1 // SPDX-License-Identifier: GPL-2.0
3 * property.c - 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 #include <linux/acpi.h>
11 #include <linux/export.h>
12 #include <linux/kernel.h>
14 #include <linux/of_address.h>
15 #include <linux/of_graph.h>
16 #include <linux/of_irq.h>
17 #include <linux/property.h>
18 #include <linux/etherdevice.h>
19 #include <linux/phy.h>
21 struct fwnode_handle *dev_fwnode(struct device *dev)
23 return IS_ENABLED(CONFIG_OF) && dev->of_node ?
24 &dev->of_node->fwnode : dev->fwnode;
26 EXPORT_SYMBOL_GPL(dev_fwnode);
29 * device_property_present - check if a property of a device is present
30 * @dev: Device whose property is being checked
31 * @propname: Name of the property
33 * Check if property @propname is present in the device firmware description.
35 bool device_property_present(struct device *dev, const char *propname)
37 return fwnode_property_present(dev_fwnode(dev), propname);
39 EXPORT_SYMBOL_GPL(device_property_present);
42 * fwnode_property_present - check if a property of a firmware node is present
43 * @fwnode: Firmware node whose property to check
44 * @propname: Name of the property
46 bool fwnode_property_present(const struct fwnode_handle *fwnode,
51 ret = fwnode_call_bool_op(fwnode, property_present, propname);
52 if (ret == false && !IS_ERR_OR_NULL(fwnode) &&
53 !IS_ERR_OR_NULL(fwnode->secondary))
54 ret = fwnode_call_bool_op(fwnode->secondary, property_present,
58 EXPORT_SYMBOL_GPL(fwnode_property_present);
61 * device_property_read_u8_array - return a u8 array property of a device
62 * @dev: Device to get the property of
63 * @propname: Name of the property
64 * @val: The values are stored here or %NULL to return the number of values
65 * @nval: Size of the @val array
67 * Function reads an array of u8 properties with @propname from the device
68 * firmware description and stores them to @val if found.
70 * Return: number of values if @val was %NULL,
71 * %0 if the property was found (success),
72 * %-EINVAL if given arguments are not valid,
73 * %-ENODATA if the property does not have a value,
74 * %-EPROTO if the property is not an array of numbers,
75 * %-EOVERFLOW if the size of the property is not as expected.
76 * %-ENXIO if no suitable firmware interface is present.
78 int device_property_read_u8_array(struct device *dev, const char *propname,
81 return fwnode_property_read_u8_array(dev_fwnode(dev), propname, val, nval);
83 EXPORT_SYMBOL_GPL(device_property_read_u8_array);
86 * device_property_read_u16_array - return a u16 array property of a device
87 * @dev: Device to get the property of
88 * @propname: Name of the property
89 * @val: The values are stored here or %NULL to return the number of values
90 * @nval: Size of the @val array
92 * Function reads an array of u16 properties with @propname from the device
93 * firmware description and stores them to @val if found.
95 * Return: number of values if @val was %NULL,
96 * %0 if the property was found (success),
97 * %-EINVAL if given arguments are not valid,
98 * %-ENODATA if the property does not have a value,
99 * %-EPROTO if the property is not an array of numbers,
100 * %-EOVERFLOW if the size of the property is not as expected.
101 * %-ENXIO if no suitable firmware interface is present.
103 int device_property_read_u16_array(struct device *dev, const char *propname,
104 u16 *val, size_t nval)
106 return fwnode_property_read_u16_array(dev_fwnode(dev), propname, val, nval);
108 EXPORT_SYMBOL_GPL(device_property_read_u16_array);
111 * device_property_read_u32_array - return a u32 array property of a device
112 * @dev: Device to get the property of
113 * @propname: Name of the property
114 * @val: The values are stored here or %NULL to return the number of values
115 * @nval: Size of the @val array
117 * Function reads an array of u32 properties with @propname from the device
118 * firmware description and stores them to @val if found.
120 * Return: number of values if @val was %NULL,
121 * %0 if the property was found (success),
122 * %-EINVAL if given arguments are not valid,
123 * %-ENODATA if the property does not have a value,
124 * %-EPROTO if the property is not an array of numbers,
125 * %-EOVERFLOW if the size of the property is not as expected.
126 * %-ENXIO if no suitable firmware interface is present.
128 int device_property_read_u32_array(struct device *dev, const char *propname,
129 u32 *val, size_t nval)
131 return fwnode_property_read_u32_array(dev_fwnode(dev), propname, val, nval);
133 EXPORT_SYMBOL_GPL(device_property_read_u32_array);
136 * device_property_read_u64_array - return a u64 array property of a device
137 * @dev: Device to get the property of
138 * @propname: Name of the property
139 * @val: The values are stored here or %NULL to return the number of values
140 * @nval: Size of the @val array
142 * Function reads an array of u64 properties with @propname from the device
143 * firmware description and stores them to @val if found.
145 * Return: number of values if @val was %NULL,
146 * %0 if the property was found (success),
147 * %-EINVAL if given arguments are not valid,
148 * %-ENODATA if the property does not have a value,
149 * %-EPROTO if the property is not an array of numbers,
150 * %-EOVERFLOW if the size of the property is not as expected.
151 * %-ENXIO if no suitable firmware interface is present.
153 int device_property_read_u64_array(struct device *dev, const char *propname,
154 u64 *val, size_t nval)
156 return fwnode_property_read_u64_array(dev_fwnode(dev), propname, val, nval);
158 EXPORT_SYMBOL_GPL(device_property_read_u64_array);
161 * device_property_read_string_array - return a string array property of device
162 * @dev: Device to get the property of
163 * @propname: Name of the property
164 * @val: The values are stored here or %NULL to return the number of values
165 * @nval: Size of the @val array
167 * Function reads an array of string properties with @propname from the device
168 * firmware description and stores them to @val if found.
170 * Return: number of values read on success if @val is non-NULL,
171 * number of values available on success if @val is NULL,
172 * %-EINVAL if given arguments are not valid,
173 * %-ENODATA if the property does not have a value,
174 * %-EPROTO or %-EILSEQ if the property is not an array of strings,
175 * %-EOVERFLOW if the size of the property is not as expected.
176 * %-ENXIO if no suitable firmware interface is present.
178 int device_property_read_string_array(struct device *dev, const char *propname,
179 const char **val, size_t nval)
181 return fwnode_property_read_string_array(dev_fwnode(dev), propname, val, nval);
183 EXPORT_SYMBOL_GPL(device_property_read_string_array);
186 * device_property_read_string - return a string property of a device
187 * @dev: Device to get the property of
188 * @propname: Name of the property
189 * @val: The value is stored here
191 * Function reads property @propname from the device firmware description and
192 * stores the value into @val if found. The value is checked to be a string.
194 * Return: %0 if the property was found (success),
195 * %-EINVAL if given arguments are not valid,
196 * %-ENODATA if the property does not have a value,
197 * %-EPROTO or %-EILSEQ if the property type is not a string.
198 * %-ENXIO if no suitable firmware interface is present.
200 int device_property_read_string(struct device *dev, const char *propname,
203 return fwnode_property_read_string(dev_fwnode(dev), propname, val);
205 EXPORT_SYMBOL_GPL(device_property_read_string);
208 * device_property_match_string - find a string in an array and return index
209 * @dev: Device to get the property of
210 * @propname: Name of the property holding the array
211 * @string: String to look for
213 * Find a given string in a string array and if it is found return the
216 * Return: %0 if the property was found (success),
217 * %-EINVAL if given arguments are not valid,
218 * %-ENODATA if the property does not have a value,
219 * %-EPROTO if the property is not an array of strings,
220 * %-ENXIO if no suitable firmware interface is present.
222 int device_property_match_string(struct device *dev, const char *propname,
225 return fwnode_property_match_string(dev_fwnode(dev), propname, string);
227 EXPORT_SYMBOL_GPL(device_property_match_string);
229 static int fwnode_property_read_int_array(const struct fwnode_handle *fwnode,
230 const char *propname,
231 unsigned int elem_size, void *val,
236 ret = fwnode_call_int_op(fwnode, property_read_int_array, propname,
237 elem_size, val, nval);
238 if (ret == -EINVAL && !IS_ERR_OR_NULL(fwnode) &&
239 !IS_ERR_OR_NULL(fwnode->secondary))
240 ret = fwnode_call_int_op(
241 fwnode->secondary, property_read_int_array, propname,
242 elem_size, val, nval);
248 * fwnode_property_read_u8_array - return a u8 array property of firmware node
249 * @fwnode: Firmware node to get the property of
250 * @propname: Name of the property
251 * @val: The values are stored here or %NULL to return the number of values
252 * @nval: Size of the @val array
254 * Read an array of u8 properties with @propname from @fwnode and stores them to
257 * Return: number of values if @val was %NULL,
258 * %0 if the property was found (success),
259 * %-EINVAL if given arguments are not valid,
260 * %-ENODATA if the property does not have a value,
261 * %-EPROTO if the property is not an array of numbers,
262 * %-EOVERFLOW if the size of the property is not as expected,
263 * %-ENXIO if no suitable firmware interface is present.
265 int fwnode_property_read_u8_array(const struct fwnode_handle *fwnode,
266 const char *propname, u8 *val, size_t nval)
268 return fwnode_property_read_int_array(fwnode, propname, sizeof(u8),
271 EXPORT_SYMBOL_GPL(fwnode_property_read_u8_array);
274 * fwnode_property_read_u16_array - return a u16 array property of firmware node
275 * @fwnode: Firmware node to get the property of
276 * @propname: Name of the property
277 * @val: The values are stored here or %NULL to return the number of values
278 * @nval: Size of the @val array
280 * Read an array of u16 properties with @propname from @fwnode and store them to
283 * Return: number of values if @val was %NULL,
284 * %0 if the property was found (success),
285 * %-EINVAL if given arguments are not valid,
286 * %-ENODATA if the property does not have a value,
287 * %-EPROTO if the property is not an array of numbers,
288 * %-EOVERFLOW if the size of the property is not as expected,
289 * %-ENXIO if no suitable firmware interface is present.
291 int fwnode_property_read_u16_array(const struct fwnode_handle *fwnode,
292 const char *propname, u16 *val, size_t nval)
294 return fwnode_property_read_int_array(fwnode, propname, sizeof(u16),
297 EXPORT_SYMBOL_GPL(fwnode_property_read_u16_array);
300 * fwnode_property_read_u32_array - return a u32 array property of firmware node
301 * @fwnode: Firmware node to get the property of
302 * @propname: Name of the property
303 * @val: The values are stored here or %NULL to return the number of values
304 * @nval: Size of the @val array
306 * Read an array of u32 properties with @propname from @fwnode store them to
309 * Return: number of values if @val was %NULL,
310 * %0 if the property was found (success),
311 * %-EINVAL if given arguments are not valid,
312 * %-ENODATA if the property does not have a value,
313 * %-EPROTO if the property is not an array of numbers,
314 * %-EOVERFLOW if the size of the property is not as expected,
315 * %-ENXIO if no suitable firmware interface is present.
317 int fwnode_property_read_u32_array(const struct fwnode_handle *fwnode,
318 const char *propname, u32 *val, size_t nval)
320 return fwnode_property_read_int_array(fwnode, propname, sizeof(u32),
323 EXPORT_SYMBOL_GPL(fwnode_property_read_u32_array);
326 * fwnode_property_read_u64_array - return a u64 array property firmware node
327 * @fwnode: Firmware node to get the property of
328 * @propname: Name of the property
329 * @val: The values are stored here or %NULL to return the number of values
330 * @nval: Size of the @val array
332 * Read an array of u64 properties with @propname from @fwnode and store them to
335 * Return: number of values if @val was %NULL,
336 * %0 if the property was found (success),
337 * %-EINVAL if given arguments are not valid,
338 * %-ENODATA if the property does not have a value,
339 * %-EPROTO if the property is not an array of numbers,
340 * %-EOVERFLOW if the size of the property is not as expected,
341 * %-ENXIO if no suitable firmware interface is present.
343 int fwnode_property_read_u64_array(const struct fwnode_handle *fwnode,
344 const char *propname, u64 *val, size_t nval)
346 return fwnode_property_read_int_array(fwnode, propname, sizeof(u64),
349 EXPORT_SYMBOL_GPL(fwnode_property_read_u64_array);
352 * fwnode_property_read_string_array - return string array property of a node
353 * @fwnode: Firmware node to get the property of
354 * @propname: Name of the property
355 * @val: The values are stored here or %NULL to return the number of values
356 * @nval: Size of the @val array
358 * Read an string list property @propname from the given firmware node and store
359 * them to @val if found.
361 * Return: number of values read on success if @val is non-NULL,
362 * number of values available on success if @val is NULL,
363 * %-EINVAL if given arguments are not valid,
364 * %-ENODATA if the property does not have a value,
365 * %-EPROTO or %-EILSEQ if the property is not an array of strings,
366 * %-EOVERFLOW if the size of the property is not as expected,
367 * %-ENXIO if no suitable firmware interface is present.
369 int fwnode_property_read_string_array(const struct fwnode_handle *fwnode,
370 const char *propname, const char **val,
375 ret = fwnode_call_int_op(fwnode, property_read_string_array, propname,
377 if (ret == -EINVAL && !IS_ERR_OR_NULL(fwnode) &&
378 !IS_ERR_OR_NULL(fwnode->secondary))
379 ret = fwnode_call_int_op(fwnode->secondary,
380 property_read_string_array, propname,
384 EXPORT_SYMBOL_GPL(fwnode_property_read_string_array);
387 * fwnode_property_read_string - return a string property of a firmware node
388 * @fwnode: Firmware node to get the property of
389 * @propname: Name of the property
390 * @val: The value is stored here
392 * Read property @propname from the given firmware node and store the value into
393 * @val if found. The value is checked to be a string.
395 * Return: %0 if the property was found (success),
396 * %-EINVAL if given arguments are not valid,
397 * %-ENODATA if the property does not have a value,
398 * %-EPROTO or %-EILSEQ if the property is not a string,
399 * %-ENXIO if no suitable firmware interface is present.
401 int fwnode_property_read_string(const struct fwnode_handle *fwnode,
402 const char *propname, const char **val)
404 int ret = fwnode_property_read_string_array(fwnode, propname, val, 1);
406 return ret < 0 ? ret : 0;
408 EXPORT_SYMBOL_GPL(fwnode_property_read_string);
411 * fwnode_property_match_string - find a string in an array and return index
412 * @fwnode: Firmware node to get the property of
413 * @propname: Name of the property holding the array
414 * @string: String to look for
416 * Find a given string in a string array and if it is found return the
419 * Return: %0 if the property was found (success),
420 * %-EINVAL if given arguments are not valid,
421 * %-ENODATA if the property does not have a value,
422 * %-EPROTO if the property is not an array of strings,
423 * %-ENXIO if no suitable firmware interface is present.
425 int fwnode_property_match_string(const struct fwnode_handle *fwnode,
426 const char *propname, const char *string)
431 nval = fwnode_property_read_string_array(fwnode, propname, NULL, 0);
438 values = kcalloc(nval, sizeof(*values), GFP_KERNEL);
442 ret = fwnode_property_read_string_array(fwnode, propname, values, nval);
446 ret = match_string(values, nval, string);
453 EXPORT_SYMBOL_GPL(fwnode_property_match_string);
456 * fwnode_property_get_reference_args() - Find a reference with arguments
457 * @fwnode: Firmware node where to look for the reference
458 * @prop: The name of the property
459 * @nargs_prop: The name of the property telling the number of
460 * arguments in the referred node. NULL if @nargs is known,
461 * otherwise @nargs is ignored. Only relevant on OF.
462 * @nargs: Number of arguments. Ignored if @nargs_prop is non-NULL.
463 * @index: Index of the reference, from zero onwards.
464 * @args: Result structure with reference and integer arguments.
466 * Obtain a reference based on a named property in an fwnode, with
469 * Caller is responsible to call fwnode_handle_put() on the returned
470 * args->fwnode pointer.
472 * Returns: %0 on success
473 * %-ENOENT when the index is out of bounds, the index has an empty
474 * reference or the property was not found
475 * %-EINVAL on parse error
477 int fwnode_property_get_reference_args(const struct fwnode_handle *fwnode,
478 const char *prop, const char *nargs_prop,
479 unsigned int nargs, unsigned int index,
480 struct fwnode_reference_args *args)
482 return fwnode_call_int_op(fwnode, get_reference_args, prop, nargs_prop,
485 EXPORT_SYMBOL_GPL(fwnode_property_get_reference_args);
488 * fwnode_find_reference - Find named reference to a fwnode_handle
489 * @fwnode: Firmware node where to look for the reference
490 * @name: The name of the reference
491 * @index: Index of the reference
493 * @index can be used when the named reference holds a table of references.
495 * Returns pointer to the reference fwnode, or ERR_PTR. Caller is responsible to
496 * call fwnode_handle_put() on the returned fwnode pointer.
498 struct fwnode_handle *fwnode_find_reference(const struct fwnode_handle *fwnode,
502 struct fwnode_reference_args args;
505 ret = fwnode_property_get_reference_args(fwnode, name, NULL, 0, index,
507 return ret ? ERR_PTR(ret) : args.fwnode;
509 EXPORT_SYMBOL_GPL(fwnode_find_reference);
512 * device_remove_properties - Remove properties from a device object.
513 * @dev: Device whose properties to remove.
515 * The function removes properties previously associated to the device
516 * firmware node with device_add_properties(). Memory allocated to the
517 * properties will also be released.
519 void device_remove_properties(struct device *dev)
521 struct fwnode_handle *fwnode = dev_fwnode(dev);
526 if (is_software_node(fwnode->secondary)) {
527 fwnode_remove_software_node(fwnode->secondary);
528 set_secondary_fwnode(dev, NULL);
531 EXPORT_SYMBOL_GPL(device_remove_properties);
534 * device_add_properties - Add a collection of properties to a device object.
535 * @dev: Device to add properties to.
536 * @properties: Collection of properties to add.
538 * Associate a collection of device properties represented by @properties with
539 * @dev. The function takes a copy of @properties.
541 * WARNING: The callers should not use this function if it is known that there
542 * is no real firmware node associated with @dev! In that case the callers
543 * should create a software node and assign it to @dev directly.
545 int device_add_properties(struct device *dev,
546 const struct property_entry *properties)
548 struct fwnode_handle *fwnode;
550 fwnode = fwnode_create_software_node(properties, NULL);
552 return PTR_ERR(fwnode);
554 set_secondary_fwnode(dev, fwnode);
557 EXPORT_SYMBOL_GPL(device_add_properties);
560 * fwnode_get_name - Return the name of a node
561 * @fwnode: The firmware node
563 * Returns a pointer to the node name.
565 const char *fwnode_get_name(const struct fwnode_handle *fwnode)
567 return fwnode_call_ptr_op(fwnode, get_name);
569 EXPORT_SYMBOL_GPL(fwnode_get_name);
572 * fwnode_get_name_prefix - Return the prefix of node for printing purposes
573 * @fwnode: The firmware node
575 * Returns the prefix of a node, intended to be printed right before the node.
576 * The prefix works also as a separator between the nodes.
578 const char *fwnode_get_name_prefix(const struct fwnode_handle *fwnode)
580 return fwnode_call_ptr_op(fwnode, get_name_prefix);
584 * fwnode_get_parent - Return parent firwmare node
585 * @fwnode: Firmware whose parent is retrieved
587 * Return parent firmware node of the given node if possible or %NULL if no
588 * parent was available.
590 struct fwnode_handle *fwnode_get_parent(const struct fwnode_handle *fwnode)
592 return fwnode_call_ptr_op(fwnode, get_parent);
594 EXPORT_SYMBOL_GPL(fwnode_get_parent);
597 * fwnode_get_next_parent - Iterate to the node's parent
598 * @fwnode: Firmware whose parent is retrieved
600 * This is like fwnode_get_parent() except that it drops the refcount
601 * on the passed node, making it suitable for iterating through a
604 * Returns a node pointer with refcount incremented, use
605 * fwnode_handle_node() on it when done.
607 struct fwnode_handle *fwnode_get_next_parent(struct fwnode_handle *fwnode)
609 struct fwnode_handle *parent = fwnode_get_parent(fwnode);
611 fwnode_handle_put(fwnode);
615 EXPORT_SYMBOL_GPL(fwnode_get_next_parent);
618 * fwnode_get_next_parent_dev - Find device of closest ancestor fwnode
619 * @fwnode: firmware node
621 * Given a firmware node (@fwnode), this function finds its closest ancestor
622 * firmware node that has a corresponding struct device and returns that struct
625 * The caller of this function is expected to call put_device() on the returned
626 * device when they are done.
628 struct device *fwnode_get_next_parent_dev(struct fwnode_handle *fwnode)
630 struct device *dev = NULL;
632 fwnode_handle_get(fwnode);
634 fwnode = fwnode_get_next_parent(fwnode);
636 dev = get_dev_from_fwnode(fwnode);
637 } while (fwnode && !dev);
638 fwnode_handle_put(fwnode);
643 * fwnode_count_parents - Return the number of parents a node has
644 * @fwnode: The node the parents of which are to be counted
646 * Returns the number of parents a node has.
648 unsigned int fwnode_count_parents(const struct fwnode_handle *fwnode)
650 struct fwnode_handle *__fwnode;
653 __fwnode = fwnode_get_parent(fwnode);
655 for (count = 0; __fwnode; count++)
656 __fwnode = fwnode_get_next_parent(__fwnode);
660 EXPORT_SYMBOL_GPL(fwnode_count_parents);
663 * fwnode_get_nth_parent - Return an nth parent of a node
664 * @fwnode: The node the parent of which is requested
665 * @depth: Distance of the parent from the node
667 * Returns the nth parent of a node. If there is no parent at the requested
668 * @depth, %NULL is returned. If @depth is 0, the functionality is equivalent to
669 * fwnode_handle_get(). For @depth == 1, it is fwnode_get_parent() and so on.
671 * The caller is responsible for calling fwnode_handle_put() for the returned
674 struct fwnode_handle *fwnode_get_nth_parent(struct fwnode_handle *fwnode,
679 fwnode_handle_get(fwnode);
681 for (i = 0; i < depth && fwnode; i++)
682 fwnode = fwnode_get_next_parent(fwnode);
686 EXPORT_SYMBOL_GPL(fwnode_get_nth_parent);
689 * fwnode_is_ancestor_of - Test if @test_ancestor is ancestor of @test_child
690 * @test_ancestor: Firmware which is tested for being an ancestor
691 * @test_child: Firmware which is tested for being the child
693 * A node is considered an ancestor of itself too.
695 * Returns true if @test_ancestor is an ancestor of @test_child.
696 * Otherwise, returns false.
698 bool fwnode_is_ancestor_of(struct fwnode_handle *test_ancestor,
699 struct fwnode_handle *test_child)
704 fwnode_handle_get(test_child);
706 if (test_child == test_ancestor) {
707 fwnode_handle_put(test_child);
710 test_child = fwnode_get_next_parent(test_child);
716 * fwnode_get_next_child_node - Return the next child node handle for a node
717 * @fwnode: Firmware node to find the next child node for.
718 * @child: Handle to one of the node's child nodes or a %NULL handle.
720 struct fwnode_handle *
721 fwnode_get_next_child_node(const struct fwnode_handle *fwnode,
722 struct fwnode_handle *child)
724 return fwnode_call_ptr_op(fwnode, get_next_child_node, child);
726 EXPORT_SYMBOL_GPL(fwnode_get_next_child_node);
729 * fwnode_get_next_available_child_node - Return the next
730 * available child node handle for a node
731 * @fwnode: Firmware node to find the next child node for.
732 * @child: Handle to one of the node's child nodes or a %NULL handle.
734 struct fwnode_handle *
735 fwnode_get_next_available_child_node(const struct fwnode_handle *fwnode,
736 struct fwnode_handle *child)
738 struct fwnode_handle *next_child = child;
744 next_child = fwnode_get_next_child_node(fwnode, next_child);
746 if (!next_child || fwnode_device_is_available(next_child))
748 } while (next_child);
752 EXPORT_SYMBOL_GPL(fwnode_get_next_available_child_node);
755 * device_get_next_child_node - Return the next child node handle for a device
756 * @dev: Device to find the next child node for.
757 * @child: Handle to one of the device's child nodes or a null handle.
759 struct fwnode_handle *device_get_next_child_node(struct device *dev,
760 struct fwnode_handle *child)
762 struct acpi_device *adev = ACPI_COMPANION(dev);
763 struct fwnode_handle *fwnode = NULL, *next;
766 fwnode = &dev->of_node->fwnode;
768 fwnode = acpi_fwnode_handle(adev);
770 /* Try to find a child in primary fwnode */
771 next = fwnode_get_next_child_node(fwnode, child);
775 /* When no more children in primary, continue with secondary */
776 if (fwnode && !IS_ERR_OR_NULL(fwnode->secondary))
777 next = fwnode_get_next_child_node(fwnode->secondary, child);
781 EXPORT_SYMBOL_GPL(device_get_next_child_node);
784 * fwnode_get_named_child_node - Return first matching named child node handle
785 * @fwnode: Firmware node to find the named child node for.
786 * @childname: String to match child node name against.
788 struct fwnode_handle *
789 fwnode_get_named_child_node(const struct fwnode_handle *fwnode,
790 const char *childname)
792 return fwnode_call_ptr_op(fwnode, get_named_child_node, childname);
794 EXPORT_SYMBOL_GPL(fwnode_get_named_child_node);
797 * device_get_named_child_node - Return first matching named child node handle
798 * @dev: Device to find the named child node for.
799 * @childname: String to match child node name against.
801 struct fwnode_handle *device_get_named_child_node(struct device *dev,
802 const char *childname)
804 return fwnode_get_named_child_node(dev_fwnode(dev), childname);
806 EXPORT_SYMBOL_GPL(device_get_named_child_node);
809 * fwnode_handle_get - Obtain a reference to a device node
810 * @fwnode: Pointer to the device node to obtain the reference to.
812 * Returns the fwnode handle.
814 struct fwnode_handle *fwnode_handle_get(struct fwnode_handle *fwnode)
816 if (!fwnode_has_op(fwnode, get))
819 return fwnode_call_ptr_op(fwnode, get);
821 EXPORT_SYMBOL_GPL(fwnode_handle_get);
824 * fwnode_handle_put - Drop reference to a device node
825 * @fwnode: Pointer to the device node to drop the reference to.
827 * This has to be used when terminating device_for_each_child_node() iteration
828 * with break or return to prevent stale device node references from being left
831 void fwnode_handle_put(struct fwnode_handle *fwnode)
833 fwnode_call_void_op(fwnode, put);
835 EXPORT_SYMBOL_GPL(fwnode_handle_put);
838 * fwnode_device_is_available - check if a device is available for use
839 * @fwnode: Pointer to the fwnode of the device.
841 * For fwnode node types that don't implement the .device_is_available()
842 * operation, this function returns true.
844 bool fwnode_device_is_available(const struct fwnode_handle *fwnode)
846 if (!fwnode_has_op(fwnode, device_is_available))
849 return fwnode_call_bool_op(fwnode, device_is_available);
851 EXPORT_SYMBOL_GPL(fwnode_device_is_available);
854 * device_get_child_node_count - return the number of child nodes for device
855 * @dev: Device to cound the child nodes for
857 unsigned int device_get_child_node_count(struct device *dev)
859 struct fwnode_handle *child;
860 unsigned int count = 0;
862 device_for_each_child_node(dev, child)
867 EXPORT_SYMBOL_GPL(device_get_child_node_count);
869 bool device_dma_supported(struct device *dev)
871 /* For DT, this is always supported.
872 * For ACPI, this depends on CCA, which
873 * is determined by the acpi_dma_supported().
875 if (IS_ENABLED(CONFIG_OF) && dev->of_node)
878 return acpi_dma_supported(ACPI_COMPANION(dev));
880 EXPORT_SYMBOL_GPL(device_dma_supported);
882 enum dev_dma_attr device_get_dma_attr(struct device *dev)
884 enum dev_dma_attr attr = DEV_DMA_NOT_SUPPORTED;
886 if (IS_ENABLED(CONFIG_OF) && dev->of_node) {
887 if (of_dma_is_coherent(dev->of_node))
888 attr = DEV_DMA_COHERENT;
890 attr = DEV_DMA_NON_COHERENT;
892 attr = acpi_get_dma_attr(ACPI_COMPANION(dev));
896 EXPORT_SYMBOL_GPL(device_get_dma_attr);
899 * fwnode_get_phy_mode - Get phy mode for given firmware node
900 * @fwnode: Pointer to the given node
902 * The function gets phy interface string from property 'phy-mode' or
903 * 'phy-connection-type', and return its index in phy_modes table, or errno in
906 int fwnode_get_phy_mode(struct fwnode_handle *fwnode)
911 err = fwnode_property_read_string(fwnode, "phy-mode", &pm);
913 err = fwnode_property_read_string(fwnode,
914 "phy-connection-type", &pm);
918 for (i = 0; i < PHY_INTERFACE_MODE_MAX; i++)
919 if (!strcasecmp(pm, phy_modes(i)))
924 EXPORT_SYMBOL_GPL(fwnode_get_phy_mode);
927 * device_get_phy_mode - Get phy mode for given device
928 * @dev: Pointer to the given device
930 * The function gets phy interface string from property 'phy-mode' or
931 * 'phy-connection-type', and return its index in phy_modes table, or errno in
934 int device_get_phy_mode(struct device *dev)
936 return fwnode_get_phy_mode(dev_fwnode(dev));
938 EXPORT_SYMBOL_GPL(device_get_phy_mode);
940 static void *fwnode_get_mac_addr(struct fwnode_handle *fwnode,
941 const char *name, char *addr,
944 int ret = fwnode_property_read_u8_array(fwnode, name, addr, alen);
946 if (ret == 0 && alen == ETH_ALEN && is_valid_ether_addr(addr))
952 * fwnode_get_mac_address - Get the MAC from the firmware node
953 * @fwnode: Pointer to the firmware node
954 * @addr: Address of buffer to store the MAC in
955 * @alen: Length of the buffer pointed to by addr, should be ETH_ALEN
957 * Search the firmware node for the best MAC address to use. 'mac-address' is
958 * checked first, because that is supposed to contain to "most recent" MAC
959 * address. If that isn't set, then 'local-mac-address' is checked next,
960 * because that is the default address. If that isn't set, then the obsolete
961 * 'address' is checked, just in case we're using an old device tree.
963 * Note that the 'address' property is supposed to contain a virtual address of
964 * the register set, but some DTS files have redefined that property to be the
967 * All-zero MAC addresses are rejected, because those could be properties that
968 * exist in the firmware tables, but were not updated by the firmware. For
969 * example, the DTS could define 'mac-address' and 'local-mac-address', with
970 * zero MAC addresses. Some older U-Boots only initialized 'local-mac-address'.
971 * In this case, the real MAC is in 'local-mac-address', and 'mac-address'
972 * exists but is all zeros.
974 void *fwnode_get_mac_address(struct fwnode_handle *fwnode, char *addr, int alen)
978 res = fwnode_get_mac_addr(fwnode, "mac-address", addr, alen);
982 res = fwnode_get_mac_addr(fwnode, "local-mac-address", addr, alen);
986 return fwnode_get_mac_addr(fwnode, "address", addr, alen);
988 EXPORT_SYMBOL(fwnode_get_mac_address);
991 * device_get_mac_address - Get the MAC for a given device
992 * @dev: Pointer to the device
993 * @addr: Address of buffer to store the MAC in
994 * @alen: Length of the buffer pointed to by addr, should be ETH_ALEN
996 void *device_get_mac_address(struct device *dev, char *addr, int alen)
998 return fwnode_get_mac_address(dev_fwnode(dev), addr, alen);
1000 EXPORT_SYMBOL(device_get_mac_address);
1003 * fwnode_irq_get - Get IRQ directly from a fwnode
1004 * @fwnode: Pointer to the firmware node
1005 * @index: Zero-based index of the IRQ
1007 * Returns Linux IRQ number on success. Other values are determined
1008 * accordingly to acpi_/of_ irq_get() operation.
1010 int fwnode_irq_get(struct fwnode_handle *fwnode, unsigned int index)
1012 struct device_node *of_node = to_of_node(fwnode);
1013 struct resource res;
1016 if (IS_ENABLED(CONFIG_OF) && of_node)
1017 return of_irq_get(of_node, index);
1019 ret = acpi_irq_get(ACPI_HANDLE_FWNODE(fwnode), index, &res);
1025 EXPORT_SYMBOL(fwnode_irq_get);
1028 * fwnode_graph_get_next_endpoint - Get next endpoint firmware node
1029 * @fwnode: Pointer to the parent firmware node
1030 * @prev: Previous endpoint node or %NULL to get the first
1032 * Returns an endpoint firmware node pointer or %NULL if no more endpoints
1035 struct fwnode_handle *
1036 fwnode_graph_get_next_endpoint(const struct fwnode_handle *fwnode,
1037 struct fwnode_handle *prev)
1039 return fwnode_call_ptr_op(fwnode, graph_get_next_endpoint, prev);
1041 EXPORT_SYMBOL_GPL(fwnode_graph_get_next_endpoint);
1044 * fwnode_graph_get_port_parent - Return the device fwnode of a port endpoint
1045 * @endpoint: Endpoint firmware node of the port
1047 * Return: the firmware node of the device the @endpoint belongs to.
1049 struct fwnode_handle *
1050 fwnode_graph_get_port_parent(const struct fwnode_handle *endpoint)
1052 struct fwnode_handle *port, *parent;
1054 port = fwnode_get_parent(endpoint);
1055 parent = fwnode_call_ptr_op(port, graph_get_port_parent);
1057 fwnode_handle_put(port);
1061 EXPORT_SYMBOL_GPL(fwnode_graph_get_port_parent);
1064 * fwnode_graph_get_remote_port_parent - Return fwnode of a remote device
1065 * @fwnode: Endpoint firmware node pointing to the remote endpoint
1067 * Extracts firmware node of a remote device the @fwnode points to.
1069 struct fwnode_handle *
1070 fwnode_graph_get_remote_port_parent(const struct fwnode_handle *fwnode)
1072 struct fwnode_handle *endpoint, *parent;
1074 endpoint = fwnode_graph_get_remote_endpoint(fwnode);
1075 parent = fwnode_graph_get_port_parent(endpoint);
1077 fwnode_handle_put(endpoint);
1081 EXPORT_SYMBOL_GPL(fwnode_graph_get_remote_port_parent);
1084 * fwnode_graph_get_remote_port - Return fwnode of a remote port
1085 * @fwnode: Endpoint firmware node pointing to the remote endpoint
1087 * Extracts firmware node of a remote port the @fwnode points to.
1089 struct fwnode_handle *
1090 fwnode_graph_get_remote_port(const struct fwnode_handle *fwnode)
1092 return fwnode_get_next_parent(fwnode_graph_get_remote_endpoint(fwnode));
1094 EXPORT_SYMBOL_GPL(fwnode_graph_get_remote_port);
1097 * fwnode_graph_get_remote_endpoint - Return fwnode of a remote endpoint
1098 * @fwnode: Endpoint firmware node pointing to the remote endpoint
1100 * Extracts firmware node of a remote endpoint the @fwnode points to.
1102 struct fwnode_handle *
1103 fwnode_graph_get_remote_endpoint(const struct fwnode_handle *fwnode)
1105 return fwnode_call_ptr_op(fwnode, graph_get_remote_endpoint);
1107 EXPORT_SYMBOL_GPL(fwnode_graph_get_remote_endpoint);
1110 * fwnode_graph_get_remote_node - get remote parent node for given port/endpoint
1111 * @fwnode: pointer to parent fwnode_handle containing graph port/endpoint
1112 * @port_id: identifier of the parent port node
1113 * @endpoint_id: identifier of the endpoint node
1115 * Return: Remote fwnode handle associated with remote endpoint node linked
1116 * to @node. Use fwnode_node_put() on it when done.
1118 struct fwnode_handle *
1119 fwnode_graph_get_remote_node(const struct fwnode_handle *fwnode, u32 port_id,
1122 struct fwnode_handle *endpoint = NULL;
1124 while ((endpoint = fwnode_graph_get_next_endpoint(fwnode, endpoint))) {
1125 struct fwnode_endpoint fwnode_ep;
1126 struct fwnode_handle *remote;
1129 ret = fwnode_graph_parse_endpoint(endpoint, &fwnode_ep);
1133 if (fwnode_ep.port != port_id || fwnode_ep.id != endpoint_id)
1136 remote = fwnode_graph_get_remote_port_parent(endpoint);
1140 return fwnode_device_is_available(remote) ? remote : NULL;
1145 EXPORT_SYMBOL_GPL(fwnode_graph_get_remote_node);
1148 * fwnode_graph_get_endpoint_by_id - get endpoint by port and endpoint numbers
1149 * @fwnode: parent fwnode_handle containing the graph
1150 * @port: identifier of the port node
1151 * @endpoint: identifier of the endpoint node under the port node
1152 * @flags: fwnode lookup flags
1154 * Return the fwnode handle of the local endpoint corresponding the port and
1155 * endpoint IDs or NULL if not found.
1157 * If FWNODE_GRAPH_ENDPOINT_NEXT is passed in @flags and the specified endpoint
1158 * has not been found, look for the closest endpoint ID greater than the
1159 * specified one and return the endpoint that corresponds to it, if present.
1161 * Do not return endpoints that belong to disabled devices, unless
1162 * FWNODE_GRAPH_DEVICE_DISABLED is passed in @flags.
1164 * The returned endpoint needs to be released by calling fwnode_handle_put() on
1165 * it when it is not needed any more.
1167 struct fwnode_handle *
1168 fwnode_graph_get_endpoint_by_id(const struct fwnode_handle *fwnode,
1169 u32 port, u32 endpoint, unsigned long flags)
1171 struct fwnode_handle *ep = NULL, *best_ep = NULL;
1172 unsigned int best_ep_id = 0;
1173 bool endpoint_next = flags & FWNODE_GRAPH_ENDPOINT_NEXT;
1174 bool enabled_only = !(flags & FWNODE_GRAPH_DEVICE_DISABLED);
1176 while ((ep = fwnode_graph_get_next_endpoint(fwnode, ep))) {
1177 struct fwnode_endpoint fwnode_ep = { 0 };
1181 struct fwnode_handle *dev_node;
1184 dev_node = fwnode_graph_get_remote_port_parent(ep);
1185 available = fwnode_device_is_available(dev_node);
1186 fwnode_handle_put(dev_node);
1191 ret = fwnode_graph_parse_endpoint(ep, &fwnode_ep);
1195 if (fwnode_ep.port != port)
1198 if (fwnode_ep.id == endpoint)
1205 * If the endpoint that has just been found is not the first
1206 * matching one and the ID of the one found previously is closer
1207 * to the requested endpoint ID, skip it.
1209 if (fwnode_ep.id < endpoint ||
1210 (best_ep && best_ep_id < fwnode_ep.id))
1213 fwnode_handle_put(best_ep);
1214 best_ep = fwnode_handle_get(ep);
1215 best_ep_id = fwnode_ep.id;
1221 if (fwnode && !IS_ERR_OR_NULL(fwnode->secondary))
1222 return fwnode_graph_get_endpoint_by_id(fwnode->secondary, port,
1227 EXPORT_SYMBOL_GPL(fwnode_graph_get_endpoint_by_id);
1230 * fwnode_graph_parse_endpoint - parse common endpoint node properties
1231 * @fwnode: pointer to endpoint fwnode_handle
1232 * @endpoint: pointer to the fwnode endpoint data structure
1234 * Parse @fwnode representing a graph endpoint node and store the
1235 * information in @endpoint. The caller must hold a reference to
1238 int fwnode_graph_parse_endpoint(const struct fwnode_handle *fwnode,
1239 struct fwnode_endpoint *endpoint)
1241 memset(endpoint, 0, sizeof(*endpoint));
1243 return fwnode_call_int_op(fwnode, graph_parse_endpoint, endpoint);
1245 EXPORT_SYMBOL(fwnode_graph_parse_endpoint);
1247 const void *device_get_match_data(struct device *dev)
1249 return fwnode_call_ptr_op(dev_fwnode(dev), device_get_match_data, dev);
1251 EXPORT_SYMBOL_GPL(device_get_match_data);
1254 fwnode_graph_devcon_match(struct fwnode_handle *fwnode, const char *con_id,
1255 void *data, devcon_match_fn_t match)
1257 struct fwnode_handle *node;
1258 struct fwnode_handle *ep;
1261 fwnode_graph_for_each_endpoint(fwnode, ep) {
1262 node = fwnode_graph_get_remote_port_parent(ep);
1263 if (!fwnode_device_is_available(node))
1266 ret = match(node, con_id, data);
1267 fwnode_handle_put(node);
1269 fwnode_handle_put(ep);
1277 fwnode_devcon_match(struct fwnode_handle *fwnode, const char *con_id,
1278 void *data, devcon_match_fn_t match)
1280 struct fwnode_handle *node;
1284 for (i = 0; ; i++) {
1285 node = fwnode_find_reference(fwnode, con_id, i);
1289 ret = match(node, NULL, data);
1290 fwnode_handle_put(node);
1299 * fwnode_connection_find_match - Find connection from a device node
1300 * @fwnode: Device node with the connection
1301 * @con_id: Identifier for the connection
1302 * @data: Data for the match function
1303 * @match: Function to check and convert the connection description
1305 * Find a connection with unique identifier @con_id between @fwnode and another
1306 * device node. @match will be used to convert the connection description to
1307 * data the caller is expecting to be returned.
1309 void *fwnode_connection_find_match(struct fwnode_handle *fwnode,
1310 const char *con_id, void *data,
1311 devcon_match_fn_t match)
1315 if (!fwnode || !match)
1318 ret = fwnode_graph_devcon_match(fwnode, con_id, data, match);
1322 return fwnode_devcon_match(fwnode, con_id, data, match);
1324 EXPORT_SYMBOL_GPL(fwnode_connection_find_match);