drivers/of/property.c

3  * drivers/of/property.c - Procedures for accessing and interpreting
7  * file contains the OF property as well as the OF graph interface
35  * of_property_read_bool - Find a property
36  * @np:		device node from which the property value is to be read.
37  * @propname:	name of the property to be searched.
39  * Search for a boolean property in a device node. Usage on non-boolean
40  * property types is deprecated.
42  * Return: true if the property exists false otherwise.
46 	struct property *prop = of_find_property(np, propname, NULL);  in of_property_read_bool()
49 	 * Boolean properties should not have a value. Testing for property  in of_property_read_bool()
51 	 * property value and check the returned error code.  in of_property_read_bool()
54 		pr_warn("%pOF: Read of boolean property '%s' with a value.\n", np, propname);  in of_property_read_bool()
81  * of_property_count_elems_of_size - Count the number of elements in a property
83  * @np:		device node from which the property value is to be read.
84  * @propname:	name of the property to be searched.
87  * Search for a property in a device node and count the number of elements of
90  * Return: The number of elements on sucess, -EINVAL if the property does not
92  * the property does not have a value.
97 	const struct property *prop = of_find_property(np, propname, NULL);  in of_property_count_elems_of_size()
117  * @np:		device node from which the property value is to be read.
118  * @propname:	name of the property to be searched.
119  * @min:	minimum allowed length of property value
120  * @max:	maximum allowed length of property value (0 means unlimited)
123  * Search for a property in a device node and valid the requested size.
125  * Return: The property value on success, -EINVAL if the property does not
126  * exist, -ENODATA if property does not have a value, and -EOVERFLOW if the
127  * property data is too small or too large.
133 	const struct property *prop = of_find_property(np, propname, NULL);  in of_find_property_value_of_size()
151  * of_property_read_u16_index - Find and read a u16 from a multi-value property.
153  * @np:		device node from which the property value is to be read.
154  * @propname:	name of the property to be searched.
158  * Search for a property in a device node and read nth 16-bit value from
161  * Return: 0 on success, -EINVAL if the property does not exist,
162  * -ENODATA if property does not have a value, and -EOVERFLOW if the
163  * property data isn't large enough.
184  * of_property_read_u32_index - Find and read a u32 from a multi-value property.
186  * @np:		device node from which the property value is to be read.
187  * @propname:	name of the property to be searched.
191  * Search for a property in a device node and read nth 32-bit value from
194  * Return: 0 on success, -EINVAL if the property does not exist,
195  * -ENODATA if property does not have a value, and -EOVERFLOW if the
196  * property data isn't large enough.
218  * of_property_read_u64_index - Find and read a u64 from a multi-value property.
220  * @np:		device node from which the property value is to be read.
221  * @propname:	name of the property to be searched.
225  * Search for a property in a device node and read nth 64-bit value from
228  * Return: 0 on success, -EINVAL if the property does not exist,
229  * -ENODATA if property does not have a value, and -EOVERFLOW if the
230  * property data isn't large enough.
252  * property, with bounds on the minimum and maximum array size.
254  * @np:		device node from which the property value is to be read.
255  * @propname:	name of the property to be searched.
262  * Search for a property in a device node and read 8-bit value(s) from
266  *  ``property = /bits/ 8 <0x50 0x60 0x70>;``
268  * Return: The number of elements read on success, -EINVAL if the property
269  * does not exist, -ENODATA if property does not have a value, and -EOVERFLOW
270  * if the property data is smaller than sz_min or longer than sz_max.
302  * property, with bounds on the minimum and maximum array size.
304  * @np:		device node from which the property value is to be read.
305  * @propname:	name of the property to be searched.
312  * Search for a property in a device node and read 16-bit value(s) from
316  *  ``property = /bits/ 16 <0x5000 0x6000 0x7000>;``
318  * Return: The number of elements read on success, -EINVAL if the property
319  * does not exist, -ENODATA if property does not have a value, and -EOVERFLOW
320  * if the property data is smaller than sz_min or longer than sz_max.
352  * integers from a property, with bounds on the minimum and maximum array size.
354  * @np:		device node from which the property value is to be read.
355  * @propname:	name of the property to be searched.
362  * Search for a property in a device node and read 32-bit value(s) from
365  * Return: The number of elements read on success, -EINVAL if the property
366  * does not exist, -ENODATA if property does not have a value, and -EOVERFLOW
367  * if the property data is smaller than sz_min or longer than sz_max.
398  * of_property_read_u64 - Find and read a 64 bit integer from a property
399  * @np:		device node from which the property value is to be read.
400  * @propname:	name of the property to be searched.
403  * Search for a property in a device node and read a 64-bit value from
406  * Return: 0 on success, -EINVAL if the property does not exist,
407  * -ENODATA if property does not have a value, and -EOVERFLOW if the
408  * property data isn't large enough.
430  * integers from a property, with bounds on the minimum and maximum array size.
432  * @np:		device node from which the property value is to be read.
433  * @propname:	name of the property to be searched.
440  * Search for a property in a device node and read 64-bit value(s) from
443  * Return: The number of elements read on success, -EINVAL if the property
444  * does not exist, -ENODATA if property does not have a value, and -EOVERFLOW
445  * if the property data is smaller than sz_min or longer than sz_max.
478  * of_property_read_string - Find and read a string from a property
479  * @np:		device node from which the property value is to be read.
480  * @propname:	name of the property to be searched.
484  * Search for a property in a device tree node and retrieve a null
487  * Return: 0 on success, -EINVAL if the property does not exist, -ENODATA if
488  * property does not have a value, and -EILSEQ if the string is not
489  * null-terminated within the length of the property data.
499 	const struct property *prop = of_find_property(np, propname, NULL);  in of_property_read_string()
514  * @np: pointer to the node containing the string list property
515  * @propname: string list property name
518  * Search for an exact match of string in a device node property which is a
522  * if the property does not exist, -ENODATA if the property does not have a
524  * the property data.
529 	const struct property *prop = of_find_property(np, propname, NULL);  in of_property_match_string()
556  * @np:		device node from which the property value is to be read.
557  * @propname:	name of the property to be searched.
569 	const struct property *prop = of_find_property(np, propname, NULL);  in of_property_read_string_helper()
592 const __be32 *of_prop_next_u32(const struct property *prop, const __be32 *cur,  in of_prop_next_u32()
615 const char *of_prop_next_string(const struct property *prop, const char *cur)  in of_prop_next_string()
816  * @port_reg: identifier (value of reg property) of the parent port node
817  * @reg: identifier (value of reg property) of the endpoint node
961  * @port: identifier (value of reg property) of the parent port node
962  * @endpoint: identifier (value of reg property) of the endpoint node
1222  * parse_prop_cells - Property parsing function for suppliers
1225  * @prop_name:	Name of property to be parsed. Expected to hold phandle values
1228  * @list_name:	Property name that is known to contain list of phandle(s) to
1230  * @cells_name:	property name that specifies phandles' arguments count
1276  * parse_suffix_prop_cells - Suffix property parsing function for suppliers
1279  * @prop_name:	Name of property to be parsed. Expected to hold phandle values
1282  * @suffix:	Property suffix that is known to contain list of phandle(s) to
1284  * @cells_name:	property name that specifies phandles' arguments count
1319  * struct supplier_bindings - Property parsing functions for suppliers
1323  *  parse_prop.np: Pointer to device node holding supplier phandle property
1324  *  parse_prop.prop_name: Name of property holding a phandle value
1327  * @get_con_dev: If the consumer node containing the property is never converted
1332  *		  for this property.
1411 	 * Ignore node with gpio-hog property since its gpios are all provided  in parse_gpio_compat()
1542  * of_link_property - Create device links to suppliers listed in a property
1543  * @con_np: The consumer device tree node which contains the property
1544  * @prop_name: Name of property to be parsed
1546  * This function checks if the property @prop_name that is present in the
1605 	const struct property *p;  in of_fwnode_add_links()