sys/contrib/dev/acpica-unix/tools/acpisrc/acpisrc.h

   1
   2 /******************************************************************************
   3  *
   4  * Module Name: acpisrc.h - Include file for AcpiSrc utility
   5  *
   6  *****************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2011, Intel Corp.
  13  * All rights reserved.
  14  *
  15  * 2. License
  16  *
  17  * 2.1. This is your license from Intel Corp. under its intellectual property
  18  * rights.  You may have additional license terms from the party that provided
  19  * you this software, covering your right to use that party's intellectual
  20  * property rights.
  21  *
  22  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  23  * copy of the source code appearing in this file ("Covered Code") an
  24  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  25  * base code distributed originally by Intel ("Original Intel Code") to copy,
  26  * make derivatives, distribute, use and display any portion of the Covered
  27  * Code in any form, with the right to sublicense such rights; and
  28  *
  29  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  30  * license (with the right to sublicense), under only those claims of Intel
  31  * patents that are infringed by the Original Intel Code, to make, use, sell,
  32  * offer to sell, and import the Covered Code and derivative works thereof
  33  * solely to the minimum extent necessary to exercise the above copyright
  34  * license, and in no event shall the patent license extend to any additions
  35  * to or modifications of the Original Intel Code.  No other license or right
  36  * is granted directly or by implication, estoppel or otherwise;
  37  *
  38  * The above copyright and patent license is granted only if the following
  39  * conditions are met:
  40  *
  41  * 3. Conditions
  42  *
  43  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  44  * Redistribution of source code of any substantial portion of the Covered
  45  * Code or modification with rights to further distribute source must include
  46  * the above Copyright Notice, the above License, this list of Conditions,
  47  * and the following Disclaimer and Export Compliance provision.  In addition,
  48  * Licensee must cause all Covered Code to which Licensee contributes to
  49  * contain a file documenting the changes Licensee made to create that Covered
  50  * Code and the date of any change.  Licensee must include in that file the
  51  * documentation of any changes made by any predecessor Licensee.  Licensee
  52  * must include a prominent statement that the modification is derived,
  53  * directly or indirectly, from Original Intel Code.
  54  *
  55  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  56  * Redistribution of source code of any substantial portion of the Covered
  57  * Code or modification without rights to further distribute source must
  58  * include the following Disclaimer and Export Compliance provision in the
  59  * documentation and/or other materials provided with distribution.  In
  60  * addition, Licensee may not authorize further sublicense of source of any
  61  * portion of the Covered Code, and must include terms to the effect that the
  62  * license from Licensee to its licensee is limited to the intellectual
  63  * property embodied in the software Licensee provides to its licensee, and
  64  * not to intellectual property embodied in modifications its licensee may
  65  * make.
  66  *
  67  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  68  * substantial portion of the Covered Code or modification must reproduce the
  69  * above Copyright Notice, and the following Disclaimer and Export Compliance
  70  * provision in the documentation and/or other materials provided with the
  71  * distribution.
  72  *
  73  * 3.4. Intel retains all right, title, and interest in and to the Original
  74  * Intel Code.
  75  *
  76  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  77  * Intel shall be used in advertising or otherwise to promote the sale, use or
  78  * other dealings in products derived from or relating to the Covered Code
  79  * without prior written authorization from Intel.
  80  *
  81  * 4. Disclaimer and Export Compliance
  82  *
  83  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  84  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  85  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  86  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  87  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  88  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  89  * PARTICULAR PURPOSE.
  90  *
  91  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  92  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  93  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  94  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  95  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  96  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  97  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  98  * LIMITED REMEDY.
  99  *
 100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 101  * software or system incorporating such software without first obtaining any
 102  * required license or other approval from the U. S. Department of Commerce or
 103  * any other agency or department of the United States Government.  In the
 104  * event Licensee exports any such software from the United States or
 105  * re-exports any such software from a foreign destination, Licensee shall
 106  * ensure that the distribution and export/re-export of the software is in
 107  * compliance with all laws, regulations, orders, or other restrictions of the
 108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 109  * any of its subsidiaries will export/re-export any technical data, process,
 110  * software, or service, directly or indirectly, to any country for which the
 111  * United States government or any agency thereof requires an export license,
 112  * other governmental approval, or letter of assurance, without first obtaining
 113  * such license, approval or letter.
 114  *
 115  *****************************************************************************/
 116
 117
 118 #define LINES_IN_LEGAL_HEADER               105 /* See above */
 119 #define LEGAL_HEADER_SIGNATURE              " * 2.1. This is your license from Intel Corp. under its intellectual property"
 120 #define LINES_IN_LINUX_HEADER               34
 121 #define LINUX_HEADER_SIGNATURE              " * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS"
 122 #define LINES_IN_ASL_HEADER                 29 /* Header as output from disassembler */
 123
 124 #include "acpi.h"
 125 #include "accommon.h"
 126
 127 #include <stdio.h>
 128 #include <sys/stat.h>
 129 #include <sys/types.h>
 130 #include <fcntl.h>
 131 #include <ctype.h>
 132 #ifdef WIN32
 133 #include <io.h>
 134 #include <direct.h>
 135 #endif
 136 #include <errno.h>
 137
 138
 139 /* Fixups for non-Win32 compilation */
 140 #ifndef WIN32
 141 #ifndef O_BINARY
 142 #define O_BINARY    0x0
 143 #endif
 144
 145 #define mkdir(x) mkdir(x, 0770)
 146 char * strlwr(char* str);
 147 #endif
 148
 149
 150 /* Constants */
 151
 152 #define ASRC_MAX_FILE_SIZE                  (1024 * 100)
 153
 154 #define FILE_TYPE_SOURCE                    1
 155 #define FILE_TYPE_HEADER                    2
 156 #define FILE_TYPE_DIRECTORY                 3
 157
 158 #define CVT_COUNT_TABS                      0x00000001
 159 #define CVT_COUNT_NON_ANSI_COMMENTS         0x00000002
 160 #define CVT_TRIM_LINES                      0x00000004
 161 #define CVT_CHECK_BRACES                    0x00000008
 162 #define CVT_COUNT_LINES                     0x00000010
 163 #define CVT_BRACES_ON_SAME_LINE             0x00000020
 164 #define CVT_MIXED_CASE_TO_UNDERSCORES       0x00000040
 165 #define CVT_LOWER_CASE_IDENTIFIERS          0x00000080
 166 #define CVT_REMOVE_DEBUG_MACROS             0x00000100
 167 #define CVT_TRIM_WHITESPACE                 0x00000200  /* Should be after all line removal */
 168 #define CVT_REMOVE_EMPTY_BLOCKS             0x00000400  /* Should be after trimming lines */
 169 #define CVT_REDUCE_TYPEDEFS                 0x00000800
 170 #define CVT_COUNT_SHORTMULTILINE_COMMENTS   0x00001000
 171 #define CVT_SPACES_TO_TABS4                 0x40000000  /* Tab conversion should be last */
 172 #define CVT_SPACES_TO_TABS8                 0x80000000  /* Tab conversion should be last */
 173
 174 #define FLG_DEFAULT_FLAGS                   0x00000000
 175 #define FLG_NO_CARRIAGE_RETURNS             0x00000001
 176 #define FLG_NO_FILE_OUTPUT                  0x00000002
 177 #define FLG_LOWERCASE_DIRNAMES              0x00000004
 178
 179 #define AS_START_IGNORE                     "/*!"
 180 #define AS_STOP_IGNORE                      "!*/"
 181
 182
 183 /* Globals */
 184
 185 extern UINT32                   Gbl_Files;
 186 extern UINT32                   Gbl_MissingBraces;
 187 extern UINT32                   Gbl_Tabs;
 188 extern UINT32                   Gbl_NonAnsiComments;
 189 extern UINT32                   Gbl_SourceLines;
 190 extern UINT32                   Gbl_WhiteLines;
 191 extern UINT32                   Gbl_CommentLines;
 192 extern UINT32                   Gbl_LongLines;
 193 extern UINT32                   Gbl_TotalLines;
 194 extern UINT32                   Gbl_HeaderSize;
 195 extern UINT32                   Gbl_HeaderLines;
 196 extern struct stat              Gbl_StatBuf;
 197 extern char                     *Gbl_FileBuffer;
 198 extern UINT32                   Gbl_TotalSize;
 199 extern UINT32                   Gbl_FileSize;
 200 extern UINT32                   Gbl_FileType;
 201 extern BOOLEAN                  Gbl_VerboseMode;
 202 extern BOOLEAN                  Gbl_QuietMode;
 203 extern BOOLEAN                  Gbl_BatchMode;
 204 extern BOOLEAN                  Gbl_MadeChanges;
 205 extern BOOLEAN                  Gbl_Overwrite;
 206 extern BOOLEAN                  Gbl_WidenDeclarations;
 207 extern BOOLEAN                  Gbl_IgnoreLoneLineFeeds;
 208 extern BOOLEAN                  Gbl_HasLoneLineFeeds;
 209 extern void                     *Gbl_StructDefs;
 210
 211 #define PARAM_LIST(pl)          pl
 212 #define TERSE_PRINT(a)          if (!Gbl_VerboseMode) printf PARAM_LIST(a)
 213 #define VERBOSE_PRINT(a)        if (Gbl_VerboseMode) printf PARAM_LIST(a)
 214
 215 #define REPLACE_WHOLE_WORD      0x00
 216 #define REPLACE_SUBSTRINGS      0x01
 217 #define REPLACE_MASK            0x01
 218
 219 #define EXTRA_INDENT_C          0x02
 220
 221
 222 /* Conversion table structs */
 223
 224 typedef struct acpi_string_table
 225 {
 226     char                        *Target;
 227     char                        *Replacement;
 228     UINT8                       Type;
 229
 230 } ACPI_STRING_TABLE;
 231
 232
 233 typedef struct acpi_typed_identifier_table
 234 {
 235     char                        *Identifier;
 236     UINT8                       Type;
 237
 238 } ACPI_TYPED_IDENTIFIER_TABLE;
 239
 240 #define SRC_TYPE_SIMPLE         0
 241 #define SRC_TYPE_STRUCT         1
 242 #define SRC_TYPE_UNION          2
 243
 244
 245 typedef struct acpi_identifier_table
 246 {
 247     char                        *Identifier;
 248
 249 } ACPI_IDENTIFIER_TABLE;
 250
 251 typedef struct acpi_conversion_table
 252 {
 253     char                        *NewHeader;
 254     UINT32                      Flags;
 255
 256     ACPI_TYPED_IDENTIFIER_TABLE *LowerCaseTable;
 257
 258     ACPI_STRING_TABLE           *SourceStringTable;
 259     ACPI_IDENTIFIER_TABLE       *SourceLineTable;
 260     ACPI_IDENTIFIER_TABLE       *SourceConditionalTable;
 261     ACPI_IDENTIFIER_TABLE       *SourceMacroTable;
 262     ACPI_TYPED_IDENTIFIER_TABLE *SourceStructTable;
 263     UINT32                      SourceFunctions;
 264
 265     ACPI_STRING_TABLE           *HeaderStringTable;
 266     ACPI_IDENTIFIER_TABLE       *HeaderLineTable;
 267     ACPI_IDENTIFIER_TABLE       *HeaderConditionalTable;
 268     ACPI_IDENTIFIER_TABLE       *HeaderMacroTable;
 269     ACPI_TYPED_IDENTIFIER_TABLE *HeaderStructTable;
 270     UINT32                      HeaderFunctions;
 271
 272 } ACPI_CONVERSION_TABLE;
 273
 274
 275 /* Conversion tables */
 276
 277 extern ACPI_CONVERSION_TABLE       LinuxConversionTable;
 278 extern ACPI_CONVERSION_TABLE       CleanupConversionTable;
 279 extern ACPI_CONVERSION_TABLE       StatsConversionTable;
 280 extern ACPI_CONVERSION_TABLE       CustomConversionTable;
 281 extern ACPI_CONVERSION_TABLE       LicenseConversionTable;
 282
 283
 284 /* Prototypes */
 285
 286 char *
 287 AsSkipUntilChar (
 288     char                    *Buffer,
 289     char                    Target);
 290
 291 char *
 292 AsSkipPastChar (
 293     char                    *Buffer,
 294     char                    Target);
 295
 296 char *
 297 AsReplaceData (
 298     char                    *Buffer,
 299     UINT32                  LengthToRemove,
 300     char                    *BufferToAdd,
 301     UINT32                  LengthToAdd);
 302
 303 int
 304 AsReplaceString (
 305     char                    *Target,
 306     char                    *Replacement,
 307     UINT8                   Type,
 308     char                    *Buffer);
 309
 310 int
 311 AsLowerCaseString (
 312     char                    *Target,
 313     char                    *Buffer);
 314
 315 void
 316 AsRemoveLine (
 317     char                    *Buffer,
 318     char                    *Keyword);
 319
 320 void
 321 AsRemoveMacro (
 322     char                    *Buffer,
 323     char                    *Keyword);
 324
 325 void
 326 AsCheckForBraces (
 327     char                    *Buffer,
 328     char                    *Filename);
 329
 330 void
 331 AsTrimLines (
 332     char                    *Buffer,
 333     char                    *Filename);
 334
 335 void
 336 AsMixedCaseToUnderscores (
 337     char                    *Buffer);
 338
 339 void
 340 AsCountTabs (
 341     char                    *Buffer,
 342     char                    *Filename);
 343
 344 void
 345 AsBracesOnSameLine (
 346     char                    *Buffer);
 347
 348 void
 349 AsLowerCaseIdentifiers (
 350     char                    *Buffer);
 351
 352 void
 353 AsReduceTypedefs (
 354     char                    *Buffer,
 355     char                    *Keyword);
 356
 357 void
 358 AsRemoveDebugMacros (
 359     char                    *Buffer);
 360
 361 void
 362 AsRemoveEmptyBlocks (
 363     char                    *Buffer,
 364     char                    *Filename);
 365
 366 void
 367 AsCountSourceLines (
 368     char                    *Buffer,
 369     char                    *Filename);
 370
 371 void
 372 AsCountNonAnsiComments (
 373     char                    *Buffer,
 374     char                    *Filename);
 375
 376 void
 377 AsTrimWhitespace (
 378     char                    *Buffer);
 379
 380 void
 381 AsTabify4 (
 382     char                    *Buffer);
 383
 384 void
 385 AsTabify8 (
 386     char                    *Buffer);
 387
 388 void
 389 AsRemoveConditionalCompile (
 390     char                    *Buffer,
 391     char                    *Keyword);
 392
 393 ACPI_NATIVE_INT
 394 AsProcessTree (
 395     ACPI_CONVERSION_TABLE   *ConversionTable,
 396     char                    *SourcePath,
 397     char                    *TargetPath);
 398
 399 int
 400 AsGetFile (
 401     char                    *FileName,
 402     char                    **FileBuffer,
 403     UINT32                  *FileSize);
 404
 405 int
 406 AsPutFile (
 407     char                    *Pathname,
 408     char                    *FileBuffer,
 409     UINT32                  SystemFlags);
 410
 411 void
 412 AsReplaceHeader (
 413     char                    *Buffer,
 414     char                    *NewHeader);
 415
 416 void
 417 AsConvertFile (
 418     ACPI_CONVERSION_TABLE   *ConversionTable,
 419     char                    *FileBuffer,
 420     char                    *Filename,
 421     ACPI_NATIVE_INT         FileType);
 422
 423 ACPI_NATIVE_INT
 424 AsProcessOneFile (
 425     ACPI_CONVERSION_TABLE   *ConversionTable,
 426     char                    *SourcePath,
 427     char                    *TargetPath,
 428     int                     MaxPathLength,
 429     char                    *Filename,
 430     ACPI_NATIVE_INT         FileType);
 431
 432 ACPI_NATIVE_INT
 433 AsCheckForDirectory (
 434     char                    *SourceDirPath,
 435     char                    *TargetDirPath,
 436     char                    *Filename,
 437     char                    **SourcePath,
 438     char                    **TargetPath);
 439
 440 BOOLEAN
 441 AsMatchExactWord (
 442     char                    *Word,
 443     UINT32                  WordLength);
 444
 445 void
 446 AsPrint (
 447     char                    *Message,
 448     UINT32                  Count,
 449     char                    *Filename);
 450
 451 void
 452 AsInsertPrefix (
 453     char                    *Buffer,
 454     char                    *Keyword,
 455     UINT8                   Type);
 456
 457 char *
 458 AsInsertData (
 459     char                    *Buffer,
 460     char                    *BufferToAdd,
 461     UINT32                  LengthToAdd);
 462
 463 char *
 464 AsRemoveData (
 465     char                    *StartPointer,
 466     char                    *EndPointer);
 467
 468 void
 469 AsInsertCarriageReturns (
 470     char                    *Buffer);
 471
 472 void
 473 AsConvertToLineFeeds (
 474     char                    *Buffer);
 475
 476