sys/contrib/dev/acpica/generate/unix/readme.txt

   1 Generic Unix ACPICA makefiles
   2 -----------------------------
   3
   4 These makefiles are intended to generate the ACPICA utilities in
   5 a Unix-like environment, with the original ACPICA code (not linuxized),
   6 and in the original (git tree) ACPICA directory structure.
   7
   8 Windows binary versions of these tools are available at:
   9
  10 http://www.acpica.org/downloads/binary_tools.php
  11
  12 Documentation is available at acpica.org:
  13
  14 http://www.acpica.org/documentation/
  15
  16 The top level makefile will generate the following utilities:
  17 Note: These utilities are tested and supported as 32-bit versions
  18 only.
  19
  20 acpibin
  21 acpiexec
  22 acpihelp
  23 acpinames
  24 acpisrc
  25 acpixtract
  26 iasl
  27
  28 To generate all utilities:
  29
  30 cd acpica/generate/unix
  31 make
  32 make install   /* install all binaries to /usr/bin */
  33
  34
  35 Requirements
  36 ------------
  37
  38 make
  39 gcc compiler (4+)
  40 bison or yacc
  41 flex or lex
  42
  43
  44 Configuration
  45 -------------
  46
  47 The Makefile.config file contains the configuration information:
  48
  49 HOST =       _CYGWIN            /* Host system, must appear in acenv.h */
  50 CC =         gcc                /* C compiler */
  51 ACPICA_SRC = ../../../source    /* Location of acpica source tree */
  52
  53
  54 Intermediate Files
  55 ------------------
  56
  57 The intermediate files for each utility (.o, etc.) are placed in the
  58 subdirectory corresponding to each utility, not in the source code
  59 tree itself. This prevents collisions when different utilities compile
  60 the same source modules with different options.
  61
  62
  63 Output
  64 ------
  65
  66 The executable utilities are copied to the local bin directory.
  67
  68 "make install" will install the binaries to /usr/bin
  69
  70
  71
  72 1) acpibin, an AML file tool
  73
  74 acpibin compares AML files, dumps AML binary files to text files,
  75 extracts binary AML from text files, and other AML file
  76 manipulation.
  77
  78
  79 2) acpiexec, a user-space AML interpreter
  80
  81 acpiexec allows the loading of ACPI tables and execution of control
  82 methods from user space. Useful for debugging AML code and testing
  83 the AML interpreter. Hardware access is simulated.
  84
  85
  86 3) acpihelp, syntax help for ASL operators and reserved names
  87
  88 acpihelp displays the syntax for all of the ASL operators, as well
  89 as information about the ASL/ACPI reserved names (4-char names that
  90 start with underscore.)
  91
  92
  93 4) acpinames, load and dump acpi namespace
  94
  95 acpinames loads an ACPI namespace from a binary ACPI table file.
  96 This is a smaller version of acpiexec that loads an acpi table and
  97 dumps the resulting namespace. It is primarily intended to demonstrate
  98 the configurability of ACPICA.
  99
 100
 101 5) acpisrc, a source code conversion tool
 102
 103 acpisrc converts the standard form of the acpica source release (included
 104 here) into a version that meets Linux coding guidelines. This consists
 105 mainly of performing a series of string replacements and transformations
 106 to the code. It can also be used to clean the acpica source and generate
 107 statistics.
 108
 109
 110 6) acpixtract, extract binary ACPI tables from an acpidump
 111
 112 acpixtract is used to extract binary ACPI tables from the ASCII text
 113 output of an acpidump utility (available on several different hosts.)
 114
 115
 116 7) iasl, an optimizing ASL compiler/disassembler
 117
 118 iasl compiles ASL (ACPI Source Language) into AML (ACPI Machine
 119 Language). This AML is suitable for inclusion as a DSDT in system
 120 firmware. It also can disassemble AML, for debugging purposes.