1 /******************************************************************************* 2 * 3 * Module Name: nsobject - Utilities for objects attached to namespace 4 * table entries 5 * 6 ******************************************************************************/ 7 8 /****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999 - 2016, Intel Corp. 13 * All rights reserved. 14 * 15 * 2. License 16 * 17 * 2.1. This is your license from Intel Corp. under its intellectual property 18 * rights. You may have additional license terms from the party that provided 19 * you this software, covering your right to use that party's intellectual 20 * property rights. 21 * 22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 23 * copy of the source code appearing in this file ("Covered Code") an 24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 25 * base code distributed originally by Intel ("Original Intel Code") to copy, 26 * make derivatives, distribute, use and display any portion of the Covered 27 * Code in any form, with the right to sublicense such rights; and 28 * 29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 30 * license (with the right to sublicense), under only those claims of Intel 31 * patents that are infringed by the Original Intel Code, to make, use, sell, 32 * offer to sell, and import the Covered Code and derivative works thereof 33 * solely to the minimum extent necessary to exercise the above copyright 34 * license, and in no event shall the patent license extend to any additions 35 * to or modifications of the Original Intel Code. No other license or right 36 * is granted directly or by implication, estoppel or otherwise; 37 * 38 * The above copyright and patent license is granted only if the following 39 * conditions are met: 40 * 41 * 3. Conditions 42 * 43 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 44 * Redistribution of source code of any substantial portion of the Covered 45 * Code or modification with rights to further distribute source must include 46 * the above Copyright Notice, the above License, this list of Conditions, 47 * and the following Disclaimer and Export Compliance provision. In addition, 48 * Licensee must cause all Covered Code to which Licensee contributes to 49 * contain a file documenting the changes Licensee made to create that Covered 50 * Code and the date of any change. Licensee must include in that file the 51 * documentation of any changes made by any predecessor Licensee. Licensee 52 * must include a prominent statement that the modification is derived, 53 * directly or indirectly, from Original Intel Code. 54 * 55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 56 * Redistribution of source code of any substantial portion of the Covered 57 * Code or modification without rights to further distribute source must 58 * include the following Disclaimer and Export Compliance provision in the 59 * documentation and/or other materials provided with distribution. In 60 * addition, Licensee may not authorize further sublicense of source of any 61 * portion of the Covered Code, and must include terms to the effect that the 62 * license from Licensee to its licensee is limited to the intellectual 63 * property embodied in the software Licensee provides to its licensee, and 64 * not to intellectual property embodied in modifications its licensee may 65 * make. 66 * 67 * 3.3. Redistribution of Executable. Redistribution in executable form of any 68 * substantial portion of the Covered Code or modification must reproduce the 69 * above Copyright Notice, and the following Disclaimer and Export Compliance 70 * provision in the documentation and/or other materials provided with the 71 * distribution. 72 * 73 * 3.4. Intel retains all right, title, and interest in and to the Original 74 * Intel Code. 75 * 76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 77 * Intel shall be used in advertising or otherwise to promote the sale, use or 78 * other dealings in products derived from or relating to the Covered Code 79 * without prior written authorization from Intel. 80 * 81 * 4. Disclaimer and Export Compliance 82 * 83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 89 * PARTICULAR PURPOSE. 90 * 91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 98 * LIMITED REMEDY. 99 * 100 * 4.3. Licensee shall not export, either directly or indirectly, any of this 101 * software or system incorporating such software without first obtaining any 102 * required license or other approval from the U. S. Department of Commerce or 103 * any other agency or department of the United States Government. In the 104 * event Licensee exports any such software from the United States or 105 * re-exports any such software from a foreign destination, Licensee shall 106 * ensure that the distribution and export/re-export of the software is in 107 * compliance with all laws, regulations, orders, or other restrictions of the 108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 109 * any of its subsidiaries will export/re-export any technical data, process, 110 * software, or service, directly or indirectly, to any country for which the 111 * United States government or any agency thereof requires an export license, 112 * other governmental approval, or letter of assurance, without first obtaining 113 * such license, approval or letter. 114 * 115 *****************************************************************************/ 116 117 #include "acpi.h" 118 #include "accommon.h" 119 #include "acnamesp.h" 120 121 122 #define _COMPONENT ACPI_NAMESPACE 123 ACPI_MODULE_NAME ("nsobject") 124 125 126 /******************************************************************************* 127 * 128 * FUNCTION: AcpiNsAttachObject 129 * 130 * PARAMETERS: Node - Parent Node 131 * Object - Object to be attached 132 * Type - Type of object, or ACPI_TYPE_ANY if not 133 * known 134 * 135 * RETURN: Status 136 * 137 * DESCRIPTION: Record the given object as the value associated with the 138 * name whose ACPI_HANDLE is passed. If Object is NULL 139 * and Type is ACPI_TYPE_ANY, set the name as having no value. 140 * Note: Future may require that the Node->Flags field be passed 141 * as a parameter. 142 * 143 * MUTEX: Assumes namespace is locked 144 * 145 ******************************************************************************/ 146 147 ACPI_STATUS 148 AcpiNsAttachObject ( 149 ACPI_NAMESPACE_NODE *Node, 150 ACPI_OPERAND_OBJECT *Object, 151 ACPI_OBJECT_TYPE Type) 152 { 153 ACPI_OPERAND_OBJECT *ObjDesc; 154 ACPI_OPERAND_OBJECT *LastObjDesc; 155 ACPI_OBJECT_TYPE ObjectType = ACPI_TYPE_ANY; 156 157 158 ACPI_FUNCTION_TRACE (NsAttachObject); 159 160 161 /* 162 * Parameter validation 163 */ 164 if (!Node) 165 { 166 /* Invalid handle */ 167 168 ACPI_ERROR ((AE_INFO, "Null NamedObj handle")); 169 return_ACPI_STATUS (AE_BAD_PARAMETER); 170 } 171 172 if (!Object && (ACPI_TYPE_ANY != Type)) 173 { 174 /* Null object */ 175 176 ACPI_ERROR ((AE_INFO, 177 "Null object, but type not ACPI_TYPE_ANY")); 178 return_ACPI_STATUS (AE_BAD_PARAMETER); 179 } 180 181 if (ACPI_GET_DESCRIPTOR_TYPE (Node) != ACPI_DESC_TYPE_NAMED) 182 { 183 /* Not a name handle */ 184 185 ACPI_ERROR ((AE_INFO, "Invalid handle %p [%s]", 186 Node, AcpiUtGetDescriptorName (Node))); 187 return_ACPI_STATUS (AE_BAD_PARAMETER); 188 } 189 190 /* Check if this object is already attached */ 191 192 if (Node->Object == Object) 193 { 194 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, 195 "Obj %p already installed in NameObj %p\n", 196 Object, Node)); 197 198 return_ACPI_STATUS (AE_OK); 199 } 200 201 /* If null object, we will just install it */ 202 203 if (!Object) 204 { 205 ObjDesc = NULL; 206 ObjectType = ACPI_TYPE_ANY; 207 } 208 209 /* 210 * If the source object is a namespace Node with an attached object, 211 * we will use that (attached) object 212 */ 213 else if ((ACPI_GET_DESCRIPTOR_TYPE (Object) == ACPI_DESC_TYPE_NAMED) && 214 ((ACPI_NAMESPACE_NODE *) Object)->Object) 215 { 216 /* 217 * Value passed is a name handle and that name has a 218 * non-null value. Use that name's value and type. 219 */ 220 ObjDesc = ((ACPI_NAMESPACE_NODE *) Object)->Object; 221 ObjectType = ((ACPI_NAMESPACE_NODE *) Object)->Type; 222 } 223 224 /* 225 * Otherwise, we will use the parameter object, but we must type 226 * it first 227 */ 228 else 229 { 230 ObjDesc = (ACPI_OPERAND_OBJECT *) Object; 231 232 /* Use the given type */ 233 234 ObjectType = Type; 235 } 236 237 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Installing %p into Node %p [%4.4s]\n", 238 ObjDesc, Node, AcpiUtGetNodeName (Node))); 239 240 /* Detach an existing attached object if present */ 241 242 if (Node->Object) 243 { 244 AcpiNsDetachObject (Node); 245 } 246 247 if (ObjDesc) 248 { 249 /* 250 * Must increment the new value's reference count 251 * (if it is an internal object) 252 */ 253 AcpiUtAddReference (ObjDesc); 254 255 /* 256 * Handle objects with multiple descriptors - walk 257 * to the end of the descriptor list 258 */ 259 LastObjDesc = ObjDesc; 260 while (LastObjDesc->Common.NextObject) 261 { 262 LastObjDesc = LastObjDesc->Common.NextObject; 263 } 264 265 /* Install the object at the front of the object list */ 266 267 LastObjDesc->Common.NextObject = Node->Object; 268 } 269 270 Node->Type = (UINT8) ObjectType; 271 Node->Object = ObjDesc; 272 273 return_ACPI_STATUS (AE_OK); 274 } 275 276 277 /******************************************************************************* 278 * 279 * FUNCTION: AcpiNsDetachObject 280 * 281 * PARAMETERS: Node - A Namespace node whose object will be detached 282 * 283 * RETURN: None. 284 * 285 * DESCRIPTION: Detach/delete an object associated with a namespace node. 286 * if the object is an allocated object, it is freed. 287 * Otherwise, the field is simply cleared. 288 * 289 ******************************************************************************/ 290 291 void 292 AcpiNsDetachObject ( 293 ACPI_NAMESPACE_NODE *Node) 294 { 295 ACPI_OPERAND_OBJECT *ObjDesc; 296 297 298 ACPI_FUNCTION_TRACE (NsDetachObject); 299 300 301 ObjDesc = Node->Object; 302 303 if (!ObjDesc || 304 (ObjDesc->Common.Type == ACPI_TYPE_LOCAL_DATA)) 305 { 306 return_VOID; 307 } 308 309 if (Node->Flags & ANOBJ_ALLOCATED_BUFFER) 310 { 311 /* Free the dynamic aml buffer */ 312 313 if (ObjDesc->Common.Type == ACPI_TYPE_METHOD) 314 { 315 ACPI_FREE (ObjDesc->Method.AmlStart); 316 } 317 } 318 319 /* Clear the Node entry in all cases */ 320 321 Node->Object = NULL; 322 if (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc) == ACPI_DESC_TYPE_OPERAND) 323 { 324 /* Unlink object from front of possible object list */ 325 326 Node->Object = ObjDesc->Common.NextObject; 327 328 /* Handle possible 2-descriptor object */ 329 330 if (Node->Object && 331 (Node->Object->Common.Type != ACPI_TYPE_LOCAL_DATA)) 332 { 333 Node->Object = Node->Object->Common.NextObject; 334 } 335 336 /* 337 * Detach the object from any data objects (which are still held by 338 * the namespace node) 339 */ 340 if (ObjDesc->Common.NextObject && 341 ((ObjDesc->Common.NextObject)->Common.Type == ACPI_TYPE_LOCAL_DATA)) 342 { 343 ObjDesc->Common.NextObject = NULL; 344 } 345 } 346 347 /* Reset the node type to untyped */ 348 349 Node->Type = ACPI_TYPE_ANY; 350 351 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "Node %p [%4.4s] Object %p\n", 352 Node, AcpiUtGetNodeName (Node), ObjDesc)); 353 354 /* Remove one reference on the object (and all subobjects) */ 355 356 AcpiUtRemoveReference (ObjDesc); 357 return_VOID; 358 } 359 360 361 /******************************************************************************* 362 * 363 * FUNCTION: AcpiNsGetAttachedObject 364 * 365 * PARAMETERS: Node - Namespace node 366 * 367 * RETURN: Current value of the object field from the Node whose 368 * handle is passed 369 * 370 * DESCRIPTION: Obtain the object attached to a namespace node. 371 * 372 ******************************************************************************/ 373 374 ACPI_OPERAND_OBJECT * 375 AcpiNsGetAttachedObject ( 376 ACPI_NAMESPACE_NODE *Node) 377 { 378 ACPI_FUNCTION_TRACE_PTR (NsGetAttachedObject, Node); 379 380 381 if (!Node) 382 { 383 ACPI_WARNING ((AE_INFO, "Null Node ptr")); 384 return_PTR (NULL); 385 } 386 387 if (!Node->Object || 388 ((ACPI_GET_DESCRIPTOR_TYPE (Node->Object) != ACPI_DESC_TYPE_OPERAND) && 389 (ACPI_GET_DESCRIPTOR_TYPE (Node->Object) != ACPI_DESC_TYPE_NAMED)) || 390 ((Node->Object)->Common.Type == ACPI_TYPE_LOCAL_DATA)) 391 { 392 return_PTR (NULL); 393 } 394 395 return_PTR (Node->Object); 396 } 397 398 399 /******************************************************************************* 400 * 401 * FUNCTION: AcpiNsGetSecondaryObject 402 * 403 * PARAMETERS: Node - Namespace node 404 * 405 * RETURN: Current value of the object field from the Node whose 406 * handle is passed. 407 * 408 * DESCRIPTION: Obtain a secondary object associated with a namespace node. 409 * 410 ******************************************************************************/ 411 412 ACPI_OPERAND_OBJECT * 413 AcpiNsGetSecondaryObject ( 414 ACPI_OPERAND_OBJECT *ObjDesc) 415 { 416 ACPI_FUNCTION_TRACE_PTR (NsGetSecondaryObject, ObjDesc); 417 418 419 if ((!ObjDesc) || 420 (ObjDesc->Common.Type== ACPI_TYPE_LOCAL_DATA) || 421 (!ObjDesc->Common.NextObject) || 422 ((ObjDesc->Common.NextObject)->Common.Type == ACPI_TYPE_LOCAL_DATA)) 423 { 424 return_PTR (NULL); 425 } 426 427 return_PTR (ObjDesc->Common.NextObject); 428 } 429 430 431 /******************************************************************************* 432 * 433 * FUNCTION: AcpiNsAttachData 434 * 435 * PARAMETERS: Node - Namespace node 436 * Handler - Handler to be associated with the data 437 * Data - Data to be attached 438 * 439 * RETURN: Status 440 * 441 * DESCRIPTION: Low-level attach data. Create and attach a Data object. 442 * 443 ******************************************************************************/ 444 445 ACPI_STATUS 446 AcpiNsAttachData ( 447 ACPI_NAMESPACE_NODE *Node, 448 ACPI_OBJECT_HANDLER Handler, 449 void *Data) 450 { 451 ACPI_OPERAND_OBJECT *PrevObjDesc; 452 ACPI_OPERAND_OBJECT *ObjDesc; 453 ACPI_OPERAND_OBJECT *DataDesc; 454 455 456 /* We only allow one attachment per handler */ 457 458 PrevObjDesc = NULL; 459 ObjDesc = Node->Object; 460 while (ObjDesc) 461 { 462 if ((ObjDesc->Common.Type == ACPI_TYPE_LOCAL_DATA) && 463 (ObjDesc->Data.Handler == Handler)) 464 { 465 return (AE_ALREADY_EXISTS); 466 } 467 468 PrevObjDesc = ObjDesc; 469 ObjDesc = ObjDesc->Common.NextObject; 470 } 471 472 /* Create an internal object for the data */ 473 474 DataDesc = AcpiUtCreateInternalObject (ACPI_TYPE_LOCAL_DATA); 475 if (!DataDesc) 476 { 477 return (AE_NO_MEMORY); 478 } 479 480 DataDesc->Data.Handler = Handler; 481 DataDesc->Data.Pointer = Data; 482 483 /* Install the data object */ 484 485 if (PrevObjDesc) 486 { 487 PrevObjDesc->Common.NextObject = DataDesc; 488 } 489 else 490 { 491 Node->Object = DataDesc; 492 } 493 494 return (AE_OK); 495 } 496 497 498 /******************************************************************************* 499 * 500 * FUNCTION: AcpiNsDetachData 501 * 502 * PARAMETERS: Node - Namespace node 503 * Handler - Handler associated with the data 504 * 505 * RETURN: Status 506 * 507 * DESCRIPTION: Low-level detach data. Delete the data node, but the caller 508 * is responsible for the actual data. 509 * 510 ******************************************************************************/ 511 512 ACPI_STATUS 513 AcpiNsDetachData ( 514 ACPI_NAMESPACE_NODE *Node, 515 ACPI_OBJECT_HANDLER Handler) 516 { 517 ACPI_OPERAND_OBJECT *ObjDesc; 518 ACPI_OPERAND_OBJECT *PrevObjDesc; 519 520 521 PrevObjDesc = NULL; 522 ObjDesc = Node->Object; 523 while (ObjDesc) 524 { 525 if ((ObjDesc->Common.Type == ACPI_TYPE_LOCAL_DATA) && 526 (ObjDesc->Data.Handler == Handler)) 527 { 528 if (PrevObjDesc) 529 { 530 PrevObjDesc->Common.NextObject = ObjDesc->Common.NextObject; 531 } 532 else 533 { 534 Node->Object = ObjDesc->Common.NextObject; 535 } 536 537 AcpiUtRemoveReference (ObjDesc); 538 return (AE_OK); 539 } 540 541 PrevObjDesc = ObjDesc; 542 ObjDesc = ObjDesc->Common.NextObject; 543 } 544 545 return (AE_NOT_FOUND); 546 } 547 548 549 /******************************************************************************* 550 * 551 * FUNCTION: AcpiNsGetAttachedData 552 * 553 * PARAMETERS: Node - Namespace node 554 * Handler - Handler associated with the data 555 * Data - Where the data is returned 556 * 557 * RETURN: Status 558 * 559 * DESCRIPTION: Low level interface to obtain data previously associated with 560 * a namespace node. 561 * 562 ******************************************************************************/ 563 564 ACPI_STATUS 565 AcpiNsGetAttachedData ( 566 ACPI_NAMESPACE_NODE *Node, 567 ACPI_OBJECT_HANDLER Handler, 568 void **Data) 569 { 570 ACPI_OPERAND_OBJECT *ObjDesc; 571 572 573 ObjDesc = Node->Object; 574 while (ObjDesc) 575 { 576 if ((ObjDesc->Common.Type == ACPI_TYPE_LOCAL_DATA) && 577 (ObjDesc->Data.Handler == Handler)) 578 { 579 *Data = ObjDesc->Data.Pointer; 580 return (AE_OK); 581 } 582 583 ObjDesc = ObjDesc->Common.NextObject; 584 } 585 586 return (AE_NOT_FOUND); 587 } 588