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