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 void release_firmware(const struct firmware *fw);
  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 request_firmware_direct(const struct firmware **fw,
  72                                           const char *name,
  73                                           struct device *device)
  74 {
  75         return -EINVAL;
  76 }
  77
  78 #endif
  79 #ifndef _LINUX_LIBRE_FIRMWARE_H
  80 #define _LINUX_LIBRE_FIRMWARE_H
  81
  82 #include <linux/device.h>
  83
  84 #define NONFREE_FIRMWARE "/*(DEBLOBBED)*/"
  85
  86 static inline int
  87 is_nonfree_firmware(const char *name)
  88 {
  89   return strstr(name, NONFREE_FIRMWARE) != 0;
  90 }
  91
  92 static inline int
  93 report_missing_free_firmware(const char *name, const char *what)
  94 {
  95         printk(KERN_ERR "%s: Missing Free %s (non-Free firmware loading is disabled)\n", name,
  96                what ? what : "firmware");
  97         return -EINVAL;
  98 }
  99 static inline int
 100 reject_firmware(const struct firmware **fw,
 101                 const char *name, struct device *device)
 102 {
 103         const struct firmware *xfw = NULL;
 104         int retval;
 105         report_missing_free_firmware(dev_name(device), NULL);
 106         retval = request_firmware(&xfw, NONFREE_FIRMWARE, device);
 107         if (!retval)
 108                 release_firmware(xfw);
 109         return -EINVAL;
 110 }
 111 static inline int
 112 maybe_reject_firmware(const struct firmware **fw,
 113                       const char *name, struct device *device)
 114 {
 115         if (is_nonfree_firmware(name))
 116                 return reject_firmware(fw, name, device);
 117         else
 118                 return request_firmware(fw, name, device);
 119 }
 120 static inline int
 121 reject_firmware_direct(const struct firmware **fw,
 122                 const char *name, struct device *device)
 123 {
 124         const struct firmware *xfw = NULL;
 125         int retval;
 126         report_missing_free_firmware(dev_name(device), NULL);
 127         retval = request_firmware_direct(&xfw, NONFREE_FIRMWARE, device);
 128         if (!retval)
 129                 release_firmware(xfw);
 130         return -EINVAL;
 131 }
 132 static inline void
 133 discard_rejected_firmware(const struct firmware *fw, void *context)
 134 {
 135         release_firmware(fw);
 136 }
 137 static inline int
 138 reject_firmware_nowait(struct module *module, int uevent,
 139                        const char *name, struct device *device,
 140                        gfp_t gfp, void *context,
 141                        void (*cont)(const struct firmware *fw,
 142                                     void *context))
 143 {
 144         int retval;
 145         report_missing_free_firmware(dev_name(device), NULL);
 146         retval = request_firmware_nowait(module, uevent, NONFREE_FIRMWARE,
 147                                          device, gfp, NULL,
 148                                          discard_rejected_firmware);
 149         if (retval)
 150                 return retval;
 151         return -EINVAL;
 152 }
 153 static inline int
 154 maybe_reject_firmware_nowait(struct module *module, int uevent,
 155                              const char *name, struct device *device,
 156                              gfp_t gfp, void *context,
 157                              void (*cont)(const struct firmware *fw,
 158                                           void *context))
 159 {
 160         if (is_nonfree_firmware(name))
 161                 return reject_firmware_nowait(module, uevent, name,
 162                                               device, gfp, context, cont);
 163         else
 164                 return request_firmware_nowait(module, uevent, name,
 165                                                device, gfp, context, cont);
 166 }
 167
 168 #endif /* _LINUX_LIBRE_FIRMWARE_H */
 169
 170 #endif