Home | History | Annotate | Line # | Download | only in acpiexec
aecommon.h revision 1.1.1.11
      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 extern BOOLEAN              AcpiGbl_IgnoreErrors;
     85 extern BOOLEAN              AcpiGbl_AbortLoopOnTimeout;
     86 extern UINT8                AcpiGbl_RegionFillValue;
     87 extern UINT8                AcpiGbl_UseHwReducedFadt;
     88 extern BOOLEAN              AcpiGbl_DisplayRegionAccess;
     89 extern BOOLEAN              AcpiGbl_DoInterfaceTests;
     90 extern BOOLEAN              AcpiGbl_LoadTestTables;
     91 extern FILE                 *AcpiGbl_NamespaceInitFile;
     92 extern ACPI_CONNECTION_INFO AeMyContext;
     93 
     94 extern UINT8                Ssdt2Code[];
     95 extern UINT8                Ssdt3Code[];
     96 extern UINT8                Ssdt4Code[];
     97 
     98 
     99 #define TEST_OUTPUT_LEVEL(lvl)          if ((lvl) & OutputLevel)
    100 
    101 #define OSD_PRINT(lvl,fp)               TEST_OUTPUT_LEVEL(lvl) {\
    102                                             AcpiOsPrintf PARAM_LIST(fp);}
    103 
    104 #define AE_PREFIX                       "ACPI Exec: "
    105 
    106 void ACPI_SYSTEM_XFACE
    107 AeSignalHandler (
    108     int                     Sig);
    109 
    110 ACPI_STATUS
    111 AeExceptionHandler (
    112     ACPI_STATUS             AmlStatus,
    113     ACPI_NAME               Name,
    114     UINT16                  Opcode,
    115     UINT32                  AmlOffset,
    116     void                    *Context);
    117 
    118 ACPI_STATUS
    119 AeBuildLocalTables (
    120     ACPI_NEW_TABLE_DESC     *TableList);
    121 
    122 ACPI_STATUS
    123 AeInstallTables (
    124     void);
    125 
    126 ACPI_STATUS
    127 AeLoadTables (
    128     void);
    129 
    130 void
    131 AeDumpNamespace (
    132     void);
    133 
    134 void
    135 AeDumpObject (
    136     char                    *MethodName,
    137     ACPI_BUFFER             *ReturnObj);
    138 
    139 void
    140 AeDumpBuffer (
    141     UINT32                  Address);
    142 
    143 void
    144 AeExecute (
    145     char                    *Name);
    146 
    147 void
    148 AeSetScope (
    149     char                    *Name);
    150 
    151 void
    152 AeCloseDebugFile (
    153     void);
    154 
    155 void
    156 AeOpenDebugFile (
    157     char                    *Name);
    158 
    159 ACPI_STATUS
    160 AeDisplayAllMethods (
    161     UINT32                  DisplayCount);
    162 
    163 /* aetests */
    164 
    165 void
    166 AeMiscellaneousTests (
    167     void);
    168 
    169 /* aeregion */
    170 
    171 ACPI_STATUS
    172 AeRegionHandler (
    173     UINT32                  Function,
    174     ACPI_PHYSICAL_ADDRESS   Address,
    175     UINT32                  BitWidth,
    176     UINT64                  *Value,
    177     void                    *HandlerContext,
    178     void                    *RegionContext);
    179 
    180 /* aeinstall */
    181 
    182 ACPI_STATUS
    183 AeInstallDeviceHandlers (
    184     void);
    185 
    186 void
    187 AeInstallRegionHandlers (
    188     void);
    189 
    190 void
    191 AeOverrideRegionHandlers (
    192     void);
    193 
    194 /* aehandlers */
    195 
    196 ACPI_STATUS
    197 AeInstallEarlyHandlers (
    198     void);
    199 
    200 ACPI_STATUS
    201 AeInstallLateHandlers (
    202     void);
    203 
    204 UINT32
    205 AeGpeHandler (
    206     ACPI_HANDLE             GpeDevice,
    207     UINT32                  GpeNumber,
    208     void                    *Context);
    209 
    210 void
    211 AeGlobalEventHandler (
    212     UINT32                  Type,
    213     ACPI_HANDLE             GpeDevice,
    214     UINT32                  EventNumber,
    215     void                    *Context);
    216 
    217 /* aeinitfile */
    218 
    219 int
    220 AeOpenInitializationFile (
    221     char                    *Filename);
    222 
    223 void
    224 AeDoObjectOverrides (
    225     void);
    226 
    227 ACPI_STATUS
    228 AeSetupConfiguration (
    229     void                    *RegionAddr);
    230 
    231 /* aeexec */
    232 
    233 void
    234 AeTestBufferArgument (
    235     void);
    236 
    237 void
    238 AeTestPackageArgument (
    239     void);
    240 
    241 ACPI_STATUS
    242 AeGetDevices (
    243     ACPI_HANDLE             ObjHandle,
    244     UINT32                  NestingLevel,
    245     void                    *Context,
    246     void                    **ReturnValue);
    247 
    248 ACPI_STATUS
    249 ExecuteOSI (
    250     char                    *OsiString,
    251     UINT64                  ExpectedResult);
    252 
    253 void
    254 AeGenericRegisters (
    255     void);
    256 
    257 #if (!ACPI_REDUCED_HARDWARE)
    258 void
    259 AfInstallGpeBlock (
    260     void);
    261 #endif /* !ACPI_REDUCED_HARDWARE */
    262 
    263 #endif /* _AECOMMON */
    264