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