You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

205 lines
8.2 KiB

  1. TODO!!! this should be merged into openocd.texi!!!
  2. Prerequisites
  3. =============
  4. When building with support for FTDI FT2232 based devices, you need at least
  5. one of the following libraries:
  6. - libftdi (
  7. - libftd2xx (
  8. On Windows, you need either Cygwin or MinGW, but compilation for MinGW is also
  9. possible using a Cygwin host.
  10. Basic Installation
  11. ==================
  12. OpenOCD is distributed without autotools generated files, i.e. without a
  13. configure script. Run ./bootstrap in the openocd directory to have all
  14. necessary files generated.
  15. You have to explicitly enable desired JTAG interfaces during configure:
  16. ./configure --enable-parport --enable-ft2232-libftdi (OR --enable-ft2232-ftd2xx) \
  17. --enable-amtjtagaccel
  18. Under Windows/Cygwin, only the ftd2xx driver is supported for FT2232 based
  19. devices. You have to specify the location of the FTDI driver package with the
  20. --with-ftd2xx=/full/path/name option.
  21. Under Linux you can choose to build the parport driver with support for
  22. /dev/parportN instead of the default access with direct port I/O using
  23. --enable-parport_ppdev. This has the advantage of running OpenOCD without root
  24. privileges at the expense of a slight performance decrease. This is also
  25. available on FreeBSD using PPI, but the naming of the devices is different.
  26. Generic installation instructions
  27. =================================
  28. These are generic installation instructions.
  29. The `configure' shell script attempts to guess correct values for
  30. various system-dependent variables used during compilation. It uses
  31. those values to create a `Makefile' in each directory of the package.
  32. It may also create one or more `.h' files containing system-dependent
  33. definitions. Finally, it creates a shell script `config.status' that
  34. you can run in the future to recreate the current configuration, a file
  35. `config.cache' that saves the results of its tests to speed up
  36. reconfiguring, and a file `config.log' containing compiler output
  37. (useful mainly for debugging `configure').
  38. If you need to do unusual things to compile the package, please try
  39. to figure out how `configure' could check whether to do them, and mail
  40. diffs or instructions to the address given in the `README' so they can
  41. be considered for the next release. If at some point `config.cache'
  42. contains results you don't want to keep, you may remove or edit it.
  43. The file `' is used to create `configure' by a program
  44. called `autoconf'. You only need `' if you want to change
  45. it or regenerate `configure' using a newer version of `autoconf'.
  46. The simplest way to compile this package is:
  47. 1. `cd' to the directory containing the package's source code and type
  48. `./configure' to configure the package for your system. If you're
  49. using `csh' on an old version of System V, you might need to type
  50. `sh ./configure' instead to prevent `csh' from trying to execute
  51. `configure' itself.
  52. Running `configure' takes a while. While running, it prints some
  53. messages telling which features it is checking for.
  54. 2. Type `make' to compile the package.
  55. 3. Type `make install' to install the programs and any data files and
  56. documentation.
  57. 4. You can remove the program binaries and object files from the
  58. source code directory by typing `make clean'.
  59. Compilers and Options
  60. =====================
  61. Some systems require unusual options for compilation or linking that
  62. the `configure' script does not know about. You can give `configure'
  63. initial values for variables by setting them in the environment. Using
  64. a Bourne-compatible shell, you can do that on the command line like
  65. this:
  66. CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
  67. Or on systems that have the `env' program, you can do it like this:
  68. env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
  69. Compiling For Multiple Architectures
  70. ====================================
  71. You can compile the package for more than one kind of computer at the
  72. same time, by placing the object files for each architecture in their
  73. own directory. To do this, you must use a version of `make' that
  74. supports the `VPATH' variable, such as GNU `make'. `cd' to the
  75. directory where you want the object files and executables to go and run
  76. the `configure' script. `configure' automatically checks for the
  77. source code in the directory that `configure' is in and in `..'.
  78. If you have to use a `make' that does not supports the `VPATH'
  79. variable, you have to compile the package for one architecture at a time
  80. in the source code directory. After you have installed the package for
  81. one architecture, use `make distclean' before reconfiguring for another
  82. architecture.
  83. Installation Names
  84. ==================
  85. By default, `make install' will install the package's files in
  86. `/usr/local/bin', `/usr/local/man', etc. You can specify an
  87. installation prefix other than `/usr/local' by giving `configure' the
  88. option `--prefix=PATH'.
  89. You can specify separate installation prefixes for
  90. architecture-specific files and architecture-independent files. If you
  91. give `configure' the option `--exec-prefix=PATH', the package will use
  92. PATH as the prefix for installing programs and libraries.
  93. Documentation and other data files will still use the regular prefix.
  94. If the package supports it, you can cause programs to be installed
  95. with an extra prefix or suffix on their names by giving `configure' the
  96. option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
  97. Optional Features
  98. =================
  99. Some packages pay attention to `--enable-FEATURE' options to
  100. `configure', where FEATURE indicates an optional part of the package.
  101. They may also pay attention to `--with-PACKAGE' options, where PACKAGE
  102. is something like `gnu-as' or `x' (for the X Window System). The
  103. `README' should mention any `--enable-' and `--with-' options that the
  104. package recognizes.
  105. For packages that use the X Window System, `configure' can usually
  106. find the X include and library files automatically, but if it doesn't,
  107. you can use the `configure' options `--x-includes=DIR' and
  108. `--x-libraries=DIR' to specify their locations.
  109. Specifying the System Type
  110. ==========================
  111. There may be some features `configure' can not figure out
  112. automatically, but needs to determine by the type of host the package
  113. will run on. Usually `configure' can figure that out, but if it prints
  114. a message saying it can not guess the host type, give it the
  115. `--host=TYPE' option. TYPE can either be a short name for the system
  116. type, such as `sun4', or a canonical name with three fields:
  118. See the file `config.sub' for the possible values of each field. If
  119. `config.sub' isn't included in this package, then this package doesn't
  120. need to know the host type.
  121. If you are building compiler tools for cross-compiling, you can also
  122. use the `--target=TYPE' option to select the type of system they will
  123. produce code for and the `--build=TYPE' option to select the type of
  124. system on which you are compiling the package.
  125. Sharing Defaults
  126. ================
  127. If you want to set default values for `configure' scripts to share,
  128. you can create a site shell script called `' that gives
  129. default values for variables like `CC', `cache_file', and `prefix'.
  130. `configure' looks for `PREFIX/share/' if it exists, then
  131. `PREFIX/etc/' if it exists. Or, you can set the
  132. `CONFIG_SITE' environment variable to the location of the site script.
  133. A warning: not all `configure' scripts look for a site script.
  134. Operation Controls
  135. ==================
  136. `configure' recognizes the following options to control how it
  137. operates.
  138. `--cache-file=FILE'
  139. Use and save the results of the tests in FILE instead of
  140. `./config.cache'. Set FILE to `/dev/null' to disable caching, for
  141. debugging `configure'.
  142. `--help'
  143. Print a summary of the options to `configure', and exit.
  144. `--quiet'
  145. `--silent'
  146. `-q'
  147. Do not print messages saying which checks are being made.
  148. `--srcdir=DIR'
  149. Look for the package's source code in directory DIR. Usually
  150. `configure' can determine that directory automatically.
  151. `--version'
  152. Print the version of Autoconf used to generate the `configure'
  153. script, and exit.
  154. `configure' also accepts some other, not widely useful, options.