Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /******************************************************************************* |
2 | * | |
3 | * Module Name: nsobject - Utilities for objects attached to namespace | |
4 | * table entries | |
5 | * | |
6 | ******************************************************************************/ | |
7 | ||
8 | /* | |
75a44ce0 | 9 | * Copyright (C) 2000 - 2008, 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> |
50df4d8b | 46 | #include <acpi/accommon.h> |
1da177e4 LT |
47 | #include <acpi/acnamesp.h> |
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 | * | |
56 | * PARAMETERS: Node - Parent Node | |
57 | * Object - Object to be attached | |
58 | * Type - Type of object, or ACPI_TYPE_ANY if not | |
59 | * known | |
60 | * | |
44f6c012 RM |
61 | * RETURN: Status |
62 | * | |
1da177e4 LT |
63 | * DESCRIPTION: Record the given object as the value associated with the |
64 | * name whose acpi_handle is passed. If Object is NULL | |
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 | |
136 | * non-null value. Use that name's value and type. | |
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 | * | |
44f6c012 | 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 | ||
212 | if (!obj_desc || | |
4be44fcd | 213 | (ACPI_GET_OBJECT_TYPE(obj_desc) == ACPI_TYPE_LOCAL_DATA)) { |
1da177e4 LT |
214 | return_VOID; |
215 | } | |
216 | ||
217 | /* Clear the entry in all cases */ | |
218 | ||
219 | node->object = NULL; | |
4be44fcd | 220 | if (ACPI_GET_DESCRIPTOR_TYPE(obj_desc) == ACPI_DESC_TYPE_OPERAND) { |
1da177e4 LT |
221 | node->object = obj_desc->common.next_object; |
222 | if (node->object && | |
4be44fcd LB |
223 | (ACPI_GET_OBJECT_TYPE(node->object) != |
224 | ACPI_TYPE_LOCAL_DATA)) { | |
1da177e4 LT |
225 | node->object = node->object->common.next_object; |
226 | } | |
227 | } | |
228 | ||
229 | /* Reset the node type to untyped */ | |
230 | ||
231 | node->type = ACPI_TYPE_ANY; | |
232 | ||
4be44fcd LB |
233 | ACPI_DEBUG_PRINT((ACPI_DB_NAMES, "Node %p [%4.4s] Object %p\n", |
234 | node, acpi_ut_get_node_name(node), obj_desc)); | |
1da177e4 LT |
235 | |
236 | /* Remove one reference on the object (and all subobjects) */ | |
237 | ||
4be44fcd | 238 | acpi_ut_remove_reference(obj_desc); |
1da177e4 LT |
239 | return_VOID; |
240 | } | |
241 | ||
1da177e4 LT |
242 | /******************************************************************************* |
243 | * | |
244 | * FUNCTION: acpi_ns_get_attached_object | |
245 | * | |
44f6c012 | 246 | * PARAMETERS: Node - Namespace node |
1da177e4 LT |
247 | * |
248 | * RETURN: Current value of the object field from the Node whose | |
249 | * handle is passed | |
250 | * | |
251 | * DESCRIPTION: Obtain the object attached to a namespace node. | |
252 | * | |
253 | ******************************************************************************/ | |
254 | ||
4be44fcd LB |
255 | union acpi_operand_object *acpi_ns_get_attached_object(struct |
256 | acpi_namespace_node | |
257 | *node) | |
1da177e4 | 258 | { |
b229cf92 | 259 | ACPI_FUNCTION_TRACE_PTR(ns_get_attached_object, node); |
1da177e4 LT |
260 | |
261 | if (!node) { | |
b8e4d893 | 262 | ACPI_WARNING((AE_INFO, "Null Node ptr")); |
4be44fcd | 263 | return_PTR(NULL); |
1da177e4 LT |
264 | } |
265 | ||
266 | if (!node->object || | |
4be44fcd LB |
267 | ((ACPI_GET_DESCRIPTOR_TYPE(node->object) != ACPI_DESC_TYPE_OPERAND) |
268 | && (ACPI_GET_DESCRIPTOR_TYPE(node->object) != | |
269 | ACPI_DESC_TYPE_NAMED)) | |
270 | || (ACPI_GET_OBJECT_TYPE(node->object) == ACPI_TYPE_LOCAL_DATA)) { | |
271 | return_PTR(NULL); | |
1da177e4 LT |
272 | } |
273 | ||
4be44fcd | 274 | return_PTR(node->object); |
1da177e4 LT |
275 | } |
276 | ||
1da177e4 LT |
277 | /******************************************************************************* |
278 | * | |
279 | * FUNCTION: acpi_ns_get_secondary_object | |
280 | * | |
44f6c012 | 281 | * PARAMETERS: Node - Namespace node |
1da177e4 LT |
282 | * |
283 | * RETURN: Current value of the object field from the Node whose | |
284 | * handle is passed. | |
285 | * | |
286 | * DESCRIPTION: Obtain a secondary object associated with a namespace node. | |
287 | * | |
288 | ******************************************************************************/ | |
289 | ||
4be44fcd LB |
290 | union acpi_operand_object *acpi_ns_get_secondary_object(union |
291 | acpi_operand_object | |
292 | *obj_desc) | |
1da177e4 | 293 | { |
b229cf92 | 294 | ACPI_FUNCTION_TRACE_PTR(ns_get_secondary_object, obj_desc); |
4be44fcd LB |
295 | |
296 | if ((!obj_desc) || | |
297 | (ACPI_GET_OBJECT_TYPE(obj_desc) == ACPI_TYPE_LOCAL_DATA) || | |
298 | (!obj_desc->common.next_object) || | |
299 | (ACPI_GET_OBJECT_TYPE(obj_desc->common.next_object) == | |
300 | ACPI_TYPE_LOCAL_DATA)) { | |
301 | return_PTR(NULL); | |
1da177e4 LT |
302 | } |
303 | ||
4be44fcd | 304 | return_PTR(obj_desc->common.next_object); |
1da177e4 LT |
305 | } |
306 | ||
1da177e4 LT |
307 | /******************************************************************************* |
308 | * | |
309 | * FUNCTION: acpi_ns_attach_data | |
310 | * | |
311 | * PARAMETERS: Node - Namespace node | |
312 | * Handler - Handler to be associated with the data | |
313 | * Data - Data to be attached | |
314 | * | |
315 | * RETURN: Status | |
316 | * | |
317 | * DESCRIPTION: Low-level attach data. Create and attach a Data object. | |
318 | * | |
319 | ******************************************************************************/ | |
320 | ||
321 | acpi_status | |
4be44fcd LB |
322 | acpi_ns_attach_data(struct acpi_namespace_node *node, |
323 | acpi_object_handler handler, void *data) | |
1da177e4 | 324 | { |
4be44fcd LB |
325 | union acpi_operand_object *prev_obj_desc; |
326 | union acpi_operand_object *obj_desc; | |
327 | union acpi_operand_object *data_desc; | |
1da177e4 LT |
328 | |
329 | /* We only allow one attachment per handler */ | |
330 | ||
331 | prev_obj_desc = NULL; | |
332 | obj_desc = node->object; | |
333 | while (obj_desc) { | |
4be44fcd LB |
334 | if ((ACPI_GET_OBJECT_TYPE(obj_desc) == ACPI_TYPE_LOCAL_DATA) && |
335 | (obj_desc->data.handler == handler)) { | |
1da177e4 LT |
336 | return (AE_ALREADY_EXISTS); |
337 | } | |
338 | ||
339 | prev_obj_desc = obj_desc; | |
340 | obj_desc = obj_desc->common.next_object; | |
341 | } | |
342 | ||
343 | /* Create an internal object for the data */ | |
344 | ||
4be44fcd | 345 | data_desc = acpi_ut_create_internal_object(ACPI_TYPE_LOCAL_DATA); |
1da177e4 LT |
346 | if (!data_desc) { |
347 | return (AE_NO_MEMORY); | |
348 | } | |
349 | ||
350 | data_desc->data.handler = handler; | |
351 | data_desc->data.pointer = data; | |
352 | ||
353 | /* Install the data object */ | |
354 | ||
355 | if (prev_obj_desc) { | |
356 | prev_obj_desc->common.next_object = data_desc; | |
4be44fcd | 357 | } else { |
1da177e4 LT |
358 | node->object = data_desc; |
359 | } | |
360 | ||
361 | return (AE_OK); | |
362 | } | |
363 | ||
1da177e4 LT |
364 | /******************************************************************************* |
365 | * | |
366 | * FUNCTION: acpi_ns_detach_data | |
367 | * | |
368 | * PARAMETERS: Node - Namespace node | |
369 | * Handler - Handler associated with the data | |
370 | * | |
371 | * RETURN: Status | |
372 | * | |
373 | * DESCRIPTION: Low-level detach data. Delete the data node, but the caller | |
374 | * is responsible for the actual data. | |
375 | * | |
376 | ******************************************************************************/ | |
377 | ||
378 | acpi_status | |
4be44fcd LB |
379 | acpi_ns_detach_data(struct acpi_namespace_node * node, |
380 | acpi_object_handler handler) | |
1da177e4 | 381 | { |
4be44fcd LB |
382 | union acpi_operand_object *obj_desc; |
383 | union acpi_operand_object *prev_obj_desc; | |
1da177e4 LT |
384 | |
385 | prev_obj_desc = NULL; | |
386 | obj_desc = node->object; | |
387 | while (obj_desc) { | |
4be44fcd LB |
388 | if ((ACPI_GET_OBJECT_TYPE(obj_desc) == ACPI_TYPE_LOCAL_DATA) && |
389 | (obj_desc->data.handler == handler)) { | |
1da177e4 | 390 | if (prev_obj_desc) { |
4be44fcd LB |
391 | prev_obj_desc->common.next_object = |
392 | obj_desc->common.next_object; | |
393 | } else { | |
1da177e4 LT |
394 | node->object = obj_desc->common.next_object; |
395 | } | |
396 | ||
4be44fcd | 397 | acpi_ut_remove_reference(obj_desc); |
1da177e4 LT |
398 | return (AE_OK); |
399 | } | |
400 | ||
401 | prev_obj_desc = obj_desc; | |
402 | obj_desc = obj_desc->common.next_object; | |
403 | } | |
404 | ||
405 | return (AE_NOT_FOUND); | |
406 | } | |
407 | ||
1da177e4 LT |
408 | /******************************************************************************* |
409 | * | |
410 | * FUNCTION: acpi_ns_get_attached_data | |
411 | * | |
412 | * PARAMETERS: Node - Namespace node | |
413 | * Handler - Handler associated with the data | |
414 | * Data - Where the data is returned | |
415 | * | |
416 | * RETURN: Status | |
417 | * | |
418 | * DESCRIPTION: Low level interface to obtain data previously associated with | |
419 | * a namespace node. | |
420 | * | |
421 | ******************************************************************************/ | |
422 | ||
423 | acpi_status | |
4be44fcd LB |
424 | acpi_ns_get_attached_data(struct acpi_namespace_node * node, |
425 | acpi_object_handler handler, void **data) | |
1da177e4 | 426 | { |
4be44fcd | 427 | union acpi_operand_object *obj_desc; |
1da177e4 LT |
428 | |
429 | obj_desc = node->object; | |
430 | while (obj_desc) { | |
4be44fcd LB |
431 | if ((ACPI_GET_OBJECT_TYPE(obj_desc) == ACPI_TYPE_LOCAL_DATA) && |
432 | (obj_desc->data.handler == handler)) { | |
1da177e4 LT |
433 | *data = obj_desc->data.pointer; |
434 | return (AE_OK); | |
435 | } | |
436 | ||
437 | obj_desc = obj_desc->common.next_object; | |
438 | } | |
439 | ||
440 | return (AE_NOT_FOUND); | |
441 | } |