include/linux/firmware.h

   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
  12 struct firmware {
  13         size_t size;
  14         const u8 *data;
  15         struct page **pages;
  16
  17         /* firmware loader private fields */
  18         void *priv;
  19 };
  20
  21 struct module;
  22 struct device;
  23
  24 struct builtin_fw {
  25         char *name;
  26         void *data;
  27         unsigned long size;
  28 };
  29
  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)
  34
  35 #define DECLARE_BUILTIN_FIRMWARE(name, blob)                                 \
  36         DECLARE_BUILTIN_FIRMWARE_SIZE(name, &(blob), sizeof(blob))
  37
  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 }
  41
  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 void retry_request_firmware(void);
  46 int request_firmware_nowait(
  47         struct module *module, bool uevent,
  48         const char *name, struct device *device, gfp_t gfp, void *context,
  49         void (*cont)(const struct firmware *fw, void *context));
  50 int request_firmware_direct(const struct firmware **fw, const char *name,
  51                             struct device *device);
  52 int request_firmware_into_buf(const struct firmware **firmware_p,
  53         const char *name, struct device *device, void *buf, size_t size);
  54
  55 void release_firmware(const struct firmware *fw);
  56 #else
  57 static inline int request_firmware(const struct firmware **fw,
  58                                    const char *name,
  59                                    struct device *device)
  60 {
  61         return -EINVAL;
  62 }
  63
  64 static inline void retry_request_firmware(void)
  65 {
  66 }
  67
  68 static inline int request_firmware_nowait(
  69         struct module *module, bool uevent,
  70         const char *name, struct device *device, gfp_t gfp, void *context,
  71         void (*cont)(const struct firmware *fw, void *context))
  72 {
  73         return -EINVAL;
  74 }
  75
  76 static inline void release_firmware(const struct firmware *fw)
  77 {
  78 }
  79
  80 static inline int request_firmware_direct(const struct firmware **fw,
  81                                           const char *name,
  82                                           struct device *device)
  83 {
  84         return -EINVAL;
  85 }
  86
  87 static inline int request_firmware_into_buf(const struct firmware **firmware_p,
  88         const char *name, struct device *device, void *buf, size_t size)
  89 {
  90         return -EINVAL;
  91 }
  92
  93 #endif
  94 #endif