1 /*******************************************************************************
3 * Module Name: nsobject - Utilities for objects attached to namespace
6 ******************************************************************************/
9 * Copyright (C) 2000 - 2015, 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 <contrib/dev/acpica/include/acpi.h>
46 #include <contrib/dev/acpica/include/accommon.h>
47 #include <contrib/dev/acpica/include/acnamesp.h>
50 #define _COMPONENT ACPI_NAMESPACE
51 ACPI_MODULE_NAME ("nsobject")
54 /*******************************************************************************
56 * FUNCTION: AcpiNsAttachObject
58 * PARAMETERS: Node - Parent Node
59 * Object - Object to be attached
60 * Type - Type of object, or ACPI_TYPE_ANY if not
65 * DESCRIPTION: Record the given object as the value associated with the
66 * name whose ACPI_HANDLE is passed. If Object is NULL
67 * and Type is ACPI_TYPE_ANY, set the name as having no value.
68 * Note: Future may require that the Node->Flags field be passed
71 * MUTEX: Assumes namespace is locked
73 ******************************************************************************/
77 ACPI_NAMESPACE_NODE *Node,
78 ACPI_OPERAND_OBJECT *Object,
79 ACPI_OBJECT_TYPE Type)
81 ACPI_OPERAND_OBJECT *ObjDesc;
82 ACPI_OPERAND_OBJECT *LastObjDesc;
83 ACPI_OBJECT_TYPE ObjectType = ACPI_TYPE_ANY;
86 ACPI_FUNCTION_TRACE (NsAttachObject);
90 * Parameter validation
96 ACPI_ERROR ((AE_INFO, "Null NamedObj handle"));
97 return_ACPI_STATUS (AE_BAD_PARAMETER);
100 if (!Object && (ACPI_TYPE_ANY != Type))
104 ACPI_ERROR ((AE_INFO,
105 "Null object, but type not ACPI_TYPE_ANY"));
106 return_ACPI_STATUS (AE_BAD_PARAMETER);
109 if (ACPI_GET_DESCRIPTOR_TYPE (Node) != ACPI_DESC_TYPE_NAMED)
111 /* Not a name handle */
113 ACPI_ERROR ((AE_INFO, "Invalid handle %p [%s]",
114 Node, AcpiUtGetDescriptorName (Node)));
115 return_ACPI_STATUS (AE_BAD_PARAMETER);
118 /* Check if this object is already attached */
120 if (Node->Object == Object)
122 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
123 "Obj %p already installed in NameObj %p\n",
126 return_ACPI_STATUS (AE_OK);
129 /* If null object, we will just install it */
134 ObjectType = ACPI_TYPE_ANY;
138 * If the source object is a namespace Node with an attached object,
139 * we will use that (attached) object
141 else if ((ACPI_GET_DESCRIPTOR_TYPE (Object) == ACPI_DESC_TYPE_NAMED) &&
142 ((ACPI_NAMESPACE_NODE *) Object)->Object)
145 * Value passed is a name handle and that name has a
146 * non-null value. Use that name's value and type.
148 ObjDesc = ((ACPI_NAMESPACE_NODE *) Object)->Object;
149 ObjectType = ((ACPI_NAMESPACE_NODE *) Object)->Type;
153 * Otherwise, we will use the parameter object, but we must type
158 ObjDesc = (ACPI_OPERAND_OBJECT *) Object;
160 /* Use the given type */
165 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Installing %p into Node %p [%4.4s]\n",
166 ObjDesc, Node, AcpiUtGetNodeName (Node)));
168 /* Detach an existing attached object if present */
172 AcpiNsDetachObject (Node);
178 * Must increment the new value's reference count
179 * (if it is an internal object)
181 AcpiUtAddReference (ObjDesc);
184 * Handle objects with multiple descriptors - walk
185 * to the end of the descriptor list
187 LastObjDesc = ObjDesc;
188 while (LastObjDesc->Common.NextObject)
190 LastObjDesc = LastObjDesc->Common.NextObject;
193 /* Install the object at the front of the object list */
195 LastObjDesc->Common.NextObject = Node->Object;
198 Node->Type = (UINT8) ObjectType;
199 Node->Object = ObjDesc;
201 return_ACPI_STATUS (AE_OK);
205 /*******************************************************************************
207 * FUNCTION: AcpiNsDetachObject
209 * PARAMETERS: Node - A Namespace node whose object will be detached
213 * DESCRIPTION: Detach/delete an object associated with a namespace node.
214 * if the object is an allocated object, it is freed.
215 * Otherwise, the field is simply cleared.
217 ******************************************************************************/
221 ACPI_NAMESPACE_NODE *Node)
223 ACPI_OPERAND_OBJECT *ObjDesc;
226 ACPI_FUNCTION_TRACE (NsDetachObject);
229 ObjDesc = Node->Object;
232 (ObjDesc->Common.Type == ACPI_TYPE_LOCAL_DATA))
237 if (Node->Flags & ANOBJ_ALLOCATED_BUFFER)
239 /* Free the dynamic aml buffer */
241 if (ObjDesc->Common.Type == ACPI_TYPE_METHOD)
243 ACPI_FREE (ObjDesc->Method.AmlStart);
247 /* Clear the Node entry in all cases */
250 if (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc) == ACPI_DESC_TYPE_OPERAND)
252 /* Unlink object from front of possible object list */
254 Node->Object = ObjDesc->Common.NextObject;
256 /* Handle possible 2-descriptor object */
259 (Node->Object->Common.Type != ACPI_TYPE_LOCAL_DATA))
261 Node->Object = Node->Object->Common.NextObject;
265 * Detach the object from any data objects (which are still held by
266 * the namespace node)
268 if (ObjDesc->Common.NextObject &&
269 ((ObjDesc->Common.NextObject)->Common.Type == ACPI_TYPE_LOCAL_DATA))
271 ObjDesc->Common.NextObject = NULL;
275 /* Reset the node type to untyped */
277 Node->Type = ACPI_TYPE_ANY;
279 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "Node %p [%4.4s] Object %p\n",
280 Node, AcpiUtGetNodeName (Node), ObjDesc));
282 /* Remove one reference on the object (and all subobjects) */
284 AcpiUtRemoveReference (ObjDesc);
289 /*******************************************************************************
291 * FUNCTION: AcpiNsGetAttachedObject
293 * PARAMETERS: Node - Namespace node
295 * RETURN: Current value of the object field from the Node whose
298 * DESCRIPTION: Obtain the object attached to a namespace node.
300 ******************************************************************************/
302 ACPI_OPERAND_OBJECT *
303 AcpiNsGetAttachedObject (
304 ACPI_NAMESPACE_NODE *Node)
306 ACPI_FUNCTION_TRACE_PTR (NsGetAttachedObject, Node);
311 ACPI_WARNING ((AE_INFO, "Null Node ptr"));
316 ((ACPI_GET_DESCRIPTOR_TYPE (Node->Object) != ACPI_DESC_TYPE_OPERAND) &&
317 (ACPI_GET_DESCRIPTOR_TYPE (Node->Object) != ACPI_DESC_TYPE_NAMED)) ||
318 ((Node->Object)->Common.Type == ACPI_TYPE_LOCAL_DATA))
323 return_PTR (Node->Object);
327 /*******************************************************************************
329 * FUNCTION: AcpiNsGetSecondaryObject
331 * PARAMETERS: Node - Namespace node
333 * RETURN: Current value of the object field from the Node whose
336 * DESCRIPTION: Obtain a secondary object associated with a namespace node.
338 ******************************************************************************/
340 ACPI_OPERAND_OBJECT *
341 AcpiNsGetSecondaryObject (
342 ACPI_OPERAND_OBJECT *ObjDesc)
344 ACPI_FUNCTION_TRACE_PTR (NsGetSecondaryObject, ObjDesc);
348 (ObjDesc->Common.Type== ACPI_TYPE_LOCAL_DATA) ||
349 (!ObjDesc->Common.NextObject) ||
350 ((ObjDesc->Common.NextObject)->Common.Type == ACPI_TYPE_LOCAL_DATA))
355 return_PTR (ObjDesc->Common.NextObject);
359 /*******************************************************************************
361 * FUNCTION: AcpiNsAttachData
363 * PARAMETERS: Node - Namespace node
364 * Handler - Handler to be associated with the data
365 * Data - Data to be attached
369 * DESCRIPTION: Low-level attach data. Create and attach a Data object.
371 ******************************************************************************/
375 ACPI_NAMESPACE_NODE *Node,
376 ACPI_OBJECT_HANDLER Handler,
379 ACPI_OPERAND_OBJECT *PrevObjDesc;
380 ACPI_OPERAND_OBJECT *ObjDesc;
381 ACPI_OPERAND_OBJECT *DataDesc;
384 /* We only allow one attachment per handler */
387 ObjDesc = Node->Object;
390 if ((ObjDesc->Common.Type == ACPI_TYPE_LOCAL_DATA) &&
391 (ObjDesc->Data.Handler == Handler))
393 return (AE_ALREADY_EXISTS);
396 PrevObjDesc = ObjDesc;
397 ObjDesc = ObjDesc->Common.NextObject;
400 /* Create an internal object for the data */
402 DataDesc = AcpiUtCreateInternalObject (ACPI_TYPE_LOCAL_DATA);
405 return (AE_NO_MEMORY);
408 DataDesc->Data.Handler = Handler;
409 DataDesc->Data.Pointer = Data;
411 /* Install the data object */
415 PrevObjDesc->Common.NextObject = DataDesc;
419 Node->Object = DataDesc;
426 /*******************************************************************************
428 * FUNCTION: AcpiNsDetachData
430 * PARAMETERS: Node - Namespace node
431 * Handler - Handler associated with the data
435 * DESCRIPTION: Low-level detach data. Delete the data node, but the caller
436 * is responsible for the actual data.
438 ******************************************************************************/
442 ACPI_NAMESPACE_NODE *Node,
443 ACPI_OBJECT_HANDLER Handler)
445 ACPI_OPERAND_OBJECT *ObjDesc;
446 ACPI_OPERAND_OBJECT *PrevObjDesc;
450 ObjDesc = Node->Object;
453 if ((ObjDesc->Common.Type == ACPI_TYPE_LOCAL_DATA) &&
454 (ObjDesc->Data.Handler == Handler))
458 PrevObjDesc->Common.NextObject = ObjDesc->Common.NextObject;
462 Node->Object = ObjDesc->Common.NextObject;
465 AcpiUtRemoveReference (ObjDesc);
469 PrevObjDesc = ObjDesc;
470 ObjDesc = ObjDesc->Common.NextObject;
473 return (AE_NOT_FOUND);
477 /*******************************************************************************
479 * FUNCTION: AcpiNsGetAttachedData
481 * PARAMETERS: Node - Namespace node
482 * Handler - Handler associated with the data
483 * Data - Where the data is returned
487 * DESCRIPTION: Low level interface to obtain data previously associated with
490 ******************************************************************************/
493 AcpiNsGetAttachedData (
494 ACPI_NAMESPACE_NODE *Node,
495 ACPI_OBJECT_HANDLER Handler,
498 ACPI_OPERAND_OBJECT *ObjDesc;
501 ObjDesc = Node->Object;
504 if ((ObjDesc->Common.Type == ACPI_TYPE_LOCAL_DATA) &&
505 (ObjDesc->Data.Handler == Handler))
507 *Data = ObjDesc->Data.Pointer;
511 ObjDesc = ObjDesc->Common.NextObject;
514 return (AE_NOT_FOUND);