1 /******************************************************************************
2  *
3  * Module Name: acpihelp.h - Include file for AcpiHelp 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 __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 #include <string.h>
58 #ifdef WIN32
59 #include <io.h>
60 #include <direct.h>
61 #endif
62 #include <errno.h>
63 
64 
65 #define     AH_DECODE_DEFAULT           0
66 #define     AH_DECODE_ASL               1
67 #define     AH_DECODE_ASL_KEYWORD       2
68 #define     AH_DECODE_PREDEFINED_NAME   3
69 #define     AH_DECODE_AML               4
70 #define     AH_DECODE_AML_OPCODE        5
71 #define     AH_DISPLAY_DEVICE_IDS       6
72 #define     AH_DECODE_EXCEPTION         7
73 #define     AH_DECODE_ASL_AML           8
74 #define     AH_DISPLAY_UUIDS            9
75 
76 #define     AH_MAX_ASL_LINE_LENGTH      70
77 #define     AH_MAX_AML_LINE_LENGTH      100
78 
79 
80 typedef struct ah_aml_opcode
81 {
82     UINT16          OpcodeRangeStart;
83     UINT16          OpcodeRangeEnd;
84     char            *OpcodeString;
85     char            *OpcodeName;
86     char            *Type;
87     char            *FixedArguments;
88     char            *VariableArguments;
89     char            *Grammar;
90 
91 } AH_AML_OPCODE;
92 
93 typedef struct ah_asl_operator
94 {
95     char            *Name;
96     char            *Syntax;
97     char            *Description;
98 
99 } AH_ASL_OPERATOR;
100 
101 typedef struct ah_asl_keyword
102 {
103     char            *Name;
104     char            *Description;
105     char            *KeywordList;
106 
107 } AH_ASL_KEYWORD;
108 
109 
110 extern const AH_AML_OPCODE          AmlOpcodeInfo[];
111 extern const AH_ASL_OPERATOR        AslOperatorInfo[];
112 extern const AH_ASL_KEYWORD         AslKeywordInfo[];
113 extern const AH_UUID                AcpiUuids[];
114 extern BOOLEAN                      AhDisplayAll;
115 
116 void
117 AhStrupr (
118     char                    *SrcString);
119 
120 void
121 AhFindAmlOpcode (
122     char                    *Name);
123 
124 void
125 AhDecodeAmlOpcode (
126     char                    *Name);
127 
128 void
129 AhDecodeException (
130     char                    *Name);
131 
132 void
133 AhFindPredefinedNames (
134     char                    *Name);
135 
136 void
137 AhFindAslAndAmlOperators (
138     char                    *Name);
139 
140 UINT32
141 AhFindAslOperators (
142     char                    *Name);
143 
144 void
145 AhFindAslKeywords (
146     char                    *Name);
147 
148 void
149 AhDisplayDeviceIds (
150     char                    *Name);
151 
152 void
153 AhDisplayUuids (
154     void);
155 
156 #endif /* __ACPIHELP_H */
157