1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * property.h - Unified device property interface.
5 * Copyright (C) 2014, Intel Corporation
10 #ifndef _LINUX_PROPERTY_H_
11 #define _LINUX_PROPERTY_H_
13 #include <linux/args.h>
14 #include <linux/bits.h>
15 #include <linux/fwnode.h>
16 #include <linux/stddef.h>
17 #include <linux/types.h>
31 DEV_DMA_NOT_SUPPORTED,
36 const struct fwnode_handle *__dev_fwnode_const(const struct device *dev);
37 struct fwnode_handle *__dev_fwnode(struct device *dev);
38 #define dev_fwnode(dev) \
40 const struct device *: __dev_fwnode_const, \
41 struct device *: __dev_fwnode)(dev)
43 bool device_property_present(const struct device *dev, const char *propname);
44 int device_property_read_u8_array(const struct device *dev, const char *propname,
45 u8 *val, size_t nval);
46 int device_property_read_u16_array(const struct device *dev, const char *propname,
47 u16 *val, size_t nval);
48 int device_property_read_u32_array(const struct device *dev, const char *propname,
49 u32 *val, size_t nval);
50 int device_property_read_u64_array(const struct device *dev, const char *propname,
51 u64 *val, size_t nval);
52 int device_property_read_string_array(const struct device *dev, const char *propname,
53 const char **val, size_t nval);
54 int device_property_read_string(const struct device *dev, const char *propname,
56 int device_property_match_string(const struct device *dev,
57 const char *propname, const char *string);
59 bool fwnode_property_present(const struct fwnode_handle *fwnode,
60 const char *propname);
61 int fwnode_property_read_u8_array(const struct fwnode_handle *fwnode,
62 const char *propname, u8 *val,
64 int fwnode_property_read_u16_array(const struct fwnode_handle *fwnode,
65 const char *propname, u16 *val,
67 int fwnode_property_read_u32_array(const struct fwnode_handle *fwnode,
68 const char *propname, u32 *val,
70 int fwnode_property_read_u64_array(const struct fwnode_handle *fwnode,
71 const char *propname, u64 *val,
73 int fwnode_property_read_string_array(const struct fwnode_handle *fwnode,
74 const char *propname, const char **val,
76 int fwnode_property_read_string(const struct fwnode_handle *fwnode,
77 const char *propname, const char **val);
78 int fwnode_property_match_string(const struct fwnode_handle *fwnode,
79 const char *propname, const char *string);
81 bool fwnode_device_is_available(const struct fwnode_handle *fwnode);
83 static inline bool fwnode_device_is_big_endian(const struct fwnode_handle *fwnode)
85 if (fwnode_property_present(fwnode, "big-endian"))
87 if (IS_ENABLED(CONFIG_CPU_BIG_ENDIAN) &&
88 fwnode_property_present(fwnode, "native-endian"))
94 bool fwnode_device_is_compatible(const struct fwnode_handle *fwnode, const char *compat)
96 return fwnode_property_match_string(fwnode, "compatible", compat) >= 0;
100 * device_is_big_endian - check if a device has BE registers
101 * @dev: Pointer to the struct device
103 * Returns: true if the device has a "big-endian" property, or if the kernel
104 * was compiled for BE *and* the device has a "native-endian" property.
105 * Returns false otherwise.
107 * Callers would nominally use ioread32be/iowrite32be if
108 * device_is_big_endian() == true, or readl/writel otherwise.
110 static inline bool device_is_big_endian(const struct device *dev)
112 return fwnode_device_is_big_endian(dev_fwnode(dev));
116 * device_is_compatible - match 'compatible' property of the device with a given string
117 * @dev: Pointer to the struct device
118 * @compat: The string to match 'compatible' property with
120 * Returns: true if matches, otherwise false.
122 static inline bool device_is_compatible(const struct device *dev, const char *compat)
124 return fwnode_device_is_compatible(dev_fwnode(dev), compat);
127 int fwnode_property_get_reference_args(const struct fwnode_handle *fwnode,
128 const char *prop, const char *nargs_prop,
129 unsigned int nargs, unsigned int index,
130 struct fwnode_reference_args *args);
132 struct fwnode_handle *fwnode_find_reference(const struct fwnode_handle *fwnode,
136 const char *fwnode_get_name(const struct fwnode_handle *fwnode);
137 const char *fwnode_get_name_prefix(const struct fwnode_handle *fwnode);
138 bool fwnode_name_eq(const struct fwnode_handle *fwnode, const char *name);
140 struct fwnode_handle *fwnode_get_parent(const struct fwnode_handle *fwnode);
141 struct fwnode_handle *fwnode_get_next_parent(struct fwnode_handle *fwnode);
143 #define fwnode_for_each_parent_node(fwnode, parent) \
144 for (parent = fwnode_get_parent(fwnode); parent; \
145 parent = fwnode_get_next_parent(parent))
147 struct device *fwnode_get_next_parent_dev(const struct fwnode_handle *fwnode);
148 unsigned int fwnode_count_parents(const struct fwnode_handle *fwn);
149 struct fwnode_handle *fwnode_get_nth_parent(struct fwnode_handle *fwn,
151 bool fwnode_is_ancestor_of(const struct fwnode_handle *ancestor, const struct fwnode_handle *child);
152 struct fwnode_handle *fwnode_get_next_child_node(
153 const struct fwnode_handle *fwnode, struct fwnode_handle *child);
154 struct fwnode_handle *fwnode_get_next_available_child_node(
155 const struct fwnode_handle *fwnode, struct fwnode_handle *child);
157 #define fwnode_for_each_child_node(fwnode, child) \
158 for (child = fwnode_get_next_child_node(fwnode, NULL); child; \
159 child = fwnode_get_next_child_node(fwnode, child))
161 #define fwnode_for_each_available_child_node(fwnode, child) \
162 for (child = fwnode_get_next_available_child_node(fwnode, NULL); child;\
163 child = fwnode_get_next_available_child_node(fwnode, child))
165 struct fwnode_handle *device_get_next_child_node(const struct device *dev,
166 struct fwnode_handle *child);
168 #define device_for_each_child_node(dev, child) \
169 for (child = device_get_next_child_node(dev, NULL); child; \
170 child = device_get_next_child_node(dev, child))
172 struct fwnode_handle *fwnode_get_named_child_node(const struct fwnode_handle *fwnode,
173 const char *childname);
174 struct fwnode_handle *device_get_named_child_node(const struct device *dev,
175 const char *childname);
177 struct fwnode_handle *fwnode_handle_get(struct fwnode_handle *fwnode);
178 void fwnode_handle_put(struct fwnode_handle *fwnode);
180 int fwnode_irq_get(const struct fwnode_handle *fwnode, unsigned int index);
181 int fwnode_irq_get_byname(const struct fwnode_handle *fwnode, const char *name);
183 unsigned int device_get_child_node_count(const struct device *dev);
185 static inline bool device_property_read_bool(const struct device *dev,
186 const char *propname)
188 return device_property_present(dev, propname);
191 static inline int device_property_read_u8(const struct device *dev,
192 const char *propname, u8 *val)
194 return device_property_read_u8_array(dev, propname, val, 1);
197 static inline int device_property_read_u16(const struct device *dev,
198 const char *propname, u16 *val)
200 return device_property_read_u16_array(dev, propname, val, 1);
203 static inline int device_property_read_u32(const struct device *dev,
204 const char *propname, u32 *val)
206 return device_property_read_u32_array(dev, propname, val, 1);
209 static inline int device_property_read_u64(const struct device *dev,
210 const char *propname, u64 *val)
212 return device_property_read_u64_array(dev, propname, val, 1);
215 static inline int device_property_count_u8(const struct device *dev, const char *propname)
217 return device_property_read_u8_array(dev, propname, NULL, 0);
220 static inline int device_property_count_u16(const struct device *dev, const char *propname)
222 return device_property_read_u16_array(dev, propname, NULL, 0);
225 static inline int device_property_count_u32(const struct device *dev, const char *propname)
227 return device_property_read_u32_array(dev, propname, NULL, 0);
230 static inline int device_property_count_u64(const struct device *dev, const char *propname)
232 return device_property_read_u64_array(dev, propname, NULL, 0);
235 static inline int device_property_string_array_count(const struct device *dev,
236 const char *propname)
238 return device_property_read_string_array(dev, propname, NULL, 0);
241 static inline bool fwnode_property_read_bool(const struct fwnode_handle *fwnode,
242 const char *propname)
244 return fwnode_property_present(fwnode, propname);
247 static inline int fwnode_property_read_u8(const struct fwnode_handle *fwnode,
248 const char *propname, u8 *val)
250 return fwnode_property_read_u8_array(fwnode, propname, val, 1);
253 static inline int fwnode_property_read_u16(const struct fwnode_handle *fwnode,
254 const char *propname, u16 *val)
256 return fwnode_property_read_u16_array(fwnode, propname, val, 1);
259 static inline int fwnode_property_read_u32(const struct fwnode_handle *fwnode,
260 const char *propname, u32 *val)
262 return fwnode_property_read_u32_array(fwnode, propname, val, 1);
265 static inline int fwnode_property_read_u64(const struct fwnode_handle *fwnode,
266 const char *propname, u64 *val)
268 return fwnode_property_read_u64_array(fwnode, propname, val, 1);
271 static inline int fwnode_property_count_u8(const struct fwnode_handle *fwnode,
272 const char *propname)
274 return fwnode_property_read_u8_array(fwnode, propname, NULL, 0);
277 static inline int fwnode_property_count_u16(const struct fwnode_handle *fwnode,
278 const char *propname)
280 return fwnode_property_read_u16_array(fwnode, propname, NULL, 0);
283 static inline int fwnode_property_count_u32(const struct fwnode_handle *fwnode,
284 const char *propname)
286 return fwnode_property_read_u32_array(fwnode, propname, NULL, 0);
289 static inline int fwnode_property_count_u64(const struct fwnode_handle *fwnode,
290 const char *propname)
292 return fwnode_property_read_u64_array(fwnode, propname, NULL, 0);
296 fwnode_property_string_array_count(const struct fwnode_handle *fwnode,
297 const char *propname)
299 return fwnode_property_read_string_array(fwnode, propname, NULL, 0);
302 struct software_node;
305 * struct software_node_ref_args - Reference property with additional arguments
306 * @node: Reference to a software node
307 * @nargs: Number of elements in @args array
308 * @args: Integer arguments
310 struct software_node_ref_args {
311 const struct software_node *node;
313 u64 args[NR_FWNODE_REFERENCE_ARGS];
316 #define SOFTWARE_NODE_REFERENCE(_ref_, ...) \
317 (const struct software_node_ref_args) { \
319 .nargs = COUNT_ARGS(__VA_ARGS__), \
320 .args = { __VA_ARGS__ }, \
324 * struct property_entry - "Built-in" device property representation.
325 * @name: Name of the property.
326 * @length: Length of data making up the value.
327 * @is_inline: True when the property value is stored inline.
328 * @type: Type of the data in unions.
329 * @pointer: Pointer to the property when it is not stored inline.
330 * @value: Value of the property when it is stored inline.
332 struct property_entry {
336 enum dev_prop_type type;
340 u8 u8_data[sizeof(u64) / sizeof(u8)];
341 u16 u16_data[sizeof(u64) / sizeof(u16)];
342 u32 u32_data[sizeof(u64) / sizeof(u32)];
343 u64 u64_data[sizeof(u64) / sizeof(u64)];
344 const char *str[sizeof(u64) / sizeof(char *)];
350 * Note: the below initializers for the anonymous union are carefully
351 * crafted to avoid gcc-4.4.4's problems with initialization of anon unions
354 #define __PROPERTY_ENTRY_ARRAY_LEN(_name_, _elem_, _Type_, _val_, _len_) \
355 (struct property_entry) { \
357 .length = (_len_) * sizeof_field(struct property_entry, value._elem_[0]), \
358 .type = DEV_PROP_##_Type_, \
359 { .pointer = _val_ }, \
362 #define PROPERTY_ENTRY_U8_ARRAY_LEN(_name_, _val_, _len_) \
363 __PROPERTY_ENTRY_ARRAY_LEN(_name_, u8_data, U8, _val_, _len_)
364 #define PROPERTY_ENTRY_U16_ARRAY_LEN(_name_, _val_, _len_) \
365 __PROPERTY_ENTRY_ARRAY_LEN(_name_, u16_data, U16, _val_, _len_)
366 #define PROPERTY_ENTRY_U32_ARRAY_LEN(_name_, _val_, _len_) \
367 __PROPERTY_ENTRY_ARRAY_LEN(_name_, u32_data, U32, _val_, _len_)
368 #define PROPERTY_ENTRY_U64_ARRAY_LEN(_name_, _val_, _len_) \
369 __PROPERTY_ENTRY_ARRAY_LEN(_name_, u64_data, U64, _val_, _len_)
370 #define PROPERTY_ENTRY_STRING_ARRAY_LEN(_name_, _val_, _len_) \
371 __PROPERTY_ENTRY_ARRAY_LEN(_name_, str, STRING, _val_, _len_)
373 #define PROPERTY_ENTRY_REF_ARRAY_LEN(_name_, _val_, _len_) \
374 (struct property_entry) { \
376 .length = (_len_) * sizeof(struct software_node_ref_args), \
377 .type = DEV_PROP_REF, \
378 { .pointer = _val_ }, \
381 #define PROPERTY_ENTRY_U8_ARRAY(_name_, _val_) \
382 PROPERTY_ENTRY_U8_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_))
383 #define PROPERTY_ENTRY_U16_ARRAY(_name_, _val_) \
384 PROPERTY_ENTRY_U16_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_))
385 #define PROPERTY_ENTRY_U32_ARRAY(_name_, _val_) \
386 PROPERTY_ENTRY_U32_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_))
387 #define PROPERTY_ENTRY_U64_ARRAY(_name_, _val_) \
388 PROPERTY_ENTRY_U64_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_))
389 #define PROPERTY_ENTRY_STRING_ARRAY(_name_, _val_) \
390 PROPERTY_ENTRY_STRING_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_))
391 #define PROPERTY_ENTRY_REF_ARRAY(_name_, _val_) \
392 PROPERTY_ENTRY_REF_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_))
394 #define __PROPERTY_ENTRY_ELEMENT(_name_, _elem_, _Type_, _val_) \
395 (struct property_entry) { \
397 .length = sizeof_field(struct property_entry, value._elem_[0]), \
399 .type = DEV_PROP_##_Type_, \
400 { .value = { ._elem_[0] = _val_ } }, \
403 #define PROPERTY_ENTRY_U8(_name_, _val_) \
404 __PROPERTY_ENTRY_ELEMENT(_name_, u8_data, U8, _val_)
405 #define PROPERTY_ENTRY_U16(_name_, _val_) \
406 __PROPERTY_ENTRY_ELEMENT(_name_, u16_data, U16, _val_)
407 #define PROPERTY_ENTRY_U32(_name_, _val_) \
408 __PROPERTY_ENTRY_ELEMENT(_name_, u32_data, U32, _val_)
409 #define PROPERTY_ENTRY_U64(_name_, _val_) \
410 __PROPERTY_ENTRY_ELEMENT(_name_, u64_data, U64, _val_)
411 #define PROPERTY_ENTRY_STRING(_name_, _val_) \
412 __PROPERTY_ENTRY_ELEMENT(_name_, str, STRING, _val_)
414 #define PROPERTY_ENTRY_REF(_name_, _ref_, ...) \
415 (struct property_entry) { \
417 .length = sizeof(struct software_node_ref_args), \
418 .type = DEV_PROP_REF, \
419 { .pointer = &SOFTWARE_NODE_REFERENCE(_ref_, ##__VA_ARGS__), }, \
422 #define PROPERTY_ENTRY_BOOL(_name_) \
423 (struct property_entry) { \
428 struct property_entry *
429 property_entries_dup(const struct property_entry *properties);
430 void property_entries_free(const struct property_entry *properties);
432 bool device_dma_supported(const struct device *dev);
433 enum dev_dma_attr device_get_dma_attr(const struct device *dev);
435 const void *device_get_match_data(const struct device *dev);
437 int device_get_phy_mode(struct device *dev);
438 int fwnode_get_phy_mode(const struct fwnode_handle *fwnode);
440 void __iomem *fwnode_iomap(struct fwnode_handle *fwnode, int index);
442 struct fwnode_handle *fwnode_graph_get_next_endpoint(
443 const struct fwnode_handle *fwnode, struct fwnode_handle *prev);
444 struct fwnode_handle *
445 fwnode_graph_get_port_parent(const struct fwnode_handle *fwnode);
446 struct fwnode_handle *fwnode_graph_get_remote_port_parent(
447 const struct fwnode_handle *fwnode);
448 struct fwnode_handle *fwnode_graph_get_remote_port(
449 const struct fwnode_handle *fwnode);
450 struct fwnode_handle *fwnode_graph_get_remote_endpoint(
451 const struct fwnode_handle *fwnode);
453 static inline bool fwnode_graph_is_endpoint(const struct fwnode_handle *fwnode)
455 return fwnode_property_present(fwnode, "remote-endpoint");
459 * Fwnode lookup flags
461 * @FWNODE_GRAPH_ENDPOINT_NEXT: In the case of no exact match, look for the
462 * closest endpoint ID greater than the specified
464 * @FWNODE_GRAPH_DEVICE_DISABLED: That the device to which the remote
465 * endpoint of the given endpoint belongs to,
466 * may be disabled, or that the endpoint is not
469 #define FWNODE_GRAPH_ENDPOINT_NEXT BIT(0)
470 #define FWNODE_GRAPH_DEVICE_DISABLED BIT(1)
472 struct fwnode_handle *
473 fwnode_graph_get_endpoint_by_id(const struct fwnode_handle *fwnode,
474 u32 port, u32 endpoint, unsigned long flags);
475 unsigned int fwnode_graph_get_endpoint_count(const struct fwnode_handle *fwnode,
476 unsigned long flags);
478 #define fwnode_graph_for_each_endpoint(fwnode, child) \
479 for (child = fwnode_graph_get_next_endpoint(fwnode, NULL); child; \
480 child = fwnode_graph_get_next_endpoint(fwnode, child))
482 int fwnode_graph_parse_endpoint(const struct fwnode_handle *fwnode,
483 struct fwnode_endpoint *endpoint);
485 typedef void *(*devcon_match_fn_t)(const struct fwnode_handle *fwnode, const char *id,
488 void *fwnode_connection_find_match(const struct fwnode_handle *fwnode,
489 const char *con_id, void *data,
490 devcon_match_fn_t match);
492 static inline void *device_connection_find_match(const struct device *dev,
493 const char *con_id, void *data,
494 devcon_match_fn_t match)
496 return fwnode_connection_find_match(dev_fwnode(dev), con_id, data, match);
499 int fwnode_connection_find_matches(const struct fwnode_handle *fwnode,
500 const char *con_id, void *data,
501 devcon_match_fn_t match,
502 void **matches, unsigned int matches_len);
504 /* -------------------------------------------------------------------------- */
505 /* Software fwnode support - when HW description is incomplete or missing */
508 * struct software_node - Software node description
509 * @name: Name of the software node
510 * @parent: Parent of the software node
511 * @properties: Array of device properties
513 struct software_node {
515 const struct software_node *parent;
516 const struct property_entry *properties;
519 #define SOFTWARE_NODE(_name_, _properties_, _parent_) \
520 (struct software_node) { \
522 .properties = _properties_, \
523 .parent = _parent_, \
526 bool is_software_node(const struct fwnode_handle *fwnode);
527 const struct software_node *
528 to_software_node(const struct fwnode_handle *fwnode);
529 struct fwnode_handle *software_node_fwnode(const struct software_node *node);
531 const struct software_node *
532 software_node_find_by_name(const struct software_node *parent,
535 int software_node_register_node_group(const struct software_node **node_group);
536 void software_node_unregister_node_group(const struct software_node **node_group);
538 int software_node_register(const struct software_node *node);
539 void software_node_unregister(const struct software_node *node);
541 struct fwnode_handle *
542 fwnode_create_software_node(const struct property_entry *properties,
543 const struct fwnode_handle *parent);
544 void fwnode_remove_software_node(struct fwnode_handle *fwnode);
546 int device_add_software_node(struct device *dev, const struct software_node *node);
547 void device_remove_software_node(struct device *dev);
549 int device_create_managed_software_node(struct device *dev,
550 const struct property_entry *properties,
551 const struct software_node *parent);
553 #endif /* _LINUX_PROPERTY_H_ */