Merge tag 'sound-fix-5.18-rc1' of git://git.kernel.org/pub/scm/linux/kernel/git/tiwai...
[linux-2.6-microblaze.git] / drivers / acpi / property.c
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * ACPI device specific properties support.
4  *
5  * Copyright (C) 2014, Intel Corporation
6  * All rights reserved.
7  *
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>
11  */
12
13 #include <linux/acpi.h>
14 #include <linux/device.h>
15 #include <linux/export.h>
16
17 #include "internal.h"
18
19 static int acpi_data_get_property_array(const struct acpi_device_data *data,
20                                         const char *name,
21                                         acpi_object_type type,
22                                         const union acpi_object **obj);
23
24 /*
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.
31  */
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),
51 };
52
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);
57
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);
64
65 static bool acpi_nondev_subnode_extract(const union acpi_object *desc,
66                                         acpi_handle handle,
67                                         const union acpi_object *link,
68                                         struct list_head *list,
69                                         struct fwnode_handle *parent)
70 {
71         struct acpi_data_node *dn;
72         bool result;
73
74         dn = kzalloc(sizeof(*dn), GFP_KERNEL);
75         if (!dn)
76                 return false;
77
78         dn->name = link->package.elements[0].string.pointer;
79         fwnode_init(&dn->fwnode, &acpi_data_fwnode_ops);
80         dn->parent = parent;
81         INIT_LIST_HEAD(&dn->data.properties);
82         INIT_LIST_HEAD(&dn->data.subnodes);
83
84         result = acpi_extract_properties(desc, &dn->data);
85
86         if (handle) {
87                 acpi_handle scope;
88                 acpi_status status;
89
90                 /*
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
94                  * object's parent.
95                  */
96                 status = acpi_get_parent(handle, &scope);
97                 if (ACPI_SUCCESS(status)
98                     && acpi_enumerate_nondev_subnodes(scope, desc, &dn->data,
99                                                       &dn->fwnode))
100                         result = true;
101         } else if (acpi_enumerate_nondev_subnodes(NULL, desc, &dn->data,
102                                                   &dn->fwnode)) {
103                 result = true;
104         }
105
106         if (result) {
107                 dn->handle = handle;
108                 dn->data.pointer = desc;
109                 list_add_tail(&dn->sibling, list);
110                 return true;
111         }
112
113         kfree(dn);
114         acpi_handle_debug(handle, "Invalid properties/subnodes data, skipping\n");
115         return false;
116 }
117
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)
122 {
123         struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER };
124         acpi_status status;
125
126         status = acpi_evaluate_object_typed(handle, NULL, NULL, &buf,
127                                             ACPI_TYPE_PACKAGE);
128         if (ACPI_FAILURE(status))
129                 return false;
130
131         if (acpi_nondev_subnode_extract(buf.pointer, handle, link, list,
132                                         parent))
133                 return true;
134
135         ACPI_FREE(buf.pointer);
136         return false;
137 }
138
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)
143 {
144         acpi_handle handle;
145         acpi_status status;
146
147         if (!scope)
148                 return false;
149
150         status = acpi_get_handle(scope, link->package.elements[1].string.pointer,
151                                  &handle);
152         if (ACPI_FAILURE(status))
153                 return false;
154
155         return acpi_nondev_subnode_data_ok(handle, link, list, parent);
156 }
157
158 static int acpi_add_nondev_subnodes(acpi_handle scope,
159                                     const union acpi_object *links,
160                                     struct list_head *list,
161                                     struct fwnode_handle *parent)
162 {
163         bool ret = false;
164         int i;
165
166         for (i = 0; i < links->package.count; i++) {
167                 const union acpi_object *link, *desc;
168                 acpi_handle handle;
169                 bool result;
170
171                 link = &links->package.elements[i];
172                 /* Only two elements allowed. */
173                 if (link->package.count != 2)
174                         continue;
175
176                 /* The first one must be a string. */
177                 if (link->package.elements[0].type != ACPI_TYPE_STRING)
178                         continue;
179
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,
184                                                          parent);
185                         break;
186                 case ACPI_TYPE_LOCAL_REFERENCE:
187                         handle = link->package.elements[1].reference.handle;
188                         result = acpi_nondev_subnode_data_ok(handle, link, list,
189                                                              parent);
190                         break;
191                 case ACPI_TYPE_PACKAGE:
192                         desc = &link->package.elements[1];
193                         result = acpi_nondev_subnode_extract(desc, NULL, link,
194                                                              list, parent);
195                         break;
196                 default:
197                         result = false;
198                         break;
199                 }
200                 ret = ret || result;
201         }
202
203         return ret;
204 }
205
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)
210 {
211         int i;
212
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;
216
217                 guid = &desc->package.elements[i];
218                 links = &desc->package.elements[i + 1];
219
220                 /*
221                  * The first element must be a GUID and the second one must be
222                  * a package.
223                  */
224                 if (guid->type != ACPI_TYPE_BUFFER ||
225                     guid->buffer.length != 16 ||
226                     links->type != ACPI_TYPE_PACKAGE)
227                         break;
228
229                 if (!guid_equal((guid_t *)guid->buffer.pointer, &ads_guid))
230                         continue;
231
232                 return acpi_add_nondev_subnodes(scope, links, &data->subnodes,
233                                                 parent);
234         }
235
236         return false;
237 }
238
239 static bool acpi_property_value_ok(const union acpi_object *value)
240 {
241         int j;
242
243         /*
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.
246          */
247         switch (value->type) {
248         case ACPI_TYPE_INTEGER:
249         case ACPI_TYPE_STRING:
250         case ACPI_TYPE_LOCAL_REFERENCE:
251                 return true;
252
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:
259                                 continue;
260
261                         default:
262                                 return false;
263                         }
264
265                 return true;
266         }
267         return false;
268 }
269
270 static bool acpi_properties_format_valid(const union acpi_object *properties)
271 {
272         int i;
273
274         for (i = 0; i < properties->package.count; i++) {
275                 const union acpi_object *property;
276
277                 property = &properties->package.elements[i];
278                 /*
279                  * Only two elements allowed, the first one must be a string and
280                  * the second one has to satisfy certain conditions.
281                  */
282                 if (property->package.count != 2
283                     || property->package.elements[0].type != ACPI_TYPE_STRING
284                     || !acpi_property_value_ok(&property->package.elements[1]))
285                         return false;
286         }
287         return true;
288 }
289
290 static void acpi_init_of_compatible(struct acpi_device *adev)
291 {
292         const union acpi_object *of_compatible;
293         int ret;
294
295         ret = acpi_data_get_property_array(&adev->data, "compatible",
296                                            ACPI_TYPE_STRING, &of_compatible);
297         if (ret) {
298                 ret = acpi_dev_get_property(adev, "compatible",
299                                             ACPI_TYPE_STRING, &of_compatible);
300                 if (ret) {
301                         if (adev->parent
302                             && adev->parent->flags.of_compatible_ok)
303                                 goto out;
304
305                         return;
306                 }
307         }
308         adev->data.of_compatible = of_compatible;
309
310  out:
311         adev->flags.of_compatible_ok = 1;
312 }
313
314 static bool acpi_is_property_guid(const guid_t *guid)
315 {
316         int i;
317
318         for (i = 0; i < ARRAY_SIZE(prp_guids); i++) {
319                 if (guid_equal(guid, &prp_guids[i]))
320                         return true;
321         }
322
323         return false;
324 }
325
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)
329 {
330         struct acpi_device_properties *props;
331
332         props = kzalloc(sizeof(*props), GFP_KERNEL);
333         if (props) {
334                 INIT_LIST_HEAD(&props->list);
335                 props->guid = guid;
336                 props->properties = properties;
337                 list_add_tail(&props->list, &data->properties);
338         }
339
340         return props;
341 }
342
343 static bool acpi_extract_properties(const union acpi_object *desc,
344                                     struct acpi_device_data *data)
345 {
346         int i;
347
348         if (desc->package.count % 2)
349                 return false;
350
351         /* Look for the device properties GUID. */
352         for (i = 0; i < desc->package.count; i += 2) {
353                 const union acpi_object *guid, *properties;
354
355                 guid = &desc->package.elements[i];
356                 properties = &desc->package.elements[i + 1];
357
358                 /*
359                  * The first element must be a GUID and the second one must be
360                  * a package.
361                  */
362                 if (guid->type != ACPI_TYPE_BUFFER ||
363                     guid->buffer.length != 16 ||
364                     properties->type != ACPI_TYPE_PACKAGE)
365                         break;
366
367                 if (!acpi_is_property_guid((guid_t *)guid->buffer.pointer))
368                         continue;
369
370                 /*
371                  * We found the matching GUID. Now validate the format of the
372                  * package immediately following it.
373                  */
374                 if (!acpi_properties_format_valid(properties))
375                         continue;
376
377                 acpi_data_add_props(data, (const guid_t *)guid->buffer.pointer,
378                                     properties);
379         }
380
381         return !list_empty(&data->properties);
382 }
383
384 void acpi_init_properties(struct acpi_device *adev)
385 {
386         struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER };
387         struct acpi_hardware_id *hwid;
388         acpi_status status;
389         bool acpi_of = false;
390
391         INIT_LIST_HEAD(&adev->data.properties);
392         INIT_LIST_HEAD(&adev->data.subnodes);
393
394         if (!adev->handle)
395                 return;
396
397         /*
398          * Check if ACPI_DT_NAMESPACE_HID is present and inthat case we fill in
399          * Device Tree compatible properties for this device.
400          */
401         list_for_each_entry(hwid, &adev->pnp.ids, list) {
402                 if (!strcmp(hwid->id, ACPI_DT_NAMESPACE_HID)) {
403                         acpi_of = true;
404                         break;
405                 }
406         }
407
408         status = acpi_evaluate_object_typed(adev->handle, "_DSD", NULL, &buf,
409                                             ACPI_TYPE_PACKAGE);
410         if (ACPI_FAILURE(status))
411                 goto out;
412
413         if (acpi_extract_properties(buf.pointer, &adev->data)) {
414                 adev->data.pointer = buf.pointer;
415                 if (acpi_of)
416                         acpi_init_of_compatible(adev);
417         }
418         if (acpi_enumerate_nondev_subnodes(adev->handle, buf.pointer,
419                                         &adev->data, acpi_fwnode_handle(adev)))
420                 adev->data.pointer = buf.pointer;
421
422         if (!adev->data.pointer) {
423                 acpi_handle_debug(adev->handle, "Invalid _DSD data, skipping\n");
424                 ACPI_FREE(buf.pointer);
425         }
426
427  out:
428         if (acpi_of && !adev->flags.of_compatible_ok)
429                 acpi_handle_info(adev->handle,
430                          ACPI_DT_NAMESPACE_HID " requires 'compatible' property\n");
431
432         if (!adev->data.pointer)
433                 acpi_extract_apple_properties(adev);
434 }
435
436 static void acpi_destroy_nondev_subnodes(struct list_head *list)
437 {
438         struct acpi_data_node *dn, *next;
439
440         if (list_empty(list))
441                 return;
442
443         list_for_each_entry_safe_reverse(dn, next, list, sibling) {
444                 acpi_destroy_nondev_subnodes(&dn->data.subnodes);
445                 wait_for_completion(&dn->kobj_done);
446                 list_del(&dn->sibling);
447                 ACPI_FREE((void *)dn->data.pointer);
448                 kfree(dn);
449         }
450 }
451
452 void acpi_free_properties(struct acpi_device *adev)
453 {
454         struct acpi_device_properties *props, *tmp;
455
456         acpi_destroy_nondev_subnodes(&adev->data.subnodes);
457         ACPI_FREE((void *)adev->data.pointer);
458         adev->data.of_compatible = NULL;
459         adev->data.pointer = NULL;
460         list_for_each_entry_safe(props, tmp, &adev->data.properties, list) {
461                 list_del(&props->list);
462                 kfree(props);
463         }
464 }
465
466 /**
467  * acpi_data_get_property - return an ACPI property with given name
468  * @data: ACPI device deta object to get the property from
469  * @name: Name of the property
470  * @type: Expected property type
471  * @obj: Location to store the property value (if not %NULL)
472  *
473  * Look up a property with @name and store a pointer to the resulting ACPI
474  * object at the location pointed to by @obj if found.
475  *
476  * Callers must not attempt to free the returned objects.  These objects will be
477  * freed by the ACPI core automatically during the removal of @data.
478  *
479  * Return: %0 if property with @name has been found (success),
480  *         %-EINVAL if the arguments are invalid,
481  *         %-EINVAL if the property doesn't exist,
482  *         %-EPROTO if the property value type doesn't match @type.
483  */
484 static int acpi_data_get_property(const struct acpi_device_data *data,
485                                   const char *name, acpi_object_type type,
486                                   const union acpi_object **obj)
487 {
488         const struct acpi_device_properties *props;
489
490         if (!data || !name)
491                 return -EINVAL;
492
493         if (!data->pointer || list_empty(&data->properties))
494                 return -EINVAL;
495
496         list_for_each_entry(props, &data->properties, list) {
497                 const union acpi_object *properties;
498                 unsigned int i;
499
500                 properties = props->properties;
501                 for (i = 0; i < properties->package.count; i++) {
502                         const union acpi_object *propname, *propvalue;
503                         const union acpi_object *property;
504
505                         property = &properties->package.elements[i];
506
507                         propname = &property->package.elements[0];
508                         propvalue = &property->package.elements[1];
509
510                         if (!strcmp(name, propname->string.pointer)) {
511                                 if (type != ACPI_TYPE_ANY &&
512                                     propvalue->type != type)
513                                         return -EPROTO;
514                                 if (obj)
515                                         *obj = propvalue;
516
517                                 return 0;
518                         }
519                 }
520         }
521         return -EINVAL;
522 }
523
524 /**
525  * acpi_dev_get_property - return an ACPI property with given name.
526  * @adev: ACPI device to get the property from.
527  * @name: Name of the property.
528  * @type: Expected property type.
529  * @obj: Location to store the property value (if not %NULL).
530  */
531 int acpi_dev_get_property(const struct acpi_device *adev, const char *name,
532                           acpi_object_type type, const union acpi_object **obj)
533 {
534         return adev ? acpi_data_get_property(&adev->data, name, type, obj) : -EINVAL;
535 }
536 EXPORT_SYMBOL_GPL(acpi_dev_get_property);
537
538 static const struct acpi_device_data *
539 acpi_device_data_of_node(const struct fwnode_handle *fwnode)
540 {
541         if (is_acpi_device_node(fwnode)) {
542                 const struct acpi_device *adev = to_acpi_device_node(fwnode);
543                 return &adev->data;
544         }
545         if (is_acpi_data_node(fwnode)) {
546                 const struct acpi_data_node *dn = to_acpi_data_node(fwnode);
547                 return &dn->data;
548         }
549         return NULL;
550 }
551
552 /**
553  * acpi_node_prop_get - return an ACPI property with given name.
554  * @fwnode: Firmware node to get the property from.
555  * @propname: Name of the property.
556  * @valptr: Location to store a pointer to the property value (if not %NULL).
557  */
558 int acpi_node_prop_get(const struct fwnode_handle *fwnode,
559                        const char *propname, void **valptr)
560 {
561         return acpi_data_get_property(acpi_device_data_of_node(fwnode),
562                                       propname, ACPI_TYPE_ANY,
563                                       (const union acpi_object **)valptr);
564 }
565
566 /**
567  * acpi_data_get_property_array - return an ACPI array property with given name
568  * @data: ACPI data object to get the property from
569  * @name: Name of the property
570  * @type: Expected type of array elements
571  * @obj: Location to store a pointer to the property value (if not NULL)
572  *
573  * Look up an array property with @name and store a pointer to the resulting
574  * ACPI object at the location pointed to by @obj if found.
575  *
576  * Callers must not attempt to free the returned objects.  Those objects will be
577  * freed by the ACPI core automatically during the removal of @data.
578  *
579  * Return: %0 if array property (package) with @name has been found (success),
580  *         %-EINVAL if the arguments are invalid,
581  *         %-EINVAL if the property doesn't exist,
582  *         %-EPROTO if the property is not a package or the type of its elements
583  *           doesn't match @type.
584  */
585 static int acpi_data_get_property_array(const struct acpi_device_data *data,
586                                         const char *name,
587                                         acpi_object_type type,
588                                         const union acpi_object **obj)
589 {
590         const union acpi_object *prop;
591         int ret, i;
592
593         ret = acpi_data_get_property(data, name, ACPI_TYPE_PACKAGE, &prop);
594         if (ret)
595                 return ret;
596
597         if (type != ACPI_TYPE_ANY) {
598                 /* Check that all elements are of correct type. */
599                 for (i = 0; i < prop->package.count; i++)
600                         if (prop->package.elements[i].type != type)
601                                 return -EPROTO;
602         }
603         if (obj)
604                 *obj = prop;
605
606         return 0;
607 }
608
609 static struct fwnode_handle *
610 acpi_fwnode_get_named_child_node(const struct fwnode_handle *fwnode,
611                                  const char *childname)
612 {
613         struct fwnode_handle *child;
614
615         fwnode_for_each_child_node(fwnode, child) {
616                 if (is_acpi_data_node(child)) {
617                         if (acpi_data_node_match(child, childname))
618                                 return child;
619                         continue;
620                 }
621
622                 if (!strncmp(acpi_device_bid(to_acpi_device_node(child)),
623                              childname, ACPI_NAMESEG_SIZE))
624                         return child;
625         }
626
627         return NULL;
628 }
629
630 /**
631  * __acpi_node_get_property_reference - returns handle to the referenced object
632  * @fwnode: Firmware node to get the property from
633  * @propname: Name of the property
634  * @index: Index of the reference to return
635  * @num_args: Maximum number of arguments after each reference
636  * @args: Location to store the returned reference with optional arguments
637  *
638  * Find property with @name, verifify that it is a package containing at least
639  * one object reference and if so, store the ACPI device object pointer to the
640  * target object in @args->adev.  If the reference includes arguments, store
641  * them in the @args->args[] array.
642  *
643  * If there's more than one reference in the property value package, @index is
644  * used to select the one to return.
645  *
646  * It is possible to leave holes in the property value set like in the
647  * example below:
648  *
649  * Package () {
650  *     "cs-gpios",
651  *     Package () {
652  *        ^GPIO, 19, 0, 0,
653  *        ^GPIO, 20, 0, 0,
654  *        0,
655  *        ^GPIO, 21, 0, 0,
656  *     }
657  * }
658  *
659  * Calling this function with index %2 or index %3 return %-ENOENT. If the
660  * property does not contain any more values %-ENOENT is returned. The NULL
661  * entry must be single integer and preferably contain value %0.
662  *
663  * Return: %0 on success, negative error code on failure.
664  */
665 int __acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
666         const char *propname, size_t index, size_t num_args,
667         struct fwnode_reference_args *args)
668 {
669         const union acpi_object *element, *end;
670         const union acpi_object *obj;
671         const struct acpi_device_data *data;
672         struct acpi_device *device;
673         int ret, idx = 0;
674
675         data = acpi_device_data_of_node(fwnode);
676         if (!data)
677                 return -ENOENT;
678
679         ret = acpi_data_get_property(data, propname, ACPI_TYPE_ANY, &obj);
680         if (ret)
681                 return ret == -EINVAL ? -ENOENT : -EINVAL;
682
683         /*
684          * The simplest case is when the value is a single reference.  Just
685          * return that reference then.
686          */
687         if (obj->type == ACPI_TYPE_LOCAL_REFERENCE) {
688                 if (index)
689                         return -ENOENT;
690
691                 device = acpi_fetch_acpi_dev(obj->reference.handle);
692                 if (!device)
693                         return -EINVAL;
694
695                 args->fwnode = acpi_fwnode_handle(device);
696                 args->nargs = 0;
697                 return 0;
698         }
699
700         /*
701          * If it is not a single reference, then it is a package of
702          * references followed by number of ints as follows:
703          *
704          *  Package () { REF, INT, REF, INT, INT }
705          *
706          * The index argument is then used to determine which reference
707          * the caller wants (along with the arguments).
708          */
709         if (obj->type != ACPI_TYPE_PACKAGE)
710                 return -EINVAL;
711         if (index >= obj->package.count)
712                 return -ENOENT;
713
714         element = obj->package.elements;
715         end = element + obj->package.count;
716
717         while (element < end) {
718                 u32 nargs, i;
719
720                 if (element->type == ACPI_TYPE_LOCAL_REFERENCE) {
721                         struct fwnode_handle *ref_fwnode;
722
723                         device = acpi_fetch_acpi_dev(element->reference.handle);
724                         if (!device)
725                                 return -EINVAL;
726
727                         nargs = 0;
728                         element++;
729
730                         /*
731                          * Find the referred data extension node under the
732                          * referred device node.
733                          */
734                         for (ref_fwnode = acpi_fwnode_handle(device);
735                              element < end && element->type == ACPI_TYPE_STRING;
736                              element++) {
737                                 ref_fwnode = acpi_fwnode_get_named_child_node(
738                                         ref_fwnode, element->string.pointer);
739                                 if (!ref_fwnode)
740                                         return -EINVAL;
741                         }
742
743                         /*
744                          * Assume the following integer elements are all args.
745                          * Stop counting on the first reference or end of the
746                          * package arguments. In case of neither reference,
747                          * nor integer, return an error, we can't parse it.
748                          */
749                         for (i = 0; element + i < end && i < num_args; i++) {
750                                 int type = element[i].type;
751
752                                 if (type == ACPI_TYPE_LOCAL_REFERENCE)
753                                         break;
754                                 if (type == ACPI_TYPE_INTEGER)
755                                         nargs++;
756                                 else
757                                         return -EINVAL;
758                         }
759
760                         if (nargs > NR_FWNODE_REFERENCE_ARGS)
761                                 return -EINVAL;
762
763                         if (idx == index) {
764                                 args->fwnode = ref_fwnode;
765                                 args->nargs = nargs;
766                                 for (i = 0; i < nargs; i++)
767                                         args->args[i] = element[i].integer.value;
768
769                                 return 0;
770                         }
771
772                         element += nargs;
773                 } else if (element->type == ACPI_TYPE_INTEGER) {
774                         if (idx == index)
775                                 return -ENOENT;
776                         element++;
777                 } else {
778                         return -EINVAL;
779                 }
780
781                 idx++;
782         }
783
784         return -ENOENT;
785 }
786 EXPORT_SYMBOL_GPL(__acpi_node_get_property_reference);
787
788 static int acpi_data_prop_read_single(const struct acpi_device_data *data,
789                                       const char *propname,
790                                       enum dev_prop_type proptype, void *val)
791 {
792         const union acpi_object *obj;
793         int ret;
794
795         if (proptype >= DEV_PROP_U8 && proptype <= DEV_PROP_U64) {
796                 ret = acpi_data_get_property(data, propname, ACPI_TYPE_INTEGER, &obj);
797                 if (ret)
798                         return ret;
799
800                 switch (proptype) {
801                 case DEV_PROP_U8:
802                         if (obj->integer.value > U8_MAX)
803                                 return -EOVERFLOW;
804
805                         if (val)
806                                 *(u8 *)val = obj->integer.value;
807
808                         break;
809                 case DEV_PROP_U16:
810                         if (obj->integer.value > U16_MAX)
811                                 return -EOVERFLOW;
812
813                         if (val)
814                                 *(u16 *)val = obj->integer.value;
815
816                         break;
817                 case DEV_PROP_U32:
818                         if (obj->integer.value > U32_MAX)
819                                 return -EOVERFLOW;
820
821                         if (val)
822                                 *(u32 *)val = obj->integer.value;
823
824                         break;
825                 default:
826                         if (val)
827                                 *(u64 *)val = obj->integer.value;
828
829                         break;
830                 }
831
832                 if (!val)
833                         return 1;
834         } else if (proptype == DEV_PROP_STRING) {
835                 ret = acpi_data_get_property(data, propname, ACPI_TYPE_STRING, &obj);
836                 if (ret)
837                         return ret;
838
839                 if (val)
840                         *(char **)val = obj->string.pointer;
841
842                 return 1;
843         } else {
844                 ret = -EINVAL;
845         }
846         return ret;
847 }
848
849 static int acpi_copy_property_array_u8(const union acpi_object *items, u8 *val,
850                                        size_t nval)
851 {
852         int i;
853
854         for (i = 0; i < nval; i++) {
855                 if (items[i].type != ACPI_TYPE_INTEGER)
856                         return -EPROTO;
857                 if (items[i].integer.value > U8_MAX)
858                         return -EOVERFLOW;
859
860                 val[i] = items[i].integer.value;
861         }
862         return 0;
863 }
864
865 static int acpi_copy_property_array_u16(const union acpi_object *items,
866                                         u16 *val, size_t nval)
867 {
868         int i;
869
870         for (i = 0; i < nval; i++) {
871                 if (items[i].type != ACPI_TYPE_INTEGER)
872                         return -EPROTO;
873                 if (items[i].integer.value > U16_MAX)
874                         return -EOVERFLOW;
875
876                 val[i] = items[i].integer.value;
877         }
878         return 0;
879 }
880
881 static int acpi_copy_property_array_u32(const union acpi_object *items,
882                                         u32 *val, size_t nval)
883 {
884         int i;
885
886         for (i = 0; i < nval; i++) {
887                 if (items[i].type != ACPI_TYPE_INTEGER)
888                         return -EPROTO;
889                 if (items[i].integer.value > U32_MAX)
890                         return -EOVERFLOW;
891
892                 val[i] = items[i].integer.value;
893         }
894         return 0;
895 }
896
897 static int acpi_copy_property_array_u64(const union acpi_object *items,
898                                         u64 *val, size_t nval)
899 {
900         int i;
901
902         for (i = 0; i < nval; i++) {
903                 if (items[i].type != ACPI_TYPE_INTEGER)
904                         return -EPROTO;
905
906                 val[i] = items[i].integer.value;
907         }
908         return 0;
909 }
910
911 static int acpi_copy_property_array_string(const union acpi_object *items,
912                                            char **val, size_t nval)
913 {
914         int i;
915
916         for (i = 0; i < nval; i++) {
917                 if (items[i].type != ACPI_TYPE_STRING)
918                         return -EPROTO;
919
920                 val[i] = items[i].string.pointer;
921         }
922         return nval;
923 }
924
925 static int acpi_data_prop_read(const struct acpi_device_data *data,
926                                const char *propname,
927                                enum dev_prop_type proptype,
928                                void *val, size_t nval)
929 {
930         const union acpi_object *obj;
931         const union acpi_object *items;
932         int ret;
933
934         if (nval == 1 || !val) {
935                 ret = acpi_data_prop_read_single(data, propname, proptype, val);
936                 /*
937                  * The overflow error means that the property is there and it is
938                  * single-value, but its type does not match, so return.
939                  */
940                 if (ret >= 0 || ret == -EOVERFLOW)
941                         return ret;
942
943                 /*
944                  * Reading this property as a single-value one failed, but its
945                  * value may still be represented as one-element array, so
946                  * continue.
947                  */
948         }
949
950         ret = acpi_data_get_property_array(data, propname, ACPI_TYPE_ANY, &obj);
951         if (ret)
952                 return ret;
953
954         if (!val)
955                 return obj->package.count;
956
957         if (proptype != DEV_PROP_STRING && nval > obj->package.count)
958                 return -EOVERFLOW;
959         if (nval == 0)
960                 return -EINVAL;
961
962         items = obj->package.elements;
963
964         switch (proptype) {
965         case DEV_PROP_U8:
966                 ret = acpi_copy_property_array_u8(items, (u8 *)val, nval);
967                 break;
968         case DEV_PROP_U16:
969                 ret = acpi_copy_property_array_u16(items, (u16 *)val, nval);
970                 break;
971         case DEV_PROP_U32:
972                 ret = acpi_copy_property_array_u32(items, (u32 *)val, nval);
973                 break;
974         case DEV_PROP_U64:
975                 ret = acpi_copy_property_array_u64(items, (u64 *)val, nval);
976                 break;
977         case DEV_PROP_STRING:
978                 ret = acpi_copy_property_array_string(
979                         items, (char **)val,
980                         min_t(u32, nval, obj->package.count));
981                 break;
982         default:
983                 ret = -EINVAL;
984                 break;
985         }
986         return ret;
987 }
988
989 /**
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.
996  *
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.
1000  */
1001 static 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)
1004 {
1005         return acpi_data_prop_read(acpi_device_data_of_node(fwnode),
1006                                    propname, proptype, val, nval);
1007 }
1008
1009 /**
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.
1013  */
1014 struct fwnode_handle *acpi_get_next_subnode(const struct fwnode_handle *fwnode,
1015                                             struct fwnode_handle *child)
1016 {
1017         const struct acpi_device *adev = to_acpi_device_node(fwnode);
1018         const struct list_head *head;
1019         struct list_head *next;
1020
1021         if ((!child || is_acpi_device_node(child)) && adev) {
1022                 struct acpi_device *child_adev;
1023
1024                 head = &adev->children;
1025                 if (list_empty(head))
1026                         goto nondev;
1027
1028                 if (child) {
1029                         adev = to_acpi_device_node(child);
1030                         next = adev->node.next;
1031                         if (next == head) {
1032                                 child = NULL;
1033                                 goto nondev;
1034                         }
1035                         child_adev = list_entry(next, struct acpi_device, node);
1036                 } else {
1037                         child_adev = list_first_entry(head, struct acpi_device,
1038                                                       node);
1039                 }
1040                 return acpi_fwnode_handle(child_adev);
1041         }
1042
1043  nondev:
1044         if (!child || is_acpi_data_node(child)) {
1045                 const struct acpi_data_node *data = to_acpi_data_node(fwnode);
1046                 struct acpi_data_node *dn;
1047
1048                 /*
1049                  * We can have a combination of device and data nodes, e.g. with
1050                  * hierarchical _DSD properties. Make sure the adev pointer is
1051                  * restored before going through data nodes, otherwise we will
1052                  * be looking for data_nodes below the last device found instead
1053                  * of the common fwnode shared by device_nodes and data_nodes.
1054                  */
1055                 adev = to_acpi_device_node(fwnode);
1056                 if (adev)
1057                         head = &adev->data.subnodes;
1058                 else if (data)
1059                         head = &data->data.subnodes;
1060                 else
1061                         return NULL;
1062
1063                 if (list_empty(head))
1064                         return NULL;
1065
1066                 if (child) {
1067                         dn = to_acpi_data_node(child);
1068                         next = dn->sibling.next;
1069                         if (next == head)
1070                                 return NULL;
1071
1072                         dn = list_entry(next, struct acpi_data_node, sibling);
1073                 } else {
1074                         dn = list_first_entry(head, struct acpi_data_node, sibling);
1075                 }
1076                 return &dn->fwnode;
1077         }
1078         return NULL;
1079 }
1080
1081 /**
1082  * acpi_node_get_parent - Return parent fwnode of this fwnode
1083  * @fwnode: Firmware node whose parent to get
1084  *
1085  * Returns parent node of an ACPI device or data firmware node or %NULL if
1086  * not available.
1087  */
1088 static struct fwnode_handle *
1089 acpi_node_get_parent(const struct fwnode_handle *fwnode)
1090 {
1091         if (is_acpi_data_node(fwnode)) {
1092                 /* All data nodes have parent pointer so just return that */
1093                 return to_acpi_data_node(fwnode)->parent;
1094         }
1095         if (is_acpi_device_node(fwnode)) {
1096                 struct device *dev = to_acpi_device_node(fwnode)->dev.parent;
1097
1098                 if (dev)
1099                         return acpi_fwnode_handle(to_acpi_device(dev));
1100         }
1101
1102         return NULL;
1103 }
1104
1105 /*
1106  * Return true if the node is an ACPI graph node. Called on either ports
1107  * or endpoints.
1108  */
1109 static bool is_acpi_graph_node(struct fwnode_handle *fwnode,
1110                                const char *str)
1111 {
1112         unsigned int len = strlen(str);
1113         const char *name;
1114
1115         if (!len || !is_acpi_data_node(fwnode))
1116                 return false;
1117
1118         name = to_acpi_data_node(fwnode)->name;
1119
1120         return (fwnode_property_present(fwnode, "reg") &&
1121                 !strncmp(name, str, len) && name[len] == '@') ||
1122                 fwnode_property_present(fwnode, str);
1123 }
1124
1125 /**
1126  * acpi_graph_get_next_endpoint - Get next endpoint ACPI firmware node
1127  * @fwnode: Pointer to the parent firmware node
1128  * @prev: Previous endpoint node or %NULL to get the first
1129  *
1130  * Looks up next endpoint ACPI firmware node below a given @fwnode. Returns
1131  * %NULL if there is no next endpoint or in case of error. In case of success
1132  * the next endpoint is returned.
1133  */
1134 static struct fwnode_handle *acpi_graph_get_next_endpoint(
1135         const struct fwnode_handle *fwnode, struct fwnode_handle *prev)
1136 {
1137         struct fwnode_handle *port = NULL;
1138         struct fwnode_handle *endpoint;
1139
1140         if (!prev) {
1141                 do {
1142                         port = fwnode_get_next_child_node(fwnode, port);
1143                         /*
1144                          * The names of the port nodes begin with "port@"
1145                          * followed by the number of the port node and they also
1146                          * have a "reg" property that also has the number of the
1147                          * port node. For compatibility reasons a node is also
1148                          * recognised as a port node from the "port" property.
1149                          */
1150                         if (is_acpi_graph_node(port, "port"))
1151                                 break;
1152                 } while (port);
1153         } else {
1154                 port = fwnode_get_parent(prev);
1155         }
1156
1157         if (!port)
1158                 return NULL;
1159
1160         endpoint = fwnode_get_next_child_node(port, prev);
1161         while (!endpoint) {
1162                 port = fwnode_get_next_child_node(fwnode, port);
1163                 if (!port)
1164                         break;
1165                 if (is_acpi_graph_node(port, "port"))
1166                         endpoint = fwnode_get_next_child_node(port, NULL);
1167         }
1168
1169         /*
1170          * The names of the endpoint nodes begin with "endpoint@" followed by
1171          * the number of the endpoint node and they also have a "reg" property
1172          * that also has the number of the endpoint node. For compatibility
1173          * reasons a node is also recognised as an endpoint node from the
1174          * "endpoint" property.
1175          */
1176         if (!is_acpi_graph_node(endpoint, "endpoint"))
1177                 return NULL;
1178
1179         return endpoint;
1180 }
1181
1182 /**
1183  * acpi_graph_get_child_prop_value - Return a child with a given property value
1184  * @fwnode: device fwnode
1185  * @prop_name: The name of the property to look for
1186  * @val: the desired property value
1187  *
1188  * Return the port node corresponding to a given port number. Returns
1189  * the child node on success, NULL otherwise.
1190  */
1191 static struct fwnode_handle *acpi_graph_get_child_prop_value(
1192         const struct fwnode_handle *fwnode, const char *prop_name,
1193         unsigned int val)
1194 {
1195         struct fwnode_handle *child;
1196
1197         fwnode_for_each_child_node(fwnode, child) {
1198                 u32 nr;
1199
1200                 if (fwnode_property_read_u32(child, prop_name, &nr))
1201                         continue;
1202
1203                 if (val == nr)
1204                         return child;
1205         }
1206
1207         return NULL;
1208 }
1209
1210
1211 /**
1212  * acpi_graph_get_remote_endpoint - Parses and returns remote end of an endpoint
1213  * @__fwnode: Endpoint firmware node pointing to a remote device
1214  *
1215  * Returns the remote endpoint corresponding to @__fwnode. NULL on error.
1216  */
1217 static struct fwnode_handle *
1218 acpi_graph_get_remote_endpoint(const struct fwnode_handle *__fwnode)
1219 {
1220         struct fwnode_handle *fwnode;
1221         unsigned int port_nr, endpoint_nr;
1222         struct fwnode_reference_args args;
1223         int ret;
1224
1225         memset(&args, 0, sizeof(args));
1226         ret = acpi_node_get_property_reference(__fwnode, "remote-endpoint", 0,
1227                                                &args);
1228         if (ret)
1229                 return NULL;
1230
1231         /* Direct endpoint reference? */
1232         if (!is_acpi_device_node(args.fwnode))
1233                 return args.nargs ? NULL : args.fwnode;
1234
1235         /*
1236          * Always require two arguments with the reference: port and
1237          * endpoint indices.
1238          */
1239         if (args.nargs != 2)
1240                 return NULL;
1241
1242         fwnode = args.fwnode;
1243         port_nr = args.args[0];
1244         endpoint_nr = args.args[1];
1245
1246         fwnode = acpi_graph_get_child_prop_value(fwnode, "port", port_nr);
1247
1248         return acpi_graph_get_child_prop_value(fwnode, "endpoint", endpoint_nr);
1249 }
1250
1251 static bool acpi_fwnode_device_is_available(const struct fwnode_handle *fwnode)
1252 {
1253         if (!is_acpi_device_node(fwnode))
1254                 return false;
1255
1256         return acpi_device_is_present(to_acpi_device_node(fwnode));
1257 }
1258
1259 static bool acpi_fwnode_property_present(const struct fwnode_handle *fwnode,
1260                                          const char *propname)
1261 {
1262         return !acpi_node_prop_get(fwnode, propname, NULL);
1263 }
1264
1265 static int
1266 acpi_fwnode_property_read_int_array(const struct fwnode_handle *fwnode,
1267                                     const char *propname,
1268                                     unsigned int elem_size, void *val,
1269                                     size_t nval)
1270 {
1271         enum dev_prop_type type;
1272
1273         switch (elem_size) {
1274         case sizeof(u8):
1275                 type = DEV_PROP_U8;
1276                 break;
1277         case sizeof(u16):
1278                 type = DEV_PROP_U16;
1279                 break;
1280         case sizeof(u32):
1281                 type = DEV_PROP_U32;
1282                 break;
1283         case sizeof(u64):
1284                 type = DEV_PROP_U64;
1285                 break;
1286         default:
1287                 return -ENXIO;
1288         }
1289
1290         return acpi_node_prop_read(fwnode, propname, type, val, nval);
1291 }
1292
1293 static int
1294 acpi_fwnode_property_read_string_array(const struct fwnode_handle *fwnode,
1295                                        const char *propname, const char **val,
1296                                        size_t nval)
1297 {
1298         return acpi_node_prop_read(fwnode, propname, DEV_PROP_STRING,
1299                                    val, nval);
1300 }
1301
1302 static int
1303 acpi_fwnode_get_reference_args(const struct fwnode_handle *fwnode,
1304                                const char *prop, const char *nargs_prop,
1305                                unsigned int args_count, unsigned int index,
1306                                struct fwnode_reference_args *args)
1307 {
1308         return __acpi_node_get_property_reference(fwnode, prop, index,
1309                                                   args_count, args);
1310 }
1311
1312 static const char *acpi_fwnode_get_name(const struct fwnode_handle *fwnode)
1313 {
1314         const struct acpi_device *adev;
1315         struct fwnode_handle *parent;
1316
1317         /* Is this the root node? */
1318         parent = fwnode_get_parent(fwnode);
1319         if (!parent)
1320                 return "\\";
1321
1322         fwnode_handle_put(parent);
1323
1324         if (is_acpi_data_node(fwnode)) {
1325                 const struct acpi_data_node *dn = to_acpi_data_node(fwnode);
1326
1327                 return dn->name;
1328         }
1329
1330         adev = to_acpi_device_node(fwnode);
1331         if (WARN_ON(!adev))
1332                 return NULL;
1333
1334         return acpi_device_bid(adev);
1335 }
1336
1337 static const char *
1338 acpi_fwnode_get_name_prefix(const struct fwnode_handle *fwnode)
1339 {
1340         struct fwnode_handle *parent;
1341
1342         /* Is this the root node? */
1343         parent = fwnode_get_parent(fwnode);
1344         if (!parent)
1345                 return "";
1346
1347         /* Is this 2nd node from the root? */
1348         parent = fwnode_get_next_parent(parent);
1349         if (!parent)
1350                 return "";
1351
1352         fwnode_handle_put(parent);
1353
1354         /* ACPI device or data node. */
1355         return ".";
1356 }
1357
1358 static struct fwnode_handle *
1359 acpi_fwnode_get_parent(struct fwnode_handle *fwnode)
1360 {
1361         return acpi_node_get_parent(fwnode);
1362 }
1363
1364 static int acpi_fwnode_graph_parse_endpoint(const struct fwnode_handle *fwnode,
1365                                             struct fwnode_endpoint *endpoint)
1366 {
1367         struct fwnode_handle *port_fwnode = fwnode_get_parent(fwnode);
1368
1369         endpoint->local_fwnode = fwnode;
1370
1371         if (fwnode_property_read_u32(port_fwnode, "reg", &endpoint->port))
1372                 fwnode_property_read_u32(port_fwnode, "port", &endpoint->port);
1373         if (fwnode_property_read_u32(fwnode, "reg", &endpoint->id))
1374                 fwnode_property_read_u32(fwnode, "endpoint", &endpoint->id);
1375
1376         return 0;
1377 }
1378
1379 static const void *
1380 acpi_fwnode_device_get_match_data(const struct fwnode_handle *fwnode,
1381                                   const struct device *dev)
1382 {
1383         return acpi_device_get_match_data(dev);
1384 }
1385
1386 #define DECLARE_ACPI_FWNODE_OPS(ops) \
1387         const struct fwnode_operations ops = {                          \
1388                 .device_is_available = acpi_fwnode_device_is_available, \
1389                 .device_get_match_data = acpi_fwnode_device_get_match_data, \
1390                 .property_present = acpi_fwnode_property_present,       \
1391                 .property_read_int_array =                              \
1392                         acpi_fwnode_property_read_int_array,            \
1393                 .property_read_string_array =                           \
1394                         acpi_fwnode_property_read_string_array,         \
1395                 .get_parent = acpi_node_get_parent,                     \
1396                 .get_next_child_node = acpi_get_next_subnode,           \
1397                 .get_named_child_node = acpi_fwnode_get_named_child_node, \
1398                 .get_name = acpi_fwnode_get_name,                       \
1399                 .get_name_prefix = acpi_fwnode_get_name_prefix,         \
1400                 .get_reference_args = acpi_fwnode_get_reference_args,   \
1401                 .graph_get_next_endpoint =                              \
1402                         acpi_graph_get_next_endpoint,                   \
1403                 .graph_get_remote_endpoint =                            \
1404                         acpi_graph_get_remote_endpoint,                 \
1405                 .graph_get_port_parent = acpi_fwnode_get_parent,        \
1406                 .graph_parse_endpoint = acpi_fwnode_graph_parse_endpoint, \
1407         };                                                              \
1408         EXPORT_SYMBOL_GPL(ops)
1409
1410 DECLARE_ACPI_FWNODE_OPS(acpi_device_fwnode_ops);
1411 DECLARE_ACPI_FWNODE_OPS(acpi_data_fwnode_ops);
1412 const struct fwnode_operations acpi_static_fwnode_ops;
1413
1414 bool is_acpi_device_node(const struct fwnode_handle *fwnode)
1415 {
1416         return !IS_ERR_OR_NULL(fwnode) &&
1417                 fwnode->ops == &acpi_device_fwnode_ops;
1418 }
1419 EXPORT_SYMBOL(is_acpi_device_node);
1420
1421 bool is_acpi_data_node(const struct fwnode_handle *fwnode)
1422 {
1423         return !IS_ERR_OR_NULL(fwnode) && fwnode->ops == &acpi_data_fwnode_ops;
1424 }
1425 EXPORT_SYMBOL(is_acpi_data_node);