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