1 /****************************************************************************** 2 * 3 * Module Name: ahmain - Main module for the acpi help utility 4 * 5 *****************************************************************************/ 6 7 /* 8 * Copyright (C) 2000 - 2014, 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 #include "acpihelp.h" 45 46 47 /* Local prototypes */ 48 49 static void 50 AhDisplayUsage ( 51 void); 52 53 #define AH_UTILITY_NAME "ACPI Help Utility" 54 #define AH_SUPPORTED_OPTIONS "aehikmopsv" 55 56 57 /****************************************************************************** 58 * 59 * FUNCTION: AhDisplayUsage 60 * 61 * DESCRIPTION: Usage message 62 * 63 ******************************************************************************/ 64 65 static void 66 AhDisplayUsage ( 67 void) 68 { 69 70 ACPI_USAGE_HEADER ("acpihelp <options> [Name/Prefix | HexValue]"); 71 ACPI_OPTION ("-h", "Display help"); 72 ACPI_OPTION ("-v", "Display version information"); 73 74 ACPI_USAGE_TEXT ("\nAML (ACPI Machine Language) Names and Encodings:\n"); 75 ACPI_OPTION ("-a [Name/Prefix]", "Find/Display both ASL operator and AML opcode name(s)"); 76 ACPI_OPTION ("-m [Name/Prefix]", "Find/Display AML opcode name(s)"); 77 78 ACPI_USAGE_TEXT ("\nASL (ACPI Source Language) Names and Symbols:\n"); 79 ACPI_OPTION ("-k [Name/Prefix]", "Find/Display ASL non-operator keyword(s)"); 80 ACPI_OPTION ("-p [Name/Prefix]", "Find/Display ASL predefined method name(s)"); 81 ACPI_OPTION ("-s [Name/Prefix]", "Find/Display ASL operator name(s)"); 82 83 ACPI_USAGE_TEXT ("\nOther ACPI Names:\n"); 84 ACPI_OPTION ("-i [Name/Prefix]", "Find/Display ACPI/PNP Hardware ID(s)"); 85 86 ACPI_USAGE_TEXT ("\nACPI Values:\n"); 87 ACPI_OPTION ("-e [HexValue]", "Decode ACPICA exception code"); 88 ACPI_OPTION ("-o [HexValue]", "Decode hex AML opcode"); 89 90 ACPI_USAGE_TEXT ("\nName/Prefix or HexValue not specified means \"Display All\"\n"); 91 ACPI_USAGE_TEXT ("\nDefault search with valid Name/Prefix and no options:\n"); 92 ACPI_USAGE_TEXT (" Find ASL/AML operator names - if NamePrefix does not start with underscore\n"); 93 ACPI_USAGE_TEXT (" Find ASL predefined method names - if NamePrefix starts with underscore\n"); 94 } 95 96 97 /****************************************************************************** 98 * 99 * FUNCTION: main 100 * 101 * DESCRIPTION: C main function for AcpiHelp utility. 102 * 103 ******************************************************************************/ 104 105 int ACPI_SYSTEM_XFACE 106 main ( 107 int argc, 108 char *argv[]) 109 { 110 char *Name; 111 UINT32 DecodeType; 112 int j; 113 114 115 AcpiOsInitialize (); 116 ACPI_DEBUG_INITIALIZE (); /* For debug version only */ 117 printf (ACPI_COMMON_SIGNON (AH_UTILITY_NAME)); 118 DecodeType = AH_DECODE_DEFAULT; 119 120 if (argc < 2) 121 { 122 AhDisplayUsage (); 123 return (0); 124 } 125 126 /* Command line options */ 127 128 while ((j = AcpiGetopt (argc, argv, AH_SUPPORTED_OPTIONS)) != ACPI_OPT_END) switch (j) 129 { 130 case 'a': 131 132 DecodeType = AH_DECODE_ASL_AML; 133 break; 134 135 case 'e': 136 137 DecodeType = AH_DECODE_EXCEPTION; 138 break; 139 140 case 'i': 141 142 DecodeType = AH_DISPLAY_DEVICE_IDS; 143 break; 144 145 case 'k': 146 147 DecodeType = AH_DECODE_ASL_KEYWORD; 148 break; 149 150 case 'm': 151 152 DecodeType = AH_DECODE_AML; 153 break; 154 155 case 'o': 156 157 DecodeType = AH_DECODE_AML_OPCODE; 158 break; 159 160 case 'p': 161 162 DecodeType = AH_DECODE_PREDEFINED_NAME; 163 break; 164 165 case 's': 166 167 DecodeType = AH_DECODE_ASL; 168 break; 169 170 case 'v': /* -v: (Version): signon already emitted, just exit */ 171 172 return (0); 173 174 case 'h': 175 default: 176 177 AhDisplayUsage (); 178 return (-1); 179 } 180 181 /* Missing (null) name means "display all" */ 182 183 Name = argv[AcpiGbl_Optind]; 184 185 switch (DecodeType) 186 { 187 case AH_DECODE_ASL_AML: 188 189 AhFindAslAndAmlOperators (Name); 190 break; 191 192 case AH_DECODE_AML: 193 194 AhFindAmlOpcode (Name); 195 break; 196 197 case AH_DECODE_AML_OPCODE: 198 199 AhDecodeAmlOpcode (Name); 200 break; 201 202 case AH_DECODE_PREDEFINED_NAME: 203 204 AhFindPredefinedNames (Name); 205 break; 206 207 case AH_DECODE_ASL: 208 209 AhFindAslOperators (Name); 210 break; 211 212 case AH_DECODE_ASL_KEYWORD: 213 214 AhFindAslKeywords (Name); 215 break; 216 217 case AH_DISPLAY_DEVICE_IDS: 218 219 AhDisplayDeviceIds (Name); 220 break; 221 222 case AH_DECODE_EXCEPTION: 223 224 AhDecodeException (Name); 225 break; 226 227 default: 228 229 if (!Name) 230 { 231 AhFindAslOperators (Name); 232 break; 233 } 234 235 if (*Name == '_') 236 { 237 AhFindPredefinedNames (Name); 238 } 239 else 240 { 241 AhFindAslAndAmlOperators (Name); 242 } 243 break; 244 } 245 246 return (0); 247 } 248 249 250 /******************************************************************************* 251 * 252 * FUNCTION: AhStrupr (strupr) 253 * 254 * PARAMETERS: SrcString - The source string to convert 255 * 256 * RETURN: None 257 * 258 * DESCRIPTION: Convert string to uppercase 259 * 260 * NOTE: This is not a POSIX function, so it appears here, not in utclib.c 261 * 262 ******************************************************************************/ 263 264 void 265 AhStrupr ( 266 char *SrcString) 267 { 268 char *String; 269 270 271 if (!SrcString) 272 { 273 return; 274 } 275 276 /* Walk entire string, uppercasing the letters */ 277 278 for (String = SrcString; *String; String++) 279 { 280 *String = (char) toupper ((int) *String); 281 } 282 283 return; 284 } 285