1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * property.h - Unified device property interface.
5 * Copyright (C) 2014, Intel Corporation
6 * Authors: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
7 * Mika Westerberg <mika.westerberg@linux.intel.com>
10 #ifndef _LINUX_PROPERTY_H_
11 #define _LINUX_PROPERTY_H_
13 #include <linux/bits.h>
14 #include <linux/fwnode.h>
15 #include <linux/types.h>
29 DEV_DMA_NOT_SUPPORTED,
34 struct fwnode_handle *dev_fwnode(struct device *dev);
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,
49 int device_property_match_string(struct device *dev,
50 const char *propname, const char *string);
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,
58 int fwnode_property_read_u16_array(const struct fwnode_handle *fwnode,
59 const char *propname, u16 *val,
61 int fwnode_property_read_u32_array(const struct fwnode_handle *fwnode,
62 const char *propname, u32 *val,
64 int fwnode_property_read_u64_array(const struct fwnode_handle *fwnode,
65 const char *propname, u64 *val,
67 int fwnode_property_read_string_array(const struct fwnode_handle *fwnode,
68 const char *propname, const char **val,
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);
79 struct fwnode_handle *fwnode_find_reference(const struct fwnode_handle *fwnode,
83 const char *fwnode_get_name(const struct fwnode_handle *fwnode);
84 const char *fwnode_get_name_prefix(const struct fwnode_handle *fwnode);
85 struct fwnode_handle *fwnode_get_parent(const struct fwnode_handle *fwnode);
86 struct fwnode_handle *fwnode_get_next_parent(
87 struct fwnode_handle *fwnode);
88 unsigned int fwnode_count_parents(const struct fwnode_handle *fwn);
89 struct fwnode_handle *fwnode_get_nth_parent(struct fwnode_handle *fwn,
91 struct fwnode_handle *fwnode_get_next_child_node(
92 const struct fwnode_handle *fwnode, struct fwnode_handle *child);
93 struct fwnode_handle *fwnode_get_next_available_child_node(
94 const struct fwnode_handle *fwnode, struct fwnode_handle *child);
96 #define fwnode_for_each_child_node(fwnode, child) \
97 for (child = fwnode_get_next_child_node(fwnode, NULL); child; \
98 child = fwnode_get_next_child_node(fwnode, child))
100 #define fwnode_for_each_available_child_node(fwnode, child) \
101 for (child = fwnode_get_next_available_child_node(fwnode, NULL); child;\
102 child = fwnode_get_next_available_child_node(fwnode, child))
104 struct fwnode_handle *device_get_next_child_node(
105 struct device *dev, struct fwnode_handle *child);
107 #define device_for_each_child_node(dev, child) \
108 for (child = device_get_next_child_node(dev, NULL); child; \
109 child = device_get_next_child_node(dev, child))
111 struct fwnode_handle *fwnode_get_named_child_node(
112 const struct fwnode_handle *fwnode, const char *childname);
113 struct fwnode_handle *device_get_named_child_node(struct device *dev,
114 const char *childname);
116 struct fwnode_handle *fwnode_handle_get(struct fwnode_handle *fwnode);
117 void fwnode_handle_put(struct fwnode_handle *fwnode);
119 int fwnode_irq_get(struct fwnode_handle *fwnode, unsigned int index);
121 unsigned int device_get_child_node_count(struct device *dev);
123 static inline bool device_property_read_bool(struct device *dev,
124 const char *propname)
126 return device_property_present(dev, propname);
129 static inline int device_property_read_u8(struct device *dev,
130 const char *propname, u8 *val)
132 return device_property_read_u8_array(dev, propname, val, 1);
135 static inline int device_property_read_u16(struct device *dev,
136 const char *propname, u16 *val)
138 return device_property_read_u16_array(dev, propname, val, 1);
141 static inline int device_property_read_u32(struct device *dev,
142 const char *propname, u32 *val)
144 return device_property_read_u32_array(dev, propname, val, 1);
147 static inline int device_property_read_u64(struct device *dev,
148 const char *propname, u64 *val)
150 return device_property_read_u64_array(dev, propname, val, 1);
153 static inline int device_property_count_u8(struct device *dev, const char *propname)
155 return device_property_read_u8_array(dev, propname, NULL, 0);
158 static inline int device_property_count_u16(struct device *dev, const char *propname)
160 return device_property_read_u16_array(dev, propname, NULL, 0);
163 static inline int device_property_count_u32(struct device *dev, const char *propname)
165 return device_property_read_u32_array(dev, propname, NULL, 0);
168 static inline int device_property_count_u64(struct device *dev, const char *propname)
170 return device_property_read_u64_array(dev, propname, NULL, 0);
173 static inline int device_property_string_array_count(struct device *dev,
174 const char *propname)
176 return device_property_read_string_array(dev, propname, NULL, 0);
179 static inline bool fwnode_property_read_bool(const struct fwnode_handle *fwnode,
180 const char *propname)
182 return fwnode_property_present(fwnode, propname);
185 static inline int fwnode_property_read_u8(const struct fwnode_handle *fwnode,
186 const char *propname, u8 *val)
188 return fwnode_property_read_u8_array(fwnode, propname, val, 1);
191 static inline int fwnode_property_read_u16(const struct fwnode_handle *fwnode,
192 const char *propname, u16 *val)
194 return fwnode_property_read_u16_array(fwnode, propname, val, 1);
197 static inline int fwnode_property_read_u32(const struct fwnode_handle *fwnode,
198 const char *propname, u32 *val)
200 return fwnode_property_read_u32_array(fwnode, propname, val, 1);
203 static inline int fwnode_property_read_u64(const struct fwnode_handle *fwnode,
204 const char *propname, u64 *val)
206 return fwnode_property_read_u64_array(fwnode, propname, val, 1);
209 static inline int fwnode_property_count_u8(const struct fwnode_handle *fwnode,
210 const char *propname)
212 return fwnode_property_read_u8_array(fwnode, propname, NULL, 0);
215 static inline int fwnode_property_count_u16(const struct fwnode_handle *fwnode,
216 const char *propname)
218 return fwnode_property_read_u16_array(fwnode, propname, NULL, 0);
221 static inline int fwnode_property_count_u32(const struct fwnode_handle *fwnode,
222 const char *propname)
224 return fwnode_property_read_u32_array(fwnode, propname, NULL, 0);
227 static inline int fwnode_property_count_u64(const struct fwnode_handle *fwnode,
228 const char *propname)
230 return fwnode_property_read_u64_array(fwnode, propname, NULL, 0);
234 fwnode_property_string_array_count(const struct fwnode_handle *fwnode,
235 const char *propname)
237 return fwnode_property_read_string_array(fwnode, propname, NULL, 0);
240 struct software_node;
243 * struct software_node_ref_args - Reference property with additional arguments
244 * @node: Reference to a software node
245 * @nargs: Number of elements in @args array
246 * @args: Integer arguments
248 struct software_node_ref_args {
249 const struct software_node *node;
251 u64 args[NR_FWNODE_REFERENCE_ARGS];
255 * struct property_entry - "Built-in" device property representation.
256 * @name: Name of the property.
257 * @length: Length of data making up the value.
258 * @is_inline: True when the property value is stored inline.
259 * @type: Type of the data in unions.
260 * @pointer: Pointer to the property when it is not stored inline.
261 * @value: Value of the property when it is stored inline.
263 struct property_entry {
267 enum dev_prop_type type;
271 u8 u8_data[sizeof(u64) / sizeof(u8)];
272 u16 u16_data[sizeof(u64) / sizeof(u16)];
273 u32 u32_data[sizeof(u64) / sizeof(u32)];
274 u64 u64_data[sizeof(u64) / sizeof(u64)];
275 const char *str[sizeof(u64) / sizeof(char *)];
281 * Note: the below initializers for the anonymous union are carefully
282 * crafted to avoid gcc-4.4.4's problems with initialization of anon unions
286 #define __PROPERTY_ENTRY_ELEMENT_SIZE(_elem_) \
287 sizeof(((struct property_entry *)NULL)->value._elem_[0])
289 #define __PROPERTY_ENTRY_ARRAY_ELSIZE_LEN(_name_, _elsize_, _Type_, \
291 (struct property_entry) { \
293 .length = (_len_) * (_elsize_), \
294 .type = DEV_PROP_##_Type_, \
295 { .pointer = _val_ }, \
298 #define __PROPERTY_ENTRY_ARRAY_LEN(_name_, _elem_, _Type_, _val_, _len_)\
299 __PROPERTY_ENTRY_ARRAY_ELSIZE_LEN(_name_, \
300 __PROPERTY_ENTRY_ELEMENT_SIZE(_elem_), \
301 _Type_, _val_, _len_)
303 #define PROPERTY_ENTRY_U8_ARRAY_LEN(_name_, _val_, _len_) \
304 __PROPERTY_ENTRY_ARRAY_LEN(_name_, u8_data, U8, _val_, _len_)
305 #define PROPERTY_ENTRY_U16_ARRAY_LEN(_name_, _val_, _len_) \
306 __PROPERTY_ENTRY_ARRAY_LEN(_name_, u16_data, U16, _val_, _len_)
307 #define PROPERTY_ENTRY_U32_ARRAY_LEN(_name_, _val_, _len_) \
308 __PROPERTY_ENTRY_ARRAY_LEN(_name_, u32_data, U32, _val_, _len_)
309 #define PROPERTY_ENTRY_U64_ARRAY_LEN(_name_, _val_, _len_) \
310 __PROPERTY_ENTRY_ARRAY_LEN(_name_, u64_data, U64, _val_, _len_)
311 #define PROPERTY_ENTRY_STRING_ARRAY_LEN(_name_, _val_, _len_) \
312 __PROPERTY_ENTRY_ARRAY_LEN(_name_, str, STRING, _val_, _len_)
313 #define PROPERTY_ENTRY_REF_ARRAY_LEN(_name_, _val_, _len_) \
314 __PROPERTY_ENTRY_ARRAY_ELSIZE_LEN(_name_, \
315 sizeof(struct software_node_ref_args), \
318 #define PROPERTY_ENTRY_U8_ARRAY(_name_, _val_) \
319 PROPERTY_ENTRY_U8_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_))
320 #define PROPERTY_ENTRY_U16_ARRAY(_name_, _val_) \
321 PROPERTY_ENTRY_U16_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_))
322 #define PROPERTY_ENTRY_U32_ARRAY(_name_, _val_) \
323 PROPERTY_ENTRY_U32_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_))
324 #define PROPERTY_ENTRY_U64_ARRAY(_name_, _val_) \
325 PROPERTY_ENTRY_U64_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_))
326 #define PROPERTY_ENTRY_STRING_ARRAY(_name_, _val_) \
327 PROPERTY_ENTRY_STRING_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_))
328 #define PROPERTY_ENTRY_REF_ARRAY(_name_, _val_) \
329 PROPERTY_ENTRY_REF_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_))
331 #define __PROPERTY_ENTRY_ELEMENT(_name_, _elem_, _Type_, _val_) \
332 (struct property_entry) { \
334 .length = __PROPERTY_ENTRY_ELEMENT_SIZE(_elem_), \
336 .type = DEV_PROP_##_Type_, \
337 { .value = { ._elem_[0] = _val_ } }, \
340 #define PROPERTY_ENTRY_U8(_name_, _val_) \
341 __PROPERTY_ENTRY_ELEMENT(_name_, u8_data, U8, _val_)
342 #define PROPERTY_ENTRY_U16(_name_, _val_) \
343 __PROPERTY_ENTRY_ELEMENT(_name_, u16_data, U16, _val_)
344 #define PROPERTY_ENTRY_U32(_name_, _val_) \
345 __PROPERTY_ENTRY_ELEMENT(_name_, u32_data, U32, _val_)
346 #define PROPERTY_ENTRY_U64(_name_, _val_) \
347 __PROPERTY_ENTRY_ELEMENT(_name_, u64_data, U64, _val_)
348 #define PROPERTY_ENTRY_STRING(_name_, _val_) \
349 __PROPERTY_ENTRY_ELEMENT(_name_, str, STRING, _val_)
351 #define PROPERTY_ENTRY_BOOL(_name_) \
352 (struct property_entry) { \
357 #define PROPERTY_ENTRY_REF(_name_, _ref_, ...) \
358 (struct property_entry) { \
360 .length = sizeof(struct software_node_ref_args), \
361 .type = DEV_PROP_REF, \
362 { .pointer = &(const struct software_node_ref_args) { \
364 .nargs = ARRAY_SIZE(((u64[]){ 0, ##__VA_ARGS__ })) - 1, \
365 .args = { __VA_ARGS__ }, \
369 struct property_entry *
370 property_entries_dup(const struct property_entry *properties);
372 void property_entries_free(const struct property_entry *properties);
374 int device_add_properties(struct device *dev,
375 const struct property_entry *properties);
376 void device_remove_properties(struct device *dev);
378 bool device_dma_supported(struct device *dev);
380 enum dev_dma_attr device_get_dma_attr(struct device *dev);
382 const void *device_get_match_data(struct device *dev);
384 int device_get_phy_mode(struct device *dev);
386 void *device_get_mac_address(struct device *dev, char *addr, int alen);
388 int fwnode_get_phy_mode(struct fwnode_handle *fwnode);
389 void *fwnode_get_mac_address(struct fwnode_handle *fwnode,
390 char *addr, int alen);
391 struct fwnode_handle *fwnode_graph_get_next_endpoint(
392 const struct fwnode_handle *fwnode, struct fwnode_handle *prev);
393 struct fwnode_handle *
394 fwnode_graph_get_port_parent(const struct fwnode_handle *fwnode);
395 struct fwnode_handle *fwnode_graph_get_remote_port_parent(
396 const struct fwnode_handle *fwnode);
397 struct fwnode_handle *fwnode_graph_get_remote_port(
398 const struct fwnode_handle *fwnode);
399 struct fwnode_handle *fwnode_graph_get_remote_endpoint(
400 const struct fwnode_handle *fwnode);
401 struct fwnode_handle *
402 fwnode_graph_get_remote_node(const struct fwnode_handle *fwnode, u32 port,
405 static inline bool fwnode_graph_is_endpoint(struct fwnode_handle *fwnode)
407 return fwnode_property_present(fwnode, "remote-endpoint");
411 * Fwnode lookup flags
413 * @FWNODE_GRAPH_ENDPOINT_NEXT: In the case of no exact match, look for the
414 * closest endpoint ID greater than the specified
416 * @FWNODE_GRAPH_DEVICE_DISABLED: That the device to which the remote
417 * endpoint of the given endpoint belongs to,
420 #define FWNODE_GRAPH_ENDPOINT_NEXT BIT(0)
421 #define FWNODE_GRAPH_DEVICE_DISABLED BIT(1)
423 struct fwnode_handle *
424 fwnode_graph_get_endpoint_by_id(const struct fwnode_handle *fwnode,
425 u32 port, u32 endpoint, unsigned long flags);
427 #define fwnode_graph_for_each_endpoint(fwnode, child) \
429 (child = fwnode_graph_get_next_endpoint(fwnode, child)); )
431 int fwnode_graph_parse_endpoint(const struct fwnode_handle *fwnode,
432 struct fwnode_endpoint *endpoint);
434 typedef void *(*devcon_match_fn_t)(struct fwnode_handle *fwnode, const char *id,
437 void *fwnode_connection_find_match(struct fwnode_handle *fwnode,
438 const char *con_id, void *data,
439 devcon_match_fn_t match);
441 static inline void *device_connection_find_match(struct device *dev,
442 const char *con_id, void *data,
443 devcon_match_fn_t match)
445 return fwnode_connection_find_match(dev_fwnode(dev), con_id, data, match);
448 /* -------------------------------------------------------------------------- */
449 /* Software fwnode support - when HW description is incomplete or missing */
452 * struct software_node - Software node description
453 * @name: Name of the software node
454 * @parent: Parent of the software node
455 * @properties: Array of device properties
457 struct software_node {
459 const struct software_node *parent;
460 const struct property_entry *properties;
463 bool is_software_node(const struct fwnode_handle *fwnode);
464 const struct software_node *
465 to_software_node(const struct fwnode_handle *fwnode);
466 struct fwnode_handle *software_node_fwnode(const struct software_node *node);
468 const struct software_node *
469 software_node_find_by_name(const struct software_node *parent,
472 int software_node_register_nodes(const struct software_node *nodes);
473 void software_node_unregister_nodes(const struct software_node *nodes);
475 int software_node_register_node_group(const struct software_node **node_group);
476 void software_node_unregister_node_group(const struct software_node **node_group);
478 int software_node_register(const struct software_node *node);
479 void software_node_unregister(const struct software_node *node);
481 int software_node_notify(struct device *dev, unsigned long action);
483 struct fwnode_handle *
484 fwnode_create_software_node(const struct property_entry *properties,
485 const struct fwnode_handle *parent);
486 void fwnode_remove_software_node(struct fwnode_handle *fwnode);
488 #endif /* _LINUX_PROPERTY_H_ */