README

   1 Welcome to OpenOCD!
   2 ===================
   3
   4 OpenOCD provides on-chip programming and debugging support with a
   5 layered architecture of JTAG interface and TAP support, debug target
   6 support (e.g. ARM, MIPS), and flash chip drivers (e.g. CFI, NAND, etc.).
   7 Several network interfaces are available for interactiving with OpenOCD:
   8 HTTP, telnet, TCL, and GDB.  The GDB server enables OpenOCD to function
   9 as a "remote target" for source-level debugging of embedded systems
  10 using the GNU GDB program.
  11
  12 This README file contains an overview of the following topics:
  13 - how to find and build more OpenOCD documentation,
  14 - the build process
  15 - packaging tips.
  16 - configuration options
  17
  18 =====================
  19 OpenOCD Documentation
  20 =====================
  21
  22 In addition to in-tree documentation, the latest documentation may be
  23 viewed on-line at the following URLs:
  24
  25  OpenOCD User's Guide:
  26     http://openocd.berlios.de/doc/html/index.html
  27
  28  OpenOCD Developer's Manual:
  29     http://openocd.berlios.de/doc/doxygen/index.html
  30
  31 These reflect the latest development versions, so the following section
  32 introduces how to build the complete documentation from the package.
  33
  34
  35 For more information, refer to these documents or contact the developers
  36 by subscribing to the OpenOCD developer mailing list:
  37
  38         openocd-development@lists.berlios.de
  39
  40 Building the OpenOCD Documentation
  41 ----------------------------------
  42
  43 The OpenOCD User's Guide can be produced in two different format:
  44
  45   # If PDFVIEWER is set, this creates and views the PDF User Guide.
  46   make pdf && ${PDFVIEWER} doc/openocd.pdf
  47
  48   # If HTMLVIEWER is set, this creates and views the HTML User Guide.
  49   make html && ${HTMLVIEWER} doc/openocd.html/index.html
  50
  51 The OpenOCD Developer Manual contains information about the internal
  52 architecture and other details about the code:
  53
  54   # NB! make sure doxygen is installed, type doxygen --version
  55   make doxygen
  56
  57   # If HTMLVIEWER is set, this views the HTML Doxygen output.
  58   ${HTMLVIEWER} doxygen/index.html
  59
  60 The remaining sections describe how to configure the system such that
  61 you can build the in-tree documentation.
  62
  63 ==================
  64 Installing OpenOCD
  65 ==================
  66
  67 A Note to OpenOCD Users
  68 -----------------------
  69
  70 If you would rather be working "with" OpenOCD rather than "on" it, your
  71 operating system or interface supplier may provide binaries for you in a
  72 convenient package.
  73
  74 Such packages should be more stable than SVN trunk, where bleeding-edge
  75 development takes place.  These "Packagers" produce binary releases of
  76 OpenOCD after the developers produces new "stable" versions of the
  77 source code.  Previous versions of OpenOCD cannot be used to diagnosed
  78 problems with the current release, so users are encouraged to keep in
  79 contact with their distribution package maintainers or interface vendors
  80 to ensure suitable upgrades appear regularly.
  81
  82 Users of these binary versions of OpenOCD must contact their Packager to
  83 ask for support or newer versions of the binaries; the OpenOCD
  84 developers do not support packages directly.
  85
  86 A Note to OpenOCD Packagers
  87 ---------------------------
  88
  89 You are a PACKAGER of OpenOCD if you:
  90
  91 - Sell dongles: and include pre-built binaries
  92 - Supply tools: A complete development solution
  93 - Supply IDEs: like Eclipse, or RHIDE, etc.
  94 - Build packages: RPM files, or DEB files for a Linux Distro
  95
  96 As a PACKAGER, you will experience first reports of most issues.
  97 When you fix those problems for your users, your solution may help
  98 prevent hundreds (if not thousands) of other questions from other users.
  99
 100 If something does not work for you, please work to inform the OpenOCD
 101 developers know how to improve the system or documentation to avoid
 102 future problems, and follow-up to help us ensure the issue will be fully
 103 resolved in our future releases.
 104
 105 That said, the OpenOCD developers would also like you to follow a few
 106 suggestions:
 107
 108 - Send patches, including config files, upstream.
 109 - Always build with printer ports enabled.
 110 - Use libftdi + libusb for FT2232 support.
 111
 112 Remember, the FTD2XX library cannot be used in binary distributions, due
 113 to restrictions of the GPL v2.
 114
 115 ================
 116 Building OpenOCD
 117 ================
 118
 119 The INSTALL file contains generic instructions for running 'configure'
 120 and compiling the OpenOCD source code.  That file is provided by default
 121 for all GNU automake packages.  If you are not familiar with the GNU
 122 autotools, then you should read those instructions first.
 123
 124 The remainder of this document tries to provide some instructions for
 125 those looking for a quick-install.
 126
 127 OpenOCD Dependencies
 128 --------------------
 129
 130 Presently, GCC is required to build OpenOCD.  The developers have begun
 131 to enforce strict code warnings (-Wall, -Werror, -Wextra, and more) and
 132 use C99-specific features: inline functions, named initializers, mixing
 133 declarations with code, and other tricks.  While it may be possible to
 134 use other compilers, they must be somewhat modern and could require
 135 extending support to conditionally remove GCC-specific extensions.
 136
 137 Also, you need to install the appropriate driver files, if you want to
 138 build support for a USB or FTDI-based interface:
 139
 140 - ft2232, jlink, rlink, vsllink, usbprog, arm-jtag-ew:
 141   - libusb: required for portable communication with USB dongles
 142 - ft2232 also requires:
 143   - libftdi: http://www.intra2net.com/opensource/ftdi/  *OR*
 144   - ftd2xx: http://www.ftdichip.com/Drivers/D2XX.htm,
 145     or the Amontec version (from http://www.amontec.com), for
 146     easier support of JTAGkey's vendor and product IDs.
 147
 148 Many Linux distributions provide these packages through their automated
 149 installation and update mechanisms; however, some Linux versions include
 150 older versions of libftdi.  In particular, using Ubuntu 8.04 has been
 151 problematic, but newer versions of Ubuntu do not have this problem.
 152
 153 Compiling OpenOCD
 154 -----------------
 155
 156 To build OpenOCD (on both Linux and Cygwin), use the following sequence
 157 of commands:
 158
 159    ./configure [with some options listed in the next section]
 160    make
 161    make install
 162
 163 The 'configure' step generates the Makefiles required to build OpenOCD,
 164 usually with one or more options provided to it.  The first 'make' step
 165 will build OpenOCD and place the final executable in ./src/.  The
 166 final (optional) step, ``make install'', places all of the files in the
 167 required location.
 168
 169 Configuration Options
 170 ---------------------
 171
 172 The configure script takes numerous options, specifying which JTAG
 173 interfaces should be included (among other things).  The following list
 174 of options was extracted from the output of './configure --help'.  Other
 175 options may be available there:
 176
 177   --enable-maintainer-mode  enable make rules and dependencies not useful
 178                           (and sometimes confusing) to the casual installer
 179                           NOTE: This option is *required* for SVN builds!
 180                           It should *not* be used to build a release.
 181
 182   --enable-dummy          Enable building the dummy JTAG port driver
 183
 184   --enable-ft2232_libftdi Enable building support for FT2232 based devices
 185                           using the libftdi driver, opensource alternate of
 186                           FTD2XX
 187   --enable-ft2232_ftd2xx  Enable building support for FT2232 based devices
 188                           using the FTD2XX driver from ftdichip.com
 189   --enable-ftd2xx-highspeed
 190                           Enable building support for FT2232H and
 191                           FT4232H-based devices (requires >=libftd2xx-0.4.16)
 192
 193   --enable-gw16012        Enable building support for the Gateworks GW16012
 194                           JTAG Programmer
 195
 196   --enable-parport        Enable building the pc parallel port driver
 197   --disable-parport-ppdev Disable use of ppdev (/dev/parportN) for parport
 198                           (for x86 only)
 199   --enable-parport-giveio Enable use of giveio for parport (for CygWin only)
 200
 201   --enable-presto_libftdi Enable building support for ASIX Presto Programmer
 202                           using the libftdi driver
 203   --enable-presto_ftd2xx  Enable building support for ASIX Presto Programmer
 204                           using the FTD2XX driver
 205
 206   --enable-amtjtagaccel   Enable building the Amontec JTAG-Accelerator driver
 207   --enable-arm-jtag-ew    Enable building support for the Olimex ARM-JTAG-EW
 208                           Programmer
 209   --enable-jlink          Enable building support for the Segger J-Link JTAG
 210                           Programmer
 211   --enable-rlink          Enable building support for the Raisonance RLink
 212                           JTAG Programmer
 213   --enable-usbprog        Enable building support for the usbprog JTAG
 214                           Programmer
 215   --enable-vsllink        Enable building support for the Versaloon-Link JTAG
 216                           Programmer
 217
 218   --enable-oocd_trace     Enable building support for the OpenOCD+trace ETM
 219                           capture device
 220
 221   --enable-ep93xx         Enable building support for EP93xx based SBCs
 222   --enable-at91rm9200     Enable building support for AT91RM9200 based SBCs
 223
 224   --enable-ecosboard      Enable building support for eCos based JTAG debugger
 225   --enable-zy1000         Enable ZY1000 interface
 226
 227   --enable-minidriver-dummy
 228                           Enable the dummy minidriver.
 229
 230   --enable-ioutil         Enable ioutil functions - useful for standalone
 231                           OpenOCD implementations
 232   --enable-httpd          Enable builtin httpd server - useful for standalone
 233                           OpenOCD implementations
 234
 235 Miscellaneous Configure Options
 236 -------------------------------
 237
 238 The following additional options may also be useful:
 239
 240   --disable-assert        turn off assertions
 241
 242   --enable-verbose        Enable verbose JTAG I/O messages (for debugging).
 243   --enable-verbose-jtag-io
 244                           Enable verbose JTAG I/O messages (for debugging).
 245   --enable-verbose-usb-io Enable verbose USB I/O messages (for debugging)
 246   --enable-verbose-usb-comms
 247                           Enable verbose USB communication messages (for
 248                           debugging)
 249   --enable-malloc-logging Include free space in logging messages (requires
 250                           malloc.h).
 251
 252   --disable-gccwarnings   Disable extra gcc warnings during build.
 253   --disable-wextra        Disable extra compiler warnings
 254   --disable-werror        Do not treat warnings as errors
 255
 256   --disable-option-checking
 257                           Ignore unrecognized --enable and --with options.
 258   --disable-dependency-tracking  speeds up one-time build
 259   --enable-shared[=PKGS]  build shared libraries [default=no]
 260   --enable-static[=PKGS]  build static libraries [default=yes]
 261
 262 Parallel Port Dongles
 263 ---------------------
 264
 265 If you want to access the parallel port using the PPDEV interface you
 266 have to specify both --enable-parport AND --enable-parport-ppdev, since the
 267 the later option is an option to the parport driver (see
 268 http://forum.sparkfun.com/viewtopic.php?t=3795 for more info).
 269
 270 The same is true for the --enable-parport-giveio option, you
 271 have to use both the --enable-parport AND the --enable-parport-giveio
 272 option if you want to use giveio instead of ioperm parallel port access
 273 method.
 274
 275 FT2232C Based USB Dongles
 276 -------------------------
 277
 278 There are 2 methods of using the FTD2232, either (1) using the
 279 FTDICHIP.COM closed source driver, or (2) the open (and free) driver
 280 libftdi.
 281
 282 Using LIBFTDI
 283 -------------
 284
 285 For both Linux and Windows, both libusb and libftdi must be built and
 286 installed.  To use the newer FT2232H chips, supporting RTCK and USB high
 287 speed (480 Mbps), you need libftdi version 0.16 or newer.  Many Linux
 288 distributions provide suitable packages for these libraries.
 289
 290 For Windows, libftdi is supported with versions 0.14 and later.
 291
 292 With these prerequisites met, configure the libftdi solution like this:
 293
 294   ./configure --prefix=/path/for/your/install --enable-ft2232_libftdi
 295
 296 Then type ``make'', and perhaps ``make install''.
 297
 298 Using FTDI's FTD2XX
 299 -------------------
 300
 301 Some claim the (closed) FTDICHIP.COM solution is faster, which
 302 is the motivation for supporting it even though its licensing restricts
 303 it to non-redistributable OpenOCD binaries, and it is not available for
 304 all operating systems used with OpenOCD.  You may, however, build such
 305 copies for personal use.
 306
 307 The FTDICHIP drivers come as either a (win32) ZIP file, or a (Linux)
 308 TAR.GZ file. You must unpack them ``some where'' convient. As of this
 309 writing FTDICHIP does not supply means to install these files "in an
 310 appropriate place."
 311
 312 If your distribution does not package these, there are several
 313 './configure' options to solve this problem:
 314
 315   --with-ftd2xx-win32-zipdir
 316                           Where (CYGWIN/MINGW) the zip file from ftdichip.com
 317                           was unpacked <default=search>
 318   --with-ftd2xx-linux-tardir
 319                           Where (Linux/Unix) the tar file from ftdichip.com
 320                           was unpacked <default=search>
 321   --with-ftd2xx-lib       Use static or shared ftd2xx libs on default static
 322
 323 If you are using the FTDICHIP.COM driver, download and unpack the
 324 Windows or Linux FTD2xx drivers from the following location:
 325
 326         http://www.ftdichip.com/Drivers/D2XX.htm
 327
 328 Remember, this library is binary-only, while OpenOCD is licenced
 329 according to GNU GPLv2 without any exceptions.  That means that
 330 _distributing_ copies of OpenOCD built with the FTDI code would violate
 331 the OpenOCD licensing terms.
 332
 333
 334 Cygwin/Win32 Notes
 335 ******************
 336
 337 The Cygwin/Win32 ZIP file contains a directory named ftd2xx.win32.
 338 Assuming that you have extracted this archive in the same directory as
 339 the OpenOCD package, you could configure with options like the following:
 340
 341    ./configure \
 342         --enable-ft2232_ftd2xx \
 343         --with-ftd2xx-win32-zipdir=../ftd2xx.win32 \
 344         ... other options ...
 345
 346 Linux Notes
 347 ***********
 348
 349 The Linux tar.gz archive contains a directory named libftd2xx0.4.16
 350 (or similar).  Assuming that you have extracted this archive in the same
 351 directory as the OpenOCD package, you could configure with options like
 352 the following:
 353
 354    ./configure \
 355         --enable-ft2232_ftd2xx \
 356         --with-ft2xx-linux-tardir=../libftd2xx0.4.16 \
 357         ... other options ...
 358
 359 =================================
 360 Obtaining OpenOCD From Subversion
 361 ---------------------------------
 362
 363 You can download the current SVN version with an SVN client of your
 364 choice from the following repositories:
 365
 366    svn://svn.berlios.de/openocd/trunk
 367 or
 368    http://svn.berlios.de/svnroot/repos/openocd/trunk
 369
 370 Using the SVN command line client, you can use the following command to
 371 fetch the latest version (make sure there is no (non-svn) directory
 372 called "openocd" in the current directory):
 373
 374    svn checkout svn://svn.berlios.de/openocd/trunk openocd
 375
 376 If you prefer GIT based tools, the git-svn package works too:
 377
 378    git svn clone -s svn://svn.berlios.de/openocd
 379
 380 Tips For Building From The Subversion Repository
 381 ************************************************
 382
 383 Building OpenOCD from a repository requires a recent version of the GNU
 384 autotools (autoconf >= 2.59 and automake >= 1.9).  For building on
 385 Windows, you have to use Cygwin. Make sure that your PATH
 386 environment variable contains no other locations with Unix utils (like
 387 UnxUtils) - these can't handle the Cygwin paths, resulting in obscure
 388 dependency errors.  This was an observation gathered from the logs of
 389 one user; please correct us if this is wrong.
 390
 391 1) Run './bootstrap' to create the 'configure' script and prepare
 392    the build process for your host system.
 393
 394 2) Run './configure --enable-maintainer-mode' with other options.
 395
 396