1 /* SPDX-License-Identifier: GPL-2.0 */
13 struct firmware {  struct
17 	/* firmware loader private fields */  argument
22  * enum fw_upload_err - firmware upload error codes  argument
25  * @FW_UPLOAD_ERR_TIMEOUT: SW timed out on handshake with HW/firmware
28  * @FW_UPLOAD_ERR_INVALID_SIZE: invalid firmware image size
30  * @FW_UPLOAD_ERR_WEAROUT: FLASH device is approaching wear-out, wait & retry
31  * @FW_UPLOAD_ERR_FW_INVALID: invalid firmware file
49 	void *priv;	 /* firmware loader private fields */
53  * struct fw_upload_ops - device specific operations to support firmware upload
85  * Built-in firmware functionality is only available if FW_LOADER=y, but not
89 bool firmware_request_builtin(struct firmware *fw, const char *name);
91 static inline bool firmware_request_builtin(struct firmware *fw,  in firmware_request_builtin()
92 					    const char *name)  in firmware_request_builtin()  argument
99 int request_firmware(const struct firmware **fw, const char *name,
102 	struct module *module, const char *name,
104 	void (*cont)(const struct firmware *fw, void *context));
105 int firmware_request_nowarn(const struct firmware **fw, const char *name,
107 int firmware_request_platform(const struct firmware **fw, const char *name,
111 	const char *name, struct device *device, gfp_t gfp, void *context,
112 	void (*cont)(const struct firmware *fw, void *context));
113 int request_firmware_direct(const struct firmware **fw, const char *name,
115 int request_firmware_into_buf(const struct firmware **firmware_p,
116 	const char *name, struct device *device, void *buf, size_t size);
117 int request_partial_firmware_into_buf(const struct firmware **firmware_p,
118 				      const char *name, struct device *device,
121 void release_firmware(const struct firmware *fw);
123 static inline int request_firmware(const struct firmware **fw,  in request_firmware()
124 				   const char *name,  in request_firmware()  argument
127 	return -EINVAL;  in request_firmware()
131 	struct module *module, const char *name,  in firmware_request_nowait_nowarn()  argument
133 	void (*cont)(const struct firmware *fw, void *context))  in firmware_request_nowait_nowarn()
135 	return -EINVAL;  in firmware_request_nowait_nowarn()
138 static inline int firmware_request_nowarn(const struct firmware **fw,  in firmware_request_nowarn()
139 					  const char *name,  in firmware_request_nowarn()  argument
142 	return -EINVAL;  in firmware_request_nowarn()
145 static inline int firmware_request_platform(const struct firmware **fw,  in firmware_request_platform()
146 					    const char *name,  in firmware_request_platform()  argument
149 	return -EINVAL;  in firmware_request_platform()
154 	const char *name, struct device *device, gfp_t gfp, void *context,  in request_firmware_nowait()  argument
155 	void (*cont)(const struct firmware *fw, void *context))  in request_firmware_nowait()
157 	return -EINVAL;  in request_firmware_nowait()
160 static inline void release_firmware(const struct firmware *fw)  in release_firmware()
164 static inline int request_firmware_direct(const struct firmware **fw,  in request_firmware_direct()
165 					  const char *name,  in request_firmware_direct()  argument
168 	return -EINVAL;  in request_firmware_direct()
171 static inline int request_firmware_into_buf(const struct firmware **firmware_p,  in request_firmware_into_buf()
172 	const char *name, struct device *device, void *buf, size_t size)  in request_firmware_into_buf()  argument
174 	return -EINVAL;  in request_firmware_into_buf()
178 					(const struct firmware **firmware_p,  in request_partial_firmware_into_buf()
179 					 const char *name,  in request_partial_firmware_into_buf()  argument
183 	return -EINVAL;  in request_partial_firmware_into_buf()
192 			 const char *name, const struct fw_upload_ops *ops,
200 			 const char *name, const struct fw_upload_ops *ops,  in firmware_upload_register()  argument
203 		return ERR_PTR(-EINVAL);  in firmware_upload_register()
212 int firmware_request_cache(struct device *device, const char *name);
214 DEFINE_FREE(firmware, struct firmware *, release_firmware(_T))