12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313 |
- // 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_get_next_parent_dev - Find device of closest ancestor fwnode
- * @fwnode: firmware node
- *
- * Given a firmware node (@fwnode), this function finds its closest ancestor
- * firmware node that has a corresponding struct device and returns that struct
- * device.
- *
- * The caller of this function is expected to call put_device() on the returned
- * device when they are done.
- */
- struct device *fwnode_get_next_parent_dev(struct fwnode_handle *fwnode)
- {
- struct device *dev = NULL;
- fwnode_handle_get(fwnode);
- do {
- fwnode = fwnode_get_next_parent(fwnode);
- if (fwnode)
- dev = get_dev_from_fwnode(fwnode);
- } while (fwnode && !dev);
- fwnode_handle_put(fwnode);
- return dev;
- }
- /**
- * 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_is_ancestor_of - Test if @test_ancestor is ancestor of @test_child
- * @test_ancestor: Firmware which is tested for being an ancestor
- * @test_child: Firmware which is tested for being the child
- *
- * A node is considered an ancestor of itself too.
- *
- * Returns true if @test_ancestor is an ancestor of @test_child.
- * Otherwise, returns false.
- */
- bool fwnode_is_ancestor_of(struct fwnode_handle *test_ancestor,
- struct fwnode_handle *test_child)
- {
- if (!test_ancestor)
- return false;
- fwnode_handle_get(test_child);
- while (test_child) {
- if (test_child == test_ancestor) {
- fwnode_handle_put(test_child);
- return true;
- }
- test_child = fwnode_get_next_parent(test_child);
- }
- return false;
- }
- /**
- * 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, *next;
- if (dev->of_node)
- fwnode = &dev->of_node->fwnode;
- else if (adev)
- fwnode = acpi_fwnode_handle(adev);
- /* Try to find a child in primary fwnode */
- next = fwnode_get_next_child_node(fwnode, child);
- if (next)
- return next;
- /* When no more children in primary, continue with secondary */
- if (fwnode && !IS_ERR_OR_NULL(fwnode->secondary))
- next = fwnode_get_next_child_node(fwnode->secondary, child);
- return next;
- }
- 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);
- static void *
- fwnode_graph_devcon_match(struct fwnode_handle *fwnode, const char *con_id,
- void *data, devcon_match_fn_t match)
- {
- struct fwnode_handle *node;
- struct fwnode_handle *ep;
- void *ret;
- fwnode_graph_for_each_endpoint(fwnode, ep) {
- node = fwnode_graph_get_remote_port_parent(ep);
- if (!fwnode_device_is_available(node)) {
- fwnode_handle_put(node);
- continue;
- }
- ret = match(node, con_id, data);
- fwnode_handle_put(node);
- if (ret) {
- fwnode_handle_put(ep);
- return ret;
- }
- }
- return NULL;
- }
- static void *
- fwnode_devcon_match(struct fwnode_handle *fwnode, const char *con_id,
- void *data, devcon_match_fn_t match)
- {
- struct fwnode_handle *node;
- void *ret;
- int i;
- for (i = 0; ; i++) {
- node = fwnode_find_reference(fwnode, con_id, i);
- if (IS_ERR(node))
- break;
- ret = match(node, NULL, data);
- fwnode_handle_put(node);
- if (ret)
- return ret;
- }
- return NULL;
- }
- /**
- * fwnode_connection_find_match - Find connection from a device node
- * @fwnode: Device node with the connection
- * @con_id: Identifier for the connection
- * @data: Data for the match function
- * @match: Function to check and convert the connection description
- *
- * Find a connection with unique identifier @con_id between @fwnode and another
- * device node. @match will be used to convert the connection description to
- * data the caller is expecting to be returned.
- */
- void *fwnode_connection_find_match(struct fwnode_handle *fwnode,
- const char *con_id, void *data,
- devcon_match_fn_t match)
- {
- void *ret;
- if (!fwnode || !match)
- return NULL;
- ret = fwnode_graph_devcon_match(fwnode, con_id, data, match);
- if (ret)
- return ret;
- return fwnode_devcon_match(fwnode, con_id, data, match);
- }
- EXPORT_SYMBOL_GPL(fwnode_connection_find_match);
|