1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun #ifndef __FIRMWARE_FALLBACK_H
3*4882a593Smuzhiyun #define __FIRMWARE_FALLBACK_H
4*4882a593Smuzhiyun
5*4882a593Smuzhiyun #include <linux/firmware.h>
6*4882a593Smuzhiyun #include <linux/device.h>
7*4882a593Smuzhiyun
8*4882a593Smuzhiyun #include "firmware.h"
9*4882a593Smuzhiyun
10*4882a593Smuzhiyun /**
11*4882a593Smuzhiyun * struct firmware_fallback_config - firmware fallback configuration settings
12*4882a593Smuzhiyun *
13*4882a593Smuzhiyun * Helps describe and fine tune the fallback mechanism.
14*4882a593Smuzhiyun *
15*4882a593Smuzhiyun * @force_sysfs_fallback: force the sysfs fallback mechanism to be used
16*4882a593Smuzhiyun * as if one had enabled CONFIG_FW_LOADER_USER_HELPER_FALLBACK=y.
17*4882a593Smuzhiyun * Useful to help debug a CONFIG_FW_LOADER_USER_HELPER_FALLBACK=y
18*4882a593Smuzhiyun * functionality on a kernel where that config entry has been disabled.
19*4882a593Smuzhiyun * @ignore_sysfs_fallback: force to disable the sysfs fallback mechanism.
20*4882a593Smuzhiyun * This emulates the behaviour as if we had set the kernel
21*4882a593Smuzhiyun * config CONFIG_FW_LOADER_USER_HELPER=n.
22*4882a593Smuzhiyun * @old_timeout: for internal use
23*4882a593Smuzhiyun * @loading_timeout: the timeout to wait for the fallback mechanism before
24*4882a593Smuzhiyun * giving up, in seconds.
25*4882a593Smuzhiyun */
26*4882a593Smuzhiyun struct firmware_fallback_config {
27*4882a593Smuzhiyun unsigned int force_sysfs_fallback;
28*4882a593Smuzhiyun unsigned int ignore_sysfs_fallback;
29*4882a593Smuzhiyun int old_timeout;
30*4882a593Smuzhiyun int loading_timeout;
31*4882a593Smuzhiyun };
32*4882a593Smuzhiyun
33*4882a593Smuzhiyun #ifdef CONFIG_FW_LOADER_USER_HELPER
34*4882a593Smuzhiyun int firmware_fallback_sysfs(struct firmware *fw, const char *name,
35*4882a593Smuzhiyun struct device *device,
36*4882a593Smuzhiyun u32 opt_flags,
37*4882a593Smuzhiyun int ret);
38*4882a593Smuzhiyun void kill_pending_fw_fallback_reqs(bool only_kill_custom);
39*4882a593Smuzhiyun
40*4882a593Smuzhiyun void fw_fallback_set_cache_timeout(void);
41*4882a593Smuzhiyun void fw_fallback_set_default_timeout(void);
42*4882a593Smuzhiyun
43*4882a593Smuzhiyun int register_sysfs_loader(void);
44*4882a593Smuzhiyun void unregister_sysfs_loader(void);
45*4882a593Smuzhiyun #else /* CONFIG_FW_LOADER_USER_HELPER */
firmware_fallback_sysfs(struct firmware * fw,const char * name,struct device * device,u32 opt_flags,int ret)46*4882a593Smuzhiyun static inline int firmware_fallback_sysfs(struct firmware *fw, const char *name,
47*4882a593Smuzhiyun struct device *device,
48*4882a593Smuzhiyun u32 opt_flags,
49*4882a593Smuzhiyun int ret)
50*4882a593Smuzhiyun {
51*4882a593Smuzhiyun /* Keep carrying over the same error */
52*4882a593Smuzhiyun return ret;
53*4882a593Smuzhiyun }
54*4882a593Smuzhiyun
kill_pending_fw_fallback_reqs(bool only_kill_custom)55*4882a593Smuzhiyun static inline void kill_pending_fw_fallback_reqs(bool only_kill_custom) { }
fw_fallback_set_cache_timeout(void)56*4882a593Smuzhiyun static inline void fw_fallback_set_cache_timeout(void) { }
fw_fallback_set_default_timeout(void)57*4882a593Smuzhiyun static inline void fw_fallback_set_default_timeout(void) { }
58*4882a593Smuzhiyun
register_sysfs_loader(void)59*4882a593Smuzhiyun static inline int register_sysfs_loader(void)
60*4882a593Smuzhiyun {
61*4882a593Smuzhiyun return 0;
62*4882a593Smuzhiyun }
63*4882a593Smuzhiyun
unregister_sysfs_loader(void)64*4882a593Smuzhiyun static inline void unregister_sysfs_loader(void)
65*4882a593Smuzhiyun {
66*4882a593Smuzhiyun }
67*4882a593Smuzhiyun #endif /* CONFIG_FW_LOADER_USER_HELPER */
68*4882a593Smuzhiyun
69*4882a593Smuzhiyun #ifdef CONFIG_EFI_EMBEDDED_FIRMWARE
70*4882a593Smuzhiyun int firmware_fallback_platform(struct fw_priv *fw_priv);
71*4882a593Smuzhiyun #else
firmware_fallback_platform(struct fw_priv * fw_priv)72*4882a593Smuzhiyun static inline int firmware_fallback_platform(struct fw_priv *fw_priv)
73*4882a593Smuzhiyun {
74*4882a593Smuzhiyun return -ENOENT;
75*4882a593Smuzhiyun }
76*4882a593Smuzhiyun #endif
77*4882a593Smuzhiyun
78*4882a593Smuzhiyun #endif /* __FIRMWARE_FALLBACK_H */
79