nsobject.c revision 83174
1/******************************************************************************* 2 * 3 * Module Name: nsobject - Utilities for objects attached to namespace 4 * table entries 5 * $Revision: 63 $ 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 UINT16 Opcode; 160 161 162 FUNCTION_TRACE ("NsAttachObject"); 163 164 165 /* 166 * Parameter validation 167 */ 168 if (!AcpiGbl_RootNode) 169 { 170 /* Name space not initialized */ 171 172 REPORT_ERROR (("NsAttachObject: Namespace not initialized\n")); 173 return_ACPI_STATUS (AE_NO_NAMESPACE); 174 } 175 176 if (!Node) 177 { 178 /* Invalid handle */ 179 180 REPORT_ERROR (("NsAttachObject: Null NamedObj handle\n")); 181 return_ACPI_STATUS (AE_BAD_PARAMETER); 182 } 183 184 if (!Object && (ACPI_TYPE_ANY != Type)) 185 { 186 /* Null object */ 187 188 REPORT_ERROR (("NsAttachObject: Null object, but type not ACPI_TYPE_ANY\n")); 189 return_ACPI_STATUS (AE_BAD_PARAMETER); 190 } 191 192 if (!VALID_DESCRIPTOR_TYPE (Node, ACPI_DESC_TYPE_NAMED)) 193 { 194 /* Not a name handle */ 195 196 REPORT_ERROR (("NsAttachObject: Invalid handle\n")); 197 return_ACPI_STATUS (AE_BAD_PARAMETER); 198 } 199 200 /* Check if this object is already attached */ 201 202 if (Node->Object == Object) 203 { 204 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Obj %p already installed in NameObj %p\n", 205 Object, Node)); 206 207 return_ACPI_STATUS (AE_OK); 208 } 209 210 211 /* Get the current flags field of the Node */ 212 213 Flags = Node->Flags; 214 Flags &= ~ANOBJ_AML_ATTACHMENT; 215 216 217 /* If null object, we will just install it */ 218 219 if (!Object) 220 { 221 ObjDesc = NULL; 222 ObjType = ACPI_TYPE_ANY; 223 } 224 225 /* 226 * If the object is an Node with an attached object, 227 * we will use that (attached) object 228 */ 229 else if (VALID_DESCRIPTOR_TYPE (Object, ACPI_DESC_TYPE_NAMED) && 230 ((ACPI_NAMESPACE_NODE *) Object)->Object) 231 { 232 /* 233 * Value passed is a name handle and that name has a 234 * non-null value. Use that name's value and type. 235 */ 236 ObjDesc = ((ACPI_NAMESPACE_NODE *) Object)->Object; 237 ObjType = ((ACPI_NAMESPACE_NODE *) Object)->Type; 238 239 /* 240 * Copy appropriate flags 241 */ 242 if (((ACPI_NAMESPACE_NODE *) Object)->Flags & ANOBJ_AML_ATTACHMENT) 243 { 244 Flags |= ANOBJ_AML_ATTACHMENT; 245 } 246 } 247 248 249 /* 250 * Otherwise, we will use the parameter object, but we must type 251 * it first 252 */ 253 else 254 { 255 ObjDesc = (ACPI_OPERAND_OBJECT *) Object; 256 257 /* If a valid type (non-ANY) was given, just use it */ 258 259 if (ACPI_TYPE_ANY != Type) 260 { 261 ObjType = Type; 262 } 263 264 /* 265 * Type is TYPE_Any, we must try to determinte the 266 * actual type of the object. 267 * Check if value points into the AML code 268 */ 269 else if (AcpiTbSystemTablePointer (Object)) 270 { 271 /* 272 * Object points into the AML stream. 273 * Set a flag bit in the Node to indicate this 274 */ 275 Flags |= ANOBJ_AML_ATTACHMENT; 276 277 /* 278 * The next byte (perhaps the next two bytes) 279 * will be the AML opcode 280 */ 281 MOVE_UNALIGNED16_TO_16 (&Opcode, Object); 282 283 /* Check for a recognized Opcode */ 284 285 switch ((UINT8) Opcode) 286 { 287 288 case AML_OP_PREFIX: 289 290 if (Opcode != AML_REVISION_OP) 291 { 292 /* 293 * OpPrefix is unrecognized unless part 294 * of RevisionOp 295 */ 296 break; 297 } 298 299 /* Otherwise, fall through and set the type to Integer */ 300 301 case AML_ZERO_OP: 302 case AML_ONES_OP: 303 case AML_ONE_OP: 304 case AML_BYTE_OP: 305 case AML_WORD_OP: 306 case AML_DWORD_OP: 307 case AML_QWORD_OP: 308 309 ObjType = ACPI_TYPE_INTEGER; 310 break; 311 312 313 case AML_STRING_OP: 314 315 ObjType = ACPI_TYPE_STRING; 316 break; 317 318 319 case AML_BUFFER_OP: 320 321 ObjType = ACPI_TYPE_BUFFER; 322 break; 323 324 325 case AML_MUTEX_OP: 326 327 ObjType = ACPI_TYPE_MUTEX; 328 break; 329 330 331 case AML_PACKAGE_OP: 332 333 ObjType = ACPI_TYPE_PACKAGE; 334 break; 335 336 337 default: 338 339 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, 340 "AML Opcode/Type [%x] not supported in attach\n", 341 (UINT8) Opcode)); 342 343 return_ACPI_STATUS (AE_TYPE); 344 break; 345 } 346 } 347 348 else 349 { 350 /* 351 * Cannot figure out the type -- set to DefAny which 352 * will print as an error in the name table dump 353 */ 354 if (AcpiDbgLevel > 0) 355 { 356 DUMP_PATHNAME (Node, 357 "NsAttachObject confused: setting bogus type for ", 358 ACPI_LV_INFO, _COMPONENT); 359 360 if (AcpiTbSystemTablePointer (Object)) 361 { 362 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, 363 "AML-stream code %02x\n", *(UINT8 *) Object)); 364 } 365 366 else if (VALID_DESCRIPTOR_TYPE (Object, ACPI_DESC_TYPE_NAMED)) 367 { 368 DUMP_PATHNAME (Object, "name ", ACPI_LV_INFO, _COMPONENT); 369 } 370 371 else 372 { 373 DUMP_PATHNAME (Object, "object ", ACPI_LV_INFO, _COMPONENT); 374 DUMP_STACK_ENTRY (Object); 375 } 376 } 377 378 ObjType = INTERNAL_TYPE_DEF_ANY; 379 } 380 } 381 382 383 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Installing %p into Node %p [%4.4s]\n", 384 ObjDesc, Node, &Node->Name)); 385 386 387 /* 388 * Must increment the new value's reference count 389 * (if it is an internal object) 390 */ 391 AcpiUtAddReference (ObjDesc); 392 393 /* Save the existing object (if any) for deletion later */ 394 395 PreviousObjDesc = Node->Object; 396 397 /* Install the object and set the type, flags */ 398 399 Node->Object = ObjDesc; 400 Node->Type = (UINT8) ObjType; 401 Node->Flags |= Flags; 402 403 404 /* 405 * Delete an existing attached object. 406 */ 407 if (PreviousObjDesc) 408 { 409 /* One for the attach to the Node */ 410 411 AcpiUtRemoveReference (PreviousObjDesc); 412 413 /* Now delete */ 414 415 AcpiUtRemoveReference (PreviousObjDesc); 416 } 417 418 return_ACPI_STATUS (AE_OK); 419} 420 421 422/******************************************************************************* 423 * 424 * FUNCTION: AcpiNsDetachObject 425 * 426 * PARAMETERS: Node - An object whose Value will be deleted 427 * 428 * RETURN: None. 429 * 430 * DESCRIPTION: Delete the Value associated with a namespace object. If the 431 * Value is an allocated object, it is freed. Otherwise, the 432 * field is simply cleared. 433 * 434 ******************************************************************************/ 435 436void 437AcpiNsDetachObject ( 438 ACPI_NAMESPACE_NODE *Node) 439{ 440 ACPI_OPERAND_OBJECT *ObjDesc; 441 442 443 FUNCTION_TRACE ("NsDetachObject"); 444 445 446 ObjDesc = Node->Object; 447 if (!ObjDesc) 448 { 449 return_VOID; 450 } 451 452 /* Clear the entry in all cases */ 453 454 Node->Object = NULL; 455 456 /* Found a valid value */ 457 458 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Object=%p Value=%p Name %4.4s\n", 459 Node, ObjDesc, &Node->Name)); 460 461 /* 462 * Not every value is an object allocated via ACPI_MEM_CALLOCATE, 463 * - must check 464 */ 465 if (!AcpiTbSystemTablePointer (ObjDesc)) 466 { 467 /* Attempt to delete the object (and all subobjects) */ 468 469 AcpiUtRemoveReference (ObjDesc); 470 } 471 472 return_VOID; 473} 474 475 476/******************************************************************************* 477 * 478 * FUNCTION: AcpiNsGetAttachedObject 479 * 480 * PARAMETERS: Node - Parent Node to be examined 481 * 482 * RETURN: Current value of the object field from the Node whose 483 * handle is passed 484 * 485 ******************************************************************************/ 486 487void * 488AcpiNsGetAttachedObject ( 489 ACPI_NAMESPACE_NODE *Node) 490{ 491 FUNCTION_TRACE_PTR ("NsGetAttachedObject", Node); 492 493 494 if (!Node) 495 { 496 /* handle invalid */ 497 498 ACPI_DEBUG_PRINT ((ACPI_DB_WARN, "Null Node ptr\n")); 499 return_PTR (NULL); 500 } 501 502 return_PTR (Node->Object); 503} 504 505 506