xref: /illumos-gate/usr/src/cmd/acpi/iasl/dtsubtable.c (revision 35786f68)
1 /******************************************************************************
2  *
3  * Module Name: dtsubtable.c - handling of subtables within ACPI tables
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2018, 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 "aslcompiler.h"
153 
154 #define _COMPONENT          DT_COMPILER
155         ACPI_MODULE_NAME    ("dtsubtable")
156 
157 
158 /******************************************************************************
159  *
160  * FUNCTION:    DtCreateSubtable
161  *
162  * PARAMETERS:  Buffer              - Input buffer
163  *              Length              - Buffer length
164  *              RetSubtable         - Returned newly created subtable
165  *
166  * RETURN:      None
167  *
168  * DESCRIPTION: Create a subtable that is not listed with ACPI_DMTABLE_INFO
169  *              For example, FACS has 24 bytes reserved at the end
170  *              and it's not listed at AcpiDmTableInfoFacs
171  *
172  *****************************************************************************/
173 
174 void
DtCreateSubtable(UINT8 * Buffer,UINT32 Length,DT_SUBTABLE ** RetSubtable)175 DtCreateSubtable (
176     UINT8                   *Buffer,
177     UINT32                  Length,
178     DT_SUBTABLE             **RetSubtable)
179 {
180     DT_SUBTABLE             *Subtable;
181     char                    *String;
182 
183 
184     Subtable = UtSubtableCacheCalloc ();
185 
186     /* Create a new buffer for the subtable data */
187 
188     String = UtLocalCacheCalloc (Length);
189     Subtable->Buffer = ACPI_CAST_PTR (UINT8, String);
190     memcpy (Subtable->Buffer, Buffer, Length);
191 
192     Subtable->Length = Length;
193     Subtable->TotalLength = Length;
194 
195     *RetSubtable = Subtable;
196 }
197 
198 
199 /******************************************************************************
200  *
201  * FUNCTION:    DtInsertSubtable
202  *
203  * PARAMETERS:  ParentTable         - The Parent of the new subtable
204  *              Subtable            - The new subtable to insert
205  *
206  * RETURN:      None
207  *
208  * DESCRIPTION: Insert the new subtable to the parent table
209  *
210  *****************************************************************************/
211 
212 void
DtInsertSubtable(DT_SUBTABLE * ParentTable,DT_SUBTABLE * Subtable)213 DtInsertSubtable (
214     DT_SUBTABLE             *ParentTable,
215     DT_SUBTABLE             *Subtable)
216 {
217     DT_SUBTABLE             *ChildTable;
218 
219 
220     Subtable->Peer = NULL;
221     Subtable->Parent = ParentTable;
222     Subtable->Depth = ParentTable->Depth + 1;
223 
224     /* Link the new entry into the child list */
225 
226     if (!ParentTable->Child)
227     {
228         ParentTable->Child = Subtable;
229     }
230     else
231     {
232         /* Walk to the end of the child list */
233 
234         ChildTable = ParentTable->Child;
235         while (ChildTable->Peer)
236         {
237             ChildTable = ChildTable->Peer;
238         }
239 
240         /* Add new subtable at the end of the child list */
241 
242         ChildTable->Peer = Subtable;
243     }
244 }
245 
246 
247 /******************************************************************************
248  *
249  * FUNCTION:    DtPushSubtable
250  *
251  * PARAMETERS:  Subtable            - Subtable to push
252  *
253  * RETURN:      None
254  *
255  * DESCRIPTION: Push a subtable onto a subtable stack
256  *
257  *****************************************************************************/
258 
259 void
DtPushSubtable(DT_SUBTABLE * Subtable)260 DtPushSubtable (
261     DT_SUBTABLE             *Subtable)
262 {
263 
264     Subtable->StackTop = Gbl_SubtableStack;
265     Gbl_SubtableStack = Subtable;
266 }
267 
268 
269 /******************************************************************************
270  *
271  * FUNCTION:    DtPopSubtable
272  *
273  * PARAMETERS:  None
274  *
275  * RETURN:      None
276  *
277  * DESCRIPTION: Pop a subtable from a subtable stack. Uses global SubtableStack
278  *
279  *****************************************************************************/
280 
281 void
DtPopSubtable(void)282 DtPopSubtable (
283     void)
284 {
285     DT_SUBTABLE             *Subtable;
286 
287 
288     Subtable = Gbl_SubtableStack;
289 
290     if (Subtable)
291     {
292         Gbl_SubtableStack = Subtable->StackTop;
293     }
294 }
295 
296 
297 /******************************************************************************
298  *
299  * FUNCTION:    DtPeekSubtable
300  *
301  * PARAMETERS:  None
302  *
303  * RETURN:      The subtable on top of stack
304  *
305  * DESCRIPTION: Get the subtable on top of stack
306  *
307  *****************************************************************************/
308 
309 DT_SUBTABLE *
DtPeekSubtable(void)310 DtPeekSubtable (
311     void)
312 {
313 
314     return (Gbl_SubtableStack);
315 }
316 
317 
318 /******************************************************************************
319  *
320  * FUNCTION:    DtGetNextSubtable
321  *
322  * PARAMETERS:  ParentTable         - Parent table whose children we are
323  *                                    getting
324  *              ChildTable          - Previous child that was found.
325  *                                    The NEXT child will be returned
326  *
327  * RETURN:      Pointer to the NEXT child or NULL if none is found.
328  *
329  * DESCRIPTION: Return the next peer subtable within the tree.
330  *
331  *****************************************************************************/
332 
333 DT_SUBTABLE *
DtGetNextSubtable(DT_SUBTABLE * ParentTable,DT_SUBTABLE * ChildTable)334 DtGetNextSubtable (
335     DT_SUBTABLE             *ParentTable,
336     DT_SUBTABLE             *ChildTable)
337 {
338     ACPI_FUNCTION_ENTRY ();
339 
340 
341     if (!ChildTable)
342     {
343         /* It's really the parent's _scope_ that we want */
344 
345         return (ParentTable->Child);
346     }
347 
348     /* Otherwise just return the next peer (NULL if at end-of-list) */
349 
350     return (ChildTable->Peer);
351 }
352 
353 
354 /******************************************************************************
355  *
356  * FUNCTION:    DtGetParentSubtable
357  *
358  * PARAMETERS:  Subtable            - Current subtable
359  *
360  * RETURN:      Parent of the given subtable
361  *
362  * DESCRIPTION: Get the parent of the given subtable in the tree
363  *
364  *****************************************************************************/
365 
366 DT_SUBTABLE *
DtGetParentSubtable(DT_SUBTABLE * Subtable)367 DtGetParentSubtable (
368     DT_SUBTABLE             *Subtable)
369 {
370 
371     if (!Subtable)
372     {
373         return (NULL);
374     }
375 
376     return (Subtable->Parent);
377 }
378 
379 
380 /******************************************************************************
381  *
382  * FUNCTION:    DtGetSubtableLength
383  *
384  * PARAMETERS:  Field               - Current field list pointer
385  *              Info                - Data table info
386  *
387  * RETURN:      Subtable length
388  *
389  * DESCRIPTION: Get length of bytes needed to compile the subtable
390  *
391  *****************************************************************************/
392 
393 UINT32
DtGetSubtableLength(DT_FIELD * Field,ACPI_DMTABLE_INFO * Info)394 DtGetSubtableLength (
395     DT_FIELD                *Field,
396     ACPI_DMTABLE_INFO       *Info)
397 {
398     UINT32                  ByteLength = 0;
399     UINT8                   Step;
400     UINT8                   i;
401 
402 
403     /* Walk entire Info table; Null name terminates */
404 
405     for (; Info->Name; Info++)
406     {
407         if (Info->Opcode == ACPI_DMT_EXTRA_TEXT)
408         {
409             continue;
410         }
411 
412         if (!Field)
413         {
414             goto Error;
415         }
416 
417         ByteLength += DtGetFieldLength (Field, Info);
418 
419         switch (Info->Opcode)
420         {
421         case ACPI_DMT_GAS:
422 
423             Step = 5;
424             break;
425 
426         case ACPI_DMT_HESTNTFY:
427 
428             Step = 9;
429             break;
430 
431         case ACPI_DMT_IORTMEM:
432 
433             Step = 10;
434             break;
435 
436         default:
437 
438             Step = 1;
439             break;
440         }
441 
442         for (i = 0; i < Step; i++)
443         {
444             if (!Field)
445             {
446                 goto Error;
447             }
448 
449             Field = Field->Next;
450         }
451     }
452 
453     return (ByteLength);
454 
455 Error:
456     if (!Field)
457     {
458         sprintf (MsgBuffer, "Found NULL field - Field name \"%s\" needed",
459             Info->Name);
460         DtFatal (ASL_MSG_COMPILER_INTERNAL, NULL, MsgBuffer);
461     }
462 
463     return (ASL_EOF);
464 }
465 
466 
467 /******************************************************************************
468  *
469  * FUNCTION:    DtSetSubtableLength
470  *
471  * PARAMETERS:  Subtable            - Subtable
472  *
473  * RETURN:      None
474  *
475  * DESCRIPTION: Set length of the subtable into its length field
476  *
477  *****************************************************************************/
478 
479 void
DtSetSubtableLength(DT_SUBTABLE * Subtable)480 DtSetSubtableLength (
481     DT_SUBTABLE             *Subtable)
482 {
483 
484     if (!Subtable->LengthField)
485     {
486         return;
487     }
488 
489     memcpy (Subtable->LengthField, &Subtable->TotalLength,
490         Subtable->SizeOfLengthField);
491 }
492