nsobject.c revision 85756
1/******************************************************************************* 2 * 3 * Module Name: nsobject - Utilities for objects attached to namespace 4 * table entries 5 * $Revision: 67 $ 6 * 7 ******************************************************************************/ 8 9/****************************************************************************** 10 * 11 * 1. Copyright Notice 12 * 13 * Some or all of this work - Copyright (c) 1999, 2000, 2001, Intel Corp. 14 * All rights reserved. 15 * 16 * 2. License 17 * 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 21 * property rights. 22 * 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 29 * 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; 38 * 39 * The above copyright and patent license is granted only if the following 40 * conditions are met: 41 * 42 * 3. Conditions 43 * 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. 55 * 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 66 * make. 67 * 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 72 * distribution. 73 * 74 * 3.4. Intel retains all right, title, and interest in and to the Original 75 * Intel Code. 76 * 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. 81 * 82 * 4. Disclaimer and Export Compliance 83 * 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 90 * PARTICULAR PURPOSE. 91 * 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 99 * LIMITED REMEDY. 100 * 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. 115 * 116 *****************************************************************************/ 117 118 119#define __NSOBJECT_C__ 120 121#include "acpi.h" 122#include "amlcode.h" 123#include "acnamesp.h" 124#include "acinterp.h" 125#include "actables.h" 126 127 128#define _COMPONENT ACPI_NAMESPACE 129 MODULE_NAME ("nsobject") 130 131 132/******************************************************************************* 133 * 134 * FUNCTION: AcpiNsAttachObject 135 * 136 * PARAMETERS: Node - Parent Node 137 * Object - Object to be attached 138 * Type - Type of object, or ACPI_TYPE_ANY if not 139 * known 140 * 141 * DESCRIPTION: Record the given object as the value associated with the 142 * name whose ACPI_HANDLE is passed. If Object is NULL 143 * and Type is ACPI_TYPE_ANY, set the name as having no value. 144 * 145 * MUTEX: Assumes namespace is locked 146 * 147 ******************************************************************************/ 148 149ACPI_STATUS 150AcpiNsAttachObject ( 151 ACPI_NAMESPACE_NODE *Node, 152 ACPI_OPERAND_OBJECT *Object, 153 ACPI_OBJECT_TYPE8 Type) 154{ 155 ACPI_OPERAND_OBJECT *ObjDesc; 156 ACPI_OPERAND_OBJECT *PreviousObjDesc; 157 ACPI_OBJECT_TYPE8 ObjType = ACPI_TYPE_ANY; 158 UINT8 Flags; 159 160 161 FUNCTION_TRACE ("NsAttachObject"); 162 163 164 /* 165 * Parameter validation 166 */ 167 if (!AcpiGbl_RootNode) 168 { 169 /* Name space not initialized */ 170 171 REPORT_ERROR (("NsAttachObject: Namespace not initialized\n")); 172 return_ACPI_STATUS (AE_NO_NAMESPACE); 173 } 174 175 if (!Node) 176 { 177 /* Invalid handle */ 178 179 REPORT_ERROR (("NsAttachObject: Null NamedObj handle\n")); 180 return_ACPI_STATUS (AE_BAD_PARAMETER); 181 } 182 183 if (!Object && (ACPI_TYPE_ANY != Type)) 184 { 185 /* Null object */ 186 187 REPORT_ERROR (("NsAttachObject: Null object, but type not ACPI_TYPE_ANY\n")); 188 return_ACPI_STATUS (AE_BAD_PARAMETER); 189 } 190 191 if (!VALID_DESCRIPTOR_TYPE (Node, ACPI_DESC_TYPE_NAMED)) 192 { 193 /* Not a name handle */ 194 195 REPORT_ERROR (("NsAttachObject: Invalid handle\n")); 196 return_ACPI_STATUS (AE_BAD_PARAMETER); 197 } 198 199 /* Check if this object is already attached */ 200 201 if (Node->Object == Object) 202 { 203 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Obj %p already installed in NameObj %p\n", 204 Object, Node)); 205 206 return_ACPI_STATUS (AE_OK); 207 } 208 209 210 /* Get the current flags field of the Node */ 211 212 Flags = Node->Flags; 213 Flags &= ~ANOBJ_AML_ATTACHMENT; 214 215 216 /* If null object, we will just install it */ 217 218 if (!Object) 219 { 220 ObjDesc = NULL; 221 ObjType = ACPI_TYPE_ANY; 222 } 223 224 /* 225 * If the source object is a namespace Node with an attached object, 226 * we will use that (attached) object 227 */ 228 else if (VALID_DESCRIPTOR_TYPE (Object, ACPI_DESC_TYPE_NAMED) && 229 ((ACPI_NAMESPACE_NODE *) Object)->Object) 230 { 231 /* 232 * Value passed is a name handle and that name has a 233 * non-null value. Use that name's value and type. 234 */ 235 ObjDesc = ((ACPI_NAMESPACE_NODE *) Object)->Object; 236 ObjType = ((ACPI_NAMESPACE_NODE *) Object)->Type; 237 238 /* 239 * Copy appropriate flags 240 */ 241 if (((ACPI_NAMESPACE_NODE *) Object)->Flags & ANOBJ_AML_ATTACHMENT) 242 { 243 Flags |= ANOBJ_AML_ATTACHMENT; 244 } 245 } 246 247 248 /* 249 * Otherwise, we will use the parameter object, but we must type 250 * it first 251 */ 252 else 253 { 254 ObjDesc = (ACPI_OPERAND_OBJECT *) Object; 255 256 /* If a valid type (non-ANY) was given, just use it */ 257 258 if (ACPI_TYPE_ANY != Type) 259 { 260 ObjType = Type; 261 } 262 263 else 264 { 265 /* 266 * Cannot figure out the type -- set to DefAny which 267 * will print as an error in the name table dump 268 */ 269 if (AcpiDbgLevel > 0) 270 { 271 DUMP_PATHNAME (Node, 272 "NsAttachObject confused: setting bogus type for ", 273 ACPI_LV_INFO, _COMPONENT); 274 275 if (VALID_DESCRIPTOR_TYPE (Object, ACPI_DESC_TYPE_NAMED)) 276 { 277 DUMP_PATHNAME (Object, "name ", ACPI_LV_INFO, _COMPONENT); 278 } 279 280 else 281 { 282 DUMP_PATHNAME (Object, "object ", ACPI_LV_INFO, _COMPONENT); 283 DUMP_STACK_ENTRY (Object); 284 } 285 } 286 287 ObjType = INTERNAL_TYPE_DEF_ANY; 288 } 289 } 290 291 292 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Installing %p into Node %p [%4.4s]\n", 293 ObjDesc, Node, (char*)&Node->Name)); 294 295 296 /* 297 * Must increment the new value's reference count 298 * (if it is an internal object) 299 */ 300 AcpiUtAddReference (ObjDesc); 301 302 /* Save the existing object (if any) for deletion later */ 303 304 PreviousObjDesc = Node->Object; 305 306 /* Install the object and set the type, flags */ 307 308 Node->Object = ObjDesc; 309 Node->Type = (UINT8) ObjType; 310 Node->Flags |= Flags; 311 312 313 /* 314 * Delete an existing attached object. 315 */ 316 if (PreviousObjDesc) 317 { 318 /* One for the attach to the Node */ 319 320 AcpiUtRemoveReference (PreviousObjDesc); 321 322 /* Now delete */ 323 324 AcpiUtRemoveReference (PreviousObjDesc); 325 } 326 327 return_ACPI_STATUS (AE_OK); 328} 329 330 331/******************************************************************************* 332 * 333 * FUNCTION: AcpiNsDetachObject 334 * 335 * PARAMETERS: Node - An object whose Value will be deleted 336 * 337 * RETURN: None. 338 * 339 * DESCRIPTION: Delete the Value associated with a namespace object. If the 340 * Value is an allocated object, it is freed. Otherwise, the 341 * field is simply cleared. 342 * 343 ******************************************************************************/ 344 345void 346AcpiNsDetachObject ( 347 ACPI_NAMESPACE_NODE *Node) 348{ 349 ACPI_OPERAND_OBJECT *ObjDesc; 350 351 352 FUNCTION_TRACE ("NsDetachObject"); 353 354 355 ObjDesc = Node->Object; 356 if (!ObjDesc) 357 { 358 return_VOID; 359 } 360 361 /* Clear the entry in all cases */ 362 363 Node->Object = NULL; 364 365 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Object=%p Value=%p Name %4.4s\n", 366 Node, ObjDesc, (char*)&Node->Name)); 367 368 /* Remove one reference on the object (and all subobjects) */ 369 370 AcpiUtRemoveReference (ObjDesc); 371 return_VOID; 372} 373 374 375/******************************************************************************* 376 * 377 * FUNCTION: AcpiNsGetAttachedObject 378 * 379 * PARAMETERS: Node - Parent Node to be examined 380 * 381 * RETURN: Current value of the object field from the Node whose 382 * handle is passed 383 * 384 ******************************************************************************/ 385 386void * 387AcpiNsGetAttachedObject ( 388 ACPI_NAMESPACE_NODE *Node) 389{ 390 FUNCTION_TRACE_PTR ("NsGetAttachedObject", Node); 391 392 393 if (!Node) 394 { 395 /* handle invalid */ 396 397 ACPI_DEBUG_PRINT ((ACPI_DB_WARN, "Null Node ptr\n")); 398 return_PTR (NULL); 399 } 400 401 return_PTR (Node->Object); 402} 403 404 405