sys/contrib/dev/acpica/exconfig.c

   1 /******************************************************************************
   2  *
   3  * Module Name: exconfig - Namespace reconfiguration (Load/Unload opcodes)
   4  *              $Revision: 71 $
   5  *
   6  *****************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2003, 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 /* $DragonFly: src/sys/contrib/dev/acpica/Attic/exconfig.c,v 1.1 2003/09/24 03:32:15 drhodus Exp $                                                               */
 118
 119 #define __EXCONFIG_C__
 120
 121 #include "acpi.h"
 122 #include "acinterp.h"
 123 #include "amlcode.h"
 124 #include "acnamesp.h"
 125 #include "acevents.h"
 126 #include "actables.h"
 127
 128
 129 #define _COMPONENT          ACPI_EXECUTER
 130         ACPI_MODULE_NAME    ("exconfig")
 131
 132
 133 /*******************************************************************************
 134  *
 135  * FUNCTION:    AcpiExAddTable
 136  *
 137  * PARAMETERS:  Table               - Pointer to raw table
 138  *              ParentNode          - Where to load the table (scope)
 139  *              DdbHandle           - Where to return the table handle.
 140  *
 141  * RETURN:      Status
 142  *
 143  * DESCRIPTION: Common function to Install and Load an ACPI table with a
 144  *              returned table handle.
 145  *
 146  ******************************************************************************/
 147
 148 ACPI_STATUS
 149 AcpiExAddTable (
 150     ACPI_TABLE_HEADER       *Table,
 151     ACPI_NAMESPACE_NODE     *ParentNode,
 152     ACPI_OPERAND_OBJECT     **DdbHandle)
 153 {
 154     ACPI_STATUS             Status;
 155     ACPI_TABLE_DESC         TableInfo;
 156     ACPI_OPERAND_OBJECT     *ObjDesc;
 157
 158
 159     ACPI_FUNCTION_TRACE ("ExAddTable");
 160
 161
 162     /* Create an object to be the table handle */
 163
 164     ObjDesc = AcpiUtCreateInternalObject (ACPI_TYPE_LOCAL_REFERENCE);
 165     if (!ObjDesc)
 166     {
 167         return_ACPI_STATUS (AE_NO_MEMORY);
 168     }
 169
 170     /* Install the new table into the local data structures */
 171
 172     TableInfo.Pointer      = Table;
 173     TableInfo.Length       = (ACPI_SIZE) Table->Length;
 174     TableInfo.Allocation   = ACPI_MEM_ALLOCATED;
 175
 176     Status = AcpiTbInstallTable (&TableInfo);
 177     if (ACPI_FAILURE (Status))
 178     {
 179         goto Cleanup;
 180     }
 181
 182     /* Add the table to the namespace */
 183
 184     Status = AcpiNsLoadTable (TableInfo.InstalledDesc, ParentNode);
 185     if (ACPI_FAILURE (Status))
 186     {
 187         /* Uninstall table on error */
 188
 189         (void) AcpiTbUninstallTable (TableInfo.InstalledDesc);
 190         goto Cleanup;
 191     }
 192
 193     /* Init the table handle */
 194
 195     ObjDesc->Reference.Opcode = AML_LOAD_OP;
 196     ObjDesc->Reference.Object = TableInfo.InstalledDesc;
 197     *DdbHandle = ObjDesc;
 198     return_ACPI_STATUS (AE_OK);
 199
 200
 201 Cleanup:
 202     AcpiUtRemoveReference (ObjDesc);
 203     return_ACPI_STATUS (Status);
 204 }
 205
 206
 207 /*******************************************************************************
 208  *
 209  * FUNCTION:    AcpiExLoadTableOp
 210  *
 211  * PARAMETERS:  WalkState           - Current state with operands
 212  *              ReturnDesc          - Where to store the return object
 213  *
 214  * RETURN:      Status
 215  *
 216  * DESCRIPTION: Load an ACPI table
 217  *
 218  ******************************************************************************/
 219
 220 ACPI_STATUS
 221 AcpiExLoadTableOp (
 222     ACPI_WALK_STATE         *WalkState,
 223     ACPI_OPERAND_OBJECT     **ReturnDesc)
 224 {
 225     ACPI_STATUS             Status;
 226     ACPI_OPERAND_OBJECT     **Operand = &WalkState->Operands[0];
 227     ACPI_TABLE_HEADER       *Table;
 228     ACPI_NAMESPACE_NODE     *ParentNode;
 229     ACPI_NAMESPACE_NODE     *StartNode;
 230     ACPI_NAMESPACE_NODE     *ParameterNode = NULL;
 231     ACPI_OPERAND_OBJECT     *DdbHandle;
 232
 233
 234     ACPI_FUNCTION_TRACE ("ExLoadTableOp");
 235
 236
 237 #if 0
 238     /*
 239      * Make sure that the signature does not match one of the tables that
 240      * is already loaded.
 241      */
 242     Status = AcpiTbMatchSignature (Operand[0]->String.Pointer, NULL);
 243     if (Status == AE_OK)
 244     {
 245         /* Signature matched -- don't allow override */
 246
 247         return_ACPI_STATUS (AE_ALREADY_EXISTS);
 248     }
 249 #endif
 250
 251     /* Find the ACPI table */
 252
 253     Status = AcpiTbFindTable (Operand[0]->String.Pointer,
 254                               Operand[1]->String.Pointer,
 255                               Operand[2]->String.Pointer, &Table);
 256     if (ACPI_FAILURE (Status))
 257     {
 258         if (Status != AE_NOT_FOUND)
 259         {
 260             return_ACPI_STATUS (Status);
 261         }
 262
 263         /* Not found, return an Integer=0 and AE_OK */
 264
 265         DdbHandle = AcpiUtCreateInternalObject (ACPI_TYPE_INTEGER);
 266         if (!DdbHandle)
 267         {
 268             return_ACPI_STATUS (AE_NO_MEMORY);
 269         }
 270
 271         DdbHandle->Integer.Value = 0;
 272         *ReturnDesc = DdbHandle;
 273
 274         return_ACPI_STATUS (AE_OK);
 275     }
 276
 277     /* Default nodes */
 278
 279     StartNode = WalkState->ScopeInfo->Scope.Node;
 280     ParentNode = AcpiGbl_RootNode;
 281
 282     /* RootPath (optional parameter) */
 283
 284     if (Operand[3]->String.Length > 0)
 285     {
 286         /*
 287          * Find the node referenced by the RootPathString.  This is the
 288          * location within the namespace where the table will be loaded.
 289          */
 290         Status = AcpiNsGetNodeByPath (Operand[3]->String.Pointer, StartNode,
 291                                         ACPI_NS_SEARCH_PARENT, &ParentNode);
 292         if (ACPI_FAILURE (Status))
 293         {
 294             return_ACPI_STATUS (Status);
 295         }
 296     }
 297
 298     /* ParameterPath (optional parameter) */
 299
 300     if (Operand[4]->String.Length > 0)
 301     {
 302         if ((Operand[4]->String.Pointer[0] != '\\') &&
 303             (Operand[4]->String.Pointer[0] != '^'))
 304         {
 305             /*
 306              * Path is not absolute, so it will be relative to the node
 307              * referenced by the RootPathString (or the NS root if omitted)
 308              */
 309             StartNode = ParentNode;
 310         }
 311
 312         /*
 313          * Find the node referenced by the ParameterPathString
 314          */
 315         Status = AcpiNsGetNodeByPath (Operand[4]->String.Pointer, StartNode,
 316                                         ACPI_NS_SEARCH_PARENT, &ParameterNode);
 317         if (ACPI_FAILURE (Status))
 318         {
 319             return_ACPI_STATUS (Status);
 320         }
 321     }
 322
 323     /* Load the table into the namespace */
 324
 325     Status = AcpiExAddTable (Table, ParentNode, &DdbHandle);
 326     if (ACPI_FAILURE (Status))
 327     {
 328         return_ACPI_STATUS (Status);
 329     }
 330
 331     /* Parameter Data (optional) */
 332
 333     if (ParameterNode)
 334     {
 335         /* Store the parameter data into the optional parameter object */
 336
 337         Status = AcpiExStore (Operand[5], ACPI_CAST_PTR (ACPI_OPERAND_OBJECT, ParameterNode),
 338                                 WalkState);
 339         if (ACPI_FAILURE (Status))
 340         {
 341             (void) AcpiExUnloadTable (DdbHandle);
 342         }
 343     }
 344
 345     return_ACPI_STATUS  (Status);
 346 }
 347
 348
 349 /*******************************************************************************
 350  *
 351  * FUNCTION:    AcpiExLoadOp
 352  *
 353  * PARAMETERS:  ObjDesc         - Region or Field where the table will be
 354  *                                obtained
 355  *              Target          - Where a handle to the table will be stored
 356  *              WalkState       - Current state
 357  *
 358  * RETURN:      Status
 359  *
 360  * DESCRIPTION: Load an ACPI table from a field or operation region
 361  *
 362  ******************************************************************************/
 363
 364 ACPI_STATUS
 365 AcpiExLoadOp (
 366     ACPI_OPERAND_OBJECT     *ObjDesc,
 367     ACPI_OPERAND_OBJECT     *Target,
 368     ACPI_WALK_STATE         *WalkState)
 369 {
 370     ACPI_STATUS             Status;
 371     ACPI_OPERAND_OBJECT     *DdbHandle;
 372     ACPI_OPERAND_OBJECT     *BufferDesc = NULL;
 373     ACPI_TABLE_HEADER       *TablePtr = NULL;
 374     UINT8                   *TableDataPtr;
 375     ACPI_TABLE_HEADER       TableHeader;
 376     UINT32                  i;
 377
 378     ACPI_FUNCTION_TRACE ("ExLoadOp");
 379
 380
 381     /* Object can be either an OpRegion or a Field */
 382
 383     switch (ACPI_GET_OBJECT_TYPE (ObjDesc))
 384     {
 385     case ACPI_TYPE_REGION:
 386
 387         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Load from Region %p %s\n",
 388             ObjDesc, AcpiUtGetObjectTypeName (ObjDesc)));
 389
 390         /* Get the table header */
 391
 392         TableHeader.Length = 0;
 393         for (i = 0; i < sizeof (ACPI_TABLE_HEADER); i++)
 394         {
 395             Status = AcpiEvAddressSpaceDispatch (ObjDesc, ACPI_READ,
 396                                 (ACPI_PHYSICAL_ADDRESS) i, 8,
 397                                 ((UINT8 *) &TableHeader) + i);
 398             if (ACPI_FAILURE (Status))
 399             {
 400                 return_ACPI_STATUS (Status);
 401             }
 402         }
 403
 404         /* Allocate a buffer for the entire table */
 405
 406         TablePtr = ACPI_MEM_ALLOCATE (TableHeader.Length);
 407         if (!TablePtr)
 408         {
 409             return_ACPI_STATUS (AE_NO_MEMORY);
 410         }
 411
 412         /* Copy the header to the buffer */
 413
 414         ACPI_MEMCPY (TablePtr, &TableHeader, sizeof (ACPI_TABLE_HEADER));
 415         TableDataPtr = ACPI_PTR_ADD (UINT8, TablePtr, sizeof (ACPI_TABLE_HEADER));
 416
 417         /* Get the table from the op region */
 418
 419         for (i = 0; i < TableHeader.Length; i++)
 420         {
 421             Status = AcpiEvAddressSpaceDispatch (ObjDesc, ACPI_READ,
 422                                 (ACPI_PHYSICAL_ADDRESS) i, 8,
 423                                 ((UINT8 *) TableDataPtr + i));
 424             if (ACPI_FAILURE (Status))
 425             {
 426                 goto Cleanup;
 427             }
 428         }
 429         break;
 430
 431
 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