1 // SPDX-License-Identifier: GPL-2.0-only
3 * ACPI device specific properties support.
5 * Copyright (C) 2014, Intel Corporation
13 #include <linux/acpi.h>
14 #include <linux/device.h>
15 #include <linux/export.h>
19 static int acpi_data_get_property_array(const struct acpi_device_data *data,
21 acpi_object_type type,
22 const union acpi_object **obj);
25 * The GUIDs here are made equivalent to each other in order to avoid extra
26 * complexity in the properties handling code, with the caveat that the
27 * kernel will accept certain combinations of GUID and properties that are
28 * not defined without a warning. For instance if any of the properties
29 * from different GUID appear in a property list of another, it will be
30 * accepted by the kernel. Firmware validation tools should catch these.
32 static const guid_t prp_guids[] = {
33 /* ACPI _DSD device properties GUID: daffd814-6eba-4d8c-8a91-bc9bbf4aa301 */
34 GUID_INIT(0xdaffd814, 0x6eba, 0x4d8c,
35 0x8a, 0x91, 0xbc, 0x9b, 0xbf, 0x4a, 0xa3, 0x01),
36 /* Hotplug in D3 GUID: 6211e2c0-58a3-4af3-90e1-927a4e0c55a4 */
37 GUID_INIT(0x6211e2c0, 0x58a3, 0x4af3,
38 0x90, 0xe1, 0x92, 0x7a, 0x4e, 0x0c, 0x55, 0xa4),
39 /* External facing port GUID: efcc06cc-73ac-4bc3-bff0-76143807c389 */
40 GUID_INIT(0xefcc06cc, 0x73ac, 0x4bc3,
41 0xbf, 0xf0, 0x76, 0x14, 0x38, 0x07, 0xc3, 0x89),
42 /* Thunderbolt GUID for IMR_VALID: c44d002f-69f9-4e7d-a904-a7baabdf43f7 */
43 GUID_INIT(0xc44d002f, 0x69f9, 0x4e7d,
44 0xa9, 0x04, 0xa7, 0xba, 0xab, 0xdf, 0x43, 0xf7),
45 /* Thunderbolt GUID for WAKE_SUPPORTED: 6c501103-c189-4296-ba72-9bf5a26ebe5d */
46 GUID_INIT(0x6c501103, 0xc189, 0x4296,
47 0xba, 0x72, 0x9b, 0xf5, 0xa2, 0x6e, 0xbe, 0x5d),
50 /* ACPI _DSD data subnodes GUID: dbb8e3e6-5886-4ba6-8795-1319f52a966b */
51 static const guid_t ads_guid =
52 GUID_INIT(0xdbb8e3e6, 0x5886, 0x4ba6,
53 0x87, 0x95, 0x13, 0x19, 0xf5, 0x2a, 0x96, 0x6b);
55 static bool acpi_enumerate_nondev_subnodes(acpi_handle scope,
56 const union acpi_object *desc,
57 struct acpi_device_data *data,
58 struct fwnode_handle *parent);
59 static bool acpi_extract_properties(const union acpi_object *desc,
60 struct acpi_device_data *data);
62 static bool acpi_nondev_subnode_extract(const union acpi_object *desc,
64 const union acpi_object *link,
65 struct list_head *list,
66 struct fwnode_handle *parent)
68 struct acpi_data_node *dn;
71 dn = kzalloc(sizeof(*dn), GFP_KERNEL);
75 dn->name = link->package.elements[0].string.pointer;
76 dn->fwnode.ops = &acpi_data_fwnode_ops;
78 INIT_LIST_HEAD(&dn->data.properties);
79 INIT_LIST_HEAD(&dn->data.subnodes);
81 result = acpi_extract_properties(desc, &dn->data);
88 * The scope for the subnode object lookup is the one of the
89 * namespace node (device) containing the object that has
90 * returned the package. That is, it's the scope of that
93 status = acpi_get_parent(handle, &scope);
94 if (ACPI_SUCCESS(status)
95 && acpi_enumerate_nondev_subnodes(scope, desc, &dn->data,
98 } else if (acpi_enumerate_nondev_subnodes(NULL, desc, &dn->data,
105 dn->data.pointer = desc;
106 list_add_tail(&dn->sibling, list);
111 acpi_handle_debug(handle, "Invalid properties/subnodes data, skipping\n");
115 static bool acpi_nondev_subnode_data_ok(acpi_handle handle,
116 const union acpi_object *link,
117 struct list_head *list,
118 struct fwnode_handle *parent)
120 struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER };
123 status = acpi_evaluate_object_typed(handle, NULL, NULL, &buf,
125 if (ACPI_FAILURE(status))
128 if (acpi_nondev_subnode_extract(buf.pointer, handle, link, list,
132 ACPI_FREE(buf.pointer);
136 static bool acpi_nondev_subnode_ok(acpi_handle scope,
137 const union acpi_object *link,
138 struct list_head *list,
139 struct fwnode_handle *parent)
147 status = acpi_get_handle(scope, link->package.elements[1].string.pointer,
149 if (ACPI_FAILURE(status))
152 return acpi_nondev_subnode_data_ok(handle, link, list, parent);
155 static int acpi_add_nondev_subnodes(acpi_handle scope,
156 const union acpi_object *links,
157 struct list_head *list,
158 struct fwnode_handle *parent)
163 for (i = 0; i < links->package.count; i++) {
164 const union acpi_object *link, *desc;
168 link = &links->package.elements[i];
169 /* Only two elements allowed. */
170 if (link->package.count != 2)
173 /* The first one must be a string. */
174 if (link->package.elements[0].type != ACPI_TYPE_STRING)
177 /* The second one may be a string, a reference or a package. */
178 switch (link->package.elements[1].type) {
179 case ACPI_TYPE_STRING:
180 result = acpi_nondev_subnode_ok(scope, link, list,
183 case ACPI_TYPE_LOCAL_REFERENCE:
184 handle = link->package.elements[1].reference.handle;
185 result = acpi_nondev_subnode_data_ok(handle, link, list,
188 case ACPI_TYPE_PACKAGE:
189 desc = &link->package.elements[1];
190 result = acpi_nondev_subnode_extract(desc, NULL, link,
203 static bool acpi_enumerate_nondev_subnodes(acpi_handle scope,
204 const union acpi_object *desc,
205 struct acpi_device_data *data,
206 struct fwnode_handle *parent)
210 /* Look for the ACPI data subnodes GUID. */
211 for (i = 0; i < desc->package.count; i += 2) {
212 const union acpi_object *guid, *links;
214 guid = &desc->package.elements[i];
215 links = &desc->package.elements[i + 1];
218 * The first element must be a GUID and the second one must be
221 if (guid->type != ACPI_TYPE_BUFFER ||
222 guid->buffer.length != 16 ||
223 links->type != ACPI_TYPE_PACKAGE)
226 if (!guid_equal((guid_t *)guid->buffer.pointer, &ads_guid))
229 return acpi_add_nondev_subnodes(scope, links, &data->subnodes,
236 static bool acpi_property_value_ok(const union acpi_object *value)
241 * The value must be an integer, a string, a reference, or a package
242 * whose every element must be an integer, a string, or a reference.
244 switch (value->type) {
245 case ACPI_TYPE_INTEGER:
246 case ACPI_TYPE_STRING:
247 case ACPI_TYPE_LOCAL_REFERENCE:
250 case ACPI_TYPE_PACKAGE:
251 for (j = 0; j < value->package.count; j++)
252 switch (value->package.elements[j].type) {
253 case ACPI_TYPE_INTEGER:
254 case ACPI_TYPE_STRING:
255 case ACPI_TYPE_LOCAL_REFERENCE:
267 static bool acpi_properties_format_valid(const union acpi_object *properties)
271 for (i = 0; i < properties->package.count; i++) {
272 const union acpi_object *property;
274 property = &properties->package.elements[i];
276 * Only two elements allowed, the first one must be a string and
277 * the second one has to satisfy certain conditions.
279 if (property->package.count != 2
280 || property->package.elements[0].type != ACPI_TYPE_STRING
281 || !acpi_property_value_ok(&property->package.elements[1]))
287 static void acpi_init_of_compatible(struct acpi_device *adev)
289 const union acpi_object *of_compatible;
292 ret = acpi_data_get_property_array(&adev->data, "compatible",
293 ACPI_TYPE_STRING, &of_compatible);
295 ret = acpi_dev_get_property(adev, "compatible",
296 ACPI_TYPE_STRING, &of_compatible);
299 && adev->parent->flags.of_compatible_ok)
305 adev->data.of_compatible = of_compatible;
308 adev->flags.of_compatible_ok = 1;
311 static bool acpi_is_property_guid(const guid_t *guid)
315 for (i = 0; i < ARRAY_SIZE(prp_guids); i++) {
316 if (guid_equal(guid, &prp_guids[i]))
323 struct acpi_device_properties *
324 acpi_data_add_props(struct acpi_device_data *data, const guid_t *guid,
325 const union acpi_object *properties)
327 struct acpi_device_properties *props;
329 props = kzalloc(sizeof(*props), GFP_KERNEL);
331 INIT_LIST_HEAD(&props->list);
333 props->properties = properties;
334 list_add_tail(&props->list, &data->properties);
340 static bool acpi_extract_properties(const union acpi_object *desc,
341 struct acpi_device_data *data)
345 if (desc->package.count % 2)
348 /* Look for the device properties GUID. */
349 for (i = 0; i < desc->package.count; i += 2) {
350 const union acpi_object *guid, *properties;
352 guid = &desc->package.elements[i];
353 properties = &desc->package.elements[i + 1];
356 * The first element must be a GUID and the second one must be
359 if (guid->type != ACPI_TYPE_BUFFER ||
360 guid->buffer.length != 16 ||
361 properties->type != ACPI_TYPE_PACKAGE)
364 if (!acpi_is_property_guid((guid_t *)guid->buffer.pointer))
368 * We found the matching GUID. Now validate the format of the
369 * package immediately following it.
371 if (!acpi_properties_format_valid(properties))
374 acpi_data_add_props(data, (const guid_t *)guid->buffer.pointer,
378 return !list_empty(&data->properties);
381 void acpi_init_properties(struct acpi_device *adev)
383 struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER };
384 struct acpi_hardware_id *hwid;
386 bool acpi_of = false;
388 INIT_LIST_HEAD(&adev->data.properties);
389 INIT_LIST_HEAD(&adev->data.subnodes);
395 * Check if ACPI_DT_NAMESPACE_HID is present and inthat case we fill in
396 * Device Tree compatible properties for this device.
398 list_for_each_entry(hwid, &adev->pnp.ids, list) {
399 if (!strcmp(hwid->id, ACPI_DT_NAMESPACE_HID)) {
405 status = acpi_evaluate_object_typed(adev->handle, "_DSD", NULL, &buf,
407 if (ACPI_FAILURE(status))
410 if (acpi_extract_properties(buf.pointer, &adev->data)) {
411 adev->data.pointer = buf.pointer;
413 acpi_init_of_compatible(adev);
415 if (acpi_enumerate_nondev_subnodes(adev->handle, buf.pointer,
416 &adev->data, acpi_fwnode_handle(adev)))
417 adev->data.pointer = buf.pointer;
419 if (!adev->data.pointer) {
420 acpi_handle_debug(adev->handle, "Invalid _DSD data, skipping\n");
421 ACPI_FREE(buf.pointer);
425 if (acpi_of && !adev->flags.of_compatible_ok)
426 acpi_handle_info(adev->handle,
427 ACPI_DT_NAMESPACE_HID " requires 'compatible' property\n");
429 if (!adev->data.pointer)
430 acpi_extract_apple_properties(adev);
433 static void acpi_destroy_nondev_subnodes(struct list_head *list)
435 struct acpi_data_node *dn, *next;
437 if (list_empty(list))
440 list_for_each_entry_safe_reverse(dn, next, list, sibling) {
441 acpi_destroy_nondev_subnodes(&dn->data.subnodes);
442 wait_for_completion(&dn->kobj_done);
443 list_del(&dn->sibling);
444 ACPI_FREE((void *)dn->data.pointer);
449 void acpi_free_properties(struct acpi_device *adev)
451 struct acpi_device_properties *props, *tmp;
453 acpi_destroy_nondev_subnodes(&adev->data.subnodes);
454 ACPI_FREE((void *)adev->data.pointer);
455 adev->data.of_compatible = NULL;
456 adev->data.pointer = NULL;
457 list_for_each_entry_safe(props, tmp, &adev->data.properties, list) {
458 list_del(&props->list);
464 * acpi_data_get_property - return an ACPI property with given name
465 * @data: ACPI device deta object to get the property from
466 * @name: Name of the property
467 * @type: Expected property type
468 * @obj: Location to store the property value (if not %NULL)
470 * Look up a property with @name and store a pointer to the resulting ACPI
471 * object at the location pointed to by @obj if found.
473 * Callers must not attempt to free the returned objects. These objects will be
474 * freed by the ACPI core automatically during the removal of @data.
476 * Return: %0 if property with @name has been found (success),
477 * %-EINVAL if the arguments are invalid,
478 * %-EINVAL if the property doesn't exist,
479 * %-EPROTO if the property value type doesn't match @type.
481 static int acpi_data_get_property(const struct acpi_device_data *data,
482 const char *name, acpi_object_type type,
483 const union acpi_object **obj)
485 const struct acpi_device_properties *props;
490 if (!data->pointer || list_empty(&data->properties))
493 list_for_each_entry(props, &data->properties, list) {
494 const union acpi_object *properties;
497 properties = props->properties;
498 for (i = 0; i < properties->package.count; i++) {
499 const union acpi_object *propname, *propvalue;
500 const union acpi_object *property;
502 property = &properties->package.elements[i];
504 propname = &property->package.elements[0];
505 propvalue = &property->package.elements[1];
507 if (!strcmp(name, propname->string.pointer)) {
508 if (type != ACPI_TYPE_ANY &&
509 propvalue->type != type)
522 * acpi_dev_get_property - return an ACPI property with given name.
523 * @adev: ACPI device to get the property from.
524 * @name: Name of the property.
525 * @type: Expected property type.
526 * @obj: Location to store the property value (if not %NULL).
528 int acpi_dev_get_property(const struct acpi_device *adev, const char *name,
529 acpi_object_type type, const union acpi_object **obj)
531 return adev ? acpi_data_get_property(&adev->data, name, type, obj) : -EINVAL;
533 EXPORT_SYMBOL_GPL(acpi_dev_get_property);
535 static const struct acpi_device_data *
536 acpi_device_data_of_node(const struct fwnode_handle *fwnode)
538 if (is_acpi_device_node(fwnode)) {
539 const struct acpi_device *adev = to_acpi_device_node(fwnode);
541 } else if (is_acpi_data_node(fwnode)) {
542 const struct acpi_data_node *dn = to_acpi_data_node(fwnode);
549 * acpi_node_prop_get - return an ACPI property with given name.
550 * @fwnode: Firmware node to get the property from.
551 * @propname: Name of the property.
552 * @valptr: Location to store a pointer to the property value (if not %NULL).
554 int acpi_node_prop_get(const struct fwnode_handle *fwnode,
555 const char *propname, void **valptr)
557 return acpi_data_get_property(acpi_device_data_of_node(fwnode),
558 propname, ACPI_TYPE_ANY,
559 (const union acpi_object **)valptr);
563 * acpi_data_get_property_array - return an ACPI array property with given name
564 * @adev: ACPI data object to get the property from
565 * @name: Name of the property
566 * @type: Expected type of array elements
567 * @obj: Location to store a pointer to the property value (if not NULL)
569 * Look up an array property with @name and store a pointer to the resulting
570 * ACPI object at the location pointed to by @obj if found.
572 * Callers must not attempt to free the returned objects. Those objects will be
573 * freed by the ACPI core automatically during the removal of @data.
575 * Return: %0 if array property (package) with @name has been found (success),
576 * %-EINVAL if the arguments are invalid,
577 * %-EINVAL if the property doesn't exist,
578 * %-EPROTO if the property is not a package or the type of its elements
579 * doesn't match @type.
581 static int acpi_data_get_property_array(const struct acpi_device_data *data,
583 acpi_object_type type,
584 const union acpi_object **obj)
586 const union acpi_object *prop;
589 ret = acpi_data_get_property(data, name, ACPI_TYPE_PACKAGE, &prop);
593 if (type != ACPI_TYPE_ANY) {
594 /* Check that all elements are of correct type. */
595 for (i = 0; i < prop->package.count; i++)
596 if (prop->package.elements[i].type != type)
605 static struct fwnode_handle *
606 acpi_fwnode_get_named_child_node(const struct fwnode_handle *fwnode,
607 const char *childname)
609 char name[ACPI_PATH_SEGMENT_LENGTH];
610 struct fwnode_handle *child;
611 struct acpi_buffer path;
614 path.length = sizeof(name);
617 fwnode_for_each_child_node(fwnode, child) {
618 if (is_acpi_data_node(child)) {
619 if (acpi_data_node_match(child, childname))
624 status = acpi_get_name(ACPI_HANDLE_FWNODE(child),
625 ACPI_SINGLE_NAME, &path);
626 if (ACPI_FAILURE(status))
629 if (!strncmp(name, childname, ACPI_NAMESEG_SIZE))
637 * __acpi_node_get_property_reference - returns handle to the referenced object
638 * @fwnode: Firmware node to get the property from
639 * @propname: Name of the property
640 * @index: Index of the reference to return
641 * @num_args: Maximum number of arguments after each reference
642 * @args: Location to store the returned reference with optional arguments
644 * Find property with @name, verifify that it is a package containing at least
645 * one object reference and if so, store the ACPI device object pointer to the
646 * target object in @args->adev. If the reference includes arguments, store
647 * them in the @args->args[] array.
649 * If there's more than one reference in the property value package, @index is
650 * used to select the one to return.
652 * It is possible to leave holes in the property value set like in the
665 * Calling this function with index %2 or index %3 return %-ENOENT. If the
666 * property does not contain any more values %-ENOENT is returned. The NULL
667 * entry must be single integer and preferably contain value %0.
669 * Return: %0 on success, negative error code on failure.
671 int __acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
672 const char *propname, size_t index, size_t num_args,
673 struct fwnode_reference_args *args)
675 const union acpi_object *element, *end;
676 const union acpi_object *obj;
677 const struct acpi_device_data *data;
678 struct acpi_device *device;
681 data = acpi_device_data_of_node(fwnode);
685 ret = acpi_data_get_property(data, propname, ACPI_TYPE_ANY, &obj);
687 return ret == -EINVAL ? -ENOENT : -EINVAL;
690 * The simplest case is when the value is a single reference. Just
691 * return that reference then.
693 if (obj->type == ACPI_TYPE_LOCAL_REFERENCE) {
697 ret = acpi_bus_get_device(obj->reference.handle, &device);
699 return ret == -ENODEV ? -EINVAL : ret;
701 args->fwnode = acpi_fwnode_handle(device);
707 * If it is not a single reference, then it is a package of
708 * references followed by number of ints as follows:
710 * Package () { REF, INT, REF, INT, INT }
712 * The index argument is then used to determine which reference
713 * the caller wants (along with the arguments).
715 if (obj->type != ACPI_TYPE_PACKAGE)
717 if (index >= obj->package.count)
720 element = obj->package.elements;
721 end = element + obj->package.count;
723 while (element < end) {
726 if (element->type == ACPI_TYPE_LOCAL_REFERENCE) {
727 struct fwnode_handle *ref_fwnode;
729 ret = acpi_bus_get_device(element->reference.handle,
738 * Find the referred data extension node under the
739 * referred device node.
741 for (ref_fwnode = acpi_fwnode_handle(device);
742 element < end && element->type == ACPI_TYPE_STRING;
744 ref_fwnode = acpi_fwnode_get_named_child_node(
745 ref_fwnode, element->string.pointer);
750 /* assume following integer elements are all args */
751 for (i = 0; element + i < end && i < num_args; i++) {
752 int type = element[i].type;
754 if (type == ACPI_TYPE_INTEGER)
756 else if (type == ACPI_TYPE_LOCAL_REFERENCE)
762 if (nargs > NR_FWNODE_REFERENCE_ARGS)
766 args->fwnode = ref_fwnode;
768 for (i = 0; i < nargs; i++)
769 args->args[i] = element[i].integer.value;
775 } else if (element->type == ACPI_TYPE_INTEGER) {
788 EXPORT_SYMBOL_GPL(__acpi_node_get_property_reference);
790 static int acpi_data_prop_read_single(const struct acpi_device_data *data,
791 const char *propname,
792 enum dev_prop_type proptype, void *val)
794 const union acpi_object *obj;
800 if (proptype >= DEV_PROP_U8 && proptype <= DEV_PROP_U64) {
801 ret = acpi_data_get_property(data, propname, ACPI_TYPE_INTEGER, &obj);
807 if (obj->integer.value > U8_MAX)
809 *(u8 *)val = obj->integer.value;
812 if (obj->integer.value > U16_MAX)
814 *(u16 *)val = obj->integer.value;
817 if (obj->integer.value > U32_MAX)
819 *(u32 *)val = obj->integer.value;
822 *(u64 *)val = obj->integer.value;
825 } else if (proptype == DEV_PROP_STRING) {
826 ret = acpi_data_get_property(data, propname, ACPI_TYPE_STRING, &obj);
830 *(char **)val = obj->string.pointer;
839 int acpi_dev_prop_read_single(struct acpi_device *adev, const char *propname,
840 enum dev_prop_type proptype, void *val)
847 ret = acpi_data_prop_read_single(&adev->data, propname, proptype, val);
848 if (ret < 0 || proptype != ACPI_TYPE_STRING)
853 static int acpi_copy_property_array_u8(const union acpi_object *items, u8 *val,
858 for (i = 0; i < nval; i++) {
859 if (items[i].type != ACPI_TYPE_INTEGER)
861 if (items[i].integer.value > U8_MAX)
864 val[i] = items[i].integer.value;
869 static int acpi_copy_property_array_u16(const union acpi_object *items,
870 u16 *val, size_t nval)
874 for (i = 0; i < nval; i++) {
875 if (items[i].type != ACPI_TYPE_INTEGER)
877 if (items[i].integer.value > U16_MAX)
880 val[i] = items[i].integer.value;
885 static int acpi_copy_property_array_u32(const union acpi_object *items,
886 u32 *val, size_t nval)
890 for (i = 0; i < nval; i++) {
891 if (items[i].type != ACPI_TYPE_INTEGER)
893 if (items[i].integer.value > U32_MAX)
896 val[i] = items[i].integer.value;
901 static int acpi_copy_property_array_u64(const union acpi_object *items,
902 u64 *val, size_t nval)
906 for (i = 0; i < nval; i++) {
907 if (items[i].type != ACPI_TYPE_INTEGER)
910 val[i] = items[i].integer.value;
915 static int acpi_copy_property_array_string(const union acpi_object *items,
916 char **val, size_t nval)
920 for (i = 0; i < nval; i++) {
921 if (items[i].type != ACPI_TYPE_STRING)
924 val[i] = items[i].string.pointer;
929 static int acpi_data_prop_read(const struct acpi_device_data *data,
930 const char *propname,
931 enum dev_prop_type proptype,
932 void *val, size_t nval)
934 const union acpi_object *obj;
935 const union acpi_object *items;
938 if (val && nval == 1) {
939 ret = acpi_data_prop_read_single(data, propname, proptype, val);
944 ret = acpi_data_get_property_array(data, propname, ACPI_TYPE_ANY, &obj);
949 return obj->package.count;
951 if (proptype != DEV_PROP_STRING && nval > obj->package.count)
956 items = obj->package.elements;
960 ret = acpi_copy_property_array_u8(items, (u8 *)val, nval);
963 ret = acpi_copy_property_array_u16(items, (u16 *)val, nval);
966 ret = acpi_copy_property_array_u32(items, (u32 *)val, nval);
969 ret = acpi_copy_property_array_u64(items, (u64 *)val, nval);
971 case DEV_PROP_STRING:
972 ret = acpi_copy_property_array_string(
974 min_t(u32, nval, obj->package.count));
983 int acpi_dev_prop_read(const struct acpi_device *adev, const char *propname,
984 enum dev_prop_type proptype, void *val, size_t nval)
986 return adev ? acpi_data_prop_read(&adev->data, propname, proptype, val, nval) : -EINVAL;
990 * acpi_node_prop_read - retrieve the value of an ACPI property with given name.
991 * @fwnode: Firmware node to get the property from.
992 * @propname: Name of the property.
993 * @proptype: Expected property type.
994 * @val: Location to store the property value (if not %NULL).
995 * @nval: Size of the array pointed to by @val.
997 * If @val is %NULL, return the number of array elements comprising the value
998 * of the property. Otherwise, read at most @nval values to the array at the
999 * location pointed to by @val.
1001 int acpi_node_prop_read(const struct fwnode_handle *fwnode,
1002 const char *propname, enum dev_prop_type proptype,
1003 void *val, size_t nval)
1005 return acpi_data_prop_read(acpi_device_data_of_node(fwnode),
1006 propname, proptype, val, nval);
1010 * acpi_get_next_subnode - Return the next child node handle for a fwnode
1011 * @fwnode: Firmware node to find the next child node for.
1012 * @child: Handle to one of the device's child nodes or a null handle.
1014 struct fwnode_handle *acpi_get_next_subnode(const struct fwnode_handle *fwnode,
1015 struct fwnode_handle *child)
1017 const struct acpi_device *adev = to_acpi_device_node(fwnode);
1018 const struct list_head *head;
1019 struct list_head *next;
1021 if (!child || is_acpi_device_node(child)) {
1022 struct acpi_device *child_adev;
1025 head = &adev->children;
1029 if (list_empty(head))
1033 adev = to_acpi_device_node(child);
1034 next = adev->node.next;
1039 child_adev = list_entry(next, struct acpi_device, node);
1041 child_adev = list_first_entry(head, struct acpi_device,
1044 return acpi_fwnode_handle(child_adev);
1048 if (!child || is_acpi_data_node(child)) {
1049 const struct acpi_data_node *data = to_acpi_data_node(fwnode);
1050 struct acpi_data_node *dn;
1053 * We can have a combination of device and data nodes, e.g. with
1054 * hierarchical _DSD properties. Make sure the adev pointer is
1055 * restored before going through data nodes, otherwise we will
1056 * be looking for data_nodes below the last device found instead
1057 * of the common fwnode shared by device_nodes and data_nodes.
1059 adev = to_acpi_device_node(fwnode);
1061 head = &adev->data.subnodes;
1063 head = &data->data.subnodes;
1067 if (list_empty(head))
1071 dn = to_acpi_data_node(child);
1072 next = dn->sibling.next;
1076 dn = list_entry(next, struct acpi_data_node, sibling);
1078 dn = list_first_entry(head, struct acpi_data_node, sibling);
1086 * acpi_node_get_parent - Return parent fwnode of this fwnode
1087 * @fwnode: Firmware node whose parent to get
1089 * Returns parent node of an ACPI device or data firmware node or %NULL if
1092 struct fwnode_handle *acpi_node_get_parent(const struct fwnode_handle *fwnode)
1094 if (is_acpi_data_node(fwnode)) {
1095 /* All data nodes have parent pointer so just return that */
1096 return to_acpi_data_node(fwnode)->parent;
1097 } else if (is_acpi_device_node(fwnode)) {
1098 acpi_handle handle, parent_handle;
1100 handle = to_acpi_device_node(fwnode)->handle;
1101 if (ACPI_SUCCESS(acpi_get_parent(handle, &parent_handle))) {
1102 struct acpi_device *adev;
1104 if (!acpi_bus_get_device(parent_handle, &adev))
1105 return acpi_fwnode_handle(adev);
1113 * Return true if the node is an ACPI graph node. Called on either ports
1116 static bool is_acpi_graph_node(struct fwnode_handle *fwnode,
1119 unsigned int len = strlen(str);
1122 if (!len || !is_acpi_data_node(fwnode))
1125 name = to_acpi_data_node(fwnode)->name;
1127 return (fwnode_property_present(fwnode, "reg") &&
1128 !strncmp(name, str, len) && name[len] == '@') ||
1129 fwnode_property_present(fwnode, str);
1133 * acpi_graph_get_next_endpoint - Get next endpoint ACPI firmware node
1134 * @fwnode: Pointer to the parent firmware node
1135 * @prev: Previous endpoint node or %NULL to get the first
1137 * Looks up next endpoint ACPI firmware node below a given @fwnode. Returns
1138 * %NULL if there is no next endpoint or in case of error. In case of success
1139 * the next endpoint is returned.
1141 static struct fwnode_handle *acpi_graph_get_next_endpoint(
1142 const struct fwnode_handle *fwnode, struct fwnode_handle *prev)
1144 struct fwnode_handle *port = NULL;
1145 struct fwnode_handle *endpoint;
1149 port = fwnode_get_next_child_node(fwnode, port);
1151 * The names of the port nodes begin with "port@"
1152 * followed by the number of the port node and they also
1153 * have a "reg" property that also has the number of the
1154 * port node. For compatibility reasons a node is also
1155 * recognised as a port node from the "port" property.
1157 if (is_acpi_graph_node(port, "port"))
1161 port = fwnode_get_parent(prev);
1167 endpoint = fwnode_get_next_child_node(port, prev);
1169 port = fwnode_get_next_child_node(fwnode, port);
1172 if (is_acpi_graph_node(port, "port"))
1173 endpoint = fwnode_get_next_child_node(port, NULL);
1177 * The names of the endpoint nodes begin with "endpoint@" followed by
1178 * the number of the endpoint node and they also have a "reg" property
1179 * that also has the number of the endpoint node. For compatibility
1180 * reasons a node is also recognised as an endpoint node from the
1181 * "endpoint" property.
1183 if (!is_acpi_graph_node(endpoint, "endpoint"))
1190 * acpi_graph_get_child_prop_value - Return a child with a given property value
1191 * @fwnode: device fwnode
1192 * @prop_name: The name of the property to look for
1193 * @val: the desired property value
1195 * Return the port node corresponding to a given port number. Returns
1196 * the child node on success, NULL otherwise.
1198 static struct fwnode_handle *acpi_graph_get_child_prop_value(
1199 const struct fwnode_handle *fwnode, const char *prop_name,
1202 struct fwnode_handle *child;
1204 fwnode_for_each_child_node(fwnode, child) {
1207 if (fwnode_property_read_u32(child, prop_name, &nr))
1219 * acpi_graph_get_remote_endpoint - Parses and returns remote end of an endpoint
1220 * @fwnode: Endpoint firmware node pointing to a remote device
1221 * @endpoint: Firmware node of remote endpoint is filled here if not %NULL
1223 * Returns the remote endpoint corresponding to @__fwnode. NULL on error.
1225 static struct fwnode_handle *
1226 acpi_graph_get_remote_endpoint(const struct fwnode_handle *__fwnode)
1228 struct fwnode_handle *fwnode;
1229 unsigned int port_nr, endpoint_nr;
1230 struct fwnode_reference_args args;
1233 memset(&args, 0, sizeof(args));
1234 ret = acpi_node_get_property_reference(__fwnode, "remote-endpoint", 0,
1239 /* Direct endpoint reference? */
1240 if (!is_acpi_device_node(args.fwnode))
1241 return args.nargs ? NULL : args.fwnode;
1244 * Always require two arguments with the reference: port and
1247 if (args.nargs != 2)
1250 fwnode = args.fwnode;
1251 port_nr = args.args[0];
1252 endpoint_nr = args.args[1];
1254 fwnode = acpi_graph_get_child_prop_value(fwnode, "port", port_nr);
1256 return acpi_graph_get_child_prop_value(fwnode, "endpoint", endpoint_nr);
1259 static bool acpi_fwnode_device_is_available(const struct fwnode_handle *fwnode)
1261 if (!is_acpi_device_node(fwnode))
1264 return acpi_device_is_present(to_acpi_device_node(fwnode));
1267 static bool acpi_fwnode_property_present(const struct fwnode_handle *fwnode,
1268 const char *propname)
1270 return !acpi_node_prop_get(fwnode, propname, NULL);
1274 acpi_fwnode_property_read_int_array(const struct fwnode_handle *fwnode,
1275 const char *propname,
1276 unsigned int elem_size, void *val,
1279 enum dev_prop_type type;
1281 switch (elem_size) {
1286 type = DEV_PROP_U16;
1289 type = DEV_PROP_U32;
1292 type = DEV_PROP_U64;
1298 return acpi_node_prop_read(fwnode, propname, type, val, nval);
1302 acpi_fwnode_property_read_string_array(const struct fwnode_handle *fwnode,
1303 const char *propname, const char **val,
1306 return acpi_node_prop_read(fwnode, propname, DEV_PROP_STRING,
1311 acpi_fwnode_get_reference_args(const struct fwnode_handle *fwnode,
1312 const char *prop, const char *nargs_prop,
1313 unsigned int args_count, unsigned int index,
1314 struct fwnode_reference_args *args)
1316 return __acpi_node_get_property_reference(fwnode, prop, index,
1320 static const char *acpi_fwnode_get_name(const struct fwnode_handle *fwnode)
1322 const struct acpi_device *adev;
1323 struct fwnode_handle *parent;
1325 /* Is this the root node? */
1326 parent = fwnode_get_parent(fwnode);
1330 fwnode_handle_put(parent);
1332 if (is_acpi_data_node(fwnode)) {
1333 const struct acpi_data_node *dn = to_acpi_data_node(fwnode);
1338 adev = to_acpi_device_node(fwnode);
1342 return acpi_device_bid(adev);
1346 acpi_fwnode_get_name_prefix(const struct fwnode_handle *fwnode)
1348 struct fwnode_handle *parent;
1350 /* Is this the root node? */
1351 parent = fwnode_get_parent(fwnode);
1355 /* Is this 2nd node from the root? */
1356 parent = fwnode_get_next_parent(parent);
1360 fwnode_handle_put(parent);
1362 /* ACPI device or data node. */
1366 static struct fwnode_handle *
1367 acpi_fwnode_get_parent(struct fwnode_handle *fwnode)
1369 return acpi_node_get_parent(fwnode);
1372 static int acpi_fwnode_graph_parse_endpoint(const struct fwnode_handle *fwnode,
1373 struct fwnode_endpoint *endpoint)
1375 struct fwnode_handle *port_fwnode = fwnode_get_parent(fwnode);
1377 endpoint->local_fwnode = fwnode;
1379 if (fwnode_property_read_u32(port_fwnode, "reg", &endpoint->port))
1380 fwnode_property_read_u32(port_fwnode, "port", &endpoint->port);
1381 if (fwnode_property_read_u32(fwnode, "reg", &endpoint->id))
1382 fwnode_property_read_u32(fwnode, "endpoint", &endpoint->id);
1388 acpi_fwnode_device_get_match_data(const struct fwnode_handle *fwnode,
1389 const struct device *dev)
1391 return acpi_device_get_match_data(dev);
1394 #define DECLARE_ACPI_FWNODE_OPS(ops) \
1395 const struct fwnode_operations ops = { \
1396 .device_is_available = acpi_fwnode_device_is_available, \
1397 .device_get_match_data = acpi_fwnode_device_get_match_data, \
1398 .property_present = acpi_fwnode_property_present, \
1399 .property_read_int_array = \
1400 acpi_fwnode_property_read_int_array, \
1401 .property_read_string_array = \
1402 acpi_fwnode_property_read_string_array, \
1403 .get_parent = acpi_node_get_parent, \
1404 .get_next_child_node = acpi_get_next_subnode, \
1405 .get_named_child_node = acpi_fwnode_get_named_child_node, \
1406 .get_name = acpi_fwnode_get_name, \
1407 .get_name_prefix = acpi_fwnode_get_name_prefix, \
1408 .get_reference_args = acpi_fwnode_get_reference_args, \
1409 .graph_get_next_endpoint = \
1410 acpi_graph_get_next_endpoint, \
1411 .graph_get_remote_endpoint = \
1412 acpi_graph_get_remote_endpoint, \
1413 .graph_get_port_parent = acpi_fwnode_get_parent, \
1414 .graph_parse_endpoint = acpi_fwnode_graph_parse_endpoint, \
1416 EXPORT_SYMBOL_GPL(ops)
1418 DECLARE_ACPI_FWNODE_OPS(acpi_device_fwnode_ops);
1419 DECLARE_ACPI_FWNODE_OPS(acpi_data_fwnode_ops);
1420 const struct fwnode_operations acpi_static_fwnode_ops;
1422 bool is_acpi_device_node(const struct fwnode_handle *fwnode)
1424 return !IS_ERR_OR_NULL(fwnode) &&
1425 fwnode->ops == &acpi_device_fwnode_ops;
1427 EXPORT_SYMBOL(is_acpi_device_node);
1429 bool is_acpi_data_node(const struct fwnode_handle *fwnode)
1431 return !IS_ERR_OR_NULL(fwnode) && fwnode->ops == &acpi_data_fwnode_ops;
1433 EXPORT_SYMBOL(is_acpi_data_node);