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
  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 firmware_request_nowarn(const struct firmware **fw, const char *name,
  45                             struct device *device);
  46 int firmware_request_platform(const struct firmware **fw, const char *name,
  47                               struct device *device);
  48 int 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));
  52 int request_firmware_direct(const struct firmware **fw, const char *name,
  53                             struct device *device);
  54 int request_firmware_into_buf(const struct firmware **firmware_p,
  55         const char *name, struct device *device, void *buf, size_t size);
  56 int request_partial_firmware_into_buf(const struct firmware **firmware_p,
  57                                       const char *name, struct device *device,
  58                                       void *buf, size_t size, size_t offset);
  59
  60 void release_firmware(const struct firmware *fw);
  61 #else
  62 static inline int request_firmware(const struct firmware **fw,
  63                                    const char *name,
  64                                    struct device *device)
  65 {
  66         return -EINVAL;
  67 }
  68
  69 static inline int firmware_request_nowarn(const struct firmware **fw,
  70                                           const char *name,
  71                                           struct device *device)
  72 {
  73         return -EINVAL;
  74 }
  75
  76 static inline int firmware_request_platform(const struct firmware **fw,
  77                                             const char *name,
  78                                             struct device *device)
  79 {
  80         return -EINVAL;
  81 }
  82
  83 static inline int request_firmware_nowait(
  84         struct module *module, bool uevent,
  85         const char *name, struct device *device, gfp_t gfp, void *context,
  86         void (*cont)(const struct firmware *fw, void *context))
  87 {
  88         return -EINVAL;
  89 }
  90
  91 static inline void release_firmware(const struct firmware *fw)
  92 {
  93 }
  94
  95 static inline int request_firmware_direct(const struct firmware **fw,
  96                                           const char *name,
  97                                           struct device *device)
  98 {
  99         return -EINVAL;
 100 }
 101
 102 static inline int request_firmware_into_buf(const struct firmware **firmware_p,
 103         const char *name, struct device *device, void *buf, size_t size)
 104 {
 105         return -EINVAL;
 106 }
 107
 108 static inline int request_partial_firmware_into_buf
 109                                         (const struct firmware **firmware_p,
 110                                          const char *name,
 111                                          struct device *device,
 112                                          void *buf, size_t size, size_t offset)
 113 {
 114         return -EINVAL;
 115 }
 116
 117 #endif
 118
 119 int firmware_request_cache(struct device *device, const char *name);
 120
 121 #ifndef _LINUX_LIBRE_FIRMWARE_H
 122 #define _LINUX_LIBRE_FIRMWARE_H
 123
 124 #include <linux/device.h>
 125
 126 #define NONFREE_FIRMWARE "/*(DEBLOBBED)*/"
 127
 128 static inline int
 129 is_nonfree_firmware(const char *name)
 130 {
 131   return strstr(name, NONFREE_FIRMWARE) != 0;
 132 }
 133
 134 static inline int
 135 report_missing_free_firmware(const char *name, const char *what)
 136 {
 137         printk(KERN_ERR "%s: Missing Free %s (non-Free firmware loading is disabled)\n", name,
 138                what ? what : "firmware");
 139         return -ENOENT;
 140 }
 141 static inline int
 142 firmware_reject_nowarn(const struct firmware **fw,
 143                        const char *name, struct device *device)
 144 {
 145         const struct firmware *xfw = NULL;
 146         int retval, retval0 = -ENOENT;
 147         retval = firmware_request_nowarn(&xfw, NONFREE_FIRMWARE, device);
 148         if (!retval) {
 149                 release_firmware(xfw);
 150                 retval = retval0;
 151         }
 152         return retval;
 153 }
 154 static inline int
 155 reject_firmware(const struct firmware **fw,
 156                 const char *name, struct device *device)
 157 {
 158         int retval, retval0;
 159         retval0 = report_missing_free_firmware(dev_name(device), NULL);
 160         retval = firmware_reject_nowarn(fw, name, device);
 161         if (!retval) {
 162                 retval = retval0;
 163         }
 164         return retval;
 165 }
 166 static inline int
 167 maybe_reject_firmware(const struct firmware **fw,
 168                       const char *name, struct device *device)
 169 {
 170         if (is_nonfree_firmware(name))
 171                 return reject_firmware(fw, name, device);
 172         else
 173                 return request_firmware(fw, name, device);
 174 }
 175 static inline int
 176 reject_firmware_direct(const struct firmware **fw,
 177                 const char *name, struct device *device)
 178 {
 179         const struct firmware *xfw = NULL;
 180         int retval, retval0;
 181         retval0 = report_missing_free_firmware(dev_name(device), NULL);
 182         retval = request_firmware_direct(&xfw, NONFREE_FIRMWARE, device);
 183         if (!retval) {
 184                 release_firmware(xfw);
 185                 retval = retval0;
 186         }
 187         return retval;
 188 }
 189 static inline int
 190 reject_firmware_nowait(struct module *module, int uevent,
 191                        const char *name, struct device *device,
 192                        gfp_t gfp, void *context,
 193                        void (*cont)(const struct firmware *fw,
 194                                     void *context))
 195 {
 196         report_missing_free_firmware(dev_name(device), NULL);
 197         /* We assume NONFREE_FIRMWARE will not be found; how could it?  */
 198         return request_firmware_nowait(module, uevent, NONFREE_FIRMWARE,
 199                                        device, gfp, context, cont);
 200 }
 201 static inline int
 202 maybe_reject_firmware_nowait(struct module *module, int uevent,
 203                              const char *name, struct device *device,
 204                              gfp_t gfp, void *context,
 205                              void (*cont)(const struct firmware *fw,
 206                                           void *context))
 207 {
 208         if (is_nonfree_firmware(name))
 209                 return reject_firmware_nowait(module, uevent, name,
 210                                               device, gfp, context, cont);
 211         else
 212                 return request_firmware_nowait(module, uevent, name,
 213                                                device, gfp, context, cont);
 214 }
 215 static inline int
 216 reject_firmware_into_buf(const struct firmware **firmware_p, const char *name,
 217                          struct device *device, void *buf, size_t size)
 218 {
 219         const struct firmware *xfw = NULL;
 220         int retval, retval0;
 221         retval0 = report_missing_free_firmware(dev_name(device), NULL);
 222         retval = request_firmware_into_buf(&xfw, NONFREE_FIRMWARE, device, buf, size);
 223         if (!retval) {
 224                 release_firmware(xfw);
 225                 retval = retval0;
 226         }
 227         return retval;
 228 }
 229 static inline int
 230 maybe_reject_firmware_into_buf(const struct firmware **firmware_p, const char *name,
 231                                struct device *device, void *buf, size_t size)
 232 {
 233         if (is_nonfree_firmware(name))
 234                 return reject_firmware_into_buf(firmware_p, name, device, buf, size);
 235         else
 236                 return request_firmware_into_buf(firmware_p, name, device, buf, size);
 237 }
 238 static inline int
 239 reject_partial_firmware_into_buf(const struct firmware **firmware_p, const char *name,
 240                                  struct device *device, void *buf, size_t size, size_t offset)
 241 {
 242         const struct firmware *xfw = NULL;
 243         int retval, retval0;
 244         retval0 = report_missing_free_firmware(dev_name(device), NULL);
 245         retval = request_partial_firmware_into_buf(&xfw, NONFREE_FIRMWARE, device, buf, size, offset);
 246         if (!retval) {
 247                 release_firmware(xfw);
 248                 retval = retval0;
 249         }
 250         return retval;
 251 }
 252 static inline int
 253 maybe_reject_partial_firmware_into_buf(const struct firmware **firmware_p, const char *name,
 254                                        struct device *device, void *buf, size_t size, size_t offset)
 255 {
 256         if (is_nonfree_firmware(name))
 257                 return reject_partial_firmware_into_buf(firmware_p, name, device, buf, size, offset);
 258         else
 259                 return request_partial_firmware_into_buf(firmware_p, name, device, buf, size, offset);
 260 }
 261
 262 #endif /* _LINUX_LIBRE_FIRMWARE_H */
 263
 264 #endif