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 int request_firmware_direct(const struct firmware **fw, const char *name,
  49                             struct device *device);
  50
  51 int request_firmware_into_buf(const char *name, struct device *device,
  52                             phys_addr_t dest_addr, size_t dest_size,
  53                             void * (*map_fw_mem)(phys_addr_t phys,
  54                                                  size_t size, void *data),
  55                             void (*unmap_fw_mem)(void *virt, size_t size,
  56                                                  void *data),
  57                             void *data);
  58 int request_firmware_nowait_into_buf(
  59         struct module *module, bool uevent,
  60         const char *name, struct device *device, gfp_t gfp, void *context,
  61         void (*cont)(const struct firmware *fw, void *context),
  62         phys_addr_t dest_addr, size_t dest_size,
  63         void * (*map_fw_mem)(phys_addr_t phys, size_t size, void *data),
  64         void (*unmap_fw_mem)(void *virt, size_t size, void *data), void *data);
  65 void release_firmware(const struct firmware *fw);
  66 #else
  67 static inline int request_firmware(const struct firmware **fw,
  68                                    const char *name,
  69                                    struct device *device)
  70 {
  71         return -EINVAL;
  72 }
  73 static inline int request_firmware_into_buf(const char *name,
  74                                           struct device *device,
  75                                           phys_addr_t dest_addr,
  76                                           size_t dest_size,
  77                                           void * (*map_fw_mem)(phys_addr_t phys,
  78                                                        size_t size, void *data),
  79                                           void (*unmap_fw_mem)(void *virt,
  80                                                                size_t size,
  81                                                                void *data),
  82                                           void *data)
  83 {
  84         return -EINVAL;
  85 }
  86 static inline int request_firmware_nowait(
  87         struct module *module, bool uevent,
  88         const char *name, struct device *device, gfp_t gfp, void *context,
  89         void (*cont)(const struct firmware *fw, void *context))
  90 {
  91         return -EINVAL;
  92 }
  93 static inline int request_firmware_nowait_into_buf(
  94         struct module *module, bool uevent,
  95         const char *name, struct device *device, gfp_t gfp, void *context,
  96         void (*cont)(const struct firmware *fw, void *context),
  97         phys_addr_t dest_addr, size_t dest_size,
  98         void * (*map_fw_mem)(phys_addr_t phys, size_t size, void *data),
  99         void (*unmap_fw_mem)(void *virt, size_t size, void *data), void *data)
 100 {
 101         return -EINVAL;
 102 }
 103 static inline void release_firmware(const struct firmware *fw)
 104 {
 105 }
 106
 107 static inline int request_firmware_direct(const struct firmware **fw,
 108                                           const char *name,
 109                                           struct device *device)
 110 {
 111         return -EINVAL;
 112 }
 113
 114 #endif
 115 #endif