src/include/fw_config.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2
   3 #ifndef __FW_CONFIG__
   4 #define __FW_CONFIG__
   5
   6 #include <device/device.h>
   7 #include <static.h>  /* Provides fw_config definitions from devicetree.cb */
   8 #include <stdbool.h>
   9 #include <stdint.h>
  10
  11 #define UNDEFINED_FW_CONFIG     ~((uint64_t)0)
  12
  13 /**
  14  * struct fw_config - Firmware configuration field and option.
  15  * @field_name: Name of the field that this option belongs to.
  16  * @option_name: Name of the option within this field.
  17  * @mask: Bitmask of the field.
  18  * @value: Value of the option within the mask.
  19  */
  20 struct fw_config {
  21         const char *field_name;
  22         const char *option_name;
  23         uint64_t mask;
  24         uint64_t value;
  25 };
  26
  27 struct fw_config_field {
  28         const char *field_name;
  29         uint64_t mask;
  30 };
  31
  32 /* Generate a pointer to a compound literal of the fw_config structure. */
  33 #define FW_CONFIG(__field, __option)    (&(const struct fw_config) {            \
  34         .field_name = FW_CONFIG_FIELD_##__field##_NAME,                         \
  35         .option_name = FW_CONFIG_FIELD_##__field##_OPTION_##__option##_NAME,    \
  36         .mask = FW_CONFIG_FIELD_##__field##_MASK,                               \
  37         .value = FW_CONFIG_FIELD_##__field##_OPTION_##__option##_VALUE          \
  38 })
  39
  40 #define FW_CONFIG_FIELD(__field) (&(const struct fw_config_field) {             \
  41         .field_name = FW_CONFIG_FIELD_##__field##_NAME,                         \
  42         .mask = FW_CONFIG_FIELD_##__field##_MASK,                               \
  43 })
  44
  45 /**
  46  * fw_config_get() - Provide firmware configuration value.
  47  *
  48  * Return 64bit firmware configuration value determined for the system.
  49  */
  50 uint64_t fw_config_get(void);
  51
  52 /**
  53  * fw_config_is_provisioned() - Determine if FW_CONFIG has been provisioned.
  54  * Return %true if FW_CONFIG has been provisioned, %false otherwise.
  55  */
  56 static inline bool fw_config_is_provisioned(void)
  57 {
  58         return fw_config_get() != UNDEFINED_FW_CONFIG;
  59 }
  60
  61
  62 #if CONFIG(FW_CONFIG)
  63
  64 /**
  65  * fw_config_get_field() - Provide firmware configuration field value.
  66  * @field: Structure containing field name and mask
  67  *
  68  * Return 64bit firmware configuration value determined for the system.
  69  * Will return UNDEFINED_FW_CONFIG if unprovisioned, caller should treat
  70  * as error value for the case.
  71  */
  72 uint64_t fw_config_get_field(const struct fw_config_field *field);
  73
  74 /**
  75  * fw_config_probe() - Check if field and option matches.
  76  * @match: Structure containing field and option to probe.
  77  *
  78  * Return %true if match is found, %false if match is not found.
  79  */
  80 bool fw_config_probe(const struct fw_config *match);
  81
  82 /**
  83  * fw_config_for_each_found() - Call a callback for each fw_config field found
  84  * @cb: The callback function
  85  * @arg: A context argument that is passed to the callback
  86  */
  87 void fw_config_for_each_found(void (*cb)(const struct fw_config *config, void *arg), void *arg);
  88
  89 /**
  90  * fw_config_get_found() - Return a pointer to the fw_config struct for a given field.
  91  * @field_mask: A field mask from static.h, e.g., FW_CONFIG_FIELD_FEATURE_MASK
  92  *
  93  * Return pointer to cached `struct fw_config` if successfully probed, otherwise NULL.
  94 */
  95 const struct fw_config *fw_config_get_found(uint64_t field_mask);
  96
  97 /**
  98  * fw_config_probe_dev() - Check if any of the probe conditions are true for given device.
  99  * @dev: Device for which probe conditions are checked
 100  * @matching_probe: If any probe condition match, then the matching probe condition is returned
 101  * to the caller.
 102  * Return %true if device has no probing conditions or if a matching probe condition is
 103  * encountered, %false otherwise.
 104  */
 105 bool fw_config_probe_dev(const struct device *dev, const struct fw_config **matching_probe);
 106
 107 #else
 108
 109 static inline bool fw_config_probe(const struct fw_config *match)
 110 {
 111         /* Always return true when probing with disabled fw_config. */
 112         return true;
 113 }
 114
 115 static inline bool fw_config_probe_dev(const struct device *dev,
 116                                        const struct fw_config **matching_probe)
 117 {
 118         /* Always return true when probing with disabled fw_config. */
 119         if (matching_probe)
 120                 *matching_probe = NULL;
 121         return true;
 122 }
 123
 124 static inline uint64_t fw_config_get_field(const struct fw_config_field *field)
 125 {
 126         /* Always return UNDEFINED_FW_CONFIG when get with disabled fw_config. */
 127         return UNDEFINED_FW_CONFIG;
 128 }
 129
 130 #endif /* CONFIG(FW_CONFIG) */
 131
 132 #endif /* __FW_CONFIG__ */