sys/contrib/dev/acpica-unix/compiler/dtsubtable.c

   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 - 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 __DTSUBTABLE_C__
 117
 118 #include "aslcompiler.h"
 119 #include "dtcompiler.h"
 120
 121 #define _COMPONENT          DT_COMPILER
 122         ACPI_MODULE_NAME    ("dtsubtable")
 123
 124
 125 /******************************************************************************
 126  *
 127  * FUNCTION:    DtCreateSubtable
 128  *
 129  * PARAMETERS:  Buffer              - Input buffer
 130  *              Length              - Buffer length
 131  *              RetSubtable         - Returned newly created subtable
 132  *
 133  * RETURN:      None
 134  *
 135  * DESCRIPTION: Create a subtable that is not listed with ACPI_DMTABLE_INFO
 136  *              For example, FACS has 24 bytes reserved at the end
 137  *              and it's not listed at AcpiDmTableInfoFacs
 138  *
 139  *****************************************************************************/
 140
 141 void
 142 DtCreateSubtable (
 143     UINT8                   *Buffer,
 144     UINT32                  Length,
 145     DT_SUBTABLE             **RetSubtable)
 146 {
 147     DT_SUBTABLE             *Subtable;
 148
 149
 150     Subtable = UtLocalCalloc (sizeof (DT_SUBTABLE));
 151
 152     /* Create a new buffer for the subtable data */
 153
 154     Subtable->Buffer = UtLocalCalloc (Length);
 155     ACPI_MEMCPY (Subtable->Buffer, Buffer, Length);
 156
 157     Subtable->Length = Length;
 158     Subtable->TotalLength = Length;
 159
 160     *RetSubtable = Subtable;
 161 }
 162
 163
 164 /******************************************************************************
 165  *
 166  * FUNCTION:    DtInsertSubtable
 167  *
 168  * PARAMETERS:  ParentTable         - The Parent of the new subtable
 169  *              Subtable            - The new subtable to insert
 170  *
 171  * RETURN:      None
 172  *
 173  * DESCRIPTION: Insert the new subtable to the parent table
 174  *
 175  *****************************************************************************/
 176
 177 void
 178 DtInsertSubtable (
 179     DT_SUBTABLE             *ParentTable,
 180     DT_SUBTABLE             *Subtable)
 181 {
 182     DT_SUBTABLE             *ChildTable;
 183
 184
 185     Subtable->Peer = NULL;
 186     Subtable->Parent = ParentTable;
 187
 188     /* Link the new entry into the child list */
 189
 190     if (!ParentTable->Child)
 191     {
 192         ParentTable->Child = Subtable;
 193     }
 194     else
 195     {
 196         /* Walk to the end of the child list */
 197
 198         ChildTable = ParentTable->Child;
 199         while (ChildTable->Peer)
 200         {
 201             ChildTable = ChildTable->Peer;
 202         }
 203
 204         /* Add new subtable at the end of the child list */
 205
 206         ChildTable->Peer = Subtable;
 207     }
 208 }
 209
 210
 211 /******************************************************************************
 212  *
 213  * FUNCTION:    DtPushSubtable
 214  *
 215  * PARAMETERS:  Subtable            - Subtable to push
 216  *
 217  * RETURN:      None
 218  *
 219  * DESCRIPTION: Push a subtable onto a subtable stack
 220  *
 221  *****************************************************************************/
 222
 223 void
 224 DtPushSubtable (
 225     DT_SUBTABLE             *Subtable)
 226 {
 227
 228     Subtable->StackTop = Gbl_SubtableStack;
 229     Gbl_SubtableStack = Subtable;
 230 }
 231
 232
 233 /******************************************************************************
 234  *
 235  * FUNCTION:    DtPopSubtable
 236  *
 237  * PARAMETERS:  None
 238  *
 239  * RETURN:      None
 240  *
 241  * DESCRIPTION: Pop a subtable from a subtable stack. Uses global SubtableStack
 242  *
 243  *****************************************************************************/
 244
 245 void
 246 DtPopSubtable (
 247     void)
 248 {
 249     DT_SUBTABLE             *Subtable;
 250
 251
 252     Subtable = Gbl_SubtableStack;
 253
 254     if (Subtable)
 255     {
 256         Gbl_SubtableStack = Subtable->StackTop;
 257     }
 258 }
 259
 260
 261 /******************************************************************************
 262  *
 263  * FUNCTION:    DtPeekSubtable
 264  *
 265  * PARAMETERS:  None
 266  *
 267  * RETURN:      The subtable on top of stack
 268  *
 269  * DESCRIPTION: Get the subtable on top of stack
 270  *
 271  *****************************************************************************/
 272
 273 DT_SUBTABLE *
 274 DtPeekSubtable (
 275     void)
 276 {
 277
 278     return (Gbl_SubtableStack);
 279 }
 280
 281
 282 /******************************************************************************
 283  *
 284  * FUNCTION:    DtGetNextSubtable
 285  *
 286  * PARAMETERS:  ParentTable         - Parent table whose children we are
 287  *                                    getting
 288  *              ChildTable          - Previous child that was found.
 289  *                                    The NEXT child will be returned
 290  *
 291  * RETURN:      Pointer to the NEXT child or NULL if none is found.
 292  *
 293  * DESCRIPTION: Return the next peer subtable within the tree.
 294  *
 295  *****************************************************************************/
 296
 297 DT_SUBTABLE *
 298 DtGetNextSubtable (
 299     DT_SUBTABLE             *ParentTable,
 300     DT_SUBTABLE             *ChildTable)
 301 {
 302     ACPI_FUNCTION_ENTRY ();
 303
 304
 305     if (!ChildTable)
 306     {
 307         /* It's really the parent's _scope_ that we want */
 308
 309         return (ParentTable->Child);
 310     }
 311
 312     /* Otherwise just return the next peer (NULL if at end-of-list) */
 313
 314     return (ChildTable->Peer);
 315 }
 316
 317
 318 /******************************************************************************
 319  *
 320  * FUNCTION:    DtGetParentSubtable
 321  *
 322  * PARAMETERS:  Subtable            - Current subtable
 323  *
 324  * RETURN:      Parent of the given subtable
 325  *
 326  * DESCRIPTION: Get the parent of the given subtable in the tree
 327  *
 328  *****************************************************************************/
 329
 330 DT_SUBTABLE *
 331 DtGetParentSubtable (
 332     DT_SUBTABLE             *Subtable)
 333 {
 334
 335     if (!Subtable)
 336     {
 337         return (NULL);
 338     }
 339
 340     return (Subtable->Parent);
 341 }
 342
 343
 344 /******************************************************************************
 345  *
 346  * FUNCTION:    DtGetSubtableLength
 347  *
 348  * PARAMETERS:  Field               - Current field list pointer
 349  *              Info                - Data table info
 350  *
 351  * RETURN:      Subtable length
 352  *
 353  * DESCRIPTION: Get length of bytes needed to compile the subtable
 354  *
 355  *****************************************************************************/
 356
 357 UINT32
 358 DtGetSubtableLength (
 359     DT_FIELD                *Field,
 360     ACPI_DMTABLE_INFO       *Info)
 361 {
 362     UINT32                  ByteLength = 0;
 363
 364
 365     /* Walk entire Info table; Null name terminates */
 366
 367     for (; Info->Name; Info++)
 368     {
 369         ByteLength += DtGetFieldLength (Field, Info);
 370     }
 371
 372     return (ByteLength);
 373 }
 374
 375
 376 /******************************************************************************
 377  *
 378  * FUNCTION:    DtSetSubtableLength
 379  *
 380  * PARAMETERS:  Subtable            - Subtable
 381  *
 382  * RETURN:      None
 383  *
 384  * DESCRIPTION: Set length of the subtable into its length field
 385  *
 386  *****************************************************************************/
 387
 388 void
 389 DtSetSubtableLength (
 390     DT_SUBTABLE             *Subtable)
 391 {
 392
 393     if (!Subtable->LengthField)
 394     {
 395         return;
 396     }
 397
 398     ACPI_MEMCPY (Subtable->LengthField, &Subtable->TotalLength,
 399         Subtable->SizeOfLengthField);
 400 }