Home | History | Annotate | Line # | Download | only in acpiexec
aecommon.h revision 1.1.1.13
      1 /******************************************************************************
      2  *
      3  * Module Name: aecommon - common include for the AcpiExec utility
      4  *
      5  *****************************************************************************/
      6 
      7 /*
      8  * Copyright (C) 2000 - 2018, 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 
     63 /*
     64  * Debug Regions
     65  */
     66 typedef struct ae_region
     67 {
     68     ACPI_PHYSICAL_ADDRESS   Address;
     69     UINT32                  Length;
     70     void                    *Buffer;
     71     void                    *NextRegion;
     72     UINT8                   SpaceId;
     73 
     74 } AE_REGION;
     75 
     76 typedef struct ae_debug_regions
     77 {
     78     UINT32                  NumberOfRegions;
     79     AE_REGION               *RegionList;
     80 
     81 } AE_DEBUG_REGIONS;
     82 
     83 
     84 /*
     85  * Init file entry
     86  */
     87 typedef struct init_file_entry
     88 {
     89     char                    *Name;
     90     UINT64                  Value;
     91 } INIT_FILE_ENTRY;
     92 
     93 extern BOOLEAN              AcpiGbl_UseLocalFaultHandler;
     94 extern BOOLEAN              AcpiGbl_VerboseHandlers;
     95 extern BOOLEAN              AcpiGbl_IgnoreErrors;
     96 extern BOOLEAN              AcpiGbl_AbortLoopOnTimeout;
     97 extern UINT8                AcpiGbl_RegionFillValue;
     98 extern INIT_FILE_ENTRY      *AcpiGbl_InitEntries;
     99 extern UINT32               AcpiGbl_InitFileLineCount;
    100 extern UINT8                AcpiGbl_UseHwReducedFadt;
    101 extern BOOLEAN              AcpiGbl_DisplayRegionAccess;
    102 extern BOOLEAN              AcpiGbl_DoInterfaceTests;
    103 extern BOOLEAN              AcpiGbl_LoadTestTables;
    104 extern FILE                 *AcpiGbl_NamespaceInitFile;
    105 extern ACPI_CONNECTION_INFO AeMyContext;
    106 
    107 extern UINT8                Ssdt2Code[];
    108 extern UINT8                Ssdt3Code[];
    109 extern UINT8                Ssdt4Code[];
    110 
    111 
    112 #define TEST_OUTPUT_LEVEL(lvl)          if ((lvl) & OutputLevel)
    113 
    114 #define OSD_PRINT(lvl,fp)               TEST_OUTPUT_LEVEL(lvl) {\
    115                                             AcpiOsPrintf PARAM_LIST(fp);}
    116 
    117 #define AE_PREFIX                       "ACPI Exec: "
    118 
    119 void ACPI_SYSTEM_XFACE
    120 AeSignalHandler (
    121     int                     Sig);
    122 
    123 ACPI_STATUS
    124 AeExceptionHandler (
    125     ACPI_STATUS             AmlStatus,
    126     ACPI_NAME               Name,
    127     UINT16                  Opcode,
    128     UINT32                  AmlOffset,
    129     void                    *Context);
    130 
    131 ACPI_STATUS
    132 AeBuildLocalTables (
    133     ACPI_NEW_TABLE_DESC     *TableList);
    134 
    135 ACPI_STATUS
    136 AeInstallTables (
    137     void);
    138 
    139 ACPI_STATUS
    140 AeLoadTables (
    141     void);
    142 
    143 void
    144 AeDumpNamespace (
    145     void);
    146 
    147 void
    148 AeDumpObject (
    149     char                    *MethodName,
    150     ACPI_BUFFER             *ReturnObj);
    151 
    152 void
    153 AeDumpBuffer (
    154     UINT32                  Address);
    155 
    156 void
    157 AeExecute (
    158     char                    *Name);
    159 
    160 void
    161 AeSetScope (
    162     char                    *Name);
    163 
    164 void
    165 AeCloseDebugFile (
    166     void);
    167 
    168 void
    169 AeOpenDebugFile (
    170     char                    *Name);
    171 
    172 ACPI_STATUS
    173 AeDisplayAllMethods (
    174     UINT32                  DisplayCount);
    175 
    176 /* aetests */
    177 
    178 void
    179 AeMiscellaneousTests (
    180     void);
    181 
    182 /* aeregion */
    183 
    184 ACPI_STATUS
    185 AeRegionHandler (
    186     UINT32                  Function,
    187     ACPI_PHYSICAL_ADDRESS   Address,
    188     UINT32                  BitWidth,
    189     UINT64                  *Value,
    190     void                    *HandlerContext,
    191     void                    *RegionContext);
    192 
    193 /* aeinstall */
    194 
    195 ACPI_STATUS
    196 AeInstallDeviceHandlers (
    197     void);
    198 
    199 void
    200 AeInstallRegionHandlers (
    201     void);
    202 
    203 void
    204 AeOverrideRegionHandlers (
    205     void);
    206 
    207 /* aehandlers */
    208 
    209 ACPI_STATUS
    210 AeInstallEarlyHandlers (
    211     void);
    212 
    213 ACPI_STATUS
    214 AeInstallLateHandlers (
    215     void);
    216 
    217 UINT32
    218 AeGpeHandler (
    219     ACPI_HANDLE             GpeDevice,
    220     UINT32                  GpeNumber,
    221     void                    *Context);
    222 
    223 void
    224 AeGlobalEventHandler (
    225     UINT32                  Type,
    226     ACPI_HANDLE             GpeDevice,
    227     UINT32                  EventNumber,
    228     void                    *Context);
    229 
    230 /* aeinitfile */
    231 
    232 int
    233 AeOpenInitializationFile (
    234     char                    *Filename);
    235 
    236 void
    237 AeProcessInitFile (
    238     void);
    239 
    240 ACPI_STATUS
    241 AeSetupConfiguration (
    242     void                    *RegionAddr);
    243 
    244 ACPI_STATUS
    245 AeLookupInitFileEntry (
    246     char                    *Pathname,
    247     UINT64                  *Value);
    248 
    249 /* aeexec */
    250 
    251 void
    252 AeTestBufferArgument (
    253     void);
    254 
    255 void
    256 AeTestPackageArgument (
    257     void);
    258 
    259 ACPI_STATUS
    260 AeGetDevices (
    261     ACPI_HANDLE             ObjHandle,
    262     UINT32                  NestingLevel,
    263     void                    *Context,
    264     void                    **ReturnValue);
    265 
    266 ACPI_STATUS
    267 ExecuteOSI (
    268     char                    *OsiString,
    269     UINT64                  ExpectedResult);
    270 
    271 void
    272 AeGenericRegisters (
    273     void);
    274 
    275 #if (!ACPI_REDUCED_HARDWARE)
    276 void
    277 AfInstallGpeBlock (
    278     void);
    279 #endif /* !ACPI_REDUCED_HARDWARE */
    280 
    281 #endif /* _AECOMMON */
    282