1 /*******************************************************************************
3 * Module Name: nsobject - Utilities for objects attached to namespace
6 ******************************************************************************/
9 * Copyright (C) 2000 - 2010, Intel Corp.
10 * All rights reserved.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
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.
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.
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.
45 #include <acpi/acpi.h>
49 #define _COMPONENT ACPI_NAMESPACE
50 ACPI_MODULE_NAME("nsobject")
52 /*******************************************************************************
54 * FUNCTION: acpi_ns_attach_object
56 * PARAMETERS: Node - Parent Node
57 * Object - Object to be attached
58 * Type - Type of object, or ACPI_TYPE_ANY if not
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
69 * MUTEX: Assumes namespace is locked
71 ******************************************************************************/
73 acpi_ns_attach_object(struct acpi_namespace_node *node,
74 union acpi_operand_object *object, acpi_object_type type)
76 union acpi_operand_object *obj_desc;
77 union acpi_operand_object *last_obj_desc;
78 acpi_object_type object_type = ACPI_TYPE_ANY;
80 ACPI_FUNCTION_TRACE(ns_attach_object);
83 * Parameter validation
89 ACPI_ERROR((AE_INFO, "Null NamedObj handle"));
90 return_ACPI_STATUS(AE_BAD_PARAMETER);
93 if (!object && (ACPI_TYPE_ANY != type)) {
98 "Null object, but type not ACPI_TYPE_ANY"));
99 return_ACPI_STATUS(AE_BAD_PARAMETER);
102 if (ACPI_GET_DESCRIPTOR_TYPE(node) != ACPI_DESC_TYPE_NAMED) {
104 /* Not a name handle */
106 ACPI_ERROR((AE_INFO, "Invalid handle %p [%s]",
107 node, acpi_ut_get_descriptor_name(node)));
108 return_ACPI_STATUS(AE_BAD_PARAMETER);
111 /* Check if this object is already attached */
113 if (node->object == object) {
114 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
115 "Obj %p already installed in NameObj %p\n",
118 return_ACPI_STATUS(AE_OK);
121 /* If null object, we will just install it */
125 object_type = ACPI_TYPE_ANY;
129 * If the source object is a namespace Node with an attached object,
130 * we will use that (attached) object
132 else if ((ACPI_GET_DESCRIPTOR_TYPE(object) == ACPI_DESC_TYPE_NAMED) &&
133 ((struct acpi_namespace_node *)object)->object) {
135 * Value passed is a name handle and that name has a
136 * non-null value. Use that name's value and type.
138 obj_desc = ((struct acpi_namespace_node *)object)->object;
139 object_type = ((struct acpi_namespace_node *)object)->type;
143 * Otherwise, we will use the parameter object, but we must type
147 obj_desc = (union acpi_operand_object *)object;
149 /* Use the given type */
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)));
157 /* Detach an existing attached object if present */
160 acpi_ns_detach_object(node);
165 * Must increment the new value's reference count
166 * (if it is an internal object)
168 acpi_ut_add_reference(obj_desc);
171 * Handle objects with multiple descriptors - walk
172 * to the end of the descriptor list
174 last_obj_desc = obj_desc;
175 while (last_obj_desc->common.next_object) {
176 last_obj_desc = last_obj_desc->common.next_object;
179 /* Install the object at the front of the object list */
181 last_obj_desc->common.next_object = node->object;
184 node->type = (u8) object_type;
185 node->object = obj_desc;
187 return_ACPI_STATUS(AE_OK);
190 /*******************************************************************************
192 * FUNCTION: acpi_ns_detach_object
194 * PARAMETERS: Node - A Namespace node whose object will be detached
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.
202 ******************************************************************************/
204 void acpi_ns_detach_object(struct acpi_namespace_node *node)
206 union acpi_operand_object *obj_desc;
208 ACPI_FUNCTION_TRACE(ns_detach_object);
210 obj_desc = node->object;
212 if (!obj_desc || (obj_desc->common.type == ACPI_TYPE_LOCAL_DATA)) {
216 if (node->flags & ANOBJ_ALLOCATED_BUFFER) {
218 /* Free the dynamic aml buffer */
220 if (obj_desc->common.type == ACPI_TYPE_METHOD) {
221 ACPI_FREE(obj_desc->method.aml_start);
225 /* Clear the entry in all cases */
228 if (ACPI_GET_DESCRIPTOR_TYPE(obj_desc) == ACPI_DESC_TYPE_OPERAND) {
229 node->object = obj_desc->common.next_object;
231 ((node->object)->common.type != ACPI_TYPE_LOCAL_DATA)) {
232 node->object = node->object->common.next_object;
236 /* Reset the node type to untyped */
238 node->type = ACPI_TYPE_ANY;
240 ACPI_DEBUG_PRINT((ACPI_DB_NAMES, "Node %p [%4.4s] Object %p\n",
241 node, acpi_ut_get_node_name(node), obj_desc));
243 /* Remove one reference on the object (and all subobjects) */
245 acpi_ut_remove_reference(obj_desc);
249 /*******************************************************************************
251 * FUNCTION: acpi_ns_get_attached_object
253 * PARAMETERS: Node - Namespace node
255 * RETURN: Current value of the object field from the Node whose
258 * DESCRIPTION: Obtain the object attached to a namespace node.
260 ******************************************************************************/
262 union acpi_operand_object *acpi_ns_get_attached_object(struct
266 ACPI_FUNCTION_TRACE_PTR(ns_get_attached_object, node);
269 ACPI_WARNING((AE_INFO, "Null Node ptr"));
274 ((ACPI_GET_DESCRIPTOR_TYPE(node->object) != ACPI_DESC_TYPE_OPERAND)
275 && (ACPI_GET_DESCRIPTOR_TYPE(node->object) !=
276 ACPI_DESC_TYPE_NAMED))
277 || ((node->object)->common.type == ACPI_TYPE_LOCAL_DATA)) {
281 return_PTR(node->object);
284 /*******************************************************************************
286 * FUNCTION: acpi_ns_get_secondary_object
288 * PARAMETERS: Node - Namespace node
290 * RETURN: Current value of the object field from the Node whose
293 * DESCRIPTION: Obtain a secondary object associated with a namespace node.
295 ******************************************************************************/
297 union acpi_operand_object *acpi_ns_get_secondary_object(union
301 ACPI_FUNCTION_TRACE_PTR(ns_get_secondary_object, obj_desc);
304 (obj_desc->common.type == ACPI_TYPE_LOCAL_DATA) ||
305 (!obj_desc->common.next_object) ||
306 ((obj_desc->common.next_object)->common.type ==
307 ACPI_TYPE_LOCAL_DATA)) {
311 return_PTR(obj_desc->common.next_object);
314 /*******************************************************************************
316 * FUNCTION: acpi_ns_attach_data
318 * PARAMETERS: Node - Namespace node
319 * Handler - Handler to be associated with the data
320 * Data - Data to be attached
324 * DESCRIPTION: Low-level attach data. Create and attach a Data object.
326 ******************************************************************************/
329 acpi_ns_attach_data(struct acpi_namespace_node *node,
330 acpi_object_handler handler, void *data)
332 union acpi_operand_object *prev_obj_desc;
333 union acpi_operand_object *obj_desc;
334 union acpi_operand_object *data_desc;
336 /* We only allow one attachment per handler */
338 prev_obj_desc = NULL;
339 obj_desc = node->object;
341 if ((obj_desc->common.type == ACPI_TYPE_LOCAL_DATA) &&
342 (obj_desc->data.handler == handler)) {
343 return (AE_ALREADY_EXISTS);
346 prev_obj_desc = obj_desc;
347 obj_desc = obj_desc->common.next_object;
350 /* Create an internal object for the data */
352 data_desc = acpi_ut_create_internal_object(ACPI_TYPE_LOCAL_DATA);
354 return (AE_NO_MEMORY);
357 data_desc->data.handler = handler;
358 data_desc->data.pointer = data;
360 /* Install the data object */
363 prev_obj_desc->common.next_object = data_desc;
365 node->object = data_desc;
371 /*******************************************************************************
373 * FUNCTION: acpi_ns_detach_data
375 * PARAMETERS: Node - Namespace node
376 * Handler - Handler associated with the data
380 * DESCRIPTION: Low-level detach data. Delete the data node, but the caller
381 * is responsible for the actual data.
383 ******************************************************************************/
386 acpi_ns_detach_data(struct acpi_namespace_node * node,
387 acpi_object_handler handler)
389 union acpi_operand_object *obj_desc;
390 union acpi_operand_object *prev_obj_desc;
392 prev_obj_desc = NULL;
393 obj_desc = node->object;
395 if ((obj_desc->common.type == ACPI_TYPE_LOCAL_DATA) &&
396 (obj_desc->data.handler == handler)) {
398 prev_obj_desc->common.next_object =
399 obj_desc->common.next_object;
401 node->object = obj_desc->common.next_object;
404 acpi_ut_remove_reference(obj_desc);
408 prev_obj_desc = obj_desc;
409 obj_desc = obj_desc->common.next_object;
412 return (AE_NOT_FOUND);
415 /*******************************************************************************
417 * FUNCTION: acpi_ns_get_attached_data
419 * PARAMETERS: Node - Namespace node
420 * Handler - Handler associated with the data
421 * Data - Where the data is returned
425 * DESCRIPTION: Low level interface to obtain data previously associated with
428 ******************************************************************************/
431 acpi_ns_get_attached_data(struct acpi_namespace_node * node,
432 acpi_object_handler handler, void **data)
434 union acpi_operand_object *obj_desc;
436 obj_desc = node->object;
438 if ((obj_desc->common.type == ACPI_TYPE_LOCAL_DATA) &&
439 (obj_desc->data.handler == handler)) {
440 *data = obj_desc->data.pointer;
444 obj_desc = obj_desc->common.next_object;
447 return (AE_NOT_FOUND);