sys/contrib/dev/acpica/source/tools/acpiexec/aecommon.h

   1 /******************************************************************************
   2  *
   3  * Module Name: aecommon - common include for the AcpiExec utility
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2014, 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 "acapps.h"
  60
  61 #include <stdio.h>
  62 #include <stdlib.h>
  63 #include <string.h>
  64 #include <signal.h>
  65
  66 #pragma pack(push) /* Set default struct packing */
  67
  68 extern BOOLEAN              AcpiGbl_IgnoreErrors;
  69 extern UINT8                AcpiGbl_RegionFillValue;
  70 extern UINT8                AcpiGbl_UseHwReducedFadt;
  71 extern BOOLEAN              AcpiGbl_DisplayRegionAccess;
  72 extern BOOLEAN              AcpiGbl_DoInterfaceTests;
  73 extern BOOLEAN              AcpiGbl_LoadTestTables;
  74
  75 /* Check for unexpected exceptions */
  76
  77 #define AE_CHECK_STATUS(Name, Status, Expected) \
  78     if (Status != Expected) \
  79     { \
  80         AcpiOsPrintf ("Unexpected %s from %s (%s-%d)\n", \
  81             AcpiFormatException (Status), #Name, _AcpiModuleName, __LINE__); \
  82     }
  83
  84 /* Check for unexpected non-AE_OK errors */
  85
  86 #define AE_CHECK_OK(Name, Status)   AE_CHECK_STATUS (Name, Status, AE_OK);
  87
  88 typedef struct ae_table_desc
  89 {
  90     ACPI_TABLE_HEADER       *Table;
  91     struct ae_table_desc    *Next;
  92
  93 } AE_TABLE_DESC;
  94
  95 /*
  96  * Debug Regions
  97  */
  98 typedef struct ae_region
  99 {
 100     ACPI_PHYSICAL_ADDRESS   Address;
 101     UINT32                  Length;
 102     void                    *Buffer;
 103     void                    *NextRegion;
 104     UINT8                   SpaceId;
 105
 106 } AE_REGION;
 107
 108 typedef struct ae_debug_regions
 109 {
 110     UINT32                  NumberOfRegions;
 111     AE_REGION               *RegionList;
 112
 113 } AE_DEBUG_REGIONS;
 114
 115
 116 #define TEST_OUTPUT_LEVEL(lvl)          if ((lvl) & OutputLevel)
 117
 118 #define OSD_PRINT(lvl,fp)               TEST_OUTPUT_LEVEL(lvl) {\
 119                                             AcpiOsPrintf PARAM_LIST(fp);}
 120
 121 void ACPI_SYSTEM_XFACE
 122 AeCtrlCHandler (
 123     int                     Sig);
 124
 125 ACPI_STATUS
 126 AeBuildLocalTables (
 127     UINT32                  TableCount,
 128     AE_TABLE_DESC           *TableList);
 129
 130 ACPI_STATUS
 131 AeInstallTables (
 132     void);
 133
 134 void
 135 AeDumpNamespace (
 136     void);
 137
 138 void
 139 AeDumpObject (
 140     char                    *MethodName,
 141     ACPI_BUFFER             *ReturnObj);
 142
 143 void
 144 AeDumpBuffer (
 145     UINT32                  Address);
 146
 147 void
 148 AeExecute (
 149     char                    *Name);
 150
 151 void
 152 AeSetScope (
 153     char                    *Name);
 154
 155 void
 156 AeCloseDebugFile (
 157     void);
 158
 159 void
 160 AeOpenDebugFile (
 161     char                    *Name);
 162
 163 ACPI_STATUS
 164 AeDisplayAllMethods (
 165     UINT32                  DisplayCount);
 166
 167 ACPI_STATUS
 168 AeInstallEarlyHandlers (
 169     void);
 170
 171 ACPI_STATUS
 172 AeInstallLateHandlers (
 173     void);
 174
 175 void
 176 AeMiscellaneousTests (
 177     void);
 178
 179 ACPI_STATUS
 180 AeRegionHandler (
 181     UINT32                  Function,
 182     ACPI_PHYSICAL_ADDRESS   Address,
 183     UINT32                  BitWidth,
 184     UINT64                  *Value,
 185     void                    *HandlerContext,
 186     void                    *RegionContext);
 187
 188 UINT32
 189 AeGpeHandler (
 190     ACPI_HANDLE             GpeDevice,
 191     UINT32                  GpeNumber,
 192     void                    *Context);
 193
 194 void
 195 AeGlobalEventHandler (
 196     UINT32                  Type,
 197     ACPI_HANDLE             GpeDevice,
 198     UINT32                  EventNumber,
 199     void                    *Context);
 200
 201
 202 #pragma pack(pop) /* Restore original struct packing */
 203
 204 #endif /* _AECOMMON */