xref: /openbmc/linux/include/linux/firmware.h (revision e5c86679)
1 #ifndef _LINUX_FIRMWARE_H
2 #define _LINUX_FIRMWARE_H
3 
4 #include <linux/types.h>
5 #include <linux/compiler.h>
6 #include <linux/gfp.h>
7 
8 #define FW_ACTION_NOHOTPLUG 0
9 #define FW_ACTION_HOTPLUG 1
10 
11 struct firmware {
12 	size_t size;
13 	const u8 *data;
14 	struct page **pages;
15 
16 	/* firmware loader private fields */
17 	void *priv;
18 };
19 
20 struct module;
21 struct device;
22 
23 struct builtin_fw {
24 	char *name;
25 	void *data;
26 	unsigned long size;
27 };
28 
29 /* We have to play tricks here much like stringify() to get the
30    __COUNTER__ macro to be expanded as we want it */
31 #define __fw_concat1(x, y) x##y
32 #define __fw_concat(x, y) __fw_concat1(x, y)
33 
34 #define DECLARE_BUILTIN_FIRMWARE(name, blob)				     \
35 	DECLARE_BUILTIN_FIRMWARE_SIZE(name, &(blob), sizeof(blob))
36 
37 #define DECLARE_BUILTIN_FIRMWARE_SIZE(name, blob, size)			     \
38 	static const struct builtin_fw __fw_concat(__builtin_fw,__COUNTER__) \
39 	__used __section(.builtin_fw) = { name, blob, size }
40 
41 #if defined(CONFIG_FW_LOADER) || (defined(CONFIG_FW_LOADER_MODULE) && defined(MODULE))
42 int request_firmware(const struct firmware **fw, const char *name,
43 		     struct device *device);
44 int request_firmware_nowait(
45 	struct module *module, bool uevent,
46 	const char *name, struct device *device, gfp_t gfp, void *context,
47 	void (*cont)(const struct firmware *fw, void *context));
48 int request_firmware_direct(const struct firmware **fw, const char *name,
49 			    struct device *device);
50 int request_firmware_into_buf(const struct firmware **firmware_p,
51 	const char *name, struct device *device, void *buf, size_t size);
52 
53 void release_firmware(const struct firmware *fw);
54 #else
55 static inline int request_firmware(const struct firmware **fw,
56 				   const char *name,
57 				   struct device *device)
58 {
59 	return -EINVAL;
60 }
61 static inline int request_firmware_nowait(
62 	struct module *module, bool uevent,
63 	const char *name, struct device *device, gfp_t gfp, void *context,
64 	void (*cont)(const struct firmware *fw, void *context))
65 {
66 	return -EINVAL;
67 }
68 
69 static inline void release_firmware(const struct firmware *fw)
70 {
71 }
72 
73 static inline int request_firmware_direct(const struct firmware **fw,
74 					  const char *name,
75 					  struct device *device)
76 {
77 	return -EINVAL;
78 }
79 
80 static inline int request_firmware_into_buf(const struct firmware **firmware_p,
81 	const char *name, struct device *device, void *buf, size_t size)
82 {
83 	return -EINVAL;
84 }
85 
86 #endif
87 #endif
88