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