sys/contrib/dev/acpica/exconfig.c

   1 /******************************************************************************
   2  *
   3  * Module Name: exconfig - Namespace reconfiguration (Load/Unload opcodes)
   4  *              $Revision: 69 $
   5  *
   6  *****************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2002, 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
  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 #define __EXCONFIG_C__
 119
 120 #include "acpi.h"
 121 #include "acinterp.h"
 122 #include "amlcode.h"
 123 #include "acnamesp.h"
 124 #include "acevents.h"
 125 #include "actables.h"
 126
 127
 128 #define _COMPONENT          ACPI_EXECUTER
 129         ACPI_MODULE_NAME    ("exconfig")
 130
 131
 132 /*******************************************************************************
 133  *
 134  * FUNCTION:    AcpiExAddTable
 135  *
 136  * PARAMETERS:  Table               - Pointer to raw table
 137  *              ParentNode          - Where to load the table (scope)
 138  *              DdbHandle           - Where to return the table handle.
 139  *
 140  * RETURN:      Status
 141  *
 142  * DESCRIPTION: Common function to Install and Load an ACPI table with a
 143  *              returned table handle.
 144  *
 145  ******************************************************************************/
 146
 147 ACPI_STATUS
 148 AcpiExAddTable (
 149     ACPI_TABLE_HEADER       *Table,
 150     ACPI_NAMESPACE_NODE     *ParentNode,
 151     ACPI_OPERAND_OBJECT     **DdbHandle)
 152 {
 153     ACPI_STATUS             Status;
 154     ACPI_TABLE_DESC         TableInfo;
 155     ACPI_OPERAND_OBJECT     *ObjDesc;
 156
 157
 158     ACPI_FUNCTION_TRACE ("ExAddTable");
 159
 160
 161     /* Create an object to be the table handle */
 162
 163     ObjDesc = AcpiUtCreateInternalObject (ACPI_TYPE_LOCAL_REFERENCE);
 164     if (!ObjDesc)
 165     {
 166         return_ACPI_STATUS (AE_NO_MEMORY);
 167     }
 168
 169     /* Install the new table into the local data structures */
 170
 171     TableInfo.Pointer      = Table;
 172     TableInfo.Length       = (ACPI_SIZE) Table->Length;
 173     TableInfo.Allocation   = ACPI_MEM_ALLOCATED;
 174
 175     Status = AcpiTbInstallTable (&TableInfo);
 176     if (ACPI_FAILURE (Status))
 177     {
 178         goto Cleanup;
 179     }
 180
 181     /* Add the table to the namespace */
 182
 183     Status = AcpiNsLoadTable (TableInfo.InstalledDesc, ParentNode);
 184     if (ACPI_FAILURE (Status))
 185     {
 186         /* Uninstall table on error */
 187
 188         (void) AcpiTbUninstallTable (TableInfo.InstalledDesc);
 189         goto Cleanup;
 190     }
 191
 192     /* Init the table handle */
 193
 194     ObjDesc->Reference.Opcode = AML_LOAD_OP;
 195     ObjDesc->Reference.Object = TableInfo.InstalledDesc;
 196     *DdbHandle = ObjDesc;
 197     return_ACPI_STATUS (AE_OK);
 198
 199
 200 Cleanup:
 201     AcpiUtRemoveReference (ObjDesc);
 202     return_ACPI_STATUS (Status);
 203 }
 204
 205
 206 /*******************************************************************************
 207  *
 208  * FUNCTION:    AcpiExLoadTableOp
 209  *
 210  * PARAMETERS:  WalkState           - Current state with operands
 211  *              ReturnDesc          - Where to store the return object
 212  *
 213  * RETURN:      Status
 214  *
 215  * DESCRIPTION: Load an ACPI table
 216  *
 217  ******************************************************************************/
 218
 219 ACPI_STATUS
 220 AcpiExLoadTableOp (
 221     ACPI_WALK_STATE         *WalkState,
 222     ACPI_OPERAND_OBJECT     **ReturnDesc)
 223 {
 224     ACPI_STATUS             Status;
 225     ACPI_OPERAND_OBJECT     **Operand = &WalkState->Operands[0];
 226     ACPI_TABLE_HEADER       *Table;
 227     ACPI_NAMESPACE_NODE     *ParentNode;
 228     ACPI_NAMESPACE_NODE     *StartNode;
 229     ACPI_NAMESPACE_NODE     *ParameterNode = NULL;
 230     ACPI_OPERAND_OBJECT     *DdbHandle;
 231
 232
 233     ACPI_FUNCTION_TRACE ("ExLoadTableOp");
 234
 235
 236 #if 0
 237     /*
 238      * Make sure that the signature does not match one of the tables that
 239      * is already loaded.
 240      */
 241     Status = AcpiTbMatchSignature (Operand[0]->String.Pointer, NULL);
 242     if (Status == AE_OK)
 243     {
 244         /* Signature matched -- don't allow override */
 245
 246         return_ACPI_STATUS (AE_ALREADY_EXISTS);
 247     }
 248 #endif
 249
 250     /* Find the ACPI table */
 251
 252     Status = AcpiTbFindTable (Operand[0]->String.Pointer,
 253                               Operand[1]->String.Pointer,
 254                               Operand[2]->String.Pointer, &Table);
 255     if (ACPI_FAILURE (Status))
 256     {
 257         if (Status != AE_NOT_FOUND)
 258         {
 259             return_ACPI_STATUS (Status);
 260         }
 261
 262         /* Not found, return an Integer=0 and AE_OK */
 263
 264         DdbHandle = AcpiUtCreateInternalObject (ACPI_TYPE_INTEGER);
 265         if (!DdbHandle)
 266         {
 267             return_ACPI_STATUS (AE_NO_MEMORY);
 268         }
 269
 270         DdbHandle->Integer.Value = 0;
 271         *ReturnDesc = DdbHandle;
 272
 273         return_ACPI_STATUS (AE_OK);
 274     }
 275
 276     /* Default nodes */
 277
 278     StartNode = WalkState->ScopeInfo->Scope.Node;
 279     ParentNode = AcpiGbl_RootNode;
 280
 281     /* RootPath (optional parameter) */
 282
 283     if (Operand[3]->String.Length > 0)
 284     {
 285         /*
 286          * Find the node referenced by the RootPathString.  This is the
 287          * location within the namespace where the table will be loaded.
 288          */
 289         Status = AcpiNsGetNodeByPath (Operand[3]->String.Pointer, StartNode,
 290                                         ACPI_NS_SEARCH_PARENT, &ParentNode);
 291         if (ACPI_FAILURE (Status))
 292         {
 293             return_ACPI_STATUS (Status);
 294         }
 295     }
 296
 297     /* ParameterPath (optional parameter) */
 298
 299     if (Operand[4]->String.Length > 0)
 300     {
 301         if ((Operand[4]->String.Pointer[0] != '\\') &&
 302             (Operand[4]->String.Pointer[0] != '^'))
 303         {
 304             /*
 305              * Path is not absolute, so it will be relative to the node
 306              * referenced by the RootPathString (or the NS root if omitted)
 307              */
 308             StartNode = ParentNode;
 309         }
 310
 311         /*
 312          * Find the node referenced by the ParameterPathString
 313          */
 314         Status = AcpiNsGetNodeByPath (Operand[4]->String.Pointer, StartNode,
 315                                         ACPI_NS_SEARCH_PARENT, &ParameterNode);
 316         if (ACPI_FAILURE (Status))
 317         {
 318             return_ACPI_STATUS (Status);
 319         }
 320     }
 321
 322     /* Load the table into the namespace */
 323
 324     Status = AcpiExAddTable (Table, ParentNode, &DdbHandle);
 325     if (ACPI_FAILURE (Status))
 326     {
 327         return_ACPI_STATUS (Status);
 328     }
 329
 330     /* Parameter Data (optional) */
 331
 332     if (ParameterNode)
 333     {
 334         /* Store the parameter data into the optional parameter object */
 335
 336         Status = AcpiExStore (Operand[5], ACPI_CAST_PTR (ACPI_OPERAND_OBJECT, ParameterNode),
 337                                 WalkState);
 338         if (ACPI_FAILURE (Status))
 339         {
 340             (void) AcpiExUnloadTable (DdbHandle);
 341         }
 342     }
 343
 344     return_ACPI_STATUS  (Status);
 345 }
 346
 347
 348 /*******************************************************************************
 349  *
 350  * FUNCTION:    AcpiExLoadOp
 351  *
 352  * PARAMETERS:  ObjDesc         - Region or Field where the table will be
 353  *                                obtained
 354  *              Target          - Where a handle to the table will be stored
 355  *              WalkState       - Current state
 356  *
 357  * RETURN:      Status
 358  *
 359  * DESCRIPTION: Load an ACPI table from a field or operation region
 360  *
 361  ******************************************************************************/
 362
 363 ACPI_STATUS
 364 AcpiExLoadOp (
 365     ACPI_OPERAND_OBJECT     *ObjDesc,
 366     ACPI_OPERAND_OBJECT     *Target,
 367     ACPI_WALK_STATE         *WalkState)
 368 {
 369     ACPI_STATUS             Status;
 370     ACPI_OPERAND_OBJECT     *DdbHandle;
 371     ACPI_OPERAND_OBJECT     *BufferDesc = NULL;
 372     ACPI_TABLE_HEADER       *TablePtr = NULL;
 373     UINT8                   *TableDataPtr;
 374     ACPI_TABLE_HEADER       TableHeader;
 375     UINT32                  i;
 376
 377     ACPI_FUNCTION_TRACE ("ExLoadOp");
 378
 379
 380     /* Object can be either an OpRegion or a Field */
 381
 382     switch (ACPI_GET_OBJECT_TYPE (ObjDesc))
 383     {
 384     case ACPI_TYPE_REGION:
 385
 386         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Load from Region %p %s\n",
 387             ObjDesc, AcpiUtGetObjectTypeName (ObjDesc)));
 388
 389         /* Get the table header */
 390
 391         TableHeader.Length = 0;
 392         for (i = 0; i < sizeof (ACPI_TABLE_HEADER); i++)
 393         {
 394             Status = AcpiEvAddressSpaceDispatch (ObjDesc, ACPI_READ,
 395                                 (ACPI_PHYSICAL_ADDRESS) i, 8,
 396                                 ((UINT8 *) &TableHeader) + i);
 397             if (ACPI_FAILURE (Status))
 398             {
 399                 return_ACPI_STATUS (Status);
 400             }
 401         }
 402
 403         /* Allocate a buffer for the entire table */
 404
 405         TablePtr = ACPI_MEM_ALLOCATE (TableHeader.Length);
 406         if (!TablePtr)
 407         {
 408             return_ACPI_STATUS (AE_NO_MEMORY);
 409         }
 410
 411         /* Copy the header to the buffer */
 412
 413         ACPI_MEMCPY (TablePtr, &TableHeader, sizeof (ACPI_TABLE_HEADER));
 414         TableDataPtr = ACPI_PTR_ADD (UINT8, TablePtr, sizeof (ACPI_TABLE_HEADER));
 415
 416         /* Get the table from the op region */
 417
 418         for (i = 0; i < TableHeader.Length; i++)
 419         {
 420             Status = AcpiEvAddressSpaceDispatch (ObjDesc, ACPI_READ,
 421                                 (ACPI_PHYSICAL_ADDRESS) i, 8,
 422                                 ((UINT8 *) TableDataPtr + i));
 423             if (ACPI_FAILURE (Status))
 424             {
 425                 goto Cleanup;
 426             }
 427         }
 428         break;
 429
 430
 431     case ACPI_TYPE_BUFFER_FIELD:
 432     case ACPI_TYPE_LOCAL_REGION_FIELD:
 433     case ACPI_TYPE_LOCAL_BANK_FIELD:
 434     case ACPI_TYPE_LOCAL_INDEX_FIELD:
 435
 436         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Load from Field %p %s\n",
 437             ObjDesc, AcpiUtGetObjectTypeName (ObjDesc)));
 438
 439         /*
 440          * The length of the field must be at least as large as the table.
 441          * Read the entire field and thus the entire table.  Buffer is
 442          * allocated during the read.
 443          */
 444         Status = AcpiExReadDataFromField (WalkState, ObjDesc, &BufferDesc);
 445         if (ACPI_FAILURE (Status))
 446         {
 447             goto Cleanup;
 448         }
 449
 450         TablePtr = ACPI_CAST_PTR (ACPI_TABLE_HEADER, BufferDesc->Buffer.Pointer);
 451         break;
 452
 453
 454     default:
 455         return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
 456     }
 457
 458     /* The table must be either an SSDT or a PSDT */
 459
 460     if ((!ACPI_STRNCMP (TablePtr->Signature,
 461                     AcpiGbl_AcpiTableData[ACPI_TABLE_PSDT].Signature,
 462                     AcpiGbl_AcpiTableData[ACPI_TABLE_PSDT].SigLength)) &&
 463         (!ACPI_STRNCMP (TablePtr->Signature,
 464                     AcpiGbl_AcpiTableData[ACPI_TABLE_SSDT].Signature,
 465                     AcpiGbl_AcpiTableData[ACPI_TABLE_SSDT].SigLength)))
 466     {
 467         ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
 468             "Table has invalid signature [%4.4s], must be SSDT or PSDT\n",
 469             TablePtr->Signature));
 470         Status = AE_BAD_SIGNATURE;
 471         goto Cleanup;
 472     }
 473
 474     /* Install the new table into the local data structures */
 475
 476     Status = AcpiExAddTable (TablePtr, AcpiGbl_RootNode, &DdbHandle);
 477     if (ACPI_FAILURE (Status))
 478     {
 479         goto Cleanup;
 480     }
 481
 482     /* Store the DdbHandle into the Target operand */
 483
 484     Status = AcpiExStore (DdbHandle, Target, WalkState);
 485     if (ACPI_FAILURE (Status))
 486     {
 487         (void) AcpiExUnloadTable (DdbHandle);
 488     }
 489
 490     return_ACPI_STATUS (Status);
 491
 492
 493 Cleanup:
 494
 495     if (BufferDesc)
 496     {
 497         AcpiUtRemoveReference (BufferDesc);
 498     }
 499     else
 500     {
 501         ACPI_MEM_FREE (TablePtr);
 502     }
 503     return_ACPI_STATUS (Status);
 504 }
 505
 506
 507 /*******************************************************************************
 508  *
 509  * FUNCTION:    AcpiExUnloadTable
 510  *
 511  * PARAMETERS:  DdbHandle           - Handle to a previously loaded table
 512  *
 513  * RETURN:      Status
 514  *
 515  * DESCRIPTION: Unload an ACPI table
 516  *
 517  ******************************************************************************/
 518
 519 ACPI_STATUS
 520 AcpiExUnloadTable (
 521     ACPI_OPERAND_OBJECT     *DdbHandle)
 522 {
 523     ACPI_STATUS             Status = AE_NOT_IMPLEMENTED;
 524     ACPI_OPERAND_OBJECT     *TableDesc = DdbHandle;
 525     ACPI_TABLE_DESC         *TableInfo;
 526
 527
 528     ACPI_FUNCTION_TRACE ("ExUnloadTable");
 529
 530
 531     /*
 532      * Validate the handle
 533      * Although the handle is partially validated in AcpiExReconfiguration(),
 534      * when it calls AcpiExResolveOperands(), the handle is more completely
 535      * validated here.
 536      */
 537     if ((!DdbHandle) ||
 538         (ACPI_GET_DESCRIPTOR_TYPE (DdbHandle) != ACPI_DESC_TYPE_OPERAND) ||
 539         (ACPI_GET_OBJECT_TYPE (DdbHandle) != ACPI_TYPE_LOCAL_REFERENCE))
 540     {
 541         return_ACPI_STATUS (AE_BAD_PARAMETER);
 542     }
 543
 544     /* Get the actual table descriptor from the DdbHandle */
 545
 546     TableInfo = (ACPI_TABLE_DESC *) TableDesc->Reference.Object;
 547
 548     /*
 549      * Delete the entire namespace under this table Node
 550      * (Offset contains the TableId)
 551      */
 552     AcpiNsDeleteNamespaceByOwner (TableInfo->TableId);
 553
 554     /* Delete the table itself */
 555
 556     (void) AcpiTbUninstallTable (TableInfo->InstalledDesc);
 557
 558     /* Delete the table descriptor (DdbHandle) */
 559
 560     AcpiUtRemoveReference (TableDesc);
 561     return_ACPI_STATUS (Status);
 562 }
 563