include/linux/property.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  * property.h - Unified device property interface.
   4  *
   5  * Copyright (C) 2014, Intel Corporation
   6  * Authors: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
   7  *          Mika Westerberg <mika.westerberg@linux.intel.com>
   8  */
   9
  10 #ifndef _LINUX_PROPERTY_H_
  11 #define _LINUX_PROPERTY_H_
  12
  13 #include <linux/bits.h>
  14 #include <linux/fwnode.h>
  15 #include <linux/types.h>
  16
  17 struct device;
  18
  19 enum dev_prop_type {
  20         DEV_PROP_U8,
  21         DEV_PROP_U16,
  22         DEV_PROP_U32,
  23         DEV_PROP_U64,
  24         DEV_PROP_STRING,
  25         DEV_PROP_MAX,
  26 };
  27
  28 enum dev_dma_attr {
  29         DEV_DMA_NOT_SUPPORTED,
  30         DEV_DMA_NON_COHERENT,
  31         DEV_DMA_COHERENT,
  32 };
  33
  34 struct fwnode_handle *dev_fwnode(struct device *dev);
  35
  36 bool device_property_present(struct device *dev, const char *propname);
  37 int device_property_read_u8_array(struct device *dev, const char *propname,
  38                                   u8 *val, size_t nval);
  39 int device_property_read_u16_array(struct device *dev, const char *propname,
  40                                    u16 *val, size_t nval);
  41 int device_property_read_u32_array(struct device *dev, const char *propname,
  42                                    u32 *val, size_t nval);
  43 int device_property_read_u64_array(struct device *dev, const char *propname,
  44                                    u64 *val, size_t nval);
  45 int device_property_read_string_array(struct device *dev, const char *propname,
  46                                       const char **val, size_t nval);
  47 int device_property_read_string(struct device *dev, const char *propname,
  48                                 const char **val);
  49 int device_property_match_string(struct device *dev,
  50                                  const char *propname, const char *string);
  51
  52 bool fwnode_device_is_available(const struct fwnode_handle *fwnode);
  53 bool fwnode_property_present(const struct fwnode_handle *fwnode,
  54                              const char *propname);
  55 int fwnode_property_read_u8_array(const struct fwnode_handle *fwnode,
  56                                   const char *propname, u8 *val,
  57                                   size_t nval);
  58 int fwnode_property_read_u16_array(const struct fwnode_handle *fwnode,
  59                                    const char *propname, u16 *val,
  60                                    size_t nval);
  61 int fwnode_property_read_u32_array(const struct fwnode_handle *fwnode,
  62                                    const char *propname, u32 *val,
  63                                    size_t nval);
  64 int fwnode_property_read_u64_array(const struct fwnode_handle *fwnode,
  65                                    const char *propname, u64 *val,
  66                                    size_t nval);
  67 int fwnode_property_read_string_array(const struct fwnode_handle *fwnode,
  68                                       const char *propname, const char **val,
  69                                       size_t nval);
  70 int fwnode_property_read_string(const struct fwnode_handle *fwnode,
  71                                 const char *propname, const char **val);
  72 int fwnode_property_match_string(const struct fwnode_handle *fwnode,
  73                                  const char *propname, const char *string);
  74 int fwnode_property_get_reference_args(const struct fwnode_handle *fwnode,
  75                                        const char *prop, const char *nargs_prop,
  76                                        unsigned int nargs, unsigned int index,
  77                                        struct fwnode_reference_args *args);
  78
  79 struct fwnode_handle *fwnode_get_parent(const struct fwnode_handle *fwnode);
  80 struct fwnode_handle *fwnode_get_next_parent(
  81         struct fwnode_handle *fwnode);
  82 struct fwnode_handle *fwnode_get_next_child_node(
  83         const struct fwnode_handle *fwnode, struct fwnode_handle *child);
  84 struct fwnode_handle *fwnode_get_next_available_child_node(
  85         const struct fwnode_handle *fwnode, struct fwnode_handle *child);
  86
  87 #define fwnode_for_each_child_node(fwnode, child)                       \
  88         for (child = fwnode_get_next_child_node(fwnode, NULL); child;   \
  89              child = fwnode_get_next_child_node(fwnode, child))
  90
  91 #define fwnode_for_each_available_child_node(fwnode, child)                    \
  92         for (child = fwnode_get_next_available_child_node(fwnode, NULL); child;\
  93              child = fwnode_get_next_available_child_node(fwnode, child))
  94
  95 struct fwnode_handle *device_get_next_child_node(
  96         struct device *dev, struct fwnode_handle *child);
  97
  98 #define device_for_each_child_node(dev, child)                          \
  99         for (child = device_get_next_child_node(dev, NULL); child;      \
 100              child = device_get_next_child_node(dev, child))
 101
 102 struct fwnode_handle *fwnode_get_named_child_node(
 103         const struct fwnode_handle *fwnode, const char *childname);
 104 struct fwnode_handle *device_get_named_child_node(struct device *dev,
 105                                                   const char *childname);
 106
 107 struct fwnode_handle *fwnode_handle_get(struct fwnode_handle *fwnode);
 108 void fwnode_handle_put(struct fwnode_handle *fwnode);
 109
 110 int fwnode_irq_get(struct fwnode_handle *fwnode, unsigned int index);
 111
 112 unsigned int device_get_child_node_count(struct device *dev);
 113
 114 static inline bool device_property_read_bool(struct device *dev,
 115                                              const char *propname)
 116 {
 117         return device_property_present(dev, propname);
 118 }
 119
 120 static inline int device_property_read_u8(struct device *dev,
 121                                           const char *propname, u8 *val)
 122 {
 123         return device_property_read_u8_array(dev, propname, val, 1);
 124 }
 125
 126 static inline int device_property_read_u16(struct device *dev,
 127                                            const char *propname, u16 *val)
 128 {
 129         return device_property_read_u16_array(dev, propname, val, 1);
 130 }
 131
 132 static inline int device_property_read_u32(struct device *dev,
 133                                            const char *propname, u32 *val)
 134 {
 135         return device_property_read_u32_array(dev, propname, val, 1);
 136 }
 137
 138 static inline int device_property_read_u64(struct device *dev,
 139                                            const char *propname, u64 *val)
 140 {
 141         return device_property_read_u64_array(dev, propname, val, 1);
 142 }
 143
 144 static inline bool fwnode_property_read_bool(const struct fwnode_handle *fwnode,
 145                                              const char *propname)
 146 {
 147         return fwnode_property_present(fwnode, propname);
 148 }
 149
 150 static inline int fwnode_property_read_u8(const struct fwnode_handle *fwnode,
 151                                           const char *propname, u8 *val)
 152 {
 153         return fwnode_property_read_u8_array(fwnode, propname, val, 1);
 154 }
 155
 156 static inline int fwnode_property_read_u16(const struct fwnode_handle *fwnode,
 157                                            const char *propname, u16 *val)
 158 {
 159         return fwnode_property_read_u16_array(fwnode, propname, val, 1);
 160 }
 161
 162 static inline int fwnode_property_read_u32(const struct fwnode_handle *fwnode,
 163                                            const char *propname, u32 *val)
 164 {
 165         return fwnode_property_read_u32_array(fwnode, propname, val, 1);
 166 }
 167
 168 static inline int fwnode_property_read_u64(const struct fwnode_handle *fwnode,
 169                                            const char *propname, u64 *val)
 170 {
 171         return fwnode_property_read_u64_array(fwnode, propname, val, 1);
 172 }
 173
 174 /**
 175  * struct property_entry - "Built-in" device property representation.
 176  * @name: Name of the property.
 177  * @length: Length of data making up the value.
 178  * @is_array: True when the property is an array.
 179  * @type: Type of the data in unions.
 180  * @pointer: Pointer to the property (an array of items of the given type).
 181  * @value: Value of the property (when it is a single item of the given type).
 182  */
 183 struct property_entry {
 184         const char *name;
 185         size_t length;
 186         bool is_array;
 187         enum dev_prop_type type;
 188         union {
 189                 union {
 190                         const u8 *u8_data;
 191                         const u16 *u16_data;
 192                         const u32 *u32_data;
 193                         const u64 *u64_data;
 194                         const char * const *str;
 195                 } pointer;
 196                 union {
 197                         u8 u8_data;
 198                         u16 u16_data;
 199                         u32 u32_data;
 200                         u64 u64_data;
 201                         const char *str;
 202                 } value;
 203         };
 204 };
 205
 206 /*
 207  * Note: the below four initializers for the anonymous union are carefully
 208  * crafted to avoid gcc-4.4.4's problems with initialization of anon unions
 209  * and structs.
 210  */
 211
 212 #define PROPERTY_ENTRY_INTEGER_ARRAY(_name_, _type_, _Type_, _val_)     \
 213 (struct property_entry) {                                               \
 214         .name = _name_,                                                 \
 215         .length = ARRAY_SIZE(_val_) * sizeof(_type_),                   \
 216         .is_array = true,                                               \
 217         .type = DEV_PROP_##_Type_,                                      \
 218         { .pointer = { ._type_##_data = _val_ } },                      \
 219 }
 220
 221 #define PROPERTY_ENTRY_U8_ARRAY(_name_, _val_)                  \
 222         PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u8, U8, _val_)
 223 #define PROPERTY_ENTRY_U16_ARRAY(_name_, _val_)                 \
 224         PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u16, U16, _val_)
 225 #define PROPERTY_ENTRY_U32_ARRAY(_name_, _val_)                 \
 226         PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u32, U32, _val_)
 227 #define PROPERTY_ENTRY_U64_ARRAY(_name_, _val_)                 \
 228         PROPERTY_ENTRY_INTEGER_ARRAY(_name_, u64, U64, _val_)
 229
 230 #define PROPERTY_ENTRY_STRING_ARRAY(_name_, _val_)              \
 231 (struct property_entry) {                                       \
 232         .name = _name_,                                         \
 233         .length = ARRAY_SIZE(_val_) * sizeof(const char *),     \
 234         .is_array = true,                                       \
 235         .type = DEV_PROP_STRING,                                \
 236         { .pointer = { .str = _val_ } },                        \
 237 }
 238
 239 #define PROPERTY_ENTRY_INTEGER(_name_, _type_, _Type_, _val_)   \
 240 (struct property_entry) {                                       \
 241         .name = _name_,                                         \
 242         .length = sizeof(_type_),                               \
 243         .type = DEV_PROP_##_Type_,                              \
 244         { .value = { ._type_##_data = _val_ } },                \
 245 }
 246
 247 #define PROPERTY_ENTRY_U8(_name_, _val_)                \
 248         PROPERTY_ENTRY_INTEGER(_name_, u8, U8, _val_)
 249 #define PROPERTY_ENTRY_U16(_name_, _val_)               \
 250         PROPERTY_ENTRY_INTEGER(_name_, u16, U16, _val_)
 251 #define PROPERTY_ENTRY_U32(_name_, _val_)               \
 252         PROPERTY_ENTRY_INTEGER(_name_, u32, U32, _val_)
 253 #define PROPERTY_ENTRY_U64(_name_, _val_)               \
 254         PROPERTY_ENTRY_INTEGER(_name_, u64, U64, _val_)
 255
 256 #define PROPERTY_ENTRY_STRING(_name_, _val_)            \
 257 (struct property_entry) {                               \
 258         .name = _name_,                                 \
 259         .length = sizeof(const char *),                 \
 260         .type = DEV_PROP_STRING,                        \
 261         { .value = { .str = _val_ } },                  \
 262 }
 263
 264 #define PROPERTY_ENTRY_BOOL(_name_)             \
 265 (struct property_entry) {                       \
 266         .name = _name_,                         \
 267 }
 268
 269 struct property_entry *
 270 property_entries_dup(const struct property_entry *properties);
 271
 272 void property_entries_free(const struct property_entry *properties);
 273
 274 int device_add_properties(struct device *dev,
 275                           const struct property_entry *properties);
 276 void device_remove_properties(struct device *dev);
 277
 278 bool device_dma_supported(struct device *dev);
 279
 280 enum dev_dma_attr device_get_dma_attr(struct device *dev);
 281
 282 const void *device_get_match_data(struct device *dev);
 283
 284 int device_get_phy_mode(struct device *dev);
 285
 286 void *device_get_mac_address(struct device *dev, char *addr, int alen);
 287
 288 int fwnode_get_phy_mode(struct fwnode_handle *fwnode);
 289 void *fwnode_get_mac_address(struct fwnode_handle *fwnode,
 290                              char *addr, int alen);
 291 struct fwnode_handle *fwnode_graph_get_next_endpoint(
 292         const struct fwnode_handle *fwnode, struct fwnode_handle *prev);
 293 struct fwnode_handle *
 294 fwnode_graph_get_port_parent(const struct fwnode_handle *fwnode);
 295 struct fwnode_handle *fwnode_graph_get_remote_port_parent(
 296         const struct fwnode_handle *fwnode);
 297 struct fwnode_handle *fwnode_graph_get_remote_port(
 298         const struct fwnode_handle *fwnode);
 299 struct fwnode_handle *fwnode_graph_get_remote_endpoint(
 300         const struct fwnode_handle *fwnode);
 301 struct fwnode_handle *
 302 fwnode_graph_get_remote_node(const struct fwnode_handle *fwnode, u32 port,
 303                              u32 endpoint);
 304
 305 /*
 306  * Fwnode lookup flags
 307  *
 308  * @FWNODE_GRAPH_ENDPOINT_NEXT: In the case of no exact match, look for the
 309  *                              closest endpoint ID greater than the specified
 310  *                              one.
 311  * @FWNODE_GRAPH_DEVICE_DISABLED: That the device to which the remote
 312  *                                endpoint of the given endpoint belongs to,
 313  *                                may be disabled.
 314  */
 315 #define FWNODE_GRAPH_ENDPOINT_NEXT      BIT(0)
 316 #define FWNODE_GRAPH_DEVICE_DISABLED    BIT(1)
 317
 318 struct fwnode_handle *
 319 fwnode_graph_get_endpoint_by_id(const struct fwnode_handle *fwnode,
 320                                 u32 port, u32 endpoint, unsigned long flags);
 321
 322 #define fwnode_graph_for_each_endpoint(fwnode, child)                   \
 323         for (child = NULL;                                              \
 324              (child = fwnode_graph_get_next_endpoint(fwnode, child)); )
 325
 326 int fwnode_graph_parse_endpoint(const struct fwnode_handle *fwnode,
 327                                 struct fwnode_endpoint *endpoint);
 328
 329 /* -------------------------------------------------------------------------- */
 330 /* Software fwnode support - when HW description is incomplete or missing */
 331
 332 bool is_software_node(const struct fwnode_handle *fwnode);
 333
 334 int software_node_notify(struct device *dev, unsigned long action);
 335
 336 struct fwnode_handle *
 337 fwnode_create_software_node(const struct property_entry *properties,
 338                             const struct fwnode_handle *parent);
 339 void fwnode_remove_software_node(struct fwnode_handle *fwnode);
 340
 341 #endif /* _LINUX_PROPERTY_H_ */