2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2005, 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.
30 #ifndef _SYS_FIRMWARE_H_
31 #define _SYS_FIRMWARE_H_
33 * Loadable firmware support.
35 * The firmware abstraction provides an interface for loading firmware
36 * images into the kernel and making them available to clients.
38 * Firmware images are usually embedded in kernel loadable modules that can
39 * be loaded on-demand or pre-loaded as desired. Modules may contain
40 * one or more firmware images that are stored as opaque data arrays
41 * and registered with a unique string name. Clients request
42 * firmware by name, and are returned a struct firmware * below on success.
43 * The kernel keeps track of references to firmware images to allow/prevent
46 * When multiple images are stored in one module, the first image is
47 * treated as the master with the other images holding references
48 * to it. This means that to unload the module each dependent/subimage
49 * must first have its references removed.
50 * In order for automatic loading to work, the master image must have
51 * the same name as the module it is embedded into.
54 const char *name; /* system-wide name */
55 const void *data; /* location of image */
56 size_t datasize; /* size of image in bytes */
57 unsigned int version; /* version of the image */
60 const struct firmware *firmware_register(const char *,
61 const void *, size_t, unsigned int, const struct firmware *);
62 int firmware_unregister(const char *);
63 const struct firmware *firmware_get(const char *);
64 #define FIRMWARE_UNLOAD 0x0001 /* unload if unreferenced */
65 void firmware_put(const struct firmware *, int);
66 #endif /* _SYS_FIRMWARE_H_ */