asltypes.h revision 285797
1118611Snjl/****************************************************************************** 2118611Snjl * 3118611Snjl * Module Name: asltypes.h - compiler data types and struct definitions 4118611Snjl * 5118611Snjl *****************************************************************************/ 6118611Snjl 7217365Sjkim/* 8278970Sjkim * Copyright (C) 2000 - 2015, Intel Corp. 9118611Snjl * All rights reserved. 10118611Snjl * 11217365Sjkim * Redistribution and use in source and binary forms, with or without 12217365Sjkim * modification, are permitted provided that the following conditions 13217365Sjkim * are met: 14217365Sjkim * 1. Redistributions of source code must retain the above copyright 15217365Sjkim * notice, this list of conditions, and the following disclaimer, 16217365Sjkim * without modification. 17217365Sjkim * 2. Redistributions in binary form must reproduce at minimum a disclaimer 18217365Sjkim * substantially similar to the "NO WARRANTY" disclaimer below 19217365Sjkim * ("Disclaimer") and any redistribution must be conditioned upon 20217365Sjkim * including a substantially similar Disclaimer requirement for further 21217365Sjkim * binary redistribution. 22217365Sjkim * 3. Neither the names of the above-listed copyright holders nor the names 23217365Sjkim * of any contributors may be used to endorse or promote products derived 24217365Sjkim * from this software without specific prior written permission. 25118611Snjl * 26217365Sjkim * Alternatively, this software may be distributed under the terms of the 27217365Sjkim * GNU General Public License ("GPL") version 2 as published by the Free 28217365Sjkim * Software Foundation. 29118611Snjl * 30217365Sjkim * NO WARRANTY 31217365Sjkim * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 32217365Sjkim * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 33217365Sjkim * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR 34217365Sjkim * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 35217365Sjkim * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 36217365Sjkim * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 37217365Sjkim * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 38217365Sjkim * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 39217365Sjkim * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 40217365Sjkim * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 41217365Sjkim * POSSIBILITY OF SUCH DAMAGES. 42217365Sjkim */ 43118611Snjl 44118611Snjl#ifndef __ASLTYPES_H 45118611Snjl#define __ASLTYPES_H 46118611Snjl 47118611Snjl 48118611Snjl/******************************************************************************* 49118611Snjl * 50118611Snjl * Structure definitions 51118611Snjl * 52118611Snjl ******************************************************************************/ 53118611Snjl 54118611Snjl 55118611Snjl/* Op flags for the ACPI_PARSE_OBJECT */ 56118611Snjl 57118611Snjl#define NODE_VISITED 0x00000001 58118611Snjl#define NODE_AML_PACKAGE 0x00000002 59118611Snjl#define NODE_IS_TARGET 0x00000004 60118611Snjl#define NODE_IS_RESOURCE_DESC 0x00000008 61118611Snjl#define NODE_IS_RESOURCE_FIELD 0x00000010 62118611Snjl#define NODE_HAS_NO_EXIT 0x00000020 63118611Snjl#define NODE_IF_HAS_NO_EXIT 0x00000040 64118611Snjl#define NODE_NAME_INTERNALIZED 0x00000080 65118611Snjl#define NODE_METHOD_NO_RETVAL 0x00000100 66118611Snjl#define NODE_METHOD_SOME_NO_RETVAL 0x00000200 67118611Snjl#define NODE_RESULT_NOT_USED 0x00000400 68118611Snjl#define NODE_METHOD_TYPED 0x00000800 69228110Sjkim#define NODE_UNUSED_FLAG 0x00001000 70118611Snjl#define NODE_COMPILE_TIME_CONST 0x00002000 71118611Snjl#define NODE_IS_TERM_ARG 0x00004000 72118611Snjl#define NODE_WAS_ONES_OP 0x00008000 73118611Snjl#define NODE_IS_NAME_DECLARATION 0x00010000 74138287Smarks#define NODE_COMPILER_EMITTED 0x00020000 75151937Sjkim#define NODE_IS_DUPLICATE 0x00040000 76167802Sjkim#define NODE_IS_RESOURCE_DATA 0x00080000 77220663Sjkim#define NODE_IS_NULL_RETURN 0x00100000 78118611Snjl 79118611Snjl/* Keeps information about individual control methods */ 80118611Snjl 81118611Snjltypedef struct asl_method_info 82118611Snjl{ 83250838Sjkim ACPI_PARSE_OBJECT *Op; 84250838Sjkim struct asl_method_info *Next; 85138287Smarks UINT32 ValidArgTypes[ACPI_METHOD_NUM_ARGS]; 86138287Smarks UINT32 ValidReturnTypes; 87118611Snjl UINT32 NumReturnNoValue; 88118611Snjl UINT32 NumReturnWithValue; 89250838Sjkim UINT8 NumArguments; 90250838Sjkim UINT8 LocalInitialized[ACPI_METHOD_NUM_LOCALS]; 91250838Sjkim UINT8 ArgInitialized[ACPI_METHOD_NUM_ARGS]; 92118611Snjl UINT8 HasBeenTyped; 93250838Sjkim UINT8 ShouldBeSerialized; 94118611Snjl 95118611Snjl} ASL_METHOD_INFO; 96118611Snjl 97118611Snjl 98118611Snjl/* Parse tree walk info for control method analysis */ 99118611Snjl 100118611Snjltypedef struct asl_analysis_walk_info 101118611Snjl{ 102118611Snjl ASL_METHOD_INFO *MethodStack; 103118611Snjl 104118611Snjl} ASL_ANALYSIS_WALK_INFO; 105118611Snjl 106118611Snjl 107118611Snjl/* An entry in the ParseOpcode to AmlOpcode mapping table */ 108118611Snjl 109118611Snjltypedef struct asl_mapping_entry 110118611Snjl{ 111118611Snjl UINT32 Value; 112118611Snjl UINT32 AcpiBtype; /* Object type or return type */ 113118611Snjl UINT16 AmlOpcode; 114118611Snjl UINT8 Flags; 115118611Snjl 116118611Snjl} ASL_MAPPING_ENTRY; 117118611Snjl 118118611Snjl 119118611Snjl/* Parse tree walk info structure */ 120118611Snjl 121118611Snjltypedef struct asl_walk_info 122118611Snjl{ 123118611Snjl ACPI_PARSE_OBJECT **NodePtr; 124118611Snjl UINT32 *LevelPtr; 125118611Snjl 126118611Snjl} ASL_WALK_INFO; 127118611Snjl 128118611Snjl 129118611Snjl/* File info */ 130118611Snjl 131118611Snjltypedef struct asl_file_info 132118611Snjl{ 133118611Snjl FILE *Handle; 134118611Snjl char *Filename; 135240716Sjkim const char *ShortDescription; 136240716Sjkim const char *Description; 137118611Snjl 138118611Snjl} ASL_FILE_INFO; 139118611Snjl 140167802Sjkimtypedef struct asl_file_status 141167802Sjkim{ 142167802Sjkim UINT32 Line; 143167802Sjkim UINT32 Offset; 144118611Snjl 145167802Sjkim} ASL_FILE_STATUS; 146167802Sjkim 147167802Sjkim 148228110Sjkim/* 149228110Sjkim * File types. Note: Any changes to this table must also be reflected 150240716Sjkim * in the Gbl_Files array. 151284583Sjkim * 152284583Sjkim * Corresponding filename suffixes are in comments 153284583Sjkim * 154284583Sjkim * NOTE: Don't move the first 4 file types 155228110Sjkim */ 156118611Snjltypedef enum 157118611Snjl{ 158118611Snjl ASL_FILE_STDOUT = 0, 159118611Snjl ASL_FILE_STDERR, 160284583Sjkim ASL_FILE_INPUT, /* .asl */ 161284583Sjkim ASL_FILE_AML_OUTPUT, /* .aml */ 162284583Sjkim ASL_FILE_SOURCE_OUTPUT, /* .src */ 163284583Sjkim ASL_FILE_PREPROCESSOR, /* .pre */ 164284583Sjkim ASL_FILE_PREPROCESSOR_USER, /* .i */ 165284583Sjkim ASL_FILE_LISTING_OUTPUT, /* .lst */ 166284583Sjkim ASL_FILE_HEX_OUTPUT, /* .hex */ 167284583Sjkim ASL_FILE_NAMESPACE_OUTPUT, /* .nsp */ 168284583Sjkim ASL_FILE_DEBUG_OUTPUT, /* .txt */ 169284583Sjkim ASL_FILE_ASM_SOURCE_OUTPUT, /* .asm */ 170284583Sjkim ASL_FILE_C_SOURCE_OUTPUT, /* .c */ 171284583Sjkim ASL_FILE_ASM_INCLUDE_OUTPUT,/* .inc */ 172284583Sjkim ASL_FILE_C_INCLUDE_OUTPUT, /* .h */ 173284583Sjkim ASL_FILE_C_OFFSET_OUTPUT, /* offset.h */ 174284583Sjkim ASL_FILE_MAP_OUTPUT /* .map */ 175118611Snjl 176118611Snjl} ASL_FILE_TYPES; 177118611Snjl 178118611Snjl 179284583Sjkim#define ASL_MAX_FILE_TYPE 16 180118611Snjl#define ASL_NUM_FILES (ASL_MAX_FILE_TYPE + 1) 181118611Snjl 182284583Sjkim/* filename suffixes for output files */ 183118611Snjl 184284583Sjkim#define FILE_SUFFIX_PREPROC_USER "i " 185284583Sjkim#define FILE_SUFFIX_PREPROCESSOR "pre" 186284583Sjkim#define FILE_SUFFIX_AML_CODE "aml" 187284583Sjkim#define FILE_SUFFIX_MAP "map" 188284583Sjkim#define FILE_SUFFIX_LISTING "lst" 189284583Sjkim#define FILE_SUFFIX_HEX_DUMP "hex" 190284583Sjkim#define FILE_SUFFIX_DEBUG "txt" 191284583Sjkim#define FILE_SUFFIX_SOURCE "src" 192284583Sjkim#define FILE_SUFFIX_NAMESPACE "nsp" 193284583Sjkim#define FILE_SUFFIX_ASM_SOURCE "asm" 194284583Sjkim#define FILE_SUFFIX_C_SOURCE "c" 195284583Sjkim#define FILE_SUFFIX_DISASSEMBLY "dsl" 196284583Sjkim#define FILE_SUFFIX_ASM_INCLUDE "inc" 197284583Sjkim#define FILE_SUFFIX_C_INCLUDE "h" 198284583Sjkim#define FILE_SUFFIX_ASL_CODE "asl" 199284583Sjkim#define FILE_SUFFIX_C_OFFSET "offset.h" 200284583Sjkim 201284583Sjkim 202272444Sjkim/* Cache block structure for ParseOps and Strings */ 203272444Sjkim 204272444Sjkimtypedef struct asl_cache_info 205272444Sjkim{ 206272444Sjkim void *Next; 207272444Sjkim char Buffer[1]; 208272444Sjkim 209272444Sjkim} ASL_CACHE_INFO; 210272444Sjkim 211272444Sjkim 212197104Sjkimtypedef struct asl_include_dir 213197104Sjkim{ 214197104Sjkim char *Dir; 215197104Sjkim struct asl_include_dir *Next; 216197104Sjkim 217197104Sjkim} ASL_INCLUDE_DIR; 218197104Sjkim 219197104Sjkim 220118611Snjl/* An entry in the exception list, one for each error/warning */ 221118611Snjl 222118611Snjltypedef struct asl_error_msg 223118611Snjl{ 224118611Snjl UINT32 LineNumber; 225118611Snjl UINT32 LogicalLineNumber; 226118611Snjl UINT32 LogicalByteOffset; 227118611Snjl UINT32 Column; 228118611Snjl char *Message; 229118611Snjl struct asl_error_msg *Next; 230118611Snjl char *Filename; 231233250Sjkim char *SourceLine; 232118611Snjl UINT32 FilenameLength; 233272444Sjkim UINT16 MessageId; 234118611Snjl UINT8 Level; 235118611Snjl 236118611Snjl} ASL_ERROR_MSG; 237118611Snjl 238118611Snjl 239118611Snjl/* An entry in the listing file stack (for include files) */ 240118611Snjl 241118611Snjltypedef struct asl_listing_node 242118611Snjl{ 243118611Snjl char *Filename; 244118611Snjl UINT32 LineNumber; 245118611Snjl struct asl_listing_node *Next; 246118611Snjl 247118611Snjl} ASL_LISTING_NODE; 248118611Snjl 249118611Snjl 250118611Snjl/* Callback interface for a parse tree walk */ 251118611Snjl 252209746Sjkim/* 253209746Sjkim * TBD - another copy of this is in adisasm.h, fix 254209746Sjkim */ 255209746Sjkim#ifndef ASL_WALK_CALLBACK_DEFINED 256118611Snjltypedef 257118611SnjlACPI_STATUS (*ASL_WALK_CALLBACK) ( 258118611Snjl ACPI_PARSE_OBJECT *Op, 259118611Snjl UINT32 Level, 260118611Snjl void *Context); 261209746Sjkim#define ASL_WALK_CALLBACK_DEFINED 262209746Sjkim#endif 263118611Snjl 264118611Snjl 265118611Snjltypedef struct asl_event_info 266118611Snjl{ 267151937Sjkim UINT64 StartTime; 268151937Sjkim UINT64 EndTime; 269118611Snjl char *EventName; 270118611Snjl BOOLEAN Valid; 271118611Snjl 272118611Snjl} ASL_EVENT_INFO; 273118611Snjl 274118611Snjl 275272444Sjkim/* Hardware mapping file structures */ 276272444Sjkim 277272444Sjkimtypedef struct acpi_gpio_info 278272444Sjkim{ 279272444Sjkim struct acpi_gpio_info *Next; 280272444Sjkim ACPI_PARSE_OBJECT *Op; 281272444Sjkim char *DeviceName; 282272444Sjkim ACPI_NAMESPACE_NODE *TargetNode; 283272444Sjkim UINT32 References; 284272444Sjkim UINT32 PinCount; 285272444Sjkim UINT32 PinIndex; 286272444Sjkim UINT16 PinNumber; 287272444Sjkim UINT8 Type; 288272444Sjkim UINT8 Direction; 289272444Sjkim UINT8 Polarity; 290272444Sjkim 291272444Sjkim} ACPI_GPIO_INFO; 292272444Sjkim 293272444Sjkimtypedef struct acpi_serial_info 294272444Sjkim{ 295272444Sjkim struct acpi_serial_info *Next; 296272444Sjkim ACPI_PARSE_OBJECT *Op; 297272444Sjkim char *DeviceName; 298272444Sjkim ACPI_NAMESPACE_NODE *TargetNode; 299272444Sjkim AML_RESOURCE *Resource; 300272444Sjkim UINT32 Speed; 301272444Sjkim UINT16 Address; 302272444Sjkim 303272444Sjkim} ACPI_SERIAL_INFO; 304272444Sjkim 305285797Sjkimtypedef struct asl_method_local 306285797Sjkim{ 307285797Sjkim ACPI_PARSE_OBJECT *Op; 308285797Sjkim UINT8 Flags; 309272444Sjkim 310285797Sjkim} ASL_METHOD_LOCAL; 311285797Sjkim 312285797Sjkim/* Values for Flags field above */ 313285797Sjkim 314285797Sjkim#define ASL_LOCAL_INITIALIZED (1) 315285797Sjkim#define ASL_LOCAL_REFERENCED (1<<1) 316285797Sjkim#define ASL_ARG_IS_LOCAL (1<<2) 317285797Sjkim#define ASL_ARG_INITIALIZED (1<<3) 318285797Sjkim#define ASL_ARG_REFERENCED (1<<4) 319285797Sjkim 320118611Snjl#endif /* __ASLTYPES_H */ 321