include/linux/firmware.h

   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
  49 void release_firmware(const struct firmware *fw);
  50 int cache_firmware(const char *name);
  51 int uncache_firmware(const char *name);
  52 #else
  53 static inline int request_firmware(const struct firmware **fw,
  54                                    const char *name,
  55                                    struct device *device)
  56 {
  57         return -EINVAL;
  58 }
  59 static inline int request_firmware_nowait(
  60         struct module *module, bool uevent,
  61         const char *name, struct device *device, gfp_t gfp, void *context,
  62         void (*cont)(const struct firmware *fw, void *context))
  63 {
  64         return -EINVAL;
  65 }
  66
  67 static inline void release_firmware(const struct firmware *fw)
  68 {
  69 }
  70
  71 static inline int cache_firmware(const char *name)
  72 {
  73         return -ENOENT;
  74 }
  75
  76 static inline int uncache_firmware(const char *name)
  77 {
  78         return -EINVAL;
  79 }
  80 #endif
  81
  82 #endif