sys/contrib/dev/acpica/source/compiler/aslmessages.h

   1 /******************************************************************************
   2  *
   3  * Module Name: aslmessages.h - Compiler error/warning messages
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2021, 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 #ifndef __ASLMESSAGES_H
 153 #define __ASLMESSAGES_H
 154
 155 /* These values must match error type string tables in aslmessages.c */
 156
 157 typedef enum
 158 {
 159     ASL_OPTIMIZATION = 0,
 160     ASL_REMARK,
 161     ASL_WARNING,
 162     ASL_WARNING2,
 163     ASL_WARNING3,
 164     ASL_ERROR,
 165     ASL_NUM_REPORT_LEVELS
 166
 167 } ASL_MESSAGE_TYPES;
 168
 169 #define ASL_ERROR_LEVEL_LENGTH          8 /* Length of strings for types above */
 170
 171 void
 172 AhDecodeAslException (
 173     char                    *HexString);
 174
 175 /*
 176  * Exception code blocks, 0 - 999
 177  * Available for new exception blocks: 600 - 999
 178  */
 179 #define ASL_MSG_MAIN_COMPILER           0       /* 0 - 299 */
 180 #define ASL_MSG_MAIN_COMPILER_END       299
 181
 182 #define ASL_MSG_TABLE_COMPILER          300     /* 300 - 499 */
 183 #define ASL_MSG_TABLE_COMPILER_END      499
 184
 185 #define ASL_MSG_PREPROCESSOR            500     /* 500 - 599 */
 186 #define ASL_MSG_PREPROCESSOR_END        599
 187
 188
 189 /*
 190  * Values (message IDs) for all compiler messages. There are currently
 191  * three distinct blocks of error messages (so that they can be expanded
 192  * individually):
 193  *      Main ASL compiler
 194  *      Data Table compiler
 195  *      Preprocessor
 196  *
 197  * NOTE1: This list must match the tables of message strings in the file
 198  * aslmessages.c exactly.
 199  *
 200  * NOTE2: With the introduction of the -vw option to disable specific
 201  * messages, new messages should only be added to the end of these
 202  * lists, so that values for existing messages are not disturbed.
 203  */
 204 typedef enum
 205 {
 206     ASL_MSG_RESERVED = ASL_MSG_MAIN_COMPILER,
 207
 208     ASL_MSG_ALIGNMENT,
 209     ASL_MSG_ALPHANUMERIC_STRING,
 210     ASL_MSG_AML_NOT_IMPLEMENTED,
 211     ASL_MSG_ARG_COUNT_HI,
 212     ASL_MSG_ARG_COUNT_LO,
 213     ASL_MSG_ARG_INIT,
 214     ASL_MSG_BACKWARDS_OFFSET,
 215     ASL_MSG_BUFFER_LENGTH,
 216     ASL_MSG_CLOSE,
 217     ASL_MSG_COMPILER_INTERNAL,
 218     ASL_MSG_COMPILER_RESERVED,
 219     ASL_MSG_CONNECTION_MISSING,
 220     ASL_MSG_CONNECTION_INVALID,
 221     ASL_MSG_CONSTANT_EVALUATION,
 222     ASL_MSG_CONSTANT_FOLDED,
 223     ASL_MSG_CORE_EXCEPTION,
 224     ASL_MSG_DEBUG_FILE_OPEN,
 225     ASL_MSG_DEBUG_FILENAME,
 226     ASL_MSG_DEPENDENT_NESTING,
 227     ASL_MSG_DMA_CHANNEL,
 228     ASL_MSG_DMA_LIST,
 229     ASL_MSG_DUPLICATE_CASE,
 230     ASL_MSG_DUPLICATE_ITEM,
 231     ASL_MSG_EARLY_EOF,
 232     ASL_MSG_ENCODING_LENGTH,
 233     ASL_MSG_EX_INTERRUPT_LIST,
 234     ASL_MSG_EX_INTERRUPT_LIST_MIN,
 235     ASL_MSG_EX_INTERRUPT_NUMBER,
 236     ASL_MSG_FIELD_ACCESS_WIDTH,
 237     ASL_MSG_FIELD_UNIT_ACCESS_WIDTH,
 238     ASL_MSG_FIELD_UNIT_OFFSET,
 239     ASL_MSG_GPE_NAME_CONFLICT,
 240     ASL_MSG_HID_LENGTH,
 241     ASL_MSG_HID_PREFIX,
 242     ASL_MSG_HID_SUFFIX,
 243     ASL_MSG_INCLUDE_FILE_OPEN,
 244     ASL_MSG_INPUT_FILE_OPEN,
 245     ASL_MSG_INTEGER_LENGTH,
 246     ASL_MSG_INTEGER_OPTIMIZATION,
 247     ASL_MSG_INTERRUPT_LIST,
 248     ASL_MSG_INTERRUPT_NUMBER,
 249     ASL_MSG_INVALID_ACCESS_SIZE,
 250     ASL_MSG_INVALID_ADDR_FLAGS,
 251     ASL_MSG_INVALID_CONSTANT_OP,
 252     ASL_MSG_INVALID_EISAID,
 253     ASL_MSG_INVALID_ESCAPE,
 254     ASL_MSG_INVALID_GRAN_FIXED,
 255     ASL_MSG_INVALID_GRANULARITY,
 256     ASL_MSG_INVALID_LENGTH,
 257     ASL_MSG_INVALID_LENGTH_FIXED,
 258     ASL_MSG_INVALID_MIN_MAX,
 259     ASL_MSG_INVALID_OPERAND,
 260     ASL_MSG_INVALID_PERFORMANCE,
 261     ASL_MSG_INVALID_PRIORITY,
 262     ASL_MSG_INVALID_STRING,
 263     ASL_MSG_INVALID_TARGET,
 264     ASL_MSG_INVALID_TIME,
 265     ASL_MSG_INVALID_TYPE,
 266     ASL_MSG_INVALID_UUID,
 267     ASL_MSG_ISA_ADDRESS,
 268     ASL_MSG_LEADING_ASTERISK,
 269     ASL_MSG_LIST_LENGTH_LONG,
 270     ASL_MSG_LIST_LENGTH_SHORT,
 271     ASL_MSG_LISTING_FILE_OPEN,
 272     ASL_MSG_LISTING_FILENAME,
 273     ASL_MSG_LOCAL_INIT,
 274     ASL_MSG_LOCAL_OUTSIDE_METHOD,
 275     ASL_MSG_LONG_LINE,
 276     ASL_MSG_MEMORY_ALLOCATION,
 277     ASL_MSG_MISSING_ENDDEPENDENT,
 278     ASL_MSG_MISSING_STARTDEPENDENT,
 279     ASL_MSG_MULTIPLE_DEFAULT,
 280     ASL_MSG_MULTIPLE_TYPES,
 281     ASL_MSG_NAME_EXISTS,
 282     ASL_MSG_NAME_OPTIMIZATION,
 283     ASL_MSG_NAMED_OBJECT_IN_WHILE,
 284     ASL_MSG_NESTED_COMMENT,
 285     ASL_MSG_NO_CASES,
 286     ASL_MSG_NO_REGION,
 287     ASL_MSG_NO_RETVAL,
 288     ASL_MSG_NO_WHILE,
 289     ASL_MSG_NON_ASCII,
 290     ASL_MSG_BUFFER_FIELD_LENGTH,
 291     ASL_MSG_NOT_EXIST,
 292     ASL_MSG_NOT_FOUND,
 293     ASL_MSG_NOT_METHOD,
 294     ASL_MSG_NOT_PARAMETER,
 295     ASL_MSG_NOT_REACHABLE,
 296     ASL_MSG_NOT_REFERENCED,
 297     ASL_MSG_NULL_DESCRIPTOR,
 298     ASL_MSG_NULL_STRING,
 299     ASL_MSG_OPEN,
 300     ASL_MSG_OUTPUT_FILE_OPEN,
 301     ASL_MSG_OUTPUT_FILENAME,
 302     ASL_MSG_PACKAGE_LENGTH,
 303     ASL_MSG_PREPROCESSOR_FILENAME,
 304     ASL_MSG_READ,
 305     ASL_MSG_RECURSION,
 306     ASL_MSG_REGION_BUFFER_ACCESS,
 307     ASL_MSG_REGION_BYTE_ACCESS,
 308     ASL_MSG_RESERVED_ARG_COUNT_HI,
 309     ASL_MSG_RESERVED_ARG_COUNT_LO,
 310     ASL_MSG_RESERVED_METHOD,
 311     ASL_MSG_RESERVED_NO_RETURN_VAL,
 312     ASL_MSG_RESERVED_OPERAND_TYPE,
 313     ASL_MSG_RESERVED_PACKAGE_LENGTH,
 314     ASL_MSG_RESERVED_RETURN_VALUE,
 315     ASL_MSG_RESERVED_USE,
 316     ASL_MSG_RESERVED_WORD,
 317     ASL_MSG_RESOURCE_FIELD,
 318     ASL_MSG_RESOURCE_INDEX,
 319     ASL_MSG_RESOURCE_LIST,
 320     ASL_MSG_RESOURCE_SOURCE,
 321     ASL_MSG_RESULT_NOT_USED,
 322     ASL_MSG_RETURN_TYPES,
 323     ASL_MSG_SCOPE_FWD_REF,
 324     ASL_MSG_SCOPE_TYPE,
 325     ASL_MSG_SEEK,
 326     ASL_MSG_SERIALIZED,
 327     ASL_MSG_SERIALIZED_REQUIRED,
 328     ASL_MSG_SINGLE_NAME_OPTIMIZATION,
 329     ASL_MSG_SOME_NO_RETVAL,
 330     ASL_MSG_STRING_LENGTH,
 331     ASL_MSG_SWITCH_TYPE,
 332     ASL_MSG_SYNC_LEVEL,
 333     ASL_MSG_SYNTAX,
 334     ASL_MSG_TABLE_SIGNATURE,
 335     ASL_MSG_TAG_LARGER,
 336     ASL_MSG_TAG_SMALLER,
 337     ASL_MSG_TIMEOUT,
 338     ASL_MSG_TOO_MANY_TEMPS,
 339     ASL_MSG_TRUNCATION,
 340     ASL_MSG_UNKNOWN_RESERVED_NAME,
 341     ASL_MSG_UNREACHABLE_CODE,
 342     ASL_MSG_UNSUPPORTED,
 343     ASL_MSG_UPPER_CASE,
 344     ASL_MSG_VENDOR_LIST,
 345     ASL_MSG_WRITE,
 346     ASL_MSG_RANGE,
 347     ASL_MSG_BUFFER_ALLOCATION,
 348     ASL_MSG_MISSING_DEPENDENCY,
 349     ASL_MSG_ILLEGAL_FORWARD_REF,
 350     ASL_MSG_ILLEGAL_METHOD_REF,
 351     ASL_MSG_LOCAL_NOT_USED,
 352     ASL_MSG_ARG_AS_LOCAL_NOT_USED,
 353     ASL_MSG_ARG_NOT_USED,
 354     ASL_MSG_CONSTANT_REQUIRED,
 355     ASL_MSG_CROSS_TABLE_SCOPE,
 356     ASL_MSG_EXCEPTION_NOT_RECEIVED,
 357     ASL_MSG_NULL_RESOURCE_TEMPLATE,
 358     ASL_MSG_FOUND_HERE,
 359     ASL_MSG_ILLEGAL_RECURSION,
 360     ASL_MSG_DUPLICATE_INPUT_FILE,
 361     ASL_MSG_WARNING_AS_ERROR,
 362     ASL_MSG_OEM_TABLE_ID,
 363     ASL_MSG_OEM_ID,
 364     ASL_MSG_UNLOAD,
 365     ASL_MSG_OFFSET,
 366     ASL_MSG_LONG_SLEEP,
 367     ASL_MSG_PREFIX_NOT_EXIST,
 368     ASL_MSG_NAMEPATH_NOT_EXIST,
 369     ASL_MSG_REGION_LENGTH,
 370     ASL_MSG_TEMPORARY_OBJECT,
 371     ASL_MSG_UNDEFINED_EXTERNAL,
 372     ASL_MSG_BUFFER_FIELD_OVERFLOW,
 373     ASL_MSG_INVALID_SPECIAL_NAME,
 374     ASL_MSG_INVALID_PROCESSOR_UID,
 375     ASL_MSG_LEGACY_PROCESSOR_OP,
 376     ASL_MSG_NAMESTRING_LENGTH,
 377     ASL_MSG_CASE_FOUND_HERE,
 378     ASL_MSG_EXTERN_INVALID_RET_TYPE,
 379     ASL_MSG_EXTERN_INVALID_PARAM_TYPE,
 380     ASL_MSG_NAMED_OBJECT_CREATION,
 381     ASL_MSG_ARG_COUNT_MISMATCH,
 382     ASL_MSG_STATIC_OPREGION_IN_METHOD,
 383     ASL_MSG_DECLARATION_TYPE_MISMATCH,
 384     ASL_MSG_TYPE_MISMATCH_FOUND_HERE,
 385     ASL_MSG_DUPLICATE_EXTERN_MISMATCH,
 386     ASL_MSG_DUPLICATE_EXTERN_FOUND_HERE,
 387     ASL_MSG_CONDREF_NEEDS_EXTERNAL_DECL,
 388     ASL_MSG_EXTERNAL_FOUND_HERE,
 389     ASL_MSG_LOWER_CASE_NAMESEG,
 390     ASL_MSG_LOWER_CASE_NAMEPATH,
 391     ASL_MSG_UUID_NOT_FOUND,
 392     ASL_MSG_LEGACY_DDB_TYPE,
 393
 394
 395     /* These messages are used by the Data Table compiler only */
 396
 397     ASL_MSG_BUFFER_ELEMENT = ASL_MSG_TABLE_COMPILER,
 398     ASL_MSG_DIVIDE_BY_ZERO,
 399     ASL_MSG_FLAG_VALUE,
 400     ASL_MSG_INTEGER_SIZE,
 401     ASL_MSG_INVALID_EXPRESSION,
 402     ASL_MSG_INVALID_FIELD_NAME,
 403     ASL_MSG_INVALID_HEX_INTEGER,
 404     ASL_MSG_OEM_TABLE,
 405     ASL_MSG_RESERVED_FIELD,
 406     ASL_MSG_UNKNOWN_LABEL,
 407     ASL_MSG_UNKNOWN_SUBTABLE,
 408     ASL_MSG_UNKNOWN_TABLE,
 409     ASL_MSG_ZERO_VALUE,
 410     ASL_MSG_INVALID_LABEL,
 411     ASL_MSG_BUFFER_LIST,
 412     ASL_MSG_ENTRY_LIST,
 413     ASL_MSG_UNKNOWN_FORMAT,
 414     ASL_MSG_RESERVED_VALUE,
 415     ASL_MSG_TWO_ZERO_VALUES,
 416     ASL_MSG_BAD_PARSE_TREE,
 417
 418     /* These messages are used by the Preprocessor only */
 419
 420     ASL_MSG_DIRECTIVE_SYNTAX = ASL_MSG_PREPROCESSOR,
 421     ASL_MSG_ENDIF_MISMATCH,
 422     ASL_MSG_ERROR_DIRECTIVE,
 423     ASL_MSG_EXISTING_NAME,
 424     ASL_MSG_INVALID_INVOCATION,
 425     ASL_MSG_MACRO_SYNTAX,
 426     ASL_MSG_TOO_MANY_ARGUMENTS,
 427     ASL_MSG_UNKNOWN_DIRECTIVE,
 428     ASL_MSG_UNKNOWN_PRAGMA,
 429     ASL_MSG_WARNING_DIRECTIVE,
 430     ASL_MSG_INCLUDE_FILE
 431
 432 } ASL_MESSAGE_IDS;
 433
 434
 435 #endif  /* __ASLMESSAGES_H */