drivers/base/firmware_loader/fallback.h

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