1 /****************************************************************************** 2 * 3 * Module Name: ahaslkey - Table of all known ASL non-operator keywords and 4 * table of iASL Preprocessor directives 5 * 6 *****************************************************************************/ 7 8 /****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999 - 2021, Intel Corp. 13 * All rights reserved. 14 * 15 * 2. License 16 * 17 * 2.1. This is your license from Intel Corp. under its intellectual property 18 * rights. You may have additional license terms from the party that provided 19 * you this software, covering your right to use that party's intellectual 20 * property rights. 21 * 22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 23 * copy of the source code appearing in this file ("Covered Code") an 24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 25 * base code distributed originally by Intel ("Original Intel Code") to copy, 26 * make derivatives, distribute, use and display any portion of the Covered 27 * Code in any form, with the right to sublicense such rights; and 28 * 29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 30 * license (with the right to sublicense), under only those claims of Intel 31 * patents that are infringed by the Original Intel Code, to make, use, sell, 32 * offer to sell, and import the Covered Code and derivative works thereof 33 * solely to the minimum extent necessary to exercise the above copyright 34 * license, and in no event shall the patent license extend to any additions 35 * to or modifications of the Original Intel Code. No other license or right 36 * is granted directly or by implication, estoppel or otherwise; 37 * 38 * The above copyright and patent license is granted only if the following 39 * conditions are met: 40 * 41 * 3. Conditions 42 * 43 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 44 * Redistribution of source code of any substantial portion of the Covered 45 * Code or modification with rights to further distribute source must include 46 * the above Copyright Notice, the above License, this list of Conditions, 47 * and the following Disclaimer and Export Compliance provision. In addition, 48 * Licensee must cause all Covered Code to which Licensee contributes to 49 * contain a file documenting the changes Licensee made to create that Covered 50 * Code and the date of any change. Licensee must include in that file the 51 * documentation of any changes made by any predecessor Licensee. Licensee 52 * must include a prominent statement that the modification is derived, 53 * directly or indirectly, from Original Intel Code. 54 * 55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 56 * Redistribution of source code of any substantial portion of the Covered 57 * Code or modification without rights to further distribute source must 58 * include the following Disclaimer and Export Compliance provision in the 59 * documentation and/or other materials provided with distribution. In 60 * addition, Licensee may not authorize further sublicense of source of any 61 * portion of the Covered Code, and must include terms to the effect that the 62 * license from Licensee to its licensee is limited to the intellectual 63 * property embodied in the software Licensee provides to its licensee, and 64 * not to intellectual property embodied in modifications its licensee may 65 * make. 66 * 67 * 3.3. Redistribution of Executable. Redistribution in executable form of any 68 * substantial portion of the Covered Code or modification must reproduce the 69 * above Copyright Notice, and the following Disclaimer and Export Compliance 70 * provision in the documentation and/or other materials provided with the 71 * distribution. 72 * 73 * 3.4. Intel retains all right, title, and interest in and to the Original 74 * Intel Code. 75 * 76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 77 * Intel shall be used in advertising or otherwise to promote the sale, use or 78 * other dealings in products derived from or relating to the Covered Code 79 * without prior written authorization from Intel. 80 * 81 * 4. Disclaimer and Export Compliance 82 * 83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 89 * PARTICULAR PURPOSE. 90 * 91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 98 * LIMITED REMEDY. 99 * 100 * 4.3. Licensee shall not export, either directly or indirectly, any of this 101 * software or system incorporating such software without first obtaining any 102 * required license or other approval from the U. S. Department of Commerce or 103 * any other agency or department of the United States Government. In the 104 * event Licensee exports any such software from the United States or 105 * re-exports any such software from a foreign destination, Licensee shall 106 * ensure that the distribution and export/re-export of the software is in 107 * compliance with all laws, regulations, orders, or other restrictions of the 108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 109 * any of its subsidiaries will export/re-export any technical data, process, 110 * software, or service, directly or indirectly, to any country for which the 111 * United States government or any agency thereof requires an export license, 112 * other governmental approval, or letter of assurance, without first obtaining 113 * such license, approval or letter. 114 * 115 ***************************************************************************** 116 * 117 * Alternatively, you may choose to be licensed under the terms of the 118 * following license: 119 * 120 * Redistribution and use in source and binary forms, with or without 121 * modification, are permitted provided that the following conditions 122 * are met: 123 * 1. Redistributions of source code must retain the above copyright 124 * notice, this list of conditions, and the following disclaimer, 125 * without modification. 126 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 127 * substantially similar to the "NO WARRANTY" disclaimer below 128 * ("Disclaimer") and any redistribution must be conditioned upon 129 * including a substantially similar Disclaimer requirement for further 130 * binary redistribution. 131 * 3. Neither the names of the above-listed copyright holders nor the names 132 * of any contributors may be used to endorse or promote products derived 133 * from this software without specific prior written permission. 134 * 135 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 136 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 137 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 138 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 139 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 140 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 141 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 142 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 143 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 144 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 145 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 146 * 147 * Alternatively, you may choose to be licensed under the terms of the 148 * GNU General Public License ("GPL") version 2 as published by the Free 149 * Software Foundation. 150 * 151 *****************************************************************************/ 152 153 #include "acpihelp.h" 154 155 /* 156 * ASL Keyword types and associated actual keywords. 157 * This table was extracted from the ACPI specification. 158 */ 159 const AH_ASL_KEYWORD Gbl_AslKeywordInfo[] = 160 { 161 {"AccessAttribKeyword", "Serial Bus Attributes (with legacy SMBus aliases)", 162 ":= AttribQuick (SMBusQuick) | AttribSendReceive (SMBusSendReceive) | " 163 "AttribByte (SMBusByte) | AttribWord (SMBusWord) | " 164 "AttribBlock (SMBusBlock) | AttribProcessCall (SMBusProcessCall) | " 165 "AttribBlockProcessCall (SMBusProcessCall)"}, 166 {"AccessTypeKeyword", "Field Access Types", 167 ":= AnyAcc | ByteAcc | WordAcc | DWordAcc | QWordAcc | BufferAcc"}, 168 {"AddressingModeKeyword", "Mode - Resource Descriptors", 169 ":= AddressingMode7Bit | AddressingMode10Bit"}, 170 {"AddressKeyword", "ACPI memory range types", 171 ":= AddressRangeMemory | AddressRangeReserved | " 172 "AddressRangeNVS | AddressRangeACPI"}, 173 {"AddressSpaceKeyword", "Operation Region Address Space Types", 174 ":= RegionSpaceKeyword | FFixedHW"}, 175 {"BusMasterKeyword", "DMA Bus Mastering", 176 ":= BusMaster | NotBusMaster"}, 177 {"ByteLengthKeyword", "Bits per Byte - Resource Descriptors", 178 ":= DataBitsFive | DataBitsSix | DataBitsSeven | DataBitsEight | DataBitsNine"}, 179 {"ClockPhaseKeyword", "Resource Descriptors", 180 ":= ClockPhaseFirst | ClockPhaseSecond"}, 181 {"ClockPolarityKeyword", "Resource Descriptors", 182 ":= ClockPolarityLow | ClockPolarityHigh"}, 183 {"DecodeKeyword", "Type of Memory Decoding - Resource Descriptors", 184 ":= SubDecode | PosDecode"}, 185 {"DmaTypeKeyword", "DMA Types - DMA Resource Descriptor", 186 ":= Compatibility | TypeA | TypeB | TypeF"}, 187 {"EndianKeyword", "Endian type - Resource Descriptor", 188 ":= BigEndian | LittleEndian"}, 189 {"ExtendedAttribKeyword", "Extended Bus Attributes", 190 ":= AttribBytes (AccessLength) | AttribRawBytes (AccessLength) | " 191 "AttribRawProcessBytes (AccessLength)"}, 192 {"FlowControlKeyword", "Resource Descriptor", 193 ":= FlowControlNone | FlowControlXon | FlowControlHardware"}, 194 {"InterruptLevelKeyword", "Interrupt Active Types", 195 ":= ActiveHigh | ActiveLow | ActiveBoth"}, 196 {"InterruptTypeKeyword", "Interrupt Types", 197 ":= Edge | Level"}, 198 {"IoDecodeKeyword", "I/O Decoding - IO Resource Descriptor", 199 ":= Decode16 | Decode10"}, 200 {"IoRestrictionKeyword", "I/O Restriction - GPIO Resource Descriptors", 201 ":= IoRestrictionNone | IoRestrictionInputOnly | " 202 "IoRestrictionOutputOnly | IoRestrictionNoneAndPreserve"}, 203 {"LockRuleKeyword", "Global Lock use for Field Operator", 204 ":= Lock | NoLock"}, 205 {"MatchOpKeyword", "Types for Match Operator", 206 ":= MTR | MEQ | MLE | MLT | MGE | MGT"}, 207 {"MaxKeyword", "Max Range Type - Resource Descriptors", 208 ":= MaxFixed | MaxNotFixed"}, 209 {"MemTypeKeyword", "Memory Types - Resource Descriptors", 210 ":= Cacheable | WriteCombining | Prefetchable | NonCacheable"}, 211 {"MinKeyword", "Min Range Type - Resource Descriptors", 212 ":= MinFixed | MinNotFixed"}, 213 {"ObjectTypeKeyword", "ACPI Object Types", 214 ":= UnknownObj | IntObj | StrObj | BuffObj | PkgObj | FieldUnitObj | " 215 "DeviceObj | EventObj | MethodObj | MutexObj | OpRegionObj | PowerResObj | " 216 "ProcessorObj | ThermalZoneObj | BuffFieldObj | DDBHandleObj"}, 217 {"ParityKeyword", "Resource Descriptors", 218 ":= ParityTypeNone | ParityTypeSpace | ParityTypeMark | " 219 "ParityTypeOdd | ParityTypeEven"}, 220 {"PinConfigKeyword", "Pin Configuration - GPIO Resource Descriptors", 221 ":= PullDefault | PullUp | PullDown | PullNone"}, 222 {"PolarityKeyword", "Resource Descriptors", 223 ":= PolarityHigh | PolarityLow"}, 224 {"RangeTypeKeyword", "I/O Range Types - Resource Descriptors", 225 ":= ISAOnlyRanges | NonISAOnlyRanges | EntireRange"}, 226 {"ReadWriteKeyword", "Memory Access Types - Resource Descriptors", 227 ":= ReadWrite | ReadOnly"}, 228 {"RegionSpaceKeyword", "Operation Region Address Space Types", 229 ":= UserDefRegionSpace | SystemIO | SystemMemory | PCI_Config | " 230 "EmbeddedControl | SMBus | SystemCMOS | PciBarTarget | IPMI | " 231 "GeneralPurposeIo, GenericSerialBus"}, 232 {"ResourceTypeKeyword", "Resource Usage - Resource Descriptors", 233 ":= ResourceConsumer | ResourceProducer"}, 234 {"SerializeRuleKeyword", "Control Method Serialization", 235 ":= Serialized | NotSerialized"}, 236 {"ShareTypeKeyword", "Interrupt Sharing - Resource Descriptors", 237 ":= Shared | Exclusive | SharedAndWake | ExclusiveAndWake"}, 238 {"SlaveModeKeyword", "Resource Descriptors", 239 ":= ControllerInitiated | DeviceInitiated"}, 240 {"StopBitsKeyword", "Resource Descriptors", 241 ":= StopBitsZero | StopBitsOne | StopBitsOnePlusHalf | StopBitsTwo"}, 242 {"TransferWidthKeyword", "DMA Widths - Fixed DMA Resource Descriptor", 243 ":= Width8bit | Width16bit | Width32bit | Width64bit | " 244 "Width128bit | Width256bit"}, 245 {"TranslationKeyword", "Translation Density Types - Resource Descriptors", 246 ":= SparseTranslation | DenseTranslation"}, 247 {"TypeKeyword", "Translation Types - Resource Descriptors", 248 ":= TypeTranslation | TypeStatic"}, 249 {"UpdateRuleKeyword", "Field Update Rules", 250 ":= Preserve | WriteAsOnes | WriteAsZeros"}, 251 {"UserDefRegionSpace", "User defined address spaces", 252 ":= IntegerData => 0x80 - 0xFF"}, 253 {"WireModeKeyword", "SPI Wire Mode - Resource Descriptors", 254 ":= ThreeWireMode | FourWireMode"}, 255 {"XferTypeKeyword", "DMA Transfer Types", 256 ":= Transfer8 | Transfer16 | Transfer8_16"}, 257 {NULL, NULL, NULL} 258 }; 259 260 /* Preprocessor directives */ 261 262 const AH_DIRECTIVE_INFO Gbl_PreprocessorDirectives[] = 263 { 264 {"#include \"Filename\"", "Standard include of an ASCII ASL source code file"}, 265 {"#include <Filename>", "Alternate syntax for #include, alternate search path"}, 266 {"#includebuffer \"Filename\" <Name>", "Include a binary file to create AML Buffer with ASL namepath"}, 267 {"#includebuffer <Filename> <Name>", "Alternate syntax for #includebuffer, alternate search path"}, 268 269 {"", ""}, 270 {"#define <Name>, <Defined name>", "Simple macro definition (full macros not supported at this time)"}, 271 {"#define <Expression>, <Defined name>","Simple macro definition (full macros not supported at this time)"}, 272 {"#undef <Defined name>", "Delete a previous #define"}, 273 274 {"", ""}, 275 {"#if <Expression>", "Evaluate <Expression> and test return value"}, 276 {"#ifdef <Defined name>", "Test existence of the <Defined Name>"}, 277 {"#ifndef <Defined name>", "Test non-existence of the <Defined Name>"}, 278 {"#elif <Expression>", "Else-If contraction - evaluate #if <Expression>, test return value"}, 279 {"#else", "Execute alternate case for a previous #if, #ifdef or #ifndef block"}, 280 {"#endif", "Close a previous #if, #ifdef or #ifndef block"}, 281 282 {"", ""}, 283 {"#line <LineNumber> [Filename]", "Set the current ASL source code line number, optional filename"}, 284 285 {"", ""}, 286 {"#error \"String\"", "Emit error message and abort compilation"}, 287 {"#warning \"String\"", "Emit an iASL warning at this location in the ASL source"}, 288 289 {"", ""}, 290 {"#pragma disable (Error number)", "Disable an iASL error or warning number"}, 291 {"#pragma message \"String\"", "Emit an informational message to the output file(s)"}, 292 293 {"", ""}, 294 {"__FILE__", "Return the simple filename of the current ASL file"}, 295 {"__PATH__", "Return the full pathname of the current ASL file"}, 296 {"__LINE__", "Return the current line number within the current ASL file"}, 297 {"__DATE__", "Return the current date"}, 298 {"__METHOD__", "Return the declared name of the current control method"}, 299 {"__IASL__", "Permanently defined for the iASL compiler"}, 300 {NULL, NULL} 301 }; 302