1 // SPDX-License-Identifier: GPL-2.0-only
3 * ACPI device specific properties support.
5 * Copyright (C) 2014, Intel Corporation
8 * Authors: Mika Westerberg <mika.westerberg@linux.intel.com>
9 * Darren Hart <dvhart@linux.intel.com>
10 * Rafael J. Wysocki <rafael.j.wysocki@intel.com>
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),
48 /* Storage device needs D3 GUID: 5025030f-842f-4ab4-a561-99a5189762d0 */
49 GUID_INIT(0x5025030f, 0x842f, 0x4ab4,
50 0xa5, 0x61, 0x99, 0xa5, 0x18, 0x97, 0x62, 0xd0),
53 /* ACPI _DSD data subnodes GUID: dbb8e3e6-5886-4ba6-8795-1319f52a966b */
54 static const guid_t ads_guid =
55 GUID_INIT(0xdbb8e3e6, 0x5886, 0x4ba6,
56 0x87, 0x95, 0x13, 0x19, 0xf5, 0x2a, 0x96, 0x6b);
58 static bool acpi_enumerate_nondev_subnodes(acpi_handle scope,
59 const union acpi_object *desc,
60 struct acpi_device_data *data,
61 struct fwnode_handle *parent);
62 static bool acpi_extract_properties(const union acpi_object *desc,
63 struct acpi_device_data *data);
65 static bool acpi_nondev_subnode_extract(const union acpi_object *desc,
67 const union acpi_object *link,
68 struct list_head *list,
69 struct fwnode_handle *parent)
71 struct acpi_data_node *dn;
74 dn = kzalloc(sizeof(*dn), GFP_KERNEL);
78 dn->name = link->package.elements[0].string.pointer;
79 dn->fwnode.ops = &acpi_data_fwnode_ops;
81 INIT_LIST_HEAD(&dn->data.properties);
82 INIT_LIST_HEAD(&dn->data.subnodes);
84 result = acpi_extract_properties(desc, &dn->data);
91 * The scope for the subnode object lookup is the one of the
92 * namespace node (device) containing the object that has
93 * returned the package. That is, it's the scope of that
96 status = acpi_get_parent(handle, &scope);
97 if (ACPI_SUCCESS(status)
98 && acpi_enumerate_nondev_subnodes(scope, desc, &dn->data,
101 } else if (acpi_enumerate_nondev_subnodes(NULL, desc, &dn->data,
108 dn->data.pointer = desc;
109 list_add_tail(&dn->sibling, list);
114 acpi_handle_debug(handle, "Invalid properties/subnodes data, skipping\n");
118 static bool acpi_nondev_subnode_data_ok(acpi_handle handle,
119 const union acpi_object *link,
120 struct list_head *list,
121 struct fwnode_handle *parent)
123 struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER };
126 status = acpi_evaluate_object_typed(handle, NULL, NULL, &buf,
128 if (ACPI_FAILURE(status))
131 if (acpi_nondev_subnode_extract(buf.pointer, handle, link, list,
135 ACPI_FREE(buf.pointer);
139 static bool acpi_nondev_subnode_ok(acpi_handle scope,
140 const union acpi_object *link,
141 struct list_head *list,
142 struct fwnode_handle *parent)
150 status = acpi_get_handle(scope, link->package.elements[1].string.pointer,
152 if (ACPI_FAILURE(status))
155 return acpi_nondev_subnode_data_ok(handle, link, list, parent);
158 static bool acpi_add_nondev_subnodes(acpi_handle scope,
159 const union acpi_object *links,
160 struct list_head *list,
161 struct fwnode_handle *parent)
166 for (i = 0; i < links->package.count; i++) {
167 const union acpi_object *link, *desc;
171 link = &links->package.elements[i];
172 /* Only two elements allowed. */
173 if (link->package.count != 2)
176 /* The first one must be a string. */
177 if (link->package.elements[0].type != ACPI_TYPE_STRING)
180 /* The second one may be a string, a reference or a package. */
181 switch (link->package.elements[1].type) {
182 case ACPI_TYPE_STRING:
183 result = acpi_nondev_subnode_ok(scope, link, list,
186 case ACPI_TYPE_LOCAL_REFERENCE:
187 handle = link->package.elements[1].reference.handle;
188 result = acpi_nondev_subnode_data_ok(handle, link, list,
191 case ACPI_TYPE_PACKAGE:
192 desc = &link->package.elements[1];
193 result = acpi_nondev_subnode_extract(desc, NULL, link,
206 static bool acpi_enumerate_nondev_subnodes(acpi_handle scope,
207 const union acpi_object *desc,
208 struct acpi_device_data *data,
209 struct fwnode_handle *parent)
213 /* Look for the ACPI data subnodes GUID. */
214 for (i = 0; i < desc->package.count; i += 2) {
215 const union acpi_object *guid, *links;
217 guid = &desc->package.elements[i];
218 links = &desc->package.elements[i + 1];
221 * The first element must be a GUID and the second one must be
224 if (guid->type != ACPI_TYPE_BUFFER ||
225 guid->buffer.length != 16 ||
226 links->type != ACPI_TYPE_PACKAGE)
229 if (!guid_equal((guid_t *)guid->buffer.pointer, &ads_guid))
232 return acpi_add_nondev_subnodes(scope, links, &data->subnodes,
239 static bool acpi_property_value_ok(const union acpi_object *value)
244 * The value must be an integer, a string, a reference, or a package
245 * whose every element must be an integer, a string, or a reference.
247 switch (value->type) {
248 case ACPI_TYPE_INTEGER:
249 case ACPI_TYPE_STRING:
250 case ACPI_TYPE_LOCAL_REFERENCE:
253 case ACPI_TYPE_PACKAGE:
254 for (j = 0; j < value->package.count; j++)
255 switch (value->package.elements[j].type) {
256 case ACPI_TYPE_INTEGER:
257 case ACPI_TYPE_STRING:
258 case ACPI_TYPE_LOCAL_REFERENCE:
270 static bool acpi_properties_format_valid(const union acpi_object *properties)
274 for (i = 0; i < properties->package.count; i++) {
275 const union acpi_object *property;
277 property = &properties->package.elements[i];
279 * Only two elements allowed, the first one must be a string and
280 * the second one has to satisfy certain conditions.
282 if (property->package.count != 2
283 || property->package.elements[0].type != ACPI_TYPE_STRING
284 || !acpi_property_value_ok(&property->package.elements[1]))
290 static void acpi_init_of_compatible(struct acpi_device *adev)
292 const union acpi_object *of_compatible;
295 ret = acpi_data_get_property_array(&adev->data, "compatible",
296 ACPI_TYPE_STRING, &of_compatible);
298 ret = acpi_dev_get_property(adev, "compatible",
299 ACPI_TYPE_STRING, &of_compatible);
302 && adev->parent->flags.of_compatible_ok)
308 adev->data.of_compatible = of_compatible;
311 adev->flags.of_compatible_ok = 1;
314 static bool acpi_is_property_guid(const guid_t *guid)
318 for (i = 0; i < ARRAY_SIZE(prp_guids); i++) {
319 if (guid_equal(guid, &prp_guids[i]))
326 struct acpi_device_properties *
327 acpi_data_add_props(struct acpi_device_data *data, const guid_t *guid,
328 const union acpi_object *properties)
330 struct acpi_device_properties *props;
332 props = kzalloc(sizeof(*props), GFP_KERNEL);
334 INIT_LIST_HEAD(&props->list);
336 props->properties = properties;
337 list_add_tail(&props->list, &data->properties);
343 static bool acpi_extract_properties(const union acpi_object *desc,
344 struct acpi_device_data *data)
348 if (desc->package.count % 2)
351 /* Look for the device properties GUID. */
352 for (i = 0; i < desc->package.count; i += 2) {
353 const union acpi_object *guid, *properties;
355 guid = &desc->package.elements[i];
356 properties = &desc->package.elements[i + 1];
359 * The first element must be a GUID and the second one must be
362 if (guid->type != ACPI_TYPE_BUFFER ||
363 guid->buffer.length != 16 ||
364 properties->type != ACPI_TYPE_PACKAGE)
367 if (!acpi_is_property_guid((guid_t *)guid->buffer.pointer))
371 * We found the matching GUID. Now validate the format of the
372 * package immediately following it.
374 if (!acpi_properties_format_valid(properties))
377 acpi_data_add_props(data, (const guid_t *)guid->buffer.pointer,
381 return !list_empty(&data->properties);
384 void acpi_init_properties(struct acpi_device *adev)
386 struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER };
387 struct acpi_hardware_id *hwid;
389 bool acpi_of = false;
391 INIT_LIST_HEAD(&adev->data.properties);
392 INIT_LIST_HEAD(&adev->data.subnodes);
398 * Check if ACPI_DT_NAMESPACE_HID is present and inthat case we fill in
399 * Device Tree compatible properties for this device.
401 list_for_each_entry(hwid, &adev->pnp.ids, list) {
402 if (!strcmp(hwid->id, ACPI_DT_NAMESPACE_HID)) {
408 status = acpi_evaluate_object_typed(adev->handle, "_DSD", NULL, &buf,
410 if (ACPI_FAILURE(status))
413 if (acpi_extract_properties(buf.pointer, &adev->data)) {
414 adev->data.pointer = buf.pointer;
416 acpi_init_of_compatible(adev);
418 if (acpi_enumerate_nondev_subnodes(adev->handle, buf.pointer,
419 &adev->data, acpi_fwnode_handle(adev)))
420 adev->data.pointer = buf.pointer;
422 if (!adev->data.pointer) {
423 acpi_handle_debug(adev->handle, "Invalid _DSD data, skipping\n");
424 ACPI_FREE(buf.pointer);
428 if (acpi_of && !adev->flags.of_compatible_ok)
429 acpi_handle_info(adev->handle,
430 ACPI_DT_NAMESPACE_HID " requires 'compatible' property\n");
432 if (!adev->data.pointer)
433 acpi_extract_apple_properties(adev);
436 static void acpi_free_device_properties(struct list_head *list)
438 struct acpi_device_properties *props, *tmp;
440 list_for_each_entry_safe(props, tmp, list, list) {
441 list_del(&props->list);
446 static void acpi_destroy_nondev_subnodes(struct list_head *list)
448 struct acpi_data_node *dn, *next;
450 if (list_empty(list))
453 list_for_each_entry_safe_reverse(dn, next, list, sibling) {
454 acpi_destroy_nondev_subnodes(&dn->data.subnodes);
455 wait_for_completion(&dn->kobj_done);
456 list_del(&dn->sibling);
457 ACPI_FREE((void *)dn->data.pointer);
458 acpi_free_device_properties(&dn->data.properties);
463 void acpi_free_properties(struct acpi_device *adev)
465 acpi_destroy_nondev_subnodes(&adev->data.subnodes);
466 ACPI_FREE((void *)adev->data.pointer);
467 adev->data.of_compatible = NULL;
468 adev->data.pointer = NULL;
469 acpi_free_device_properties(&adev->data.properties);
473 * acpi_data_get_property - return an ACPI property with given name
474 * @data: ACPI device deta object to get the property from
475 * @name: Name of the property
476 * @type: Expected property type
477 * @obj: Location to store the property value (if not %NULL)
479 * Look up a property with @name and store a pointer to the resulting ACPI
480 * object at the location pointed to by @obj if found.
482 * Callers must not attempt to free the returned objects. These objects will be
483 * freed by the ACPI core automatically during the removal of @data.
485 * Return: %0 if property with @name has been found (success),
486 * %-EINVAL if the arguments are invalid,
487 * %-EINVAL if the property doesn't exist,
488 * %-EPROTO if the property value type doesn't match @type.
490 static int acpi_data_get_property(const struct acpi_device_data *data,
491 const char *name, acpi_object_type type,
492 const union acpi_object **obj)
494 const struct acpi_device_properties *props;
499 if (!data->pointer || list_empty(&data->properties))
502 list_for_each_entry(props, &data->properties, list) {
503 const union acpi_object *properties;
506 properties = props->properties;
507 for (i = 0; i < properties->package.count; i++) {
508 const union acpi_object *propname, *propvalue;
509 const union acpi_object *property;
511 property = &properties->package.elements[i];
513 propname = &property->package.elements[0];
514 propvalue = &property->package.elements[1];
516 if (!strcmp(name, propname->string.pointer)) {
517 if (type != ACPI_TYPE_ANY &&
518 propvalue->type != type)
531 * acpi_dev_get_property - return an ACPI property with given name.
532 * @adev: ACPI device to get the property from.
533 * @name: Name of the property.
534 * @type: Expected property type.
535 * @obj: Location to store the property value (if not %NULL).
537 int acpi_dev_get_property(const struct acpi_device *adev, const char *name,
538 acpi_object_type type, const union acpi_object **obj)
540 return adev ? acpi_data_get_property(&adev->data, name, type, obj) : -EINVAL;
542 EXPORT_SYMBOL_GPL(acpi_dev_get_property);
544 static const struct acpi_device_data *
545 acpi_device_data_of_node(const struct fwnode_handle *fwnode)
547 if (is_acpi_device_node(fwnode)) {
548 const struct acpi_device *adev = to_acpi_device_node(fwnode);
550 } else if (is_acpi_data_node(fwnode)) {
551 const struct acpi_data_node *dn = to_acpi_data_node(fwnode);
558 * acpi_node_prop_get - return an ACPI property with given name.
559 * @fwnode: Firmware node to get the property from.
560 * @propname: Name of the property.
561 * @valptr: Location to store a pointer to the property value (if not %NULL).
563 int acpi_node_prop_get(const struct fwnode_handle *fwnode,
564 const char *propname, void **valptr)
566 return acpi_data_get_property(acpi_device_data_of_node(fwnode),
567 propname, ACPI_TYPE_ANY,
568 (const union acpi_object **)valptr);
572 * acpi_data_get_property_array - return an ACPI array property with given name
573 * @adev: ACPI data object to get the property from
574 * @name: Name of the property
575 * @type: Expected type of array elements
576 * @obj: Location to store a pointer to the property value (if not NULL)
578 * Look up an array property with @name and store a pointer to the resulting
579 * ACPI object at the location pointed to by @obj if found.
581 * Callers must not attempt to free the returned objects. Those objects will be
582 * freed by the ACPI core automatically during the removal of @data.
584 * Return: %0 if array property (package) with @name has been found (success),
585 * %-EINVAL if the arguments are invalid,
586 * %-EINVAL if the property doesn't exist,
587 * %-EPROTO if the property is not a package or the type of its elements
588 * doesn't match @type.
590 static int acpi_data_get_property_array(const struct acpi_device_data *data,
592 acpi_object_type type,
593 const union acpi_object **obj)
595 const union acpi_object *prop;
598 ret = acpi_data_get_property(data, name, ACPI_TYPE_PACKAGE, &prop);
602 if (type != ACPI_TYPE_ANY) {
603 /* Check that all elements are of correct type. */
604 for (i = 0; i < prop->package.count; i++)
605 if (prop->package.elements[i].type != type)
614 static struct fwnode_handle *
615 acpi_fwnode_get_named_child_node(const struct fwnode_handle *fwnode,
616 const char *childname)
618 struct fwnode_handle *child;
620 fwnode_for_each_child_node(fwnode, child) {
621 if (is_acpi_data_node(child)) {
622 if (acpi_data_node_match(child, childname))
627 if (!strncmp(acpi_device_bid(to_acpi_device_node(child)),
628 childname, ACPI_NAMESEG_SIZE))
636 * __acpi_node_get_property_reference - returns handle to the referenced object
637 * @fwnode: Firmware node to get the property from
638 * @propname: Name of the property
639 * @index: Index of the reference to return
640 * @num_args: Maximum number of arguments after each reference
641 * @args: Location to store the returned reference with optional arguments
643 * Find property with @name, verifify that it is a package containing at least
644 * one object reference and if so, store the ACPI device object pointer to the
645 * target object in @args->adev. If the reference includes arguments, store
646 * them in the @args->args[] array.
648 * If there's more than one reference in the property value package, @index is
649 * used to select the one to return.
651 * It is possible to leave holes in the property value set like in the
664 * Calling this function with index %2 or index %3 return %-ENOENT. If the
665 * property does not contain any more values %-ENOENT is returned. The NULL
666 * entry must be single integer and preferably contain value %0.
668 * Return: %0 on success, negative error code on failure.
670 int __acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
671 const char *propname, size_t index, size_t num_args,
672 struct fwnode_reference_args *args)
674 const union acpi_object *element, *end;
675 const union acpi_object *obj;
676 const struct acpi_device_data *data;
677 struct acpi_device *device;
680 data = acpi_device_data_of_node(fwnode);
684 ret = acpi_data_get_property(data, propname, ACPI_TYPE_ANY, &obj);
686 return ret == -EINVAL ? -ENOENT : -EINVAL;
689 * The simplest case is when the value is a single reference. Just
690 * return that reference then.
692 if (obj->type == ACPI_TYPE_LOCAL_REFERENCE) {
696 ret = acpi_bus_get_device(obj->reference.handle, &device);
698 return ret == -ENODEV ? -EINVAL : ret;
700 args->fwnode = acpi_fwnode_handle(device);
706 * If it is not a single reference, then it is a package of
707 * references followed by number of ints as follows:
709 * Package () { REF, INT, REF, INT, INT }
711 * The index argument is then used to determine which reference
712 * the caller wants (along with the arguments).
714 if (obj->type != ACPI_TYPE_PACKAGE)
716 if (index >= obj->package.count)
719 element = obj->package.elements;
720 end = element + obj->package.count;
722 while (element < end) {
725 if (element->type == ACPI_TYPE_LOCAL_REFERENCE) {
726 struct fwnode_handle *ref_fwnode;
728 ret = acpi_bus_get_device(element->reference.handle,
737 * Find the referred data extension node under the
738 * referred device node.
740 for (ref_fwnode = acpi_fwnode_handle(device);
741 element < end && element->type == ACPI_TYPE_STRING;
743 ref_fwnode = acpi_fwnode_get_named_child_node(
744 ref_fwnode, element->string.pointer);
749 /* assume following integer elements are all args */
750 for (i = 0; element + i < end && i < num_args; i++) {
751 int type = element[i].type;
753 if (type == ACPI_TYPE_INTEGER)
755 else if (type == ACPI_TYPE_LOCAL_REFERENCE)
761 if (nargs > NR_FWNODE_REFERENCE_ARGS)
765 args->fwnode = ref_fwnode;
767 for (i = 0; i < nargs; i++)
768 args->args[i] = element[i].integer.value;
774 } else if (element->type == ACPI_TYPE_INTEGER) {
787 EXPORT_SYMBOL_GPL(__acpi_node_get_property_reference);
789 static int acpi_data_prop_read_single(const struct acpi_device_data *data,
790 const char *propname,
791 enum dev_prop_type proptype, void *val)
793 const union acpi_object *obj;
796 if (proptype >= DEV_PROP_U8 && proptype <= DEV_PROP_U64) {
797 ret = acpi_data_get_property(data, propname, ACPI_TYPE_INTEGER, &obj);
803 if (obj->integer.value > U8_MAX)
807 *(u8 *)val = obj->integer.value;
811 if (obj->integer.value > U16_MAX)
815 *(u16 *)val = obj->integer.value;
819 if (obj->integer.value > U32_MAX)
823 *(u32 *)val = obj->integer.value;
828 *(u64 *)val = obj->integer.value;
835 } else if (proptype == DEV_PROP_STRING) {
836 ret = acpi_data_get_property(data, propname, ACPI_TYPE_STRING, &obj);
841 *(char **)val = obj->string.pointer;
850 int acpi_dev_prop_read_single(struct acpi_device *adev, const char *propname,
851 enum dev_prop_type proptype, void *val)
858 ret = acpi_data_prop_read_single(&adev->data, propname, proptype, val);
859 if (ret < 0 || proptype != ACPI_TYPE_STRING)
864 static int acpi_copy_property_array_u8(const union acpi_object *items, u8 *val,
869 for (i = 0; i < nval; i++) {
870 if (items[i].type != ACPI_TYPE_INTEGER)
872 if (items[i].integer.value > U8_MAX)
875 val[i] = items[i].integer.value;
880 static int acpi_copy_property_array_u16(const union acpi_object *items,
881 u16 *val, size_t nval)
885 for (i = 0; i < nval; i++) {
886 if (items[i].type != ACPI_TYPE_INTEGER)
888 if (items[i].integer.value > U16_MAX)
891 val[i] = items[i].integer.value;
896 static int acpi_copy_property_array_u32(const union acpi_object *items,
897 u32 *val, size_t nval)
901 for (i = 0; i < nval; i++) {
902 if (items[i].type != ACPI_TYPE_INTEGER)
904 if (items[i].integer.value > U32_MAX)
907 val[i] = items[i].integer.value;
912 static int acpi_copy_property_array_u64(const union acpi_object *items,
913 u64 *val, size_t nval)
917 for (i = 0; i < nval; i++) {
918 if (items[i].type != ACPI_TYPE_INTEGER)
921 val[i] = items[i].integer.value;
926 static int acpi_copy_property_array_string(const union acpi_object *items,
927 char **val, size_t nval)
931 for (i = 0; i < nval; i++) {
932 if (items[i].type != ACPI_TYPE_STRING)
935 val[i] = items[i].string.pointer;
940 static int acpi_data_prop_read(const struct acpi_device_data *data,
941 const char *propname,
942 enum dev_prop_type proptype,
943 void *val, size_t nval)
945 const union acpi_object *obj;
946 const union acpi_object *items;
949 if (nval == 1 || !val) {
950 ret = acpi_data_prop_read_single(data, propname, proptype, val);
952 * The overflow error means that the property is there and it is
953 * single-value, but its type does not match, so return.
955 if (ret >= 0 || ret == -EOVERFLOW)
959 * Reading this property as a single-value one failed, but its
960 * value may still be represented as one-element array, so
965 ret = acpi_data_get_property_array(data, propname, ACPI_TYPE_ANY, &obj);
970 return obj->package.count;
972 if (proptype != DEV_PROP_STRING && nval > obj->package.count)
977 items = obj->package.elements;
981 ret = acpi_copy_property_array_u8(items, (u8 *)val, nval);
984 ret = acpi_copy_property_array_u16(items, (u16 *)val, nval);
987 ret = acpi_copy_property_array_u32(items, (u32 *)val, nval);
990 ret = acpi_copy_property_array_u64(items, (u64 *)val, nval);
992 case DEV_PROP_STRING:
993 ret = acpi_copy_property_array_string(
995 min_t(u32, nval, obj->package.count));
1004 int acpi_dev_prop_read(const struct acpi_device *adev, const char *propname,
1005 enum dev_prop_type proptype, void *val, size_t nval)
1007 return adev ? acpi_data_prop_read(&adev->data, propname, proptype, val, nval) : -EINVAL;
1011 * acpi_node_prop_read - retrieve the value of an ACPI property with given name.
1012 * @fwnode: Firmware node to get the property from.
1013 * @propname: Name of the property.
1014 * @proptype: Expected property type.
1015 * @val: Location to store the property value (if not %NULL).
1016 * @nval: Size of the array pointed to by @val.
1018 * If @val is %NULL, return the number of array elements comprising the value
1019 * of the property. Otherwise, read at most @nval values to the array at the
1020 * location pointed to by @val.
1022 int acpi_node_prop_read(const struct fwnode_handle *fwnode,
1023 const char *propname, enum dev_prop_type proptype,
1024 void *val, size_t nval)
1026 return acpi_data_prop_read(acpi_device_data_of_node(fwnode),
1027 propname, proptype, val, nval);
1031 * acpi_get_next_subnode - Return the next child node handle for a fwnode
1032 * @fwnode: Firmware node to find the next child node for.
1033 * @child: Handle to one of the device's child nodes or a null handle.
1035 struct fwnode_handle *acpi_get_next_subnode(const struct fwnode_handle *fwnode,
1036 struct fwnode_handle *child)
1038 const struct acpi_device *adev = to_acpi_device_node(fwnode);
1039 const struct list_head *head;
1040 struct list_head *next;
1042 if (!child || is_acpi_device_node(child)) {
1043 struct acpi_device *child_adev;
1046 head = &adev->children;
1050 if (list_empty(head))
1054 adev = to_acpi_device_node(child);
1055 next = adev->node.next;
1060 child_adev = list_entry(next, struct acpi_device, node);
1062 child_adev = list_first_entry(head, struct acpi_device,
1065 return acpi_fwnode_handle(child_adev);
1069 if (!child || is_acpi_data_node(child)) {
1070 const struct acpi_data_node *data = to_acpi_data_node(fwnode);
1071 struct acpi_data_node *dn;
1074 * We can have a combination of device and data nodes, e.g. with
1075 * hierarchical _DSD properties. Make sure the adev pointer is
1076 * restored before going through data nodes, otherwise we will
1077 * be looking for data_nodes below the last device found instead
1078 * of the common fwnode shared by device_nodes and data_nodes.
1080 adev = to_acpi_device_node(fwnode);
1082 head = &adev->data.subnodes;
1084 head = &data->data.subnodes;
1088 if (list_empty(head))
1092 dn = to_acpi_data_node(child);
1093 next = dn->sibling.next;
1097 dn = list_entry(next, struct acpi_data_node, sibling);
1099 dn = list_first_entry(head, struct acpi_data_node, sibling);
1107 * acpi_node_get_parent - Return parent fwnode of this fwnode
1108 * @fwnode: Firmware node whose parent to get
1110 * Returns parent node of an ACPI device or data firmware node or %NULL if
1113 struct fwnode_handle *acpi_node_get_parent(const struct fwnode_handle *fwnode)
1115 if (is_acpi_data_node(fwnode)) {
1116 /* All data nodes have parent pointer so just return that */
1117 return to_acpi_data_node(fwnode)->parent;
1118 } else if (is_acpi_device_node(fwnode)) {
1119 struct device *dev = to_acpi_device_node(fwnode)->dev.parent;
1122 return acpi_fwnode_handle(to_acpi_device(dev));
1129 * Return true if the node is an ACPI graph node. Called on either ports
1132 static bool is_acpi_graph_node(struct fwnode_handle *fwnode,
1135 unsigned int len = strlen(str);
1138 if (!len || !is_acpi_data_node(fwnode))
1141 name = to_acpi_data_node(fwnode)->name;
1143 return (fwnode_property_present(fwnode, "reg") &&
1144 !strncmp(name, str, len) && name[len] == '@') ||
1145 fwnode_property_present(fwnode, str);
1149 * acpi_graph_get_next_endpoint - Get next endpoint ACPI firmware node
1150 * @fwnode: Pointer to the parent firmware node
1151 * @prev: Previous endpoint node or %NULL to get the first
1153 * Looks up next endpoint ACPI firmware node below a given @fwnode. Returns
1154 * %NULL if there is no next endpoint or in case of error. In case of success
1155 * the next endpoint is returned.
1157 static struct fwnode_handle *acpi_graph_get_next_endpoint(
1158 const struct fwnode_handle *fwnode, struct fwnode_handle *prev)
1160 struct fwnode_handle *port = NULL;
1161 struct fwnode_handle *endpoint;
1165 port = fwnode_get_next_child_node(fwnode, port);
1167 * The names of the port nodes begin with "port@"
1168 * followed by the number of the port node and they also
1169 * have a "reg" property that also has the number of the
1170 * port node. For compatibility reasons a node is also
1171 * recognised as a port node from the "port" property.
1173 if (is_acpi_graph_node(port, "port"))
1177 port = fwnode_get_parent(prev);
1183 endpoint = fwnode_get_next_child_node(port, prev);
1185 port = fwnode_get_next_child_node(fwnode, port);
1188 if (is_acpi_graph_node(port, "port"))
1189 endpoint = fwnode_get_next_child_node(port, NULL);
1193 * The names of the endpoint nodes begin with "endpoint@" followed by
1194 * the number of the endpoint node and they also have a "reg" property
1195 * that also has the number of the endpoint node. For compatibility
1196 * reasons a node is also recognised as an endpoint node from the
1197 * "endpoint" property.
1199 if (!is_acpi_graph_node(endpoint, "endpoint"))
1206 * acpi_graph_get_child_prop_value - Return a child with a given property value
1207 * @fwnode: device fwnode
1208 * @prop_name: The name of the property to look for
1209 * @val: the desired property value
1211 * Return the port node corresponding to a given port number. Returns
1212 * the child node on success, NULL otherwise.
1214 static struct fwnode_handle *acpi_graph_get_child_prop_value(
1215 const struct fwnode_handle *fwnode, const char *prop_name,
1218 struct fwnode_handle *child;
1220 fwnode_for_each_child_node(fwnode, child) {
1223 if (fwnode_property_read_u32(child, prop_name, &nr))
1235 * acpi_graph_get_remote_endpoint - Parses and returns remote end of an endpoint
1236 * @fwnode: Endpoint firmware node pointing to a remote device
1237 * @endpoint: Firmware node of remote endpoint is filled here if not %NULL
1239 * Returns the remote endpoint corresponding to @__fwnode. NULL on error.
1241 static struct fwnode_handle *
1242 acpi_graph_get_remote_endpoint(const struct fwnode_handle *__fwnode)
1244 struct fwnode_handle *fwnode;
1245 unsigned int port_nr, endpoint_nr;
1246 struct fwnode_reference_args args;
1249 memset(&args, 0, sizeof(args));
1250 ret = acpi_node_get_property_reference(__fwnode, "remote-endpoint", 0,
1255 /* Direct endpoint reference? */
1256 if (!is_acpi_device_node(args.fwnode))
1257 return args.nargs ? NULL : args.fwnode;
1260 * Always require two arguments with the reference: port and
1263 if (args.nargs != 2)
1266 fwnode = args.fwnode;
1267 port_nr = args.args[0];
1268 endpoint_nr = args.args[1];
1270 fwnode = acpi_graph_get_child_prop_value(fwnode, "port", port_nr);
1272 return acpi_graph_get_child_prop_value(fwnode, "endpoint", endpoint_nr);
1275 static bool acpi_fwnode_device_is_available(const struct fwnode_handle *fwnode)
1277 if (!is_acpi_device_node(fwnode))
1280 return acpi_device_is_present(to_acpi_device_node(fwnode));
1283 static bool acpi_fwnode_property_present(const struct fwnode_handle *fwnode,
1284 const char *propname)
1286 return !acpi_node_prop_get(fwnode, propname, NULL);
1290 acpi_fwnode_property_read_int_array(const struct fwnode_handle *fwnode,
1291 const char *propname,
1292 unsigned int elem_size, void *val,
1295 enum dev_prop_type type;
1297 switch (elem_size) {
1302 type = DEV_PROP_U16;
1305 type = DEV_PROP_U32;
1308 type = DEV_PROP_U64;
1314 return acpi_node_prop_read(fwnode, propname, type, val, nval);
1318 acpi_fwnode_property_read_string_array(const struct fwnode_handle *fwnode,
1319 const char *propname, const char **val,
1322 return acpi_node_prop_read(fwnode, propname, DEV_PROP_STRING,
1327 acpi_fwnode_get_reference_args(const struct fwnode_handle *fwnode,
1328 const char *prop, const char *nargs_prop,
1329 unsigned int args_count, unsigned int index,
1330 struct fwnode_reference_args *args)
1332 return __acpi_node_get_property_reference(fwnode, prop, index,
1336 static const char *acpi_fwnode_get_name(const struct fwnode_handle *fwnode)
1338 const struct acpi_device *adev;
1339 struct fwnode_handle *parent;
1341 /* Is this the root node? */
1342 parent = fwnode_get_parent(fwnode);
1346 fwnode_handle_put(parent);
1348 if (is_acpi_data_node(fwnode)) {
1349 const struct acpi_data_node *dn = to_acpi_data_node(fwnode);
1354 adev = to_acpi_device_node(fwnode);
1358 return acpi_device_bid(adev);
1362 acpi_fwnode_get_name_prefix(const struct fwnode_handle *fwnode)
1364 struct fwnode_handle *parent;
1366 /* Is this the root node? */
1367 parent = fwnode_get_parent(fwnode);
1371 /* Is this 2nd node from the root? */
1372 parent = fwnode_get_next_parent(parent);
1376 fwnode_handle_put(parent);
1378 /* ACPI device or data node. */
1382 static struct fwnode_handle *
1383 acpi_fwnode_get_parent(struct fwnode_handle *fwnode)
1385 return acpi_node_get_parent(fwnode);
1388 static int acpi_fwnode_graph_parse_endpoint(const struct fwnode_handle *fwnode,
1389 struct fwnode_endpoint *endpoint)
1391 struct fwnode_handle *port_fwnode = fwnode_get_parent(fwnode);
1393 endpoint->local_fwnode = fwnode;
1395 if (fwnode_property_read_u32(port_fwnode, "reg", &endpoint->port))
1396 fwnode_property_read_u32(port_fwnode, "port", &endpoint->port);
1397 if (fwnode_property_read_u32(fwnode, "reg", &endpoint->id))
1398 fwnode_property_read_u32(fwnode, "endpoint", &endpoint->id);
1404 acpi_fwnode_device_get_match_data(const struct fwnode_handle *fwnode,
1405 const struct device *dev)
1407 return acpi_device_get_match_data(dev);
1410 #define DECLARE_ACPI_FWNODE_OPS(ops) \
1411 const struct fwnode_operations ops = { \
1412 .device_is_available = acpi_fwnode_device_is_available, \
1413 .device_get_match_data = acpi_fwnode_device_get_match_data, \
1414 .property_present = acpi_fwnode_property_present, \
1415 .property_read_int_array = \
1416 acpi_fwnode_property_read_int_array, \
1417 .property_read_string_array = \
1418 acpi_fwnode_property_read_string_array, \
1419 .get_parent = acpi_node_get_parent, \
1420 .get_next_child_node = acpi_get_next_subnode, \
1421 .get_named_child_node = acpi_fwnode_get_named_child_node, \
1422 .get_name = acpi_fwnode_get_name, \
1423 .get_name_prefix = acpi_fwnode_get_name_prefix, \
1424 .get_reference_args = acpi_fwnode_get_reference_args, \
1425 .graph_get_next_endpoint = \
1426 acpi_graph_get_next_endpoint, \
1427 .graph_get_remote_endpoint = \
1428 acpi_graph_get_remote_endpoint, \
1429 .graph_get_port_parent = acpi_fwnode_get_parent, \
1430 .graph_parse_endpoint = acpi_fwnode_graph_parse_endpoint, \
1432 EXPORT_SYMBOL_GPL(ops)
1434 DECLARE_ACPI_FWNODE_OPS(acpi_device_fwnode_ops);
1435 DECLARE_ACPI_FWNODE_OPS(acpi_data_fwnode_ops);
1436 const struct fwnode_operations acpi_static_fwnode_ops;
1438 bool is_acpi_device_node(const struct fwnode_handle *fwnode)
1440 return !IS_ERR_OR_NULL(fwnode) &&
1441 fwnode->ops == &acpi_device_fwnode_ops;
1443 EXPORT_SYMBOL(is_acpi_device_node);
1445 bool is_acpi_data_node(const struct fwnode_handle *fwnode)
1447 return !IS_ERR_OR_NULL(fwnode) && fwnode->ops == &acpi_data_fwnode_ops;
1449 EXPORT_SYMBOL(is_acpi_data_node);