| // SPDX-License-Identifier: GPL-2.0 |
| /* |
| * property.c - Unified device property interface. |
| * |
| * Copyright (C) 2014, Intel Corporation |
| * Authors: Rafael J. Wysocki <rafael.j.wysocki@intel.com> |
| * Mika Westerberg <mika.westerberg@linux.intel.com> |
| */ |
| |
| #include <linux/acpi.h> |
| #include <linux/export.h> |
| #include <linux/kernel.h> |
| #include <linux/of.h> |
| #include <linux/of_address.h> |
| #include <linux/of_graph.h> |
| #include <linux/of_irq.h> |
| #include <linux/property.h> |
| #include <linux/etherdevice.h> |
| #include <linux/phy.h> |
| |
| struct fwnode_handle *dev_fwnode(struct device *dev) |
| { |
| return IS_ENABLED(CONFIG_OF) && dev->of_node ? |
| &dev->of_node->fwnode : dev->fwnode; |
| } |
| EXPORT_SYMBOL_GPL(dev_fwnode); |
| |
| /** |
| * device_property_present - check if a property of a device is present |
| * @dev: Device whose property is being checked |
| * @propname: Name of the property |
| * |
| * Check if property @propname is present in the device firmware description. |
| */ |
| bool device_property_present(struct device *dev, const char *propname) |
| { |
| return fwnode_property_present(dev_fwnode(dev), propname); |
| } |
| EXPORT_SYMBOL_GPL(device_property_present); |
| |
| /** |
| * fwnode_property_present - check if a property of a firmware node is present |
| * @fwnode: Firmware node whose property to check |
| * @propname: Name of the property |
| */ |
| bool fwnode_property_present(const struct fwnode_handle *fwnode, |
| const char *propname) |
| { |
| bool ret; |
| |
| ret = fwnode_call_bool_op(fwnode, property_present, propname); |
| if (ret == false && !IS_ERR_OR_NULL(fwnode) && |
| !IS_ERR_OR_NULL(fwnode->secondary)) |
| ret = fwnode_call_bool_op(fwnode->secondary, property_present, |
| propname); |
| return ret; |
| } |
| EXPORT_SYMBOL_GPL(fwnode_property_present); |
| |
| /** |
| * device_property_read_u8_array - return a u8 array property of a device |
| * @dev: Device to get the property of |
| * @propname: Name of the property |
| * @val: The values are stored here or %NULL to return the number of values |
| * @nval: Size of the @val array |
| * |
| * Function reads an array of u8 properties with @propname from the device |
| * firmware description and stores them to @val if found. |
| * |
| * Return: number of values if @val was %NULL, |
| * %0 if the property was found (success), |
| * %-EINVAL if given arguments are not valid, |
| * %-ENODATA if the property does not have a value, |
| * %-EPROTO if the property is not an array of numbers, |
| * %-EOVERFLOW if the size of the property is not as expected. |
| * %-ENXIO if no suitable firmware interface is present. |
| */ |
| int device_property_read_u8_array(struct device *dev, const char *propname, |
| u8 *val, size_t nval) |
| { |
| return fwnode_property_read_u8_array(dev_fwnode(dev), propname, val, nval); |
| } |
| EXPORT_SYMBOL_GPL(device_property_read_u8_array); |
| |
| /** |
| * device_property_read_u16_array - return a u16 array property of a device |
| * @dev: Device to get the property of |
| * @propname: Name of the property |
| * @val: The values are stored here or %NULL to return the number of values |
| * @nval: Size of the @val array |
| * |
| * Function reads an array of u16 properties with @propname from the device |
| * firmware description and stores them to @val if found. |
| * |
| * Return: number of values if @val was %NULL, |
| * %0 if the property was found (success), |
| * %-EINVAL if given arguments are not valid, |
| * %-ENODATA if the property does not have a value, |
| * %-EPROTO if the property is not an array of numbers, |
| * %-EOVERFLOW if the size of the property is not as expected. |
| * %-ENXIO if no suitable firmware interface is present. |
| */ |
| int device_property_read_u16_array(struct device *dev, const char *propname, |
| u16 *val, size_t nval) |
| { |
| return fwnode_property_read_u16_array(dev_fwnode(dev), propname, val, nval); |
| } |
| EXPORT_SYMBOL_GPL(device_property_read_u16_array); |
| |
| /** |
| * device_property_read_u32_array - return a u32 array property of a device |
| * @dev: Device to get the property of |
| * @propname: Name of the property |
| * @val: The values are stored here or %NULL to return the number of values |
| * @nval: Size of the @val array |
| * |
| * Function reads an array of u32 properties with @propname from the device |
| * firmware description and stores them to @val if found. |
| * |
| * Return: number of values if @val was %NULL, |
| * %0 if the property was found (success), |
| * %-EINVAL if given arguments are not valid, |
| * %-ENODATA if the property does not have a value, |
| * %-EPROTO if the property is not an array of numbers, |
| * %-EOVERFLOW if the size of the property is not as expected. |
| * %-ENXIO if no suitable firmware interface is present. |
| */ |
| int device_property_read_u32_array(struct device *dev, const char *propname, |
| u32 *val, size_t nval) |
| { |
| return fwnode_property_read_u32_array(dev_fwnode(dev), propname, val, nval); |
| } |
| EXPORT_SYMBOL_GPL(device_property_read_u32_array); |
| |
| /** |
| * device_property_read_u64_array - return a u64 array property of a device |
| * @dev: Device to get the property of |
| * @propname: Name of the property |
| * @val: The values are stored here or %NULL to return the number of values |
| * @nval: Size of the @val array |
| * |
| * Function reads an array of u64 properties with @propname from the device |
| * firmware description and stores them to @val if found. |
| * |
| * Return: number of values if @val was %NULL, |
| * %0 if the property was found (success), |
| * %-EINVAL if given arguments are not valid, |
| * %-ENODATA if the property does not have a value, |
| * %-EPROTO if the property is not an array of numbers, |
| * %-EOVERFLOW if the size of the property is not as expected. |
| * %-ENXIO if no suitable firmware interface is present. |
| */ |
| int device_property_read_u64_array(struct device *dev, const char *propname, |
| u64 *val, size_t nval) |
| { |
| return fwnode_property_read_u64_array(dev_fwnode(dev), propname, val, nval); |
| } |
| EXPORT_SYMBOL_GPL(device_property_read_u64_array); |
| |
| /** |
| * device_property_read_string_array - return a string array property of device |
| * @dev: Device to get the property of |
| * @propname: Name of the property |
| * @val: The values are stored here or %NULL to return the number of values |
| * @nval: Size of the @val array |
| * |
| * Function reads an array of string properties with @propname from the device |
| * firmware description and stores them to @val if found. |
| * |
| * Return: number of values read on success if @val is non-NULL, |
| * number of values available on success if @val is NULL, |
| * %-EINVAL if given arguments are not valid, |
| * %-ENODATA if the property does not have a value, |
| * %-EPROTO or %-EILSEQ if the property is not an array of strings, |
| * %-EOVERFLOW if the size of the property is not as expected. |
| * %-ENXIO if no suitable firmware interface is present. |
| */ |
| int device_property_read_string_array(struct device *dev, const char *propname, |
| const char **val, size_t nval) |
| { |
| return fwnode_property_read_string_array(dev_fwnode(dev), propname, val, nval); |
| } |
| EXPORT_SYMBOL_GPL(device_property_read_string_array); |
| |
| /** |
| * device_property_read_string - return a string property of a device |
| * @dev: Device to get the property of |
| * @propname: Name of the property |
| * @val: The value is stored here |
| * |
| * Function reads property @propname from the device firmware description and |
| * stores the value into @val if found. The value is checked to be a string. |
| * |
| * Return: %0 if the property was found (success), |
| * %-EINVAL if given arguments are not valid, |
| * %-ENODATA if the property does not have a value, |
| * %-EPROTO or %-EILSEQ if the property type is not a string. |
| * %-ENXIO if no suitable firmware interface is present. |
| */ |
| int device_property_read_string(struct device *dev, const char *propname, |
| const char **val) |
| { |
| return fwnode_property_read_string(dev_fwnode(dev), propname, val); |
| } |
| EXPORT_SYMBOL_GPL(device_property_read_string); |
| |
| /** |
| * device_property_match_string - find a string in an array and return index |
| * @dev: Device to get the property of |
| * @propname: Name of the property holding the array |
| * @string: String to look for |
| * |
| * Find a given string in a string array and if it is found return the |
| * index back. |
| * |
| * Return: %0 if the property was found (success), |
| * %-EINVAL if given arguments are not valid, |
| * %-ENODATA if the property does not have a value, |
| * %-EPROTO if the property is not an array of strings, |
| * %-ENXIO if no suitable firmware interface is present. |
| */ |
| int device_property_match_string(struct device *dev, const char *propname, |
| const char *string) |
| { |
| return fwnode_property_match_string(dev_fwnode(dev), propname, string); |
| } |
| EXPORT_SYMBOL_GPL(device_property_match_string); |
| |
| static int fwnode_property_read_int_array(const struct fwnode_handle *fwnode, |
| const char *propname, |
| unsigned int elem_size, void *val, |
| size_t nval) |
| { |
| int ret; |
| |
| ret = fwnode_call_int_op(fwnode, property_read_int_array, propname, |
| elem_size, val, nval); |
| if (ret == -EINVAL && !IS_ERR_OR_NULL(fwnode) && |
| !IS_ERR_OR_NULL(fwnode->secondary)) |
| ret = fwnode_call_int_op( |
| fwnode->secondary, property_read_int_array, propname, |
| elem_size, val, nval); |
| |
| return ret; |
| } |
| |
| /** |
| * fwnode_property_read_u8_array - return a u8 array property of firmware node |
| * @fwnode: Firmware node to get the property of |
| * @propname: Name of the property |
| * @val: The values are stored here or %NULL to return the number of values |
| * @nval: Size of the @val array |
| * |
| * Read an array of u8 properties with @propname from @fwnode and stores them to |
| * @val if found. |
| * |
| * Return: number of values if @val was %NULL, |
| * %0 if the property was found (success), |
| * %-EINVAL if given arguments are not valid, |
| * %-ENODATA if the property does not have a value, |
| * %-EPROTO if the property is not an array of numbers, |
| * %-EOVERFLOW if the size of the property is not as expected, |
| * %-ENXIO if no suitable firmware interface is present. |
| */ |
| int fwnode_property_read_u8_array(const struct fwnode_handle *fwnode, |
| const char *propname, u8 *val, size_t nval) |
| { |
| return fwnode_property_read_int_array(fwnode, propname, sizeof(u8), |
| val, nval); |
| } |
| EXPORT_SYMBOL_GPL(fwnode_property_read_u8_array); |
| |
| /** |
| * fwnode_property_read_u16_array - return a u16 array property of firmware node |
| * @fwnode: Firmware node to get the property of |
| * @propname: Name of the property |
| * @val: The values are stored here or %NULL to return the number of values |
| * @nval: Size of the @val array |
| * |
| * Read an array of u16 properties with @propname from @fwnode and store them to |
| * @val if found. |
| * |
| * Return: number of values if @val was %NULL, |
| * %0 if the property was found (success), |
| * %-EINVAL if given arguments are not valid, |
| * %-ENODATA if the property does not have a value, |
| * %-EPROTO if the property is not an array of numbers, |
| * %-EOVERFLOW if the size of the property is not as expected, |
| * %-ENXIO if no suitable firmware interface is present. |
| */ |
| int fwnode_property_read_u16_array(const struct fwnode_handle *fwnode, |
| const char *propname, u16 *val, size_t nval) |
| { |
| return fwnode_property_read_int_array(fwnode, propname, sizeof(u16), |
| val, nval); |
| } |
| EXPORT_SYMBOL_GPL(fwnode_property_read_u16_array); |
| |
| /** |
| * fwnode_property_read_u32_array - return a u32 array property of firmware node |
| * @fwnode: Firmware node to get the property of |
| * @propname: Name of the property |
| * @val: The values are stored here or %NULL to return the number of values |
| * @nval: Size of the @val array |
| * |
| * Read an array of u32 properties with @propname from @fwnode store them to |
| * @val if found. |
| * |
| * Return: number of values if @val was %NULL, |
| * %0 if the property was found (success), |
| * %-EINVAL if given arguments are not valid, |
| * %-ENODATA if the property does not have a value, |
| * %-EPROTO if the property is not an array of numbers, |
| * %-EOVERFLOW if the size of the property is not as expected, |
| * %-ENXIO if no suitable firmware interface is present. |
| */ |
| int fwnode_property_read_u32_array(const struct fwnode_handle *fwnode, |
| const char *propname, u32 *val, size_t nval) |
| { |
| return fwnode_property_read_int_array(fwnode, propname, sizeof(u32), |
| val, nval); |
| } |
| EXPORT_SYMBOL_GPL(fwnode_property_read_u32_array); |
| |
| /** |
| * fwnode_property_read_u64_array - return a u64 array property firmware node |
| * @fwnode: Firmware node to get the property of |
| * @propname: Name of the property |
| * @val: The values are stored here or %NULL to return the number of values |
| * @nval: Size of the @val array |
| * |
| * Read an array of u64 properties with @propname from @fwnode and store them to |
| * @val if found. |
| * |
| * Return: number of values if @val was %NULL, |
| * %0 if the property was found (success), |
| * %-EINVAL if given arguments are not valid, |
| * %-ENODATA if the property does not have a value, |
| * %-EPROTO if the property is not an array of numbers, |
| * %-EOVERFLOW if the size of the property is not as expected, |
| * %-ENXIO if no suitable firmware interface is present. |
| */ |
| int fwnode_property_read_u64_array(const struct fwnode_handle *fwnode, |
| const char *propname, u64 *val, size_t nval) |
| { |
| return fwnode_property_read_int_array(fwnode, propname, sizeof(u64), |
| val, nval); |
| } |
| EXPORT_SYMBOL_GPL(fwnode_property_read_u64_array); |
| |
| /** |
| * fwnode_property_read_string_array - return string array property of a node |
| * @fwnode: Firmware node to get the property of |
| * @propname: Name of the property |
| * @val: The values are stored here or %NULL to return the number of values |
| * @nval: Size of the @val array |
| * |
| * Read an string list property @propname from the given firmware node and store |
| * them to @val if found. |
| * |
| * Return: number of values read on success if @val is non-NULL, |
| * number of values available on success if @val is NULL, |
| * %-EINVAL if given arguments are not valid, |
| * %-ENODATA if the property does not have a value, |
| * %-EPROTO or %-EILSEQ if the property is not an array of strings, |
| * %-EOVERFLOW if the size of the property is not as expected, |
| * %-ENXIO if no suitable firmware interface is present. |
| */ |
| int fwnode_property_read_string_array(const struct fwnode_handle *fwnode, |
| const char *propname, const char **val, |
| size_t nval) |
| { |
| int ret; |
| |
| ret = fwnode_call_int_op(fwnode, property_read_string_array, propname, |
| val, nval); |
| if (ret == -EINVAL && !IS_ERR_OR_NULL(fwnode) && |
| !IS_ERR_OR_NULL(fwnode->secondary)) |
| ret = fwnode_call_int_op(fwnode->secondary, |
| property_read_string_array, propname, |
| val, nval); |
| return ret; |
| } |
| EXPORT_SYMBOL_GPL(fwnode_property_read_string_array); |
| |
| /** |
| * fwnode_property_read_string - return a string property of a firmware node |
| * @fwnode: Firmware node to get the property of |
| * @propname: Name of the property |
| * @val: The value is stored here |
| * |
| * Read property @propname from the given firmware node and store the value into |
| * @val if found. The value is checked to be a string. |
| * |
| * Return: %0 if the property was found (success), |
| * %-EINVAL if given arguments are not valid, |
| * %-ENODATA if the property does not have a value, |
| * %-EPROTO or %-EILSEQ if the property is not a string, |
| * %-ENXIO if no suitable firmware interface is present. |
| */ |
| int fwnode_property_read_string(const struct fwnode_handle *fwnode, |
| const char *propname, const char **val) |
| { |
| int ret = fwnode_property_read_string_array(fwnode, propname, val, 1); |
| |
| return ret < 0 ? ret : 0; |
| } |
| EXPORT_SYMBOL_GPL(fwnode_property_read_string); |
| |
| /** |
| * fwnode_property_match_string - find a string in an array and return index |
| * @fwnode: Firmware node to get the property of |
| * @propname: Name of the property holding the array |
| * @string: String to look for |
| * |
| * Find a given string in a string array and if it is found return the |
| * index back. |
| * |
| * Return: %0 if the property was found (success), |
| * %-EINVAL if given arguments are not valid, |
| * %-ENODATA if the property does not have a value, |
| * %-EPROTO if the property is not an array of strings, |
| * %-ENXIO if no suitable firmware interface is present. |
| */ |
| int fwnode_property_match_string(const struct fwnode_handle *fwnode, |
| const char *propname, const char *string) |
| { |
| const char **values; |
| int nval, ret; |
| |
| nval = fwnode_property_read_string_array(fwnode, propname, NULL, 0); |
| if (nval < 0) |
| return nval; |
| |
| if (nval == 0) |
| return -ENODATA; |
| |
| values = kcalloc(nval, sizeof(*values), GFP_KERNEL); |
| if (!values) |
| return -ENOMEM; |
| |
| ret = fwnode_property_read_string_array(fwnode, propname, values, nval); |
| if (ret < 0) |
| goto out; |
| |
| ret = match_string(values, nval, string); |
| if (ret < 0) |
| ret = -ENODATA; |
| out: |
| kfree(values); |
| return ret; |
| } |
| EXPORT_SYMBOL_GPL(fwnode_property_match_string); |
| |
| /** |
| * fwnode_property_get_reference_args() - Find a reference with arguments |
| * @fwnode: Firmware node where to look for the reference |
| * @prop: The name of the property |
| * @nargs_prop: The name of the property telling the number of |
| * arguments in the referred node. NULL if @nargs is known, |
| * otherwise @nargs is ignored. Only relevant on OF. |
| * @nargs: Number of arguments. Ignored if @nargs_prop is non-NULL. |
| * @index: Index of the reference, from zero onwards. |
| * @args: Result structure with reference and integer arguments. |
| * |
| * Obtain a reference based on a named property in an fwnode, with |
| * integer arguments. |
| * |
| * Caller is responsible to call fwnode_handle_put() on the returned |
| * args->fwnode pointer. |
| * |
| * Returns: %0 on success |
| * %-ENOENT when the index is out of bounds, the index has an empty |
| * reference or the property was not found |
| * %-EINVAL on parse error |
| */ |
| int fwnode_property_get_reference_args(const struct fwnode_handle *fwnode, |
| const char *prop, const char *nargs_prop, |
| unsigned int nargs, unsigned int index, |
| struct fwnode_reference_args *args) |
| { |
| return fwnode_call_int_op(fwnode, get_reference_args, prop, nargs_prop, |
| nargs, index, args); |
| } |
| EXPORT_SYMBOL_GPL(fwnode_property_get_reference_args); |
| |
| /** |
| * fwnode_find_reference - Find named reference to a fwnode_handle |
| * @fwnode: Firmware node where to look for the reference |
| * @name: The name of the reference |
| * @index: Index of the reference |
| * |
| * @index can be used when the named reference holds a table of references. |
| * |
| * Returns pointer to the reference fwnode, or ERR_PTR. Caller is responsible to |
| * call fwnode_handle_put() on the returned fwnode pointer. |
| */ |
| struct fwnode_handle *fwnode_find_reference(const struct fwnode_handle *fwnode, |
| const char *name, |
| unsigned int index) |
| { |
| struct fwnode_reference_args args; |
| int ret; |
| |
| ret = fwnode_property_get_reference_args(fwnode, name, NULL, 0, index, |
| &args); |
| return ret ? ERR_PTR(ret) : args.fwnode; |
| } |
| EXPORT_SYMBOL_GPL(fwnode_find_reference); |
| |
| /** |
| * device_remove_properties - Remove properties from a device object. |
| * @dev: Device whose properties to remove. |
| * |
| * The function removes properties previously associated to the device |
| * firmware node with device_add_properties(). Memory allocated to the |
| * properties will also be released. |
| */ |
| void device_remove_properties(struct device *dev) |
| { |
| struct fwnode_handle *fwnode = dev_fwnode(dev); |
| |
| if (!fwnode) |
| return; |
| |
| if (is_software_node(fwnode->secondary)) { |
| fwnode_remove_software_node(fwnode->secondary); |
| set_secondary_fwnode(dev, NULL); |
| } |
| } |
| EXPORT_SYMBOL_GPL(device_remove_properties); |
| |
| /** |
| * device_add_properties - Add a collection of properties to a device object. |
| * @dev: Device to add properties to. |
| * @properties: Collection of properties to add. |
| * |
| * Associate a collection of device properties represented by @properties with |
| * @dev. The function takes a copy of @properties. |
| * |
| * WARNING: The callers should not use this function if it is known that there |
| * is no real firmware node associated with @dev! In that case the callers |
| * should create a software node and assign it to @dev directly. |
| */ |
| int device_add_properties(struct device *dev, |
| const struct property_entry *properties) |
| { |
| struct fwnode_handle *fwnode; |
| |
| fwnode = fwnode_create_software_node(properties, NULL); |
| if (IS_ERR(fwnode)) |
| return PTR_ERR(fwnode); |
| |
| set_secondary_fwnode(dev, fwnode); |
| return 0; |
| } |
| EXPORT_SYMBOL_GPL(device_add_properties); |
| |
| /** |
| * fwnode_get_name - Return the name of a node |
| * @fwnode: The firmware node |
| * |
| * Returns a pointer to the node name. |
| */ |
| const char *fwnode_get_name(const struct fwnode_handle *fwnode) |
| { |
| return fwnode_call_ptr_op(fwnode, get_name); |
| } |
| EXPORT_SYMBOL_GPL(fwnode_get_name); |
| |
| /** |
| * fwnode_get_name_prefix - Return the prefix of node for printing purposes |
| * @fwnode: The firmware node |
| * |
| * Returns the prefix of a node, intended to be printed right before the node. |
| * The prefix works also as a separator between the nodes. |
| */ |
| const char *fwnode_get_name_prefix(const struct fwnode_handle *fwnode) |
| { |
| return fwnode_call_ptr_op(fwnode, get_name_prefix); |
| } |
| |
| /** |
| * fwnode_get_parent - Return parent firwmare node |
| * @fwnode: Firmware whose parent is retrieved |
| * |
| * Return parent firmware node of the given node if possible or %NULL if no |
| * parent was available. |
| */ |
| struct fwnode_handle *fwnode_get_parent(const struct fwnode_handle *fwnode) |
| { |
| return fwnode_call_ptr_op(fwnode, get_parent); |
| } |
| EXPORT_SYMBOL_GPL(fwnode_get_parent); |
| |
| /** |
| * fwnode_get_next_parent - Iterate to the node's parent |
| * @fwnode: Firmware whose parent is retrieved |
| * |
| * This is like fwnode_get_parent() except that it drops the refcount |
| * on the passed node, making it suitable for iterating through a |
| * node's parents. |
| * |
| * Returns a node pointer with refcount incremented, use |
| * fwnode_handle_node() on it when done. |
| */ |
| struct fwnode_handle *fwnode_get_next_parent(struct fwnode_handle *fwnode) |
| { |
| struct fwnode_handle *parent = fwnode_get_parent(fwnode); |
| |
| fwnode_handle_put(fwnode); |
| |
| return parent; |
| } |
| EXPORT_SYMBOL_GPL(fwnode_get_next_parent); |
| |
| /** |
| * fwnode_count_parents - Return the number of parents a node has |
| * @fwnode: The node the parents of which are to be counted |
| * |
| * Returns the number of parents a node has. |
| */ |
| unsigned int fwnode_count_parents(const struct fwnode_handle *fwnode) |
| { |
| struct fwnode_handle *__fwnode; |
| unsigned int count; |
| |
| __fwnode = fwnode_get_parent(fwnode); |
| |
| for (count = 0; __fwnode; count++) |
| __fwnode = fwnode_get_next_parent(__fwnode); |
| |
| return count; |
| } |
| EXPORT_SYMBOL_GPL(fwnode_count_parents); |
| |
| /** |
| * fwnode_get_nth_parent - Return an nth parent of a node |
| * @fwnode: The node the parent of which is requested |
| * @depth: Distance of the parent from the node |
| * |
| * Returns the nth parent of a node. If there is no parent at the requested |
| * @depth, %NULL is returned. If @depth is 0, the functionality is equivalent to |
| * fwnode_handle_get(). For @depth == 1, it is fwnode_get_parent() and so on. |
| * |
| * The caller is responsible for calling fwnode_handle_put() for the returned |
| * node. |
| */ |
| struct fwnode_handle *fwnode_get_nth_parent(struct fwnode_handle *fwnode, |
| unsigned int depth) |
| { |
| unsigned int i; |
| |
| fwnode_handle_get(fwnode); |
| |
| for (i = 0; i < depth && fwnode; i++) |
| fwnode = fwnode_get_next_parent(fwnode); |
| |
| return fwnode; |
| } |
| EXPORT_SYMBOL_GPL(fwnode_get_nth_parent); |
| |
| /** |
| * fwnode_get_next_child_node - Return the next child node handle for a node |
| * @fwnode: Firmware node to find the next child node for. |
| * @child: Handle to one of the node's child nodes or a %NULL handle. |
| */ |
| struct fwnode_handle * |
| fwnode_get_next_child_node(const struct fwnode_handle *fwnode, |
| struct fwnode_handle *child) |
| { |
| return fwnode_call_ptr_op(fwnode, get_next_child_node, child); |
| } |
| EXPORT_SYMBOL_GPL(fwnode_get_next_child_node); |
| |
| /** |
| * fwnode_get_next_available_child_node - Return the next |
| * available child node handle for a node |
| * @fwnode: Firmware node to find the next child node for. |
| * @child: Handle to one of the node's child nodes or a %NULL handle. |
| */ |
| struct fwnode_handle * |
| fwnode_get_next_available_child_node(const struct fwnode_handle *fwnode, |
| struct fwnode_handle *child) |
| { |
| struct fwnode_handle *next_child = child; |
| |
| if (!fwnode) |
| return NULL; |
| |
| do { |
| next_child = fwnode_get_next_child_node(fwnode, next_child); |
| |
| if (!next_child || fwnode_device_is_available(next_child)) |
| break; |
| } while (next_child); |
| |
| return next_child; |
| } |
| EXPORT_SYMBOL_GPL(fwnode_get_next_available_child_node); |
| |
| /** |
| * device_get_next_child_node - Return the next child node handle for a device |
| * @dev: Device to find the next child node for. |
| * @child: Handle to one of the device's child nodes or a null handle. |
| */ |
| struct fwnode_handle *device_get_next_child_node(struct device *dev, |
| struct fwnode_handle *child) |
| { |
| struct acpi_device *adev = ACPI_COMPANION(dev); |
| struct fwnode_handle *fwnode = NULL; |
| |
| if (dev->of_node) |
| fwnode = &dev->of_node->fwnode; |
| else if (adev) |
| fwnode = acpi_fwnode_handle(adev); |
| |
| return fwnode_get_next_child_node(fwnode, child); |
| } |
| EXPORT_SYMBOL_GPL(device_get_next_child_node); |
| |
| /** |
| * fwnode_get_named_child_node - Return first matching named child node handle |
| * @fwnode: Firmware node to find the named child node for. |
| * @childname: String to match child node name against. |
| */ |
| struct fwnode_handle * |
| fwnode_get_named_child_node(const struct fwnode_handle *fwnode, |
| const char *childname) |
| { |
| return fwnode_call_ptr_op(fwnode, get_named_child_node, childname); |
| } |
| EXPORT_SYMBOL_GPL(fwnode_get_named_child_node); |
| |
| /** |
| * device_get_named_child_node - Return first matching named child node handle |
| * @dev: Device to find the named child node for. |
| * @childname: String to match child node name against. |
| */ |
| struct fwnode_handle *device_get_named_child_node(struct device *dev, |
| const char *childname) |
| { |
| return fwnode_get_named_child_node(dev_fwnode(dev), childname); |
| } |
| EXPORT_SYMBOL_GPL(device_get_named_child_node); |
| |
| /** |
| * fwnode_handle_get - Obtain a reference to a device node |
| * @fwnode: Pointer to the device node to obtain the reference to. |
| * |
| * Returns the fwnode handle. |
| */ |
| struct fwnode_handle *fwnode_handle_get(struct fwnode_handle *fwnode) |
| { |
| if (!fwnode_has_op(fwnode, get)) |
| return fwnode; |
| |
| return fwnode_call_ptr_op(fwnode, get); |
| } |
| EXPORT_SYMBOL_GPL(fwnode_handle_get); |
| |
| /** |
| * fwnode_handle_put - Drop reference to a device node |
| * @fwnode: Pointer to the device node to drop the reference to. |
| * |
| * This has to be used when terminating device_for_each_child_node() iteration |
| * with break or return to prevent stale device node references from being left |
| * behind. |
| */ |
| void fwnode_handle_put(struct fwnode_handle *fwnode) |
| { |
| fwnode_call_void_op(fwnode, put); |
| } |
| EXPORT_SYMBOL_GPL(fwnode_handle_put); |
| |
| /** |
| * fwnode_device_is_available - check if a device is available for use |
| * @fwnode: Pointer to the fwnode of the device. |
| */ |
| bool fwnode_device_is_available(const struct fwnode_handle *fwnode) |
| { |
| return fwnode_call_bool_op(fwnode, device_is_available); |
| } |
| EXPORT_SYMBOL_GPL(fwnode_device_is_available); |
| |
| /** |
| * device_get_child_node_count - return the number of child nodes for device |
| * @dev: Device to cound the child nodes for |
| */ |
| unsigned int device_get_child_node_count(struct device *dev) |
| { |
| struct fwnode_handle *child; |
| unsigned int count = 0; |
| |
| device_for_each_child_node(dev, child) |
| count++; |
| |
| return count; |
| } |
| EXPORT_SYMBOL_GPL(device_get_child_node_count); |
| |
| bool device_dma_supported(struct device *dev) |
| { |
| /* For DT, this is always supported. |
| * For ACPI, this depends on CCA, which |
| * is determined by the acpi_dma_supported(). |
| */ |
| if (IS_ENABLED(CONFIG_OF) && dev->of_node) |
| return true; |
| |
| return acpi_dma_supported(ACPI_COMPANION(dev)); |
| } |
| EXPORT_SYMBOL_GPL(device_dma_supported); |
| |
| enum dev_dma_attr device_get_dma_attr(struct device *dev) |
| { |
| enum dev_dma_attr attr = DEV_DMA_NOT_SUPPORTED; |
| |
| if (IS_ENABLED(CONFIG_OF) && dev->of_node) { |
| if (of_dma_is_coherent(dev->of_node)) |
| attr = DEV_DMA_COHERENT; |
| else |
| attr = DEV_DMA_NON_COHERENT; |
| } else |
| attr = acpi_get_dma_attr(ACPI_COMPANION(dev)); |
| |
| return attr; |
| } |
| EXPORT_SYMBOL_GPL(device_get_dma_attr); |
| |
| /** |
| * fwnode_get_phy_mode - Get phy mode for given firmware node |
| * @fwnode: Pointer to the given node |
| * |
| * The function gets phy interface string from property 'phy-mode' or |
| * 'phy-connection-type', and return its index in phy_modes table, or errno in |
| * error case. |
| */ |
| int fwnode_get_phy_mode(struct fwnode_handle *fwnode) |
| { |
| const char *pm; |
| int err, i; |
| |
| err = fwnode_property_read_string(fwnode, "phy-mode", &pm); |
| if (err < 0) |
| err = fwnode_property_read_string(fwnode, |
| "phy-connection-type", &pm); |
| if (err < 0) |
| return err; |
| |
| for (i = 0; i < PHY_INTERFACE_MODE_MAX; i++) |
| if (!strcasecmp(pm, phy_modes(i))) |
| return i; |
| |
| return -ENODEV; |
| } |
| EXPORT_SYMBOL_GPL(fwnode_get_phy_mode); |
| |
| /** |
| * device_get_phy_mode - Get phy mode for given device |
| * @dev: Pointer to the given device |
| * |
| * The function gets phy interface string from property 'phy-mode' or |
| * 'phy-connection-type', and return its index in phy_modes table, or errno in |
| * error case. |
| */ |
| int device_get_phy_mode(struct device *dev) |
| { |
| return fwnode_get_phy_mode(dev_fwnode(dev)); |
| } |
| EXPORT_SYMBOL_GPL(device_get_phy_mode); |
| |
| static void *fwnode_get_mac_addr(struct fwnode_handle *fwnode, |
| const char *name, char *addr, |
| int alen) |
| { |
| int ret = fwnode_property_read_u8_array(fwnode, name, addr, alen); |
| |
| if (ret == 0 && alen == ETH_ALEN && is_valid_ether_addr(addr)) |
| return addr; |
| return NULL; |
| } |
| |
| /** |
| * fwnode_get_mac_address - Get the MAC from the firmware node |
| * @fwnode: Pointer to the firmware node |
| * @addr: Address of buffer to store the MAC in |
| * @alen: Length of the buffer pointed to by addr, should be ETH_ALEN |
| * |
| * Search the firmware node for the best MAC address to use. 'mac-address' is |
| * checked first, because that is supposed to contain to "most recent" MAC |
| * address. If that isn't set, then 'local-mac-address' is checked next, |
| * because that is the default address. If that isn't set, then the obsolete |
| * 'address' is checked, just in case we're using an old device tree. |
| * |
| * Note that the 'address' property is supposed to contain a virtual address of |
| * the register set, but some DTS files have redefined that property to be the |
| * MAC address. |
| * |
| * All-zero MAC addresses are rejected, because those could be properties that |
| * exist in the firmware tables, but were not updated by the firmware. For |
| * example, the DTS could define 'mac-address' and 'local-mac-address', with |
| * zero MAC addresses. Some older U-Boots only initialized 'local-mac-address'. |
| * In this case, the real MAC is in 'local-mac-address', and 'mac-address' |
| * exists but is all zeros. |
| */ |
| void *fwnode_get_mac_address(struct fwnode_handle *fwnode, char *addr, int alen) |
| { |
| char *res; |
| |
| res = fwnode_get_mac_addr(fwnode, "mac-address", addr, alen); |
| if (res) |
| return res; |
| |
| res = fwnode_get_mac_addr(fwnode, "local-mac-address", addr, alen); |
| if (res) |
| return res; |
| |
| return fwnode_get_mac_addr(fwnode, "address", addr, alen); |
| } |
| EXPORT_SYMBOL(fwnode_get_mac_address); |
| |
| /** |
| * device_get_mac_address - Get the MAC for a given device |
| * @dev: Pointer to the device |
| * @addr: Address of buffer to store the MAC in |
| * @alen: Length of the buffer pointed to by addr, should be ETH_ALEN |
| */ |
| void *device_get_mac_address(struct device *dev, char *addr, int alen) |
| { |
| return fwnode_get_mac_address(dev_fwnode(dev), addr, alen); |
| } |
| EXPORT_SYMBOL(device_get_mac_address); |
| |
| /** |
| * fwnode_irq_get - Get IRQ directly from a fwnode |
| * @fwnode: Pointer to the firmware node |
| * @index: Zero-based index of the IRQ |
| * |
| * Returns Linux IRQ number on success. Other values are determined |
| * accordingly to acpi_/of_ irq_get() operation. |
| */ |
| int fwnode_irq_get(struct fwnode_handle *fwnode, unsigned int index) |
| { |
| struct device_node *of_node = to_of_node(fwnode); |
| struct resource res; |
| int ret; |
| |
| if (IS_ENABLED(CONFIG_OF) && of_node) |
| return of_irq_get(of_node, index); |
| |
| ret = acpi_irq_get(ACPI_HANDLE_FWNODE(fwnode), index, &res); |
| if (ret) |
| return ret; |
| |
| return res.start; |
| } |
| EXPORT_SYMBOL(fwnode_irq_get); |
| |
| /** |
| * fwnode_graph_get_next_endpoint - Get next endpoint firmware node |
| * @fwnode: Pointer to the parent firmware node |
| * @prev: Previous endpoint node or %NULL to get the first |
| * |
| * Returns an endpoint firmware node pointer or %NULL if no more endpoints |
| * are available. |
| */ |
| struct fwnode_handle * |
| fwnode_graph_get_next_endpoint(const struct fwnode_handle *fwnode, |
| struct fwnode_handle *prev) |
| { |
| return fwnode_call_ptr_op(fwnode, graph_get_next_endpoint, prev); |
| } |
| EXPORT_SYMBOL_GPL(fwnode_graph_get_next_endpoint); |
| |
| /** |
| * fwnode_graph_get_port_parent - Return the device fwnode of a port endpoint |
| * @endpoint: Endpoint firmware node of the port |
| * |
| * Return: the firmware node of the device the @endpoint belongs to. |
| */ |
| struct fwnode_handle * |
| fwnode_graph_get_port_parent(const struct fwnode_handle *endpoint) |
| { |
| struct fwnode_handle *port, *parent; |
| |
| port = fwnode_get_parent(endpoint); |
| parent = fwnode_call_ptr_op(port, graph_get_port_parent); |
| |
| fwnode_handle_put(port); |
| |
| return parent; |
| } |
| EXPORT_SYMBOL_GPL(fwnode_graph_get_port_parent); |
| |
| /** |
| * fwnode_graph_get_remote_port_parent - Return fwnode of a remote device |
| * @fwnode: Endpoint firmware node pointing to the remote endpoint |
| * |
| * Extracts firmware node of a remote device the @fwnode points to. |
| */ |
| struct fwnode_handle * |
| fwnode_graph_get_remote_port_parent(const struct fwnode_handle *fwnode) |
| { |
| struct fwnode_handle *endpoint, *parent; |
| |
| endpoint = fwnode_graph_get_remote_endpoint(fwnode); |
| parent = fwnode_graph_get_port_parent(endpoint); |
| |
| fwnode_handle_put(endpoint); |
| |
| return parent; |
| } |
| EXPORT_SYMBOL_GPL(fwnode_graph_get_remote_port_parent); |
| |
| /** |
| * fwnode_graph_get_remote_port - Return fwnode of a remote port |
| * @fwnode: Endpoint firmware node pointing to the remote endpoint |
| * |
| * Extracts firmware node of a remote port the @fwnode points to. |
| */ |
| struct fwnode_handle * |
| fwnode_graph_get_remote_port(const struct fwnode_handle *fwnode) |
| { |
| return fwnode_get_next_parent(fwnode_graph_get_remote_endpoint(fwnode)); |
| } |
| EXPORT_SYMBOL_GPL(fwnode_graph_get_remote_port); |
| |
| /** |
| * fwnode_graph_get_remote_endpoint - Return fwnode of a remote endpoint |
| * @fwnode: Endpoint firmware node pointing to the remote endpoint |
| * |
| * Extracts firmware node of a remote endpoint the @fwnode points to. |
| */ |
| struct fwnode_handle * |
| fwnode_graph_get_remote_endpoint(const struct fwnode_handle *fwnode) |
| { |
| return fwnode_call_ptr_op(fwnode, graph_get_remote_endpoint); |
| } |
| EXPORT_SYMBOL_GPL(fwnode_graph_get_remote_endpoint); |
| |
| /** |
| * fwnode_graph_get_remote_node - get remote parent node for given port/endpoint |
| * @fwnode: pointer to parent fwnode_handle containing graph port/endpoint |
| * @port_id: identifier of the parent port node |
| * @endpoint_id: identifier of the endpoint node |
| * |
| * Return: Remote fwnode handle associated with remote endpoint node linked |
| * to @node. Use fwnode_node_put() on it when done. |
| */ |
| struct fwnode_handle * |
| fwnode_graph_get_remote_node(const struct fwnode_handle *fwnode, u32 port_id, |
| u32 endpoint_id) |
| { |
| struct fwnode_handle *endpoint = NULL; |
| |
| while ((endpoint = fwnode_graph_get_next_endpoint(fwnode, endpoint))) { |
| struct fwnode_endpoint fwnode_ep; |
| struct fwnode_handle *remote; |
| int ret; |
| |
| ret = fwnode_graph_parse_endpoint(endpoint, &fwnode_ep); |
| if (ret < 0) |
| continue; |
| |
| if (fwnode_ep.port != port_id || fwnode_ep.id != endpoint_id) |
| continue; |
| |
| remote = fwnode_graph_get_remote_port_parent(endpoint); |
| if (!remote) |
| return NULL; |
| |
| return fwnode_device_is_available(remote) ? remote : NULL; |
| } |
| |
| return NULL; |
| } |
| EXPORT_SYMBOL_GPL(fwnode_graph_get_remote_node); |
| |
| /** |
| * fwnode_graph_get_endpoint_by_id - get endpoint by port and endpoint numbers |
| * @fwnode: parent fwnode_handle containing the graph |
| * @port: identifier of the port node |
| * @endpoint: identifier of the endpoint node under the port node |
| * @flags: fwnode lookup flags |
| * |
| * Return the fwnode handle of the local endpoint corresponding the port and |
| * endpoint IDs or NULL if not found. |
| * |
| * If FWNODE_GRAPH_ENDPOINT_NEXT is passed in @flags and the specified endpoint |
| * has not been found, look for the closest endpoint ID greater than the |
| * specified one and return the endpoint that corresponds to it, if present. |
| * |
| * Do not return endpoints that belong to disabled devices, unless |
| * FWNODE_GRAPH_DEVICE_DISABLED is passed in @flags. |
| * |
| * The returned endpoint needs to be released by calling fwnode_handle_put() on |
| * it when it is not needed any more. |
| */ |
| struct fwnode_handle * |
| fwnode_graph_get_endpoint_by_id(const struct fwnode_handle *fwnode, |
| u32 port, u32 endpoint, unsigned long flags) |
| { |
| struct fwnode_handle *ep = NULL, *best_ep = NULL; |
| unsigned int best_ep_id = 0; |
| bool endpoint_next = flags & FWNODE_GRAPH_ENDPOINT_NEXT; |
| bool enabled_only = !(flags & FWNODE_GRAPH_DEVICE_DISABLED); |
| |
| while ((ep = fwnode_graph_get_next_endpoint(fwnode, ep))) { |
| struct fwnode_endpoint fwnode_ep = { 0 }; |
| int ret; |
| |
| if (enabled_only) { |
| struct fwnode_handle *dev_node; |
| bool available; |
| |
| dev_node = fwnode_graph_get_remote_port_parent(ep); |
| available = fwnode_device_is_available(dev_node); |
| fwnode_handle_put(dev_node); |
| if (!available) |
| continue; |
| } |
| |
| ret = fwnode_graph_parse_endpoint(ep, &fwnode_ep); |
| if (ret < 0) |
| continue; |
| |
| if (fwnode_ep.port != port) |
| continue; |
| |
| if (fwnode_ep.id == endpoint) |
| return ep; |
| |
| if (!endpoint_next) |
| continue; |
| |
| /* |
| * If the endpoint that has just been found is not the first |
| * matching one and the ID of the one found previously is closer |
| * to the requested endpoint ID, skip it. |
| */ |
| if (fwnode_ep.id < endpoint || |
| (best_ep && best_ep_id < fwnode_ep.id)) |
| continue; |
| |
| fwnode_handle_put(best_ep); |
| best_ep = fwnode_handle_get(ep); |
| best_ep_id = fwnode_ep.id; |
| } |
| |
| return best_ep; |
| } |
| EXPORT_SYMBOL_GPL(fwnode_graph_get_endpoint_by_id); |
| |
| /** |
| * fwnode_graph_parse_endpoint - parse common endpoint node properties |
| * @fwnode: pointer to endpoint fwnode_handle |
| * @endpoint: pointer to the fwnode endpoint data structure |
| * |
| * Parse @fwnode representing a graph endpoint node and store the |
| * information in @endpoint. The caller must hold a reference to |
| * @fwnode. |
| */ |
| int fwnode_graph_parse_endpoint(const struct fwnode_handle *fwnode, |
| struct fwnode_endpoint *endpoint) |
| { |
| memset(endpoint, 0, sizeof(*endpoint)); |
| |
| return fwnode_call_int_op(fwnode, graph_parse_endpoint, endpoint); |
| } |
| EXPORT_SYMBOL(fwnode_graph_parse_endpoint); |
| |
| const void *device_get_match_data(struct device *dev) |
| { |
| return fwnode_call_ptr_op(dev_fwnode(dev), device_get_match_data, dev); |
| } |
| EXPORT_SYMBOL_GPL(device_get_match_data); |
| |
| /** |
| * fwnode_is_compatible - Check does fwnode have the given compatible string |
| * @fwnode: fwnode with the "compatible" property |
| * @compat: The compatible string |
| * |
| * Match the compatible strings of @fwnode against @compat. |
| * |
| * Returns positive value on match, and 0 when no matching compatible |
| * string is found. |
| */ |
| int fwnode_is_compatible(struct fwnode_handle *fwnode, const char *compat) |
| { |
| int ret; |
| |
| if (is_of_node(fwnode)) |
| return of_device_is_compatible(to_of_node(fwnode), compat); |
| |
| ret = fwnode_property_match_string(fwnode, "compatible", compat); |
| |
| return ret < 0 ? 0 : 1; |
| } |
| EXPORT_SYMBOL_GPL(fwnode_is_compatible); |
| |
| /** |
| * device_is_compatible - Check does a device have the given compatible string |
| * @dev: Device with the "compatible" property |
| * @compat: The compatible string |
| * |
| * Match the compatible strings of @dev against @compat. |
| * |
| * Returns positive value on match, and 0 when no matching compatible |
| * string is found. |
| */ |
| int device_is_compatible(struct device *dev, const char *compat) |
| { |
| return fwnode_is_compatible(dev_fwnode(dev), compat); |
| } |
| EXPORT_SYMBOL_GPL(device_is_compatible); |