1 /******************************************************************************
2 *
3 * Module Name: acpihelp.h - Include file for AcpiHelp utility
4 *
5 *****************************************************************************/
6
7 /*
8 * Copyright (C) 2000 - 2013, 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
74 #define AH_MAX_ASL_LINE_LENGTH 70
75 #define AH_MAX_AML_LINE_LENGTH 100
76
77
78 typedef struct ah_aml_opcode
79 {
80 UINT16 OpcodeRangeStart;
81 UINT16 OpcodeRangeEnd;
82 char *OpcodeString;
83 char *OpcodeName;
84 char *Type;
85 char *FixedArguments;
86 char *VariableArguments;
87 char *Grammar;
88
89 } AH_AML_OPCODE;
90
91 typedef struct ah_asl_operator
92 {
93 char *Name;
94 char *Syntax;
95 char *Description;
96
97 } AH_ASL_OPERATOR;
98
99 typedef struct ah_asl_keyword
100 {
101 char *Name;
102 char *Description;
103 char *KeywordList;
104
105 } AH_ASL_KEYWORD;
106
107 typedef struct ah_device_id
108 {
109 char *Name;
110 char *Description;
111
112 } AH_DEVICE_ID;
113
114
115 extern const AH_AML_OPCODE AmlOpcodeInfo[];
116 extern const AH_ASL_OPERATOR AslOperatorInfo[];
117 extern const AH_ASL_KEYWORD AslKeywordInfo[];
118 extern BOOLEAN AhDisplayAll;
119
120 void
121 AhStrupr (
122 char *SrcString);
123
124 void
125 AhFindAmlOpcode (
126 char *Name);
127
128 void
129 AhDecodeAmlOpcode (
130 char *Name);
131
132 void
133 AhDecodeException (
134 char *Name);
135
136 void
137 AhFindPredefinedNames (
138 char *Name);
139
140 void
141 AhFindAslOperators (
142 char *Name);
143
144 void
145 AhFindAslKeywords (
146 char *Name);
147
148 void
149 AhDisplayDeviceIds (
150 void);
151
152 #endif /* __ACPIHELP_H */