Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/* SPDX-License-Identifier: GPL-2.0 */
2#ifndef _LINUX_FIRMWARE_H
3#define _LINUX_FIRMWARE_H
4
5#include <linux/types.h>
6#include <linux/compiler.h>
7#include <linux/gfp.h>
8
9#define FW_ACTION_NOHOTPLUG 0
10#define FW_ACTION_HOTPLUG 1
11
12struct firmware {
13 size_t size;
14 const u8 *data;
15
16 /* firmware loader private fields */
17 void *priv;
18};
19
20struct module;
21struct device;
22
23struct 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))
42int request_firmware(const struct firmware **fw, const char *name,
43 struct device *device);
44int firmware_request_nowarn(const struct firmware **fw, const char *name,
45 struct device *device);
46int firmware_request_platform(const struct firmware **fw, const char *name,
47 struct device *device);
48int request_firmware_nowait(
49 struct module *module, bool uevent,
50 const char *name, struct device *device, gfp_t gfp, void *context,
51 void (*cont)(const struct firmware *fw, void *context));
52int request_firmware_direct(const struct firmware **fw, const char *name,
53 struct device *device);
54int request_firmware_into_buf(const struct firmware **firmware_p,
55 const char *name, struct device *device, void *buf, size_t size);
56
57void release_firmware(const struct firmware *fw);
58#else
59static inline int request_firmware(const struct firmware **fw,
60 const char *name,
61 struct device *device)
62{
63 return -EINVAL;
64}
65
66static inline int firmware_request_nowarn(const struct firmware **fw,
67 const char *name,
68 struct device *device)
69{
70 return -EINVAL;
71}
72
73static inline int firmware_request_platform(const struct firmware **fw,
74 const char *name,
75 struct device *device)
76{
77 return -EINVAL;
78}
79
80static inline int request_firmware_nowait(
81 struct module *module, bool uevent,
82 const char *name, struct device *device, gfp_t gfp, void *context,
83 void (*cont)(const struct firmware *fw, void *context))
84{
85 return -EINVAL;
86}
87
88static inline void release_firmware(const struct firmware *fw)
89{
90}
91
92static inline int request_firmware_direct(const struct firmware **fw,
93 const char *name,
94 struct device *device)
95{
96 return -EINVAL;
97}
98
99static inline int request_firmware_into_buf(const struct firmware **firmware_p,
100 const char *name, struct device *device, void *buf, size_t size)
101{
102 return -EINVAL;
103}
104
105#endif
106
107int firmware_request_cache(struct device *device, const char *name);
108
109#endif