1 /****************************************************************************** 2 * 3 * Module Name: acpihelp.h - Include file for AcpiHelp utility 4 * 5 *****************************************************************************/ 6 7 /* 8 * Copyright (C) 2000 - 2016, Intel Corp. 9 * All rights reserved. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions, and the following disclaimer, 16 * without modification. 17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 18 * substantially similar to the "NO WARRANTY" disclaimer below 19 * ("Disclaimer") and any redistribution must be conditioned upon 20 * including a substantially similar Disclaimer requirement for further 21 * binary redistribution. 22 * 3. Neither the names of the above-listed copyright holders nor the names 23 * of any contributors may be used to endorse or promote products derived 24 * from this software without specific prior written permission. 25 * 26 * Alternatively, this software may be distributed under the terms of the 27 * GNU General Public License ("GPL") version 2 as published by the Free 28 * Software Foundation. 29 * 30 * NO WARRANTY 31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR 34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 41 * POSSIBILITY OF SUCH DAMAGES. 42 */ 43 44 #ifndef __ACPIHELP_H 45 #define __ACPIHELP_H 46 47 48 #include "acpi.h" 49 #include "accommon.h" 50 #include "acapps.h" 51 52 #include <stdio.h> 53 #include <sys/stat.h> 54 #include <sys/types.h> 55 #include <fcntl.h> 56 #include <ctype.h> 57 #include <string.h> 58 #ifdef WIN32 59 #include <io.h> 60 #include <direct.h> 61 #endif 62 #include <errno.h> 63 64 65 typedef enum 66 { 67 AH_DECODE_DEFAULT = 0, 68 AH_DECODE_ASL, 69 AH_DECODE_ASL_KEYWORD, 70 AH_DECODE_PREDEFINED_NAME, 71 AH_DECODE_AML, 72 AH_DECODE_AML_OPCODE, 73 AH_DISPLAY_DEVICE_IDS, 74 AH_DECODE_EXCEPTION, 75 AH_DECODE_ASL_AML, 76 AH_DISPLAY_UUIDS, 77 AH_DISPLAY_TABLES, 78 AH_DISPLAY_DIRECTIVES 79 80 } AH_OPTION_TYPES; 81 82 #define AH_MAX_ASL_LINE_LENGTH 70 83 #define AH_MAX_AML_LINE_LENGTH 100 84 85 86 typedef struct ah_aml_opcode 87 { 88 UINT16 OpcodeRangeStart; 89 UINT16 OpcodeRangeEnd; 90 char *OpcodeString; 91 char *OpcodeName; 92 char *Type; 93 char *FixedArguments; 94 char *VariableArguments; 95 char *Grammar; 96 97 } AH_AML_OPCODE; 98 99 typedef struct ah_asl_operator 100 { 101 char *Name; 102 char *Syntax; 103 char *Description; 104 105 } AH_ASL_OPERATOR; 106 107 typedef struct ah_asl_keyword 108 { 109 char *Name; 110 char *Description; 111 char *KeywordList; 112 113 } AH_ASL_KEYWORD; 114 115 typedef struct ah_directive_info 116 { 117 char *Name; 118 char *Description; 119 120 } AH_DIRECTIVE_INFO; 121 122 extern const AH_AML_OPCODE AmlOpcodeInfo[]; 123 extern const AH_ASL_OPERATOR AslOperatorInfo[]; 124 extern const AH_ASL_KEYWORD AslKeywordInfo[]; 125 extern const AH_UUID AcpiUuids[]; 126 extern const AH_DIRECTIVE_INFO PreprocessorDirectives[]; 127 extern const AH_TABLE AcpiSupportedTables[]; 128 extern BOOLEAN AhDisplayAll; 129 130 void 131 AhFindAmlOpcode ( 132 char *Name); 133 134 void 135 AhDecodeAmlOpcode ( 136 char *Name); 137 138 void 139 AhDecodeException ( 140 char *Name); 141 142 void 143 AhFindPredefinedNames ( 144 char *Name); 145 146 void 147 AhFindAslAndAmlOperators ( 148 char *Name); 149 150 UINT32 151 AhFindAslOperators ( 152 char *Name); 153 154 void 155 AhFindAslKeywords ( 156 char *Name); 157 158 void 159 AhDisplayDeviceIds ( 160 char *Name); 161 162 void 163 AhDisplayTables ( 164 void); 165 166 const AH_TABLE * 167 AcpiAhGetTableInfo ( 168 char *Signature); 169 170 void 171 AhDisplayUuids ( 172 void); 173 174 void 175 AhDisplayDirectives ( 176 void); 177 178 #endif /* __ACPIHELP_H */ 179