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/phy.h>
20 struct fwnode_handle *__dev_fwnode(struct device *dev)
22 return IS_ENABLED(CONFIG_OF) && dev->of_node ?
23 of_fwnode_handle(dev->of_node) : dev->fwnode;
25 EXPORT_SYMBOL_GPL(__dev_fwnode);
27 const struct fwnode_handle *__dev_fwnode_const(const struct device *dev)
29 return IS_ENABLED(CONFIG_OF) && dev->of_node ?
30 of_fwnode_handle(dev->of_node) : dev->fwnode;
32 EXPORT_SYMBOL_GPL(__dev_fwnode_const);
35 * device_property_present - check if a property of a device is present
36 * @dev: Device whose property is being checked
37 * @propname: Name of the property
39 * Check if property @propname is present in the device firmware description.
41 * Return: true if property @propname is present. Otherwise, returns false.
43 bool device_property_present(const struct device *dev, const char *propname)
45 return fwnode_property_present(dev_fwnode(dev), propname);
47 EXPORT_SYMBOL_GPL(device_property_present);
50 * fwnode_property_present - check if a property of a firmware node is present
51 * @fwnode: Firmware node whose property to check
52 * @propname: Name of the property
54 * Return: true if property @propname is present. Otherwise, returns false.
56 bool fwnode_property_present(const struct fwnode_handle *fwnode,
61 if (IS_ERR_OR_NULL(fwnode))
64 ret = fwnode_call_bool_op(fwnode, property_present, propname);
68 return fwnode_call_bool_op(fwnode->secondary, property_present, propname);
70 EXPORT_SYMBOL_GPL(fwnode_property_present);
73 * device_property_read_u8_array - return a u8 array property of a device
74 * @dev: Device to get the property of
75 * @propname: Name of the property
76 * @val: The values are stored here or %NULL to return the number of values
77 * @nval: Size of the @val array
79 * Function reads an array of u8 properties with @propname from the device
80 * firmware description and stores them to @val if found.
82 * It's recommended to call device_property_count_u8() instead of calling
83 * this function with @val equals %NULL and @nval equals 0.
85 * Return: number of values if @val was %NULL,
86 * %0 if the property was found (success),
87 * %-EINVAL if given arguments are not valid,
88 * %-ENODATA if the property does not have a value,
89 * %-EPROTO if the property is not an array of numbers,
90 * %-EOVERFLOW if the size of the property is not as expected.
91 * %-ENXIO if no suitable firmware interface is present.
93 int device_property_read_u8_array(const struct device *dev, const char *propname,
96 return fwnode_property_read_u8_array(dev_fwnode(dev), propname, val, nval);
98 EXPORT_SYMBOL_GPL(device_property_read_u8_array);
101 * device_property_read_u16_array - return a u16 array property of a device
102 * @dev: Device to get the property of
103 * @propname: Name of the property
104 * @val: The values are stored here or %NULL to return the number of values
105 * @nval: Size of the @val array
107 * Function reads an array of u16 properties with @propname from the device
108 * firmware description and stores them to @val if found.
110 * It's recommended to call device_property_count_u16() instead of calling
111 * this function with @val equals %NULL and @nval equals 0.
113 * Return: number of values if @val was %NULL,
114 * %0 if the property was found (success),
115 * %-EINVAL if given arguments are not valid,
116 * %-ENODATA if the property does not have a value,
117 * %-EPROTO if the property is not an array of numbers,
118 * %-EOVERFLOW if the size of the property is not as expected.
119 * %-ENXIO if no suitable firmware interface is present.
121 int device_property_read_u16_array(const struct device *dev, const char *propname,
122 u16 *val, size_t nval)
124 return fwnode_property_read_u16_array(dev_fwnode(dev), propname, val, nval);
126 EXPORT_SYMBOL_GPL(device_property_read_u16_array);
129 * device_property_read_u32_array - return a u32 array property of a device
130 * @dev: Device to get the property of
131 * @propname: Name of the property
132 * @val: The values are stored here or %NULL to return the number of values
133 * @nval: Size of the @val array
135 * Function reads an array of u32 properties with @propname from the device
136 * firmware description and stores them to @val if found.
138 * It's recommended to call device_property_count_u32() instead of calling
139 * this function with @val equals %NULL and @nval equals 0.
141 * Return: number of values if @val was %NULL,
142 * %0 if the property was found (success),
143 * %-EINVAL if given arguments are not valid,
144 * %-ENODATA if the property does not have a value,
145 * %-EPROTO if the property is not an array of numbers,
146 * %-EOVERFLOW if the size of the property is not as expected.
147 * %-ENXIO if no suitable firmware interface is present.
149 int device_property_read_u32_array(const struct device *dev, const char *propname,
150 u32 *val, size_t nval)
152 return fwnode_property_read_u32_array(dev_fwnode(dev), propname, val, nval);
154 EXPORT_SYMBOL_GPL(device_property_read_u32_array);
157 * device_property_read_u64_array - return a u64 array property of a device
158 * @dev: Device to get the property of
159 * @propname: Name of the property
160 * @val: The values are stored here or %NULL to return the number of values
161 * @nval: Size of the @val array
163 * Function reads an array of u64 properties with @propname from the device
164 * firmware description and stores them to @val if found.
166 * It's recommended to call device_property_count_u64() instead of calling
167 * this function with @val equals %NULL and @nval equals 0.
169 * Return: number of values if @val was %NULL,
170 * %0 if the property was found (success),
171 * %-EINVAL if given arguments are not valid,
172 * %-ENODATA if the property does not have a value,
173 * %-EPROTO if the property is not an array of numbers,
174 * %-EOVERFLOW if the size of the property is not as expected.
175 * %-ENXIO if no suitable firmware interface is present.
177 int device_property_read_u64_array(const struct device *dev, const char *propname,
178 u64 *val, size_t nval)
180 return fwnode_property_read_u64_array(dev_fwnode(dev), propname, val, nval);
182 EXPORT_SYMBOL_GPL(device_property_read_u64_array);
185 * device_property_read_string_array - return a string array property of device
186 * @dev: Device to get the property of
187 * @propname: Name of the property
188 * @val: The values are stored here or %NULL to return the number of values
189 * @nval: Size of the @val array
191 * Function reads an array of string properties with @propname from the device
192 * firmware description and stores them to @val if found.
194 * It's recommended to call device_property_string_array_count() instead of calling
195 * this function with @val equals %NULL and @nval equals 0.
197 * Return: number of values read on success if @val is non-NULL,
198 * number of values available on success if @val is NULL,
199 * %-EINVAL if given arguments are not valid,
200 * %-ENODATA if the property does not have a value,
201 * %-EPROTO or %-EILSEQ if the property is not an array of strings,
202 * %-EOVERFLOW if the size of the property is not as expected.
203 * %-ENXIO if no suitable firmware interface is present.
205 int device_property_read_string_array(const struct device *dev, const char *propname,
206 const char **val, size_t nval)
208 return fwnode_property_read_string_array(dev_fwnode(dev), propname, val, nval);
210 EXPORT_SYMBOL_GPL(device_property_read_string_array);
213 * device_property_read_string - return a string property of a device
214 * @dev: Device to get the property of
215 * @propname: Name of the property
216 * @val: The value is stored here
218 * Function reads property @propname from the device firmware description and
219 * stores the value into @val if found. The value is checked to be a string.
221 * Return: %0 if the property was found (success),
222 * %-EINVAL if given arguments are not valid,
223 * %-ENODATA if the property does not have a value,
224 * %-EPROTO or %-EILSEQ if the property type is not a string.
225 * %-ENXIO if no suitable firmware interface is present.
227 int device_property_read_string(const struct device *dev, const char *propname,
230 return fwnode_property_read_string(dev_fwnode(dev), propname, val);
232 EXPORT_SYMBOL_GPL(device_property_read_string);
235 * device_property_match_string - find a string in an array and return index
236 * @dev: Device to get the property of
237 * @propname: Name of the property holding the array
238 * @string: String to look for
240 * Find a given string in a string array and if it is found return the
243 * Return: index, starting from %0, if the property was found (success),
244 * %-EINVAL if given arguments are not valid,
245 * %-ENODATA if the property does not have a value,
246 * %-EPROTO if the property is not an array of strings,
247 * %-ENXIO if no suitable firmware interface is present.
249 int device_property_match_string(const struct device *dev, const char *propname,
252 return fwnode_property_match_string(dev_fwnode(dev), propname, string);
254 EXPORT_SYMBOL_GPL(device_property_match_string);
256 static int fwnode_property_read_int_array(const struct fwnode_handle *fwnode,
257 const char *propname,
258 unsigned int elem_size, void *val,
263 if (IS_ERR_OR_NULL(fwnode))
266 ret = fwnode_call_int_op(fwnode, property_read_int_array, propname,
267 elem_size, val, nval);
271 return fwnode_call_int_op(fwnode->secondary, property_read_int_array, propname,
272 elem_size, val, nval);
276 * fwnode_property_read_u8_array - return a u8 array property of firmware node
277 * @fwnode: Firmware node to get the property of
278 * @propname: Name of the property
279 * @val: The values are stored here or %NULL to return the number of values
280 * @nval: Size of the @val array
282 * Read an array of u8 properties with @propname from @fwnode and stores them to
285 * It's recommended to call fwnode_property_count_u8() instead of calling
286 * this function with @val equals %NULL and @nval equals 0.
288 * Return: number of values if @val was %NULL,
289 * %0 if the property was found (success),
290 * %-EINVAL if given arguments are not valid,
291 * %-ENODATA if the property does not have a value,
292 * %-EPROTO if the property is not an array of numbers,
293 * %-EOVERFLOW if the size of the property is not as expected,
294 * %-ENXIO if no suitable firmware interface is present.
296 int fwnode_property_read_u8_array(const struct fwnode_handle *fwnode,
297 const char *propname, u8 *val, size_t nval)
299 return fwnode_property_read_int_array(fwnode, propname, sizeof(u8),
302 EXPORT_SYMBOL_GPL(fwnode_property_read_u8_array);
305 * fwnode_property_read_u16_array - return a u16 array property of firmware node
306 * @fwnode: Firmware node to get the property of
307 * @propname: Name of the property
308 * @val: The values are stored here or %NULL to return the number of values
309 * @nval: Size of the @val array
311 * Read an array of u16 properties with @propname from @fwnode and store them to
314 * It's recommended to call fwnode_property_count_u16() instead of calling
315 * this function with @val equals %NULL and @nval equals 0.
317 * Return: number of values if @val was %NULL,
318 * %0 if the property was found (success),
319 * %-EINVAL if given arguments are not valid,
320 * %-ENODATA if the property does not have a value,
321 * %-EPROTO if the property is not an array of numbers,
322 * %-EOVERFLOW if the size of the property is not as expected,
323 * %-ENXIO if no suitable firmware interface is present.
325 int fwnode_property_read_u16_array(const struct fwnode_handle *fwnode,
326 const char *propname, u16 *val, size_t nval)
328 return fwnode_property_read_int_array(fwnode, propname, sizeof(u16),
331 EXPORT_SYMBOL_GPL(fwnode_property_read_u16_array);
334 * fwnode_property_read_u32_array - return a u32 array property of firmware node
335 * @fwnode: Firmware node to get the property of
336 * @propname: Name of the property
337 * @val: The values are stored here or %NULL to return the number of values
338 * @nval: Size of the @val array
340 * Read an array of u32 properties with @propname from @fwnode store them to
343 * It's recommended to call fwnode_property_count_u32() instead of calling
344 * this function with @val equals %NULL and @nval equals 0.
346 * Return: number of values if @val was %NULL,
347 * %0 if the property was found (success),
348 * %-EINVAL if given arguments are not valid,
349 * %-ENODATA if the property does not have a value,
350 * %-EPROTO if the property is not an array of numbers,
351 * %-EOVERFLOW if the size of the property is not as expected,
352 * %-ENXIO if no suitable firmware interface is present.
354 int fwnode_property_read_u32_array(const struct fwnode_handle *fwnode,
355 const char *propname, u32 *val, size_t nval)
357 return fwnode_property_read_int_array(fwnode, propname, sizeof(u32),
360 EXPORT_SYMBOL_GPL(fwnode_property_read_u32_array);
363 * fwnode_property_read_u64_array - return a u64 array property firmware node
364 * @fwnode: Firmware node to get the property of
365 * @propname: Name of the property
366 * @val: The values are stored here or %NULL to return the number of values
367 * @nval: Size of the @val array
369 * Read an array of u64 properties with @propname from @fwnode and store them to
372 * It's recommended to call fwnode_property_count_u64() instead of calling
373 * this function with @val equals %NULL and @nval equals 0.
375 * Return: number of values if @val was %NULL,
376 * %0 if the property was found (success),
377 * %-EINVAL if given arguments are not valid,
378 * %-ENODATA if the property does not have a value,
379 * %-EPROTO if the property is not an array of numbers,
380 * %-EOVERFLOW if the size of the property is not as expected,
381 * %-ENXIO if no suitable firmware interface is present.
383 int fwnode_property_read_u64_array(const struct fwnode_handle *fwnode,
384 const char *propname, u64 *val, size_t nval)
386 return fwnode_property_read_int_array(fwnode, propname, sizeof(u64),
389 EXPORT_SYMBOL_GPL(fwnode_property_read_u64_array);
392 * fwnode_property_read_string_array - return string array property of a node
393 * @fwnode: Firmware node to get the property of
394 * @propname: Name of the property
395 * @val: The values are stored here or %NULL to return the number of values
396 * @nval: Size of the @val array
398 * Read an string list property @propname from the given firmware node and store
399 * them to @val if found.
401 * It's recommended to call fwnode_property_string_array_count() instead of calling
402 * this function with @val equals %NULL and @nval equals 0.
404 * Return: number of values read on success if @val is non-NULL,
405 * number of values available on success if @val is NULL,
406 * %-EINVAL if given arguments are not valid,
407 * %-ENODATA if the property does not have a value,
408 * %-EPROTO or %-EILSEQ if the property is not an array of strings,
409 * %-EOVERFLOW if the size of the property is not as expected,
410 * %-ENXIO if no suitable firmware interface is present.
412 int fwnode_property_read_string_array(const struct fwnode_handle *fwnode,
413 const char *propname, const char **val,
418 if (IS_ERR_OR_NULL(fwnode))
421 ret = fwnode_call_int_op(fwnode, property_read_string_array, propname,
426 return fwnode_call_int_op(fwnode->secondary, property_read_string_array, propname,
429 EXPORT_SYMBOL_GPL(fwnode_property_read_string_array);
432 * fwnode_property_read_string - return a string property of a firmware node
433 * @fwnode: Firmware node to get the property of
434 * @propname: Name of the property
435 * @val: The value is stored here
437 * Read property @propname from the given firmware node and store the value into
438 * @val if found. The value is checked to be a string.
440 * Return: %0 if the property was found (success),
441 * %-EINVAL if given arguments are not valid,
442 * %-ENODATA if the property does not have a value,
443 * %-EPROTO or %-EILSEQ if the property is not a string,
444 * %-ENXIO if no suitable firmware interface is present.
446 int fwnode_property_read_string(const struct fwnode_handle *fwnode,
447 const char *propname, const char **val)
449 int ret = fwnode_property_read_string_array(fwnode, propname, val, 1);
451 return ret < 0 ? ret : 0;
453 EXPORT_SYMBOL_GPL(fwnode_property_read_string);
456 * fwnode_property_match_string - find a string in an array and return index
457 * @fwnode: Firmware node to get the property of
458 * @propname: Name of the property holding the array
459 * @string: String to look for
461 * Find a given string in a string array and if it is found return the
464 * Return: index, starting from %0, if the property was found (success),
465 * %-EINVAL if given arguments are not valid,
466 * %-ENODATA if the property does not have a value,
467 * %-EPROTO if the property is not an array of strings,
468 * %-ENXIO if no suitable firmware interface is present.
470 int fwnode_property_match_string(const struct fwnode_handle *fwnode,
471 const char *propname, const char *string)
476 nval = fwnode_property_string_array_count(fwnode, propname);
483 values = kcalloc(nval, sizeof(*values), GFP_KERNEL);
487 ret = fwnode_property_read_string_array(fwnode, propname, values, nval);
491 ret = match_string(values, nval, string);
499 EXPORT_SYMBOL_GPL(fwnode_property_match_string);
502 * fwnode_property_match_property_string - find a property string value in an array and return index
503 * @fwnode: Firmware node to get the property of
504 * @propname: Name of the property holding the string value
505 * @array: String array to search in
506 * @n: Size of the @array
508 * Find a property string value in a given @array and if it is found return
511 * Return: index, starting from %0, if the string value was found in the @array (success),
512 * %-ENOENT when the string value was not found in the @array,
513 * %-EINVAL if given arguments are not valid,
514 * %-ENODATA if the property does not have a value,
515 * %-EPROTO or %-EILSEQ if the property is not a string,
516 * %-ENXIO if no suitable firmware interface is present.
518 int fwnode_property_match_property_string(const struct fwnode_handle *fwnode,
519 const char *propname, const char * const *array, size_t n)
524 ret = fwnode_property_read_string(fwnode, propname, &string);
528 ret = match_string(array, n, string);
534 EXPORT_SYMBOL_GPL(fwnode_property_match_property_string);
537 * fwnode_property_get_reference_args() - Find a reference with arguments
538 * @fwnode: Firmware node where to look for the reference
539 * @prop: The name of the property
540 * @nargs_prop: The name of the property telling the number of
541 * arguments in the referred node. NULL if @nargs is known,
542 * otherwise @nargs is ignored. Only relevant on OF.
543 * @nargs: Number of arguments. Ignored if @nargs_prop is non-NULL.
544 * @index: Index of the reference, from zero onwards.
545 * @args: Result structure with reference and integer arguments.
548 * Obtain a reference based on a named property in an fwnode, with
551 * The caller is responsible for calling fwnode_handle_put() on the returned
552 * @args->fwnode pointer.
554 * Return: %0 on success
555 * %-ENOENT when the index is out of bounds, the index has an empty
556 * reference or the property was not found
557 * %-EINVAL on parse error
559 int fwnode_property_get_reference_args(const struct fwnode_handle *fwnode,
560 const char *prop, const char *nargs_prop,
561 unsigned int nargs, unsigned int index,
562 struct fwnode_reference_args *args)
566 if (IS_ERR_OR_NULL(fwnode))
569 ret = fwnode_call_int_op(fwnode, get_reference_args, prop, nargs_prop,
574 if (IS_ERR_OR_NULL(fwnode->secondary))
577 return fwnode_call_int_op(fwnode->secondary, get_reference_args, prop, nargs_prop,
580 EXPORT_SYMBOL_GPL(fwnode_property_get_reference_args);
583 * fwnode_find_reference - Find named reference to a fwnode_handle
584 * @fwnode: Firmware node where to look for the reference
585 * @name: The name of the reference
586 * @index: Index of the reference
588 * @index can be used when the named reference holds a table of references.
590 * The caller is responsible for calling fwnode_handle_put() on the returned
593 * Return: a pointer to the reference fwnode, when found. Otherwise,
594 * returns an error pointer.
596 struct fwnode_handle *fwnode_find_reference(const struct fwnode_handle *fwnode,
600 struct fwnode_reference_args args;
603 ret = fwnode_property_get_reference_args(fwnode, name, NULL, 0, index,
605 return ret ? ERR_PTR(ret) : args.fwnode;
607 EXPORT_SYMBOL_GPL(fwnode_find_reference);
610 * fwnode_get_name - Return the name of a node
611 * @fwnode: The firmware node
613 * Return: a pointer to the node name, or %NULL.
615 const char *fwnode_get_name(const struct fwnode_handle *fwnode)
617 return fwnode_call_ptr_op(fwnode, get_name);
619 EXPORT_SYMBOL_GPL(fwnode_get_name);
622 * fwnode_get_name_prefix - Return the prefix of node for printing purposes
623 * @fwnode: The firmware node
625 * Return: the prefix of a node, intended to be printed right before the node.
626 * The prefix works also as a separator between the nodes.
628 const char *fwnode_get_name_prefix(const struct fwnode_handle *fwnode)
630 return fwnode_call_ptr_op(fwnode, get_name_prefix);
634 * fwnode_name_eq - Return true if node name is equal
635 * @fwnode: The firmware node
636 * @name: The name to which to compare the node name
638 * Compare the name provided as an argument to the name of the node, stopping
639 * the comparison at either NUL or '@' character, whichever comes first. This
640 * function is generally used for comparing node names while ignoring the
641 * possible unit address of the node.
643 * Return: true if the node name matches with the name provided in the @name
644 * argument, false otherwise.
646 bool fwnode_name_eq(const struct fwnode_handle *fwnode, const char *name)
648 const char *node_name;
651 node_name = fwnode_get_name(fwnode);
655 len = strchrnul(node_name, '@') - node_name;
657 return str_has_prefix(node_name, name) == len;
659 EXPORT_SYMBOL_GPL(fwnode_name_eq);
662 * fwnode_get_parent - Return parent firwmare node
663 * @fwnode: Firmware whose parent is retrieved
665 * The caller is responsible for calling fwnode_handle_put() on the returned
668 * Return: parent firmware node of the given node if possible or %NULL if no
669 * parent was available.
671 struct fwnode_handle *fwnode_get_parent(const struct fwnode_handle *fwnode)
673 return fwnode_call_ptr_op(fwnode, get_parent);
675 EXPORT_SYMBOL_GPL(fwnode_get_parent);
678 * fwnode_get_next_parent - Iterate to the node's parent
679 * @fwnode: Firmware whose parent is retrieved
681 * This is like fwnode_get_parent() except that it drops the refcount
682 * on the passed node, making it suitable for iterating through a
685 * The caller is responsible for calling fwnode_handle_put() on the returned
686 * fwnode pointer. Note that this function also puts a reference to @fwnode
689 * Return: parent firmware node of the given node if possible or %NULL if no
690 * parent was available.
692 struct fwnode_handle *fwnode_get_next_parent(struct fwnode_handle *fwnode)
694 struct fwnode_handle *parent = fwnode_get_parent(fwnode);
696 fwnode_handle_put(fwnode);
700 EXPORT_SYMBOL_GPL(fwnode_get_next_parent);
703 * fwnode_get_next_parent_dev - Find device of closest ancestor fwnode
704 * @fwnode: firmware node
706 * Given a firmware node (@fwnode), this function finds its closest ancestor
707 * firmware node that has a corresponding struct device and returns that struct
710 * The caller is responsible for calling put_device() on the returned device
713 * Return: a pointer to the device of the @fwnode's closest ancestor.
715 struct device *fwnode_get_next_parent_dev(const struct fwnode_handle *fwnode)
717 struct fwnode_handle *parent;
720 fwnode_for_each_parent_node(fwnode, parent) {
721 dev = get_dev_from_fwnode(parent);
723 fwnode_handle_put(parent);
731 * fwnode_count_parents - Return the number of parents a node has
732 * @fwnode: The node the parents of which are to be counted
734 * Return: the number of parents a node has.
736 unsigned int fwnode_count_parents(const struct fwnode_handle *fwnode)
738 struct fwnode_handle *parent;
739 unsigned int count = 0;
741 fwnode_for_each_parent_node(fwnode, parent)
746 EXPORT_SYMBOL_GPL(fwnode_count_parents);
749 * fwnode_get_nth_parent - Return an nth parent of a node
750 * @fwnode: The node the parent of which is requested
751 * @depth: Distance of the parent from the node
753 * The caller is responsible for calling fwnode_handle_put() on the returned
756 * Return: the nth parent of a node. If there is no parent at the requested
757 * @depth, %NULL is returned. If @depth is 0, the functionality is equivalent to
758 * fwnode_handle_get(). For @depth == 1, it is fwnode_get_parent() and so on.
760 struct fwnode_handle *fwnode_get_nth_parent(struct fwnode_handle *fwnode,
763 struct fwnode_handle *parent;
766 return fwnode_handle_get(fwnode);
768 fwnode_for_each_parent_node(fwnode, parent) {
774 EXPORT_SYMBOL_GPL(fwnode_get_nth_parent);
777 * fwnode_is_ancestor_of - Test if @ancestor is ancestor of @child
778 * @ancestor: Firmware which is tested for being an ancestor
779 * @child: Firmware which is tested for being the child
781 * A node is considered an ancestor of itself too.
783 * Return: true if @ancestor is an ancestor of @child. Otherwise, returns false.
785 bool fwnode_is_ancestor_of(const struct fwnode_handle *ancestor, const struct fwnode_handle *child)
787 struct fwnode_handle *parent;
789 if (IS_ERR_OR_NULL(ancestor))
792 if (child == ancestor)
795 fwnode_for_each_parent_node(child, parent) {
796 if (parent == ancestor) {
797 fwnode_handle_put(parent);
805 * fwnode_get_next_child_node - Return the next child node handle for a node
806 * @fwnode: Firmware node to find the next child node for.
807 * @child: Handle to one of the node's child nodes or a %NULL handle.
809 * The caller is responsible for calling fwnode_handle_put() on the returned
810 * fwnode pointer. Note that this function also puts a reference to @child
813 struct fwnode_handle *
814 fwnode_get_next_child_node(const struct fwnode_handle *fwnode,
815 struct fwnode_handle *child)
817 return fwnode_call_ptr_op(fwnode, get_next_child_node, child);
819 EXPORT_SYMBOL_GPL(fwnode_get_next_child_node);
822 * fwnode_get_next_available_child_node - Return the next available child node handle for a node
823 * @fwnode: Firmware node to find the next child node for.
824 * @child: Handle to one of the node's child nodes or a %NULL handle.
826 * The caller is responsible for calling fwnode_handle_put() on the returned
827 * fwnode pointer. Note that this function also puts a reference to @child
830 struct fwnode_handle *
831 fwnode_get_next_available_child_node(const struct fwnode_handle *fwnode,
832 struct fwnode_handle *child)
834 struct fwnode_handle *next_child = child;
836 if (IS_ERR_OR_NULL(fwnode))
840 next_child = fwnode_get_next_child_node(fwnode, next_child);
843 } while (!fwnode_device_is_available(next_child));
847 EXPORT_SYMBOL_GPL(fwnode_get_next_available_child_node);
850 * device_get_next_child_node - Return the next child node handle for a device
851 * @dev: Device to find the next child node for.
852 * @child: Handle to one of the device's child nodes or a %NULL handle.
854 * The caller is responsible for calling fwnode_handle_put() on the returned
855 * fwnode pointer. Note that this function also puts a reference to @child
858 struct fwnode_handle *device_get_next_child_node(const struct device *dev,
859 struct fwnode_handle *child)
861 const struct fwnode_handle *fwnode = dev_fwnode(dev);
862 struct fwnode_handle *next;
864 if (IS_ERR_OR_NULL(fwnode))
867 /* Try to find a child in primary fwnode */
868 next = fwnode_get_next_child_node(fwnode, child);
872 /* When no more children in primary, continue with secondary */
873 return fwnode_get_next_child_node(fwnode->secondary, child);
875 EXPORT_SYMBOL_GPL(device_get_next_child_node);
878 * fwnode_get_named_child_node - Return first matching named child node handle
879 * @fwnode: Firmware node to find the named child node for.
880 * @childname: String to match child node name against.
882 * The caller is responsible for calling fwnode_handle_put() on the returned
885 struct fwnode_handle *
886 fwnode_get_named_child_node(const struct fwnode_handle *fwnode,
887 const char *childname)
889 return fwnode_call_ptr_op(fwnode, get_named_child_node, childname);
891 EXPORT_SYMBOL_GPL(fwnode_get_named_child_node);
894 * device_get_named_child_node - Return first matching named child node handle
895 * @dev: Device to find the named child node for.
896 * @childname: String to match child node name against.
898 * The caller is responsible for calling fwnode_handle_put() on the returned
901 struct fwnode_handle *device_get_named_child_node(const struct device *dev,
902 const char *childname)
904 return fwnode_get_named_child_node(dev_fwnode(dev), childname);
906 EXPORT_SYMBOL_GPL(device_get_named_child_node);
909 * fwnode_handle_get - Obtain a reference to a device node
910 * @fwnode: Pointer to the device node to obtain the reference to.
912 * The caller is responsible for calling fwnode_handle_put() on the returned
915 * Return: the fwnode handle.
917 struct fwnode_handle *fwnode_handle_get(struct fwnode_handle *fwnode)
919 if (!fwnode_has_op(fwnode, get))
922 return fwnode_call_ptr_op(fwnode, get);
924 EXPORT_SYMBOL_GPL(fwnode_handle_get);
927 * fwnode_handle_put - Drop reference to a device node
928 * @fwnode: Pointer to the device node to drop the reference to.
930 * This has to be used when terminating device_for_each_child_node() iteration
931 * with break or return to prevent stale device node references from being left
934 void fwnode_handle_put(struct fwnode_handle *fwnode)
936 fwnode_call_void_op(fwnode, put);
938 EXPORT_SYMBOL_GPL(fwnode_handle_put);
941 * fwnode_device_is_available - check if a device is available for use
942 * @fwnode: Pointer to the fwnode of the device.
944 * Return: true if device is available for use. Otherwise, returns false.
946 * For fwnode node types that don't implement the .device_is_available()
947 * operation, this function returns true.
949 bool fwnode_device_is_available(const struct fwnode_handle *fwnode)
951 if (IS_ERR_OR_NULL(fwnode))
954 if (!fwnode_has_op(fwnode, device_is_available))
957 return fwnode_call_bool_op(fwnode, device_is_available);
959 EXPORT_SYMBOL_GPL(fwnode_device_is_available);
962 * device_get_child_node_count - return the number of child nodes for device
963 * @dev: Device to cound the child nodes for
965 * Return: the number of child nodes for a given device.
967 unsigned int device_get_child_node_count(const struct device *dev)
969 struct fwnode_handle *child;
970 unsigned int count = 0;
972 device_for_each_child_node(dev, child)
977 EXPORT_SYMBOL_GPL(device_get_child_node_count);
979 bool device_dma_supported(const struct device *dev)
981 return fwnode_call_bool_op(dev_fwnode(dev), device_dma_supported);
983 EXPORT_SYMBOL_GPL(device_dma_supported);
985 enum dev_dma_attr device_get_dma_attr(const struct device *dev)
987 if (!fwnode_has_op(dev_fwnode(dev), device_get_dma_attr))
988 return DEV_DMA_NOT_SUPPORTED;
990 return fwnode_call_int_op(dev_fwnode(dev), device_get_dma_attr);
992 EXPORT_SYMBOL_GPL(device_get_dma_attr);
995 * fwnode_get_phy_mode - Get phy mode for given firmware node
996 * @fwnode: Pointer to the given node
998 * The function gets phy interface string from property 'phy-mode' or
999 * 'phy-connection-type', and return its index in phy_modes table, or errno in
1002 int fwnode_get_phy_mode(const struct fwnode_handle *fwnode)
1007 err = fwnode_property_read_string(fwnode, "phy-mode", &pm);
1009 err = fwnode_property_read_string(fwnode,
1010 "phy-connection-type", &pm);
1014 for (i = 0; i < PHY_INTERFACE_MODE_MAX; i++)
1015 if (!strcasecmp(pm, phy_modes(i)))
1020 EXPORT_SYMBOL_GPL(fwnode_get_phy_mode);
1023 * device_get_phy_mode - Get phy mode for given device
1024 * @dev: Pointer to the given device
1026 * The function gets phy interface string from property 'phy-mode' or
1027 * 'phy-connection-type', and return its index in phy_modes table, or errno in
1030 int device_get_phy_mode(struct device *dev)
1032 return fwnode_get_phy_mode(dev_fwnode(dev));
1034 EXPORT_SYMBOL_GPL(device_get_phy_mode);
1037 * fwnode_iomap - Maps the memory mapped IO for a given fwnode
1038 * @fwnode: Pointer to the firmware node
1039 * @index: Index of the IO range
1041 * Return: a pointer to the mapped memory.
1043 void __iomem *fwnode_iomap(struct fwnode_handle *fwnode, int index)
1045 return fwnode_call_ptr_op(fwnode, iomap, index);
1047 EXPORT_SYMBOL(fwnode_iomap);
1050 * fwnode_irq_get - Get IRQ directly from a fwnode
1051 * @fwnode: Pointer to the firmware node
1052 * @index: Zero-based index of the IRQ
1054 * Return: Linux IRQ number on success. Negative errno on failure.
1056 int fwnode_irq_get(const struct fwnode_handle *fwnode, unsigned int index)
1060 ret = fwnode_call_int_op(fwnode, irq_get, index);
1061 /* We treat mapping errors as invalid case */
1067 EXPORT_SYMBOL(fwnode_irq_get);
1070 * fwnode_irq_get_byname - Get IRQ from a fwnode using its name
1071 * @fwnode: Pointer to the firmware node
1075 * Find a match to the string @name in the 'interrupt-names' string array
1076 * in _DSD for ACPI, or of_node for Device Tree. Then get the Linux IRQ
1077 * number of the IRQ resource corresponding to the index of the matched
1080 * Return: Linux IRQ number on success, or negative errno otherwise.
1082 int fwnode_irq_get_byname(const struct fwnode_handle *fwnode, const char *name)
1089 index = fwnode_property_match_string(fwnode, "interrupt-names", name);
1093 return fwnode_irq_get(fwnode, index);
1095 EXPORT_SYMBOL(fwnode_irq_get_byname);
1098 * fwnode_graph_get_next_endpoint - Get next endpoint firmware node
1099 * @fwnode: Pointer to the parent firmware node
1100 * @prev: Previous endpoint node or %NULL to get the first
1102 * The caller is responsible for calling fwnode_handle_put() on the returned
1103 * fwnode pointer. Note that this function also puts a reference to @prev
1106 * Return: an endpoint firmware node pointer or %NULL if no more endpoints
1109 struct fwnode_handle *
1110 fwnode_graph_get_next_endpoint(const struct fwnode_handle *fwnode,
1111 struct fwnode_handle *prev)
1113 struct fwnode_handle *ep, *port_parent = NULL;
1114 const struct fwnode_handle *parent;
1117 * If this function is in a loop and the previous iteration returned
1118 * an endpoint from fwnode->secondary, then we need to use the secondary
1119 * as parent rather than @fwnode.
1122 port_parent = fwnode_graph_get_port_parent(prev);
1123 parent = port_parent;
1127 if (IS_ERR_OR_NULL(parent))
1130 ep = fwnode_call_ptr_op(parent, graph_get_next_endpoint, prev);
1132 goto out_put_port_parent;
1134 ep = fwnode_graph_get_next_endpoint(parent->secondary, NULL);
1136 out_put_port_parent:
1137 fwnode_handle_put(port_parent);
1140 EXPORT_SYMBOL_GPL(fwnode_graph_get_next_endpoint);
1143 * fwnode_graph_get_port_parent - Return the device fwnode of a port endpoint
1144 * @endpoint: Endpoint firmware node of the port
1146 * The caller is responsible for calling fwnode_handle_put() on the returned
1149 * Return: the firmware node of the device the @endpoint belongs to.
1151 struct fwnode_handle *
1152 fwnode_graph_get_port_parent(const struct fwnode_handle *endpoint)
1154 struct fwnode_handle *port, *parent;
1156 port = fwnode_get_parent(endpoint);
1157 parent = fwnode_call_ptr_op(port, graph_get_port_parent);
1159 fwnode_handle_put(port);
1163 EXPORT_SYMBOL_GPL(fwnode_graph_get_port_parent);
1166 * fwnode_graph_get_remote_port_parent - Return fwnode of a remote device
1167 * @fwnode: Endpoint firmware node pointing to the remote endpoint
1169 * Extracts firmware node of a remote device the @fwnode points to.
1171 * The caller is responsible for calling fwnode_handle_put() on the returned
1174 struct fwnode_handle *
1175 fwnode_graph_get_remote_port_parent(const struct fwnode_handle *fwnode)
1177 struct fwnode_handle *endpoint, *parent;
1179 endpoint = fwnode_graph_get_remote_endpoint(fwnode);
1180 parent = fwnode_graph_get_port_parent(endpoint);
1182 fwnode_handle_put(endpoint);
1186 EXPORT_SYMBOL_GPL(fwnode_graph_get_remote_port_parent);
1189 * fwnode_graph_get_remote_port - Return fwnode of a remote port
1190 * @fwnode: Endpoint firmware node pointing to the remote endpoint
1192 * Extracts firmware node of a remote port the @fwnode points to.
1194 * The caller is responsible for calling fwnode_handle_put() on the returned
1197 struct fwnode_handle *
1198 fwnode_graph_get_remote_port(const struct fwnode_handle *fwnode)
1200 return fwnode_get_next_parent(fwnode_graph_get_remote_endpoint(fwnode));
1202 EXPORT_SYMBOL_GPL(fwnode_graph_get_remote_port);
1205 * fwnode_graph_get_remote_endpoint - Return fwnode of a remote endpoint
1206 * @fwnode: Endpoint firmware node pointing to the remote endpoint
1208 * Extracts firmware node of a remote endpoint the @fwnode points to.
1210 * The caller is responsible for calling fwnode_handle_put() on the returned
1213 struct fwnode_handle *
1214 fwnode_graph_get_remote_endpoint(const struct fwnode_handle *fwnode)
1216 return fwnode_call_ptr_op(fwnode, graph_get_remote_endpoint);
1218 EXPORT_SYMBOL_GPL(fwnode_graph_get_remote_endpoint);
1220 static bool fwnode_graph_remote_available(struct fwnode_handle *ep)
1222 struct fwnode_handle *dev_node;
1225 dev_node = fwnode_graph_get_remote_port_parent(ep);
1226 available = fwnode_device_is_available(dev_node);
1227 fwnode_handle_put(dev_node);
1233 * fwnode_graph_get_endpoint_by_id - get endpoint by port and endpoint numbers
1234 * @fwnode: parent fwnode_handle containing the graph
1235 * @port: identifier of the port node
1236 * @endpoint: identifier of the endpoint node under the port node
1237 * @flags: fwnode lookup flags
1239 * The caller is responsible for calling fwnode_handle_put() on the returned
1242 * Return: the fwnode handle of the local endpoint corresponding the port and
1243 * endpoint IDs or %NULL if not found.
1245 * If FWNODE_GRAPH_ENDPOINT_NEXT is passed in @flags and the specified endpoint
1246 * has not been found, look for the closest endpoint ID greater than the
1247 * specified one and return the endpoint that corresponds to it, if present.
1249 * Does not return endpoints that belong to disabled devices or endpoints that
1250 * are unconnected, unless FWNODE_GRAPH_DEVICE_DISABLED is passed in @flags.
1252 struct fwnode_handle *
1253 fwnode_graph_get_endpoint_by_id(const struct fwnode_handle *fwnode,
1254 u32 port, u32 endpoint, unsigned long flags)
1256 struct fwnode_handle *ep, *best_ep = NULL;
1257 unsigned int best_ep_id = 0;
1258 bool endpoint_next = flags & FWNODE_GRAPH_ENDPOINT_NEXT;
1259 bool enabled_only = !(flags & FWNODE_GRAPH_DEVICE_DISABLED);
1261 fwnode_graph_for_each_endpoint(fwnode, ep) {
1262 struct fwnode_endpoint fwnode_ep = { 0 };
1265 if (enabled_only && !fwnode_graph_remote_available(ep))
1268 ret = fwnode_graph_parse_endpoint(ep, &fwnode_ep);
1272 if (fwnode_ep.port != port)
1275 if (fwnode_ep.id == endpoint)
1282 * If the endpoint that has just been found is not the first
1283 * matching one and the ID of the one found previously is closer
1284 * to the requested endpoint ID, skip it.
1286 if (fwnode_ep.id < endpoint ||
1287 (best_ep && best_ep_id < fwnode_ep.id))
1290 fwnode_handle_put(best_ep);
1291 best_ep = fwnode_handle_get(ep);
1292 best_ep_id = fwnode_ep.id;
1297 EXPORT_SYMBOL_GPL(fwnode_graph_get_endpoint_by_id);
1300 * fwnode_graph_get_endpoint_count - Count endpoints on a device node
1301 * @fwnode: The node related to a device
1302 * @flags: fwnode lookup flags
1303 * Count endpoints in a device node.
1305 * If FWNODE_GRAPH_DEVICE_DISABLED flag is specified, also unconnected endpoints
1306 * and endpoints connected to disabled devices are counted.
1308 unsigned int fwnode_graph_get_endpoint_count(const struct fwnode_handle *fwnode,
1309 unsigned long flags)
1311 struct fwnode_handle *ep;
1312 unsigned int count = 0;
1314 fwnode_graph_for_each_endpoint(fwnode, ep) {
1315 if (flags & FWNODE_GRAPH_DEVICE_DISABLED ||
1316 fwnode_graph_remote_available(ep))
1322 EXPORT_SYMBOL_GPL(fwnode_graph_get_endpoint_count);
1325 * fwnode_graph_parse_endpoint - parse common endpoint node properties
1326 * @fwnode: pointer to endpoint fwnode_handle
1327 * @endpoint: pointer to the fwnode endpoint data structure
1329 * Parse @fwnode representing a graph endpoint node and store the
1330 * information in @endpoint. The caller must hold a reference to
1333 int fwnode_graph_parse_endpoint(const struct fwnode_handle *fwnode,
1334 struct fwnode_endpoint *endpoint)
1336 memset(endpoint, 0, sizeof(*endpoint));
1338 return fwnode_call_int_op(fwnode, graph_parse_endpoint, endpoint);
1340 EXPORT_SYMBOL(fwnode_graph_parse_endpoint);
1342 const void *device_get_match_data(const struct device *dev)
1344 return fwnode_call_ptr_op(dev_fwnode(dev), device_get_match_data, dev);
1346 EXPORT_SYMBOL_GPL(device_get_match_data);
1348 static unsigned int fwnode_graph_devcon_matches(const struct fwnode_handle *fwnode,
1349 const char *con_id, void *data,
1350 devcon_match_fn_t match,
1352 unsigned int matches_len)
1354 struct fwnode_handle *node;
1355 struct fwnode_handle *ep;
1356 unsigned int count = 0;
1359 fwnode_graph_for_each_endpoint(fwnode, ep) {
1360 if (matches && count >= matches_len) {
1361 fwnode_handle_put(ep);
1365 node = fwnode_graph_get_remote_port_parent(ep);
1366 if (!fwnode_device_is_available(node)) {
1367 fwnode_handle_put(node);
1371 ret = match(node, con_id, data);
1372 fwnode_handle_put(node);
1375 matches[count] = ret;
1382 static unsigned int fwnode_devcon_matches(const struct fwnode_handle *fwnode,
1383 const char *con_id, void *data,
1384 devcon_match_fn_t match,
1386 unsigned int matches_len)
1388 struct fwnode_handle *node;
1389 unsigned int count = 0;
1393 for (i = 0; ; i++) {
1394 if (matches && count >= matches_len)
1397 node = fwnode_find_reference(fwnode, con_id, i);
1401 ret = match(node, NULL, data);
1402 fwnode_handle_put(node);
1405 matches[count] = ret;
1414 * fwnode_connection_find_match - Find connection from a device node
1415 * @fwnode: Device node with the connection
1416 * @con_id: Identifier for the connection
1417 * @data: Data for the match function
1418 * @match: Function to check and convert the connection description
1420 * Find a connection with unique identifier @con_id between @fwnode and another
1421 * device node. @match will be used to convert the connection description to
1422 * data the caller is expecting to be returned.
1424 void *fwnode_connection_find_match(const struct fwnode_handle *fwnode,
1425 const char *con_id, void *data,
1426 devcon_match_fn_t match)
1431 if (!fwnode || !match)
1434 count = fwnode_graph_devcon_matches(fwnode, con_id, data, match, &ret, 1);
1438 count = fwnode_devcon_matches(fwnode, con_id, data, match, &ret, 1);
1439 return count ? ret : NULL;
1441 EXPORT_SYMBOL_GPL(fwnode_connection_find_match);
1444 * fwnode_connection_find_matches - Find connections from a device node
1445 * @fwnode: Device node with the connection
1446 * @con_id: Identifier for the connection
1447 * @data: Data for the match function
1448 * @match: Function to check and convert the connection description
1449 * @matches: (Optional) array of pointers to fill with matches
1450 * @matches_len: Length of @matches
1452 * Find up to @matches_len connections with unique identifier @con_id between
1453 * @fwnode and other device nodes. @match will be used to convert the
1454 * connection description to data the caller is expecting to be returned
1455 * through the @matches array.
1457 * If @matches is %NULL @matches_len is ignored and the total number of resolved
1458 * matches is returned.
1460 * Return: Number of matches resolved, or negative errno.
1462 int fwnode_connection_find_matches(const struct fwnode_handle *fwnode,
1463 const char *con_id, void *data,
1464 devcon_match_fn_t match,
1465 void **matches, unsigned int matches_len)
1467 unsigned int count_graph;
1468 unsigned int count_ref;
1470 if (!fwnode || !match)
1473 count_graph = fwnode_graph_devcon_matches(fwnode, con_id, data, match,
1474 matches, matches_len);
1477 matches += count_graph;
1478 matches_len -= count_graph;
1481 count_ref = fwnode_devcon_matches(fwnode, con_id, data, match,
1482 matches, matches_len);
1484 return count_graph + count_ref;
1486 EXPORT_SYMBOL_GPL(fwnode_connection_find_matches);