1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _LINUX_FIRMWARE_H
3 #define _LINUX_FIRMWARE_H
5 #include <linux/types.h>
6 #include <linux/compiler.h>
9 #define FW_ACTION_NOHOTPLUG 0
10 #define FW_ACTION_HOTPLUG 1
17 /* firmware loader private fields */
30 /* We have to play tricks here much like stringify() to get the
31 __COUNTER__ macro to be expanded as we want it */
32 #define __fw_concat1(x, y) x##y
33 #define __fw_concat(x, y) __fw_concat1(x, y)
35 #define DECLARE_BUILTIN_FIRMWARE(name, blob) \
36 DECLARE_BUILTIN_FIRMWARE_SIZE(name, &(blob), sizeof(blob))
38 #define DECLARE_BUILTIN_FIRMWARE_SIZE(name, blob, size) \
39 static const struct builtin_fw __fw_concat(__builtin_fw,__COUNTER__) \
40 __used __section(.builtin_fw) = { name, blob, size }
42 #if defined(CONFIG_FW_LOADER) || (defined(CONFIG_FW_LOADER_MODULE) && defined(MODULE))
43 int request_firmware(const struct firmware **fw, const char *name,
44 struct device *device);
45 int firmware_request_nowarn(const struct firmware **fw, const char *name,
46 struct device *device);
47 int request_firmware_nowait(
48 struct module *module, bool uevent,
49 const char *name, struct device *device, gfp_t gfp, void *context,
50 void (*cont)(const struct firmware *fw, void *context));
51 int request_firmware_direct(const struct firmware **fw, const char *name,
52 struct device *device);
53 int request_firmware_into_buf(const struct firmware **firmware_p,
54 const char *name, struct device *device, void *buf, size_t size);
56 void release_firmware(const struct firmware *fw);
58 static inline int request_firmware(const struct firmware **fw,
60 struct device *device)
65 static inline int firmware_request_nowarn(const struct firmware **fw,
67 struct device *device)
72 static inline int request_firmware_nowait(
73 struct module *module, bool uevent,
74 const char *name, struct device *device, gfp_t gfp, void *context,
75 void (*cont)(const struct firmware *fw, void *context))
80 static inline void release_firmware(const struct firmware *fw)
84 static inline int request_firmware_direct(const struct firmware **fw,
86 struct device *device)
91 static inline int request_firmware_into_buf(const struct firmware **firmware_p,
92 const char *name, struct device *device, void *buf, size_t size)
99 int firmware_request_cache(struct device *device, const char *name);
101 #ifndef _LINUX_LIBRE_FIRMWARE_H
102 #define _LINUX_LIBRE_FIRMWARE_H
104 #include <linux/device.h>
106 #define NONFREE_FIRMWARE "/*(DEBLOBBED)*/"
109 is_nonfree_firmware(const char *name)
111 return strstr(name, NONFREE_FIRMWARE) != 0;
115 report_missing_free_firmware(const char *name, const char *what)
117 printk(KERN_ERR "%s: Missing Free %s (non-Free firmware loading is disabled)\n", name,
118 what ? what : "firmware");
122 firmware_reject_nowarn(const struct firmware **fw,
123 const char *name, struct device *device)
125 const struct firmware *xfw = NULL;
126 int retval, retval0 = -ENOENT;
128 retval = firmware_request_nowarn(&xfw, NONFREE_FIRMWARE, device);
130 release_firmware(xfw);
136 reject_firmware(const struct firmware **fw,
137 const char *name, struct device *device)
140 retval0 = report_missing_free_firmware(dev_name(device), NULL);
141 retval = firmware_reject_nowarn(fw, name, device);
148 maybe_reject_firmware(const struct firmware **fw,
149 const char *name, struct device *device)
151 if (is_nonfree_firmware(name))
152 return reject_firmware(fw, name, device);
154 return request_firmware(fw, name, device);
157 reject_firmware_direct(const struct firmware **fw,
158 const char *name, struct device *device)
160 const struct firmware *xfw = NULL;
163 retval0 = report_missing_free_firmware(dev_name(device), NULL);
164 retval = request_firmware_direct(&xfw, NONFREE_FIRMWARE, device);
166 release_firmware(xfw);
172 reject_firmware_nowait(struct module *module, int uevent,
173 const char *name, struct device *device,
174 gfp_t gfp, void *context,
175 void (*cont)(const struct firmware *fw,
178 report_missing_free_firmware(dev_name(device), NULL);
179 /* We assume NONFREE_FIRMWARE will not be found; how could it? */
180 return request_firmware_nowait(module, uevent, NONFREE_FIRMWARE,
181 device, gfp, context, cont);
184 maybe_reject_firmware_nowait(struct module *module, int uevent,
185 const char *name, struct device *device,
186 gfp_t gfp, void *context,
187 void (*cont)(const struct firmware *fw,
190 if (is_nonfree_firmware(name))
191 return reject_firmware_nowait(module, uevent, name,
192 device, gfp, context, cont);
194 return request_firmware_nowait(module, uevent, name,
195 device, gfp, context, cont);
198 reject_firmware_into_buf(const struct firmware **firmware_p, const char *name,
199 struct device *device, void *buf, size_t size)
201 const struct firmware *xfw = NULL;
203 if (firmware_p) *firmware_p = xfw;
204 retval0 = report_missing_free_firmware(dev_name(device), NULL);
205 retval = request_firmware_into_buf(&xfw, NONFREE_FIRMWARE, device, buf, size);
207 release_firmware(xfw);
213 maybe_reject_firmware_into_buf(const struct firmware **firmware_p, const char *name,
214 struct device *device, void *buf, size_t size)
216 if (is_nonfree_firmware(name))
217 return reject_firmware_into_buf(firmware_p, name, device, buf, size);
219 return request_firmware_into_buf(firmware_p, name, device, buf, size);
222 #endif /* _LINUX_LIBRE_FIRMWARE_H */