Home | History | Annotate | Line # | Download | only in acpiexec
aecommon.h revision 1.1.1.9
      1 /******************************************************************************
      2  *
      3  * Module Name: aecommon - common include for the AcpiExec utility
      4  *
      5  *****************************************************************************/
      6 
      7 /*
      8  * Copyright (C) 2000 - 2017, 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 UINT8                AcpiGbl_RegionFillValue;
     86 extern UINT8                AcpiGbl_UseHwReducedFadt;
     87 extern BOOLEAN              AcpiGbl_DisplayRegionAccess;
     88 extern BOOLEAN              AcpiGbl_DoInterfaceTests;
     89 extern BOOLEAN              AcpiGbl_LoadTestTables;
     90 extern FILE                 *AcpiGbl_NamespaceInitFile;
     91 extern ACPI_CONNECTION_INFO AeMyContext;
     92 
     93 
     94 #define TEST_OUTPUT_LEVEL(lvl)          if ((lvl) & OutputLevel)
     95 
     96 #define OSD_PRINT(lvl,fp)               TEST_OUTPUT_LEVEL(lvl) {\
     97                                             AcpiOsPrintf PARAM_LIST(fp);}
     98 
     99 #define AE_PREFIX                       "ACPI Exec: "
    100 
    101 void ACPI_SYSTEM_XFACE
    102 AeSignalHandler (
    103     int                     Sig);
    104 
    105 ACPI_STATUS
    106 AeExceptionHandler (
    107     ACPI_STATUS             AmlStatus,
    108     ACPI_NAME               Name,
    109     UINT16                  Opcode,
    110     UINT32                  AmlOffset,
    111     void                    *Context);
    112 
    113 ACPI_STATUS
    114 AeBuildLocalTables (
    115     ACPI_NEW_TABLE_DESC     *TableList);
    116 
    117 ACPI_STATUS
    118 AeInstallTables (
    119     void);
    120 
    121 ACPI_STATUS
    122 AeLoadTables (
    123     void);
    124 
    125 void
    126 AeDumpNamespace (
    127     void);
    128 
    129 void
    130 AeDumpObject (
    131     char                    *MethodName,
    132     ACPI_BUFFER             *ReturnObj);
    133 
    134 void
    135 AeDumpBuffer (
    136     UINT32                  Address);
    137 
    138 void
    139 AeExecute (
    140     char                    *Name);
    141 
    142 void
    143 AeSetScope (
    144     char                    *Name);
    145 
    146 void
    147 AeCloseDebugFile (
    148     void);
    149 
    150 void
    151 AeOpenDebugFile (
    152     char                    *Name);
    153 
    154 ACPI_STATUS
    155 AeDisplayAllMethods (
    156     UINT32                  DisplayCount);
    157 
    158 ACPI_STATUS
    159 AeInstallEarlyHandlers (
    160     void);
    161 
    162 ACPI_STATUS
    163 AeInstallLateHandlers (
    164     void);
    165 
    166 void
    167 AeMiscellaneousTests (
    168     void);
    169 
    170 ACPI_STATUS
    171 AeRegionHandler (
    172     UINT32                  Function,
    173     ACPI_PHYSICAL_ADDRESS   Address,
    174     UINT32                  BitWidth,
    175     UINT64                  *Value,
    176     void                    *HandlerContext,
    177     void                    *RegionContext);
    178 
    179 UINT32
    180 AeGpeHandler (
    181     ACPI_HANDLE             GpeDevice,
    182     UINT32                  GpeNumber,
    183     void                    *Context);
    184 
    185 void
    186 AeGlobalEventHandler (
    187     UINT32                  Type,
    188     ACPI_HANDLE             GpeDevice,
    189     UINT32                  EventNumber,
    190     void                    *Context);
    191 
    192 /* aeregion */
    193 
    194 ACPI_STATUS
    195 AeInstallDeviceHandlers (
    196     void);
    197 
    198 void
    199 AeInstallRegionHandlers (
    200     void);
    201 
    202 void
    203 AeOverrideRegionHandlers (
    204     void);
    205 
    206 
    207 /* aeinitfile */
    208 
    209 int
    210 AeOpenInitializationFile (
    211     char                    *Filename);
    212 
    213 void
    214 AeDoObjectOverrides (
    215     void);
    216 
    217 #endif /* _AECOMMON */
    218