blob: e4279fedb93a305023059882cca49da35ca7f420 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef _LINUX_FIRMWARE_H
2#define _LINUX_FIRMWARE_H
David Woodhouse5658c762008-05-23 13:52:42 +01003
Linus Torvalds1da177e2005-04-16 15:20:36 -07004#include <linux/types.h>
David Woodhouse5658c762008-05-23 13:52:42 +01005#include <linux/compiler.h>
Johannes Berg9ebfbd42009-10-29 12:36:02 +01006#include <linux/gfp.h>
David Woodhouse5658c762008-05-23 13:52:42 +01007
Abhay Salunke6e3eaab2005-09-06 15:17:13 -07008#define FW_ACTION_NOHOTPLUG 0
9#define FW_ACTION_HOTPLUG 1
10
Linus Torvalds1da177e2005-04-16 15:20:36 -070011struct firmware {
12 size_t size;
David Woodhouseb7a39bd2008-05-23 18:38:49 +010013 const u8 *data;
David Woodhousedd336c52010-05-02 11:21:21 +030014 struct page **pages;
Ming Lei1f2b7952012-08-04 12:01:21 +080015
16 /* firmware loader private fields */
17 void *priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -070018};
James Bottomleyfbab9762008-03-07 08:57:54 -060019
Paul Gortmakerde477252011-05-26 13:46:22 -040020struct module;
Linus Torvalds1da177e2005-04-16 15:20:36 -070021struct device;
James Bottomleyfbab9762008-03-07 08:57:54 -060022
David Woodhouse5658c762008-05-23 13:52:42 +010023struct 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
James Bottomley69d44a12008-07-04 09:59:27 -070041#if defined(CONFIG_FW_LOADER) || (defined(CONFIG_FW_LOADER_MODULE) && defined(MODULE))
Linus Torvalds1da177e2005-04-16 15:20:36 -070042int request_firmware(const struct firmware **fw, const char *name,
43 struct device *device);
44int request_firmware_nowait(
Bob Liu072fc8f2011-01-26 18:33:32 +080045 struct module *module, bool uevent,
Johannes Berg9ebfbd42009-10-29 12:36:02 +010046 const char *name, struct device *device, gfp_t gfp, void *context,
Linus Torvalds1da177e2005-04-16 15:20:36 -070047 void (*cont)(const struct firmware *fw, void *context));
48
49void release_firmware(const struct firmware *fw);
Ming Lei2887b392012-08-04 12:01:22 +080050int cache_firmware(const char *name);
51int uncache_firmware(const char *name);
James Bottomleyfbab9762008-03-07 08:57:54 -060052#else
53static inline int request_firmware(const struct firmware **fw,
54 const char *name,
55 struct device *device)
56{
57 return -EINVAL;
58}
59static inline int request_firmware_nowait(
Bob Liu072fc8f2011-01-26 18:33:32 +080060 struct module *module, bool uevent,
Johannes Berg9ebfbd42009-10-29 12:36:02 +010061 const char *name, struct device *device, gfp_t gfp, void *context,
James Bottomleyfbab9762008-03-07 08:57:54 -060062 void (*cont)(const struct firmware *fw, void *context))
63{
64 return -EINVAL;
65}
66
67static inline void release_firmware(const struct firmware *fw)
68{
69}
Ming Lei2887b392012-08-04 12:01:22 +080070
71static inline int cache_firmware(const char *name)
72{
73 return -ENOENT;
74}
75
76static inline int uncache_firmware(const char *name)
77{
78 return -EINVAL;
79}
James Bottomleyfbab9762008-03-07 08:57:54 -060080#endif
81
Linus Torvalds1da177e2005-04-16 15:20:36 -070082#endif