sys/contrib/dev/acpica-unix/tables/tbfind.c

   1 /******************************************************************************
   2  *
   3  * Module Name: tbfind   - find table
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2011, Intel Corp.
  12  * All rights reserved.
  13  *
  14  * 2. License
  15  *
  16  * 2.1. This is your license from Intel Corp. under its intellectual property
  17  * rights.  You may have additional license terms from the party that provided
  18  * you this software, covering your right to use that party's intellectual
  19  * property rights.
  20  *
  21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  22  * copy of the source code appearing in this file ("Covered Code") an
  23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  24  * base code distributed originally by Intel ("Original Intel Code") to copy,
  25  * make derivatives, distribute, use and display any portion of the Covered
  26  * Code in any form, with the right to sublicense such rights; and
  27  *
  28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  29  * license (with the right to sublicense), under only those claims of Intel
  30  * patents that are infringed by the Original Intel Code, to make, use, sell,
  31  * offer to sell, and import the Covered Code and derivative works thereof
  32  * solely to the minimum extent necessary to exercise the above copyright
  33  * license, and in no event shall the patent license extend to any additions
  34  * to or modifications of the Original Intel Code.  No other license or right
  35  * is granted directly or by implication, estoppel or otherwise;
  36  *
  37  * The above copyright and patent license is granted only if the following
  38  * conditions are met:
  39  *
  40  * 3. Conditions
  41  *
  42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  43  * Redistribution of source code of any substantial portion of the Covered
  44  * Code or modification with rights to further distribute source must include
  45  * the above Copyright Notice, the above License, this list of Conditions,
  46  * and the following Disclaimer and Export Compliance provision.  In addition,
  47  * Licensee must cause all Covered Code to which Licensee contributes to
  48  * contain a file documenting the changes Licensee made to create that Covered
  49  * Code and the date of any change.  Licensee must include in that file the
  50  * documentation of any changes made by any predecessor Licensee.  Licensee
  51  * must include a prominent statement that the modification is derived,
  52  * directly or indirectly, from Original Intel Code.
  53  *
  54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  55  * Redistribution of source code of any substantial portion of the Covered
  56  * Code or modification without rights to further distribute source must
  57  * include the following Disclaimer and Export Compliance provision in the
  58  * documentation and/or other materials provided with distribution.  In
  59  * addition, Licensee may not authorize further sublicense of source of any
  60  * portion of the Covered Code, and must include terms to the effect that the
  61  * license from Licensee to its licensee is limited to the intellectual
  62  * property embodied in the software Licensee provides to its licensee, and
  63  * not to intellectual property embodied in modifications its licensee may
  64  * make.
  65  *
  66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  67  * substantial portion of the Covered Code or modification must reproduce the
  68  * above Copyright Notice, and the following Disclaimer and Export Compliance
  69  * provision in the documentation and/or other materials provided with the
  70  * distribution.
  71  *
  72  * 3.4. Intel retains all right, title, and interest in and to the Original
  73  * Intel Code.
  74  *
  75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  76  * Intel shall be used in advertising or otherwise to promote the sale, use or
  77  * other dealings in products derived from or relating to the Covered Code
  78  * without prior written authorization from Intel.
  79  *
  80  * 4. Disclaimer and Export Compliance
  81  *
  82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  83  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  85  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  86  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  88  * PARTICULAR PURPOSE.
  89  *
  90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  97  * LIMITED REMEDY.
  98  *
  99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 100  * software or system incorporating such software without first obtaining any
 101  * required license or other approval from the U. S. Department of Commerce or
 102  * any other agency or department of the United States Government.  In the
 103  * event Licensee exports any such software from the United States or
 104  * re-exports any such software from a foreign destination, Licensee shall
 105  * ensure that the distribution and export/re-export of the software is in
 106  * compliance with all laws, regulations, orders, or other restrictions of the
 107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 108  * any of its subsidiaries will export/re-export any technical data, process,
 109  * software, or service, directly or indirectly, to any country for which the
 110  * United States government or any agency thereof requires an export license,
 111  * other governmental approval, or letter of assurance, without first obtaining
 112  * such license, approval or letter.
 113  *
 114  *****************************************************************************/
 115
 116 #define __TBFIND_C__
 117
 118 #include "acpi.h"
 119 #include "accommon.h"
 120 #include "actables.h"
 121
 122 #define _COMPONENT          ACPI_TABLES
 123         ACPI_MODULE_NAME    ("tbfind")
 124
 125
 126 /*******************************************************************************
 127  *
 128  * FUNCTION:    AcpiTbFindTable
 129  *
 130  * PARAMETERS:  Signature           - String with ACPI table signature
 131  *              OemId               - String with the table OEM ID
 132  *              OemTableId          - String with the OEM Table ID
 133  *              TableIndex          - Where the table index is returned
 134  *
 135  * RETURN:      Status and table index
 136  *
 137  * DESCRIPTION: Find an ACPI table (in the RSDT/XSDT) that matches the
 138  *              Signature, OEM ID and OEM Table ID. Returns an index that can
 139  *              be used to get the table header or entire table.
 140  *
 141  ******************************************************************************/
 142
 143 ACPI_STATUS
 144 AcpiTbFindTable (
 145     char                    *Signature,
 146     char                    *OemId,
 147     char                    *OemTableId,
 148     UINT32                  *TableIndex)
 149 {
 150     UINT32                  i;
 151     ACPI_STATUS             Status;
 152     ACPI_TABLE_HEADER       Header;
 153
 154
 155     ACPI_FUNCTION_TRACE (TbFindTable);
 156
 157
 158     /* Normalize the input strings */
 159
 160     ACPI_MEMSET (&Header, 0, sizeof (ACPI_TABLE_HEADER));
 161     ACPI_STRNCPY (Header.Signature, Signature, ACPI_NAME_SIZE);
 162     ACPI_STRNCPY (Header.OemId, OemId, ACPI_OEM_ID_SIZE);
 163     ACPI_STRNCPY (Header.OemTableId, OemTableId, ACPI_OEM_TABLE_ID_SIZE);
 164
 165     /* Search for the table */
 166
 167     for (i = 0; i < AcpiGbl_RootTableList.CurrentTableCount; ++i)
 168     {
 169         if (ACPI_MEMCMP (&(AcpiGbl_RootTableList.Tables[i].Signature),
 170                             Header.Signature, ACPI_NAME_SIZE))
 171         {
 172             /* Not the requested table */
 173
 174             continue;
 175         }
 176
 177         /* Table with matching signature has been found */
 178
 179         if (!AcpiGbl_RootTableList.Tables[i].Pointer)
 180         {
 181             /* Table is not currently mapped, map it */
 182
 183             Status = AcpiTbVerifyTable (&AcpiGbl_RootTableList.Tables[i]);
 184             if (ACPI_FAILURE (Status))
 185             {
 186                 return_ACPI_STATUS (Status);
 187             }
 188
 189             if (!AcpiGbl_RootTableList.Tables[i].Pointer)
 190             {
 191                 continue;
 192             }
 193         }
 194
 195         /* Check for table match on all IDs */
 196
 197         if (!ACPI_MEMCMP (AcpiGbl_RootTableList.Tables[i].Pointer->Signature,
 198                             Header.Signature, ACPI_NAME_SIZE) &&
 199             (!OemId[0] ||
 200              !ACPI_MEMCMP (AcpiGbl_RootTableList.Tables[i].Pointer->OemId,
 201                              Header.OemId, ACPI_OEM_ID_SIZE)) &&
 202             (!OemTableId[0] ||
 203              !ACPI_MEMCMP (AcpiGbl_RootTableList.Tables[i].Pointer->OemTableId,
 204                              Header.OemTableId, ACPI_OEM_TABLE_ID_SIZE)))
 205         {
 206             *TableIndex = i;
 207
 208             ACPI_DEBUG_PRINT ((ACPI_DB_TABLES, "Found table [%4.4s]\n",
 209                 Header.Signature));
 210             return_ACPI_STATUS (AE_OK);
 211         }
 212     }
 213
 214     return_ACPI_STATUS (AE_NOT_FOUND);
 215 }