Home | History | Annotate | Line # | Download | only in acpiexec
aecommon.h revision 1.1.1.5
      1 /******************************************************************************
      2  *
      3  * Module Name: aecommon - common include for the AcpiExec utility
      4  *
      5  *****************************************************************************/
      6 
      7 /*
      8  * Copyright (C) 2000 - 2015, Intel Corp.
      9  * All rights reserved.
     10  *
     11  * Redistribution and use in source and binary forms, with or without
     12  * modification, are permitted provided that the following conditions
     13  * are met:
     14  * 1. Redistributions of source code must retain the above copyright
     15  *    notice, this list of conditions, and the following disclaimer,
     16  *    without modification.
     17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
     18  *    substantially similar to the "NO WARRANTY" disclaimer below
     19  *    ("Disclaimer") and any redistribution must be conditioned upon
     20  *    including a substantially similar Disclaimer requirement for further
     21  *    binary redistribution.
     22  * 3. Neither the names of the above-listed copyright holders nor the names
     23  *    of any contributors may be used to endorse or promote products derived
     24  *    from this software without specific prior written permission.
     25  *
     26  * Alternatively, this software may be distributed under the terms of the
     27  * GNU General Public License ("GPL") version 2 as published by the Free
     28  * Software Foundation.
     29  *
     30  * NO WARRANTY
     31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
     34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
     39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
     40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     41  * POSSIBILITY OF SUCH DAMAGES.
     42  */
     43 
     44 #ifndef _AECOMMON
     45 #define _AECOMMON
     46 
     47 #ifdef _MSC_VER                 /* disable some level-4 warnings */
     48 #pragma warning(disable:4100)   /* warning C4100: unreferenced formal parameter */
     49 #endif
     50 
     51 #include "acpi.h"
     52 #include "accommon.h"
     53 #include "acparser.h"
     54 #include "amlcode.h"
     55 #include "acnamesp.h"
     56 #include "acdebug.h"
     57 #include "actables.h"
     58 #include "acinterp.h"
     59 #include "amlresrc.h"
     60 #include "acapps.h"
     61 
     62 #include <stdio.h>
     63 #include <stdlib.h>
     64 #include <string.h>
     65 #include <signal.h>
     66 
     67 extern BOOLEAN              AcpiGbl_IgnoreErrors;
     68 extern UINT8                AcpiGbl_RegionFillValue;
     69 extern UINT8                AcpiGbl_UseHwReducedFadt;
     70 extern BOOLEAN              AcpiGbl_DisplayRegionAccess;
     71 extern BOOLEAN              AcpiGbl_DoInterfaceTests;
     72 extern BOOLEAN              AcpiGbl_LoadTestTables;
     73 extern FILE                 *AcpiGbl_NamespaceInitFile;
     74 extern ACPI_CONNECTION_INFO AeMyContext;
     75 
     76 /* Check for unexpected exceptions */
     77 
     78 #define AE_CHECK_STATUS(Name, Status, Expected) \
     79     if (Status != Expected) \
     80     { \
     81         AcpiOsPrintf ("Unexpected %s from %s (%s-%d)\n", \
     82             AcpiFormatException (Status), #Name, _AcpiModuleName, __LINE__); \
     83     }
     84 
     85 /* Check for unexpected non-AE_OK errors */
     86 
     87 #define AE_CHECK_OK(Name, Status)   AE_CHECK_STATUS (Name, Status, AE_OK);
     88 
     89 typedef struct ae_table_desc
     90 {
     91     ACPI_TABLE_HEADER       *Table;
     92     struct ae_table_desc    *Next;
     93 
     94 } AE_TABLE_DESC;
     95 
     96 /*
     97  * Debug Regions
     98  */
     99 typedef struct ae_region
    100 {
    101     ACPI_PHYSICAL_ADDRESS   Address;
    102     UINT32                  Length;
    103     void                    *Buffer;
    104     void                    *NextRegion;
    105     UINT8                   SpaceId;
    106 
    107 } AE_REGION;
    108 
    109 typedef struct ae_debug_regions
    110 {
    111     UINT32                  NumberOfRegions;
    112     AE_REGION               *RegionList;
    113 
    114 } AE_DEBUG_REGIONS;
    115 
    116 
    117 #define TEST_OUTPUT_LEVEL(lvl)          if ((lvl) & OutputLevel)
    118 
    119 #define OSD_PRINT(lvl,fp)               TEST_OUTPUT_LEVEL(lvl) {\
    120                                             AcpiOsPrintf PARAM_LIST(fp);}
    121 
    122 void ACPI_SYSTEM_XFACE
    123 AeCtrlCHandler (
    124     int                     Sig);
    125 
    126 ACPI_STATUS
    127 AeBuildLocalTables (
    128     UINT32                  TableCount,
    129     AE_TABLE_DESC           *TableList);
    130 
    131 ACPI_STATUS
    132 AeInstallTables (
    133     void);
    134 
    135 void
    136 AeDumpNamespace (
    137     void);
    138 
    139 void
    140 AeDumpObject (
    141     char                    *MethodName,
    142     ACPI_BUFFER             *ReturnObj);
    143 
    144 void
    145 AeDumpBuffer (
    146     UINT32                  Address);
    147 
    148 void
    149 AeExecute (
    150     char                    *Name);
    151 
    152 void
    153 AeSetScope (
    154     char                    *Name);
    155 
    156 void
    157 AeCloseDebugFile (
    158     void);
    159 
    160 void
    161 AeOpenDebugFile (
    162     char                    *Name);
    163 
    164 ACPI_STATUS
    165 AeDisplayAllMethods (
    166     UINT32                  DisplayCount);
    167 
    168 ACPI_STATUS
    169 AeInstallEarlyHandlers (
    170     void);
    171 
    172 ACPI_STATUS
    173 AeInstallLateHandlers (
    174     void);
    175 
    176 void
    177 AeMiscellaneousTests (
    178     void);
    179 
    180 ACPI_STATUS
    181 AeRegionHandler (
    182     UINT32                  Function,
    183     ACPI_PHYSICAL_ADDRESS   Address,
    184     UINT32                  BitWidth,
    185     UINT64                  *Value,
    186     void                    *HandlerContext,
    187     void                    *RegionContext);
    188 
    189 UINT32
    190 AeGpeHandler (
    191     ACPI_HANDLE             GpeDevice,
    192     UINT32                  GpeNumber,
    193     void                    *Context);
    194 
    195 void
    196 AeGlobalEventHandler (
    197     UINT32                  Type,
    198     ACPI_HANDLE             GpeDevice,
    199     UINT32                  EventNumber,
    200     void                    *Context);
    201 
    202 /* aeregion */
    203 
    204 ACPI_STATUS
    205 AeInstallDeviceHandlers (
    206     void);
    207 
    208 void
    209 AeInstallRegionHandlers (
    210     void);
    211 
    212 void
    213 AeOverrideRegionHandlers (
    214     void);
    215 
    216 
    217 /* aeinitfile */
    218 
    219 int
    220 AeOpenInitializationFile (
    221     char                    *Filename);
    222 
    223 void
    224 AeDoObjectOverrides (
    225     void);
    226 
    227 #endif /* _AECOMMON */
    228