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