]>
Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /******************************************************************************* |
2 | * | |
3 | * Module Name: nsobject - Utilities for objects attached to namespace | |
4 | * table entries | |
5 | * | |
6 | ******************************************************************************/ | |
7 | ||
8 | /* | |
7735ca0e | 9 | * Copyright (C) 2000 - 2017, Intel Corp. |
1da177e4 LT |
10 | * All rights reserved. |
11 | * | |
12 | * Redistribution and use in source and binary forms, with or without | |
13 | * modification, are permitted provided that the following conditions | |
14 | * are met: | |
15 | * 1. Redistributions of source code must retain the above copyright | |
16 | * notice, this list of conditions, and the following disclaimer, | |
17 | * without modification. | |
18 | * 2. Redistributions in binary form must reproduce at minimum a disclaimer | |
19 | * substantially similar to the "NO WARRANTY" disclaimer below | |
20 | * ("Disclaimer") and any redistribution must be conditioned upon | |
21 | * including a substantially similar Disclaimer requirement for further | |
22 | * binary redistribution. | |
23 | * 3. Neither the names of the above-listed copyright holders nor the names | |
24 | * of any contributors may be used to endorse or promote products derived | |
25 | * from this software without specific prior written permission. | |
26 | * | |
27 | * Alternatively, this software may be distributed under the terms of the | |
28 | * GNU General Public License ("GPL") version 2 as published by the Free | |
29 | * Software Foundation. | |
30 | * | |
31 | * NO WARRANTY | |
32 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
33 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
34 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR | |
35 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
36 | * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
37 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |
38 | * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
39 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, | |
40 | * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING | |
41 | * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | |
42 | * POSSIBILITY OF SUCH DAMAGES. | |
43 | */ | |
44 | ||
1da177e4 | 45 | #include <acpi/acpi.h> |
e2f7a777 LB |
46 | #include "accommon.h" |
47 | #include "acnamesp.h" | |
1da177e4 | 48 | |
1da177e4 | 49 | #define _COMPONENT ACPI_NAMESPACE |
4be44fcd | 50 | ACPI_MODULE_NAME("nsobject") |
1da177e4 LT |
51 | |
52 | /******************************************************************************* | |
53 | * | |
54 | * FUNCTION: acpi_ns_attach_object | |
55 | * | |
ba494bee BM |
56 | * PARAMETERS: node - Parent Node |
57 | * object - Object to be attached | |
58 | * type - Type of object, or ACPI_TYPE_ANY if not | |
1da177e4 LT |
59 | * known |
60 | * | |
44f6c012 RM |
61 | * RETURN: Status |
62 | * | |
1da177e4 | 63 | * DESCRIPTION: Record the given object as the value associated with the |
73a3090a | 64 | * name whose acpi_handle is passed. If Object is NULL |
1da177e4 LT |
65 | * and Type is ACPI_TYPE_ANY, set the name as having no value. |
66 | * Note: Future may require that the Node->Flags field be passed | |
67 | * as a parameter. | |
68 | * | |
69 | * MUTEX: Assumes namespace is locked | |
70 | * | |
71 | ******************************************************************************/ | |
1da177e4 | 72 | acpi_status |
4be44fcd LB |
73 | acpi_ns_attach_object(struct acpi_namespace_node *node, |
74 | union acpi_operand_object *object, acpi_object_type type) | |
1da177e4 | 75 | { |
4be44fcd LB |
76 | union acpi_operand_object *obj_desc; |
77 | union acpi_operand_object *last_obj_desc; | |
78 | acpi_object_type object_type = ACPI_TYPE_ANY; | |
1da177e4 | 79 | |
b229cf92 | 80 | ACPI_FUNCTION_TRACE(ns_attach_object); |
1da177e4 LT |
81 | |
82 | /* | |
83 | * Parameter validation | |
84 | */ | |
85 | if (!node) { | |
52fc0b02 | 86 | |
1da177e4 LT |
87 | /* Invalid handle */ |
88 | ||
b229cf92 | 89 | ACPI_ERROR((AE_INFO, "Null NamedObj handle")); |
4be44fcd | 90 | return_ACPI_STATUS(AE_BAD_PARAMETER); |
1da177e4 LT |
91 | } |
92 | ||
93 | if (!object && (ACPI_TYPE_ANY != type)) { | |
52fc0b02 | 94 | |
1da177e4 LT |
95 | /* Null object */ |
96 | ||
b8e4d893 BM |
97 | ACPI_ERROR((AE_INFO, |
98 | "Null object, but type not ACPI_TYPE_ANY")); | |
4be44fcd | 99 | return_ACPI_STATUS(AE_BAD_PARAMETER); |
1da177e4 LT |
100 | } |
101 | ||
4be44fcd | 102 | if (ACPI_GET_DESCRIPTOR_TYPE(node) != ACPI_DESC_TYPE_NAMED) { |
52fc0b02 | 103 | |
1da177e4 LT |
104 | /* Not a name handle */ |
105 | ||
b8e4d893 BM |
106 | ACPI_ERROR((AE_INFO, "Invalid handle %p [%s]", |
107 | node, acpi_ut_get_descriptor_name(node))); | |
4be44fcd | 108 | return_ACPI_STATUS(AE_BAD_PARAMETER); |
1da177e4 LT |
109 | } |
110 | ||
111 | /* Check if this object is already attached */ | |
112 | ||
113 | if (node->object == object) { | |
4be44fcd | 114 | ACPI_DEBUG_PRINT((ACPI_DB_EXEC, |
b229cf92 | 115 | "Obj %p already installed in NameObj %p\n", |
4be44fcd | 116 | object, node)); |
1da177e4 | 117 | |
4be44fcd | 118 | return_ACPI_STATUS(AE_OK); |
1da177e4 LT |
119 | } |
120 | ||
121 | /* If null object, we will just install it */ | |
122 | ||
123 | if (!object) { | |
4be44fcd | 124 | obj_desc = NULL; |
1da177e4 LT |
125 | object_type = ACPI_TYPE_ANY; |
126 | } | |
127 | ||
128 | /* | |
129 | * If the source object is a namespace Node with an attached object, | |
130 | * we will use that (attached) object | |
131 | */ | |
4be44fcd LB |
132 | else if ((ACPI_GET_DESCRIPTOR_TYPE(object) == ACPI_DESC_TYPE_NAMED) && |
133 | ((struct acpi_namespace_node *)object)->object) { | |
1da177e4 LT |
134 | /* |
135 | * Value passed is a name handle and that name has a | |
73a3090a | 136 | * non-null value. Use that name's value and type. |
1da177e4 | 137 | */ |
4be44fcd LB |
138 | obj_desc = ((struct acpi_namespace_node *)object)->object; |
139 | object_type = ((struct acpi_namespace_node *)object)->type; | |
1da177e4 LT |
140 | } |
141 | ||
142 | /* | |
143 | * Otherwise, we will use the parameter object, but we must type | |
144 | * it first | |
145 | */ | |
146 | else { | |
4be44fcd | 147 | obj_desc = (union acpi_operand_object *)object; |
1da177e4 LT |
148 | |
149 | /* Use the given type */ | |
150 | ||
151 | object_type = type; | |
152 | } | |
153 | ||
4be44fcd LB |
154 | ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Installing %p into Node %p [%4.4s]\n", |
155 | obj_desc, node, acpi_ut_get_node_name(node))); | |
1da177e4 LT |
156 | |
157 | /* Detach an existing attached object if present */ | |
158 | ||
159 | if (node->object) { | |
4be44fcd | 160 | acpi_ns_detach_object(node); |
1da177e4 LT |
161 | } |
162 | ||
163 | if (obj_desc) { | |
164 | /* | |
165 | * Must increment the new value's reference count | |
166 | * (if it is an internal object) | |
167 | */ | |
4be44fcd | 168 | acpi_ut_add_reference(obj_desc); |
1da177e4 LT |
169 | |
170 | /* | |
171 | * Handle objects with multiple descriptors - walk | |
172 | * to the end of the descriptor list | |
173 | */ | |
174 | last_obj_desc = obj_desc; | |
175 | while (last_obj_desc->common.next_object) { | |
176 | last_obj_desc = last_obj_desc->common.next_object; | |
177 | } | |
178 | ||
179 | /* Install the object at the front of the object list */ | |
180 | ||
181 | last_obj_desc->common.next_object = node->object; | |
182 | } | |
183 | ||
4be44fcd LB |
184 | node->type = (u8) object_type; |
185 | node->object = obj_desc; | |
1da177e4 | 186 | |
4be44fcd | 187 | return_ACPI_STATUS(AE_OK); |
1da177e4 LT |
188 | } |
189 | ||
1da177e4 LT |
190 | /******************************************************************************* |
191 | * | |
192 | * FUNCTION: acpi_ns_detach_object | |
193 | * | |
ba494bee | 194 | * PARAMETERS: node - A Namespace node whose object will be detached |
1da177e4 LT |
195 | * |
196 | * RETURN: None. | |
197 | * | |
198 | * DESCRIPTION: Detach/delete an object associated with a namespace node. | |
199 | * if the object is an allocated object, it is freed. | |
200 | * Otherwise, the field is simply cleared. | |
201 | * | |
202 | ******************************************************************************/ | |
203 | ||
4be44fcd | 204 | void acpi_ns_detach_object(struct acpi_namespace_node *node) |
1da177e4 | 205 | { |
4be44fcd | 206 | union acpi_operand_object *obj_desc; |
1da177e4 | 207 | |
b229cf92 | 208 | ACPI_FUNCTION_TRACE(ns_detach_object); |
1da177e4 LT |
209 | |
210 | obj_desc = node->object; | |
211 | ||
3371c19c | 212 | if (!obj_desc || (obj_desc->common.type == ACPI_TYPE_LOCAL_DATA)) { |
1da177e4 LT |
213 | return_VOID; |
214 | } | |
215 | ||
b2f7ddcf LM |
216 | if (node->flags & ANOBJ_ALLOCATED_BUFFER) { |
217 | ||
218 | /* Free the dynamic aml buffer */ | |
219 | ||
220 | if (obj_desc->common.type == ACPI_TYPE_METHOD) { | |
221 | ACPI_FREE(obj_desc->method.aml_start); | |
222 | } | |
223 | } | |
224 | ||
f953529f | 225 | /* Clear the Node entry in all cases */ |
1da177e4 LT |
226 | |
227 | node->object = NULL; | |
4be44fcd | 228 | if (ACPI_GET_DESCRIPTOR_TYPE(obj_desc) == ACPI_DESC_TYPE_OPERAND) { |
f953529f BM |
229 | |
230 | /* Unlink object from front of possible object list */ | |
231 | ||
1da177e4 | 232 | node->object = obj_desc->common.next_object; |
f953529f BM |
233 | |
234 | /* Handle possible 2-descriptor object */ | |
235 | ||
1da177e4 | 236 | if (node->object && |
f953529f | 237 | (node->object->common.type != ACPI_TYPE_LOCAL_DATA)) { |
1da177e4 LT |
238 | node->object = node->object->common.next_object; |
239 | } | |
e23d9b82 | 240 | |
7817e265 BM |
241 | /* |
242 | * Detach the object from any data objects (which are still held by | |
243 | * the namespace node) | |
244 | */ | |
245 | if (obj_desc->common.next_object && | |
246 | ((obj_desc->common.next_object)->common.type == | |
247 | ACPI_TYPE_LOCAL_DATA)) { | |
248 | obj_desc->common.next_object = NULL; | |
249 | } | |
e23d9b82 DB |
250 | } |
251 | ||
1da177e4 LT |
252 | /* Reset the node type to untyped */ |
253 | ||
254 | node->type = ACPI_TYPE_ANY; | |
255 | ||
4be44fcd LB |
256 | ACPI_DEBUG_PRINT((ACPI_DB_NAMES, "Node %p [%4.4s] Object %p\n", |
257 | node, acpi_ut_get_node_name(node), obj_desc)); | |
1da177e4 LT |
258 | |
259 | /* Remove one reference on the object (and all subobjects) */ | |
260 | ||
4be44fcd | 261 | acpi_ut_remove_reference(obj_desc); |
1da177e4 LT |
262 | return_VOID; |
263 | } | |
264 | ||
1da177e4 LT |
265 | /******************************************************************************* |
266 | * | |
267 | * FUNCTION: acpi_ns_get_attached_object | |
268 | * | |
ba494bee | 269 | * PARAMETERS: node - Namespace node |
1da177e4 LT |
270 | * |
271 | * RETURN: Current value of the object field from the Node whose | |
272 | * handle is passed | |
273 | * | |
274 | * DESCRIPTION: Obtain the object attached to a namespace node. | |
275 | * | |
276 | ******************************************************************************/ | |
277 | ||
4be44fcd LB |
278 | union acpi_operand_object *acpi_ns_get_attached_object(struct |
279 | acpi_namespace_node | |
280 | *node) | |
1da177e4 | 281 | { |
b229cf92 | 282 | ACPI_FUNCTION_TRACE_PTR(ns_get_attached_object, node); |
1da177e4 LT |
283 | |
284 | if (!node) { | |
b8e4d893 | 285 | ACPI_WARNING((AE_INFO, "Null Node ptr")); |
4be44fcd | 286 | return_PTR(NULL); |
1da177e4 LT |
287 | } |
288 | ||
289 | if (!node->object || | |
4be44fcd LB |
290 | ((ACPI_GET_DESCRIPTOR_TYPE(node->object) != ACPI_DESC_TYPE_OPERAND) |
291 | && (ACPI_GET_DESCRIPTOR_TYPE(node->object) != | |
292 | ACPI_DESC_TYPE_NAMED)) | |
3371c19c | 293 | || ((node->object)->common.type == ACPI_TYPE_LOCAL_DATA)) { |
4be44fcd | 294 | return_PTR(NULL); |
1da177e4 LT |
295 | } |
296 | ||
4be44fcd | 297 | return_PTR(node->object); |
1da177e4 LT |
298 | } |
299 | ||
1da177e4 LT |
300 | /******************************************************************************* |
301 | * | |
302 | * FUNCTION: acpi_ns_get_secondary_object | |
303 | * | |
ba494bee | 304 | * PARAMETERS: node - Namespace node |
1da177e4 LT |
305 | * |
306 | * RETURN: Current value of the object field from the Node whose | |
307 | * handle is passed. | |
308 | * | |
309 | * DESCRIPTION: Obtain a secondary object associated with a namespace node. | |
310 | * | |
311 | ******************************************************************************/ | |
312 | ||
4be44fcd LB |
313 | union acpi_operand_object *acpi_ns_get_secondary_object(union |
314 | acpi_operand_object | |
315 | *obj_desc) | |
1da177e4 | 316 | { |
b229cf92 | 317 | ACPI_FUNCTION_TRACE_PTR(ns_get_secondary_object, obj_desc); |
4be44fcd LB |
318 | |
319 | if ((!obj_desc) || | |
3371c19c | 320 | (obj_desc->common.type == ACPI_TYPE_LOCAL_DATA) || |
4be44fcd | 321 | (!obj_desc->common.next_object) || |
3371c19c | 322 | ((obj_desc->common.next_object)->common.type == |
4be44fcd LB |
323 | ACPI_TYPE_LOCAL_DATA)) { |
324 | return_PTR(NULL); | |
1da177e4 LT |
325 | } |
326 | ||
4be44fcd | 327 | return_PTR(obj_desc->common.next_object); |
1da177e4 LT |
328 | } |
329 | ||
1da177e4 LT |
330 | /******************************************************************************* |
331 | * | |
332 | * FUNCTION: acpi_ns_attach_data | |
333 | * | |
ba494bee BM |
334 | * PARAMETERS: node - Namespace node |
335 | * handler - Handler to be associated with the data | |
336 | * data - Data to be attached | |
1da177e4 LT |
337 | * |
338 | * RETURN: Status | |
339 | * | |
73a3090a | 340 | * DESCRIPTION: Low-level attach data. Create and attach a Data object. |
1da177e4 LT |
341 | * |
342 | ******************************************************************************/ | |
343 | ||
344 | acpi_status | |
4be44fcd LB |
345 | acpi_ns_attach_data(struct acpi_namespace_node *node, |
346 | acpi_object_handler handler, void *data) | |
1da177e4 | 347 | { |
4be44fcd LB |
348 | union acpi_operand_object *prev_obj_desc; |
349 | union acpi_operand_object *obj_desc; | |
350 | union acpi_operand_object *data_desc; | |
1da177e4 LT |
351 | |
352 | /* We only allow one attachment per handler */ | |
353 | ||
354 | prev_obj_desc = NULL; | |
355 | obj_desc = node->object; | |
356 | while (obj_desc) { | |
3371c19c | 357 | if ((obj_desc->common.type == ACPI_TYPE_LOCAL_DATA) && |
4be44fcd | 358 | (obj_desc->data.handler == handler)) { |
1da177e4 LT |
359 | return (AE_ALREADY_EXISTS); |
360 | } | |
361 | ||
362 | prev_obj_desc = obj_desc; | |
363 | obj_desc = obj_desc->common.next_object; | |
364 | } | |
365 | ||
366 | /* Create an internal object for the data */ | |
367 | ||
4be44fcd | 368 | data_desc = acpi_ut_create_internal_object(ACPI_TYPE_LOCAL_DATA); |
1da177e4 LT |
369 | if (!data_desc) { |
370 | return (AE_NO_MEMORY); | |
371 | } | |
372 | ||
373 | data_desc->data.handler = handler; | |
374 | data_desc->data.pointer = data; | |
375 | ||
376 | /* Install the data object */ | |
377 | ||
378 | if (prev_obj_desc) { | |
379 | prev_obj_desc->common.next_object = data_desc; | |
4be44fcd | 380 | } else { |
1da177e4 LT |
381 | node->object = data_desc; |
382 | } | |
383 | ||
384 | return (AE_OK); | |
385 | } | |
386 | ||
1da177e4 LT |
387 | /******************************************************************************* |
388 | * | |
389 | * FUNCTION: acpi_ns_detach_data | |
390 | * | |
ba494bee BM |
391 | * PARAMETERS: node - Namespace node |
392 | * handler - Handler associated with the data | |
1da177e4 LT |
393 | * |
394 | * RETURN: Status | |
395 | * | |
73a3090a | 396 | * DESCRIPTION: Low-level detach data. Delete the data node, but the caller |
1da177e4 LT |
397 | * is responsible for the actual data. |
398 | * | |
399 | ******************************************************************************/ | |
400 | ||
401 | acpi_status | |
f5c1e1c5 | 402 | acpi_ns_detach_data(struct acpi_namespace_node *node, |
4be44fcd | 403 | acpi_object_handler handler) |
1da177e4 | 404 | { |
4be44fcd LB |
405 | union acpi_operand_object *obj_desc; |
406 | union acpi_operand_object *prev_obj_desc; | |
1da177e4 LT |
407 | |
408 | prev_obj_desc = NULL; | |
409 | obj_desc = node->object; | |
410 | while (obj_desc) { | |
3371c19c | 411 | if ((obj_desc->common.type == ACPI_TYPE_LOCAL_DATA) && |
4be44fcd | 412 | (obj_desc->data.handler == handler)) { |
1da177e4 | 413 | if (prev_obj_desc) { |
4be44fcd LB |
414 | prev_obj_desc->common.next_object = |
415 | obj_desc->common.next_object; | |
416 | } else { | |
1da177e4 LT |
417 | node->object = obj_desc->common.next_object; |
418 | } | |
419 | ||
4be44fcd | 420 | acpi_ut_remove_reference(obj_desc); |
1da177e4 LT |
421 | return (AE_OK); |
422 | } | |
423 | ||
424 | prev_obj_desc = obj_desc; | |
425 | obj_desc = obj_desc->common.next_object; | |
426 | } | |
427 | ||
428 | return (AE_NOT_FOUND); | |
429 | } | |
430 | ||
1da177e4 LT |
431 | /******************************************************************************* |
432 | * | |
433 | * FUNCTION: acpi_ns_get_attached_data | |
434 | * | |
ba494bee BM |
435 | * PARAMETERS: node - Namespace node |
436 | * handler - Handler associated with the data | |
437 | * data - Where the data is returned | |
1da177e4 LT |
438 | * |
439 | * RETURN: Status | |
440 | * | |
441 | * DESCRIPTION: Low level interface to obtain data previously associated with | |
442 | * a namespace node. | |
443 | * | |
444 | ******************************************************************************/ | |
445 | ||
446 | acpi_status | |
f5c1e1c5 | 447 | acpi_ns_get_attached_data(struct acpi_namespace_node *node, |
4be44fcd | 448 | acpi_object_handler handler, void **data) |
1da177e4 | 449 | { |
4be44fcd | 450 | union acpi_operand_object *obj_desc; |
1da177e4 LT |
451 | |
452 | obj_desc = node->object; | |
453 | while (obj_desc) { | |
3371c19c | 454 | if ((obj_desc->common.type == ACPI_TYPE_LOCAL_DATA) && |
4be44fcd | 455 | (obj_desc->data.handler == handler)) { |
1da177e4 LT |
456 | *data = obj_desc->data.pointer; |
457 | return (AE_OK); | |
458 | } | |
459 | ||
460 | obj_desc = obj_desc->common.next_object; | |
461 | } | |
462 | ||
463 | return (AE_NOT_FOUND); | |
464 | } |