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.

202 lines
8.1 KiB

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