sys/contrib/dev/acpica/source/tools/acpibin/abmain.c

   1 /******************************************************************************
   2  *
   3  * Module Name: abmain - Main module for the acpi binary utility
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2018, 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 _DECLARE_GLOBALS
 153 #include "acpibin.h"
 154
 155 /* Local prototypes */
 156
 157 static void
 158 AbDisplayUsage (
 159     UINT8                   OptionCount);
 160
 161
 162 #define AB_UTILITY_NAME             "ACPI Binary Table Dump Utility"
 163 #define AB_SUPPORTED_OPTIONS        "a:c:d:h:o:s:tv^"
 164
 165
 166 /******************************************************************************
 167  *
 168  * FUNCTION:    AbDisplayUsage
 169  *
 170  * DESCRIPTION: Usage message
 171  *
 172  ******************************************************************************/
 173
 174 static void
 175 AbDisplayUsage (
 176     UINT8                   OptionCount)
 177 {
 178
 179     if (OptionCount)
 180     {
 181         printf ("Option requires %u arguments\n\n", OptionCount);
 182     }
 183
 184     ACPI_USAGE_HEADER ("acpibin [options]");
 185
 186     ACPI_OPTION ("-a <File1> <File2>",      "Compare two binary AML files, dump all mismatches");
 187     ACPI_OPTION ("-c <File1> <File2>",      "Compare two binary AML files, dump first 100 mismatches");
 188     ACPI_OPTION ("-d <In> <Out>",           "Dump AML binary to text file");
 189     ACPI_OPTION ("-o <Value>",              "Start comparison at this offset into second file");
 190     ACPI_OPTION ("-h <File>",               "Display table header for binary AML file");
 191     ACPI_OPTION ("-s <File>",               "Update checksum for binary AML file");
 192     ACPI_OPTION ("-t",                      "Terse mode");
 193     ACPI_OPTION ("-v",                      "Display version information");
 194     ACPI_OPTION ("-vd",                     "Display build date and time");
 195 }
 196
 197
 198 /******************************************************************************
 199  *
 200  * FUNCTION:    main
 201  *
 202  * DESCRIPTION: C main function
 203  *
 204  ******************************************************************************/
 205
 206 int ACPI_SYSTEM_XFACE
 207 main (
 208     int                     argc,
 209     char                    *argv[])
 210 {
 211     int                     j;
 212     int                     Status = AE_OK;
 213
 214
 215     ACPI_DEBUG_INITIALIZE (); /* For debug version only */
 216
 217     AcpiGbl_DebugFile = NULL;
 218     AcpiGbl_DbOutputFlags = DB_CONSOLE_OUTPUT;
 219
 220     AcpiOsInitialize ();
 221     printf (ACPI_COMMON_SIGNON (AB_UTILITY_NAME));
 222
 223     if (argc < 2)
 224     {
 225         AbDisplayUsage (0);
 226         return (0);
 227     }
 228
 229     /* Command line options */
 230
 231     while ((j = AcpiGetopt (argc, argv, AB_SUPPORTED_OPTIONS)) != ACPI_OPT_END) switch(j)
 232     {
 233     case 'a':   /* Compare Files, display all differences */
 234
 235         AbGbl_DisplayAllMiscompares = TRUE;
 236
 237         /* Fallthrough */
 238
 239     case 'c':   /* Compare Files */
 240
 241         if (argc < 4)
 242         {
 243             AbDisplayUsage (2);
 244             return (-1);
 245         }
 246
 247         Status = AbCompareAmlFiles (AcpiGbl_Optarg, argv[AcpiGbl_Optind]);
 248         break;
 249
 250     case 'd':   /* Dump AML file */
 251
 252         if (argc < 4)
 253         {
 254             AbDisplayUsage (2);
 255             return (-1);
 256         }
 257
 258         Status = AbDumpAmlFile (AcpiGbl_Optarg, argv[AcpiGbl_Optind]);
 259         break;
 260
 261     case 'h':   /* Display ACPI table header */
 262
 263         if (argc < 3)
 264         {
 265             AbDisplayUsage (1);
 266             return (-1);
 267         }
 268
 269         AbDisplayHeader (AcpiGbl_Optarg);
 270         return (0);
 271
 272     case 'o':
 273
 274         AbGbl_CompareOffset = atoi (AcpiGbl_Optarg);
 275         continue;
 276
 277     case 's':   /* Compute/update checksum */
 278
 279         if (argc < 3)
 280         {
 281             AbDisplayUsage (1);
 282             return (-1);
 283         }
 284
 285         AbComputeChecksum (AcpiGbl_Optarg);
 286         return (0);
 287
 288     case 't':   /* Enable terse mode */
 289
 290         Gbl_TerseMode = TRUE;
 291         break;
 292
 293     case 'v': /* -v: (Version): signon already emitted, just exit */
 294
 295         switch (AcpiGbl_Optarg[0])
 296         {
 297         case '^':  /* -v: (Version): signon already emitted, just exit */
 298
 299             return (1);
 300
 301         case 'd':
 302
 303             printf (ACPI_COMMON_BUILD_TIME);
 304             return (1);
 305
 306         default:
 307
 308             printf ("Unknown option: -v%s\n", AcpiGbl_Optarg);
 309             return (-1);
 310         }
 311         break;
 312
 313     default:
 314
 315         AbDisplayUsage (0);
 316         return (-1);
 317     }
 318
 319     return (Status);
 320 }