xref: /freebsd/sys/contrib/dev/acpica/compiler/aslmessages.c (revision 722b16673c40aedf280895f2f2f676bb494518d7)
1 /******************************************************************************
2  *
3  * Module Name: aslmessages.c - Compiler error/warning message strings
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2023, Intel Corp.
12  * All rights reserved.
13  *
14  * 2. License
15  *
16  * 2.1. This is your license from Intel Corp. under its intellectual property
17  * rights. You may have additional license terms from the party that provided
18  * you this software, covering your right to use that party's intellectual
19  * property rights.
20  *
21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22  * copy of the source code appearing in this file ("Covered Code") an
23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24  * base code distributed originally by Intel ("Original Intel Code") to copy,
25  * make derivatives, distribute, use and display any portion of the Covered
26  * Code in any form, with the right to sublicense such rights; and
27  *
28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29  * license (with the right to sublicense), under only those claims of Intel
30  * patents that are infringed by the Original Intel Code, to make, use, sell,
31  * offer to sell, and import the Covered Code and derivative works thereof
32  * solely to the minimum extent necessary to exercise the above copyright
33  * license, and in no event shall the patent license extend to any additions
34  * to or modifications of the Original Intel Code. No other license or right
35  * is granted directly or by implication, estoppel or otherwise;
36  *
37  * The above copyright and patent license is granted only if the following
38  * conditions are met:
39  *
40  * 3. Conditions
41  *
42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43  * Redistribution of source code of any substantial portion of the Covered
44  * Code or modification with rights to further distribute source must include
45  * the above Copyright Notice, the above License, this list of Conditions,
46  * and the following Disclaimer and Export Compliance provision. In addition,
47  * Licensee must cause all Covered Code to which Licensee contributes to
48  * contain a file documenting the changes Licensee made to create that Covered
49  * Code and the date of any change. Licensee must include in that file the
50  * documentation of any changes made by any predecessor Licensee. Licensee
51  * must include a prominent statement that the modification is derived,
52  * directly or indirectly, from Original Intel Code.
53  *
54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55  * Redistribution of source code of any substantial portion of the Covered
56  * Code or modification without rights to further distribute source must
57  * include the following Disclaimer and Export Compliance provision in the
58  * documentation and/or other materials provided with distribution. In
59  * addition, Licensee may not authorize further sublicense of source of any
60  * portion of the Covered Code, and must include terms to the effect that the
61  * license from Licensee to its licensee is limited to the intellectual
62  * property embodied in the software Licensee provides to its licensee, and
63  * not to intellectual property embodied in modifications its licensee may
64  * make.
65  *
66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
67  * substantial portion of the Covered Code or modification must reproduce the
68  * above Copyright Notice, and the following Disclaimer and Export Compliance
69  * provision in the documentation and/or other materials provided with the
70  * distribution.
71  *
72  * 3.4. Intel retains all right, title, and interest in and to the Original
73  * Intel Code.
74  *
75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76  * Intel shall be used in advertising or otherwise to promote the sale, use or
77  * other dealings in products derived from or relating to the Covered Code
78  * without prior written authorization from Intel.
79  *
80  * 4. Disclaimer and Export Compliance
81  *
82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88  * PARTICULAR PURPOSE.
89  *
90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97  * LIMITED REMEDY.
98  *
99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
100  * software or system incorporating such software without first obtaining any
101  * required license or other approval from the U. S. Department of Commerce or
102  * any other agency or department of the United States Government. In the
103  * event Licensee exports any such software from the United States or
104  * re-exports any such software from a foreign destination, Licensee shall
105  * ensure that the distribution and export/re-export of the software is in
106  * compliance with all laws, regulations, orders, or other restrictions of the
107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108  * any of its subsidiaries will export/re-export any technical data, process,
109  * software, or service, directly or indirectly, to any country for which the
110  * United States government or any agency thereof requires an export license,
111  * other governmental approval, or letter of assurance, without first obtaining
112  * such license, approval or letter.
113  *
114  *****************************************************************************
115  *
116  * Alternatively, you may choose to be licensed under the terms of the
117  * following license:
118  *
119  * Redistribution and use in source and binary forms, with or without
120  * modification, are permitted provided that the following conditions
121  * are met:
122  * 1. Redistributions of source code must retain the above copyright
123  *    notice, this list of conditions, and the following disclaimer,
124  *    without modification.
125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126  *    substantially similar to the "NO WARRANTY" disclaimer below
127  *    ("Disclaimer") and any redistribution must be conditioned upon
128  *    including a substantially similar Disclaimer requirement for further
129  *    binary redistribution.
130  * 3. Neither the names of the above-listed copyright holders nor the names
131  *    of any contributors may be used to endorse or promote products derived
132  *    from this software without specific prior written permission.
133  *
134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145  *
146  * Alternatively, you may choose to be licensed under the terms of the
147  * GNU General Public License ("GPL") version 2 as published by the Free
148  * Software Foundation.
149  *
150  *****************************************************************************/
151 
152 #include <contrib/dev/acpica/compiler/aslcompiler.h>
153 
154 #define _COMPONENT          ACPI_COMPILER
155         ACPI_MODULE_NAME    ("aslmessages")
156 
157 
158 /*
159  * Strings for message reporting levels, must match error
160  * type string tables in aslmessages.c
161  */
162 const char              *AslErrorLevel [ASL_NUM_REPORT_LEVELS] = {
163     "Optimize",
164     "Remark  ",
165     "Warning ",
166     "Warning ",
167     "Warning ",
168     "Error   "
169 };
170 
171 /* All lowercase versions for IDEs */
172 
173 const char              *AslErrorLevelIde [ASL_NUM_REPORT_LEVELS] = {
174     "optimize",
175     "remark  ",
176     "warning ",
177     "warning ",
178     "warning ",
179     "error   "
180 };
181 
182 
183 /*
184  * Actual message strings for each compiler message ID. There are currently
185  * three distinct blocks of error messages (so that they can be expanded
186  * individually):
187  *      Main ASL compiler
188  *      Data Table compiler
189  *      Preprocessor
190  *
191  * NOTE1: These tables must match the enum list of message IDs in the file
192  * aslmessages.h exactly.
193  *
194  * NOTE2: With the introduction of the -vw option to disable specific messages,
195  * new messages should only be added to the end of this list, so that values
196  * for existing messages are not disturbed. As important, obsolete messages
197  * cannot be removed from this list, as it will affect the -vw option.
198  */
199 
200 /* ASL compiler */
201 
202 const char                      *AslCompilerMsgs [] =
203 {
204 /*    The zeroth message is reserved */    "",
205 /*    ASL_MSG_ALIGNMENT */                  "Must be a multiple of alignment/granularity value",
206 /*    ASL_MSG_ALPHANUMERIC_STRING */        "String must be entirely alphanumeric",
207 /*    ASL_MSG_AML_NOT_IMPLEMENTED */        "Opcode is not implemented in compiler AML code generator",
208 /*    ASL_MSG_ARG_COUNT_HI */               "Too many arguments",
209 /*    ASL_MSG_ARG_COUNT_LO */               "Too few arguments",
210 /*    ASL_MSG_ARG_INIT */                   "Method argument is not initialized",
211 /*    ASL_MSG_BACKWARDS_OFFSET */           "Invalid backwards offset",
212 /*    ASL_MSG_BUFFER_LENGTH */              "Effective AML buffer length is zero",
213 /*    ASL_MSG_CLOSE */                      "Could not close file",
214 /*    ASL_MSG_COMPILER_INTERNAL */          "Internal compiler error",
215 /*    ASL_MSG_COMPILER_RESERVED */          "Use of compiler reserved name",
216 /*    ASL_MSG_CONNECTION_MISSING */         "A Connection operator is required for this field SpaceId",
217 /*    ASL_MSG_CONNECTION_INVALID */         "Invalid OpRegion SpaceId for use of Connection operator",
218 /*    ASL_MSG_CONSTANT_EVALUATION */        "Could not evaluate constant expression",
219 /*    ASL_MSG_CONSTANT_FOLDED */            "Constant expression evaluated and reduced",
220 /*    ASL_MSG_CORE_EXCEPTION */             "From ACPICA Subsystem",
221 /*    ASL_MSG_DEBUG_FILE_OPEN */            "Could not open debug file",
222 /*    ASL_MSG_DEBUG_FILENAME */             "Could not create debug filename",
223 /*    ASL_MSG_DEPENDENT_NESTING */          "Dependent function macros cannot be nested",
224 /*    ASL_MSG_DMA_CHANNEL */                "Invalid DMA channel (must be 0-7)",
225 /*    ASL_MSG_DMA_LIST */                   "Too many DMA channels (8 max)",
226 /*    ASL_MSG_DUPLICATE_CASE */             "Case value already specified",
227 /*    ASL_MSG_DUPLICATE_ITEM */             "Duplicate value in list",
228 /*    ASL_MSG_EARLY_EOF */                  "Premature end-of-file reached",
229 /*    ASL_MSG_ENCODING_LENGTH */            "Package length too long to encode",
230 /*    ASL_MSG_EX_INTERRUPT_LIST */          "Too many interrupts (255 max)",
231 /*    ASL_MSG_EX_INTERRUPT_LIST_MIN */      "Too few interrupts (1 minimum required)",
232 /*    ASL_MSG_EX_INTERRUPT_NUMBER */        "Invalid interrupt number (must be 32 bits)",
233 /*    ASL_MSG_FIELD_ACCESS_WIDTH */         "Access width is greater than region size",
234 /*    ASL_MSG_FIELD_UNIT_ACCESS_WIDTH */    "Access width of Field Unit extends beyond region limit",
235 /*    ASL_MSG_FIELD_UNIT_OFFSET */          "Field Unit extends beyond region limit",
236 /*    ASL_MSG_GPE_NAME_CONFLICT */          "Name conflicts with a previous GPE method",
237 /*    ASL_MSG_HID_LENGTH */                 "_HID string must be exactly 7 or 8 characters",
238 /*    ASL_MSG_HID_PREFIX */                 "_HID prefix must be all uppercase or decimal digits",
239 /*    ASL_MSG_HID_SUFFIX */                 "_HID suffix must be all hex digits",
240 /*    ASL_MSG_INCLUDE_FILE_OPEN */          "Could not open include file",
241 /*    ASL_MSG_INPUT_FILE_OPEN */            "Could not open input file",
242 /*    ASL_MSG_INTEGER_LENGTH */             "Truncating 64-bit constant found in 32-bit table",
243 /*    ASL_MSG_INTEGER_OPTIMIZATION */       "Integer optimized to single-byte AML opcode",
244 /*    ASL_MSG_INTERRUPT_LIST */             "Too many interrupts (16 max)",
245 /*    ASL_MSG_INTERRUPT_NUMBER */           "Invalid interrupt number (must be 0-15)",
246 /*    ASL_MSG_INVALID_ACCESS_SIZE */        "Invalid AccessSize (Maximum is 4 - QWord access)",
247 /*    ASL_MSG_INVALID_ADDR_FLAGS */         "Invalid combination of Length and Min/Max fixed flags",
248 /*    ASL_MSG_INVALID_CONSTANT_OP */        "Invalid operator in constant expression (not type 3/4/5)",
249 /*    ASL_MSG_INVALID_EISAID */             "EISAID string must be of the form \"UUUXXXX\" (3 uppercase, 4 hex digits)",
250 /*    ASL_MSG_INVALID_ESCAPE */             "Invalid or unknown escape sequence",
251 /*    ASL_MSG_INVALID_GRAN_FIXED */         "Granularity must be zero for fixed Min/Max",
252 /*    ASL_MSG_INVALID_GRANULARITY */        "Granularity must be zero or a power of two minus one",
253 /*    ASL_MSG_INVALID_LENGTH */             "Length is larger than Min/Max window",
254 /*    ASL_MSG_INVALID_LENGTH_FIXED */       "Length is not equal to fixed Min/Max window",
255 /*    ASL_MSG_INVALID_MIN_MAX */            "Address Min is greater than Address Max",
256 /*    ASL_MSG_INVALID_OPERAND */            "Invalid operand",
257 /*    ASL_MSG_INVALID_PERFORMANCE */        "Invalid performance/robustness value",
258 /*    ASL_MSG_INVALID_PRIORITY */           "Invalid priority value",
259 /*    ASL_MSG_INVALID_STRING */             "Invalid Hex/Octal Escape - Non-ASCII or NULL",
260 /*    ASL_MSG_INVALID_TARGET */             "Target operand not allowed in constant expression",
261 /*    ASL_MSG_INVALID_TIME */               "Time parameter too long (255 max)",
262 /*    ASL_MSG_INVALID_TYPE */               "Invalid type",
263 /*    ASL_MSG_INVALID_UUID */               "UUID string must be of the form \"aabbccdd-eeff-gghh-iijj-kkllmmnnoopp\"",
264 /*    ASL_MSG_ISA_ADDRESS */                "Maximum 10-bit ISA address (0x3FF)",
265 /*    ASL_MSG_LEADING_ASTERISK */           "Invalid leading asterisk",
266 /*    ASL_MSG_LIST_LENGTH_LONG */           "Initializer list longer than declared package length",
267 /*    ASL_MSG_LIST_LENGTH_SHORT */          "Initializer list shorter than declared package length",
268 /*    ASL_MSG_LISTING_FILE_OPEN */          "Could not open listing file",
269 /*    ASL_MSG_LISTING_FILENAME */           "Could not create listing filename",
270 /*    ASL_MSG_LOCAL_INIT */                 "Method local variable is not initialized",
271 /*    ASL_MSG_LOCAL_OUTSIDE_METHOD */       "Local or Arg used outside a control method",
272 /*    ASL_MSG_LONG_LINE */                  "Splitting long input line",
273 /*    ASL_MSG_MEMORY_ALLOCATION */          "Memory allocation failure",
274 /*    ASL_MSG_MISSING_ENDDEPENDENT */       "Missing EndDependentFn() macro in dependent resource list",
275 /*    ASL_MSG_MISSING_STARTDEPENDENT */     "Missing StartDependentFn() macro in dependent resource list",
276 /*    ASL_MSG_MULTIPLE_DEFAULT */           "More than one Default statement within Switch construct",
277 /*    ASL_MSG_MULTIPLE_TYPES */             "Multiple types",
278 /*    ASL_MSG_NAME_EXISTS */                "Name already exists in scope",
279 /*    ASL_MSG_NAME_OPTIMIZATION */          "NamePath optimized",
280 /*    ASL_MSG_NAMED_OBJECT_IN_WHILE */      "Creating a named object in a While loop",
281 /*    ASL_MSG_NESTED_COMMENT */             "Nested comment found",
282 /*    ASL_MSG_NO_CASES */                   "No Case statements under Switch",
283 /*    ASL_MSG_NO_REGION */                  "_REG has no corresponding Operation Region",
284 /*    ASL_MSG_NO_RETVAL */                  "Called method returns no value",
285 /*    ASL_MSG_NO_WHILE */                   "No enclosing While statement",
286 /*    ASL_MSG_NON_ASCII */                  "Invalid characters found in file",
287 /*    ASL_MSG_BUFFER_FIELD_LENGTH */        "Field length must be non-zero",
288 /*    ASL_MSG_NOT_EXIST */                  "Object does not exist",
289 /*    ASL_MSG_NOT_FOUND */                  "Object not found or not accessible from current scope",
290 /*    ASL_MSG_NOT_METHOD */                 "Not a control method, cannot invoke",
291 /*    ASL_MSG_NOT_PARAMETER */              "Not a parameter, used as local only",
292 /*    ASL_MSG_NOT_REACHABLE */              "Object is not accessible from this scope",
293 /*    ASL_MSG_NOT_REFERENCED */             "Object is not referenced",
294 /*    ASL_MSG_NULL_DESCRIPTOR */            "Min/Max/Length/Gran are all zero, but no resource tag",
295 /*    ASL_MSG_NULL_STRING */                "Invalid zero-length (null) string",
296 /*    ASL_MSG_OPEN */                       "Could not open file",
297 /*    ASL_MSG_OUTPUT_FILE_OPEN */           "Could not open output AML file",
298 /*    ASL_MSG_OUTPUT_FILENAME */            "Could not create output filename",
299 /*    ASL_MSG_PACKAGE_LENGTH */             "Effective AML package length is zero",
300 /*    ASL_MSG_PREPROCESSOR_FILENAME */      "Could not create preprocessor filename",
301 /*    ASL_MSG_READ */                       "Could not read file",
302 /*    ASL_MSG_RECURSION */                  "Recursive method call",
303 /*    ASL_MSG_REGION_BUFFER_ACCESS */       "Host Operation Region requires BufferAcc access",
304 /*    ASL_MSG_REGION_BYTE_ACCESS */         "Host Operation Region requires ByteAcc access",
305 /*    ASL_MSG_RESERVED_ARG_COUNT_HI */      "Reserved method has too many arguments",
306 /*    ASL_MSG_RESERVED_ARG_COUNT_LO */      "Reserved method has too few arguments",
307 /*    ASL_MSG_RESERVED_METHOD */            "Reserved name must be a control method",
308 /*    ASL_MSG_RESERVED_NO_RETURN_VAL */     "Reserved method should not return a value",
309 /*    ASL_MSG_RESERVED_OPERAND_TYPE */      "Invalid object type for reserved name",
310 /*    ASL_MSG_RESERVED_PACKAGE_LENGTH */    "Invalid package length for reserved name",
311 /*    ASL_MSG_RESERVED_RETURN_VALUE */      "Reserved method must return a value",
312 /*    ASL_MSG_RESERVED_USE */               "Invalid use of reserved name",
313 /*    ASL_MSG_RESERVED_WORD */              "Use of reserved name",
314 /*    ASL_MSG_RESOURCE_FIELD */             "Resource field name cannot be used as a target",
315 /*    ASL_MSG_RESOURCE_INDEX */             "Missing ResourceSourceIndex (required)",
316 /*    ASL_MSG_RESOURCE_LIST */              "Too many resource items (internal error)",
317 /*    ASL_MSG_RESOURCE_SOURCE */            "Missing ResourceSource string (required)",
318 /*    ASL_MSG_RESULT_NOT_USED */            "Result is not used, operator has no effect",
319 /*    ASL_MSG_RETURN_TYPES */               "Not all control paths return a value",
320 /*    ASL_MSG_SCOPE_FWD_REF */              "Forward references from Scope operator not allowed",
321 /*    ASL_MSG_SCOPE_TYPE */                 "Existing object has invalid type for Scope operator",
322 /*    ASL_MSG_SEEK */                       "Could not seek file",
323 /*    ASL_MSG_SERIALIZED */                 "Control Method marked Serialized",
324 /*    ASL_MSG_SERIALIZED_REQUIRED */        "Control Method should be made Serialized due to creation of named objects within",
325 /*    ASL_MSG_SINGLE_NAME_OPTIMIZATION */   "NamePath optimized to NameSeg (uses run-time search path)",
326 /*    ASL_MSG_SOME_NO_RETVAL */             "Called method may not always return a value",
327 /*    ASL_MSG_STRING_LENGTH */              "String literal too long",
328 /*    ASL_MSG_SWITCH_TYPE */                "Switch expression is not a static Integer/Buffer/String data type, defaulting to Integer",
329 /*    ASL_MSG_SYNC_LEVEL */                 "SyncLevel must be in the range 0-15",
330 /*    ASL_MSG_SYNTAX */                     "",
331 /*    ASL_MSG_TABLE_SIGNATURE */            "Invalid Table Signature",
332 /*    ASL_MSG_TAG_LARGER */                 "ResourceTag larger than Field",
333 /*    ASL_MSG_TAG_SMALLER */                "ResourceTag smaller than Field",
334 /*    ASL_MSG_TIMEOUT */                    "Result is not used, possible operator timeout will be missed",
335 /*    ASL_MSG_TOO_MANY_TEMPS */             "Method requires too many temporary variables (_T_x)",
336 /*    ASL_MSG_TRUNCATION */                 "64-bit return value will be truncated to 32 bits (DSDT or SSDT version < 2)",
337 /*    ASL_MSG_UNKNOWN_RESERVED_NAME */      "Unknown reserved name",
338 /*    ASL_MSG_UNREACHABLE_CODE */           "Statement is unreachable",
339 /*    ASL_MSG_UNSUPPORTED */                "Unsupported feature",
340 /*    ASL_MSG_UPPER_CASE */                 "Non-hex letters must be upper case",
341 /*    ASL_MSG_VENDOR_LIST */                "Too many vendor data bytes (7 max)",
342 /*    ASL_MSG_WRITE */                      "Could not write file",
343 /*    ASL_MSG_RANGE */                      "Constant out of range",
344 /*    ASL_MSG_BUFFER_ALLOCATION */          "Could not allocate line buffer",
345 /*    ASL_MSG_MISSING_DEPENDENCY */         "Missing dependency",
346 /*    ASL_MSG_ILLEGAL_FORWARD_REF */        "Illegal forward reference",
347 /*    ASL_MSG_ILLEGAL_METHOD_REF */         "Object is declared in a different method",
348 /*    ASL_MSG_LOCAL_NOT_USED */             "Method Local is set but never used",
349 /*    ASL_MSG_ARG_AS_LOCAL_NOT_USED */      "Method Argument (as a local) is set but never used",
350 /*    ASL_MSG_ARG_NOT_USED */               "Method Argument is never used",
351 /*    ASL_MSG_CONSTANT_REQUIRED */          "Non-reducible expression",
352 /*    ASL_MSG_CROSS_TABLE_SCOPE */          "Illegal open scope on external object from within DSDT",
353 /*    ASL_MSG_EXCEPTION_NOT_RECEIVED */     "Expected remark, warning, or error did not occur. Message ID:",
354 /*    ASL_MSG_NULL_RESOURCE_TEMPLATE */     "Empty Resource Template (END_TAG only)",
355 /*    ASL_MSG_FOUND_HERE */                 "Original name creation/declaration below: ",
356 /*    ASL_MSG_ILLEGAL_RECURSION */          "Illegal recursive call to method that creates named objects",
357 /*    ASL_MSG_DUPLICATE_INPUT_FILE */       "Duplicate input files detected:",
358 /*    ASL_MSG_WARNING_AS_ERROR */           "Warnings detected during compilation",
359 /*    ASL_MSG_OEM_TABLE_ID */               "Invalid OEM Table ID",
360 /*    ASL_MSG_OEM_ID */                     "Invalid OEM ID",
361 /*    ASL_MSG_UNLOAD */                     "Unload is not supported by all operating systems",
362 /*    ASL_MSG_OFFSET */                     "Unnecessary/redundant use of Offset operator",
363 /*    ASL_MSG_LONG_SLEEP */                 "Very long Sleep, greater than 1 second",
364 /*    ASL_MSG_PREFIX_NOT_EXIST */           "One or more prefix Scopes do not exist",
365 /*    ASL_MSG_NAMEPATH_NOT_EXIST */         "One or more objects within the Pathname do not exist",
366 /*    ASL_MSG_REGION_LENGTH */              "Operation Region declared with zero length",
367 /*    ASL_MSG_TEMPORARY_OBJECT */           "Object is created temporarily in another method and cannot be accessed",
368 /*    ASL_MSG_UNDEFINED_EXTERNAL */         "Named object was declared external but the actual definition does not exist",
369 /*    ASL_MSG_BUFFER_FIELD_OVERFLOW */      "Buffer field extends beyond end of target buffer",
370 /*    ASL_MSG_INVALID_SPECIAL_NAME */       "declaration of this named object outside root scope is illegal",
371 /*    ASL_MSG_INVALID_PROCESSOR_UID */      "_UID inside processor declaration must be an integer",
372 /*    ASL_MSG_LEGACY_PROCESSOR_OP */        "Legacy Processor() keyword detected. Use Device() keyword instead.",
373 /*    ASL_MSG_NAMESTRING_LENGTH */          "NameString contains too many NameSegs (>255)",
374 /*    ASL_MSG_CASE_FOUND_HERE */            "Original Case value below:",
375 /*    ASL_MSG_EXTERN_INVALID_RET_TYPE */    "Return type is only allowed for Externals declared as MethodObj",
376 /*    ASL_MSG_EXTERN_INVALID_PARAM_TYPE */  "Parameter type is only allowed for Externals declared as MethodObj",
377 /*    ASL_MSG_NAMED_OBJECT_CREATION */      "Creation of named objects within a method is highly inefficient, use globals or method local variables instead",
378 /*    ASL_MSG_ARG_COUNT_MISMATCH */         "Method NumArgs count does not match length of ParameterTypes list",
379 /*    ASL_MSG_STATIC_OPREGION_IN_METHOD */  "Static OperationRegion should be declared outside control method",
380 /*    ASL_MSG_DECLARATION_TYPE_MISMATCH */  "Type mismatch between external declaration and actual object declaration detected",
381 /*    ASL_MSG_TYPE_MISMATCH_FOUND_HERE */   "Actual object declaration:",
382 /*    ASL_MSG_DUPLICATE_EXTERN_MISMATCH */  "Type mismatch between multiple external declarations detected",
383 /*    ASL_MSG_DUPLICATE_EXTERN_FOUND_HERE */"Duplicate external declaration:",
384 /*    ASL_MSG_CONDREF_NEEDS_EXTERNAL_DECL */"CondRefOf parameter requires External() declaration",
385 /*    ASL_MSG_EXTERNAL_FOUND_HERE */        "External declaration below ",
386 /*    ASL_MSG_LOWER_CASE_NAMESEG */         "At least one lower case letter found in NameSeg, ASL is case insensitive - converting to upper case",
387 /*    ASL_MSG_LOWER_CASE_NAMEPATH */        "At least one lower case letter found in NamePath, ASL is case insensitive - converting to upper case",
388 /*    ASL_MSG_UUID_NOT_FOUND */             "Unknown UUID string",
389 /*    ASL_MSG_LEGACY_DDB_TYPE */            "DDBHandleObj has been deprecated along with the Unload operator. DDBHandlObj objects are only used in Unload"
390 };
391 
392 /* Table compiler */
393 
394 const char                      *AslTableCompilerMsgs [] =
395 {
396 /*    ASL_MSG_BUFFER_ELEMENT */             "Invalid element in buffer initializer list",
397 /*    ASL_MSG_DIVIDE_BY_ZERO */             "Expression contains divide-by-zero",
398 /*    ASL_MSG_FLAG_VALUE */                 "Flag value is too large",
399 /*    ASL_MSG_INTEGER_SIZE */               "Integer too large for target",
400 /*    ASL_MSG_INVALID_EXPRESSION */         "Invalid expression",
401 /*    ASL_MSG_INVALID_FIELD_NAME */         "Invalid Field Name",
402 /*    ASL_MSG_INVALID_HEX_INTEGER */        "Invalid hex integer constant",
403 /*    ASL_MSG_OEM_TABLE */                  "OEM table - unknown contents",
404 /*    ASL_MSG_RESERVED_FIELD */             "Reserved field",
405 /*    ASL_MSG_UNKNOWN_LABEL */              "Label is undefined",
406 /*    ASL_MSG_UNKNOWN_SUBTABLE */           "Unknown subtable type",
407 /*    ASL_MSG_UNKNOWN_TABLE */              "Unknown ACPI table signature",
408 /*    ASL_MSG_ZERO_VALUE */                 "Value must be non-zero",
409 /*    ASL_MSG_INVALID_LABEL */              "Invalid field label detected",
410 /*    ASL_MSG_BUFFER_LIST */                "Invalid buffer initializer list",
411 /*    ASL_MSG_ENTRY_LIST */                 "Invalid entry initializer list",
412 /*    ASL_MSG_UNKNOWN_FORMAT */             "Unknown format value",
413 /*    ASL_MSG_RESERVED_VALUE */             "Value for field is reserved or unknown",
414 /*    ASL_MSG_TWO_ZERO_VALUES */            "32-bit DSDT Address and 64-bit X_DSDT Address cannot both be zero",
415 /*    ASL_MSG_BAD_PARSE_TREE */             "Parse tree appears to be ill-defined"
416 };
417 
418 /* Preprocessor */
419 
420 const char                      *AslPreprocessorMsgs [] =
421 {
422 /*    ASL_MSG_DIRECTIVE_SYNTAX */           "Invalid directive syntax",
423 /*    ASL_MSG_ENDIF_MISMATCH */             "Mismatched #endif",
424 /*    ASL_MSG_ERROR_DIRECTIVE */            "#error",
425 /*    ASL_MSG_EXISTING_NAME */              "Name is already defined",
426 /*    ASL_MSG_INVALID_INVOCATION */         "Invalid macro invocation",
427 /*    ASL_MSG_MACRO_SYNTAX */               "Invalid macro syntax",
428 /*    ASL_MSG_TOO_MANY_ARGUMENTS */         "Too many macro arguments",
429 /*    ASL_MSG_UNKNOWN_DIRECTIVE */          "Unknown directive",
430 /*    ASL_MSG_UNKNOWN_PRAGMA */             "Unknown pragma",
431 /*    ASL_MSG_WARNING_DIRECTIVE */          "#warning",
432 /*    ASL_MSG_INCLUDE_FILE */               "Found a # preprocessor directive in ASL Include() file"
433 };
434 
435 
436 /*******************************************************************************
437  *
438  * FUNCTION:    AeDecodeMessageId
439  *
440  * PARAMETERS:  MessageId               - ASL message ID (exception code) to be
441  *                                        formatted. Possibly fully encoded.
442  *
443  * RETURN:      A string containing the exception message text.
444  *
445  * DESCRIPTION: This function validates and translates an ASL message ID into
446  *              an ASCII string.
447  *
448  ******************************************************************************/
449 
450 const char *
AeDecodeMessageId(UINT16 MessageId)451 AeDecodeMessageId (
452     UINT16                  MessageId)
453 {
454     UINT32                  Index;
455     const char              **MessageTable;
456 
457 
458     /* Main ASL Compiler messages */
459 
460     if (MessageId <= ASL_MSG_MAIN_COMPILER_END)
461     {
462         MessageTable = AslCompilerMsgs;
463         Index = MessageId;
464 
465         if (Index >= ACPI_ARRAY_LENGTH (AslCompilerMsgs))
466         {
467             return ("[Unknown iASL Compiler exception ID]");
468         }
469     }
470 
471     /* Data Table Compiler messages */
472 
473     else if (MessageId <= ASL_MSG_TABLE_COMPILER_END)
474     {
475         MessageTable = AslTableCompilerMsgs;
476         Index = MessageId - ASL_MSG_TABLE_COMPILER;
477 
478         if (Index >= ACPI_ARRAY_LENGTH (AslTableCompilerMsgs))
479         {
480             return ("[Unknown iASL Table Compiler exception ID]");
481         }
482     }
483 
484     /* Preprocessor messages */
485 
486     else if (MessageId <= ASL_MSG_PREPROCESSOR_END)
487     {
488         MessageTable = AslPreprocessorMsgs;
489         Index = MessageId - ASL_MSG_PREPROCESSOR;
490 
491         if (Index >= ACPI_ARRAY_LENGTH (AslPreprocessorMsgs))
492         {
493             return ("[Unknown iASL Preprocessor exception ID]");
494         }
495     }
496 
497     /* Everything else is unknown */
498 
499     else
500     {
501         return ("[Unknown iASL exception ID]");
502     }
503 
504     return (MessageTable[Index]);
505 }
506 
507 
508 /*******************************************************************************
509  *
510  * FUNCTION:    AeDecodeExceptionLevel
511  *
512  * PARAMETERS:  Level               - The ASL error level to be decoded
513  *
514  * RETURN:      A string containing the error level text
515  *
516  * DESCRIPTION: This function validates and translates an ASL error level into
517  *              an ASCII string.
518  *
519  ******************************************************************************/
520 
521 const char *
AeDecodeExceptionLevel(UINT8 Level)522 AeDecodeExceptionLevel (
523     UINT8                   Level)
524 {
525     /* Range check on Level */
526 
527     if (Level >= ACPI_ARRAY_LENGTH (AslErrorLevel))
528     {
529         return ("Unknown exception level");
530     }
531 
532     /* Differentiate the string type to be used (IDE is all lower case) */
533 
534     if (AslGbl_VerboseErrors)
535     {
536         return (AslErrorLevel[Level]);
537     }
538 
539     return (AslErrorLevelIde[Level]);
540 }
541 
542 
543 /*******************************************************************************
544  *
545  * FUNCTION:    AeBuildFullExceptionCode
546  *
547  * PARAMETERS:  Level               - ASL error level
548  *              MessageId           - ASL exception code to be formatted
549  *
550  * RETURN:      Fully encoded exception code
551  *
552  * DESCRIPTION: Build the full exception code from the error level and the
553  *              actual message ID.
554  *
555  ******************************************************************************/
556 
557 UINT16
AeBuildFullExceptionCode(UINT8 Level,UINT16 MessageId)558 AeBuildFullExceptionCode (
559     UINT8                   Level,
560     UINT16                  MessageId)
561 {
562 
563     /*
564      * Error level is in the thousands slot (error/warning/remark, etc.)
565      * Error codes are 0 - 999
566      */
567     return (((Level + 1) * 1000) + MessageId);
568 }
569 
570 
571 #ifdef ACPI_HELP_APP
572 /*******************************************************************************
573  *
574  * FUNCTION:    AhDecodeAslException
575  *
576  * PARAMETERS:  HexString           - iASL status string from command line, in
577  *                                    hex. If null, display all exceptions.
578  *
579  * RETURN:      None
580  *
581  * DESCRIPTION: Decode and display an iASL exception code. Note1: a
582  * NULL string for HexString displays all known iASL exceptions. Note2:
583  * implements the -x option for AcpiHelp.
584  *
585  ******************************************************************************/
586 
587 #define AH_DISPLAY_ASL_EXCEPTION_TEXT(Status, Exception) \
588     printf ("%.4X: %s\n", Status, Exception)
589 
590 #define AH_DISPLAY_EXCEPTION(Status, Name) \
591     printf ("%.4X: %s\n", Status, Name)
592 
593 
594 void
AhDecodeAslException(char * HexString)595 AhDecodeAslException (
596     char                    *HexString)
597 {
598     UINT32                  i;
599     UINT32                  MessageId;
600     const char              *OneException;
601     UINT32                  Index = 1;
602 
603 
604     /*
605      * A null input string means to decode and display all known
606      * exception codes.
607      */
608     if (!HexString)
609     {
610         printf ("All defined iASL exception codes:\n\n");
611         printf ("Main iASL exceptions:\n\n");
612         AH_DISPLAY_EXCEPTION (0,
613             "AE_OK                        (No error occurred)");
614 
615         /* Display codes in each block of exception types */
616 
617         for (i = 1; Index < ACPI_ARRAY_LENGTH (AslCompilerMsgs); i++, Index++)
618         {
619             AH_DISPLAY_ASL_EXCEPTION_TEXT (Index, AslCompilerMsgs[i]);
620         }
621 
622         printf ("\niASL Table Compiler exceptions:\n\n");
623         Index = ASL_MSG_TABLE_COMPILER;
624         for (i = 0; i < ACPI_ARRAY_LENGTH (AslTableCompilerMsgs); i++, Index++)
625         {
626             AH_DISPLAY_ASL_EXCEPTION_TEXT (Index, AslTableCompilerMsgs[i]);
627         }
628 
629         printf ("\niASL Preprocessor exceptions:\n\n");
630         Index = ASL_MSG_PREPROCESSOR;
631         for (i = 0; i < ACPI_ARRAY_LENGTH (AslPreprocessorMsgs); i++, Index++)
632         {
633             AH_DISPLAY_ASL_EXCEPTION_TEXT (Index, AslPreprocessorMsgs[i]);
634         }
635         return;
636     }
637 
638     /* HexString is valid - convert it to a MessageId and decode it */
639 
640     MessageId = strtol (HexString, NULL, 16);
641     OneException = AeDecodeMessageId ((UINT16) MessageId);
642     AH_DISPLAY_ASL_EXCEPTION_TEXT (MessageId, OneException);
643 }
644 #endif
645