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