1
2
3
4
5
6
7
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
17struct device;
18
19enum 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_REF,
26};
27
28enum dev_dma_attr {
29 DEV_DMA_NOT_SUPPORTED,
30 DEV_DMA_NON_COHERENT,
31 DEV_DMA_COHERENT,
32};
33
34struct fwnode_handle *dev_fwnode(struct device *dev);
35
36bool device_property_present(struct device *dev, const char *propname);
37int device_property_read_u8_array(struct device *dev, const char *propname,
38 u8 *val, size_t nval);
39int device_property_read_u16_array(struct device *dev, const char *propname,
40 u16 *val, size_t nval);
41int device_property_read_u32_array(struct device *dev, const char *propname,
42 u32 *val, size_t nval);
43int device_property_read_u64_array(struct device *dev, const char *propname,
44 u64 *val, size_t nval);
45int device_property_read_string_array(struct device *dev, const char *propname,
46 const char **val, size_t nval);
47int device_property_read_string(struct device *dev, const char *propname,
48 const char **val);
49int device_property_match_string(struct device *dev,
50 const char *propname, const char *string);
51
52bool fwnode_device_is_available(const struct fwnode_handle *fwnode);
53bool fwnode_property_present(const struct fwnode_handle *fwnode,
54 const char *propname);
55int fwnode_property_read_u8_array(const struct fwnode_handle *fwnode,
56 const char *propname, u8 *val,
57 size_t nval);
58int fwnode_property_read_u16_array(const struct fwnode_handle *fwnode,
59 const char *propname, u16 *val,
60 size_t nval);
61int fwnode_property_read_u32_array(const struct fwnode_handle *fwnode,
62 const char *propname, u32 *val,
63 size_t nval);
64int fwnode_property_read_u64_array(const struct fwnode_handle *fwnode,
65 const char *propname, u64 *val,
66 size_t nval);
67int fwnode_property_read_string_array(const struct fwnode_handle *fwnode,
68 const char *propname, const char **val,
69 size_t nval);
70int fwnode_property_read_string(const struct fwnode_handle *fwnode,
71 const char *propname, const char **val);
72int fwnode_property_match_string(const struct fwnode_handle *fwnode,
73 const char *propname, const char *string);
74int 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
79struct fwnode_handle *fwnode_find_reference(const struct fwnode_handle *fwnode,
80 const char *name,
81 unsigned int index);
82
83const char *fwnode_get_name(const struct fwnode_handle *fwnode);
84const char *fwnode_get_name_prefix(const struct fwnode_handle *fwnode);
85struct fwnode_handle *fwnode_get_parent(const struct fwnode_handle *fwnode);
86struct fwnode_handle *fwnode_get_next_parent(
87 struct fwnode_handle *fwnode);
88struct device *fwnode_get_next_parent_dev(struct fwnode_handle *fwnode);
89unsigned int fwnode_count_parents(const struct fwnode_handle *fwn);
90struct fwnode_handle *fwnode_get_nth_parent(struct fwnode_handle *fwn,
91 unsigned int depth);
92bool fwnode_is_ancestor_of(struct fwnode_handle *test_ancestor,
93 struct fwnode_handle *test_child);
94struct fwnode_handle *fwnode_get_next_child_node(
95 const struct fwnode_handle *fwnode, struct fwnode_handle *child);
96struct fwnode_handle *fwnode_get_next_available_child_node(
97 const struct fwnode_handle *fwnode, struct fwnode_handle *child);
98
99#define fwnode_for_each_child_node(fwnode, child) \
100 for (child = fwnode_get_next_child_node(fwnode, NULL); child; \
101 child = fwnode_get_next_child_node(fwnode, child))
102
103#define fwnode_for_each_available_child_node(fwnode, child) \
104 for (child = fwnode_get_next_available_child_node(fwnode, NULL); child;\
105 child = fwnode_get_next_available_child_node(fwnode, child))
106
107struct fwnode_handle *device_get_next_child_node(
108 struct device *dev, struct fwnode_handle *child);
109
110#define device_for_each_child_node(dev, child) \
111 for (child = device_get_next_child_node(dev, NULL); child; \
112 child = device_get_next_child_node(dev, child))
113
114struct fwnode_handle *fwnode_get_named_child_node(
115 const struct fwnode_handle *fwnode, const char *childname);
116struct fwnode_handle *device_get_named_child_node(struct device *dev,
117 const char *childname);
118
119struct fwnode_handle *fwnode_handle_get(struct fwnode_handle *fwnode);
120void fwnode_handle_put(struct fwnode_handle *fwnode);
121
122int fwnode_irq_get(const struct fwnode_handle *fwnode, unsigned int index);
123
124unsigned int device_get_child_node_count(struct device *dev);
125
126static inline bool device_property_read_bool(struct device *dev,
127 const char *propname)
128{
129 return device_property_present(dev, propname);
130}
131
132static inline int device_property_read_u8(struct device *dev,
133 const char *propname, u8 *val)
134{
135 return device_property_read_u8_array(dev, propname, val, 1);
136}
137
138static inline int device_property_read_u16(struct device *dev,
139 const char *propname, u16 *val)
140{
141 return device_property_read_u16_array(dev, propname, val, 1);
142}
143
144static inline int device_property_read_u32(struct device *dev,
145 const char *propname, u32 *val)
146{
147 return device_property_read_u32_array(dev, propname, val, 1);
148}
149
150static inline int device_property_read_u64(struct device *dev,
151 const char *propname, u64 *val)
152{
153 return device_property_read_u64_array(dev, propname, val, 1);
154}
155
156static inline int device_property_count_u8(struct device *dev, const char *propname)
157{
158 return device_property_read_u8_array(dev, propname, NULL, 0);
159}
160
161static inline int device_property_count_u16(struct device *dev, const char *propname)
162{
163 return device_property_read_u16_array(dev, propname, NULL, 0);
164}
165
166static inline int device_property_count_u32(struct device *dev, const char *propname)
167{
168 return device_property_read_u32_array(dev, propname, NULL, 0);
169}
170
171static inline int device_property_count_u64(struct device *dev, const char *propname)
172{
173 return device_property_read_u64_array(dev, propname, NULL, 0);
174}
175
176static inline int device_property_string_array_count(struct device *dev,
177 const char *propname)
178{
179 return device_property_read_string_array(dev, propname, NULL, 0);
180}
181
182static inline bool fwnode_property_read_bool(const struct fwnode_handle *fwnode,
183 const char *propname)
184{
185 return fwnode_property_present(fwnode, propname);
186}
187
188static inline int fwnode_property_read_u8(const struct fwnode_handle *fwnode,
189 const char *propname, u8 *val)
190{
191 return fwnode_property_read_u8_array(fwnode, propname, val, 1);
192}
193
194static inline int fwnode_property_read_u16(const struct fwnode_handle *fwnode,
195 const char *propname, u16 *val)
196{
197 return fwnode_property_read_u16_array(fwnode, propname, val, 1);
198}
199
200static inline int fwnode_property_read_u32(const struct fwnode_handle *fwnode,
201 const char *propname, u32 *val)
202{
203 return fwnode_property_read_u32_array(fwnode, propname, val, 1);
204}
205
206static inline int fwnode_property_read_u64(const struct fwnode_handle *fwnode,
207 const char *propname, u64 *val)
208{
209 return fwnode_property_read_u64_array(fwnode, propname, val, 1);
210}
211
212static inline int fwnode_property_count_u8(const struct fwnode_handle *fwnode,
213 const char *propname)
214{
215 return fwnode_property_read_u8_array(fwnode, propname, NULL, 0);
216}
217
218static inline int fwnode_property_count_u16(const struct fwnode_handle *fwnode,
219 const char *propname)
220{
221 return fwnode_property_read_u16_array(fwnode, propname, NULL, 0);
222}
223
224static inline int fwnode_property_count_u32(const struct fwnode_handle *fwnode,
225 const char *propname)
226{
227 return fwnode_property_read_u32_array(fwnode, propname, NULL, 0);
228}
229
230static inline int fwnode_property_count_u64(const struct fwnode_handle *fwnode,
231 const char *propname)
232{
233 return fwnode_property_read_u64_array(fwnode, propname, NULL, 0);
234}
235
236static inline int
237fwnode_property_string_array_count(const struct fwnode_handle *fwnode,
238 const char *propname)
239{
240 return fwnode_property_read_string_array(fwnode, propname, NULL, 0);
241}
242
243struct software_node;
244
245
246
247
248
249
250
251struct software_node_ref_args {
252 const struct software_node *node;
253 unsigned int nargs;
254 u64 args[NR_FWNODE_REFERENCE_ARGS];
255};
256
257#define SOFTWARE_NODE_REFERENCE(_ref_, ...) \
258(const struct software_node_ref_args) { \
259 .node = _ref_, \
260 .nargs = ARRAY_SIZE(((u64[]){ 0, ##__VA_ARGS__ })) - 1, \
261 .args = { __VA_ARGS__ }, \
262}
263
264
265
266
267
268
269
270
271
272
273struct property_entry {
274 const char *name;
275 size_t length;
276 bool is_inline;
277 enum dev_prop_type type;
278 union {
279 const void *pointer;
280 union {
281 u8 u8_data[sizeof(u64) / sizeof(u8)];
282 u16 u16_data[sizeof(u64) / sizeof(u16)];
283 u32 u32_data[sizeof(u64) / sizeof(u32)];
284 u64 u64_data[sizeof(u64) / sizeof(u64)];
285 const char *str[sizeof(u64) / sizeof(char *)];
286 } value;
287 };
288};
289
290
291
292
293
294
295
296#define __PROPERTY_ENTRY_ELEMENT_SIZE(_elem_) \
297 sizeof(((struct property_entry *)NULL)->value._elem_[0])
298
299#define __PROPERTY_ENTRY_ARRAY_ELSIZE_LEN(_name_, _elsize_, _Type_, \
300 _val_, _len_) \
301(struct property_entry) { \
302 .name = _name_, \
303 .length = (_len_) * (_elsize_), \
304 .type = DEV_PROP_##_Type_, \
305 { .pointer = _val_ }, \
306}
307
308#define __PROPERTY_ENTRY_ARRAY_LEN(_name_, _elem_, _Type_, _val_, _len_)\
309 __PROPERTY_ENTRY_ARRAY_ELSIZE_LEN(_name_, \
310 __PROPERTY_ENTRY_ELEMENT_SIZE(_elem_), \
311 _Type_, _val_, _len_)
312
313#define PROPERTY_ENTRY_U8_ARRAY_LEN(_name_, _val_, _len_) \
314 __PROPERTY_ENTRY_ARRAY_LEN(_name_, u8_data, U8, _val_, _len_)
315#define PROPERTY_ENTRY_U16_ARRAY_LEN(_name_, _val_, _len_) \
316 __PROPERTY_ENTRY_ARRAY_LEN(_name_, u16_data, U16, _val_, _len_)
317#define PROPERTY_ENTRY_U32_ARRAY_LEN(_name_, _val_, _len_) \
318 __PROPERTY_ENTRY_ARRAY_LEN(_name_, u32_data, U32, _val_, _len_)
319#define PROPERTY_ENTRY_U64_ARRAY_LEN(_name_, _val_, _len_) \
320 __PROPERTY_ENTRY_ARRAY_LEN(_name_, u64_data, U64, _val_, _len_)
321#define PROPERTY_ENTRY_STRING_ARRAY_LEN(_name_, _val_, _len_) \
322 __PROPERTY_ENTRY_ARRAY_LEN(_name_, str, STRING, _val_, _len_)
323#define PROPERTY_ENTRY_REF_ARRAY_LEN(_name_, _val_, _len_) \
324 __PROPERTY_ENTRY_ARRAY_ELSIZE_LEN(_name_, \
325 sizeof(struct software_node_ref_args), \
326 REF, _val_, _len_)
327
328#define PROPERTY_ENTRY_U8_ARRAY(_name_, _val_) \
329 PROPERTY_ENTRY_U8_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_))
330#define PROPERTY_ENTRY_U16_ARRAY(_name_, _val_) \
331 PROPERTY_ENTRY_U16_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_))
332#define PROPERTY_ENTRY_U32_ARRAY(_name_, _val_) \
333 PROPERTY_ENTRY_U32_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_))
334#define PROPERTY_ENTRY_U64_ARRAY(_name_, _val_) \
335 PROPERTY_ENTRY_U64_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_))
336#define PROPERTY_ENTRY_STRING_ARRAY(_name_, _val_) \
337 PROPERTY_ENTRY_STRING_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_))
338#define PROPERTY_ENTRY_REF_ARRAY(_name_, _val_) \
339 PROPERTY_ENTRY_REF_ARRAY_LEN(_name_, _val_, ARRAY_SIZE(_val_))
340
341#define __PROPERTY_ENTRY_ELEMENT(_name_, _elem_, _Type_, _val_) \
342(struct property_entry) { \
343 .name = _name_, \
344 .length = __PROPERTY_ENTRY_ELEMENT_SIZE(_elem_), \
345 .is_inline = true, \
346 .type = DEV_PROP_##_Type_, \
347 { .value = { ._elem_[0] = _val_ } }, \
348}
349
350#define PROPERTY_ENTRY_U8(_name_, _val_) \
351 __PROPERTY_ENTRY_ELEMENT(_name_, u8_data, U8, _val_)
352#define PROPERTY_ENTRY_U16(_name_, _val_) \
353 __PROPERTY_ENTRY_ELEMENT(_name_, u16_data, U16, _val_)
354#define PROPERTY_ENTRY_U32(_name_, _val_) \
355 __PROPERTY_ENTRY_ELEMENT(_name_, u32_data, U32, _val_)
356#define PROPERTY_ENTRY_U64(_name_, _val_) \
357 __PROPERTY_ENTRY_ELEMENT(_name_, u64_data, U64, _val_)
358#define PROPERTY_ENTRY_STRING(_name_, _val_) \
359 __PROPERTY_ENTRY_ELEMENT(_name_, str, STRING, _val_)
360
361#define PROPERTY_ENTRY_BOOL(_name_) \
362(struct property_entry) { \
363 .name = _name_, \
364 .is_inline = true, \
365}
366
367#define PROPERTY_ENTRY_REF(_name_, _ref_, ...) \
368(struct property_entry) { \
369 .name = _name_, \
370 .length = sizeof(struct software_node_ref_args), \
371 .type = DEV_PROP_REF, \
372 { .pointer = &SOFTWARE_NODE_REFERENCE(_ref_, ##__VA_ARGS__), }, \
373}
374
375struct property_entry *
376property_entries_dup(const struct property_entry *properties);
377
378void property_entries_free(const struct property_entry *properties);
379
380int device_add_properties(struct device *dev,
381 const struct property_entry *properties);
382void device_remove_properties(struct device *dev);
383
384bool device_dma_supported(struct device *dev);
385
386enum dev_dma_attr device_get_dma_attr(struct device *dev);
387
388const void *device_get_match_data(struct device *dev);
389
390int device_get_phy_mode(struct device *dev);
391
392void *device_get_mac_address(struct device *dev, char *addr, int alen);
393
394int fwnode_get_phy_mode(struct fwnode_handle *fwnode);
395void *fwnode_get_mac_address(struct fwnode_handle *fwnode,
396 char *addr, int alen);
397struct fwnode_handle *fwnode_graph_get_next_endpoint(
398 const struct fwnode_handle *fwnode, struct fwnode_handle *prev);
399struct fwnode_handle *
400fwnode_graph_get_port_parent(const struct fwnode_handle *fwnode);
401struct fwnode_handle *fwnode_graph_get_remote_port_parent(
402 const struct fwnode_handle *fwnode);
403struct fwnode_handle *fwnode_graph_get_remote_port(
404 const struct fwnode_handle *fwnode);
405struct fwnode_handle *fwnode_graph_get_remote_endpoint(
406 const struct fwnode_handle *fwnode);
407struct fwnode_handle *
408fwnode_graph_get_remote_node(const struct fwnode_handle *fwnode, u32 port,
409 u32 endpoint);
410
411static inline bool fwnode_graph_is_endpoint(struct fwnode_handle *fwnode)
412{
413 return fwnode_property_present(fwnode, "remote-endpoint");
414}
415
416
417
418
419
420
421
422
423
424
425
426#define FWNODE_GRAPH_ENDPOINT_NEXT BIT(0)
427#define FWNODE_GRAPH_DEVICE_DISABLED BIT(1)
428
429struct fwnode_handle *
430fwnode_graph_get_endpoint_by_id(const struct fwnode_handle *fwnode,
431 u32 port, u32 endpoint, unsigned long flags);
432
433#define fwnode_graph_for_each_endpoint(fwnode, child) \
434 for (child = NULL; \
435 (child = fwnode_graph_get_next_endpoint(fwnode, child)); )
436
437int fwnode_graph_parse_endpoint(const struct fwnode_handle *fwnode,
438 struct fwnode_endpoint *endpoint);
439
440typedef void *(*devcon_match_fn_t)(struct fwnode_handle *fwnode, const char *id,
441 void *data);
442
443void *fwnode_connection_find_match(struct fwnode_handle *fwnode,
444 const char *con_id, void *data,
445 devcon_match_fn_t match);
446
447static inline void *device_connection_find_match(struct device *dev,
448 const char *con_id, void *data,
449 devcon_match_fn_t match)
450{
451 return fwnode_connection_find_match(dev_fwnode(dev), con_id, data, match);
452}
453
454
455
456
457
458
459
460
461
462
463struct software_node {
464 const char *name;
465 const struct software_node *parent;
466 const struct property_entry *properties;
467};
468
469bool is_software_node(const struct fwnode_handle *fwnode);
470const struct software_node *
471to_software_node(const struct fwnode_handle *fwnode);
472struct fwnode_handle *software_node_fwnode(const struct software_node *node);
473
474const struct software_node *
475software_node_find_by_name(const struct software_node *parent,
476 const char *name);
477
478int software_node_register_nodes(const struct software_node *nodes);
479void software_node_unregister_nodes(const struct software_node *nodes);
480
481int software_node_register_node_group(const struct software_node **node_group);
482void software_node_unregister_node_group(const struct software_node **node_group);
483
484int software_node_register(const struct software_node *node);
485void software_node_unregister(const struct software_node *node);
486
487struct fwnode_handle *
488fwnode_create_software_node(const struct property_entry *properties,
489 const struct fwnode_handle *parent);
490void fwnode_remove_software_node(struct fwnode_handle *fwnode);
491
492int device_add_software_node(struct device *dev, const struct software_node *node);
493void device_remove_software_node(struct device *dev);
494
495int device_create_managed_software_node(struct device *dev,
496 const struct property_entry *properties,
497 const struct software_node *parent);
498
499#endif
500