[ACPICA] Update to version 20171215. CORE-15222
[reactos.git] / drivers / bus / acpi / acpica / include / acapps.h
1 /******************************************************************************
2 *
3 * Module Name: acapps - common include for ACPI applications/tools
4 *
5 *****************************************************************************/
6
7 /*
8 * Copyright (C) 2000 - 2017, 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 _ACAPPS
45 #define _ACAPPS
46
47 #ifdef ACPI_USE_STANDARD_HEADERS
48 #include <sys/stat.h>
49 #endif /* ACPI_USE_STANDARD_HEADERS */
50
51 /* Common info for tool signons */
52
53 #define ACPICA_NAME "Intel ACPI Component Architecture"
54 #define ACPICA_COPYRIGHT "Copyright (c) 2000 - 2017 Intel Corporation"
55
56 #if ACPI_MACHINE_WIDTH == 64
57 #define ACPI_WIDTH " (64-bit version)"
58
59 #elif ACPI_MACHINE_WIDTH == 32
60 #define ACPI_WIDTH " (32-bit version)"
61
62 #else
63 #error unknown ACPI_MACHINE_WIDTH
64 #define ACPI_WIDTH " (unknown bit width, not 32 or 64)"
65
66 #endif
67
68 /* Macros for signons and file headers */
69
70 #define ACPI_COMMON_SIGNON(UtilityName) \
71 "\n%s\n%s version %8.8X\n%s\n\n", \
72 ACPICA_NAME, \
73 UtilityName, ((UINT32) ACPI_CA_VERSION), \
74 ACPICA_COPYRIGHT
75
76 #define ACPI_COMMON_HEADER(UtilityName, Prefix) \
77 "%s%s\n%s%s version %8.8X%s\n%s%s\n%s\n", \
78 Prefix, ACPICA_NAME, \
79 Prefix, UtilityName, ((UINT32) ACPI_CA_VERSION), ACPI_WIDTH, \
80 Prefix, ACPICA_COPYRIGHT, \
81 Prefix
82
83 #define ACPI_COMMON_BUILD_TIME \
84 "Build date/time: %s %s\n", __DATE__, __TIME__
85
86 /* Macros for usage messages */
87
88 #define ACPI_USAGE_HEADER(Usage) \
89 printf ("Usage: %s\nOptions:\n", Usage);
90
91 #define ACPI_USAGE_TEXT(Description) \
92 printf (Description);
93
94 #define ACPI_OPTION(Name, Description) \
95 printf (" %-20s%s\n", Name, Description);
96
97
98 /* Check for unexpected exceptions */
99
100 #define ACPI_CHECK_STATUS(Name, Status, Expected) \
101 if (Status != Expected) \
102 { \
103 AcpiOsPrintf ("Unexpected %s from %s (%s-%d)\n", \
104 AcpiFormatException (Status), #Name, _AcpiModuleName, __LINE__); \
105 }
106
107 /* Check for unexpected non-AE_OK errors */
108
109
110 #define ACPI_CHECK_OK(Name, Status) ACPI_CHECK_STATUS (Name, Status, AE_OK);
111
112 #define FILE_SUFFIX_DISASSEMBLY "dsl"
113 #define FILE_SUFFIX_BINARY_TABLE ".dat" /* Needs the dot */
114
115
116 /* acfileio */
117
118 ACPI_STATUS
119 AcGetAllTablesFromFile (
120 char *Filename,
121 UINT8 GetOnlyAmlTables,
122 ACPI_NEW_TABLE_DESC **ReturnListHead);
123
124 void
125 AcDeleteTableList (
126 ACPI_NEW_TABLE_DESC *ListHead);
127
128 BOOLEAN
129 AcIsFileBinary (
130 FILE *File);
131
132 ACPI_STATUS
133 AcValidateTableHeader (
134 FILE *File,
135 long TableOffset);
136
137
138 /* Values for GetOnlyAmlTables */
139
140 #define ACPI_GET_ONLY_AML_TABLES TRUE
141 #define ACPI_GET_ALL_TABLES FALSE
142
143
144 /*
145 * getopt
146 */
147 int
148 AcpiGetopt(
149 int argc,
150 char **argv,
151 char *opts);
152
153 int
154 AcpiGetoptArgument (
155 int argc,
156 char **argv);
157
158 extern int AcpiGbl_Optind;
159 extern int AcpiGbl_Opterr;
160 extern int AcpiGbl_SubOptChar;
161 extern char *AcpiGbl_Optarg;
162
163
164 /*
165 * cmfsize - Common get file size function
166 */
167 UINT32
168 CmGetFileSize (
169 ACPI_FILE File);
170
171
172 /*
173 * adwalk
174 */
175 void
176 AcpiDmCrossReferenceNamespace (
177 ACPI_PARSE_OBJECT *ParseTreeRoot,
178 ACPI_NAMESPACE_NODE *NamespaceRoot,
179 ACPI_OWNER_ID OwnerId);
180
181 void
182 AcpiDmDumpTree (
183 ACPI_PARSE_OBJECT *Origin);
184
185 void
186 AcpiDmFindOrphanMethods (
187 ACPI_PARSE_OBJECT *Origin);
188
189 void
190 AcpiDmFinishNamespaceLoad (
191 ACPI_PARSE_OBJECT *ParseTreeRoot,
192 ACPI_NAMESPACE_NODE *NamespaceRoot,
193 ACPI_OWNER_ID OwnerId);
194
195 void
196 AcpiDmConvertParseObjects (
197 ACPI_PARSE_OBJECT *ParseTreeRoot,
198 ACPI_NAMESPACE_NODE *NamespaceRoot);
199
200
201 /*
202 * adfile
203 */
204 ACPI_STATUS
205 AdInitialize (
206 void);
207
208 char *
209 FlGenerateFilename (
210 char *InputFilename,
211 char *Suffix);
212
213 ACPI_STATUS
214 FlSplitInputPathname (
215 char *InputPath,
216 char **OutDirectoryPath,
217 char **OutFilename);
218
219 char *
220 AdGenerateFilename (
221 char *Prefix,
222 char *TableId);
223
224 void
225 AdWriteTable (
226 ACPI_TABLE_HEADER *Table,
227 UINT32 Length,
228 char *TableName,
229 char *OemTableId);
230
231 #endif /* _ACAPPS */