2 * Copyright (c) 2005, Sam Leffler <sam@errno.com>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice unmodified, this list of conditions, and the following
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include <sys/param.h>
31 #include <sys/kernel.h>
32 #include <sys/malloc.h>
33 #include <sys/queue.h>
34 #include <sys/taskqueue.h>
35 #include <sys/systm.h>
37 #include <sys/mutex.h>
38 #include <sys/errno.h>
39 #include <sys/linker.h>
40 #include <sys/firmware.h>
42 #include <sys/module.h>
44 #define FIRMWARE_MAX 30
45 static struct firmware firmware_table[FIRMWARE_MAX];
46 struct task firmware_task;
47 struct mtx firmware_mtx;
48 MTX_SYSINIT(firmware, &firmware_mtx, "firmware table", MTX_DEF);
51 * Register a firmware image with the specified name. The
52 * image name must not already be registered. If this is a
53 * subimage then parent refers to a previously registered
54 * image that this should be associated with.
57 firmware_register(const char *imagename, const void *data, size_t datasize,
58 unsigned int version, struct firmware *parent)
60 struct firmware *frp = NULL;
63 mtx_lock(&firmware_mtx);
64 for (i = 0; i < FIRMWARE_MAX; i++) {
65 struct firmware *fp = &firmware_table[i];
67 if (fp->name == NULL) {
72 if (strcasecmp(imagename, fp->name) == 0) {
73 mtx_unlock(&firmware_mtx);
74 printf("%s: image %s already registered!\n",
80 mtx_unlock(&firmware_mtx);
81 printf("%s: cannot register image %s, firmware table full!\n",
85 frp->name = imagename;
87 frp->datasize = datasize;
88 frp->version = version;
95 mtx_unlock(&firmware_mtx);
100 clearentry(struct firmware *fp)
102 KASSERT(fp->refcnt == 0, ("image %s refcnt %u", fp->name, fp->refcnt));
109 if (fp->parent != NULL) { /* release parent reference */
110 fp->parent->refcnt--;
115 static struct firmware *
116 lookup(const char *name)
121 for (i = 0; i < FIRMWARE_MAX; i++) {
122 fp = &firmware_table[i];
123 if (fp->name != NULL && strcasecmp(name, fp->name) == 0)
130 * Unregister/remove a firmware image. If there are outstanding
131 * references an error is returned and the image is not removed
135 firmware_unregister(const char *imagename)
140 mtx_lock(&firmware_mtx);
142 * NB: it is ok for the lookup to fail; this can happen
143 * when a module is unloaded on last reference and the
144 * module unload handler unregister's each of it's
147 fp = lookup(imagename);
153 mtx_unlock(&firmware_mtx);
154 return (refcnt != 0 ? EBUSY : 0);
158 * Lookup and potentially load the specified firmware image.
159 * If the firmware is not found in the registry attempt to
160 * load a kernel module with the image name. If the firmware
161 * is located a reference is returned. The caller must release
162 * this reference for the image to be eligible for removal/unload.
165 firmware_get(const char *imagename)
169 linker_file_t result;
170 int requested_load = 0;
173 mtx_lock(&firmware_mtx);
174 fp = lookup(imagename);
179 mtx_unlock(&firmware_mtx);
183 * Image not present, try to load the module holding it
184 * or if we already tried give up.
186 mtx_unlock(&firmware_mtx);
187 if (requested_load) {
188 printf("%s: failed to load firmware image %s\n",
189 __func__, imagename);
193 if (suser(td) != 0 || securelevel_gt(td->td_ucred, 0) != 0) {
194 printf("%s: insufficient privileges to "
195 "load firmware image %s\n", __func__, imagename);
198 mtx_lock(&Giant); /* XXX */
199 (void) linker_reference_module(imagename, NULL, &result);
200 mtx_unlock(&Giant); /* XXX */
202 goto again; /* sort of an Algol-style for loop */
206 unloadentry(void *unused1, int unused2)
212 mtx_lock(&firmware_mtx);
214 /* Look for an unwanted entry that we explicitly loaded. */
215 for (i = 0; i < FIRMWARE_MAX; i++) {
216 fp = &firmware_table[i];
217 if (fp->name != NULL && fp->file != NULL &&
219 (fp->flags & FIRMWAREFLAG_KEEPKLDREF) == 0)
226 /* No longer explicitly loaded. */
228 mtx_unlock(&firmware_mtx);
230 linker_file_unload(file, LINKER_UNLOAD_NORMAL);
232 mtx_lock(&firmware_mtx);
234 mtx_unlock(&firmware_mtx);
238 * Release a reference to a firmware image returned by
239 * firmware_get. The reference is released and if this is
240 * the last reference to the firmware image the associated
241 * module may be released/unloaded.
244 firmware_put(struct firmware *fp, int flags)
246 mtx_lock(&firmware_mtx);
248 if (fp->refcnt == 0) {
249 if ((flags & FIRMWARE_UNLOAD) == 0)
250 fp->flags |= FIRMWAREFLAG_KEEPKLDREF;
253 taskqueue_enqueue(taskqueue_thread, &firmware_task);
254 mtx_unlock(&firmware_mtx);
261 firmware_modevent(module_t mod, int type, void *unused)
268 TASK_INIT(&firmware_task, 0, unloadentry, NULL);
271 for (i = 0; i < FIRMWARE_MAX; i++) {
272 fp = &firmware_table[i];
273 fp->flags &= ~FIRMWAREFLAG_KEEPKLDREF;
275 taskqueue_enqueue(taskqueue_thread, &firmware_task);
276 taskqueue_drain(taskqueue_thread, &firmware_task);
282 static moduledata_t firmware_mod = {
287 DECLARE_MODULE(firmware, firmware_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
288 MODULE_VERSION(firmware, 1);