drivers/acpi/tools/acpihelp/ahaslkey.c

   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 - 2015, 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 #include "acpihelp.h"
 118
 119 /*
 120  * ASL Keyword types and associated actual keywords.
 121  * This table was extracted from the ACPI specification.
 122  */
 123 const AH_ASL_KEYWORD        AslKeywordInfo[] =
 124 {
 125     {"AccessAttribKeyword", "Serial Bus Attributes (with legacy SMBus aliases)",
 126         ":= AttribQuick (SMBusQuick) | AttribSendReceive (SMBusSendReceive) | "
 127         "AttribByte (SMBusByte) | AttribWord (SMBusWord) | "
 128         "AttribBlock (SMBusBlock) | AttribProcessCall (SMBusProcessCall) | "
 129         "AttribBlockProcessCall (SMBusProcessCall)"},
 130     {"AccessTypeKeyword", "Field Access Types",
 131         ":= AnyAcc | ByteAcc | WordAcc | DWordAcc | QWordAcc | BufferAcc"},
 132     {"AddressingModeKeyword", "Mode - Resource Descriptors",
 133         ":= AddressingMode7Bit | AddressingMode10Bit"},
 134     {"AddressKeyword", "ACPI memory range types",
 135         ":= AddressRangeMemory | AddressRangeReserved | "
 136         "AddressRangeNVS | AddressRangeACPI"},
 137     {"AddressSpaceKeyword", "Operation Region Address Space Types",
 138         ":= RegionSpaceKeyword | FFixedHW"},
 139     {"BusMasterKeyword", "DMA Bus Mastering",
 140         ":= BusMaster | NotBusMaster"},
 141     {"ByteLengthKeyword", "Bits per Byte - Resource Descriptors",
 142         ":= DataBitsFive | DataBitsSix | DataBitsSeven | DataBitsEight | DataBitsNine"},
 143     {"ClockPhaseKeyword", "Resource Descriptors",
 144         ":= ClockPhaseFirst | ClockPhaseSecond"},
 145     {"ClockPolarityKeyword", "Resource Descriptors",
 146         ":= ClockPolarityLow | ClockPolarityHigh"},
 147     {"DecodeKeyword", "Type of Memory Decoding - Resource Descriptors",
 148         ":= SubDecode | PosDecode"},
 149     {"DmaTypeKeyword", "DMA Types - DMA Resource Descriptor",
 150         ":= Compatibility | TypeA | TypeB | TypeF"},
 151     {"EndianKeyword", "Endian type - Resource Descriptor",
 152         ":= BigEndian | LittleEndian"},
 153     {"ExtendedAttribKeyword", "Extended Bus Attributes",
 154         ":= AttribBytes (AccessLength) | AttribRawBytes (AccessLength) | "
 155         "AttribRawProcessBytes (AccessLength)"},
 156     {"FlowControlKeyword", "Resource Descriptor",
 157         ":= FlowControlNone | FlowControlXon | FlowControlHardware"},
 158     {"InterruptLevelKeyword", "Interrupt Active Types",
 159         ":= ActiveHigh | ActiveLow | ActiveBoth"},
 160     {"InterruptTypeKeyword", "Interrupt Types",
 161         ":= Edge | Level"},
 162     {"IoDecodeKeyword", "I/O Decoding - IO Resource Descriptor",
 163         ":= Decode16 | Decode10"},
 164     {"IoRestrictionKeyword", "I/O Restriction - GPIO Resource Descriptors",
 165         ":= IoRestrictionNone | IoRestrictionInputOnly | "
 166         "IoRestrictionOutputOnly | IoRestrictionNoneAndPreserve"},
 167     {"LockRuleKeyword", "Global Lock use for Field Operator",
 168         ":= Lock | NoLock"},
 169     {"MatchOpKeyword", "Types for Match Operator",
 170         ":= MTR | MEQ | MLE | MLT | MGE | MGT"},
 171     {"MaxKeyword", "Max Range Type - Resource Descriptors",
 172         ":= MaxFixed | MaxNotFixed"},
 173     {"MemTypeKeyword", "Memory Types - Resource Descriptors",
 174         ":= Cacheable | WriteCombining | Prefetchable | NonCacheable"},
 175     {"MinKeyword", "Min Range Type - Resource Descriptors",
 176         ":= MinFixed | MinNotFixed"},
 177     {"ObjectTypeKeyword", "ACPI Object Types",
 178         ":= UnknownObj | IntObj | StrObj | BuffObj | PkgObj | FieldUnitObj | "
 179         "DeviceObj | EventObj | MethodObj | MutexObj | OpRegionObj | PowerResObj | "
 180         "ProcessorObj | ThermalZoneObj | BuffFieldObj | DDBHandleObj"},
 181     {"ParityKeyword", "Resource Descriptors",
 182         ":= ParityTypeNone | ParityTypeSpace | ParityTypeMark | "
 183         "ParityTypeOdd | ParityTypeEven"},
 184     {"PinConfigKeyword", "Pin Configuration - GPIO Resource Descriptors",
 185         ":= PullDefault | PullUp | PullDown | PullNone"},
 186     {"PolarityKeyword", "Resource Descriptors",
 187         ":= PolarityHigh | PolarityLow"},
 188     {"RangeTypeKeyword", "I/O Range Types - Resource Descriptors",
 189         ":= ISAOnlyRanges | NonISAOnlyRanges | EntireRange"},
 190     {"ReadWriteKeyword", "Memory Access Types - Resource Descriptors",
 191         ":= ReadWrite | ReadOnly"},
 192     {"RegionSpaceKeyword", "Operation Region Address Space Types",
 193         ":= UserDefRegionSpace | SystemIO | SystemMemory | PCI_Config | "
 194         "EmbeddedControl | SMBus | SystemCMOS | PciBarTarget | IPMI | "
 195         "GeneralPurposeIo, GenericSerialBus"},
 196     {"ResourceTypeKeyword", "Resource Usage - Resource Descriptors",
 197         ":= ResourceConsumer | ResourceProducer"},
 198     {"SerializeRuleKeyword", "Control Method Serialization",
 199         ":= Serialized | NotSerialized"},
 200     {"ShareTypeKeyword", "Interrupt Sharing - Resource Descriptors",
 201         ":= Shared | Exclusive | SharedAndWake | ExclusiveAndWake"},
 202     {"SlaveModeKeyword", "Resource Descriptors",
 203         ":= ControllerInitiated | DeviceInitiated"},
 204     {"StopBitsKeyword", "Resource Descriptors",
 205         ":= StopBitsZero | StopBitsOne | StopBitsOnePlusHalf | StopBitsTwo"},
 206     {"TransferWidthKeyword", "DMA Widths - Fixed DMA Resource Descriptor",
 207         ":= Width8bit | Width16bit | Width32bit | Width64bit | "
 208         "Width128bit | Width256bit"},
 209     {"TranslationKeyword", "Translation Density Types - Resource Descriptors",
 210         ":= SparseTranslation | DenseTranslation"},
 211     {"TypeKeyword", "Translation Types - Resource Descriptors",
 212         ":= TypeTranslation | TypeStatic"},
 213     {"UpdateRuleKeyword", "Field Update Rules",
 214         ":= Preserve | WriteAsOnes | WriteAsZeros"},
 215     {"UserDefRegionSpace", "User defined address spaces",
 216         ":= IntegerData => 0x80 - 0xFF"},
 217     {"WireModeKeyword", "SPI Wire Mode - Resource Descriptors",
 218         ":= ThreeWireMode | FourWireMode"},
 219     {"XferTypeKeyword", "DMA Transfer Types",
 220         ":= Transfer8 | Transfer16 | Transfer8_16"},
 221     {NULL, NULL, NULL}
 222 };
 223
 224 /* Preprocessor directives */
 225
 226 const AH_DIRECTIVE_INFO      PreprocessorDirectives[] =
 227 {
 228     {"#define",         "OriginalName, DefinedName"},
 229     {"#elif",           "Expression"},
 230     {"#else",           ""},
 231     {"#endif",          ""},
 232     {"#error",          "Message"},
 233     {"#if",             "Expression"},
 234     {"#ifdef",          "DefinedName"},
 235     {"#ifndef",         "DefinedName"},
 236     {"#include",        "\"Filename\""},
 237     {"#include",        "<Filename>"},
 238     {"#includebuffer",  "\"Filename\""},
 239     {"#includebuffer",  "<Filename>"},
 240     {"#line",           ""},
 241     {"#pragma",         "Disable error-number"},
 242     {"#pragma",         "Message"},
 243     {"#undef",          "DefinedName"},
 244     {"#warning",        ""},
 245     {"__DATE__",        "Returns current date"},
 246     {"__FILE__",        "Returns name of current ASL file"},
 247     {"__LINE__",        "Returns line number in ASL file"},
 248     {"__PATH__",        "Returns full pathname of current ASL file"},
 249     {NULL,              0}
 250 };