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