Home | History | Annotate | Line # | Download | only in acpihelp
acpihelp.h revision 1.1 
      1 /******************************************************************************
      2  *
      3  * Module Name: acpihelp.h - Include file for AcpiHelp 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 __ACPIHELP_H
     45 #define __ACPIHELP_H
     46 
     47 
     48 #include "acpi.h"
     49 #include "accommon.h"
     50 #include "acapps.h"
     51 
     52 #include <stdio.h>
     53 #include <sys/stat.h>
     54 #include <sys/types.h>
     55 #include <fcntl.h>
     56 #include <ctype.h>
     57 #ifdef WIN32
     58 #include <io.h>
     59 #include <direct.h>
     60 #endif
     61 #include <errno.h>
     62 
     63 
     64 #define     AH_DECODE_DEFAULT           0
     65 #define     AH_DECODE_ASL               1
     66 #define     AH_DECODE_ASL_KEYWORD       2
     67 #define     AH_DECODE_PREDEFINED_NAME   3
     68 #define     AH_DECODE_AML               4
     69 #define     AH_DECODE_AML_OPCODE        5
     70 
     71 #define     AH_MAX_ASL_LINE_LENGTH      70
     72 #define     AH_MAX_AML_LINE_LENGTH      100
     73 
     74 
     75 typedef struct ah_aml_opcode
     76 {
     77     UINT16          OpcodeRangeStart;
     78     UINT16          OpcodeRangeEnd;
     79     char            *OpcodeString;
     80     char            *OpcodeName;
     81     char            *Type;
     82     char            *FixedArguments;
     83     char            *VariableArguments;
     84     char            *Grammar;
     85 
     86 } AH_AML_OPCODE;
     87 
     88 typedef struct ah_asl_operator
     89 {
     90     char            *Name;
     91     char            *Syntax;
     92     char            *Description;
     93 
     94 } AH_ASL_OPERATOR;
     95 
     96 typedef struct ah_asl_keyword
     97 {
     98     char            *Name;
     99     char            *Description;
    100     char            *KeywordList;
    101 
    102 } AH_ASL_KEYWORD;
    103 
    104 typedef struct ah_predefined_name
    105 {
    106     char            *Name;
    107     char            *Description;
    108     char            *Action;
    109 
    110 } AH_PREDEFINED_NAME;
    111 
    112 
    113 extern const AH_AML_OPCODE          AmlOpcodeInfo[];
    114 extern const AH_ASL_OPERATOR        AslOperatorInfo[];
    115 extern const AH_ASL_KEYWORD         AslKeywordInfo[];
    116 extern const AH_PREDEFINED_NAME     AslPredefinedInfo[];
    117 extern BOOLEAN                      AhDisplayAll;
    118 
    119 void
    120 AhStrupr (
    121     char                    *SrcString);
    122 
    123 void
    124 AhFindAmlOpcode (
    125     char                    *Name);
    126 
    127 void
    128 AhDecodeAmlOpcode (
    129     char                    *Name);
    130 
    131 void
    132 AhFindPredefinedNames (
    133     char                    *Name);
    134 
    135 void
    136 AhFindAslOperators (
    137     char                    *Name);
    138 
    139 void
    140 AhFindAslKeywords (
    141     char                    *Name);
    142 
    143 #endif /* __ACPIHELP_H */
    144