PCI/ACPI: Guard ARM64-specific mcfg_quirks
[platform/kernel/linux-rpi.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 bool 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_free_device_properties(struct list_head *list)
437 {
438         struct acpi_device_properties *props, *tmp;
439
440         list_for_each_entry_safe(props, tmp, list, list) {
441                 list_del(&props->list);
442                 kfree(props);
443         }
444 }
445
446 static void acpi_destroy_nondev_subnodes(struct list_head *list)
447 {
448         struct acpi_data_node *dn, *next;
449
450         if (list_empty(list))
451                 return;
452
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);
459                 kfree(dn);
460         }
461 }
462
463 void acpi_free_properties(struct acpi_device *adev)
464 {
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);
470 }
471
472 /**
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)
478  *
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.
481  *
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.
484  *
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.
489  */
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)
493 {
494         const struct acpi_device_properties *props;
495
496         if (!data || !name)
497                 return -EINVAL;
498
499         if (!data->pointer || list_empty(&data->properties))
500                 return -EINVAL;
501
502         list_for_each_entry(props, &data->properties, list) {
503                 const union acpi_object *properties;
504                 unsigned int i;
505
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;
510
511                         property = &properties->package.elements[i];
512
513                         propname = &property->package.elements[0];
514                         propvalue = &property->package.elements[1];
515
516                         if (!strcmp(name, propname->string.pointer)) {
517                                 if (type != ACPI_TYPE_ANY &&
518                                     propvalue->type != type)
519                                         return -EPROTO;
520                                 if (obj)
521                                         *obj = propvalue;
522
523                                 return 0;
524                         }
525                 }
526         }
527         return -EINVAL;
528 }
529
530 /**
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).
536  */
537 int acpi_dev_get_property(const struct acpi_device *adev, const char *name,
538                           acpi_object_type type, const union acpi_object **obj)
539 {
540         return adev ? acpi_data_get_property(&adev->data, name, type, obj) : -EINVAL;
541 }
542 EXPORT_SYMBOL_GPL(acpi_dev_get_property);
543
544 static const struct acpi_device_data *
545 acpi_device_data_of_node(const struct fwnode_handle *fwnode)
546 {
547         if (is_acpi_device_node(fwnode)) {
548                 const struct acpi_device *adev = to_acpi_device_node(fwnode);
549                 return &adev->data;
550         } else if (is_acpi_data_node(fwnode)) {
551                 const struct acpi_data_node *dn = to_acpi_data_node(fwnode);
552                 return &dn->data;
553         }
554         return NULL;
555 }
556
557 /**
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).
562  */
563 int acpi_node_prop_get(const struct fwnode_handle *fwnode,
564                        const char *propname, void **valptr)
565 {
566         return acpi_data_get_property(acpi_device_data_of_node(fwnode),
567                                       propname, ACPI_TYPE_ANY,
568                                       (const union acpi_object **)valptr);
569 }
570
571 /**
572  * acpi_data_get_property_array - return an ACPI array property with given name
573  * @data: 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)
577  *
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.
580  *
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.
583  *
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.
589  */
590 static int acpi_data_get_property_array(const struct acpi_device_data *data,
591                                         const char *name,
592                                         acpi_object_type type,
593                                         const union acpi_object **obj)
594 {
595         const union acpi_object *prop;
596         int ret, i;
597
598         ret = acpi_data_get_property(data, name, ACPI_TYPE_PACKAGE, &prop);
599         if (ret)
600                 return ret;
601
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)
606                                 return -EPROTO;
607         }
608         if (obj)
609                 *obj = prop;
610
611         return 0;
612 }
613
614 static struct fwnode_handle *
615 acpi_fwnode_get_named_child_node(const struct fwnode_handle *fwnode,
616                                  const char *childname)
617 {
618         struct fwnode_handle *child;
619
620         fwnode_for_each_child_node(fwnode, child) {
621                 if (is_acpi_data_node(child)) {
622                         if (acpi_data_node_match(child, childname))
623                                 return child;
624                         continue;
625                 }
626
627                 if (!strncmp(acpi_device_bid(to_acpi_device_node(child)),
628                              childname, ACPI_NAMESEG_SIZE))
629                         return child;
630         }
631
632         return NULL;
633 }
634
635 /**
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
642  *
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.
647  *
648  * If there's more than one reference in the property value package, @index is
649  * used to select the one to return.
650  *
651  * It is possible to leave holes in the property value set like in the
652  * example below:
653  *
654  * Package () {
655  *     "cs-gpios",
656  *     Package () {
657  *        ^GPIO, 19, 0, 0,
658  *        ^GPIO, 20, 0, 0,
659  *        0,
660  *        ^GPIO, 21, 0, 0,
661  *     }
662  * }
663  *
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.
667  *
668  * Return: %0 on success, negative error code on failure.
669  */
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)
673 {
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;
678         int ret, idx = 0;
679
680         data = acpi_device_data_of_node(fwnode);
681         if (!data)
682                 return -ENOENT;
683
684         ret = acpi_data_get_property(data, propname, ACPI_TYPE_ANY, &obj);
685         if (ret)
686                 return ret == -EINVAL ? -ENOENT : -EINVAL;
687
688         /*
689          * The simplest case is when the value is a single reference.  Just
690          * return that reference then.
691          */
692         if (obj->type == ACPI_TYPE_LOCAL_REFERENCE) {
693                 if (index)
694                         return -ENOENT;
695
696                 ret = acpi_bus_get_device(obj->reference.handle, &device);
697                 if (ret)
698                         return ret == -ENODEV ? -EINVAL : ret;
699
700                 args->fwnode = acpi_fwnode_handle(device);
701                 args->nargs = 0;
702                 return 0;
703         }
704
705         /*
706          * If it is not a single reference, then it is a package of
707          * references followed by number of ints as follows:
708          *
709          *  Package () { REF, INT, REF, INT, INT }
710          *
711          * The index argument is then used to determine which reference
712          * the caller wants (along with the arguments).
713          */
714         if (obj->type != ACPI_TYPE_PACKAGE)
715                 return -EINVAL;
716         if (index >= obj->package.count)
717                 return -ENOENT;
718
719         element = obj->package.elements;
720         end = element + obj->package.count;
721
722         while (element < end) {
723                 u32 nargs, i;
724
725                 if (element->type == ACPI_TYPE_LOCAL_REFERENCE) {
726                         struct fwnode_handle *ref_fwnode;
727
728                         ret = acpi_bus_get_device(element->reference.handle,
729                                                   &device);
730                         if (ret)
731                                 return -EINVAL;
732
733                         nargs = 0;
734                         element++;
735
736                         /*
737                          * Find the referred data extension node under the
738                          * referred device node.
739                          */
740                         for (ref_fwnode = acpi_fwnode_handle(device);
741                              element < end && element->type == ACPI_TYPE_STRING;
742                              element++) {
743                                 ref_fwnode = acpi_fwnode_get_named_child_node(
744                                         ref_fwnode, element->string.pointer);
745                                 if (!ref_fwnode)
746                                         return -EINVAL;
747                         }
748
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;
752
753                                 if (type == ACPI_TYPE_INTEGER)
754                                         nargs++;
755                                 else if (type == ACPI_TYPE_LOCAL_REFERENCE)
756                                         break;
757                                 else
758                                         return -EINVAL;
759                         }
760
761                         if (nargs > NR_FWNODE_REFERENCE_ARGS)
762                                 return -EINVAL;
763
764                         if (idx == index) {
765                                 args->fwnode = ref_fwnode;
766                                 args->nargs = nargs;
767                                 for (i = 0; i < nargs; i++)
768                                         args->args[i] = element[i].integer.value;
769
770                                 return 0;
771                         }
772
773                         element += nargs;
774                 } else if (element->type == ACPI_TYPE_INTEGER) {
775                         if (idx == index)
776                                 return -ENOENT;
777                         element++;
778                 } else {
779                         return -EINVAL;
780                 }
781
782                 idx++;
783         }
784
785         return -ENOENT;
786 }
787 EXPORT_SYMBOL_GPL(__acpi_node_get_property_reference);
788
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)
792 {
793         const union acpi_object *obj;
794         int ret;
795
796         if (proptype >= DEV_PROP_U8 && proptype <= DEV_PROP_U64) {
797                 ret = acpi_data_get_property(data, propname, ACPI_TYPE_INTEGER, &obj);
798                 if (ret)
799                         return ret;
800
801                 switch (proptype) {
802                 case DEV_PROP_U8:
803                         if (obj->integer.value > U8_MAX)
804                                 return -EOVERFLOW;
805
806                         if (val)
807                                 *(u8 *)val = obj->integer.value;
808
809                         break;
810                 case DEV_PROP_U16:
811                         if (obj->integer.value > U16_MAX)
812                                 return -EOVERFLOW;
813
814                         if (val)
815                                 *(u16 *)val = obj->integer.value;
816
817                         break;
818                 case DEV_PROP_U32:
819                         if (obj->integer.value > U32_MAX)
820                                 return -EOVERFLOW;
821
822                         if (val)
823                                 *(u32 *)val = obj->integer.value;
824
825                         break;
826                 default:
827                         if (val)
828                                 *(u64 *)val = obj->integer.value;
829
830                         break;
831                 }
832
833                 if (!val)
834                         return 1;
835         } else if (proptype == DEV_PROP_STRING) {
836                 ret = acpi_data_get_property(data, propname, ACPI_TYPE_STRING, &obj);
837                 if (ret)
838                         return ret;
839
840                 if (val)
841                         *(char **)val = obj->string.pointer;
842
843                 return 1;
844         } else {
845                 ret = -EINVAL;
846         }
847         return ret;
848 }
849
850 static int acpi_copy_property_array_u8(const union acpi_object *items, u8 *val,
851                                        size_t nval)
852 {
853         int i;
854
855         for (i = 0; i < nval; i++) {
856                 if (items[i].type != ACPI_TYPE_INTEGER)
857                         return -EPROTO;
858                 if (items[i].integer.value > U8_MAX)
859                         return -EOVERFLOW;
860
861                 val[i] = items[i].integer.value;
862         }
863         return 0;
864 }
865
866 static int acpi_copy_property_array_u16(const union acpi_object *items,
867                                         u16 *val, size_t nval)
868 {
869         int i;
870
871         for (i = 0; i < nval; i++) {
872                 if (items[i].type != ACPI_TYPE_INTEGER)
873                         return -EPROTO;
874                 if (items[i].integer.value > U16_MAX)
875                         return -EOVERFLOW;
876
877                 val[i] = items[i].integer.value;
878         }
879         return 0;
880 }
881
882 static int acpi_copy_property_array_u32(const union acpi_object *items,
883                                         u32 *val, size_t nval)
884 {
885         int i;
886
887         for (i = 0; i < nval; i++) {
888                 if (items[i].type != ACPI_TYPE_INTEGER)
889                         return -EPROTO;
890                 if (items[i].integer.value > U32_MAX)
891                         return -EOVERFLOW;
892
893                 val[i] = items[i].integer.value;
894         }
895         return 0;
896 }
897
898 static int acpi_copy_property_array_u64(const union acpi_object *items,
899                                         u64 *val, size_t nval)
900 {
901         int i;
902
903         for (i = 0; i < nval; i++) {
904                 if (items[i].type != ACPI_TYPE_INTEGER)
905                         return -EPROTO;
906
907                 val[i] = items[i].integer.value;
908         }
909         return 0;
910 }
911
912 static int acpi_copy_property_array_string(const union acpi_object *items,
913                                            char **val, size_t nval)
914 {
915         int i;
916
917         for (i = 0; i < nval; i++) {
918                 if (items[i].type != ACPI_TYPE_STRING)
919                         return -EPROTO;
920
921                 val[i] = items[i].string.pointer;
922         }
923         return nval;
924 }
925
926 static int acpi_data_prop_read(const struct acpi_device_data *data,
927                                const char *propname,
928                                enum dev_prop_type proptype,
929                                void *val, size_t nval)
930 {
931         const union acpi_object *obj;
932         const union acpi_object *items;
933         int ret;
934
935         if (nval == 1 || !val) {
936                 ret = acpi_data_prop_read_single(data, propname, proptype, val);
937                 /*
938                  * The overflow error means that the property is there and it is
939                  * single-value, but its type does not match, so return.
940                  */
941                 if (ret >= 0 || ret == -EOVERFLOW)
942                         return ret;
943
944                 /*
945                  * Reading this property as a single-value one failed, but its
946                  * value may still be represented as one-element array, so
947                  * continue.
948                  */
949         }
950
951         ret = acpi_data_get_property_array(data, propname, ACPI_TYPE_ANY, &obj);
952         if (ret)
953                 return ret;
954
955         if (!val)
956                 return obj->package.count;
957
958         if (proptype != DEV_PROP_STRING && nval > obj->package.count)
959                 return -EOVERFLOW;
960         else if (nval <= 0)
961                 return -EINVAL;
962
963         items = obj->package.elements;
964
965         switch (proptype) {
966         case DEV_PROP_U8:
967                 ret = acpi_copy_property_array_u8(items, (u8 *)val, nval);
968                 break;
969         case DEV_PROP_U16:
970                 ret = acpi_copy_property_array_u16(items, (u16 *)val, nval);
971                 break;
972         case DEV_PROP_U32:
973                 ret = acpi_copy_property_array_u32(items, (u32 *)val, nval);
974                 break;
975         case DEV_PROP_U64:
976                 ret = acpi_copy_property_array_u64(items, (u64 *)val, nval);
977                 break;
978         case DEV_PROP_STRING:
979                 ret = acpi_copy_property_array_string(
980                         items, (char **)val,
981                         min_t(u32, nval, obj->package.count));
982                 break;
983         default:
984                 ret = -EINVAL;
985                 break;
986         }
987         return ret;
988 }
989
990 /**
991  * acpi_node_prop_read - retrieve the value of an ACPI property with given name.
992  * @fwnode: Firmware node to get the property from.
993  * @propname: Name of the property.
994  * @proptype: Expected property type.
995  * @val: Location to store the property value (if not %NULL).
996  * @nval: Size of the array pointed to by @val.
997  *
998  * If @val is %NULL, return the number of array elements comprising the value
999  * of the property.  Otherwise, read at most @nval values to the array at the
1000  * location pointed to by @val.
1001  */
1002 static int acpi_node_prop_read(const struct fwnode_handle *fwnode,
1003                                const char *propname, enum dev_prop_type proptype,
1004                                void *val, size_t nval)
1005 {
1006         return acpi_data_prop_read(acpi_device_data_of_node(fwnode),
1007                                    propname, proptype, val, nval);
1008 }
1009
1010 /**
1011  * acpi_get_next_subnode - Return the next child node handle for a fwnode
1012  * @fwnode: Firmware node to find the next child node for.
1013  * @child: Handle to one of the device's child nodes or a null handle.
1014  */
1015 struct fwnode_handle *acpi_get_next_subnode(const struct fwnode_handle *fwnode,
1016                                             struct fwnode_handle *child)
1017 {
1018         const struct acpi_device *adev = to_acpi_device_node(fwnode);
1019         const struct list_head *head;
1020         struct list_head *next;
1021
1022         if (!child || is_acpi_device_node(child)) {
1023                 struct acpi_device *child_adev;
1024
1025                 if (adev)
1026                         head = &adev->children;
1027                 else
1028                         goto nondev;
1029
1030                 if (list_empty(head))
1031                         goto nondev;
1032
1033                 if (child) {
1034                         adev = to_acpi_device_node(child);
1035                         next = adev->node.next;
1036                         if (next == head) {
1037                                 child = NULL;
1038                                 goto nondev;
1039                         }
1040                         child_adev = list_entry(next, struct acpi_device, node);
1041                 } else {
1042                         child_adev = list_first_entry(head, struct acpi_device,
1043                                                       node);
1044                 }
1045                 return acpi_fwnode_handle(child_adev);
1046         }
1047
1048  nondev:
1049         if (!child || is_acpi_data_node(child)) {
1050                 const struct acpi_data_node *data = to_acpi_data_node(fwnode);
1051                 struct acpi_data_node *dn;
1052
1053                 /*
1054                  * We can have a combination of device and data nodes, e.g. with
1055                  * hierarchical _DSD properties. Make sure the adev pointer is
1056                  * restored before going through data nodes, otherwise we will
1057                  * be looking for data_nodes below the last device found instead
1058                  * of the common fwnode shared by device_nodes and data_nodes.
1059                  */
1060                 adev = to_acpi_device_node(fwnode);
1061                 if (adev)
1062                         head = &adev->data.subnodes;
1063                 else if (data)
1064                         head = &data->data.subnodes;
1065                 else
1066                         return NULL;
1067
1068                 if (list_empty(head))
1069                         return NULL;
1070
1071                 if (child) {
1072                         dn = to_acpi_data_node(child);
1073                         next = dn->sibling.next;
1074                         if (next == head)
1075                                 return NULL;
1076
1077                         dn = list_entry(next, struct acpi_data_node, sibling);
1078                 } else {
1079                         dn = list_first_entry(head, struct acpi_data_node, sibling);
1080                 }
1081                 return &dn->fwnode;
1082         }
1083         return NULL;
1084 }
1085
1086 /**
1087  * acpi_node_get_parent - Return parent fwnode of this fwnode
1088  * @fwnode: Firmware node whose parent to get
1089  *
1090  * Returns parent node of an ACPI device or data firmware node or %NULL if
1091  * not available.
1092  */
1093 struct fwnode_handle *acpi_node_get_parent(const struct fwnode_handle *fwnode)
1094 {
1095         if (is_acpi_data_node(fwnode)) {
1096                 /* All data nodes have parent pointer so just return that */
1097                 return to_acpi_data_node(fwnode)->parent;
1098         } else if (is_acpi_device_node(fwnode)) {
1099                 struct device *dev = to_acpi_device_node(fwnode)->dev.parent;
1100
1101                 if (dev)
1102                         return acpi_fwnode_handle(to_acpi_device(dev));
1103         }
1104
1105         return NULL;
1106 }
1107
1108 /*
1109  * Return true if the node is an ACPI graph node. Called on either ports
1110  * or endpoints.
1111  */
1112 static bool is_acpi_graph_node(struct fwnode_handle *fwnode,
1113                                const char *str)
1114 {
1115         unsigned int len = strlen(str);
1116         const char *name;
1117
1118         if (!len || !is_acpi_data_node(fwnode))
1119                 return false;
1120
1121         name = to_acpi_data_node(fwnode)->name;
1122
1123         return (fwnode_property_present(fwnode, "reg") &&
1124                 !strncmp(name, str, len) && name[len] == '@') ||
1125                 fwnode_property_present(fwnode, str);
1126 }
1127
1128 /**
1129  * acpi_graph_get_next_endpoint - Get next endpoint ACPI firmware node
1130  * @fwnode: Pointer to the parent firmware node
1131  * @prev: Previous endpoint node or %NULL to get the first
1132  *
1133  * Looks up next endpoint ACPI firmware node below a given @fwnode. Returns
1134  * %NULL if there is no next endpoint or in case of error. In case of success
1135  * the next endpoint is returned.
1136  */
1137 static struct fwnode_handle *acpi_graph_get_next_endpoint(
1138         const struct fwnode_handle *fwnode, struct fwnode_handle *prev)
1139 {
1140         struct fwnode_handle *port = NULL;
1141         struct fwnode_handle *endpoint;
1142
1143         if (!prev) {
1144                 do {
1145                         port = fwnode_get_next_child_node(fwnode, port);
1146                         /*
1147                          * The names of the port nodes begin with "port@"
1148                          * followed by the number of the port node and they also
1149                          * have a "reg" property that also has the number of the
1150                          * port node. For compatibility reasons a node is also
1151                          * recognised as a port node from the "port" property.
1152                          */
1153                         if (is_acpi_graph_node(port, "port"))
1154                                 break;
1155                 } while (port);
1156         } else {
1157                 port = fwnode_get_parent(prev);
1158         }
1159
1160         if (!port)
1161                 return NULL;
1162
1163         endpoint = fwnode_get_next_child_node(port, prev);
1164         while (!endpoint) {
1165                 port = fwnode_get_next_child_node(fwnode, port);
1166                 if (!port)
1167                         break;
1168                 if (is_acpi_graph_node(port, "port"))
1169                         endpoint = fwnode_get_next_child_node(port, NULL);
1170         }
1171
1172         /*
1173          * The names of the endpoint nodes begin with "endpoint@" followed by
1174          * the number of the endpoint node and they also have a "reg" property
1175          * that also has the number of the endpoint node. For compatibility
1176          * reasons a node is also recognised as an endpoint node from the
1177          * "endpoint" property.
1178          */
1179         if (!is_acpi_graph_node(endpoint, "endpoint"))
1180                 return NULL;
1181
1182         return endpoint;
1183 }
1184
1185 /**
1186  * acpi_graph_get_child_prop_value - Return a child with a given property value
1187  * @fwnode: device fwnode
1188  * @prop_name: The name of the property to look for
1189  * @val: the desired property value
1190  *
1191  * Return the port node corresponding to a given port number. Returns
1192  * the child node on success, NULL otherwise.
1193  */
1194 static struct fwnode_handle *acpi_graph_get_child_prop_value(
1195         const struct fwnode_handle *fwnode, const char *prop_name,
1196         unsigned int val)
1197 {
1198         struct fwnode_handle *child;
1199
1200         fwnode_for_each_child_node(fwnode, child) {
1201                 u32 nr;
1202
1203                 if (fwnode_property_read_u32(child, prop_name, &nr))
1204                         continue;
1205
1206                 if (val == nr)
1207                         return child;
1208         }
1209
1210         return NULL;
1211 }
1212
1213
1214 /**
1215  * acpi_graph_get_remote_endpoint - Parses and returns remote end of an endpoint
1216  * @__fwnode: Endpoint firmware node pointing to a remote device
1217  *
1218  * Returns the remote endpoint corresponding to @__fwnode. NULL on error.
1219  */
1220 static struct fwnode_handle *
1221 acpi_graph_get_remote_endpoint(const struct fwnode_handle *__fwnode)
1222 {
1223         struct fwnode_handle *fwnode;
1224         unsigned int port_nr, endpoint_nr;
1225         struct fwnode_reference_args args;
1226         int ret;
1227
1228         memset(&args, 0, sizeof(args));
1229         ret = acpi_node_get_property_reference(__fwnode, "remote-endpoint", 0,
1230                                                &args);
1231         if (ret)
1232                 return NULL;
1233
1234         /* Direct endpoint reference? */
1235         if (!is_acpi_device_node(args.fwnode))
1236                 return args.nargs ? NULL : args.fwnode;
1237
1238         /*
1239          * Always require two arguments with the reference: port and
1240          * endpoint indices.
1241          */
1242         if (args.nargs != 2)
1243                 return NULL;
1244
1245         fwnode = args.fwnode;
1246         port_nr = args.args[0];
1247         endpoint_nr = args.args[1];
1248
1249         fwnode = acpi_graph_get_child_prop_value(fwnode, "port", port_nr);
1250
1251         return acpi_graph_get_child_prop_value(fwnode, "endpoint", endpoint_nr);
1252 }
1253
1254 static bool acpi_fwnode_device_is_available(const struct fwnode_handle *fwnode)
1255 {
1256         if (!is_acpi_device_node(fwnode))
1257                 return false;
1258
1259         return acpi_device_is_present(to_acpi_device_node(fwnode));
1260 }
1261
1262 static bool acpi_fwnode_property_present(const struct fwnode_handle *fwnode,
1263                                          const char *propname)
1264 {
1265         return !acpi_node_prop_get(fwnode, propname, NULL);
1266 }
1267
1268 static int
1269 acpi_fwnode_property_read_int_array(const struct fwnode_handle *fwnode,
1270                                     const char *propname,
1271                                     unsigned int elem_size, void *val,
1272                                     size_t nval)
1273 {
1274         enum dev_prop_type type;
1275
1276         switch (elem_size) {
1277         case sizeof(u8):
1278                 type = DEV_PROP_U8;
1279                 break;
1280         case sizeof(u16):
1281                 type = DEV_PROP_U16;
1282                 break;
1283         case sizeof(u32):
1284                 type = DEV_PROP_U32;
1285                 break;
1286         case sizeof(u64):
1287                 type = DEV_PROP_U64;
1288                 break;
1289         default:
1290                 return -ENXIO;
1291         }
1292
1293         return acpi_node_prop_read(fwnode, propname, type, val, nval);
1294 }
1295
1296 static int
1297 acpi_fwnode_property_read_string_array(const struct fwnode_handle *fwnode,
1298                                        const char *propname, const char **val,
1299                                        size_t nval)
1300 {
1301         return acpi_node_prop_read(fwnode, propname, DEV_PROP_STRING,
1302                                    val, nval);
1303 }
1304
1305 static int
1306 acpi_fwnode_get_reference_args(const struct fwnode_handle *fwnode,
1307                                const char *prop, const char *nargs_prop,
1308                                unsigned int args_count, unsigned int index,
1309                                struct fwnode_reference_args *args)
1310 {
1311         return __acpi_node_get_property_reference(fwnode, prop, index,
1312                                                   args_count, args);
1313 }
1314
1315 static const char *acpi_fwnode_get_name(const struct fwnode_handle *fwnode)
1316 {
1317         const struct acpi_device *adev;
1318         struct fwnode_handle *parent;
1319
1320         /* Is this the root node? */
1321         parent = fwnode_get_parent(fwnode);
1322         if (!parent)
1323                 return "\\";
1324
1325         fwnode_handle_put(parent);
1326
1327         if (is_acpi_data_node(fwnode)) {
1328                 const struct acpi_data_node *dn = to_acpi_data_node(fwnode);
1329
1330                 return dn->name;
1331         }
1332
1333         adev = to_acpi_device_node(fwnode);
1334         if (WARN_ON(!adev))
1335                 return NULL;
1336
1337         return acpi_device_bid(adev);
1338 }
1339
1340 static const char *
1341 acpi_fwnode_get_name_prefix(const struct fwnode_handle *fwnode)
1342 {
1343         struct fwnode_handle *parent;
1344
1345         /* Is this the root node? */
1346         parent = fwnode_get_parent(fwnode);
1347         if (!parent)
1348                 return "";
1349
1350         /* Is this 2nd node from the root? */
1351         parent = fwnode_get_next_parent(parent);
1352         if (!parent)
1353                 return "";
1354
1355         fwnode_handle_put(parent);
1356
1357         /* ACPI device or data node. */
1358         return ".";
1359 }
1360
1361 static struct fwnode_handle *
1362 acpi_fwnode_get_parent(struct fwnode_handle *fwnode)
1363 {
1364         return acpi_node_get_parent(fwnode);
1365 }
1366
1367 static int acpi_fwnode_graph_parse_endpoint(const struct fwnode_handle *fwnode,
1368                                             struct fwnode_endpoint *endpoint)
1369 {
1370         struct fwnode_handle *port_fwnode = fwnode_get_parent(fwnode);
1371
1372         endpoint->local_fwnode = fwnode;
1373
1374         if (fwnode_property_read_u32(port_fwnode, "reg", &endpoint->port))
1375                 fwnode_property_read_u32(port_fwnode, "port", &endpoint->port);
1376         if (fwnode_property_read_u32(fwnode, "reg", &endpoint->id))
1377                 fwnode_property_read_u32(fwnode, "endpoint", &endpoint->id);
1378
1379         return 0;
1380 }
1381
1382 static const void *
1383 acpi_fwnode_device_get_match_data(const struct fwnode_handle *fwnode,
1384                                   const struct device *dev)
1385 {
1386         return acpi_device_get_match_data(dev);
1387 }
1388
1389 #define DECLARE_ACPI_FWNODE_OPS(ops) \
1390         const struct fwnode_operations ops = {                          \
1391                 .device_is_available = acpi_fwnode_device_is_available, \
1392                 .device_get_match_data = acpi_fwnode_device_get_match_data, \
1393                 .property_present = acpi_fwnode_property_present,       \
1394                 .property_read_int_array =                              \
1395                         acpi_fwnode_property_read_int_array,            \
1396                 .property_read_string_array =                           \
1397                         acpi_fwnode_property_read_string_array,         \
1398                 .get_parent = acpi_node_get_parent,                     \
1399                 .get_next_child_node = acpi_get_next_subnode,           \
1400                 .get_named_child_node = acpi_fwnode_get_named_child_node, \
1401                 .get_name = acpi_fwnode_get_name,                       \
1402                 .get_name_prefix = acpi_fwnode_get_name_prefix,         \
1403                 .get_reference_args = acpi_fwnode_get_reference_args,   \
1404                 .graph_get_next_endpoint =                              \
1405                         acpi_graph_get_next_endpoint,                   \
1406                 .graph_get_remote_endpoint =                            \
1407                         acpi_graph_get_remote_endpoint,                 \
1408                 .graph_get_port_parent = acpi_fwnode_get_parent,        \
1409                 .graph_parse_endpoint = acpi_fwnode_graph_parse_endpoint, \
1410         };                                                              \
1411         EXPORT_SYMBOL_GPL(ops)
1412
1413 DECLARE_ACPI_FWNODE_OPS(acpi_device_fwnode_ops);
1414 DECLARE_ACPI_FWNODE_OPS(acpi_data_fwnode_ops);
1415 const struct fwnode_operations acpi_static_fwnode_ops;
1416
1417 bool is_acpi_device_node(const struct fwnode_handle *fwnode)
1418 {
1419         return !IS_ERR_OR_NULL(fwnode) &&
1420                 fwnode->ops == &acpi_device_fwnode_ops;
1421 }
1422 EXPORT_SYMBOL(is_acpi_device_node);
1423
1424 bool is_acpi_data_node(const struct fwnode_handle *fwnode)
1425 {
1426         return !IS_ERR_OR_NULL(fwnode) && fwnode->ops == &acpi_data_fwnode_ops;
1427 }
1428 EXPORT_SYMBOL(is_acpi_data_node);