Subversion Repositories Kolibri OS

Rev

Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

  1. /******************************************************************************
  2.  *
  3.  * Module Name: dtcompiler.h - header for data table compiler
  4.  *
  5.  *****************************************************************************/
  6.  
  7. /******************************************************************************
  8.  *
  9.  * 1. Copyright Notice
  10.  *
  11.  * Some or all of this work - Copyright (c) 1999 - 2010, 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 __DTCOMPILER_H__
  117.  
  118. #ifndef _DTCOMPILER
  119. #define _DTCOMPILER
  120.  
  121. #include <stdio.h>
  122. #include "acdisasm.h"
  123.  
  124.  
  125. #undef DT_EXTERN
  126.  
  127. #ifdef _DECLARE_DT_GLOBALS
  128. #define DT_EXTERN
  129. #define DT_INIT_GLOBAL(a,b)         (a)=(b)
  130. #else
  131. #define DT_EXTERN                   extern
  132. #define DT_INIT_GLOBAL(a,b)         (a)
  133. #endif
  134.  
  135.  
  136. /* Types for individual fields (one per input line) */
  137.  
  138. #define DT_FIELD_TYPE_STRING            0
  139. #define DT_FIELD_TYPE_INTEGER           1
  140. #define DT_FIELD_TYPE_BUFFER            2
  141. #define DT_FIELD_TYPE_PCI_PATH          3
  142. #define DT_FIELD_TYPE_FLAG              4
  143. #define DT_FIELD_TYPE_FLAGS_INTEGER     5
  144. #define DT_FIELD_TYPE_INLINE_SUBTABLE   6
  145.  
  146.  
  147. /*
  148.  * Structure used for each individual field within an ACPI table
  149.  */
  150. typedef struct dt_field
  151. {
  152.     char                    *Name;
  153.     char                    *Value;
  154.     struct dt_field         *Next;
  155.     UINT32                  Line;       /* Line number for this field */
  156.     UINT32                  ByteOffset; /* Offset in source file for field */
  157.     UINT32                  NameColumn; /* Start column for field name */
  158.     UINT32                  Column;     /* Start column for field value */
  159.     UINT8                   Flags;
  160.  
  161. } DT_FIELD;
  162.  
  163. /* Flags for above */
  164.  
  165. #define DT_FIELD_NOT_ALLOCATED      1
  166.  
  167.  
  168. /*
  169.  * Structure used for individual subtables within an ACPI table
  170.  */
  171. typedef struct dt_subtable
  172. {
  173.     struct dt_subtable      *Parent;
  174.     struct dt_subtable      *Child;
  175.     struct dt_subtable      *Peer;
  176.     struct dt_subtable      *StackTop;
  177.     UINT8                   *Buffer;
  178.     UINT8                   *LengthField;
  179.     UINT32                  Length;
  180.     UINT32                  TotalLength;
  181.     UINT32                  SizeOfLengthField;
  182.     UINT8                   Flags;
  183.  
  184. } DT_SUBTABLE;
  185.  
  186.  
  187. /*
  188.  * Globals
  189.  */
  190.  
  191. /* List of all field names and values from the input source */
  192.  
  193. DT_EXTERN DT_FIELD          DT_INIT_GLOBAL (*Gbl_FieldList, NULL);
  194.  
  195. /* List of all compiled tables and subtables */
  196.  
  197. DT_EXTERN DT_SUBTABLE       DT_INIT_GLOBAL (*Gbl_RootTable, NULL);
  198.  
  199. /* Stack for subtables */
  200.  
  201. DT_EXTERN DT_SUBTABLE       DT_INIT_GLOBAL (*Gbl_SubtableStack, NULL);
  202.  
  203.  
  204. /* dtcompiler - main module */
  205.  
  206. ACPI_STATUS
  207. DtCompileTable (
  208.     DT_FIELD                **Field,
  209.     ACPI_DMTABLE_INFO       *Info,
  210.     DT_SUBTABLE             **RetSubtable,
  211.     BOOLEAN                 Required);
  212.  
  213.  
  214. /* dtio - binary and text input/output */
  215.  
  216. DT_FIELD *
  217. DtScanFile (
  218.     FILE                    *Handle);
  219.  
  220. void
  221. DtOutputBinary (
  222.     DT_SUBTABLE             *RootTable);
  223.  
  224.  
  225. /* dtsubtable - compile subtables */
  226.  
  227. void
  228. DtCreateSubtable (
  229.     UINT8                   *Buffer,
  230.     UINT32                  Length,
  231.     DT_SUBTABLE             **RetSubtable);
  232.  
  233. UINT32
  234. DtGetSubtableLength (
  235.     DT_FIELD                *Field,
  236.     ACPI_DMTABLE_INFO       *Info);
  237.  
  238. void
  239. DtSetSubtableLength (
  240.     DT_SUBTABLE             *Subtable);
  241.  
  242. void
  243. DtPushSubtable (
  244.     DT_SUBTABLE             *Subtable);
  245.  
  246. void
  247. DtPopSubtable (
  248.     void);
  249.  
  250. DT_SUBTABLE *
  251. DtPeekSubtable (
  252.     void);
  253.  
  254. void
  255. DtInsertSubtable (
  256.     DT_SUBTABLE             *ParentTable,
  257.     DT_SUBTABLE             *Subtable);
  258.  
  259. DT_SUBTABLE *
  260. DtGetNextSubtable (
  261.     DT_SUBTABLE             *ParentTable,
  262.     DT_SUBTABLE             *ChildTable);
  263.  
  264. DT_SUBTABLE *
  265. DtGetParentSubtable (
  266.     DT_SUBTABLE             *Subtable);
  267.  
  268.  
  269. /* dtfield - Compile individual fields within a table */
  270.  
  271. void
  272. DtCompileOneField (
  273.     UINT8                   *Buffer,
  274.     DT_FIELD                *Field,
  275.     UINT32                  ByteLength,
  276.     UINT8                   Type,
  277.     UINT8                   Flags);
  278.  
  279. void
  280. DtCompileInteger (
  281.     UINT8                   *Buffer,
  282.     DT_FIELD                *Field,
  283.     UINT32                  ByteLength,
  284.     UINT8                   Flags);
  285.  
  286. UINT32
  287. DtCompileBuffer (
  288.     UINT8                   *Buffer,
  289.     char                    *Value,
  290.     DT_FIELD                *Field,
  291.     UINT32                  ByteLength);
  292.  
  293. UINT32
  294. DtCompileFlag (
  295.     UINT8                   *Buffer,
  296.     DT_FIELD                *Field,
  297.     ACPI_DMTABLE_INFO       *Info,
  298.     UINT32                  BitPosition);
  299.  
  300.  
  301. /* dtutils - Miscellaneous utilities */
  302.  
  303. typedef
  304. void (*DT_WALK_CALLBACK) (
  305.     DT_SUBTABLE             *Subtable,
  306.     void                    *Context,
  307.     void                    *ReturnValue);
  308.  
  309. void
  310. DtWalkTableTree (
  311.     DT_SUBTABLE             *StartTable,
  312.     DT_WALK_CALLBACK        UserFunction,
  313.     void                    *Context,
  314.     void                    *ReturnValue);
  315.  
  316. void
  317. DtError (
  318.     UINT8                   Level,
  319.     UINT8                   MessageId,
  320.     DT_FIELD                *FieldObject,
  321.     char                    *ExtraMessage);
  322.  
  323. void
  324. DtNameError (
  325.     UINT8                   Level,
  326.     UINT8                   MessageId,
  327.     DT_FIELD                *FieldObject,
  328.     char                    *ExtraMessage);
  329.  
  330. void
  331. DtFatal (
  332.     UINT8                   MessageId,
  333.     DT_FIELD                *FieldObject,
  334.     char                    *ExtraMessage);
  335.  
  336. ACPI_STATUS
  337. DtStrtoul64 (
  338.     char                    *String,
  339.     UINT64                  *ReturnInteger);
  340.  
  341. UINT32
  342. DtGetFileSize (
  343.     FILE                    *Handle);
  344.  
  345. char*
  346. DtGetFieldValue (
  347.     DT_FIELD                *Field,
  348.     char                    *Name);
  349.  
  350. UINT8
  351. DtGetFieldType (
  352.     ACPI_DMTABLE_INFO       *Info);
  353.  
  354. UINT32
  355. DtGetBufferLength (
  356.     char                    *Buffer);
  357.  
  358. UINT32
  359. DtGetFieldLength (
  360.     DT_FIELD                *Field,
  361.     ACPI_DMTABLE_INFO       *Info);
  362.  
  363. void
  364. DtSetTableChecksum (
  365.     UINT8                   *ChecksumPointer);
  366.  
  367. void
  368. DtSetTableLength(
  369.     void);
  370.  
  371. void
  372. DtFreeFieldList (
  373.     void);
  374.  
  375.  
  376. /* dttable - individual table compilation */
  377.  
  378. ACPI_STATUS
  379. DtCompileFacs (
  380.     DT_FIELD                **PFieldList);
  381.  
  382. ACPI_STATUS
  383. DtCompileRsdp (
  384.     DT_FIELD                **PFieldList);
  385.  
  386. ACPI_STATUS
  387. DtCompileAsf (
  388.     void                    **PFieldList);
  389.  
  390. ACPI_STATUS
  391. DtCompileCpep (
  392.     void                    **PFieldList);
  393.  
  394. ACPI_STATUS
  395. DtCompileDmar (
  396.     void                    **PFieldList);
  397.  
  398. ACPI_STATUS
  399. DtCompileEinj (
  400.     void                    **PFieldList);
  401.  
  402. ACPI_STATUS
  403. DtCompileErst (
  404.     void                    **PFieldList);
  405.  
  406. ACPI_STATUS
  407. DtCompileFadt (
  408.     void                    **PFieldList);
  409.  
  410. ACPI_STATUS
  411. DtCompileHest (
  412.     void                    **PFieldList);
  413.  
  414. ACPI_STATUS
  415. DtCompileIvrs (
  416.     void                    **PFieldList);
  417.  
  418. ACPI_STATUS
  419. DtCompileMadt (
  420.     void                    **PFieldList);
  421.  
  422. ACPI_STATUS
  423. DtCompileMcfg (
  424.     void                    **PFieldList);
  425.  
  426. ACPI_STATUS
  427. DtCompileMsct (
  428.     void                    **PFieldList);
  429.  
  430. ACPI_STATUS
  431. DtCompileRsdt (
  432.     void                    **PFieldList);
  433.  
  434. ACPI_STATUS
  435. DtCompileSlit (
  436.     void                    **PFieldList);
  437.  
  438. ACPI_STATUS
  439. DtCompileSrat (
  440.     void                    **PFieldList);
  441.  
  442. ACPI_STATUS
  443. DtCompileWdat (
  444.     void                    **PFieldList);
  445.  
  446. ACPI_STATUS
  447. DtCompileXsdt (
  448.     void                    **PFieldList);
  449.  
  450.  
  451. /* Debug */
  452.  
  453. #define MYDEBUG         printf
  454.  
  455. #endif
  456.