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 LT |
45 | #include <acpi/acpi.h> |
46 | #include <acpi/acnamesp.h> | |
47 | ||
1da177e4 | 48 | #define _COMPONENT ACPI_NAMESPACE |
4be44fcd | 49 | ACPI_MODULE_NAME("nsobject") |
1da177e4 LT |
50 | |
51 | /******************************************************************************* | |
52 | * | |
53 | * FUNCTION: acpi_ns_attach_object | |
54 | * | |
55 | * PARAMETERS: Node - Parent Node | |
56 | * Object - Object to be attached | |
57 | * Type - Type of object, or ACPI_TYPE_ANY if not | |
58 | * known | |
59 | * | |
44f6c012 RM |
60 | * RETURN: Status |
61 | * | |
1da177e4 LT |
62 | * DESCRIPTION: Record the given object as the value associated with the |
63 | * name whose acpi_handle is passed. If Object is NULL | |
64 | * and Type is ACPI_TYPE_ANY, set the name as having no value. | |
65 | * Note: Future may require that the Node->Flags field be passed | |
66 | * as a parameter. | |
67 | * | |
68 | * MUTEX: Assumes namespace is locked | |
69 | * | |
70 | ******************************************************************************/ | |
1da177e4 | 71 | acpi_status |
4be44fcd LB |
72 | acpi_ns_attach_object(struct acpi_namespace_node *node, |
73 | union acpi_operand_object *object, acpi_object_type type) | |
1da177e4 | 74 | { |
4be44fcd LB |
75 | union acpi_operand_object *obj_desc; |
76 | union acpi_operand_object *last_obj_desc; | |
77 | acpi_object_type object_type = ACPI_TYPE_ANY; | |
1da177e4 | 78 | |
b229cf92 | 79 | ACPI_FUNCTION_TRACE(ns_attach_object); |
1da177e4 LT |
80 | |
81 | /* | |
82 | * Parameter validation | |
83 | */ | |
84 | if (!node) { | |
52fc0b02 | 85 | |
1da177e4 LT |
86 | /* Invalid handle */ |
87 | ||
b229cf92 | 88 | ACPI_ERROR((AE_INFO, "Null NamedObj handle")); |
4be44fcd | 89 | return_ACPI_STATUS(AE_BAD_PARAMETER); |
1da177e4 LT |
90 | } |
91 | ||
92 | if (!object && (ACPI_TYPE_ANY != type)) { | |
52fc0b02 | 93 | |
1da177e4 LT |
94 | /* Null object */ |
95 | ||
b8e4d893 BM |
96 | ACPI_ERROR((AE_INFO, |
97 | "Null object, but type not ACPI_TYPE_ANY")); | |
4be44fcd | 98 | return_ACPI_STATUS(AE_BAD_PARAMETER); |
1da177e4 LT |
99 | } |
100 | ||
4be44fcd | 101 | if (ACPI_GET_DESCRIPTOR_TYPE(node) != ACPI_DESC_TYPE_NAMED) { |
52fc0b02 | 102 | |
1da177e4 LT |
103 | /* Not a name handle */ |
104 | ||
b8e4d893 BM |
105 | ACPI_ERROR((AE_INFO, "Invalid handle %p [%s]", |
106 | node, acpi_ut_get_descriptor_name(node))); | |
4be44fcd | 107 | return_ACPI_STATUS(AE_BAD_PARAMETER); |
1da177e4 LT |
108 | } |
109 | ||
110 | /* Check if this object is already attached */ | |
111 | ||
112 | if (node->object == object) { | |
4be44fcd | 113 | ACPI_DEBUG_PRINT((ACPI_DB_EXEC, |
b229cf92 | 114 | "Obj %p already installed in NameObj %p\n", |
4be44fcd | 115 | object, node)); |
1da177e4 | 116 | |
4be44fcd | 117 | return_ACPI_STATUS(AE_OK); |
1da177e4 LT |
118 | } |
119 | ||
120 | /* If null object, we will just install it */ | |
121 | ||
122 | if (!object) { | |
4be44fcd | 123 | obj_desc = NULL; |
1da177e4 LT |
124 | object_type = ACPI_TYPE_ANY; |
125 | } | |
126 | ||
127 | /* | |
128 | * If the source object is a namespace Node with an attached object, | |
129 | * we will use that (attached) object | |
130 | */ | |
4be44fcd LB |
131 | else if ((ACPI_GET_DESCRIPTOR_TYPE(object) == ACPI_DESC_TYPE_NAMED) && |
132 | ((struct acpi_namespace_node *)object)->object) { | |
1da177e4 LT |
133 | /* |
134 | * Value passed is a name handle and that name has a | |
135 | * non-null value. Use that name's value and type. | |
136 | */ | |
4be44fcd LB |
137 | obj_desc = ((struct acpi_namespace_node *)object)->object; |
138 | object_type = ((struct acpi_namespace_node *)object)->type; | |
1da177e4 LT |
139 | } |
140 | ||
141 | /* | |
142 | * Otherwise, we will use the parameter object, but we must type | |
143 | * it first | |
144 | */ | |
145 | else { | |
4be44fcd | 146 | obj_desc = (union acpi_operand_object *)object; |
1da177e4 LT |
147 | |
148 | /* Use the given type */ | |
149 | ||
150 | object_type = type; | |
151 | } | |
152 | ||
4be44fcd LB |
153 | ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Installing %p into Node %p [%4.4s]\n", |
154 | obj_desc, node, acpi_ut_get_node_name(node))); | |
1da177e4 LT |
155 | |
156 | /* Detach an existing attached object if present */ | |
157 | ||
158 | if (node->object) { | |
4be44fcd | 159 | acpi_ns_detach_object(node); |
1da177e4 LT |
160 | } |
161 | ||
162 | if (obj_desc) { | |
163 | /* | |
164 | * Must increment the new value's reference count | |
165 | * (if it is an internal object) | |
166 | */ | |
4be44fcd | 167 | acpi_ut_add_reference(obj_desc); |
1da177e4 LT |
168 | |
169 | /* | |
170 | * Handle objects with multiple descriptors - walk | |
171 | * to the end of the descriptor list | |
172 | */ | |
173 | last_obj_desc = obj_desc; | |
174 | while (last_obj_desc->common.next_object) { | |
175 | last_obj_desc = last_obj_desc->common.next_object; | |
176 | } | |
177 | ||
178 | /* Install the object at the front of the object list */ | |
179 | ||
180 | last_obj_desc->common.next_object = node->object; | |
181 | } | |
182 | ||
4be44fcd LB |
183 | node->type = (u8) object_type; |
184 | node->object = obj_desc; | |
1da177e4 | 185 | |
4be44fcd | 186 | return_ACPI_STATUS(AE_OK); |
1da177e4 LT |
187 | } |
188 | ||
1da177e4 LT |
189 | /******************************************************************************* |
190 | * | |
191 | * FUNCTION: acpi_ns_detach_object | |
192 | * | |
44f6c012 | 193 | * PARAMETERS: Node - A Namespace node whose object will be detached |
1da177e4 LT |
194 | * |
195 | * RETURN: None. | |
196 | * | |
197 | * DESCRIPTION: Detach/delete an object associated with a namespace node. | |
198 | * if the object is an allocated object, it is freed. | |
199 | * Otherwise, the field is simply cleared. | |
200 | * | |
201 | ******************************************************************************/ | |
202 | ||
4be44fcd | 203 | void acpi_ns_detach_object(struct acpi_namespace_node *node) |
1da177e4 | 204 | { |
4be44fcd | 205 | union acpi_operand_object *obj_desc; |
1da177e4 | 206 | |
b229cf92 | 207 | ACPI_FUNCTION_TRACE(ns_detach_object); |
1da177e4 LT |
208 | |
209 | obj_desc = node->object; | |
210 | ||
211 | if (!obj_desc || | |
4be44fcd | 212 | (ACPI_GET_OBJECT_TYPE(obj_desc) == ACPI_TYPE_LOCAL_DATA)) { |
1da177e4 LT |
213 | return_VOID; |
214 | } | |
215 | ||
216 | /* Clear the entry in all cases */ | |
217 | ||
218 | node->object = NULL; | |
4be44fcd | 219 | if (ACPI_GET_DESCRIPTOR_TYPE(obj_desc) == ACPI_DESC_TYPE_OPERAND) { |
1da177e4 LT |
220 | node->object = obj_desc->common.next_object; |
221 | if (node->object && | |
4be44fcd LB |
222 | (ACPI_GET_OBJECT_TYPE(node->object) != |
223 | ACPI_TYPE_LOCAL_DATA)) { | |
1da177e4 LT |
224 | node->object = node->object->common.next_object; |
225 | } | |
226 | } | |
227 | ||
228 | /* Reset the node type to untyped */ | |
229 | ||
230 | node->type = ACPI_TYPE_ANY; | |
231 | ||
4be44fcd LB |
232 | ACPI_DEBUG_PRINT((ACPI_DB_NAMES, "Node %p [%4.4s] Object %p\n", |
233 | node, acpi_ut_get_node_name(node), obj_desc)); | |
1da177e4 LT |
234 | |
235 | /* Remove one reference on the object (and all subobjects) */ | |
236 | ||
4be44fcd | 237 | acpi_ut_remove_reference(obj_desc); |
1da177e4 LT |
238 | return_VOID; |
239 | } | |
240 | ||
1da177e4 LT |
241 | /******************************************************************************* |
242 | * | |
243 | * FUNCTION: acpi_ns_get_attached_object | |
244 | * | |
44f6c012 | 245 | * PARAMETERS: Node - Namespace node |
1da177e4 LT |
246 | * |
247 | * RETURN: Current value of the object field from the Node whose | |
248 | * handle is passed | |
249 | * | |
250 | * DESCRIPTION: Obtain the object attached to a namespace node. | |
251 | * | |
252 | ******************************************************************************/ | |
253 | ||
4be44fcd LB |
254 | union acpi_operand_object *acpi_ns_get_attached_object(struct |
255 | acpi_namespace_node | |
256 | *node) | |
1da177e4 | 257 | { |
b229cf92 | 258 | ACPI_FUNCTION_TRACE_PTR(ns_get_attached_object, node); |
1da177e4 LT |
259 | |
260 | if (!node) { | |
b8e4d893 | 261 | ACPI_WARNING((AE_INFO, "Null Node ptr")); |
4be44fcd | 262 | return_PTR(NULL); |
1da177e4 LT |
263 | } |
264 | ||
265 | if (!node->object || | |
4be44fcd LB |
266 | ((ACPI_GET_DESCRIPTOR_TYPE(node->object) != ACPI_DESC_TYPE_OPERAND) |
267 | && (ACPI_GET_DESCRIPTOR_TYPE(node->object) != | |
268 | ACPI_DESC_TYPE_NAMED)) | |
269 | || (ACPI_GET_OBJECT_TYPE(node->object) == ACPI_TYPE_LOCAL_DATA)) { | |
270 | return_PTR(NULL); | |
1da177e4 LT |
271 | } |
272 | ||
4be44fcd | 273 | return_PTR(node->object); |
1da177e4 LT |
274 | } |
275 | ||
1da177e4 LT |
276 | /******************************************************************************* |
277 | * | |
278 | * FUNCTION: acpi_ns_get_secondary_object | |
279 | * | |
44f6c012 | 280 | * PARAMETERS: Node - Namespace node |
1da177e4 LT |
281 | * |
282 | * RETURN: Current value of the object field from the Node whose | |
283 | * handle is passed. | |
284 | * | |
285 | * DESCRIPTION: Obtain a secondary object associated with a namespace node. | |
286 | * | |
287 | ******************************************************************************/ | |
288 | ||
4be44fcd LB |
289 | union acpi_operand_object *acpi_ns_get_secondary_object(union |
290 | acpi_operand_object | |
291 | *obj_desc) | |
1da177e4 | 292 | { |
b229cf92 | 293 | ACPI_FUNCTION_TRACE_PTR(ns_get_secondary_object, obj_desc); |
4be44fcd LB |
294 | |
295 | if ((!obj_desc) || | |
296 | (ACPI_GET_OBJECT_TYPE(obj_desc) == ACPI_TYPE_LOCAL_DATA) || | |
297 | (!obj_desc->common.next_object) || | |
298 | (ACPI_GET_OBJECT_TYPE(obj_desc->common.next_object) == | |
299 | ACPI_TYPE_LOCAL_DATA)) { | |
300 | return_PTR(NULL); | |
1da177e4 LT |
301 | } |
302 | ||
4be44fcd | 303 | return_PTR(obj_desc->common.next_object); |
1da177e4 LT |
304 | } |
305 | ||
1da177e4 LT |
306 | /******************************************************************************* |
307 | * | |
308 | * FUNCTION: acpi_ns_attach_data | |
309 | * | |
310 | * PARAMETERS: Node - Namespace node | |
311 | * Handler - Handler to be associated with the data | |
312 | * Data - Data to be attached | |
313 | * | |
314 | * RETURN: Status | |
315 | * | |
316 | * DESCRIPTION: Low-level attach data. Create and attach a Data object. | |
317 | * | |
318 | ******************************************************************************/ | |
319 | ||
320 | acpi_status | |
4be44fcd LB |
321 | acpi_ns_attach_data(struct acpi_namespace_node *node, |
322 | acpi_object_handler handler, void *data) | |
1da177e4 | 323 | { |
4be44fcd LB |
324 | union acpi_operand_object *prev_obj_desc; |
325 | union acpi_operand_object *obj_desc; | |
326 | union acpi_operand_object *data_desc; | |
1da177e4 LT |
327 | |
328 | /* We only allow one attachment per handler */ | |
329 | ||
330 | prev_obj_desc = NULL; | |
331 | obj_desc = node->object; | |
332 | while (obj_desc) { | |
4be44fcd LB |
333 | if ((ACPI_GET_OBJECT_TYPE(obj_desc) == ACPI_TYPE_LOCAL_DATA) && |
334 | (obj_desc->data.handler == handler)) { | |
1da177e4 LT |
335 | return (AE_ALREADY_EXISTS); |
336 | } | |
337 | ||
338 | prev_obj_desc = obj_desc; | |
339 | obj_desc = obj_desc->common.next_object; | |
340 | } | |
341 | ||
342 | /* Create an internal object for the data */ | |
343 | ||
4be44fcd | 344 | data_desc = acpi_ut_create_internal_object(ACPI_TYPE_LOCAL_DATA); |
1da177e4 LT |
345 | if (!data_desc) { |
346 | return (AE_NO_MEMORY); | |
347 | } | |
348 | ||
349 | data_desc->data.handler = handler; | |
350 | data_desc->data.pointer = data; | |
351 | ||
352 | /* Install the data object */ | |
353 | ||
354 | if (prev_obj_desc) { | |
355 | prev_obj_desc->common.next_object = data_desc; | |
4be44fcd | 356 | } else { |
1da177e4 LT |
357 | node->object = data_desc; |
358 | } | |
359 | ||
360 | return (AE_OK); | |
361 | } | |
362 | ||
1da177e4 LT |
363 | /******************************************************************************* |
364 | * | |
365 | * FUNCTION: acpi_ns_detach_data | |
366 | * | |
367 | * PARAMETERS: Node - Namespace node | |
368 | * Handler - Handler associated with the data | |
369 | * | |
370 | * RETURN: Status | |
371 | * | |
372 | * DESCRIPTION: Low-level detach data. Delete the data node, but the caller | |
373 | * is responsible for the actual data. | |
374 | * | |
375 | ******************************************************************************/ | |
376 | ||
377 | acpi_status | |
4be44fcd LB |
378 | acpi_ns_detach_data(struct acpi_namespace_node * node, |
379 | acpi_object_handler handler) | |
1da177e4 | 380 | { |
4be44fcd LB |
381 | union acpi_operand_object *obj_desc; |
382 | union acpi_operand_object *prev_obj_desc; | |
1da177e4 LT |
383 | |
384 | prev_obj_desc = NULL; | |
385 | obj_desc = node->object; | |
386 | while (obj_desc) { | |
4be44fcd LB |
387 | if ((ACPI_GET_OBJECT_TYPE(obj_desc) == ACPI_TYPE_LOCAL_DATA) && |
388 | (obj_desc->data.handler == handler)) { | |
1da177e4 | 389 | if (prev_obj_desc) { |
4be44fcd LB |
390 | prev_obj_desc->common.next_object = |
391 | obj_desc->common.next_object; | |
392 | } else { | |
1da177e4 LT |
393 | node->object = obj_desc->common.next_object; |
394 | } | |
395 | ||
4be44fcd | 396 | acpi_ut_remove_reference(obj_desc); |
1da177e4 LT |
397 | return (AE_OK); |
398 | } | |
399 | ||
400 | prev_obj_desc = obj_desc; | |
401 | obj_desc = obj_desc->common.next_object; | |
402 | } | |
403 | ||
404 | return (AE_NOT_FOUND); | |
405 | } | |
406 | ||
1da177e4 LT |
407 | /******************************************************************************* |
408 | * | |
409 | * FUNCTION: acpi_ns_get_attached_data | |
410 | * | |
411 | * PARAMETERS: Node - Namespace node | |
412 | * Handler - Handler associated with the data | |
413 | * Data - Where the data is returned | |
414 | * | |
415 | * RETURN: Status | |
416 | * | |
417 | * DESCRIPTION: Low level interface to obtain data previously associated with | |
418 | * a namespace node. | |
419 | * | |
420 | ******************************************************************************/ | |
421 | ||
422 | acpi_status | |
4be44fcd LB |
423 | acpi_ns_get_attached_data(struct acpi_namespace_node * node, |
424 | acpi_object_handler handler, void **data) | |
1da177e4 | 425 | { |
4be44fcd | 426 | union acpi_operand_object *obj_desc; |
1da177e4 LT |
427 | |
428 | obj_desc = node->object; | |
429 | while (obj_desc) { | |
4be44fcd LB |
430 | if ((ACPI_GET_OBJECT_TYPE(obj_desc) == ACPI_TYPE_LOCAL_DATA) && |
431 | (obj_desc->data.handler == handler)) { | |
1da177e4 LT |
432 | *data = obj_desc->data.pointer; |
433 | return (AE_OK); | |
434 | } | |
435 | ||
436 | obj_desc = obj_desc->common.next_object; | |
437 | } | |
438 | ||
439 | return (AE_NOT_FOUND); | |
440 | } |