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