Loading...
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * ACPI device specific properties support.
4 *
5 * Copyright (C) 2014 - 2023, 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 * Sakari Ailus <sakari.ailus@linux.intel.com>
12 */
13
14#define pr_fmt(fmt) "ACPI: " fmt
15
16#include <linux/acpi.h>
17#include <linux/device.h>
18#include <linux/export.h>
19
20#include "internal.h"
21
22static int acpi_data_get_property_array(const struct acpi_device_data *data,
23 const char *name,
24 acpi_object_type type,
25 const union acpi_object **obj);
26
27/*
28 * The GUIDs here are made equivalent to each other in order to avoid extra
29 * complexity in the properties handling code, with the caveat that the
30 * kernel will accept certain combinations of GUID and properties that are
31 * not defined without a warning. For instance if any of the properties
32 * from different GUID appear in a property list of another, it will be
33 * accepted by the kernel. Firmware validation tools should catch these.
34 */
35static const guid_t prp_guids[] = {
36 /* ACPI _DSD device properties GUID: daffd814-6eba-4d8c-8a91-bc9bbf4aa301 */
37 GUID_INIT(0xdaffd814, 0x6eba, 0x4d8c,
38 0x8a, 0x91, 0xbc, 0x9b, 0xbf, 0x4a, 0xa3, 0x01),
39 /* Hotplug in D3 GUID: 6211e2c0-58a3-4af3-90e1-927a4e0c55a4 */
40 GUID_INIT(0x6211e2c0, 0x58a3, 0x4af3,
41 0x90, 0xe1, 0x92, 0x7a, 0x4e, 0x0c, 0x55, 0xa4),
42 /* External facing port GUID: efcc06cc-73ac-4bc3-bff0-76143807c389 */
43 GUID_INIT(0xefcc06cc, 0x73ac, 0x4bc3,
44 0xbf, 0xf0, 0x76, 0x14, 0x38, 0x07, 0xc3, 0x89),
45 /* Thunderbolt GUID for IMR_VALID: c44d002f-69f9-4e7d-a904-a7baabdf43f7 */
46 GUID_INIT(0xc44d002f, 0x69f9, 0x4e7d,
47 0xa9, 0x04, 0xa7, 0xba, 0xab, 0xdf, 0x43, 0xf7),
48 /* Thunderbolt GUID for WAKE_SUPPORTED: 6c501103-c189-4296-ba72-9bf5a26ebe5d */
49 GUID_INIT(0x6c501103, 0xc189, 0x4296,
50 0xba, 0x72, 0x9b, 0xf5, 0xa2, 0x6e, 0xbe, 0x5d),
51 /* Storage device needs D3 GUID: 5025030f-842f-4ab4-a561-99a5189762d0 */
52 GUID_INIT(0x5025030f, 0x842f, 0x4ab4,
53 0xa5, 0x61, 0x99, 0xa5, 0x18, 0x97, 0x62, 0xd0),
54};
55
56/* ACPI _DSD data subnodes GUID: dbb8e3e6-5886-4ba6-8795-1319f52a966b */
57static const guid_t ads_guid =
58 GUID_INIT(0xdbb8e3e6, 0x5886, 0x4ba6,
59 0x87, 0x95, 0x13, 0x19, 0xf5, 0x2a, 0x96, 0x6b);
60
61/* ACPI _DSD data buffer GUID: edb12dd0-363d-4085-a3d2-49522ca160c4 */
62static const guid_t buffer_prop_guid =
63 GUID_INIT(0xedb12dd0, 0x363d, 0x4085,
64 0xa3, 0xd2, 0x49, 0x52, 0x2c, 0xa1, 0x60, 0xc4);
65
66static bool acpi_enumerate_nondev_subnodes(acpi_handle scope,
67 union acpi_object *desc,
68 struct acpi_device_data *data,
69 struct fwnode_handle *parent);
70static bool acpi_extract_properties(acpi_handle handle,
71 union acpi_object *desc,
72 struct acpi_device_data *data);
73
74static bool acpi_nondev_subnode_extract(union acpi_object *desc,
75 acpi_handle handle,
76 const union acpi_object *link,
77 struct list_head *list,
78 struct fwnode_handle *parent)
79{
80 struct acpi_data_node *dn;
81 bool result;
82
83 dn = kzalloc(sizeof(*dn), GFP_KERNEL);
84 if (!dn)
85 return false;
86
87 dn->name = link->package.elements[0].string.pointer;
88 fwnode_init(&dn->fwnode, &acpi_data_fwnode_ops);
89 dn->parent = parent;
90 INIT_LIST_HEAD(&dn->data.properties);
91 INIT_LIST_HEAD(&dn->data.subnodes);
92
93 result = acpi_extract_properties(handle, desc, &dn->data);
94
95 if (handle) {
96 acpi_handle scope;
97 acpi_status status;
98
99 /*
100 * The scope for the subnode object lookup is the one of the
101 * namespace node (device) containing the object that has
102 * returned the package. That is, it's the scope of that
103 * object's parent.
104 */
105 status = acpi_get_parent(handle, &scope);
106 if (ACPI_SUCCESS(status)
107 && acpi_enumerate_nondev_subnodes(scope, desc, &dn->data,
108 &dn->fwnode))
109 result = true;
110 } else if (acpi_enumerate_nondev_subnodes(NULL, desc, &dn->data,
111 &dn->fwnode)) {
112 result = true;
113 }
114
115 if (result) {
116 dn->handle = handle;
117 dn->data.pointer = desc;
118 list_add_tail(&dn->sibling, list);
119 return true;
120 }
121
122 kfree(dn);
123 acpi_handle_debug(handle, "Invalid properties/subnodes data, skipping\n");
124 return false;
125}
126
127static bool acpi_nondev_subnode_data_ok(acpi_handle handle,
128 const union acpi_object *link,
129 struct list_head *list,
130 struct fwnode_handle *parent)
131{
132 struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER };
133 acpi_status status;
134
135 status = acpi_evaluate_object_typed(handle, NULL, NULL, &buf,
136 ACPI_TYPE_PACKAGE);
137 if (ACPI_FAILURE(status))
138 return false;
139
140 if (acpi_nondev_subnode_extract(buf.pointer, handle, link, list,
141 parent))
142 return true;
143
144 ACPI_FREE(buf.pointer);
145 return false;
146}
147
148static bool acpi_nondev_subnode_ok(acpi_handle scope,
149 const union acpi_object *link,
150 struct list_head *list,
151 struct fwnode_handle *parent)
152{
153 acpi_handle handle;
154 acpi_status status;
155
156 if (!scope)
157 return false;
158
159 status = acpi_get_handle(scope, link->package.elements[1].string.pointer,
160 &handle);
161 if (ACPI_FAILURE(status))
162 return false;
163
164 return acpi_nondev_subnode_data_ok(handle, link, list, parent);
165}
166
167static bool acpi_add_nondev_subnodes(acpi_handle scope,
168 union acpi_object *links,
169 struct list_head *list,
170 struct fwnode_handle *parent)
171{
172 bool ret = false;
173 int i;
174
175 for (i = 0; i < links->package.count; i++) {
176 union acpi_object *link, *desc;
177 acpi_handle handle;
178 bool result;
179
180 link = &links->package.elements[i];
181 /* Only two elements allowed. */
182 if (link->package.count != 2)
183 continue;
184
185 /* The first one must be a string. */
186 if (link->package.elements[0].type != ACPI_TYPE_STRING)
187 continue;
188
189 /* The second one may be a string, a reference or a package. */
190 switch (link->package.elements[1].type) {
191 case ACPI_TYPE_STRING:
192 result = acpi_nondev_subnode_ok(scope, link, list,
193 parent);
194 break;
195 case ACPI_TYPE_LOCAL_REFERENCE:
196 handle = link->package.elements[1].reference.handle;
197 result = acpi_nondev_subnode_data_ok(handle, link, list,
198 parent);
199 break;
200 case ACPI_TYPE_PACKAGE:
201 desc = &link->package.elements[1];
202 result = acpi_nondev_subnode_extract(desc, NULL, link,
203 list, parent);
204 break;
205 default:
206 result = false;
207 break;
208 }
209 ret = ret || result;
210 }
211
212 return ret;
213}
214
215static bool acpi_enumerate_nondev_subnodes(acpi_handle scope,
216 union acpi_object *desc,
217 struct acpi_device_data *data,
218 struct fwnode_handle *parent)
219{
220 int i;
221
222 /* Look for the ACPI data subnodes GUID. */
223 for (i = 0; i < desc->package.count; i += 2) {
224 const union acpi_object *guid;
225 union acpi_object *links;
226
227 guid = &desc->package.elements[i];
228 links = &desc->package.elements[i + 1];
229
230 /*
231 * The first element must be a GUID and the second one must be
232 * a package.
233 */
234 if (guid->type != ACPI_TYPE_BUFFER ||
235 guid->buffer.length != 16 ||
236 links->type != ACPI_TYPE_PACKAGE)
237 break;
238
239 if (!guid_equal((guid_t *)guid->buffer.pointer, &ads_guid))
240 continue;
241
242 return acpi_add_nondev_subnodes(scope, links, &data->subnodes,
243 parent);
244 }
245
246 return false;
247}
248
249static bool acpi_property_value_ok(const union acpi_object *value)
250{
251 int j;
252
253 /*
254 * The value must be an integer, a string, a reference, or a package
255 * whose every element must be an integer, a string, or a reference.
256 */
257 switch (value->type) {
258 case ACPI_TYPE_INTEGER:
259 case ACPI_TYPE_STRING:
260 case ACPI_TYPE_LOCAL_REFERENCE:
261 return true;
262
263 case ACPI_TYPE_PACKAGE:
264 for (j = 0; j < value->package.count; j++)
265 switch (value->package.elements[j].type) {
266 case ACPI_TYPE_INTEGER:
267 case ACPI_TYPE_STRING:
268 case ACPI_TYPE_LOCAL_REFERENCE:
269 continue;
270
271 default:
272 return false;
273 }
274
275 return true;
276 }
277 return false;
278}
279
280static bool acpi_properties_format_valid(const union acpi_object *properties)
281{
282 int i;
283
284 for (i = 0; i < properties->package.count; i++) {
285 const union acpi_object *property;
286
287 property = &properties->package.elements[i];
288 /*
289 * Only two elements allowed, the first one must be a string and
290 * the second one has to satisfy certain conditions.
291 */
292 if (property->package.count != 2
293 || property->package.elements[0].type != ACPI_TYPE_STRING
294 || !acpi_property_value_ok(&property->package.elements[1]))
295 return false;
296 }
297 return true;
298}
299
300static void acpi_init_of_compatible(struct acpi_device *adev)
301{
302 const union acpi_object *of_compatible;
303 int ret;
304
305 ret = acpi_data_get_property_array(&adev->data, "compatible",
306 ACPI_TYPE_STRING, &of_compatible);
307 if (ret) {
308 ret = acpi_dev_get_property(adev, "compatible",
309 ACPI_TYPE_STRING, &of_compatible);
310 if (ret) {
311 struct acpi_device *parent;
312
313 parent = acpi_dev_parent(adev);
314 if (parent && parent->flags.of_compatible_ok)
315 goto out;
316
317 return;
318 }
319 }
320 adev->data.of_compatible = of_compatible;
321
322 out:
323 adev->flags.of_compatible_ok = 1;
324}
325
326static bool acpi_is_property_guid(const guid_t *guid)
327{
328 int i;
329
330 for (i = 0; i < ARRAY_SIZE(prp_guids); i++) {
331 if (guid_equal(guid, &prp_guids[i]))
332 return true;
333 }
334
335 return false;
336}
337
338struct acpi_device_properties *
339acpi_data_add_props(struct acpi_device_data *data, const guid_t *guid,
340 union acpi_object *properties)
341{
342 struct acpi_device_properties *props;
343
344 props = kzalloc(sizeof(*props), GFP_KERNEL);
345 if (props) {
346 INIT_LIST_HEAD(&props->list);
347 props->guid = guid;
348 props->properties = properties;
349 list_add_tail(&props->list, &data->properties);
350 }
351
352 return props;
353}
354
355static void acpi_nondev_subnode_tag(acpi_handle handle, void *context)
356{
357}
358
359static void acpi_untie_nondev_subnodes(struct acpi_device_data *data)
360{
361 struct acpi_data_node *dn;
362
363 list_for_each_entry(dn, &data->subnodes, sibling) {
364 acpi_detach_data(dn->handle, acpi_nondev_subnode_tag);
365
366 acpi_untie_nondev_subnodes(&dn->data);
367 }
368}
369
370static bool acpi_tie_nondev_subnodes(struct acpi_device_data *data)
371{
372 struct acpi_data_node *dn;
373
374 list_for_each_entry(dn, &data->subnodes, sibling) {
375 acpi_status status;
376 bool ret;
377
378 status = acpi_attach_data(dn->handle, acpi_nondev_subnode_tag, dn);
379 if (ACPI_FAILURE(status) && status != AE_ALREADY_EXISTS) {
380 acpi_handle_err(dn->handle, "Can't tag data node\n");
381 return false;
382 }
383
384 ret = acpi_tie_nondev_subnodes(&dn->data);
385 if (!ret)
386 return ret;
387 }
388
389 return true;
390}
391
392static void acpi_data_add_buffer_props(acpi_handle handle,
393 struct acpi_device_data *data,
394 union acpi_object *properties)
395{
396 struct acpi_device_properties *props;
397 union acpi_object *package;
398 size_t alloc_size;
399 unsigned int i;
400 u32 *count;
401
402 if (check_mul_overflow((size_t)properties->package.count,
403 sizeof(*package) + sizeof(void *),
404 &alloc_size) ||
405 check_add_overflow(sizeof(*props) + sizeof(*package), alloc_size,
406 &alloc_size)) {
407 acpi_handle_warn(handle,
408 "can't allocate memory for %u buffer props",
409 properties->package.count);
410 return;
411 }
412
413 props = kvzalloc(alloc_size, GFP_KERNEL);
414 if (!props)
415 return;
416
417 props->guid = &buffer_prop_guid;
418 props->bufs = (void *)(props + 1);
419 props->properties = (void *)(props->bufs + properties->package.count);
420
421 /* Outer package */
422 package = props->properties;
423 package->type = ACPI_TYPE_PACKAGE;
424 package->package.elements = package + 1;
425 count = &package->package.count;
426 *count = 0;
427
428 /* Inner packages */
429 package++;
430
431 for (i = 0; i < properties->package.count; i++) {
432 struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER };
433 union acpi_object *property = &properties->package.elements[i];
434 union acpi_object *prop, *obj, *buf_obj;
435 acpi_status status;
436
437 if (property->type != ACPI_TYPE_PACKAGE ||
438 property->package.count != 2) {
439 acpi_handle_warn(handle,
440 "buffer property %u has %u entries\n",
441 i, property->package.count);
442 continue;
443 }
444
445 prop = &property->package.elements[0];
446 obj = &property->package.elements[1];
447
448 if (prop->type != ACPI_TYPE_STRING ||
449 obj->type != ACPI_TYPE_STRING) {
450 acpi_handle_warn(handle,
451 "wrong object types %u and %u\n",
452 prop->type, obj->type);
453 continue;
454 }
455
456 status = acpi_evaluate_object_typed(handle, obj->string.pointer,
457 NULL, &buf,
458 ACPI_TYPE_BUFFER);
459 if (ACPI_FAILURE(status)) {
460 acpi_handle_warn(handle,
461 "can't evaluate \"%*pE\" as buffer\n",
462 obj->string.length,
463 obj->string.pointer);
464 continue;
465 }
466
467 package->type = ACPI_TYPE_PACKAGE;
468 package->package.elements = prop;
469 package->package.count = 2;
470
471 buf_obj = buf.pointer;
472
473 /* Replace the string object with a buffer object */
474 obj->type = ACPI_TYPE_BUFFER;
475 obj->buffer.length = buf_obj->buffer.length;
476 obj->buffer.pointer = buf_obj->buffer.pointer;
477
478 props->bufs[i] = buf.pointer;
479 package++;
480 (*count)++;
481 }
482
483 if (*count)
484 list_add(&props->list, &data->properties);
485 else
486 kvfree(props);
487}
488
489static bool acpi_extract_properties(acpi_handle scope, union acpi_object *desc,
490 struct acpi_device_data *data)
491{
492 int i;
493
494 if (desc->package.count % 2)
495 return false;
496
497 /* Look for the device properties GUID. */
498 for (i = 0; i < desc->package.count; i += 2) {
499 const union acpi_object *guid;
500 union acpi_object *properties;
501
502 guid = &desc->package.elements[i];
503 properties = &desc->package.elements[i + 1];
504
505 /*
506 * The first element must be a GUID and the second one must be
507 * a package.
508 */
509 if (guid->type != ACPI_TYPE_BUFFER ||
510 guid->buffer.length != 16 ||
511 properties->type != ACPI_TYPE_PACKAGE)
512 break;
513
514 if (guid_equal((guid_t *)guid->buffer.pointer,
515 &buffer_prop_guid)) {
516 acpi_data_add_buffer_props(scope, data, properties);
517 continue;
518 }
519
520 if (!acpi_is_property_guid((guid_t *)guid->buffer.pointer))
521 continue;
522
523 /*
524 * We found the matching GUID. Now validate the format of the
525 * package immediately following it.
526 */
527 if (!acpi_properties_format_valid(properties))
528 continue;
529
530 acpi_data_add_props(data, (const guid_t *)guid->buffer.pointer,
531 properties);
532 }
533
534 return !list_empty(&data->properties);
535}
536
537void acpi_init_properties(struct acpi_device *adev)
538{
539 struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER };
540 struct acpi_hardware_id *hwid;
541 acpi_status status;
542 bool acpi_of = false;
543
544 INIT_LIST_HEAD(&adev->data.properties);
545 INIT_LIST_HEAD(&adev->data.subnodes);
546
547 if (!adev->handle)
548 return;
549
550 /*
551 * Check if ACPI_DT_NAMESPACE_HID is present and inthat case we fill in
552 * Device Tree compatible properties for this device.
553 */
554 list_for_each_entry(hwid, &adev->pnp.ids, list) {
555 if (!strcmp(hwid->id, ACPI_DT_NAMESPACE_HID)) {
556 acpi_of = true;
557 break;
558 }
559 }
560
561 status = acpi_evaluate_object_typed(adev->handle, "_DSD", NULL, &buf,
562 ACPI_TYPE_PACKAGE);
563 if (ACPI_FAILURE(status))
564 goto out;
565
566 if (acpi_extract_properties(adev->handle, buf.pointer, &adev->data)) {
567 adev->data.pointer = buf.pointer;
568 if (acpi_of)
569 acpi_init_of_compatible(adev);
570 }
571 if (acpi_enumerate_nondev_subnodes(adev->handle, buf.pointer,
572 &adev->data, acpi_fwnode_handle(adev)))
573 adev->data.pointer = buf.pointer;
574
575 if (!adev->data.pointer) {
576 acpi_handle_debug(adev->handle, "Invalid _DSD data, skipping\n");
577 ACPI_FREE(buf.pointer);
578 } else {
579 if (!acpi_tie_nondev_subnodes(&adev->data))
580 acpi_untie_nondev_subnodes(&adev->data);
581 }
582
583 out:
584 if (acpi_of && !adev->flags.of_compatible_ok)
585 acpi_handle_info(adev->handle,
586 ACPI_DT_NAMESPACE_HID " requires 'compatible' property\n");
587
588 if (!adev->data.pointer)
589 acpi_extract_apple_properties(adev);
590}
591
592static void acpi_free_device_properties(struct list_head *list)
593{
594 struct acpi_device_properties *props, *tmp;
595
596 list_for_each_entry_safe(props, tmp, list, list) {
597 u32 i;
598
599 list_del(&props->list);
600 /* Buffer data properties were separately allocated */
601 if (props->bufs)
602 for (i = 0; i < props->properties->package.count; i++)
603 ACPI_FREE(props->bufs[i]);
604 kvfree(props);
605 }
606}
607
608static void acpi_destroy_nondev_subnodes(struct list_head *list)
609{
610 struct acpi_data_node *dn, *next;
611
612 if (list_empty(list))
613 return;
614
615 list_for_each_entry_safe_reverse(dn, next, list, sibling) {
616 acpi_destroy_nondev_subnodes(&dn->data.subnodes);
617 wait_for_completion(&dn->kobj_done);
618 list_del(&dn->sibling);
619 ACPI_FREE((void *)dn->data.pointer);
620 acpi_free_device_properties(&dn->data.properties);
621 kfree(dn);
622 }
623}
624
625void acpi_free_properties(struct acpi_device *adev)
626{
627 acpi_untie_nondev_subnodes(&adev->data);
628 acpi_destroy_nondev_subnodes(&adev->data.subnodes);
629 ACPI_FREE((void *)adev->data.pointer);
630 adev->data.of_compatible = NULL;
631 adev->data.pointer = NULL;
632 acpi_free_device_properties(&adev->data.properties);
633}
634
635/**
636 * acpi_data_get_property - return an ACPI property with given name
637 * @data: ACPI device deta object to get the property from
638 * @name: Name of the property
639 * @type: Expected property type
640 * @obj: Location to store the property value (if not %NULL)
641 *
642 * Look up a property with @name and store a pointer to the resulting ACPI
643 * object at the location pointed to by @obj if found.
644 *
645 * Callers must not attempt to free the returned objects. These objects will be
646 * freed by the ACPI core automatically during the removal of @data.
647 *
648 * Return: %0 if property with @name has been found (success),
649 * %-EINVAL if the arguments are invalid,
650 * %-EINVAL if the property doesn't exist,
651 * %-EPROTO if the property value type doesn't match @type.
652 */
653static int acpi_data_get_property(const struct acpi_device_data *data,
654 const char *name, acpi_object_type type,
655 const union acpi_object **obj)
656{
657 const struct acpi_device_properties *props;
658
659 if (!data || !name)
660 return -EINVAL;
661
662 if (!data->pointer || list_empty(&data->properties))
663 return -EINVAL;
664
665 list_for_each_entry(props, &data->properties, list) {
666 const union acpi_object *properties;
667 unsigned int i;
668
669 properties = props->properties;
670 for (i = 0; i < properties->package.count; i++) {
671 const union acpi_object *propname, *propvalue;
672 const union acpi_object *property;
673
674 property = &properties->package.elements[i];
675
676 propname = &property->package.elements[0];
677 propvalue = &property->package.elements[1];
678
679 if (!strcmp(name, propname->string.pointer)) {
680 if (type != ACPI_TYPE_ANY &&
681 propvalue->type != type)
682 return -EPROTO;
683 if (obj)
684 *obj = propvalue;
685
686 return 0;
687 }
688 }
689 }
690 return -EINVAL;
691}
692
693/**
694 * acpi_dev_get_property - return an ACPI property with given name.
695 * @adev: ACPI device to get the property from.
696 * @name: Name of the property.
697 * @type: Expected property type.
698 * @obj: Location to store the property value (if not %NULL).
699 */
700int acpi_dev_get_property(const struct acpi_device *adev, const char *name,
701 acpi_object_type type, const union acpi_object **obj)
702{
703 return adev ? acpi_data_get_property(&adev->data, name, type, obj) : -EINVAL;
704}
705EXPORT_SYMBOL_GPL(acpi_dev_get_property);
706
707static const struct acpi_device_data *
708acpi_device_data_of_node(const struct fwnode_handle *fwnode)
709{
710 if (is_acpi_device_node(fwnode)) {
711 const struct acpi_device *adev = to_acpi_device_node(fwnode);
712 return &adev->data;
713 }
714 if (is_acpi_data_node(fwnode)) {
715 const struct acpi_data_node *dn = to_acpi_data_node(fwnode);
716 return &dn->data;
717 }
718 return NULL;
719}
720
721/**
722 * acpi_node_prop_get - return an ACPI property with given name.
723 * @fwnode: Firmware node to get the property from.
724 * @propname: Name of the property.
725 * @valptr: Location to store a pointer to the property value (if not %NULL).
726 */
727int acpi_node_prop_get(const struct fwnode_handle *fwnode,
728 const char *propname, void **valptr)
729{
730 return acpi_data_get_property(acpi_device_data_of_node(fwnode),
731 propname, ACPI_TYPE_ANY,
732 (const union acpi_object **)valptr);
733}
734
735/**
736 * acpi_data_get_property_array - return an ACPI array property with given name
737 * @data: ACPI data object to get the property from
738 * @name: Name of the property
739 * @type: Expected type of array elements
740 * @obj: Location to store a pointer to the property value (if not NULL)
741 *
742 * Look up an array property with @name and store a pointer to the resulting
743 * ACPI object at the location pointed to by @obj if found.
744 *
745 * Callers must not attempt to free the returned objects. Those objects will be
746 * freed by the ACPI core automatically during the removal of @data.
747 *
748 * Return: %0 if array property (package) with @name has been found (success),
749 * %-EINVAL if the arguments are invalid,
750 * %-EINVAL if the property doesn't exist,
751 * %-EPROTO if the property is not a package or the type of its elements
752 * doesn't match @type.
753 */
754static int acpi_data_get_property_array(const struct acpi_device_data *data,
755 const char *name,
756 acpi_object_type type,
757 const union acpi_object **obj)
758{
759 const union acpi_object *prop;
760 int ret, i;
761
762 ret = acpi_data_get_property(data, name, ACPI_TYPE_PACKAGE, &prop);
763 if (ret)
764 return ret;
765
766 if (type != ACPI_TYPE_ANY) {
767 /* Check that all elements are of correct type. */
768 for (i = 0; i < prop->package.count; i++)
769 if (prop->package.elements[i].type != type)
770 return -EPROTO;
771 }
772 if (obj)
773 *obj = prop;
774
775 return 0;
776}
777
778static struct fwnode_handle *
779acpi_fwnode_get_named_child_node(const struct fwnode_handle *fwnode,
780 const char *childname)
781{
782 struct fwnode_handle *child;
783
784 fwnode_for_each_child_node(fwnode, child) {
785 if (is_acpi_data_node(child)) {
786 if (acpi_data_node_match(child, childname))
787 return child;
788 continue;
789 }
790
791 if (!strncmp(acpi_device_bid(to_acpi_device_node(child)),
792 childname, ACPI_NAMESEG_SIZE))
793 return child;
794 }
795
796 return NULL;
797}
798
799static int acpi_get_ref_args(struct fwnode_reference_args *args,
800 struct fwnode_handle *ref_fwnode,
801 const union acpi_object **element,
802 const union acpi_object *end, size_t num_args)
803{
804 u32 nargs = 0, i;
805
806 /*
807 * Assume the following integer elements are all args. Stop counting on
808 * the first reference (possibly represented as a string) or end of the
809 * package arguments. In case of neither reference, nor integer, return
810 * an error, we can't parse it.
811 */
812 for (i = 0; (*element) + i < end && i < num_args; i++) {
813 acpi_object_type type = (*element)[i].type;
814
815 if (type == ACPI_TYPE_LOCAL_REFERENCE || type == ACPI_TYPE_STRING)
816 break;
817
818 if (type == ACPI_TYPE_INTEGER)
819 nargs++;
820 else
821 return -EINVAL;
822 }
823
824 if (nargs > NR_FWNODE_REFERENCE_ARGS)
825 return -EINVAL;
826
827 if (args) {
828 args->fwnode = ref_fwnode;
829 args->nargs = nargs;
830 for (i = 0; i < nargs; i++)
831 args->args[i] = (*element)[i].integer.value;
832 }
833
834 (*element) += nargs;
835
836 return 0;
837}
838
839static struct fwnode_handle *acpi_parse_string_ref(const struct fwnode_handle *fwnode,
840 const char *refstring)
841{
842 acpi_handle scope, handle;
843 struct acpi_data_node *dn;
844 struct acpi_device *device;
845 acpi_status status;
846
847 if (is_acpi_device_node(fwnode)) {
848 scope = to_acpi_device_node(fwnode)->handle;
849 } else if (is_acpi_data_node(fwnode)) {
850 scope = to_acpi_data_node(fwnode)->handle;
851 } else {
852 pr_debug("Bad node type for node %pfw\n", fwnode);
853 return NULL;
854 }
855
856 status = acpi_get_handle(scope, refstring, &handle);
857 if (ACPI_FAILURE(status)) {
858 acpi_handle_debug(scope, "Unable to get an ACPI handle for %s\n",
859 refstring);
860 return NULL;
861 }
862
863 device = acpi_fetch_acpi_dev(handle);
864 if (device)
865 return acpi_fwnode_handle(device);
866
867 status = acpi_get_data_full(handle, acpi_nondev_subnode_tag,
868 (void **)&dn, NULL);
869 if (ACPI_FAILURE(status) || !dn) {
870 acpi_handle_debug(handle, "Subnode not found\n");
871 return NULL;
872 }
873
874 return &dn->fwnode;
875}
876
877/**
878 * __acpi_node_get_property_reference - returns handle to the referenced object
879 * @fwnode: Firmware node to get the property from
880 * @propname: Name of the property
881 * @index: Index of the reference to return
882 * @num_args: Maximum number of arguments after each reference
883 * @args: Location to store the returned reference with optional arguments
884 * (may be NULL)
885 *
886 * Find property with @name, verifify that it is a package containing at least
887 * one object reference and if so, store the ACPI device object pointer to the
888 * target object in @args->adev. If the reference includes arguments, store
889 * them in the @args->args[] array.
890 *
891 * If there's more than one reference in the property value package, @index is
892 * used to select the one to return.
893 *
894 * It is possible to leave holes in the property value set like in the
895 * example below:
896 *
897 * Package () {
898 * "cs-gpios",
899 * Package () {
900 * ^GPIO, 19, 0, 0,
901 * ^GPIO, 20, 0, 0,
902 * 0,
903 * ^GPIO, 21, 0, 0,
904 * }
905 * }
906 *
907 * Calling this function with index %2 or index %3 return %-ENOENT. If the
908 * property does not contain any more values %-ENOENT is returned. The NULL
909 * entry must be single integer and preferably contain value %0.
910 *
911 * Return: %0 on success, negative error code on failure.
912 */
913int __acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
914 const char *propname, size_t index, size_t num_args,
915 struct fwnode_reference_args *args)
916{
917 const union acpi_object *element, *end;
918 const union acpi_object *obj;
919 const struct acpi_device_data *data;
920 struct fwnode_handle *ref_fwnode;
921 struct acpi_device *device;
922 int ret, idx = 0;
923
924 data = acpi_device_data_of_node(fwnode);
925 if (!data)
926 return -ENOENT;
927
928 ret = acpi_data_get_property(data, propname, ACPI_TYPE_ANY, &obj);
929 if (ret)
930 return ret == -EINVAL ? -ENOENT : -EINVAL;
931
932 switch (obj->type) {
933 case ACPI_TYPE_LOCAL_REFERENCE:
934 /* Plain single reference without arguments. */
935 if (index)
936 return -ENOENT;
937
938 device = acpi_fetch_acpi_dev(obj->reference.handle);
939 if (!device)
940 return -EINVAL;
941
942 if (!args)
943 return 0;
944
945 args->fwnode = acpi_fwnode_handle(device);
946 args->nargs = 0;
947
948 return 0;
949 case ACPI_TYPE_STRING:
950 if (index)
951 return -ENOENT;
952
953 ref_fwnode = acpi_parse_string_ref(fwnode, obj->string.pointer);
954 if (!ref_fwnode)
955 return -EINVAL;
956
957 args->fwnode = ref_fwnode;
958 args->nargs = 0;
959
960 return 0;
961 case ACPI_TYPE_PACKAGE:
962 /*
963 * If it is not a single reference, then it is a package of
964 * references, followed by number of ints as follows:
965 *
966 * Package () { REF, INT, REF, INT, INT }
967 *
968 * Here, REF may be either a local reference or a string. The
969 * index argument is then used to determine which reference the
970 * caller wants (along with the arguments).
971 */
972 break;
973 default:
974 return -EINVAL;
975 }
976
977 if (index >= obj->package.count)
978 return -ENOENT;
979
980 element = obj->package.elements;
981 end = element + obj->package.count;
982
983 while (element < end) {
984 switch (element->type) {
985 case ACPI_TYPE_LOCAL_REFERENCE:
986 device = acpi_fetch_acpi_dev(element->reference.handle);
987 if (!device)
988 return -EINVAL;
989
990 element++;
991
992 ret = acpi_get_ref_args(idx == index ? args : NULL,
993 acpi_fwnode_handle(device),
994 &element, end, num_args);
995 if (ret < 0)
996 return ret;
997
998 if (idx == index)
999 return 0;
1000
1001 break;
1002 case ACPI_TYPE_STRING:
1003 ref_fwnode = acpi_parse_string_ref(fwnode,
1004 element->string.pointer);
1005 if (!ref_fwnode)
1006 return -EINVAL;
1007
1008 element++;
1009
1010 ret = acpi_get_ref_args(idx == index ? args : NULL,
1011 ref_fwnode, &element, end,
1012 num_args);
1013 if (ret < 0)
1014 return ret;
1015
1016 if (idx == index)
1017 return 0;
1018
1019 break;
1020 case ACPI_TYPE_INTEGER:
1021 if (idx == index)
1022 return -ENOENT;
1023 element++;
1024 break;
1025 default:
1026 return -EINVAL;
1027 }
1028
1029 idx++;
1030 }
1031
1032 return -ENOENT;
1033}
1034EXPORT_SYMBOL_GPL(__acpi_node_get_property_reference);
1035
1036static int acpi_data_prop_read_single(const struct acpi_device_data *data,
1037 const char *propname,
1038 enum dev_prop_type proptype, void *val)
1039{
1040 const union acpi_object *obj;
1041 int ret = 0;
1042
1043 if (proptype >= DEV_PROP_U8 && proptype <= DEV_PROP_U64)
1044 ret = acpi_data_get_property(data, propname, ACPI_TYPE_INTEGER, &obj);
1045 else if (proptype == DEV_PROP_STRING)
1046 ret = acpi_data_get_property(data, propname, ACPI_TYPE_STRING, &obj);
1047 if (ret)
1048 return ret;
1049
1050 switch (proptype) {
1051 case DEV_PROP_U8:
1052 if (obj->integer.value > U8_MAX)
1053 return -EOVERFLOW;
1054 if (val)
1055 *(u8 *)val = obj->integer.value;
1056 break;
1057 case DEV_PROP_U16:
1058 if (obj->integer.value > U16_MAX)
1059 return -EOVERFLOW;
1060 if (val)
1061 *(u16 *)val = obj->integer.value;
1062 break;
1063 case DEV_PROP_U32:
1064 if (obj->integer.value > U32_MAX)
1065 return -EOVERFLOW;
1066 if (val)
1067 *(u32 *)val = obj->integer.value;
1068 break;
1069 case DEV_PROP_U64:
1070 if (val)
1071 *(u64 *)val = obj->integer.value;
1072 break;
1073 case DEV_PROP_STRING:
1074 if (val)
1075 *(char **)val = obj->string.pointer;
1076 return 1;
1077 default:
1078 return -EINVAL;
1079 }
1080
1081 /* When no storage provided return number of available values */
1082 return val ? 0 : 1;
1083}
1084
1085#define acpi_copy_property_array_uint(items, val, nval) \
1086 ({ \
1087 typeof(items) __items = items; \
1088 typeof(val) __val = val; \
1089 typeof(nval) __nval = nval; \
1090 size_t i; \
1091 int ret = 0; \
1092 \
1093 for (i = 0; i < __nval; i++) { \
1094 if (__items->type == ACPI_TYPE_BUFFER) { \
1095 __val[i] = __items->buffer.pointer[i]; \
1096 continue; \
1097 } \
1098 if (__items[i].type != ACPI_TYPE_INTEGER) { \
1099 ret = -EPROTO; \
1100 break; \
1101 } \
1102 if (__items[i].integer.value > _Generic(__val, \
1103 u8 *: U8_MAX, \
1104 u16 *: U16_MAX, \
1105 u32 *: U32_MAX, \
1106 u64 *: U64_MAX)) { \
1107 ret = -EOVERFLOW; \
1108 break; \
1109 } \
1110 \
1111 __val[i] = __items[i].integer.value; \
1112 } \
1113 ret; \
1114 })
1115
1116static int acpi_copy_property_array_string(const union acpi_object *items,
1117 char **val, size_t nval)
1118{
1119 int i;
1120
1121 for (i = 0; i < nval; i++) {
1122 if (items[i].type != ACPI_TYPE_STRING)
1123 return -EPROTO;
1124
1125 val[i] = items[i].string.pointer;
1126 }
1127 return nval;
1128}
1129
1130static int acpi_data_prop_read(const struct acpi_device_data *data,
1131 const char *propname,
1132 enum dev_prop_type proptype,
1133 void *val, size_t nval)
1134{
1135 const union acpi_object *obj;
1136 const union acpi_object *items;
1137 int ret;
1138
1139 if (nval == 1 || !val) {
1140 ret = acpi_data_prop_read_single(data, propname, proptype, val);
1141 /*
1142 * The overflow error means that the property is there and it is
1143 * single-value, but its type does not match, so return.
1144 */
1145 if (ret >= 0 || ret == -EOVERFLOW)
1146 return ret;
1147
1148 /*
1149 * Reading this property as a single-value one failed, but its
1150 * value may still be represented as one-element array, so
1151 * continue.
1152 */
1153 }
1154
1155 ret = acpi_data_get_property_array(data, propname, ACPI_TYPE_ANY, &obj);
1156 if (ret && proptype >= DEV_PROP_U8 && proptype <= DEV_PROP_U64)
1157 ret = acpi_data_get_property(data, propname, ACPI_TYPE_BUFFER,
1158 &obj);
1159 if (ret)
1160 return ret;
1161
1162 if (!val) {
1163 if (obj->type == ACPI_TYPE_BUFFER)
1164 return obj->buffer.length;
1165
1166 return obj->package.count;
1167 }
1168
1169 switch (proptype) {
1170 case DEV_PROP_STRING:
1171 break;
1172 default:
1173 if (obj->type == ACPI_TYPE_BUFFER) {
1174 if (nval > obj->buffer.length)
1175 return -EOVERFLOW;
1176 } else {
1177 if (nval > obj->package.count)
1178 return -EOVERFLOW;
1179 }
1180 break;
1181 }
1182 if (nval == 0)
1183 return -EINVAL;
1184
1185 if (obj->type == ACPI_TYPE_BUFFER) {
1186 if (proptype != DEV_PROP_U8)
1187 return -EPROTO;
1188 items = obj;
1189 } else {
1190 items = obj->package.elements;
1191 }
1192
1193 switch (proptype) {
1194 case DEV_PROP_U8:
1195 ret = acpi_copy_property_array_uint(items, (u8 *)val, nval);
1196 break;
1197 case DEV_PROP_U16:
1198 ret = acpi_copy_property_array_uint(items, (u16 *)val, nval);
1199 break;
1200 case DEV_PROP_U32:
1201 ret = acpi_copy_property_array_uint(items, (u32 *)val, nval);
1202 break;
1203 case DEV_PROP_U64:
1204 ret = acpi_copy_property_array_uint(items, (u64 *)val, nval);
1205 break;
1206 case DEV_PROP_STRING:
1207 ret = acpi_copy_property_array_string(
1208 items, (char **)val,
1209 min_t(u32, nval, obj->package.count));
1210 break;
1211 default:
1212 ret = -EINVAL;
1213 break;
1214 }
1215 return ret;
1216}
1217
1218/**
1219 * acpi_node_prop_read - retrieve the value of an ACPI property with given name.
1220 * @fwnode: Firmware node to get the property from.
1221 * @propname: Name of the property.
1222 * @proptype: Expected property type.
1223 * @val: Location to store the property value (if not %NULL).
1224 * @nval: Size of the array pointed to by @val.
1225 *
1226 * If @val is %NULL, return the number of array elements comprising the value
1227 * of the property. Otherwise, read at most @nval values to the array at the
1228 * location pointed to by @val.
1229 */
1230static int acpi_node_prop_read(const struct fwnode_handle *fwnode,
1231 const char *propname, enum dev_prop_type proptype,
1232 void *val, size_t nval)
1233{
1234 return acpi_data_prop_read(acpi_device_data_of_node(fwnode),
1235 propname, proptype, val, nval);
1236}
1237
1238static int stop_on_next(struct acpi_device *adev, void *data)
1239{
1240 struct acpi_device **ret_p = data;
1241
1242 if (!*ret_p) {
1243 *ret_p = adev;
1244 return 1;
1245 }
1246
1247 /* Skip until the "previous" object is found. */
1248 if (*ret_p == adev)
1249 *ret_p = NULL;
1250
1251 return 0;
1252}
1253
1254/**
1255 * acpi_get_next_subnode - Return the next child node handle for a fwnode
1256 * @fwnode: Firmware node to find the next child node for.
1257 * @child: Handle to one of the device's child nodes or a null handle.
1258 */
1259struct fwnode_handle *acpi_get_next_subnode(const struct fwnode_handle *fwnode,
1260 struct fwnode_handle *child)
1261{
1262 struct acpi_device *adev = to_acpi_device_node(fwnode);
1263
1264 if ((!child || is_acpi_device_node(child)) && adev) {
1265 struct acpi_device *child_adev = to_acpi_device_node(child);
1266
1267 acpi_dev_for_each_child(adev, stop_on_next, &child_adev);
1268 if (child_adev)
1269 return acpi_fwnode_handle(child_adev);
1270
1271 child = NULL;
1272 }
1273
1274 if (!child || is_acpi_data_node(child)) {
1275 const struct acpi_data_node *data = to_acpi_data_node(fwnode);
1276 const struct list_head *head;
1277 struct list_head *next;
1278 struct acpi_data_node *dn;
1279
1280 /*
1281 * We can have a combination of device and data nodes, e.g. with
1282 * hierarchical _DSD properties. Make sure the adev pointer is
1283 * restored before going through data nodes, otherwise we will
1284 * be looking for data_nodes below the last device found instead
1285 * of the common fwnode shared by device_nodes and data_nodes.
1286 */
1287 adev = to_acpi_device_node(fwnode);
1288 if (adev)
1289 head = &adev->data.subnodes;
1290 else if (data)
1291 head = &data->data.subnodes;
1292 else
1293 return NULL;
1294
1295 if (list_empty(head))
1296 return NULL;
1297
1298 if (child) {
1299 dn = to_acpi_data_node(child);
1300 next = dn->sibling.next;
1301 if (next == head)
1302 return NULL;
1303
1304 dn = list_entry(next, struct acpi_data_node, sibling);
1305 } else {
1306 dn = list_first_entry(head, struct acpi_data_node, sibling);
1307 }
1308 return &dn->fwnode;
1309 }
1310 return NULL;
1311}
1312
1313/**
1314 * acpi_node_get_parent - Return parent fwnode of this fwnode
1315 * @fwnode: Firmware node whose parent to get
1316 *
1317 * Returns parent node of an ACPI device or data firmware node or %NULL if
1318 * not available.
1319 */
1320static struct fwnode_handle *
1321acpi_node_get_parent(const struct fwnode_handle *fwnode)
1322{
1323 if (is_acpi_data_node(fwnode)) {
1324 /* All data nodes have parent pointer so just return that */
1325 return to_acpi_data_node(fwnode)->parent;
1326 }
1327 if (is_acpi_device_node(fwnode)) {
1328 struct acpi_device *parent;
1329
1330 parent = acpi_dev_parent(to_acpi_device_node(fwnode));
1331 if (parent)
1332 return acpi_fwnode_handle(parent);
1333 }
1334
1335 return NULL;
1336}
1337
1338/*
1339 * Return true if the node is an ACPI graph node. Called on either ports
1340 * or endpoints.
1341 */
1342static bool is_acpi_graph_node(struct fwnode_handle *fwnode,
1343 const char *str)
1344{
1345 unsigned int len = strlen(str);
1346 const char *name;
1347
1348 if (!len || !is_acpi_data_node(fwnode))
1349 return false;
1350
1351 name = to_acpi_data_node(fwnode)->name;
1352
1353 return (fwnode_property_present(fwnode, "reg") &&
1354 !strncmp(name, str, len) && name[len] == '@') ||
1355 fwnode_property_present(fwnode, str);
1356}
1357
1358/**
1359 * acpi_graph_get_next_endpoint - Get next endpoint ACPI firmware node
1360 * @fwnode: Pointer to the parent firmware node
1361 * @prev: Previous endpoint node or %NULL to get the first
1362 *
1363 * Looks up next endpoint ACPI firmware node below a given @fwnode. Returns
1364 * %NULL if there is no next endpoint or in case of error. In case of success
1365 * the next endpoint is returned.
1366 */
1367static struct fwnode_handle *acpi_graph_get_next_endpoint(
1368 const struct fwnode_handle *fwnode, struct fwnode_handle *prev)
1369{
1370 struct fwnode_handle *port = NULL;
1371 struct fwnode_handle *endpoint;
1372
1373 if (!prev) {
1374 do {
1375 port = fwnode_get_next_child_node(fwnode, port);
1376 /*
1377 * The names of the port nodes begin with "port@"
1378 * followed by the number of the port node and they also
1379 * have a "reg" property that also has the number of the
1380 * port node. For compatibility reasons a node is also
1381 * recognised as a port node from the "port" property.
1382 */
1383 if (is_acpi_graph_node(port, "port"))
1384 break;
1385 } while (port);
1386 } else {
1387 port = fwnode_get_parent(prev);
1388 }
1389
1390 if (!port)
1391 return NULL;
1392
1393 endpoint = fwnode_get_next_child_node(port, prev);
1394 while (!endpoint) {
1395 port = fwnode_get_next_child_node(fwnode, port);
1396 if (!port)
1397 break;
1398 if (is_acpi_graph_node(port, "port"))
1399 endpoint = fwnode_get_next_child_node(port, NULL);
1400 }
1401
1402 /*
1403 * The names of the endpoint nodes begin with "endpoint@" followed by
1404 * the number of the endpoint node and they also have a "reg" property
1405 * that also has the number of the endpoint node. For compatibility
1406 * reasons a node is also recognised as an endpoint node from the
1407 * "endpoint" property.
1408 */
1409 if (!is_acpi_graph_node(endpoint, "endpoint"))
1410 return NULL;
1411
1412 return endpoint;
1413}
1414
1415/**
1416 * acpi_graph_get_child_prop_value - Return a child with a given property value
1417 * @fwnode: device fwnode
1418 * @prop_name: The name of the property to look for
1419 * @val: the desired property value
1420 *
1421 * Return the port node corresponding to a given port number. Returns
1422 * the child node on success, NULL otherwise.
1423 */
1424static struct fwnode_handle *acpi_graph_get_child_prop_value(
1425 const struct fwnode_handle *fwnode, const char *prop_name,
1426 unsigned int val)
1427{
1428 struct fwnode_handle *child;
1429
1430 fwnode_for_each_child_node(fwnode, child) {
1431 u32 nr;
1432
1433 if (fwnode_property_read_u32(child, prop_name, &nr))
1434 continue;
1435
1436 if (val == nr)
1437 return child;
1438 }
1439
1440 return NULL;
1441}
1442
1443
1444/**
1445 * acpi_graph_get_remote_endpoint - Parses and returns remote end of an endpoint
1446 * @__fwnode: Endpoint firmware node pointing to a remote device
1447 *
1448 * Returns the remote endpoint corresponding to @__fwnode. NULL on error.
1449 */
1450static struct fwnode_handle *
1451acpi_graph_get_remote_endpoint(const struct fwnode_handle *__fwnode)
1452{
1453 struct fwnode_handle *fwnode;
1454 unsigned int port_nr, endpoint_nr;
1455 struct fwnode_reference_args args;
1456 int ret;
1457
1458 memset(&args, 0, sizeof(args));
1459 ret = acpi_node_get_property_reference(__fwnode, "remote-endpoint", 0,
1460 &args);
1461 if (ret)
1462 return NULL;
1463
1464 /* Direct endpoint reference? */
1465 if (!is_acpi_device_node(args.fwnode))
1466 return args.nargs ? NULL : args.fwnode;
1467
1468 /*
1469 * Always require two arguments with the reference: port and
1470 * endpoint indices.
1471 */
1472 if (args.nargs != 2)
1473 return NULL;
1474
1475 fwnode = args.fwnode;
1476 port_nr = args.args[0];
1477 endpoint_nr = args.args[1];
1478
1479 fwnode = acpi_graph_get_child_prop_value(fwnode, "port", port_nr);
1480
1481 return acpi_graph_get_child_prop_value(fwnode, "endpoint", endpoint_nr);
1482}
1483
1484static bool acpi_fwnode_device_is_available(const struct fwnode_handle *fwnode)
1485{
1486 if (!is_acpi_device_node(fwnode))
1487 return false;
1488
1489 return acpi_device_is_present(to_acpi_device_node(fwnode));
1490}
1491
1492static const void *
1493acpi_fwnode_device_get_match_data(const struct fwnode_handle *fwnode,
1494 const struct device *dev)
1495{
1496 return acpi_device_get_match_data(dev);
1497}
1498
1499static bool acpi_fwnode_device_dma_supported(const struct fwnode_handle *fwnode)
1500{
1501 return acpi_dma_supported(to_acpi_device_node(fwnode));
1502}
1503
1504static enum dev_dma_attr
1505acpi_fwnode_device_get_dma_attr(const struct fwnode_handle *fwnode)
1506{
1507 return acpi_get_dma_attr(to_acpi_device_node(fwnode));
1508}
1509
1510static bool acpi_fwnode_property_present(const struct fwnode_handle *fwnode,
1511 const char *propname)
1512{
1513 return !acpi_node_prop_get(fwnode, propname, NULL);
1514}
1515
1516static int
1517acpi_fwnode_property_read_int_array(const struct fwnode_handle *fwnode,
1518 const char *propname,
1519 unsigned int elem_size, void *val,
1520 size_t nval)
1521{
1522 enum dev_prop_type type;
1523
1524 switch (elem_size) {
1525 case sizeof(u8):
1526 type = DEV_PROP_U8;
1527 break;
1528 case sizeof(u16):
1529 type = DEV_PROP_U16;
1530 break;
1531 case sizeof(u32):
1532 type = DEV_PROP_U32;
1533 break;
1534 case sizeof(u64):
1535 type = DEV_PROP_U64;
1536 break;
1537 default:
1538 return -ENXIO;
1539 }
1540
1541 return acpi_node_prop_read(fwnode, propname, type, val, nval);
1542}
1543
1544static int
1545acpi_fwnode_property_read_string_array(const struct fwnode_handle *fwnode,
1546 const char *propname, const char **val,
1547 size_t nval)
1548{
1549 return acpi_node_prop_read(fwnode, propname, DEV_PROP_STRING,
1550 val, nval);
1551}
1552
1553static int
1554acpi_fwnode_get_reference_args(const struct fwnode_handle *fwnode,
1555 const char *prop, const char *nargs_prop,
1556 unsigned int args_count, unsigned int index,
1557 struct fwnode_reference_args *args)
1558{
1559 return __acpi_node_get_property_reference(fwnode, prop, index,
1560 args_count, args);
1561}
1562
1563static const char *acpi_fwnode_get_name(const struct fwnode_handle *fwnode)
1564{
1565 const struct acpi_device *adev;
1566 struct fwnode_handle *parent;
1567
1568 /* Is this the root node? */
1569 parent = fwnode_get_parent(fwnode);
1570 if (!parent)
1571 return "\\";
1572
1573 fwnode_handle_put(parent);
1574
1575 if (is_acpi_data_node(fwnode)) {
1576 const struct acpi_data_node *dn = to_acpi_data_node(fwnode);
1577
1578 return dn->name;
1579 }
1580
1581 adev = to_acpi_device_node(fwnode);
1582 if (WARN_ON(!adev))
1583 return NULL;
1584
1585 return acpi_device_bid(adev);
1586}
1587
1588static const char *
1589acpi_fwnode_get_name_prefix(const struct fwnode_handle *fwnode)
1590{
1591 struct fwnode_handle *parent;
1592
1593 /* Is this the root node? */
1594 parent = fwnode_get_parent(fwnode);
1595 if (!parent)
1596 return "";
1597
1598 /* Is this 2nd node from the root? */
1599 parent = fwnode_get_next_parent(parent);
1600 if (!parent)
1601 return "";
1602
1603 fwnode_handle_put(parent);
1604
1605 /* ACPI device or data node. */
1606 return ".";
1607}
1608
1609static struct fwnode_handle *
1610acpi_fwnode_get_parent(struct fwnode_handle *fwnode)
1611{
1612 return acpi_node_get_parent(fwnode);
1613}
1614
1615static int acpi_fwnode_graph_parse_endpoint(const struct fwnode_handle *fwnode,
1616 struct fwnode_endpoint *endpoint)
1617{
1618 struct fwnode_handle *port_fwnode = fwnode_get_parent(fwnode);
1619
1620 endpoint->local_fwnode = fwnode;
1621
1622 if (fwnode_property_read_u32(port_fwnode, "reg", &endpoint->port))
1623 fwnode_property_read_u32(port_fwnode, "port", &endpoint->port);
1624 if (fwnode_property_read_u32(fwnode, "reg", &endpoint->id))
1625 fwnode_property_read_u32(fwnode, "endpoint", &endpoint->id);
1626
1627 return 0;
1628}
1629
1630static int acpi_fwnode_irq_get(const struct fwnode_handle *fwnode,
1631 unsigned int index)
1632{
1633 struct resource res;
1634 int ret;
1635
1636 ret = acpi_irq_get(ACPI_HANDLE_FWNODE(fwnode), index, &res);
1637 if (ret)
1638 return ret;
1639
1640 return res.start;
1641}
1642
1643#define DECLARE_ACPI_FWNODE_OPS(ops) \
1644 const struct fwnode_operations ops = { \
1645 .device_is_available = acpi_fwnode_device_is_available, \
1646 .device_get_match_data = acpi_fwnode_device_get_match_data, \
1647 .device_dma_supported = \
1648 acpi_fwnode_device_dma_supported, \
1649 .device_get_dma_attr = acpi_fwnode_device_get_dma_attr, \
1650 .property_present = acpi_fwnode_property_present, \
1651 .property_read_int_array = \
1652 acpi_fwnode_property_read_int_array, \
1653 .property_read_string_array = \
1654 acpi_fwnode_property_read_string_array, \
1655 .get_parent = acpi_node_get_parent, \
1656 .get_next_child_node = acpi_get_next_subnode, \
1657 .get_named_child_node = acpi_fwnode_get_named_child_node, \
1658 .get_name = acpi_fwnode_get_name, \
1659 .get_name_prefix = acpi_fwnode_get_name_prefix, \
1660 .get_reference_args = acpi_fwnode_get_reference_args, \
1661 .graph_get_next_endpoint = \
1662 acpi_graph_get_next_endpoint, \
1663 .graph_get_remote_endpoint = \
1664 acpi_graph_get_remote_endpoint, \
1665 .graph_get_port_parent = acpi_fwnode_get_parent, \
1666 .graph_parse_endpoint = acpi_fwnode_graph_parse_endpoint, \
1667 .irq_get = acpi_fwnode_irq_get, \
1668 }; \
1669 EXPORT_SYMBOL_GPL(ops)
1670
1671DECLARE_ACPI_FWNODE_OPS(acpi_device_fwnode_ops);
1672DECLARE_ACPI_FWNODE_OPS(acpi_data_fwnode_ops);
1673const struct fwnode_operations acpi_static_fwnode_ops;
1674
1675bool is_acpi_device_node(const struct fwnode_handle *fwnode)
1676{
1677 return !IS_ERR_OR_NULL(fwnode) &&
1678 fwnode->ops == &acpi_device_fwnode_ops;
1679}
1680EXPORT_SYMBOL(is_acpi_device_node);
1681
1682bool is_acpi_data_node(const struct fwnode_handle *fwnode)
1683{
1684 return !IS_ERR_OR_NULL(fwnode) && fwnode->ops == &acpi_data_fwnode_ops;
1685}
1686EXPORT_SYMBOL(is_acpi_data_node);
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * ACPI device specific properties support.
4 *
5 * Copyright (C) 2014 - 2023, 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 * Sakari Ailus <sakari.ailus@linux.intel.com>
12 */
13
14#define pr_fmt(fmt) "ACPI: " fmt
15
16#include <linux/acpi.h>
17#include <linux/device.h>
18#include <linux/export.h>
19
20#include "internal.h"
21
22static int acpi_data_get_property_array(const struct acpi_device_data *data,
23 const char *name,
24 acpi_object_type type,
25 const union acpi_object **obj);
26
27/*
28 * The GUIDs here are made equivalent to each other in order to avoid extra
29 * complexity in the properties handling code, with the caveat that the
30 * kernel will accept certain combinations of GUID and properties that are
31 * not defined without a warning. For instance if any of the properties
32 * from different GUID appear in a property list of another, it will be
33 * accepted by the kernel. Firmware validation tools should catch these.
34 */
35static const guid_t prp_guids[] = {
36 /* ACPI _DSD device properties GUID: daffd814-6eba-4d8c-8a91-bc9bbf4aa301 */
37 GUID_INIT(0xdaffd814, 0x6eba, 0x4d8c,
38 0x8a, 0x91, 0xbc, 0x9b, 0xbf, 0x4a, 0xa3, 0x01),
39 /* Hotplug in D3 GUID: 6211e2c0-58a3-4af3-90e1-927a4e0c55a4 */
40 GUID_INIT(0x6211e2c0, 0x58a3, 0x4af3,
41 0x90, 0xe1, 0x92, 0x7a, 0x4e, 0x0c, 0x55, 0xa4),
42 /* External facing port GUID: efcc06cc-73ac-4bc3-bff0-76143807c389 */
43 GUID_INIT(0xefcc06cc, 0x73ac, 0x4bc3,
44 0xbf, 0xf0, 0x76, 0x14, 0x38, 0x07, 0xc3, 0x89),
45 /* Thunderbolt GUID for IMR_VALID: c44d002f-69f9-4e7d-a904-a7baabdf43f7 */
46 GUID_INIT(0xc44d002f, 0x69f9, 0x4e7d,
47 0xa9, 0x04, 0xa7, 0xba, 0xab, 0xdf, 0x43, 0xf7),
48 /* Thunderbolt GUID for WAKE_SUPPORTED: 6c501103-c189-4296-ba72-9bf5a26ebe5d */
49 GUID_INIT(0x6c501103, 0xc189, 0x4296,
50 0xba, 0x72, 0x9b, 0xf5, 0xa2, 0x6e, 0xbe, 0x5d),
51 /* Storage device needs D3 GUID: 5025030f-842f-4ab4-a561-99a5189762d0 */
52 GUID_INIT(0x5025030f, 0x842f, 0x4ab4,
53 0xa5, 0x61, 0x99, 0xa5, 0x18, 0x97, 0x62, 0xd0),
54};
55
56/* ACPI _DSD data subnodes GUID: dbb8e3e6-5886-4ba6-8795-1319f52a966b */
57static const guid_t ads_guid =
58 GUID_INIT(0xdbb8e3e6, 0x5886, 0x4ba6,
59 0x87, 0x95, 0x13, 0x19, 0xf5, 0x2a, 0x96, 0x6b);
60
61/* ACPI _DSD data buffer GUID: edb12dd0-363d-4085-a3d2-49522ca160c4 */
62static const guid_t buffer_prop_guid =
63 GUID_INIT(0xedb12dd0, 0x363d, 0x4085,
64 0xa3, 0xd2, 0x49, 0x52, 0x2c, 0xa1, 0x60, 0xc4);
65
66static bool acpi_enumerate_nondev_subnodes(acpi_handle scope,
67 union acpi_object *desc,
68 struct acpi_device_data *data,
69 struct fwnode_handle *parent);
70static bool acpi_extract_properties(acpi_handle handle,
71 union acpi_object *desc,
72 struct acpi_device_data *data);
73
74static bool acpi_nondev_subnode_extract(union acpi_object *desc,
75 acpi_handle handle,
76 const union acpi_object *link,
77 struct list_head *list,
78 struct fwnode_handle *parent)
79{
80 struct acpi_data_node *dn;
81 bool result;
82
83 if (acpi_graph_ignore_port(handle))
84 return false;
85
86 dn = kzalloc(sizeof(*dn), GFP_KERNEL);
87 if (!dn)
88 return false;
89
90 dn->name = link->package.elements[0].string.pointer;
91 fwnode_init(&dn->fwnode, &acpi_data_fwnode_ops);
92 dn->parent = parent;
93 INIT_LIST_HEAD(&dn->data.properties);
94 INIT_LIST_HEAD(&dn->data.subnodes);
95
96 result = acpi_extract_properties(handle, desc, &dn->data);
97
98 if (handle) {
99 acpi_handle scope;
100 acpi_status status;
101
102 /*
103 * The scope for the subnode object lookup is the one of the
104 * namespace node (device) containing the object that has
105 * returned the package. That is, it's the scope of that
106 * object's parent.
107 */
108 status = acpi_get_parent(handle, &scope);
109 if (ACPI_SUCCESS(status)
110 && acpi_enumerate_nondev_subnodes(scope, desc, &dn->data,
111 &dn->fwnode))
112 result = true;
113 } else if (acpi_enumerate_nondev_subnodes(NULL, desc, &dn->data,
114 &dn->fwnode)) {
115 result = true;
116 }
117
118 if (result) {
119 dn->handle = handle;
120 dn->data.pointer = desc;
121 list_add_tail(&dn->sibling, list);
122 return true;
123 }
124
125 kfree(dn);
126 acpi_handle_debug(handle, "Invalid properties/subnodes data, skipping\n");
127 return false;
128}
129
130static bool acpi_nondev_subnode_data_ok(acpi_handle handle,
131 const union acpi_object *link,
132 struct list_head *list,
133 struct fwnode_handle *parent)
134{
135 struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER };
136 acpi_status status;
137
138 status = acpi_evaluate_object_typed(handle, NULL, NULL, &buf,
139 ACPI_TYPE_PACKAGE);
140 if (ACPI_FAILURE(status))
141 return false;
142
143 if (acpi_nondev_subnode_extract(buf.pointer, handle, link, list,
144 parent))
145 return true;
146
147 ACPI_FREE(buf.pointer);
148 return false;
149}
150
151static bool acpi_nondev_subnode_ok(acpi_handle scope,
152 const union acpi_object *link,
153 struct list_head *list,
154 struct fwnode_handle *parent)
155{
156 acpi_handle handle;
157 acpi_status status;
158
159 if (!scope)
160 return false;
161
162 status = acpi_get_handle(scope, link->package.elements[1].string.pointer,
163 &handle);
164 if (ACPI_FAILURE(status))
165 return false;
166
167 return acpi_nondev_subnode_data_ok(handle, link, list, parent);
168}
169
170static bool acpi_add_nondev_subnodes(acpi_handle scope,
171 union acpi_object *links,
172 struct list_head *list,
173 struct fwnode_handle *parent)
174{
175 bool ret = false;
176 int i;
177
178 for (i = 0; i < links->package.count; i++) {
179 union acpi_object *link, *desc;
180 acpi_handle handle;
181 bool result;
182
183 link = &links->package.elements[i];
184 /* Only two elements allowed. */
185 if (link->package.count != 2)
186 continue;
187
188 /* The first one must be a string. */
189 if (link->package.elements[0].type != ACPI_TYPE_STRING)
190 continue;
191
192 /* The second one may be a string, a reference or a package. */
193 switch (link->package.elements[1].type) {
194 case ACPI_TYPE_STRING:
195 result = acpi_nondev_subnode_ok(scope, link, list,
196 parent);
197 break;
198 case ACPI_TYPE_LOCAL_REFERENCE:
199 handle = link->package.elements[1].reference.handle;
200 result = acpi_nondev_subnode_data_ok(handle, link, list,
201 parent);
202 break;
203 case ACPI_TYPE_PACKAGE:
204 desc = &link->package.elements[1];
205 result = acpi_nondev_subnode_extract(desc, NULL, link,
206 list, parent);
207 break;
208 default:
209 result = false;
210 break;
211 }
212 ret = ret || result;
213 }
214
215 return ret;
216}
217
218static bool acpi_enumerate_nondev_subnodes(acpi_handle scope,
219 union acpi_object *desc,
220 struct acpi_device_data *data,
221 struct fwnode_handle *parent)
222{
223 int i;
224
225 /* Look for the ACPI data subnodes GUID. */
226 for (i = 0; i < desc->package.count; i += 2) {
227 const union acpi_object *guid;
228 union acpi_object *links;
229
230 guid = &desc->package.elements[i];
231 links = &desc->package.elements[i + 1];
232
233 /*
234 * The first element must be a GUID and the second one must be
235 * a package.
236 */
237 if (guid->type != ACPI_TYPE_BUFFER ||
238 guid->buffer.length != 16 ||
239 links->type != ACPI_TYPE_PACKAGE)
240 break;
241
242 if (!guid_equal((guid_t *)guid->buffer.pointer, &ads_guid))
243 continue;
244
245 return acpi_add_nondev_subnodes(scope, links, &data->subnodes,
246 parent);
247 }
248
249 return false;
250}
251
252static bool acpi_property_value_ok(const union acpi_object *value)
253{
254 int j;
255
256 /*
257 * The value must be an integer, a string, a reference, or a package
258 * whose every element must be an integer, a string, or a reference.
259 */
260 switch (value->type) {
261 case ACPI_TYPE_INTEGER:
262 case ACPI_TYPE_STRING:
263 case ACPI_TYPE_LOCAL_REFERENCE:
264 return true;
265
266 case ACPI_TYPE_PACKAGE:
267 for (j = 0; j < value->package.count; j++)
268 switch (value->package.elements[j].type) {
269 case ACPI_TYPE_INTEGER:
270 case ACPI_TYPE_STRING:
271 case ACPI_TYPE_LOCAL_REFERENCE:
272 continue;
273
274 default:
275 return false;
276 }
277
278 return true;
279 }
280 return false;
281}
282
283static bool acpi_properties_format_valid(const union acpi_object *properties)
284{
285 int i;
286
287 for (i = 0; i < properties->package.count; i++) {
288 const union acpi_object *property;
289
290 property = &properties->package.elements[i];
291 /*
292 * Only two elements allowed, the first one must be a string and
293 * the second one has to satisfy certain conditions.
294 */
295 if (property->package.count != 2
296 || property->package.elements[0].type != ACPI_TYPE_STRING
297 || !acpi_property_value_ok(&property->package.elements[1]))
298 return false;
299 }
300 return true;
301}
302
303static void acpi_init_of_compatible(struct acpi_device *adev)
304{
305 const union acpi_object *of_compatible;
306 int ret;
307
308 ret = acpi_data_get_property_array(&adev->data, "compatible",
309 ACPI_TYPE_STRING, &of_compatible);
310 if (ret) {
311 ret = acpi_dev_get_property(adev, "compatible",
312 ACPI_TYPE_STRING, &of_compatible);
313 if (ret) {
314 struct acpi_device *parent;
315
316 parent = acpi_dev_parent(adev);
317 if (parent && parent->flags.of_compatible_ok)
318 goto out;
319
320 return;
321 }
322 }
323 adev->data.of_compatible = of_compatible;
324
325 out:
326 adev->flags.of_compatible_ok = 1;
327}
328
329static bool acpi_is_property_guid(const guid_t *guid)
330{
331 int i;
332
333 for (i = 0; i < ARRAY_SIZE(prp_guids); i++) {
334 if (guid_equal(guid, &prp_guids[i]))
335 return true;
336 }
337
338 return false;
339}
340
341struct acpi_device_properties *
342acpi_data_add_props(struct acpi_device_data *data, const guid_t *guid,
343 union acpi_object *properties)
344{
345 struct acpi_device_properties *props;
346
347 props = kzalloc(sizeof(*props), GFP_KERNEL);
348 if (props) {
349 INIT_LIST_HEAD(&props->list);
350 props->guid = guid;
351 props->properties = properties;
352 list_add_tail(&props->list, &data->properties);
353 }
354
355 return props;
356}
357
358static void acpi_nondev_subnode_tag(acpi_handle handle, void *context)
359{
360}
361
362static void acpi_untie_nondev_subnodes(struct acpi_device_data *data)
363{
364 struct acpi_data_node *dn;
365
366 list_for_each_entry(dn, &data->subnodes, sibling) {
367 acpi_detach_data(dn->handle, acpi_nondev_subnode_tag);
368
369 acpi_untie_nondev_subnodes(&dn->data);
370 }
371}
372
373static bool acpi_tie_nondev_subnodes(struct acpi_device_data *data)
374{
375 struct acpi_data_node *dn;
376
377 list_for_each_entry(dn, &data->subnodes, sibling) {
378 acpi_status status;
379 bool ret;
380
381 status = acpi_attach_data(dn->handle, acpi_nondev_subnode_tag, dn);
382 if (ACPI_FAILURE(status) && status != AE_ALREADY_EXISTS) {
383 acpi_handle_err(dn->handle, "Can't tag data node\n");
384 return false;
385 }
386
387 ret = acpi_tie_nondev_subnodes(&dn->data);
388 if (!ret)
389 return ret;
390 }
391
392 return true;
393}
394
395static void acpi_data_add_buffer_props(acpi_handle handle,
396 struct acpi_device_data *data,
397 union acpi_object *properties)
398{
399 struct acpi_device_properties *props;
400 union acpi_object *package;
401 size_t alloc_size;
402 unsigned int i;
403 u32 *count;
404
405 if (check_mul_overflow((size_t)properties->package.count,
406 sizeof(*package) + sizeof(void *),
407 &alloc_size) ||
408 check_add_overflow(sizeof(*props) + sizeof(*package), alloc_size,
409 &alloc_size)) {
410 acpi_handle_warn(handle,
411 "can't allocate memory for %u buffer props",
412 properties->package.count);
413 return;
414 }
415
416 props = kvzalloc(alloc_size, GFP_KERNEL);
417 if (!props)
418 return;
419
420 props->guid = &buffer_prop_guid;
421 props->bufs = (void *)(props + 1);
422 props->properties = (void *)(props->bufs + properties->package.count);
423
424 /* Outer package */
425 package = props->properties;
426 package->type = ACPI_TYPE_PACKAGE;
427 package->package.elements = package + 1;
428 count = &package->package.count;
429 *count = 0;
430
431 /* Inner packages */
432 package++;
433
434 for (i = 0; i < properties->package.count; i++) {
435 struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER };
436 union acpi_object *property = &properties->package.elements[i];
437 union acpi_object *prop, *obj, *buf_obj;
438 acpi_status status;
439
440 if (property->type != ACPI_TYPE_PACKAGE ||
441 property->package.count != 2) {
442 acpi_handle_warn(handle,
443 "buffer property %u has %u entries\n",
444 i, property->package.count);
445 continue;
446 }
447
448 prop = &property->package.elements[0];
449 obj = &property->package.elements[1];
450
451 if (prop->type != ACPI_TYPE_STRING ||
452 obj->type != ACPI_TYPE_STRING) {
453 acpi_handle_warn(handle,
454 "wrong object types %u and %u\n",
455 prop->type, obj->type);
456 continue;
457 }
458
459 status = acpi_evaluate_object_typed(handle, obj->string.pointer,
460 NULL, &buf,
461 ACPI_TYPE_BUFFER);
462 if (ACPI_FAILURE(status)) {
463 acpi_handle_warn(handle,
464 "can't evaluate \"%*pE\" as buffer\n",
465 obj->string.length,
466 obj->string.pointer);
467 continue;
468 }
469
470 package->type = ACPI_TYPE_PACKAGE;
471 package->package.elements = prop;
472 package->package.count = 2;
473
474 buf_obj = buf.pointer;
475
476 /* Replace the string object with a buffer object */
477 obj->type = ACPI_TYPE_BUFFER;
478 obj->buffer.length = buf_obj->buffer.length;
479 obj->buffer.pointer = buf_obj->buffer.pointer;
480
481 props->bufs[i] = buf.pointer;
482 package++;
483 (*count)++;
484 }
485
486 if (*count)
487 list_add(&props->list, &data->properties);
488 else
489 kvfree(props);
490}
491
492static bool acpi_extract_properties(acpi_handle scope, union acpi_object *desc,
493 struct acpi_device_data *data)
494{
495 int i;
496
497 if (desc->package.count % 2)
498 return false;
499
500 /* Look for the device properties GUID. */
501 for (i = 0; i < desc->package.count; i += 2) {
502 const union acpi_object *guid;
503 union acpi_object *properties;
504
505 guid = &desc->package.elements[i];
506 properties = &desc->package.elements[i + 1];
507
508 /*
509 * The first element must be a GUID and the second one must be
510 * a package.
511 */
512 if (guid->type != ACPI_TYPE_BUFFER ||
513 guid->buffer.length != 16 ||
514 properties->type != ACPI_TYPE_PACKAGE)
515 break;
516
517 if (guid_equal((guid_t *)guid->buffer.pointer,
518 &buffer_prop_guid)) {
519 acpi_data_add_buffer_props(scope, data, properties);
520 continue;
521 }
522
523 if (!acpi_is_property_guid((guid_t *)guid->buffer.pointer))
524 continue;
525
526 /*
527 * We found the matching GUID. Now validate the format of the
528 * package immediately following it.
529 */
530 if (!acpi_properties_format_valid(properties))
531 continue;
532
533 acpi_data_add_props(data, (const guid_t *)guid->buffer.pointer,
534 properties);
535 }
536
537 return !list_empty(&data->properties);
538}
539
540void acpi_init_properties(struct acpi_device *adev)
541{
542 struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER };
543 struct acpi_hardware_id *hwid;
544 acpi_status status;
545 bool acpi_of = false;
546
547 INIT_LIST_HEAD(&adev->data.properties);
548 INIT_LIST_HEAD(&adev->data.subnodes);
549
550 if (!adev->handle)
551 return;
552
553 /*
554 * Check if ACPI_DT_NAMESPACE_HID is present and inthat case we fill in
555 * Device Tree compatible properties for this device.
556 */
557 list_for_each_entry(hwid, &adev->pnp.ids, list) {
558 if (!strcmp(hwid->id, ACPI_DT_NAMESPACE_HID)) {
559 acpi_of = true;
560 break;
561 }
562 }
563
564 status = acpi_evaluate_object_typed(adev->handle, "_DSD", NULL, &buf,
565 ACPI_TYPE_PACKAGE);
566 if (ACPI_FAILURE(status))
567 goto out;
568
569 if (acpi_extract_properties(adev->handle, buf.pointer, &adev->data)) {
570 adev->data.pointer = buf.pointer;
571 if (acpi_of)
572 acpi_init_of_compatible(adev);
573 }
574 if (acpi_enumerate_nondev_subnodes(adev->handle, buf.pointer,
575 &adev->data, acpi_fwnode_handle(adev)))
576 adev->data.pointer = buf.pointer;
577
578 if (!adev->data.pointer) {
579 acpi_handle_debug(adev->handle, "Invalid _DSD data, skipping\n");
580 ACPI_FREE(buf.pointer);
581 } else {
582 if (!acpi_tie_nondev_subnodes(&adev->data))
583 acpi_untie_nondev_subnodes(&adev->data);
584 }
585
586 out:
587 if (acpi_of && !adev->flags.of_compatible_ok)
588 acpi_handle_info(adev->handle,
589 ACPI_DT_NAMESPACE_HID " requires 'compatible' property\n");
590
591 if (!adev->data.pointer)
592 acpi_extract_apple_properties(adev);
593}
594
595static void acpi_free_device_properties(struct list_head *list)
596{
597 struct acpi_device_properties *props, *tmp;
598
599 list_for_each_entry_safe(props, tmp, list, list) {
600 u32 i;
601
602 list_del(&props->list);
603 /* Buffer data properties were separately allocated */
604 if (props->bufs)
605 for (i = 0; i < props->properties->package.count; i++)
606 ACPI_FREE(props->bufs[i]);
607 kvfree(props);
608 }
609}
610
611static void acpi_destroy_nondev_subnodes(struct list_head *list)
612{
613 struct acpi_data_node *dn, *next;
614
615 if (list_empty(list))
616 return;
617
618 list_for_each_entry_safe_reverse(dn, next, list, sibling) {
619 acpi_destroy_nondev_subnodes(&dn->data.subnodes);
620 wait_for_completion(&dn->kobj_done);
621 list_del(&dn->sibling);
622 ACPI_FREE((void *)dn->data.pointer);
623 acpi_free_device_properties(&dn->data.properties);
624 kfree(dn);
625 }
626}
627
628void acpi_free_properties(struct acpi_device *adev)
629{
630 acpi_untie_nondev_subnodes(&adev->data);
631 acpi_destroy_nondev_subnodes(&adev->data.subnodes);
632 ACPI_FREE((void *)adev->data.pointer);
633 adev->data.of_compatible = NULL;
634 adev->data.pointer = NULL;
635 acpi_free_device_properties(&adev->data.properties);
636}
637
638/**
639 * acpi_data_get_property - return an ACPI property with given name
640 * @data: ACPI device deta object to get the property from
641 * @name: Name of the property
642 * @type: Expected property type
643 * @obj: Location to store the property value (if not %NULL)
644 *
645 * Look up a property with @name and store a pointer to the resulting ACPI
646 * object at the location pointed to by @obj if found.
647 *
648 * Callers must not attempt to free the returned objects. These objects will be
649 * freed by the ACPI core automatically during the removal of @data.
650 *
651 * Return: %0 if property with @name has been found (success),
652 * %-EINVAL if the arguments are invalid,
653 * %-EINVAL if the property doesn't exist,
654 * %-EPROTO if the property value type doesn't match @type.
655 */
656static int acpi_data_get_property(const struct acpi_device_data *data,
657 const char *name, acpi_object_type type,
658 const union acpi_object **obj)
659{
660 const struct acpi_device_properties *props;
661
662 if (!data || !name)
663 return -EINVAL;
664
665 if (!data->pointer || list_empty(&data->properties))
666 return -EINVAL;
667
668 list_for_each_entry(props, &data->properties, list) {
669 const union acpi_object *properties;
670 unsigned int i;
671
672 properties = props->properties;
673 for (i = 0; i < properties->package.count; i++) {
674 const union acpi_object *propname, *propvalue;
675 const union acpi_object *property;
676
677 property = &properties->package.elements[i];
678
679 propname = &property->package.elements[0];
680 propvalue = &property->package.elements[1];
681
682 if (!strcmp(name, propname->string.pointer)) {
683 if (type != ACPI_TYPE_ANY &&
684 propvalue->type != type)
685 return -EPROTO;
686 if (obj)
687 *obj = propvalue;
688
689 return 0;
690 }
691 }
692 }
693 return -EINVAL;
694}
695
696/**
697 * acpi_dev_get_property - return an ACPI property with given name.
698 * @adev: ACPI device to get the property from.
699 * @name: Name of the property.
700 * @type: Expected property type.
701 * @obj: Location to store the property value (if not %NULL).
702 */
703int acpi_dev_get_property(const struct acpi_device *adev, const char *name,
704 acpi_object_type type, const union acpi_object **obj)
705{
706 return adev ? acpi_data_get_property(&adev->data, name, type, obj) : -EINVAL;
707}
708EXPORT_SYMBOL_GPL(acpi_dev_get_property);
709
710static const struct acpi_device_data *
711acpi_device_data_of_node(const struct fwnode_handle *fwnode)
712{
713 if (is_acpi_device_node(fwnode)) {
714 const struct acpi_device *adev = to_acpi_device_node(fwnode);
715 return &adev->data;
716 }
717 if (is_acpi_data_node(fwnode)) {
718 const struct acpi_data_node *dn = to_acpi_data_node(fwnode);
719 return &dn->data;
720 }
721 return NULL;
722}
723
724/**
725 * acpi_node_prop_get - return an ACPI property with given name.
726 * @fwnode: Firmware node to get the property from.
727 * @propname: Name of the property.
728 * @valptr: Location to store a pointer to the property value (if not %NULL).
729 */
730int acpi_node_prop_get(const struct fwnode_handle *fwnode,
731 const char *propname, void **valptr)
732{
733 return acpi_data_get_property(acpi_device_data_of_node(fwnode),
734 propname, ACPI_TYPE_ANY,
735 (const union acpi_object **)valptr);
736}
737
738/**
739 * acpi_data_get_property_array - return an ACPI array property with given name
740 * @data: ACPI data object to get the property from
741 * @name: Name of the property
742 * @type: Expected type of array elements
743 * @obj: Location to store a pointer to the property value (if not NULL)
744 *
745 * Look up an array property with @name and store a pointer to the resulting
746 * ACPI object at the location pointed to by @obj if found.
747 *
748 * Callers must not attempt to free the returned objects. Those objects will be
749 * freed by the ACPI core automatically during the removal of @data.
750 *
751 * Return: %0 if array property (package) with @name has been found (success),
752 * %-EINVAL if the arguments are invalid,
753 * %-EINVAL if the property doesn't exist,
754 * %-EPROTO if the property is not a package or the type of its elements
755 * doesn't match @type.
756 */
757static int acpi_data_get_property_array(const struct acpi_device_data *data,
758 const char *name,
759 acpi_object_type type,
760 const union acpi_object **obj)
761{
762 const union acpi_object *prop;
763 int ret, i;
764
765 ret = acpi_data_get_property(data, name, ACPI_TYPE_PACKAGE, &prop);
766 if (ret)
767 return ret;
768
769 if (type != ACPI_TYPE_ANY) {
770 /* Check that all elements are of correct type. */
771 for (i = 0; i < prop->package.count; i++)
772 if (prop->package.elements[i].type != type)
773 return -EPROTO;
774 }
775 if (obj)
776 *obj = prop;
777
778 return 0;
779}
780
781static struct fwnode_handle *
782acpi_fwnode_get_named_child_node(const struct fwnode_handle *fwnode,
783 const char *childname)
784{
785 struct fwnode_handle *child;
786
787 fwnode_for_each_child_node(fwnode, child) {
788 if (is_acpi_data_node(child)) {
789 if (acpi_data_node_match(child, childname))
790 return child;
791 continue;
792 }
793
794 if (!strncmp(acpi_device_bid(to_acpi_device_node(child)),
795 childname, ACPI_NAMESEG_SIZE))
796 return child;
797 }
798
799 return NULL;
800}
801
802static int acpi_get_ref_args(struct fwnode_reference_args *args,
803 struct fwnode_handle *ref_fwnode,
804 const union acpi_object **element,
805 const union acpi_object *end, size_t num_args)
806{
807 u32 nargs = 0, i;
808
809 /*
810 * Assume the following integer elements are all args. Stop counting on
811 * the first reference (possibly represented as a string) or end of the
812 * package arguments. In case of neither reference, nor integer, return
813 * an error, we can't parse it.
814 */
815 for (i = 0; (*element) + i < end && i < num_args; i++) {
816 acpi_object_type type = (*element)[i].type;
817
818 if (type == ACPI_TYPE_LOCAL_REFERENCE || type == ACPI_TYPE_STRING)
819 break;
820
821 if (type == ACPI_TYPE_INTEGER)
822 nargs++;
823 else
824 return -EINVAL;
825 }
826
827 if (nargs > NR_FWNODE_REFERENCE_ARGS)
828 return -EINVAL;
829
830 if (args) {
831 args->fwnode = ref_fwnode;
832 args->nargs = nargs;
833 for (i = 0; i < nargs; i++)
834 args->args[i] = (*element)[i].integer.value;
835 }
836
837 (*element) += nargs;
838
839 return 0;
840}
841
842static struct fwnode_handle *acpi_parse_string_ref(const struct fwnode_handle *fwnode,
843 const char *refstring)
844{
845 acpi_handle scope, handle;
846 struct acpi_data_node *dn;
847 struct acpi_device *device;
848 acpi_status status;
849
850 if (is_acpi_device_node(fwnode)) {
851 scope = to_acpi_device_node(fwnode)->handle;
852 } else if (is_acpi_data_node(fwnode)) {
853 scope = to_acpi_data_node(fwnode)->handle;
854 } else {
855 pr_debug("Bad node type for node %pfw\n", fwnode);
856 return NULL;
857 }
858
859 status = acpi_get_handle(scope, refstring, &handle);
860 if (ACPI_FAILURE(status)) {
861 acpi_handle_debug(scope, "Unable to get an ACPI handle for %s\n",
862 refstring);
863 return NULL;
864 }
865
866 device = acpi_fetch_acpi_dev(handle);
867 if (device)
868 return acpi_fwnode_handle(device);
869
870 status = acpi_get_data_full(handle, acpi_nondev_subnode_tag,
871 (void **)&dn, NULL);
872 if (ACPI_FAILURE(status) || !dn) {
873 acpi_handle_debug(handle, "Subnode not found\n");
874 return NULL;
875 }
876
877 return &dn->fwnode;
878}
879
880/**
881 * __acpi_node_get_property_reference - returns handle to the referenced object
882 * @fwnode: Firmware node to get the property from
883 * @propname: Name of the property
884 * @index: Index of the reference to return
885 * @num_args: Maximum number of arguments after each reference
886 * @args: Location to store the returned reference with optional arguments
887 * (may be NULL)
888 *
889 * Find property with @name, verifify that it is a package containing at least
890 * one object reference and if so, store the ACPI device object pointer to the
891 * target object in @args->adev. If the reference includes arguments, store
892 * them in the @args->args[] array.
893 *
894 * If there's more than one reference in the property value package, @index is
895 * used to select the one to return.
896 *
897 * It is possible to leave holes in the property value set like in the
898 * example below:
899 *
900 * Package () {
901 * "cs-gpios",
902 * Package () {
903 * ^GPIO, 19, 0, 0,
904 * ^GPIO, 20, 0, 0,
905 * 0,
906 * ^GPIO, 21, 0, 0,
907 * }
908 * }
909 *
910 * Calling this function with index %2 or index %3 return %-ENOENT. If the
911 * property does not contain any more values %-ENOENT is returned. The NULL
912 * entry must be single integer and preferably contain value %0.
913 *
914 * Return: %0 on success, negative error code on failure.
915 */
916int __acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
917 const char *propname, size_t index, size_t num_args,
918 struct fwnode_reference_args *args)
919{
920 const union acpi_object *element, *end;
921 const union acpi_object *obj;
922 const struct acpi_device_data *data;
923 struct fwnode_handle *ref_fwnode;
924 struct acpi_device *device;
925 int ret, idx = 0;
926
927 data = acpi_device_data_of_node(fwnode);
928 if (!data)
929 return -ENOENT;
930
931 ret = acpi_data_get_property(data, propname, ACPI_TYPE_ANY, &obj);
932 if (ret)
933 return ret == -EINVAL ? -ENOENT : -EINVAL;
934
935 switch (obj->type) {
936 case ACPI_TYPE_LOCAL_REFERENCE:
937 /* Plain single reference without arguments. */
938 if (index)
939 return -ENOENT;
940
941 device = acpi_fetch_acpi_dev(obj->reference.handle);
942 if (!device)
943 return -EINVAL;
944
945 if (!args)
946 return 0;
947
948 args->fwnode = acpi_fwnode_handle(device);
949 args->nargs = 0;
950
951 return 0;
952 case ACPI_TYPE_STRING:
953 if (index)
954 return -ENOENT;
955
956 ref_fwnode = acpi_parse_string_ref(fwnode, obj->string.pointer);
957 if (!ref_fwnode)
958 return -EINVAL;
959
960 args->fwnode = ref_fwnode;
961 args->nargs = 0;
962
963 return 0;
964 case ACPI_TYPE_PACKAGE:
965 /*
966 * If it is not a single reference, then it is a package of
967 * references, followed by number of ints as follows:
968 *
969 * Package () { REF, INT, REF, INT, INT }
970 *
971 * Here, REF may be either a local reference or a string. The
972 * index argument is then used to determine which reference the
973 * caller wants (along with the arguments).
974 */
975 break;
976 default:
977 return -EINVAL;
978 }
979
980 if (index >= obj->package.count)
981 return -ENOENT;
982
983 element = obj->package.elements;
984 end = element + obj->package.count;
985
986 while (element < end) {
987 switch (element->type) {
988 case ACPI_TYPE_LOCAL_REFERENCE:
989 device = acpi_fetch_acpi_dev(element->reference.handle);
990 if (!device)
991 return -EINVAL;
992
993 element++;
994
995 ret = acpi_get_ref_args(idx == index ? args : NULL,
996 acpi_fwnode_handle(device),
997 &element, end, num_args);
998 if (ret < 0)
999 return ret;
1000
1001 if (idx == index)
1002 return 0;
1003
1004 break;
1005 case ACPI_TYPE_STRING:
1006 ref_fwnode = acpi_parse_string_ref(fwnode,
1007 element->string.pointer);
1008 if (!ref_fwnode)
1009 return -EINVAL;
1010
1011 element++;
1012
1013 ret = acpi_get_ref_args(idx == index ? args : NULL,
1014 ref_fwnode, &element, end,
1015 num_args);
1016 if (ret < 0)
1017 return ret;
1018
1019 if (idx == index)
1020 return 0;
1021
1022 break;
1023 case ACPI_TYPE_INTEGER:
1024 if (idx == index)
1025 return -ENOENT;
1026 element++;
1027 break;
1028 default:
1029 return -EINVAL;
1030 }
1031
1032 idx++;
1033 }
1034
1035 return -ENOENT;
1036}
1037EXPORT_SYMBOL_GPL(__acpi_node_get_property_reference);
1038
1039static int acpi_data_prop_read_single(const struct acpi_device_data *data,
1040 const char *propname,
1041 enum dev_prop_type proptype, void *val)
1042{
1043 const union acpi_object *obj;
1044 int ret = 0;
1045
1046 if (proptype >= DEV_PROP_U8 && proptype <= DEV_PROP_U64)
1047 ret = acpi_data_get_property(data, propname, ACPI_TYPE_INTEGER, &obj);
1048 else if (proptype == DEV_PROP_STRING)
1049 ret = acpi_data_get_property(data, propname, ACPI_TYPE_STRING, &obj);
1050 if (ret)
1051 return ret;
1052
1053 switch (proptype) {
1054 case DEV_PROP_U8:
1055 if (obj->integer.value > U8_MAX)
1056 return -EOVERFLOW;
1057 if (val)
1058 *(u8 *)val = obj->integer.value;
1059 break;
1060 case DEV_PROP_U16:
1061 if (obj->integer.value > U16_MAX)
1062 return -EOVERFLOW;
1063 if (val)
1064 *(u16 *)val = obj->integer.value;
1065 break;
1066 case DEV_PROP_U32:
1067 if (obj->integer.value > U32_MAX)
1068 return -EOVERFLOW;
1069 if (val)
1070 *(u32 *)val = obj->integer.value;
1071 break;
1072 case DEV_PROP_U64:
1073 if (val)
1074 *(u64 *)val = obj->integer.value;
1075 break;
1076 case DEV_PROP_STRING:
1077 if (val)
1078 *(char **)val = obj->string.pointer;
1079 return 1;
1080 default:
1081 return -EINVAL;
1082 }
1083
1084 /* When no storage provided return number of available values */
1085 return val ? 0 : 1;
1086}
1087
1088#define acpi_copy_property_array_uint(items, val, nval) \
1089 ({ \
1090 typeof(items) __items = items; \
1091 typeof(val) __val = val; \
1092 typeof(nval) __nval = nval; \
1093 size_t i; \
1094 int ret = 0; \
1095 \
1096 for (i = 0; i < __nval; i++) { \
1097 if (__items->type == ACPI_TYPE_BUFFER) { \
1098 __val[i] = __items->buffer.pointer[i]; \
1099 continue; \
1100 } \
1101 if (__items[i].type != ACPI_TYPE_INTEGER) { \
1102 ret = -EPROTO; \
1103 break; \
1104 } \
1105 if (__items[i].integer.value > _Generic(__val, \
1106 u8 *: U8_MAX, \
1107 u16 *: U16_MAX, \
1108 u32 *: U32_MAX, \
1109 u64 *: U64_MAX)) { \
1110 ret = -EOVERFLOW; \
1111 break; \
1112 } \
1113 \
1114 __val[i] = __items[i].integer.value; \
1115 } \
1116 ret; \
1117 })
1118
1119static int acpi_copy_property_array_string(const union acpi_object *items,
1120 char **val, size_t nval)
1121{
1122 int i;
1123
1124 for (i = 0; i < nval; i++) {
1125 if (items[i].type != ACPI_TYPE_STRING)
1126 return -EPROTO;
1127
1128 val[i] = items[i].string.pointer;
1129 }
1130 return nval;
1131}
1132
1133static int acpi_data_prop_read(const struct acpi_device_data *data,
1134 const char *propname,
1135 enum dev_prop_type proptype,
1136 void *val, size_t nval)
1137{
1138 const union acpi_object *obj;
1139 const union acpi_object *items;
1140 int ret;
1141
1142 if (nval == 1 || !val) {
1143 ret = acpi_data_prop_read_single(data, propname, proptype, val);
1144 /*
1145 * The overflow error means that the property is there and it is
1146 * single-value, but its type does not match, so return.
1147 */
1148 if (ret >= 0 || ret == -EOVERFLOW)
1149 return ret;
1150
1151 /*
1152 * Reading this property as a single-value one failed, but its
1153 * value may still be represented as one-element array, so
1154 * continue.
1155 */
1156 }
1157
1158 ret = acpi_data_get_property_array(data, propname, ACPI_TYPE_ANY, &obj);
1159 if (ret && proptype >= DEV_PROP_U8 && proptype <= DEV_PROP_U64)
1160 ret = acpi_data_get_property(data, propname, ACPI_TYPE_BUFFER,
1161 &obj);
1162 if (ret)
1163 return ret;
1164
1165 if (!val) {
1166 if (obj->type == ACPI_TYPE_BUFFER)
1167 return obj->buffer.length;
1168
1169 return obj->package.count;
1170 }
1171
1172 switch (proptype) {
1173 case DEV_PROP_STRING:
1174 break;
1175 default:
1176 if (obj->type == ACPI_TYPE_BUFFER) {
1177 if (nval > obj->buffer.length)
1178 return -EOVERFLOW;
1179 } else {
1180 if (nval > obj->package.count)
1181 return -EOVERFLOW;
1182 }
1183 break;
1184 }
1185 if (nval == 0)
1186 return -EINVAL;
1187
1188 if (obj->type == ACPI_TYPE_BUFFER) {
1189 if (proptype != DEV_PROP_U8)
1190 return -EPROTO;
1191 items = obj;
1192 } else {
1193 items = obj->package.elements;
1194 }
1195
1196 switch (proptype) {
1197 case DEV_PROP_U8:
1198 ret = acpi_copy_property_array_uint(items, (u8 *)val, nval);
1199 break;
1200 case DEV_PROP_U16:
1201 ret = acpi_copy_property_array_uint(items, (u16 *)val, nval);
1202 break;
1203 case DEV_PROP_U32:
1204 ret = acpi_copy_property_array_uint(items, (u32 *)val, nval);
1205 break;
1206 case DEV_PROP_U64:
1207 ret = acpi_copy_property_array_uint(items, (u64 *)val, nval);
1208 break;
1209 case DEV_PROP_STRING:
1210 ret = acpi_copy_property_array_string(
1211 items, (char **)val,
1212 min_t(u32, nval, obj->package.count));
1213 break;
1214 default:
1215 ret = -EINVAL;
1216 break;
1217 }
1218 return ret;
1219}
1220
1221/**
1222 * acpi_node_prop_read - retrieve the value of an ACPI property with given name.
1223 * @fwnode: Firmware node to get the property from.
1224 * @propname: Name of the property.
1225 * @proptype: Expected property type.
1226 * @val: Location to store the property value (if not %NULL).
1227 * @nval: Size of the array pointed to by @val.
1228 *
1229 * If @val is %NULL, return the number of array elements comprising the value
1230 * of the property. Otherwise, read at most @nval values to the array at the
1231 * location pointed to by @val.
1232 */
1233static int acpi_node_prop_read(const struct fwnode_handle *fwnode,
1234 const char *propname, enum dev_prop_type proptype,
1235 void *val, size_t nval)
1236{
1237 return acpi_data_prop_read(acpi_device_data_of_node(fwnode),
1238 propname, proptype, val, nval);
1239}
1240
1241static int stop_on_next(struct acpi_device *adev, void *data)
1242{
1243 struct acpi_device **ret_p = data;
1244
1245 if (!*ret_p) {
1246 *ret_p = adev;
1247 return 1;
1248 }
1249
1250 /* Skip until the "previous" object is found. */
1251 if (*ret_p == adev)
1252 *ret_p = NULL;
1253
1254 return 0;
1255}
1256
1257/**
1258 * acpi_get_next_subnode - Return the next child node handle for a fwnode
1259 * @fwnode: Firmware node to find the next child node for.
1260 * @child: Handle to one of the device's child nodes or a null handle.
1261 */
1262struct fwnode_handle *acpi_get_next_subnode(const struct fwnode_handle *fwnode,
1263 struct fwnode_handle *child)
1264{
1265 struct acpi_device *adev = to_acpi_device_node(fwnode);
1266
1267 if ((!child || is_acpi_device_node(child)) && adev) {
1268 struct acpi_device *child_adev = to_acpi_device_node(child);
1269
1270 acpi_dev_for_each_child(adev, stop_on_next, &child_adev);
1271 if (child_adev)
1272 return acpi_fwnode_handle(child_adev);
1273
1274 child = NULL;
1275 }
1276
1277 if (!child || is_acpi_data_node(child)) {
1278 const struct acpi_data_node *data = to_acpi_data_node(fwnode);
1279 const struct list_head *head;
1280 struct list_head *next;
1281 struct acpi_data_node *dn;
1282
1283 /*
1284 * We can have a combination of device and data nodes, e.g. with
1285 * hierarchical _DSD properties. Make sure the adev pointer is
1286 * restored before going through data nodes, otherwise we will
1287 * be looking for data_nodes below the last device found instead
1288 * of the common fwnode shared by device_nodes and data_nodes.
1289 */
1290 adev = to_acpi_device_node(fwnode);
1291 if (adev)
1292 head = &adev->data.subnodes;
1293 else if (data)
1294 head = &data->data.subnodes;
1295 else
1296 return NULL;
1297
1298 if (list_empty(head))
1299 return NULL;
1300
1301 if (child) {
1302 dn = to_acpi_data_node(child);
1303 next = dn->sibling.next;
1304 if (next == head)
1305 return NULL;
1306
1307 dn = list_entry(next, struct acpi_data_node, sibling);
1308 } else {
1309 dn = list_first_entry(head, struct acpi_data_node, sibling);
1310 }
1311 return &dn->fwnode;
1312 }
1313 return NULL;
1314}
1315
1316/**
1317 * acpi_node_get_parent - Return parent fwnode of this fwnode
1318 * @fwnode: Firmware node whose parent to get
1319 *
1320 * Returns parent node of an ACPI device or data firmware node or %NULL if
1321 * not available.
1322 */
1323static struct fwnode_handle *
1324acpi_node_get_parent(const struct fwnode_handle *fwnode)
1325{
1326 if (is_acpi_data_node(fwnode)) {
1327 /* All data nodes have parent pointer so just return that */
1328 return to_acpi_data_node(fwnode)->parent;
1329 }
1330 if (is_acpi_device_node(fwnode)) {
1331 struct acpi_device *parent;
1332
1333 parent = acpi_dev_parent(to_acpi_device_node(fwnode));
1334 if (parent)
1335 return acpi_fwnode_handle(parent);
1336 }
1337
1338 return NULL;
1339}
1340
1341/*
1342 * Return true if the node is an ACPI graph node. Called on either ports
1343 * or endpoints.
1344 */
1345static bool is_acpi_graph_node(struct fwnode_handle *fwnode,
1346 const char *str)
1347{
1348 unsigned int len = strlen(str);
1349 const char *name;
1350
1351 if (!len || !is_acpi_data_node(fwnode))
1352 return false;
1353
1354 name = to_acpi_data_node(fwnode)->name;
1355
1356 return (fwnode_property_present(fwnode, "reg") &&
1357 !strncmp(name, str, len) && name[len] == '@') ||
1358 fwnode_property_present(fwnode, str);
1359}
1360
1361/**
1362 * acpi_graph_get_next_endpoint - Get next endpoint ACPI firmware node
1363 * @fwnode: Pointer to the parent firmware node
1364 * @prev: Previous endpoint node or %NULL to get the first
1365 *
1366 * Looks up next endpoint ACPI firmware node below a given @fwnode. Returns
1367 * %NULL if there is no next endpoint or in case of error. In case of success
1368 * the next endpoint is returned.
1369 */
1370static struct fwnode_handle *acpi_graph_get_next_endpoint(
1371 const struct fwnode_handle *fwnode, struct fwnode_handle *prev)
1372{
1373 struct fwnode_handle *port = NULL;
1374 struct fwnode_handle *endpoint;
1375
1376 if (!prev) {
1377 do {
1378 port = fwnode_get_next_child_node(fwnode, port);
1379 /*
1380 * The names of the port nodes begin with "port@"
1381 * followed by the number of the port node and they also
1382 * have a "reg" property that also has the number of the
1383 * port node. For compatibility reasons a node is also
1384 * recognised as a port node from the "port" property.
1385 */
1386 if (is_acpi_graph_node(port, "port"))
1387 break;
1388 } while (port);
1389 } else {
1390 port = fwnode_get_parent(prev);
1391 }
1392
1393 if (!port)
1394 return NULL;
1395
1396 endpoint = fwnode_get_next_child_node(port, prev);
1397 while (!endpoint) {
1398 port = fwnode_get_next_child_node(fwnode, port);
1399 if (!port)
1400 break;
1401 if (is_acpi_graph_node(port, "port"))
1402 endpoint = fwnode_get_next_child_node(port, NULL);
1403 }
1404
1405 /*
1406 * The names of the endpoint nodes begin with "endpoint@" followed by
1407 * the number of the endpoint node and they also have a "reg" property
1408 * that also has the number of the endpoint node. For compatibility
1409 * reasons a node is also recognised as an endpoint node from the
1410 * "endpoint" property.
1411 */
1412 if (!is_acpi_graph_node(endpoint, "endpoint"))
1413 return NULL;
1414
1415 return endpoint;
1416}
1417
1418/**
1419 * acpi_graph_get_child_prop_value - Return a child with a given property value
1420 * @fwnode: device fwnode
1421 * @prop_name: The name of the property to look for
1422 * @val: the desired property value
1423 *
1424 * Return the port node corresponding to a given port number. Returns
1425 * the child node on success, NULL otherwise.
1426 */
1427static struct fwnode_handle *acpi_graph_get_child_prop_value(
1428 const struct fwnode_handle *fwnode, const char *prop_name,
1429 unsigned int val)
1430{
1431 struct fwnode_handle *child;
1432
1433 fwnode_for_each_child_node(fwnode, child) {
1434 u32 nr;
1435
1436 if (fwnode_property_read_u32(child, prop_name, &nr))
1437 continue;
1438
1439 if (val == nr)
1440 return child;
1441 }
1442
1443 return NULL;
1444}
1445
1446
1447/**
1448 * acpi_graph_get_remote_endpoint - Parses and returns remote end of an endpoint
1449 * @__fwnode: Endpoint firmware node pointing to a remote device
1450 *
1451 * Returns the remote endpoint corresponding to @__fwnode. NULL on error.
1452 */
1453static struct fwnode_handle *
1454acpi_graph_get_remote_endpoint(const struct fwnode_handle *__fwnode)
1455{
1456 struct fwnode_handle *fwnode;
1457 unsigned int port_nr, endpoint_nr;
1458 struct fwnode_reference_args args;
1459 int ret;
1460
1461 memset(&args, 0, sizeof(args));
1462 ret = acpi_node_get_property_reference(__fwnode, "remote-endpoint", 0,
1463 &args);
1464 if (ret)
1465 return NULL;
1466
1467 /* Direct endpoint reference? */
1468 if (!is_acpi_device_node(args.fwnode))
1469 return args.nargs ? NULL : args.fwnode;
1470
1471 /*
1472 * Always require two arguments with the reference: port and
1473 * endpoint indices.
1474 */
1475 if (args.nargs != 2)
1476 return NULL;
1477
1478 fwnode = args.fwnode;
1479 port_nr = args.args[0];
1480 endpoint_nr = args.args[1];
1481
1482 fwnode = acpi_graph_get_child_prop_value(fwnode, "port", port_nr);
1483
1484 return acpi_graph_get_child_prop_value(fwnode, "endpoint", endpoint_nr);
1485}
1486
1487static bool acpi_fwnode_device_is_available(const struct fwnode_handle *fwnode)
1488{
1489 if (!is_acpi_device_node(fwnode))
1490 return false;
1491
1492 return acpi_device_is_present(to_acpi_device_node(fwnode));
1493}
1494
1495static const void *
1496acpi_fwnode_device_get_match_data(const struct fwnode_handle *fwnode,
1497 const struct device *dev)
1498{
1499 return acpi_device_get_match_data(dev);
1500}
1501
1502static bool acpi_fwnode_device_dma_supported(const struct fwnode_handle *fwnode)
1503{
1504 return acpi_dma_supported(to_acpi_device_node(fwnode));
1505}
1506
1507static enum dev_dma_attr
1508acpi_fwnode_device_get_dma_attr(const struct fwnode_handle *fwnode)
1509{
1510 return acpi_get_dma_attr(to_acpi_device_node(fwnode));
1511}
1512
1513static bool acpi_fwnode_property_present(const struct fwnode_handle *fwnode,
1514 const char *propname)
1515{
1516 return !acpi_node_prop_get(fwnode, propname, NULL);
1517}
1518
1519static int
1520acpi_fwnode_property_read_int_array(const struct fwnode_handle *fwnode,
1521 const char *propname,
1522 unsigned int elem_size, void *val,
1523 size_t nval)
1524{
1525 enum dev_prop_type type;
1526
1527 switch (elem_size) {
1528 case sizeof(u8):
1529 type = DEV_PROP_U8;
1530 break;
1531 case sizeof(u16):
1532 type = DEV_PROP_U16;
1533 break;
1534 case sizeof(u32):
1535 type = DEV_PROP_U32;
1536 break;
1537 case sizeof(u64):
1538 type = DEV_PROP_U64;
1539 break;
1540 default:
1541 return -ENXIO;
1542 }
1543
1544 return acpi_node_prop_read(fwnode, propname, type, val, nval);
1545}
1546
1547static int
1548acpi_fwnode_property_read_string_array(const struct fwnode_handle *fwnode,
1549 const char *propname, const char **val,
1550 size_t nval)
1551{
1552 return acpi_node_prop_read(fwnode, propname, DEV_PROP_STRING,
1553 val, nval);
1554}
1555
1556static int
1557acpi_fwnode_get_reference_args(const struct fwnode_handle *fwnode,
1558 const char *prop, const char *nargs_prop,
1559 unsigned int args_count, unsigned int index,
1560 struct fwnode_reference_args *args)
1561{
1562 return __acpi_node_get_property_reference(fwnode, prop, index,
1563 args_count, args);
1564}
1565
1566static const char *acpi_fwnode_get_name(const struct fwnode_handle *fwnode)
1567{
1568 const struct acpi_device *adev;
1569 struct fwnode_handle *parent;
1570
1571 /* Is this the root node? */
1572 parent = fwnode_get_parent(fwnode);
1573 if (!parent)
1574 return "\\";
1575
1576 fwnode_handle_put(parent);
1577
1578 if (is_acpi_data_node(fwnode)) {
1579 const struct acpi_data_node *dn = to_acpi_data_node(fwnode);
1580
1581 return dn->name;
1582 }
1583
1584 adev = to_acpi_device_node(fwnode);
1585 if (WARN_ON(!adev))
1586 return NULL;
1587
1588 return acpi_device_bid(adev);
1589}
1590
1591static const char *
1592acpi_fwnode_get_name_prefix(const struct fwnode_handle *fwnode)
1593{
1594 struct fwnode_handle *parent;
1595
1596 /* Is this the root node? */
1597 parent = fwnode_get_parent(fwnode);
1598 if (!parent)
1599 return "";
1600
1601 /* Is this 2nd node from the root? */
1602 parent = fwnode_get_next_parent(parent);
1603 if (!parent)
1604 return "";
1605
1606 fwnode_handle_put(parent);
1607
1608 /* ACPI device or data node. */
1609 return ".";
1610}
1611
1612static struct fwnode_handle *
1613acpi_fwnode_get_parent(struct fwnode_handle *fwnode)
1614{
1615 return acpi_node_get_parent(fwnode);
1616}
1617
1618static int acpi_fwnode_graph_parse_endpoint(const struct fwnode_handle *fwnode,
1619 struct fwnode_endpoint *endpoint)
1620{
1621 struct fwnode_handle *port_fwnode = fwnode_get_parent(fwnode);
1622
1623 endpoint->local_fwnode = fwnode;
1624
1625 if (fwnode_property_read_u32(port_fwnode, "reg", &endpoint->port))
1626 fwnode_property_read_u32(port_fwnode, "port", &endpoint->port);
1627 if (fwnode_property_read_u32(fwnode, "reg", &endpoint->id))
1628 fwnode_property_read_u32(fwnode, "endpoint", &endpoint->id);
1629
1630 return 0;
1631}
1632
1633static int acpi_fwnode_irq_get(const struct fwnode_handle *fwnode,
1634 unsigned int index)
1635{
1636 struct resource res;
1637 int ret;
1638
1639 ret = acpi_irq_get(ACPI_HANDLE_FWNODE(fwnode), index, &res);
1640 if (ret)
1641 return ret;
1642
1643 return res.start;
1644}
1645
1646#define DECLARE_ACPI_FWNODE_OPS(ops) \
1647 const struct fwnode_operations ops = { \
1648 .device_is_available = acpi_fwnode_device_is_available, \
1649 .device_get_match_data = acpi_fwnode_device_get_match_data, \
1650 .device_dma_supported = \
1651 acpi_fwnode_device_dma_supported, \
1652 .device_get_dma_attr = acpi_fwnode_device_get_dma_attr, \
1653 .property_present = acpi_fwnode_property_present, \
1654 .property_read_int_array = \
1655 acpi_fwnode_property_read_int_array, \
1656 .property_read_string_array = \
1657 acpi_fwnode_property_read_string_array, \
1658 .get_parent = acpi_node_get_parent, \
1659 .get_next_child_node = acpi_get_next_subnode, \
1660 .get_named_child_node = acpi_fwnode_get_named_child_node, \
1661 .get_name = acpi_fwnode_get_name, \
1662 .get_name_prefix = acpi_fwnode_get_name_prefix, \
1663 .get_reference_args = acpi_fwnode_get_reference_args, \
1664 .graph_get_next_endpoint = \
1665 acpi_graph_get_next_endpoint, \
1666 .graph_get_remote_endpoint = \
1667 acpi_graph_get_remote_endpoint, \
1668 .graph_get_port_parent = acpi_fwnode_get_parent, \
1669 .graph_parse_endpoint = acpi_fwnode_graph_parse_endpoint, \
1670 .irq_get = acpi_fwnode_irq_get, \
1671 }; \
1672 EXPORT_SYMBOL_GPL(ops)
1673
1674DECLARE_ACPI_FWNODE_OPS(acpi_device_fwnode_ops);
1675DECLARE_ACPI_FWNODE_OPS(acpi_data_fwnode_ops);
1676const struct fwnode_operations acpi_static_fwnode_ops;
1677
1678bool is_acpi_device_node(const struct fwnode_handle *fwnode)
1679{
1680 return !IS_ERR_OR_NULL(fwnode) &&
1681 fwnode->ops == &acpi_device_fwnode_ops;
1682}
1683EXPORT_SYMBOL(is_acpi_device_node);
1684
1685bool is_acpi_data_node(const struct fwnode_handle *fwnode)
1686{
1687 return !IS_ERR_OR_NULL(fwnode) && fwnode->ops == &acpi_data_fwnode_ops;
1688}
1689EXPORT_SYMBOL(is_acpi_data_node);