2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2005-2008, Sam Leffler <sam@errno.com>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice unmodified, this list of conditions, and the following
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
32 #include <sys/param.h>
33 #include <sys/kernel.h>
34 #include <sys/malloc.h>
35 #include <sys/queue.h>
36 #include <sys/taskqueue.h>
37 #include <sys/systm.h>
39 #include <sys/mutex.h>
40 #include <sys/errno.h>
41 #include <sys/linker.h>
42 #include <sys/firmware.h>
45 #include <sys/module.h>
46 #include <sys/eventhandler.h>
48 #include <sys/filedesc.h>
49 #include <sys/vnode.h>
52 * Loadable firmware support. See sys/sys/firmware.h and firmware(9)
53 * form more details on the subsystem.
55 * 'struct firmware' is the user-visible part of the firmware table.
56 * Additional internal information is stored in a 'struct priv_fw',
57 * which embeds the public firmware structure.
61 * fw.name != NULL when an image is registered; file != NULL for
62 * autoloaded images whose handling has not been completed.
64 * The state of a slot evolves as follows:
65 * firmware_register --> fw.name = image_name
66 * (autoloaded image) --> file = module reference
67 * firmware_unregister --> fw.name = NULL
68 * (unloadentry complete) --> file = NULL
70 * In order for the above to work, the 'file' field must remain
71 * unchanged in firmware_unregister().
73 * Images residing in the same module are linked to each other
74 * through the 'parent' argument of firmware_register().
75 * One image (typically, one with the same name as the module to let
76 * the autoloading mechanism work) is considered the parent image for
77 * all other images in the same module. Children affect the refcount
78 * on the parent image preventing improper unloading of the image itself.
82 int refcnt; /* reference count */
83 LIST_ENTRY(priv_fw) link; /* table linkage */
86 * parent entry, see above. Set on firmware_register(),
87 * cleared on firmware_unregister().
89 struct priv_fw *parent;
91 int flags; /* record FIRMWARE_UNLOAD requests */
92 #define FW_UNLOAD 0x100
95 * 'file' is private info managed by the autoload/unload code.
96 * Set at the end of firmware_get(), cleared only in the
97 * firmware_unload_task, so the latter can depend on its value even
98 * while the lock is not held.
100 linker_file_t file; /* module file, if autoloaded */
103 * 'fw' is the externally visible image information.
104 * We do not make it the first field in priv_fw, to avoid the
105 * temptation of casting pointers to each other.
106 * Use PRIV_FW(fw) to get a pointer to the cointainer of fw.
107 * Beware, PRIV_FW does not work for a NULL pointer.
109 struct firmware fw; /* externally visible information */
113 * PRIV_FW returns the pointer to the container of struct firmware *x.
114 * Cast to intptr_t to override the 'const' attribute of x
116 #define PRIV_FW(x) ((struct priv_fw *) \
117 ((intptr_t)(x) - offsetof(struct priv_fw, fw)) )
120 * Global firmware image registry.
122 static LIST_HEAD(, priv_fw) firmware_table;
125 * Firmware module operations are handled in a separate task as they
126 * might sleep and they require directory context to do i/o.
128 static struct taskqueue *firmware_tq;
129 static struct task firmware_unload_task;
132 * This mutex protects accesses to the firmware table.
134 static struct mtx firmware_mtx;
135 MTX_SYSINIT(firmware, &firmware_mtx, "firmware table", MTX_DEF);
137 static MALLOC_DEFINE(M_FIRMWARE, "firmware", "device firmware images");
140 * Helper function to lookup a name.
141 * As a side effect, it sets the pointer to a free slot, if any.
142 * This way we can concentrate most of the registry scanning in
143 * this function, which makes it easier to replace the registry
144 * with some other data structure.
146 static struct priv_fw *
147 lookup(const char *name)
151 mtx_assert(&firmware_mtx, MA_OWNED);
153 LIST_FOREACH(fp, &firmware_table, link) {
154 if (fp->fw.name != NULL && strcasecmp(name, fp->fw.name) == 0)
161 * Register a firmware image with the specified name. The
162 * image name must not already be registered. If this is a
163 * subimage then parent refers to a previously registered
164 * image that this should be associated with.
166 const struct firmware *
167 firmware_register(const char *imagename, const void *data, size_t datasize,
168 unsigned int version, const struct firmware *parent)
173 mtx_lock(&firmware_mtx);
174 frp = lookup(imagename);
176 mtx_unlock(&firmware_mtx);
177 printf("%s: image %s already registered!\n",
178 __func__, imagename);
181 mtx_unlock(&firmware_mtx);
183 frp = malloc(sizeof(*frp), M_FIRMWARE, M_WAITOK | M_ZERO);
184 name = strdup(imagename, M_FIRMWARE);
186 mtx_lock(&firmware_mtx);
187 if (lookup(imagename) != NULL) {
188 /* We lost a race. */
189 mtx_unlock(&firmware_mtx);
190 free(name, M_FIRMWARE);
191 free(frp, M_FIRMWARE);
196 frp->fw.datasize = datasize;
197 frp->fw.version = version;
199 frp->parent = PRIV_FW(parent);
200 LIST_INSERT_HEAD(&firmware_table, frp, link);
201 mtx_unlock(&firmware_mtx);
203 printf("firmware: '%s' version %u: %zu bytes loaded at %p\n",
204 imagename, version, datasize, data);
209 * Unregister/remove a firmware image. If there are outstanding
210 * references an error is returned and the image is not removed
214 firmware_unregister(const char *imagename)
219 mtx_lock(&firmware_mtx);
220 fp = lookup(imagename);
223 * It is ok for the lookup to fail; this can happen
224 * when a module is unloaded on last reference and the
225 * module unload handler unregister's each of its
229 } else if (fp->refcnt != 0) { /* cannot unregister */
232 LIST_REMOVE(fp, link);
233 free(__DECONST(char *, fp->fw.name), M_FIRMWARE);
234 free(fp, M_FIRMWARE);
237 mtx_unlock(&firmware_mtx);
241 struct fw_loadimage {
242 const char *imagename;
247 loadimage(void *arg, int npending __unused)
249 struct fw_loadimage *fwli = arg;
251 linker_file_t result;
254 error = linker_reference_module(fwli->imagename, NULL, &result);
256 if (bootverbose || (fwli->flags & FIRMWARE_GET_NOWARN) == 0)
257 printf("%s: could not load firmware image, error %d\n",
258 fwli->imagename, error);
259 mtx_lock(&firmware_mtx);
263 mtx_lock(&firmware_mtx);
264 fp = lookup(fwli->imagename);
265 if (fp == NULL || fp->file != NULL) {
266 mtx_unlock(&firmware_mtx);
268 printf("%s: firmware image loaded, "
269 "but did not register\n", fwli->imagename);
270 (void) linker_release_module(fwli->imagename, NULL, NULL);
271 mtx_lock(&firmware_mtx);
274 fp->file = result; /* record the module identity */
277 mtx_unlock(&firmware_mtx);
281 * Lookup and potentially load the specified firmware image.
282 * If the firmware is not found in the registry, try to load a kernel
283 * module named as the image name.
284 * If the firmware is located, a reference is returned. The caller must
285 * release this reference for the image to be eligible for removal/unload.
287 const struct firmware *
288 firmware_get_flags(const char *imagename, uint32_t flags)
290 struct task fwload_task;
294 mtx_lock(&firmware_mtx);
295 fp = lookup(imagename);
299 * Image not present, try to load the module holding it.
302 if (priv_check(td, PRIV_FIRMWARE_LOAD) != 0 ||
303 securelevel_gt(td->td_ucred, 0) != 0) {
304 mtx_unlock(&firmware_mtx);
305 printf("%s: insufficient privileges to "
306 "load firmware image %s\n", __func__, imagename);
310 * Defer load to a thread with known context. linker_reference_module
311 * may do filesystem i/o which requires root & current dirs, etc.
312 * Also we must not hold any mtx's over this call which is problematic.
315 struct fw_loadimage fwli;
317 fwli.imagename = imagename;
319 TASK_INIT(&fwload_task, 0, loadimage, (void *)&fwli);
320 taskqueue_enqueue(firmware_tq, &fwload_task);
322 msleep((void *)&fwli, &firmware_mtx, 0, "fwload", 0);
326 * After attempting to load the module, see if the image is registered.
328 fp = lookup(imagename);
330 mtx_unlock(&firmware_mtx);
333 found: /* common exit point on success */
334 if (fp->refcnt == 0 && fp->parent != NULL)
335 fp->parent->refcnt++;
337 mtx_unlock(&firmware_mtx);
341 const struct firmware *
342 firmware_get(const char *imagename)
345 return (firmware_get_flags(imagename, 0));
349 * Release a reference to a firmware image returned by firmware_get.
350 * The caller may specify, with the FIRMWARE_UNLOAD flag, its desire
351 * to release the resource, but the flag is only advisory.
353 * If this is the last reference to the firmware image, and this is an
354 * autoloaded module, wake up the firmware_unload_task to figure out
355 * what to do with the associated module.
358 firmware_put(const struct firmware *p, int flags)
360 struct priv_fw *fp = PRIV_FW(p);
362 mtx_lock(&firmware_mtx);
364 if (fp->refcnt == 0) {
365 if (fp->parent != NULL)
366 fp->parent->refcnt--;
367 if (flags & FIRMWARE_UNLOAD)
368 fp->flags |= FW_UNLOAD;
370 taskqueue_enqueue(firmware_tq, &firmware_unload_task);
372 mtx_unlock(&firmware_mtx);
376 * Setup directory state for the firmware_tq thread so we can do i/o.
379 set_rootvnode(void *arg, int npending)
387 * Event handler called on mounting of /; bounce a task
388 * into the task queue thread to setup it's directories.
391 firmware_mountroot(void *arg)
393 struct task *setroot_task;
395 setroot_task = malloc(sizeof(struct task), M_TEMP, M_NOWAIT);
396 if (setroot_task != NULL) {
397 TASK_INIT(setroot_task, 0, set_rootvnode, setroot_task);
398 taskqueue_enqueue(firmware_tq, setroot_task);
400 printf("%s: no memory for task!\n", __func__);
402 EVENTHANDLER_DEFINE(mountroot, firmware_mountroot, NULL, 0);
405 * The body of the task in charge of unloading autoloaded modules
406 * that are not needed anymore.
407 * Images can be cross-linked so we may need to make multiple passes,
408 * but the time we spend in the loop is bounded because we clear entries
412 unloadentry(void *unused1, int unused2)
416 mtx_lock(&firmware_mtx);
418 LIST_FOREACH(fp, &firmware_table, link) {
419 if (fp->file == NULL || fp->refcnt != 0 ||
420 (fp->flags & FW_UNLOAD) == 0)
424 * Found an entry. Now:
425 * 1. make sure we scan the table again
426 * 2. clear FW_UNLOAD so we don't try this entry again.
427 * 3. release the lock while trying to unload the module.
429 fp->flags &= ~FW_UNLOAD; /* do not try again */
432 * We rely on the module to call firmware_unregister()
433 * on unload to actually free the entry.
435 mtx_unlock(&firmware_mtx);
436 (void)linker_release_module(NULL, NULL, fp->file);
437 mtx_lock(&firmware_mtx);
440 * When we dropped the lock, another thread could have
441 * removed an element, so we must restart the scan.
445 mtx_unlock(&firmware_mtx);
452 firmware_modevent(module_t mod, int type, void *unused)
460 TASK_INIT(&firmware_unload_task, 0, unloadentry, NULL);
461 firmware_tq = taskqueue_create("taskqueue_firmware", M_WAITOK,
462 taskqueue_thread_enqueue, &firmware_tq);
463 /* NB: use our own loop routine that sets up context */
464 (void) taskqueue_start_threads(&firmware_tq, 1, PWAIT,
466 if (rootvnode != NULL) {
468 * Root is already mounted so we won't get an event;
471 firmware_mountroot(NULL);
476 /* request all autoloaded modules to be released */
477 mtx_lock(&firmware_mtx);
478 LIST_FOREACH(fp, &firmware_table, link)
479 fp->flags |= FW_UNLOAD;
480 mtx_unlock(&firmware_mtx);
481 taskqueue_enqueue(firmware_tq, &firmware_unload_task);
482 taskqueue_drain(firmware_tq, &firmware_unload_task);
484 LIST_FOREACH(fp, &firmware_table, link) {
485 if (fp->fw.name != NULL) {
486 printf("%s: image %s still active, %d refs\n",
487 __func__, fp->fw.name, fp->refcnt);
492 taskqueue_free(firmware_tq);
502 static moduledata_t firmware_mod = {
507 DECLARE_MODULE(firmware, firmware_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
508 MODULE_VERSION(firmware, 1);