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 - 2023, 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 * Alternatively, you may choose to be licensed under the terms of the
117 * following license:
118 *
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
121 * are met:
122 * 1. Redistributions of source code must retain the above copyright
123 * notice, this list of conditions, and the following disclaimer,
124 * without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 * substantially similar to the "NO WARRANTY" disclaimer below
127 * ("Disclaimer") and any redistribution must be conditioned upon
128 * including a substantially similar Disclaimer requirement for further
129 * binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 * of any contributors may be used to endorse or promote products derived
132 * from this software without specific prior written permission.
133 *
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145 *
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
149 *
150 *****************************************************************************/
151
152 #include <contrib/dev/acpica/include/acpi.h>
153 #include <contrib/dev/acpica/include/accommon.h>
154 #include <contrib/dev/acpica/include/actables.h>
155
156 #define _COMPONENT ACPI_TABLES
157 ACPI_MODULE_NAME ("tbfind")
158
159
160 /*******************************************************************************
161 *
162 * FUNCTION: AcpiTbFindTable
163 *
164 * PARAMETERS: Signature - String with ACPI table signature
165 * OemId - String with the table OEM ID
166 * OemTableId - String with the OEM Table ID
167 * TableIndex - Where the table index is returned
168 *
169 * RETURN: Status and table index
170 *
171 * DESCRIPTION: Find an ACPI table (in the RSDT/XSDT) that matches the
172 * Signature, OEM ID and OEM Table ID. Returns an index that can
173 * be used to get the table header or entire table.
174 *
175 ******************************************************************************/
176
177 ACPI_STATUS
AcpiTbFindTable(char * Signature,char * OemId,char * OemTableId,UINT32 * TableIndex)178 AcpiTbFindTable (
179 char *Signature,
180 char *OemId,
181 char *OemTableId,
182 UINT32 *TableIndex)
183 {
184 ACPI_STATUS Status = AE_OK;
185 ACPI_TABLE_HEADER Header;
186 UINT32 i;
187
188
189 ACPI_FUNCTION_TRACE (TbFindTable);
190
191
192 /* Validate the input table signature */
193
194 if (!AcpiUtValidNameseg (Signature))
195 {
196 return_ACPI_STATUS (AE_BAD_SIGNATURE);
197 }
198
199 /* Don't allow the OEM strings to be too long */
200
201 if ((strlen (OemId) > ACPI_OEM_ID_SIZE) ||
202 (strlen (OemTableId) > ACPI_OEM_TABLE_ID_SIZE))
203 {
204 return_ACPI_STATUS (AE_AML_STRING_LIMIT);
205 }
206
207 /* Normalize the input strings */
208
209 memset (&Header, 0, sizeof (ACPI_TABLE_HEADER));
210 ACPI_COPY_NAMESEG (Header.Signature, Signature);
211 strncpy (Header.OemId, OemId, ACPI_OEM_ID_SIZE);
212 strncpy (Header.OemTableId, OemTableId, ACPI_OEM_TABLE_ID_SIZE);
213
214 /* Search for the table */
215
216 (void) AcpiUtAcquireMutex (ACPI_MTX_TABLES);
217 for (i = 0; i < AcpiGbl_RootTableList.CurrentTableCount; ++i)
218 {
219 if (memcmp (&(AcpiGbl_RootTableList.Tables[i].Signature),
220 Header.Signature, ACPI_NAMESEG_SIZE))
221 {
222 /* Not the requested table */
223
224 continue;
225 }
226
227 /* Table with matching signature has been found */
228
229 if (!AcpiGbl_RootTableList.Tables[i].Pointer)
230 {
231 /* Table is not currently mapped, map it */
232
233 Status = AcpiTbValidateTable (&AcpiGbl_RootTableList.Tables[i]);
234 if (ACPI_FAILURE (Status))
235 {
236 goto UnlockAndExit;
237 }
238
239 if (!AcpiGbl_RootTableList.Tables[i].Pointer)
240 {
241 continue;
242 }
243 }
244
245 /* Check for table match on all IDs */
246
247 if (!memcmp (AcpiGbl_RootTableList.Tables[i].Pointer->Signature,
248 Header.Signature, ACPI_NAMESEG_SIZE) &&
249 (!OemId[0] ||
250 !memcmp (AcpiGbl_RootTableList.Tables[i].Pointer->OemId,
251 Header.OemId, ACPI_OEM_ID_SIZE)) &&
252 (!OemTableId[0] ||
253 !memcmp (AcpiGbl_RootTableList.Tables[i].Pointer->OemTableId,
254 Header.OemTableId, ACPI_OEM_TABLE_ID_SIZE)))
255 {
256 *TableIndex = i;
257
258 ACPI_DEBUG_PRINT ((ACPI_DB_TABLES, "Found table [%4.4s]\n",
259 Header.Signature));
260 goto UnlockAndExit;
261 }
262 }
263 Status = AE_NOT_FOUND;
264
265 UnlockAndExit:
266 (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES);
267 return_ACPI_STATUS (Status);
268 }
269