1 /*******************************************************************************
3 * Module Name: nsobject - Utilities for objects attached to namespace
7 ******************************************************************************/
9 /******************************************************************************
13 * Some or all of this work - Copyright (c) 1999 - 2003, Intel Corp.
14 * All rights reserved.
18 * 2.1. This is your license from Intel Corp. under its intellectual property
19 * rights. You may have additional license terms from the party that provided
20 * you this software, covering your right to use that party's intellectual
23 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
24 * copy of the source code appearing in this file ("Covered Code") an
25 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
26 * base code distributed originally by Intel ("Original Intel Code") to copy,
27 * make derivatives, distribute, use and display any portion of the Covered
28 * Code in any form, with the right to sublicense such rights; and
30 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
31 * license (with the right to sublicense), under only those claims of Intel
32 * patents that are infringed by the Original Intel Code, to make, use, sell,
33 * offer to sell, and import the Covered Code and derivative works thereof
34 * solely to the minimum extent necessary to exercise the above copyright
35 * license, and in no event shall the patent license extend to any additions
36 * to or modifications of the Original Intel Code. No other license or right
37 * is granted directly or by implication, estoppel or otherwise;
39 * The above copyright and patent license is granted only if the following
44 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
45 * Redistribution of source code of any substantial portion of the Covered
46 * Code or modification with rights to further distribute source must include
47 * the above Copyright Notice, the above License, this list of Conditions,
48 * and the following Disclaimer and Export Compliance provision. In addition,
49 * Licensee must cause all Covered Code to which Licensee contributes to
50 * contain a file documenting the changes Licensee made to create that Covered
51 * Code and the date of any change. Licensee must include in that file the
52 * documentation of any changes made by any predecessor Licensee. Licensee
53 * must include a prominent statement that the modification is derived,
54 * directly or indirectly, from Original Intel Code.
56 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
57 * Redistribution of source code of any substantial portion of the Covered
58 * Code or modification without rights to further distribute source must
59 * include the following Disclaimer and Export Compliance provision in the
60 * documentation and/or other materials provided with distribution. In
61 * addition, Licensee may not authorize further sublicense of source of any
62 * portion of the Covered Code, and must include terms to the effect that the
63 * license from Licensee to its licensee is limited to the intellectual
64 * property embodied in the software Licensee provides to its licensee, and
65 * not to intellectual property embodied in modifications its licensee may
68 * 3.3. Redistribution of Executable. Redistribution in executable form of any
69 * substantial portion of the Covered Code or modification must reproduce the
70 * above Copyright Notice, and the following Disclaimer and Export Compliance
71 * provision in the documentation and/or other materials provided with the
74 * 3.4. Intel retains all right, title, and interest in and to the Original
77 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
78 * Intel shall be used in advertising or otherwise to promote the sale, use or
79 * other dealings in products derived from or relating to the Covered Code
80 * without prior written authorization from Intel.
82 * 4. Disclaimer and Export Compliance
84 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
85 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
86 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
87 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
88 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
89 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
92 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
93 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
94 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
95 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
96 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
97 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
98 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
101 * 4.3. Licensee shall not export, either directly or indirectly, any of this
102 * software or system incorporating such software without first obtaining any
103 * required license or other approval from the U. S. Department of Commerce or
104 * any other agency or department of the United States Government. In the
105 * event Licensee exports any such software from the United States or
106 * re-exports any such software from a foreign destination, Licensee shall
107 * ensure that the distribution and export/re-export of the software is in
108 * compliance with all laws, regulations, orders, or other restrictions of the
109 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
110 * any of its subsidiaries will export/re-export any technical data, process,
111 * software, or service, directly or indirectly, to any country for which the
112 * United States government or any agency thereof requires an export license,
113 * other governmental approval, or letter of assurance, without first obtaining
114 * such license, approval or letter.
116 *****************************************************************************/
117 /* $DragonFly: src/sys/contrib/dev/acpica/Attic/nsobject.c,v 1.1 2003/09/24 03:32:16 drhodus Exp $ */
120 #define __NSOBJECT_C__
123 #include "acnamesp.h"
126 #define _COMPONENT ACPI_NAMESPACE
127 ACPI_MODULE_NAME ("nsobject")
130 /*******************************************************************************
132 * FUNCTION: AcpiNsAttachObject
134 * PARAMETERS: Node - Parent Node
135 * Object - Object to be attached
136 * Type - Type of object, or ACPI_TYPE_ANY if not
139 * DESCRIPTION: Record the given object as the value associated with the
140 * name whose ACPI_HANDLE is passed. If Object is NULL
141 * and Type is ACPI_TYPE_ANY, set the name as having no value.
142 * Note: Future may require that the Node->Flags field be passed
145 * MUTEX: Assumes namespace is locked
147 ******************************************************************************/
151 ACPI_NAMESPACE_NODE *Node,
152 ACPI_OPERAND_OBJECT *Object,
153 ACPI_OBJECT_TYPE Type)
155 ACPI_OPERAND_OBJECT *ObjDesc;
156 ACPI_OPERAND_OBJECT *LastObjDesc;
157 ACPI_OBJECT_TYPE ObjectType = ACPI_TYPE_ANY;
160 ACPI_FUNCTION_TRACE ("NsAttachObject");
164 * Parameter validation
170 ACPI_REPORT_ERROR (("NsAttachObject: Null NamedObj handle\n"));
171 return_ACPI_STATUS (AE_BAD_PARAMETER);
174 if (!Object && (ACPI_TYPE_ANY != Type))
178 ACPI_REPORT_ERROR (("NsAttachObject: Null object, but type not ACPI_TYPE_ANY\n"));
179 return_ACPI_STATUS (AE_BAD_PARAMETER);
182 if (ACPI_GET_DESCRIPTOR_TYPE (Node) != ACPI_DESC_TYPE_NAMED)
184 /* Not a name handle */
186 ACPI_REPORT_ERROR (("NsAttachObject: Invalid handle\n"));
187 return_ACPI_STATUS (AE_BAD_PARAMETER);
190 /* Check if this object is already attached */
192 if (Node->Object == Object)
194 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Obj %p already installed in NameObj %p\n",
197 return_ACPI_STATUS (AE_OK);
200 /* If null object, we will just install it */
205 ObjectType = ACPI_TYPE_ANY;
209 * If the source object is a namespace Node with an attached object,
210 * we will use that (attached) object
212 else if ((ACPI_GET_DESCRIPTOR_TYPE (Object) == ACPI_DESC_TYPE_NAMED) &&
213 ((ACPI_NAMESPACE_NODE *) Object)->Object)
216 * Value passed is a name handle and that name has a
217 * non-null value. Use that name's value and type.
219 ObjDesc = ((ACPI_NAMESPACE_NODE *) Object)->Object;
220 ObjectType = ((ACPI_NAMESPACE_NODE *) Object)->Type;
224 * Otherwise, we will use the parameter object, but we must type
229 ObjDesc = (ACPI_OPERAND_OBJECT *) Object;
231 /* Use the given type */
236 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Installing %p into Node %p [%4.4s]\n",
237 ObjDesc, Node, Node->Name.Ascii));
239 /* Detach an existing attached object if present */
243 AcpiNsDetachObject (Node);
249 * Must increment the new value's reference count
250 * (if it is an internal object)
252 AcpiUtAddReference (ObjDesc);
255 * Handle objects with multiple descriptors - walk
256 * to the end of the descriptor list
258 LastObjDesc = ObjDesc;
259 while (LastObjDesc->Common.NextObject)
261 LastObjDesc = LastObjDesc->Common.NextObject;
264 /* Install the object at the front of the object list */
266 LastObjDesc->Common.NextObject = Node->Object;
269 Node->Type = (UINT8) ObjectType;
270 Node->Object = ObjDesc;
272 return_ACPI_STATUS (AE_OK);
276 /*******************************************************************************
278 * FUNCTION: AcpiNsDetachObject
280 * PARAMETERS: Node - An node whose object will be detached
284 * DESCRIPTION: Detach/delete an object associated with a namespace node.
285 * if the object is an allocated object, it is freed.
286 * Otherwise, the field is simply cleared.
288 ******************************************************************************/
292 ACPI_NAMESPACE_NODE *Node)
294 ACPI_OPERAND_OBJECT *ObjDesc;
297 ACPI_FUNCTION_TRACE ("NsDetachObject");
300 ObjDesc = Node->Object;
303 (ACPI_GET_OBJECT_TYPE (ObjDesc) == ACPI_TYPE_LOCAL_DATA))
308 /* Clear the entry in all cases */
311 if (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc) == ACPI_DESC_TYPE_OPERAND)
313 Node->Object = ObjDesc->Common.NextObject;
315 (ACPI_GET_OBJECT_TYPE (Node->Object) != ACPI_TYPE_LOCAL_DATA))
317 Node->Object = Node->Object->Common.NextObject;
321 /* Reset the node type to untyped */
323 Node->Type = ACPI_TYPE_ANY;
325 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "Node %p [%4.4s] Object %p\n",
326 Node, Node->Name.Ascii, ObjDesc));
328 /* Remove one reference on the object (and all subobjects) */
330 AcpiUtRemoveReference (ObjDesc);
335 /*******************************************************************************
337 * FUNCTION: AcpiNsGetAttachedObject
339 * PARAMETERS: Node - Parent Node to be examined
341 * RETURN: Current value of the object field from the Node whose
344 * DESCRIPTION: Obtain the object attached to a namespace node.
346 ******************************************************************************/
348 ACPI_OPERAND_OBJECT *
349 AcpiNsGetAttachedObject (
350 ACPI_NAMESPACE_NODE *Node)
352 ACPI_FUNCTION_TRACE_PTR ("NsGetAttachedObject", Node);
357 ACPI_DEBUG_PRINT ((ACPI_DB_WARN, "Null Node ptr\n"));
362 ((ACPI_GET_DESCRIPTOR_TYPE (Node->Object) != ACPI_DESC_TYPE_OPERAND) &&
363 (ACPI_GET_DESCRIPTOR_TYPE (Node->Object) != ACPI_DESC_TYPE_NAMED)) ||
364 (ACPI_GET_OBJECT_TYPE (Node->Object) == ACPI_TYPE_LOCAL_DATA))
369 return_PTR (Node->Object);
373 /*******************************************************************************
375 * FUNCTION: AcpiNsGetSecondaryObject
377 * PARAMETERS: Node - Parent Node to be examined
379 * RETURN: Current value of the object field from the Node whose
382 * DESCRIPTION: Obtain a secondary object associated with a namespace node.
384 ******************************************************************************/
386 ACPI_OPERAND_OBJECT *
387 AcpiNsGetSecondaryObject (
388 ACPI_OPERAND_OBJECT *ObjDesc)
390 ACPI_FUNCTION_TRACE_PTR ("NsGetSecondaryObject", ObjDesc);
394 (ACPI_GET_OBJECT_TYPE (ObjDesc) == ACPI_TYPE_LOCAL_DATA) ||
395 (!ObjDesc->Common.NextObject) ||
396 (ACPI_GET_OBJECT_TYPE (ObjDesc->Common.NextObject) == ACPI_TYPE_LOCAL_DATA))
401 return_PTR (ObjDesc->Common.NextObject);
405 /*******************************************************************************
407 * FUNCTION: AcpiNsAttachData
409 * PARAMETERS: Node - Namespace node
410 * Handler - Handler to be associated with the data
411 * Data - Data to be attached
415 * DESCRIPTION: Low-level attach data. Create and attach a Data object.
417 ******************************************************************************/
421 ACPI_NAMESPACE_NODE *Node,
422 ACPI_OBJECT_HANDLER Handler,
425 ACPI_OPERAND_OBJECT *PrevObjDesc;
426 ACPI_OPERAND_OBJECT *ObjDesc;
427 ACPI_OPERAND_OBJECT *DataDesc;
430 /* We only allow one attachment per handler */
433 ObjDesc = Node->Object;
436 if ((ACPI_GET_OBJECT_TYPE (ObjDesc) == ACPI_TYPE_LOCAL_DATA) &&
437 (ObjDesc->Data.Handler == Handler))
439 return (AE_ALREADY_EXISTS);
442 PrevObjDesc = ObjDesc;
443 ObjDesc = ObjDesc->Common.NextObject;
446 /* Create an internal object for the data */
448 DataDesc = AcpiUtCreateInternalObject (ACPI_TYPE_LOCAL_DATA);
451 return (AE_NO_MEMORY);
454 DataDesc->Data.Handler = Handler;
455 DataDesc->Data.Pointer = Data;
457 /* Install the data object */
461 PrevObjDesc->Common.NextObject = DataDesc;
465 Node->Object = DataDesc;
472 /*******************************************************************************
474 * FUNCTION: AcpiNsDetachData
476 * PARAMETERS: Node - Namespace node
477 * Handler - Handler associated with the data
481 * DESCRIPTION: Low-level detach data. Delete the data node, but the caller
482 * is responsible for the actual data.
484 ******************************************************************************/
488 ACPI_NAMESPACE_NODE *Node,
489 ACPI_OBJECT_HANDLER Handler)
491 ACPI_OPERAND_OBJECT *ObjDesc;
492 ACPI_OPERAND_OBJECT *PrevObjDesc;
496 ObjDesc = Node->Object;
499 if ((ACPI_GET_OBJECT_TYPE (ObjDesc) == ACPI_TYPE_LOCAL_DATA) &&
500 (ObjDesc->Data.Handler == Handler))
504 PrevObjDesc->Common.NextObject = ObjDesc->Common.NextObject;
508 Node->Object = ObjDesc->Common.NextObject;
511 AcpiUtRemoveReference (ObjDesc);
515 PrevObjDesc = ObjDesc;
516 ObjDesc = ObjDesc->Common.NextObject;
519 return (AE_NOT_FOUND);
523 /*******************************************************************************
525 * FUNCTION: AcpiNsGetAttachedData
527 * PARAMETERS: Node - Namespace node
528 * Handler - Handler associated with the data
529 * Data - Where the data is returned
533 * DESCRIPTION: Low level interface to obtain data previously associated with
536 ******************************************************************************/
539 AcpiNsGetAttachedData (
540 ACPI_NAMESPACE_NODE *Node,
541 ACPI_OBJECT_HANDLER Handler,
544 ACPI_OPERAND_OBJECT *ObjDesc;
547 ObjDesc = Node->Object;
550 if ((ACPI_GET_OBJECT_TYPE (ObjDesc) == ACPI_TYPE_LOCAL_DATA) &&
551 (ObjDesc->Data.Handler == Handler))
553 *Data = ObjDesc->Data.Pointer;
557 ObjDesc = ObjDesc->Common.NextObject;
560 return (AE_NOT_FOUND);