Lines Matching +full:int +full:- +full:property
1 // SPDX-License-Identifier: GPL-2.0+
3 * drivers/of/property.c - Procedures for accessing and interpreting
7 * file contains the OF property as well as the OF graph interface
11 * Copyright (C) 1996-2005 Paul Mackerras.
35 * of_graph_is_present() - check graph's presence
38 * Return: True if @node has a port or ports (with a port) sub-node,
58 * of_property_count_elems_of_size - Count the number of elements in a property
60 * @np: device node from which the property value is to be read.
61 * @propname: name of the property to be searched.
64 * Search for a property in a device node and count the number of elements of
67 * Return: The number of elements on sucess, -EINVAL if the property does not
68 * exist or its length does not match a multiple of elem_size and -ENODATA if
69 * the property does not have a value.
71 int of_property_count_elems_of_size(const struct device_node *np, in of_property_count_elems_of_size()
72 const char *propname, int elem_size) in of_property_count_elems_of_size()
74 struct property *prop = of_find_property(np, propname, NULL); in of_property_count_elems_of_size()
77 return -EINVAL; in of_property_count_elems_of_size()
78 if (!prop->value) in of_property_count_elems_of_size()
79 return -ENODATA; in of_property_count_elems_of_size()
81 if (prop->length % elem_size != 0) { in of_property_count_elems_of_size()
84 return -EINVAL; in of_property_count_elems_of_size()
87 return prop->length / elem_size; in of_property_count_elems_of_size()
94 * @np: device node from which the property value is to be read.
95 * @propname: name of the property to be searched.
96 * @min: minimum allowed length of property value
97 * @max: maximum allowed length of property value (0 means unlimited)
100 * Search for a property in a device node and valid the requested size.
102 * Return: The property value on success, -EINVAL if the property does not
103 * exist, -ENODATA if property does not have a value, and -EOVERFLOW if the
104 * property data is too small or too large.
110 struct property *prop = of_find_property(np, propname, NULL); in of_find_property_value_of_size()
113 return ERR_PTR(-EINVAL); in of_find_property_value_of_size()
114 if (!prop->value) in of_find_property_value_of_size()
115 return ERR_PTR(-ENODATA); in of_find_property_value_of_size()
116 if (prop->length < min) in of_find_property_value_of_size()
117 return ERR_PTR(-EOVERFLOW); in of_find_property_value_of_size()
118 if (max && prop->length > max) in of_find_property_value_of_size()
119 return ERR_PTR(-EOVERFLOW); in of_find_property_value_of_size()
122 *len = prop->length; in of_find_property_value_of_size()
124 return prop->value; in of_find_property_value_of_size()
128 * of_property_read_u32_index - Find and read a u32 from a multi-value property.
130 * @np: device node from which the property value is to be read.
131 * @propname: name of the property to be searched.
135 * Search for a property in a device node and read nth 32-bit value from
138 * Return: 0 on success, -EINVAL if the property does not exist,
139 * -ENODATA if property does not have a value, and -EOVERFLOW if the
140 * property data isn't large enough.
144 int of_property_read_u32_index(const struct device_node *np, in of_property_read_u32_index()
162 * of_property_read_u64_index - Find and read a u64 from a multi-value property.
164 * @np: device node from which the property value is to be read.
165 * @propname: name of the property to be searched.
169 * Search for a property in a device node and read nth 64-bit value from
172 * Return: 0 on success, -EINVAL if the property does not exist,
173 * -ENODATA if property does not have a value, and -EOVERFLOW if the
174 * property data isn't large enough.
178 int of_property_read_u64_index(const struct device_node *np, in of_property_read_u64_index()
195 * of_property_read_variable_u8_array - Find and read an array of u8 from a
196 * property, with bounds on the minimum and maximum array size.
198 * @np: device node from which the property value is to be read.
199 * @propname: name of the property to be searched.
206 * Search for a property in a device node and read 8-bit value(s) from
210 * ``property = /bits/ 8 <0x50 0x60 0x70>;``
212 * Return: The number of elements read on success, -EINVAL if the property
213 * does not exist, -ENODATA if property does not have a value, and -EOVERFLOW
214 * if the property data is smaller than sz_min or longer than sz_max.
218 int of_property_read_variable_u8_array(const struct device_node *np, in of_property_read_variable_u8_array()
237 while (count--) in of_property_read_variable_u8_array()
245 * of_property_read_variable_u16_array - Find and read an array of u16 from a
246 * property, with bounds on the minimum and maximum array size.
248 * @np: device node from which the property value is to be read.
249 * @propname: name of the property to be searched.
256 * Search for a property in a device node and read 16-bit value(s) from
260 * ``property = /bits/ 16 <0x5000 0x6000 0x7000>;``
262 * Return: The number of elements read on success, -EINVAL if the property
263 * does not exist, -ENODATA if property does not have a value, and -EOVERFLOW
264 * if the property data is smaller than sz_min or longer than sz_max.
268 int of_property_read_variable_u16_array(const struct device_node *np, in of_property_read_variable_u16_array()
287 while (count--) in of_property_read_variable_u16_array()
295 * of_property_read_variable_u32_array - Find and read an array of 32 bit
296 * integers from a property, with bounds on the minimum and maximum array size.
298 * @np: device node from which the property value is to be read.
299 * @propname: name of the property to be searched.
306 * Search for a property in a device node and read 32-bit value(s) from
309 * Return: The number of elements read on success, -EINVAL if the property
310 * does not exist, -ENODATA if property does not have a value, and -EOVERFLOW
311 * if the property data is smaller than sz_min or longer than sz_max.
315 int of_property_read_variable_u32_array(const struct device_node *np, in of_property_read_variable_u32_array()
334 while (count--) in of_property_read_variable_u32_array()
342 * of_property_read_u64 - Find and read a 64 bit integer from a property
343 * @np: device node from which the property value is to be read.
344 * @propname: name of the property to be searched.
347 * Search for a property in a device node and read a 64-bit value from
350 * Return: 0 on success, -EINVAL if the property does not exist,
351 * -ENODATA if property does not have a value, and -EOVERFLOW if the
352 * property data isn't large enough.
356 int of_property_read_u64(const struct device_node *np, const char *propname, in of_property_read_u64()
373 * of_property_read_variable_u64_array - Find and read an array of 64 bit
374 * integers from a property, with bounds on the minimum and maximum array size.
376 * @np: device node from which the property value is to be read.
377 * @propname: name of the property to be searched.
384 * Search for a property in a device node and read 64-bit value(s) from
387 * Return: The number of elements read on success, -EINVAL if the property
388 * does not exist, -ENODATA if property does not have a value, and -EOVERFLOW
389 * if the property data is smaller than sz_min or longer than sz_max.
393 int of_property_read_variable_u64_array(const struct device_node *np, in of_property_read_variable_u64_array()
412 while (count--) { in of_property_read_variable_u64_array()
422 * of_property_read_string - Find and read a string from a property
423 * @np: device node from which the property value is to be read.
424 * @propname: name of the property to be searched.
428 * Search for a property in a device tree node and retrieve a null
431 * Return: 0 on success, -EINVAL if the property does not exist, -ENODATA if
432 * property does not have a value, and -EILSEQ if the string is not
433 * null-terminated within the length of the property data.
435 * Note that the empty string "" has length of 1, thus -ENODATA cannot
440 int of_property_read_string(const struct device_node *np, const char *propname, in of_property_read_string()
443 const struct property *prop = of_find_property(np, propname, NULL); in of_property_read_string()
445 return -EINVAL; in of_property_read_string()
446 if (!prop->length) in of_property_read_string()
447 return -ENODATA; in of_property_read_string()
448 if (strnlen(prop->value, prop->length) >= prop->length) in of_property_read_string()
449 return -EILSEQ; in of_property_read_string()
450 *out_string = prop->value; in of_property_read_string()
456 * of_property_match_string() - Find string in a list and return index
457 * @np: pointer to node containing string list property
458 * @propname: string list property name
461 * This function searches a string list property and returns the index
464 int of_property_match_string(const struct device_node *np, const char *propname, in of_property_match_string()
467 const struct property *prop = of_find_property(np, propname, NULL); in of_property_match_string()
469 int i; in of_property_match_string()
473 return -EINVAL; in of_property_match_string()
474 if (!prop->value) in of_property_match_string()
475 return -ENODATA; in of_property_match_string()
477 p = prop->value; in of_property_match_string()
478 end = p + prop->length; in of_property_match_string()
481 l = strnlen(p, end - p) + 1; in of_property_match_string()
483 return -EILSEQ; in of_property_match_string()
488 return -ENODATA; in of_property_match_string()
493 * of_property_read_string_helper() - Utility helper for parsing string properties
494 * @np: device node from which the property value is to be read.
495 * @propname: name of the property to be searched.
503 int of_property_read_string_helper(const struct device_node *np, in of_property_read_string_helper()
505 size_t sz, int skip) in of_property_read_string_helper()
507 const struct property *prop = of_find_property(np, propname, NULL); in of_property_read_string_helper()
508 int l = 0, i = 0; in of_property_read_string_helper()
512 return -EINVAL; in of_property_read_string_helper()
513 if (!prop->value) in of_property_read_string_helper()
514 return -ENODATA; in of_property_read_string_helper()
515 p = prop->value; in of_property_read_string_helper()
516 end = p + prop->length; in of_property_read_string_helper()
519 l = strnlen(p, end - p) + 1; in of_property_read_string_helper()
521 return -EILSEQ; in of_property_read_string_helper()
525 i -= skip; in of_property_read_string_helper()
526 return i <= 0 ? -ENODATA : i; in of_property_read_string_helper()
530 const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur, in of_prop_next_u32()
539 curv = prop->value; in of_prop_next_u32()
544 if (curv >= prop->value + prop->length) in of_prop_next_u32()
553 const char *of_prop_next_string(struct property *prop, const char *cur) in of_prop_next_string()
561 return prop->value; in of_prop_next_string()
564 if (curv >= prop->value + prop->length) in of_prop_next_string()
572 * of_graph_parse_endpoint() - parse common endpoint node properties
578 int of_graph_parse_endpoint(const struct device_node *node, in of_graph_parse_endpoint()
588 endpoint->local_node = node; in of_graph_parse_endpoint()
593 of_property_read_u32(port_node, "reg", &endpoint->port); in of_graph_parse_endpoint()
594 of_property_read_u32(node, "reg", &endpoint->id); in of_graph_parse_endpoint()
603 * of_graph_get_port_by_id() - get the port matching a given id
635 * of_graph_get_next_endpoint() - get next endpoint node
702 * of_graph_get_endpoint_by_regs() - get endpoint node of specific identifiers
704 * @port_reg: identifier (value of reg property) of the parent port node
705 * @reg: identifier (value of reg property) of the endpoint node
709 * ignored when they are -1. Use of_node_put() on the pointer when done.
712 const struct device_node *parent, int port_reg, int reg) in of_graph_get_endpoint_by_regs()
719 if (((port_reg == -1) || (endpoint.port == port_reg)) && in of_graph_get_endpoint_by_regs()
720 ((reg == -1) || (endpoint.id == reg))) in of_graph_get_endpoint_by_regs()
729 * of_graph_get_remote_endpoint() - get remote endpoint node
738 return of_parse_phandle(node, "remote-endpoint", 0); in of_graph_get_remote_endpoint()
743 * of_graph_get_port_parent() - get port's parent node
751 unsigned int depth; in of_graph_get_port_parent()
763 for (depth = 3; depth && node; depth--) { in of_graph_get_port_parent()
766 !of_node_name_eq(node, "in-ports") && in of_graph_get_port_parent()
767 !of_node_name_eq(node, "out-ports")) in of_graph_get_port_parent()
775 * of_graph_get_remote_port_parent() - get remote port's parent node
798 * of_graph_get_remote_port() - get remote port node
816 int of_graph_get_endpoint_count(const struct device_node *np) in of_graph_get_endpoint_count()
819 int num = 0; in of_graph_get_endpoint_count()
829 * of_graph_get_remote_node() - get remote parent device_node for given port/endpoint
831 * @port: identifier (value of reg property) of the parent port node
832 * @endpoint: identifier (value of reg property) of the endpoint node
901 static int of_fwnode_property_read_int_array(const struct fwnode_handle *fwnode, in of_fwnode_property_read_int_array()
903 unsigned int elem_size, void *val, in of_fwnode_property_read_int_array()
923 return -ENXIO; in of_fwnode_property_read_int_array()
926 static int
940 return kbasename(to_of_node(fwnode)->full_name); in of_fwnode_get_name()
946 if (!to_of_node(fwnode)->parent) in of_fwnode_get_name_prefix()
980 static int
983 unsigned int nargs, unsigned int index, in of_fwnode_get_reference_args()
987 unsigned int i; in of_fwnode_get_reference_args()
988 int ret; in of_fwnode_get_reference_args()
1003 args->nargs = of_args.args_count; in of_fwnode_get_reference_args()
1004 args->fwnode = of_fwnode_handle(of_args.np); in of_fwnode_get_reference_args()
1007 args->args[i] = i < of_args.args_count ? of_args.args[i] : 0; in of_fwnode_get_reference_args()
1044 static int of_fwnode_graph_parse_endpoint(const struct fwnode_handle *fwnode, in of_fwnode_graph_parse_endpoint()
1050 endpoint->local_fwnode = fwnode; in of_fwnode_graph_parse_endpoint()
1052 of_property_read_u32(port_node, "reg", &endpoint->port); in of_fwnode_graph_parse_endpoint()
1053 of_property_read_u32(node, "reg", &endpoint->id); in of_fwnode_graph_parse_endpoint()
1074 if (of_fwnode_handle(tmp_np)->dev) { in of_link_to_phandle()
1091 * parse_prop_cells - Property parsing function for suppliers
1094 * @prop_name: Name of property to be parsed. Expected to hold phandle values
1097 * @list_name: Property name that is known to contain list of phandle(s) to
1099 * @cells_name: property name that specifies phandles' arguments count
1105 * - phandle node pointer with refcount incremented. Caller must of_node_put()
1107 * - NULL if no phandle found at index
1110 const char *prop_name, int index, in parse_prop_cells()
1128 const char *prop_name, int index) \
1133 static int strcmp_suffix(const char *str, const char *suffix) in strcmp_suffix()
1135 unsigned int len, suffix_len; in strcmp_suffix()
1140 return -1; in strcmp_suffix()
1141 return strcmp(str + len - suffix_len, suffix); in strcmp_suffix()
1145 * parse_suffix_prop_cells - Suffix property parsing function for suppliers
1148 * @prop_name: Name of property to be parsed. Expected to hold phandle values
1151 * @suffix: Property suffix that is known to contain list of phandle(s) to
1153 * @cells_name: property name that specifies phandles' arguments count
1159 * - phandle node pointer with refcount incremented. Caller must of_node_put()
1161 * - NULL if no phandle found at index
1164 const char *prop_name, int index, in parse_suffix_prop_cells()
1182 const char *prop_name, int index) \
1188 * struct supplier_bindings - Property parsing functions for suppliers
1192 * @parse_prop.np: Pointer to device node holding supplier phandle property
1193 * @parse_prop.prop_name: Name of property holding a phandle value
1196 * @get_con_dev: If the consumer node containing the property is never converted
1203 * - phandle node pointer with refcount incremented. Caller must of_node_put()
1205 * - NULL if no phandle found at index
1209 const char *prop_name, int index);
1214 DEFINE_SIMPLE_PROP(clocks, "clocks", "#clock-cells")
1215 DEFINE_SIMPLE_PROP(interconnects, "interconnects", "#interconnect-cells")
1216 DEFINE_SIMPLE_PROP(iommus, "iommus", "#iommu-cells")
1217 DEFINE_SIMPLE_PROP(mboxes, "mboxes", "#mbox-cells")
1218 DEFINE_SIMPLE_PROP(io_channels, "io-channels", "#io-channel-cells")
1219 DEFINE_SIMPLE_PROP(interrupt_parent, "interrupt-parent", NULL)
1220 DEFINE_SIMPLE_PROP(dmas, "dmas", "#dma-cells")
1221 DEFINE_SIMPLE_PROP(power_domains, "power-domains", "#power-domain-cells")
1222 DEFINE_SIMPLE_PROP(hwlocks, "hwlocks", "#hwlock-cells")
1224 DEFINE_SIMPLE_PROP(nvmem_cells, "nvmem-cells", "#nvmem-cell-cells")
1225 DEFINE_SIMPLE_PROP(phys, "phys", "#phy-cells")
1226 DEFINE_SIMPLE_PROP(wakeup_parent, "wakeup-parent", NULL)
1227 DEFINE_SIMPLE_PROP(pinctrl0, "pinctrl-0", NULL)
1228 DEFINE_SIMPLE_PROP(pinctrl1, "pinctrl-1", NULL)
1229 DEFINE_SIMPLE_PROP(pinctrl2, "pinctrl-2", NULL)
1230 DEFINE_SIMPLE_PROP(pinctrl3, "pinctrl-3", NULL)
1231 DEFINE_SIMPLE_PROP(pinctrl4, "pinctrl-4", NULL)
1232 DEFINE_SIMPLE_PROP(pinctrl5, "pinctrl-5", NULL)
1233 DEFINE_SIMPLE_PROP(pinctrl6, "pinctrl-6", NULL)
1234 DEFINE_SIMPLE_PROP(pinctrl7, "pinctrl-7", NULL)
1235 DEFINE_SIMPLE_PROP(pinctrl8, "pinctrl-8", NULL)
1236 DEFINE_SIMPLE_PROP(pwms, "pwms", "#pwm-cells")
1237 DEFINE_SIMPLE_PROP(resets, "resets", "#reset-cells")
1241 DEFINE_SUFFIX_PROP(regulators, "-supply", NULL)
1242 DEFINE_SUFFIX_PROP(gpio, "-gpio", "#gpio-cells")
1245 const char *prop_name, int index) in parse_gpios()
1247 if (!strcmp_suffix(prop_name, ",nr-gpios")) in parse_gpios()
1250 return parse_suffix_prop_cells(np, prop_name, index, "-gpios", in parse_gpios()
1251 "#gpio-cells"); in parse_gpios()
1255 const char *prop_name, int index) in parse_iommu_maps()
1257 if (strcmp(prop_name, "iommu-map")) in parse_iommu_maps()
1264 const char *prop_name, int index) in parse_gpio_compat()
1272 * Ignore node with gpio-hog property since its gpios are all provided in parse_gpio_compat()
1275 if (of_property_read_bool(np, "gpio-hog")) in parse_gpio_compat()
1278 if (of_parse_phandle_with_args(np, prop_name, "#gpio-cells", index, in parse_gpio_compat()
1286 const char *prop_name, int index) in parse_interrupts()
1294 strcmp(prop_name, "interrupts-extended")) in parse_interrupts()
1302 int index) in parse_remote_endpoint()
1304 /* Return NULL for index > 0 to signify end of remote-endpoints. */ in parse_remote_endpoint()
1305 if (index > 0 || strcmp(prop_name, "remote-endpoint")) in parse_remote_endpoint()
1353 * of_link_property - Create device links to suppliers listed in a property
1354 * @con_np: The consumer device tree node which contains the property
1355 * @prop_name: Name of property to be parsed
1357 * This function checks if the property @prop_name that is present in the
1371 static int of_link_property(struct device_node *con_np, const char *prop_name) in of_link_property()
1375 unsigned int i = 0; in of_link_property()
1379 while (!matched && s->parse_prop) { in of_link_property()
1380 if (s->optional && !fw_devlink_is_strict()) { in of_link_property()
1385 while ((phandle = s->parse_prop(con_np, prop_name, i))) { in of_link_property()
1388 con_dev_np = s->get_con_dev in of_link_property()
1389 ? s->get_con_dev(con_np) in of_link_property()
1402 static void __iomem *of_fwnode_iomap(struct fwnode_handle *fwnode, int index) in of_fwnode_iomap()
1411 static int of_fwnode_irq_get(const struct fwnode_handle *fwnode, in of_fwnode_irq_get()
1412 unsigned int index) in of_fwnode_irq_get()
1417 static int of_fwnode_add_links(struct fwnode_handle *fwnode) in of_fwnode_add_links()
1419 struct property *p; in of_fwnode_add_links()
1426 return -EINVAL; in of_fwnode_add_links()
1429 of_link_property(con_np, p->name); in of_fwnode_add_links()