sys/contrib/dev/acpica/tbget.c

   1 /******************************************************************************
   2  *
   3  * Module Name: tbget - ACPI Table get* routines
   4  *              $Revision: 83 $
   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  * 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 /* $DragonFly: src/sys/contrib/dev/acpica/Attic/tbget.c,v 1.1 2003/09/24 03:32:16 drhodus Exp $                                                               */
 117
 118 #define __TBGET_C__
 119
 120 #include "acpi.h"
 121 #include "actables.h"
 122
 123
 124 #define _COMPONENT          ACPI_TABLES
 125         ACPI_MODULE_NAME    ("tbget")
 126
 127
 128 /*******************************************************************************
 129  *
 130  * FUNCTION:    AcpiTbGetTable
 131  *
 132  * PARAMETERS:  Address             - Address of table to retrieve.  Can be
 133  *                                    Logical or Physical
 134  *              TableInfo           - Where table info is returned
 135  *
 136  * RETURN:      None
 137  *
 138  * DESCRIPTION: Get entire table of unknown size.
 139  *
 140  ******************************************************************************/
 141
 142 ACPI_STATUS
 143 AcpiTbGetTable (
 144     ACPI_POINTER            *Address,
 145     ACPI_TABLE_DESC         *TableInfo)
 146 {
 147     ACPI_STATUS             Status;
 148     ACPI_TABLE_HEADER       Header;
 149
 150
 151     ACPI_FUNCTION_TRACE ("TbGetTable");
 152
 153
 154     /*
 155      * Get the header in order to get signature and table size
 156      */
 157     Status = AcpiTbGetTableHeader (Address, &Header);
 158     if (ACPI_FAILURE (Status))
 159     {
 160         return_ACPI_STATUS (Status);
 161     }
 162
 163     /* Get the entire table */
 164
 165     Status = AcpiTbGetTableBody (Address, &Header, TableInfo);
 166     if (ACPI_FAILURE (Status))
 167     {
 168         ACPI_REPORT_ERROR (("Could not get ACPI table (size %X), %s\n",
 169             Header.Length, AcpiFormatException (Status)));
 170         return_ACPI_STATUS (Status);
 171     }
 172
 173     return_ACPI_STATUS (AE_OK);
 174 }
 175
 176
 177 /*******************************************************************************
 178  *
 179  * FUNCTION:    AcpiTbGetTableHeader
 180  *
 181  * PARAMETERS:  Address             - Address of table to retrieve.  Can be
 182  *                                    Logical or Physical
 183  *              ReturnHeader        - Where the table header is returned
 184  *
 185  * RETURN:      Status
 186  *
 187  * DESCRIPTION: Get an ACPI table header.  Works in both physical or virtual
 188  *              addressing mode.  Works with both physical or logical pointers.
 189  *              Table is either copied or mapped, depending on the pointer
 190  *              type and mode of the processor.
 191  *
 192  ******************************************************************************/
 193
 194 ACPI_STATUS
 195 AcpiTbGetTableHeader (
 196     ACPI_POINTER            *Address,
 197     ACPI_TABLE_HEADER       *ReturnHeader)
 198 {
 199     ACPI_STATUS             Status = AE_OK;
 200     ACPI_TABLE_HEADER       *Header = NULL;
 201
 202
 203     ACPI_FUNCTION_TRACE ("TbGetTableHeader");
 204
 205
 206     /*
 207      * Flags contains the current processor mode (Virtual or Physical addressing)
 208      * The PointerType is either Logical or Physical
 209      */
 210     switch (Address->PointerType)
 211     {
 212     case ACPI_PHYSMODE_PHYSPTR:
 213     case ACPI_LOGMODE_LOGPTR:
 214
 215         /* Pointer matches processor mode, copy the header */
 216
 217         ACPI_MEMCPY (ReturnHeader, Address->Pointer.Logical, sizeof (ACPI_TABLE_HEADER));
 218         break;
 219
 220
 221     case ACPI_LOGMODE_PHYSPTR:
 222
 223         /* Create a logical address for the physical pointer*/
 224
 225         Status = AcpiOsMapMemory (Address->Pointer.Physical, sizeof (ACPI_TABLE_HEADER),
 226                                     (void **) &Header);
 227         if (ACPI_FAILURE (Status))
 228         {
 229             ACPI_REPORT_ERROR (("Could not map memory at %8.8X%8.8X for length %X\n",
 230                 ACPI_HIDWORD (Address->Pointer.Physical),
 231                 ACPI_LODWORD (Address->Pointer.Physical),
 232                 sizeof (ACPI_TABLE_HEADER)));
 233             return_ACPI_STATUS (Status);
 234         }
 235
 236         /* Copy header and delete mapping */
 237
 238         ACPI_MEMCPY (ReturnHeader, Header, sizeof (ACPI_TABLE_HEADER));
 239         AcpiOsUnmapMemory (Header, sizeof (ACPI_TABLE_HEADER));
 240         break;
 241
 242
 243     default:
 244
 245         ACPI_REPORT_ERROR (("Invalid address flags %X\n",
 246             Address->PointerType));
 247         return_ACPI_STATUS (AE_BAD_PARAMETER);
 248     }
 249
 250     return_ACPI_STATUS (AE_OK);
 251 }
 252
 253
 254 /*******************************************************************************
 255  *
 256  * FUNCTION:    AcpiTbGetTableBody
 257  *
 258  * PARAMETERS:  Address             - Address of table to retrieve.  Can be
 259  *                                    Logical or Physical
 260  *              Header              - Header of the table to retrieve
 261  *              TableInfo           - Where the table info is returned
 262  *
 263  * RETURN:      Status
 264  *
 265  * DESCRIPTION: Get an entire ACPI table with support to allow the host OS to
 266  *              replace the table with a newer version (table override.)
 267  *              Works in both physical or virtual
 268  *              addressing mode.  Works with both physical or logical pointers.
 269  *              Table is either copied or mapped, depending on the pointer
 270  *              type and mode of the processor.
 271  *
 272  ******************************************************************************/
 273
 274 ACPI_STATUS
 275 AcpiTbGetTableBody (
 276     ACPI_POINTER            *Address,
 277     ACPI_TABLE_HEADER       *Header,
 278     ACPI_TABLE_DESC         *TableInfo)
 279 {
 280     ACPI_STATUS             Status;
 281
 282
 283     ACPI_FUNCTION_TRACE ("TbGetTableBody");
 284
 285
 286     if (!TableInfo || !Address)
 287     {
 288         return_ACPI_STATUS (AE_BAD_PARAMETER);
 289     }
 290
 291     /*
 292      * Attempt table override.
 293      */
 294     Status = AcpiTbTableOverride (Header, TableInfo);
 295     if (ACPI_SUCCESS (Status))
 296     {
 297         /* Table was overridden by the host OS */
 298
 299         return_ACPI_STATUS (Status);
 300     }
 301
 302     /* No override, get the original table */
 303
 304     Status = AcpiTbGetThisTable (Address, Header, TableInfo);
 305     return_ACPI_STATUS (Status);
 306 }
 307
 308
 309 /*******************************************************************************
 310  *
 311  * FUNCTION:    AcpiTbTableOverride
 312  *
 313  * PARAMETERS:  Header              - Pointer to table header
 314  *              TableInfo           - Return info if table is overridden
 315  *
 316  * RETURN:      None
 317  *
 318  * DESCRIPTION: Attempts override of current table with a new one if provided
 319  *              by the host OS.
 320  *
 321  ******************************************************************************/
 322
 323 ACPI_STATUS
 324 AcpiTbTableOverride (
 325     ACPI_TABLE_HEADER       *Header,
 326     ACPI_TABLE_DESC         *TableInfo)
 327 {
 328     ACPI_TABLE_HEADER       *NewTable;
 329     ACPI_STATUS             Status;
 330     ACPI_POINTER            Address;
 331
 332
 333     ACPI_FUNCTION_TRACE ("TbTableOverride");
 334
 335
 336     /*
 337      * The OSL will examine the header and decide whether to override this
 338      * table.  If it decides to override, a table will be returned in NewTable,
 339      * which we will then copy.
 340      */
 341     Status = AcpiOsTableOverride (Header, &NewTable);
 342     if (ACPI_FAILURE (Status))
 343     {
 344         /* Some severe error from the OSL, but we basically ignore it */
 345
 346         ACPI_REPORT_ERROR (("Could not override ACPI table, %s\n",
 347             AcpiFormatException (Status)));
 348         return_ACPI_STATUS (Status);
 349     }
 350
 351     if (!NewTable)
 352     {
 353         /* No table override */
 354
 355         return_ACPI_STATUS (AE_NO_ACPI_TABLES);
 356     }
 357
 358     /*
 359      * We have a new table to override the old one.  Get a copy of
 360      * the new one.  We know that the new table has a logical pointer.
 361      */
 362     Address.PointerType     = ACPI_LOGICAL_POINTER | ACPI_LOGICAL_ADDRESSING;
 363     Address.Pointer.Logical = NewTable;
 364
 365     Status = AcpiTbGetThisTable (&Address, NewTable, TableInfo);
 366     if (ACPI_FAILURE (Status))
 367     {
 368         ACPI_REPORT_ERROR (("Could not copy override ACPI table, %s\n",
 369             AcpiFormatException (Status)));
 370         return_ACPI_STATUS (Status);
 371     }
 372
 373     /* Copy the table info */
 374
 375     ACPI_REPORT_INFO (("Table [%4.4s] replaced by host OS\n",
 376         TableInfo->Pointer->Signature));
 377
 378     return_ACPI_STATUS (AE_OK);
 379 }
 380
 381
 382 /*******************************************************************************
 383  *
 384  * FUNCTION:    AcpiTbGetThisTable
 385  *
 386  * PARAMETERS:  Address             - Address of table to retrieve.  Can be
 387  *                                    Logical or Physical
 388  *              Header              - Header of the table to retrieve
 389  *              TableInfo           - Where the table info is returned
 390  *
 391  * RETURN:      Status
 392  *
 393  * DESCRIPTION: Get an entire ACPI table.  Works in both physical or virtual
 394  *              addressing mode.  Works with both physical or logical pointers.
 395  *              Table is either copied or mapped, depending on the pointer
 396  *              type and mode of the processor.
 397  *
 398  ******************************************************************************/
 399
 400 ACPI_STATUS
 401 AcpiTbGetThisTable (
 402     ACPI_POINTER            *Address,
 403     ACPI_TABLE_HEADER       *Header,
 404     ACPI_TABLE_DESC         *TableInfo)
 405 {
 406     ACPI_TABLE_HEADER       *FullTable = NULL;
 407     UINT8                   Allocation;
 408     ACPI_STATUS             Status = AE_OK;
 409
 410
 411     ACPI_FUNCTION_TRACE ("TbGetThisTable");
 412
 413
 414     /*
 415      * Flags contains the current processor mode (Virtual or Physical addressing)
 416      * The PointerType is either Logical or Physical
 417      */
 418     switch (Address->PointerType)
 419     {
 420     case ACPI_PHYSMODE_PHYSPTR:
 421     case ACPI_LOGMODE_LOGPTR:
 422
 423         /* Pointer matches processor mode, copy the table to a new buffer */
 424
 425         FullTable = ACPI_MEM_ALLOCATE (Header->Length);
 426         if (!FullTable)
 427         {
 428             ACPI_REPORT_ERROR (("Could not allocate table memory for [%4.4s] length %X\n",
 429                 Header->Signature, Header->Length));
 430             return_ACPI_STATUS (AE_NO_MEMORY);
 431         }
 432
 433         /* Copy the entire table (including header) to the local buffer */
 434
 435         ACPI_MEMCPY (FullTable, Address->Pointer.Logical, Header->Length);
 436
 437         /* Save allocation type */
 438
 439         Allocation = ACPI_MEM_ALLOCATED;
 440         break;
 441
 442
 443     case ACPI_LOGMODE_PHYSPTR:
 444
 445         /*
 446          * Just map the table's physical memory
 447          * into our address space.
 448          */
 449         Status = AcpiOsMapMemory (Address->Pointer.Physical, (ACPI_SIZE) Header->Length,
 450                                     (void **) &FullTable);
 451         if (ACPI_FAILURE (Status))
 452         {
 453             ACPI_REPORT_ERROR (("Could not map memory for table [%4.4s] at %8.8X%8.8X for length %X\n",
 454                 Header->Signature,
 455                 ACPI_HIDWORD (Address->Pointer.Physical),
 456                 ACPI_LODWORD (Address->Pointer.Physical), Header->Length));
 457             return (Status);
 458         }
 459
 460         /* Save allocation type */
 461
 462         Allocation = ACPI_MEM_MAPPED;
 463         break;
 464
 465
 466     default:
 467
 468         ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Invalid address flags %X\n",
 469             Address->PointerType));
 470         return_ACPI_STATUS (AE_BAD_PARAMETER);
 471     }
 472
 473     /*
 474      * Validate checksum for _most_ tables,
 475      * even the ones whose signature we don't recognize
 476      */
 477     if (TableInfo->Type != ACPI_TABLE_FACS)
 478     {
 479         Status = AcpiTbVerifyTableChecksum (FullTable);
 480
 481 #if (!ACPI_CHECKSUM_ABORT)
 482         if (ACPI_FAILURE (Status))
 483         {
 484             /* Ignore the error if configuration says so */
 485
 486             Status = AE_OK;
 487         }
 488 #endif
 489     }
 490
 491     /* Return values */
 492
 493     TableInfo->Pointer      = FullTable;
 494     TableInfo->Length       = (ACPI_SIZE) Header->Length;
 495     TableInfo->Allocation   = Allocation;
 496
 497     ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
 498         "Found table [%4.4s] at %8.8X%8.8X, mapped/copied to %p\n",
 499         FullTable->Signature,
 500         ACPI_HIDWORD (Address->Pointer.Physical),
 501         ACPI_LODWORD (Address->Pointer.Physical), FullTable));
 502
 503     return_ACPI_STATUS (Status);
 504 }
 505
 506
 507 /*******************************************************************************
 508  *
 509  * FUNCTION:    AcpiTbGetTablePtr
 510  *
 511  * PARAMETERS:  TableType       - one of the defined table types
 512  *              Instance        - Which table of this type
 513  *              TablePtrLoc     - pointer to location to place the pointer for
 514  *                                return
 515  *
 516  * RETURN:      Status
 517  *
 518  * DESCRIPTION: This function is called to get the pointer to an ACPI table.
 519  *
 520  ******************************************************************************/
 521
 522 ACPI_STATUS
 523 AcpiTbGetTablePtr (
 524     ACPI_TABLE_TYPE         TableType,
 525     UINT32                  Instance,
 526     ACPI_TABLE_HEADER       **TablePtrLoc)
 527 {
 528     ACPI_TABLE_DESC         *TableDesc;
 529     UINT32                  i;
 530
 531
 532     ACPI_FUNCTION_TRACE ("TbGetTablePtr");
 533
 534
 535     if (!AcpiGbl_DSDT)
 536     {
 537         return_ACPI_STATUS (AE_NO_ACPI_TABLES);
 538     }
 539
 540     if (TableType > ACPI_TABLE_MAX)
 541     {
 542         return_ACPI_STATUS (AE_BAD_PARAMETER);
 543     }
 544
 545     /*
 546      * For all table types (Single/Multiple), the first
 547      * instance is always in the list head.
 548      */
 549     if (Instance == 1)
 550     {
 551         /*
 552          * Just pluck the pointer out of the global table!
 553          * Will be null if no table is present
 554          */
 555         *TablePtrLoc = AcpiGbl_AcpiTables[TableType].Pointer;
 556         return_ACPI_STATUS (AE_OK);
 557     }
 558
 559     /*
 560      * Check for instance out of range
 561      */
 562     if (Instance > AcpiGbl_AcpiTables[TableType].Count)
 563     {
 564         return_ACPI_STATUS (AE_NOT_EXIST);
 565     }
 566
 567     /* Walk the list to get the desired table
 568      * Since the if (Instance == 1) check above checked for the
 569      * first table, setting TableDesc equal to the .Next member
 570      * is actually pointing to the second table.  Therefore, we
 571      * need to walk from the 2nd table until we reach the Instance
 572      * that the user is looking for and return its table pointer.
 573      */
 574     TableDesc = AcpiGbl_AcpiTables[TableType].Next;
 575     for (i = 2; i < Instance; i++)
 576     {
 577         TableDesc = TableDesc->Next;
 578     }
 579
 580     /* We are now pointing to the requested table's descriptor */
 581
 582     *TablePtrLoc = TableDesc->Pointer;
 583
 584     return_ACPI_STATUS (AE_OK);
 585 }
 586