1 /****************************************************************************** 2 * 3 * Module Name: ahmain - Main module for the acpi help utility 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2025, Intel Corp. 12 * All rights reserved. 13 * 14 * 2. License 15 * 16 * 2.1. This is your license from Intel Corp. under its intellectual property 17 * rights. You may have additional license terms from the party that provided 18 * you this software, covering your right to use that party's intellectual 19 * property rights. 20 * 21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 22 * copy of the source code appearing in this file ("Covered Code") an 23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 24 * base code distributed originally by Intel ("Original Intel Code") to copy, 25 * make derivatives, distribute, use and display any portion of the Covered 26 * Code in any form, with the right to sublicense such rights; and 27 * 28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 29 * license (with the right to sublicense), under only those claims of Intel 30 * patents that are infringed by the Original Intel Code, to make, use, sell, 31 * offer to sell, and import the Covered Code and derivative works thereof 32 * solely to the minimum extent necessary to exercise the above copyright 33 * license, and in no event shall the patent license extend to any additions 34 * to or modifications of the Original Intel Code. No other license or right 35 * is granted directly or by implication, estoppel or otherwise; 36 * 37 * The above copyright and patent license is granted only if the following 38 * conditions are met: 39 * 40 * 3. Conditions 41 * 42 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 43 * Redistribution of source code of any substantial portion of the Covered 44 * Code or modification with rights to further distribute source must include 45 * the above Copyright Notice, the above License, this list of Conditions, 46 * and the following Disclaimer and Export Compliance provision. In addition, 47 * Licensee must cause all Covered Code to which Licensee contributes to 48 * contain a file documenting the changes Licensee made to create that Covered 49 * Code and the date of any change. Licensee must include in that file the 50 * documentation of any changes made by any predecessor Licensee. Licensee 51 * must include a prominent statement that the modification is derived, 52 * directly or indirectly, from Original Intel Code. 53 * 54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 55 * Redistribution of source code of any substantial portion of the Covered 56 * Code or modification without rights to further distribute source must 57 * include the following Disclaimer and Export Compliance provision in the 58 * documentation and/or other materials provided with distribution. In 59 * addition, Licensee may not authorize further sublicense of source of any 60 * portion of the Covered Code, and must include terms to the effect that the 61 * license from Licensee to its licensee is limited to the intellectual 62 * property embodied in the software Licensee provides to its licensee, and 63 * not to intellectual property embodied in modifications its licensee may 64 * make. 65 * 66 * 3.3. Redistribution of Executable. Redistribution in executable form of any 67 * substantial portion of the Covered Code or modification must reproduce the 68 * above Copyright Notice, and the following Disclaimer and Export Compliance 69 * provision in the documentation and/or other materials provided with the 70 * distribution. 71 * 72 * 3.4. Intel retains all right, title, and interest in and to the Original 73 * Intel Code. 74 * 75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 76 * Intel shall be used in advertising or otherwise to promote the sale, use or 77 * other dealings in products derived from or relating to the Covered Code 78 * without prior written authorization from Intel. 79 * 80 * 4. Disclaimer and Export Compliance 81 * 82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 88 * PARTICULAR PURPOSE. 89 * 90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 97 * LIMITED REMEDY. 98 * 99 * 4.3. Licensee shall not export, either directly or indirectly, any of this 100 * software or system incorporating such software without first obtaining any 101 * required license or other approval from the U. S. Department of Commerce or 102 * any other agency or department of the United States Government. In the 103 * event Licensee exports any such software from the United States or 104 * re-exports any such software from a foreign destination, Licensee shall 105 * ensure that the distribution and export/re-export of the software is in 106 * compliance with all laws, regulations, orders, or other restrictions of the 107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 108 * any of its subsidiaries will export/re-export any technical data, process, 109 * software, or service, directly or indirectly, to any country for which the 110 * United States government or any agency thereof requires an export license, 111 * other governmental approval, or letter of assurance, without first obtaining 112 * such license, approval or letter. 113 * 114 ***************************************************************************** 115 * 116 * Alternatively, you may choose to be licensed under the terms of the 117 * following license: 118 * 119 * Redistribution and use in source and binary forms, with or without 120 * modification, are permitted provided that the following conditions 121 * are met: 122 * 1. Redistributions of source code must retain the above copyright 123 * notice, this list of conditions, and the following disclaimer, 124 * without modification. 125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 126 * substantially similar to the "NO WARRANTY" disclaimer below 127 * ("Disclaimer") and any redistribution must be conditioned upon 128 * including a substantially similar Disclaimer requirement for further 129 * binary redistribution. 130 * 3. Neither the names of the above-listed copyright holders nor the names 131 * of any contributors may be used to endorse or promote products derived 132 * from this software without specific prior written permission. 133 * 134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 145 * 146 * Alternatively, you may choose to be licensed under the terms of the 147 * GNU General Public License ("GPL") version 2 as published by the Free 148 * Software Foundation. 149 * 150 *****************************************************************************/ 151 152 #define DEFINE_AHELP_GLOBALS 153 #include "acpihelp.h" 154 155 156 /* Local prototypes */ 157 158 static void 159 AhDisplayUsage ( 160 void); 161 162 #define AH_UTILITY_NAME "ACPI Help Utility" 163 #define AH_SUPPORTED_OPTIONS "adeghikmopstuv^x" 164 165 166 #if defined ACPI_OPTION 167 #undef ACPI_OPTION 168 #endif 169 170 #define ACPI_OPTION(Name, Description) \ 171 AcpiOsPrintf (" %-24s%s\n", Name, Description); 172 173 174 /****************************************************************************** 175 * 176 * FUNCTION: AhDisplayUsage 177 * 178 * DESCRIPTION: Usage message 179 * 180 ******************************************************************************/ 181 182 static void 183 AhDisplayUsage ( 184 void) 185 { 186 187 ACPI_USAGE_HEADER ("acpihelp <options> [Name/Prefix | HexValue]"); 188 ACPI_OPTION ("-h", "Display help"); 189 ACPI_OPTION ("-v", "Display version information"); 190 ACPI_OPTION ("-vd", "Display build date and time"); 191 192 ACPI_USAGE_TEXT ("\nAML Names and Encodings (ACPI Machine Language):\n"); 193 ACPI_OPTION ("-a [Name/Prefix | *]", "Display both ASL operator and AML opcode name(s)"); 194 ACPI_OPTION ("-g [Name/Prefix | *]", "Display AML grammar elements(s)"); 195 ACPI_OPTION ("-m [Name/Prefix | *]", "Display AML opcode name(s)"); 196 197 ACPI_USAGE_TEXT ("\nACPI Values:\n"); 198 ACPI_OPTION ("-e [HexValue]", "Decode ACPICA exception code"); 199 ACPI_OPTION ("-o [HexValue]", "Decode hex AML opcode"); 200 ACPI_OPTION ("-x [HexValue]", "Decode iASL exception code"); 201 202 ACPI_USAGE_TEXT ("\nASL Names and Symbols (ACPI Source Language):\n"); 203 ACPI_OPTION ("-k [Name/Prefix | *]", "Display ASL non-operator keyword(s)"); 204 ACPI_OPTION ("-p [Name/Prefix | *]", "Display ASL predefined method name(s)"); 205 ACPI_OPTION ("-s [Name/Prefix | *]", "Display ASL operator name(s)"); 206 207 ACPI_USAGE_TEXT ("\nOther miscellaneous ACPI Names:\n"); 208 ACPI_OPTION ("-i [Name/Prefix | *]", "Display ACPI/PNP Hardware ID(s)"); 209 ACPI_OPTION ("-d", "Display iASL Preprocessor directives"); 210 ACPI_OPTION ("-t", "Display supported ACPI tables"); 211 ACPI_OPTION ("-u", "Display ACPI-related UUIDs"); 212 213 ACPI_USAGE_TEXT ("\nName/Prefix or HexValue not specified means \"Display All\"\n"); 214 ACPI_USAGE_TEXT ("\nDefault search with valid Name/Prefix and no options:\n"); 215 ACPI_USAGE_TEXT (" Find ASL/AML operator names - if NamePrefix does not start with underscore\n"); 216 ACPI_USAGE_TEXT (" Find ASL predefined method names - if NamePrefix starts with underscore\n"); 217 } 218 219 220 /****************************************************************************** 221 * 222 * FUNCTION: main 223 * 224 * DESCRIPTION: C main function for AcpiHelp utility. 225 * 226 ******************************************************************************/ 227 228 int ACPI_SYSTEM_XFACE 229 main ( 230 int argc, 231 char *argv[]) 232 { 233 char *Name; 234 UINT32 DecodeType; 235 int j; 236 237 238 AcpiOsInitialize (); 239 ACPI_DEBUG_INITIALIZE (); /* For debug version only */ 240 printf (ACPI_COMMON_SIGNON (AH_UTILITY_NAME)); 241 DecodeType = AH_DECODE_DEFAULT; 242 243 if (argc < 2) 244 { 245 AhDisplayUsage (); 246 return (0); 247 } 248 249 /* Command line options */ 250 251 while ((j = AcpiGetopt (argc, argv, AH_SUPPORTED_OPTIONS)) != ACPI_OPT_END) switch (j) 252 { 253 case 'a': 254 255 DecodeType = AH_DECODE_ASL_AML; 256 break; 257 258 case 'd': 259 260 DecodeType = AH_DISPLAY_DIRECTIVES; 261 break; 262 263 case 'e': 264 265 DecodeType = AH_DECODE_EXCEPTION; 266 break; 267 268 case 'g': 269 270 DecodeType = AH_DECODE_AML_TYPE; 271 break; 272 273 case 'i': 274 275 DecodeType = AH_DISPLAY_DEVICE_IDS; 276 break; 277 278 case 'k': 279 280 DecodeType = AH_DECODE_ASL_KEYWORD; 281 break; 282 283 case 'm': 284 285 DecodeType = AH_DECODE_AML; 286 break; 287 288 case 'o': 289 290 DecodeType = AH_DECODE_AML_OPCODE; 291 break; 292 293 case 'p': 294 295 DecodeType = AH_DECODE_PREDEFINED_NAME; 296 break; 297 298 case 's': 299 300 DecodeType = AH_DECODE_ASL; 301 break; 302 303 case 't': 304 305 DecodeType = AH_DISPLAY_TABLES; 306 break; 307 308 case 'u': 309 310 DecodeType = AH_DISPLAY_UUIDS; 311 break; 312 313 case 'x': 314 315 DecodeType = AH_DECODE_ASL_EXCEPTION; 316 break; 317 318 case 'v': /* -v: (Version): signon already emitted, just exit */ 319 320 switch (AcpiGbl_Optarg[0]) 321 { 322 case '^': /* -v: (Version) */ 323 324 return (1); 325 326 case 'd': 327 328 printf (ACPI_COMMON_BUILD_TIME); 329 return (1); 330 331 default: 332 333 printf ("Unknown option: -v%s\n", AcpiGbl_Optarg); 334 return (-1); 335 } 336 break; 337 338 case 'h': 339 default: 340 341 AhDisplayUsage (); 342 return (-1); 343 } 344 345 /* Missing (null) name means "display all" */ 346 347 Name = argv[AcpiGbl_Optind]; 348 349 switch (DecodeType) 350 { 351 case AH_DECODE_ASL_AML: 352 353 AhFindAslAndAmlOperators (Name); 354 break; 355 356 case AH_DECODE_AML: 357 358 AhFindAmlOpcode (Name); 359 break; 360 361 case AH_DECODE_AML_OPCODE: 362 363 AhDecodeAmlOpcode (Name); 364 break; 365 366 case AH_DECODE_AML_TYPE: 367 368 AhFindAmlTypes (Name); 369 break; 370 371 case AH_DECODE_PREDEFINED_NAME: 372 373 AhFindPredefinedNames (Name); 374 break; 375 376 case AH_DECODE_ASL: 377 378 AhFindAslOperators (Name); 379 break; 380 381 case AH_DECODE_ASL_KEYWORD: 382 383 AhFindAslKeywords (Name); 384 break; 385 386 case AH_DISPLAY_DEVICE_IDS: 387 388 AhDisplayDeviceIds (Name); 389 break; 390 391 case AH_DECODE_EXCEPTION: 392 393 AhDecodeException (Name); 394 break; 395 396 case AH_DISPLAY_UUIDS: 397 398 AhDisplayUuids (); 399 break; 400 401 case AH_DISPLAY_TABLES: 402 403 AhDisplayTables (); 404 break; 405 406 case AH_DISPLAY_DIRECTIVES: 407 408 AhDisplayDirectives (); 409 break; 410 411 case AH_DECODE_ASL_EXCEPTION: 412 413 AhDecodeAslException (Name); 414 break; 415 416 default: 417 418 if (!Name) 419 { 420 AhFindAslOperators (Name); 421 break; 422 } 423 424 if (*Name == '_') 425 { 426 AhFindPredefinedNames (Name); 427 } 428 else 429 { 430 AhFindAslAndAmlOperators (Name); 431 } 432 break; 433 } 434 435 return (0); 436 } 437
Indexes created Sat Sep 20 22:09:52 GMT 2025