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.sourceforge.net/doc/html/index.html
  27
  28  OpenOCD Developer's Manual:
  29     http://openocd.sourceforge.net/doc/doxygen/html/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-devel@lists.sourceforge.net
  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 On Linux, you may have permissions problems to address.  The best way
  68 to do this is to use the contrib/openocd.udev rules file.  It probably
  69 belongs somewhere in /etc/udev/rules.d, but consult your operating
  70 system documentation to be sure.  In particular, make sure that it
  71 matches the syntax used by your operating system's version of udev.
  72
  73 A Note to OpenOCD Users
  74 -----------------------
  75
  76 If you would rather be working "with" OpenOCD rather than "on" it, your
  77 operating system or JTAG interface supplier may provide binaries for
  78 you in a convenient-enough package.
  79
  80 Such packages may be more stable than git mainline, where bleeding-edge
  81 development takes place.  These "Packagers" produce binary releases of
  82 OpenOCD after the developers produces new "release" versions of the
  83 source code.  Previous versions of OpenOCD cannot be used to diagnose
  84 problems with the current release, so users are encouraged to keep in
  85 contact with their distribution package maintainers or interface vendors
  86 to ensure suitable upgrades appear regularly.
  87
  88 Users of these binary versions of OpenOCD must contact their Packager to
  89 ask for support or newer versions of the binaries; the OpenOCD
  90 developers do not support packages directly.
  91
  92 A Note to OpenOCD Packagers
  93 ---------------------------
  94
  95 You are a PACKAGER of OpenOCD if you:
  96
  97 - Sell dongles: and include pre-built binaries
  98 - Supply tools: A complete development solution
  99 - Supply IDEs: like Eclipse, or RHIDE, etc.
 100 - Build packages: RPM files, or DEB files for a Linux Distro
 101
 102 As a PACKAGER, you will experience first reports of most issues.
 103 When you fix those problems for your users, your solution may help
 104 prevent hundreds (if not thousands) of other questions from other users.
 105
 106 If something does not work for you, please work to inform the OpenOCD
 107 developers know how to improve the system or documentation to avoid
 108 future problems, and follow-up to help us ensure the issue will be fully
 109 resolved in our future releases.
 110
 111 That said, the OpenOCD developers would also like you to follow a few
 112 suggestions:
 113
 114 - Send patches, including config files, upstream.
 115 - Always build with printer ports enabled.
 116 - Use libftdi + libusb for FT2232 support.
 117
 118 Remember, the FTD2XX library cannot be used in binary distributions, due
 119 to restrictions of the GPL v2.
 120
 121 ================
 122 Building OpenOCD
 123 ================
 124
 125 The INSTALL file contains generic instructions for running 'configure'
 126 and compiling the OpenOCD source code.  That file is provided by default
 127 for all GNU automake packages.  If you are not familiar with the GNU
 128 autotools, then you should read those instructions first.
 129
 130 The remainder of this document tries to provide some instructions for
 131 those looking for a quick-install.
 132
 133 OpenOCD Dependencies
 134 --------------------
 135
 136 Presently, GCC is required to build OpenOCD.  The developers have begun
 137 to enforce strict code warnings (-Wall, -Werror, -Wextra, and more) and
 138 use C99-specific features: inline functions, named initializers, mixing
 139 declarations with code, and other tricks.  While it may be possible to
 140 use other compilers, they must be somewhat modern and could require
 141 extending support to conditionally remove GCC-specific extensions.
 142
 143 Also, you need to install the appropriate driver files, if you want to
 144 build support for a USB or FTDI-based interface:
 145
 146 - ft2232, jlink, rlink, vsllink, usbprog, arm-jtag-ew:
 147   - libusb: required for portable communication with USB dongles
 148 - ft2232 also requires:
 149   - libftdi: http://www.intra2net.com/opensource/ftdi/  *OR*
 150   - ftd2xx: http://www.ftdichip.com/Drivers/D2XX.htm,
 151     or the Amontec version (from http://www.amontec.com), for
 152     easier support of JTAGkey's vendor and product IDs.
 153
 154 Many Linux distributions provide these packages through their automated
 155 installation and update mechanisms; however, some Linux versions include
 156 older versions of libftdi.  In particular, using Ubuntu 8.04 has been
 157 problematic, but newer versions of Ubuntu do not have this problem.
 158
 159 Compiling OpenOCD
 160 -----------------
 161
 162 To build OpenOCD (on both Linux and Cygwin), use the following sequence
 163 of commands:
 164
 165    ./configure [with some options listed in the next section]
 166    make
 167    make install
 168
 169 The 'configure' step generates the Makefiles required to build OpenOCD,
 170 usually with one or more options provided to it.  The first 'make' step
 171 will build OpenOCD and place the final executable in ./src/.  The
 172 final (optional) step, ``make install'', places all of the files in the
 173 required location.
 174
 175 Cross-Compiling Options
 176 -----------------------
 177
 178 To cross-compile, you must specify both --build and --host options to
 179 the 'configure' script.  For example, you can configure OpenOCD to
 180 cross-compile on a x86 Linux host to run on Windows (MinGW32), you could
 181 use the following configuration options:
 182
 183   ./configure --build=i686-pc-linux-gnu --host=i586-mingw32msvc ...
 184
 185 Likewise, the following options allow OpenOCD to be cross-compiled for
 186 an ARM target on the same x86 host:
 187
 188   ./configure --build=i686-pc-linux-gnu --host=arm-elf ...
 189
 190 Both must be specified to work around bugs in autoconf.
 191
 192 Scripts for producing ARM cross-compilers can be found on the web with a
 193 little searching.  A script to produce an x86 Linux-hosted MinGW32
 194 cross-compiler can be downloaded from the following URL:
 195
 196   http://www.mingw.org/wiki/LinuxCrossMinGW
 197
 198 Configuration Options
 199 ---------------------
 200
 201 The configure script takes numerous options, specifying which JTAG
 202 interfaces should be included (among other things).  The following list
 203 of options was extracted from the output of './configure --help'.  Other
 204 options may be available there:
 205
 206   --enable-maintainer-mode  enable make rules and dependencies not useful
 207                           (and sometimes confusing) to the casual installer
 208                           NOTE: This option is *required* for GIT builds!
 209                           It should *not* be used to build a release.
 210
 211   --enable-dummy          Enable building the dummy JTAG port driver
 212
 213   --enable-ft2232_libftdi Enable building support for FT2232 based devices
 214                           using the libftdi driver, opensource alternate of
 215                           FTD2XX
 216   --enable-ft2232_ftd2xx  Enable building support for FT2232 based devices
 217                           using the FTD2XX driver from ftdichip.com
 218
 219   --enable-gw16012        Enable building support for the Gateworks GW16012
 220                           JTAG Programmer
 221
 222   --enable-parport        Enable building the pc parallel port driver
 223   --disable-parport-ppdev Disable use of ppdev (/dev/parportN) for parport
 224                           (for x86 only)
 225   --enable-parport-giveio Enable use of giveio for parport (for CygWin only)
 226
 227   --enable-presto_libftdi Enable building support for ASIX Presto Programmer
 228                           using the libftdi driver
 229   --enable-presto_ftd2xx  Enable building support for ASIX Presto Programmer
 230                           using the FTD2XX driver
 231
 232   --enable-amtjtagaccel   Enable building the Amontec JTAG-Accelerator driver
 233   --enable-arm-jtag-ew    Enable building support for the Olimex ARM-JTAG-EW
 234                           Programmer
 235   --enable-jlink          Enable building support for the Segger J-Link JTAG
 236                           Programmer
 237   --enable-rlink          Enable building support for the Raisonance RLink
 238                           JTAG Programmer
 239   --enable-ulink          Enable building support for the Keil ULINK JTAG
 240                           Programmer
 241   --enable-usbprog        Enable building support for the usbprog JTAG
 242                           Programmer
 243   --enable-vsllink        Enable building support for the Versaloon-Link JTAG
 244                           Programmer
 245
 246   --enable-oocd_trace     Enable building support for the OpenOCD+trace ETM
 247                           capture device
 248
 249   --enable-ep93xx         Enable building support for EP93xx based SBCs
 250   --enable-at91rm9200     Enable building support for AT91RM9200 based SBCs
 251
 252   --enable-ecosboard      Enable building support for eCos based JTAG debugger
 253   --enable-zy1000         Enable ZY1000 interface
 254
 255   --enable-minidriver-dummy
 256                           Enable the dummy minidriver.
 257
 258   --enable-ioutil         Enable ioutil functions - useful for standalone
 259                           OpenOCD implementations
 260
 261   --disable-doxygen-html Disable building Doxygen manual as HTML.
 262   --enable-doxygen-pdf   Enable building Doxygen manual as PDF.
 263
 264 Miscellaneous Configure Options
 265 -------------------------------
 266
 267 The following additional options may also be useful:
 268
 269   --disable-assert        turn off assertions
 270
 271   --enable-verbose        Enable verbose JTAG I/O messages (for debugging).
 272   --enable-verbose-jtag-io
 273                           Enable verbose JTAG I/O messages (for debugging).
 274   --enable-verbose-usb-io Enable verbose USB I/O messages (for debugging)
 275   --enable-verbose-usb-comms
 276                           Enable verbose USB communication messages (for
 277                           debugging)
 278   --enable-malloc-logging Include free space in logging messages (requires
 279                           malloc.h).
 280
 281   --disable-gccwarnings   Disable extra gcc warnings during build.
 282   --disable-wextra        Disable extra compiler warnings
 283   --disable-werror        Do not treat warnings as errors
 284
 285   --disable-option-checking
 286                           Ignore unrecognized --enable and --with options.
 287   --disable-dependency-tracking  speeds up one-time build
 288   --enable-shared[=PKGS]  build shared libraries [default=no]
 289   --enable-static[=PKGS]  build static libraries [default=yes]
 290
 291 Parallel Port Dongles
 292 ---------------------
 293
 294 If you want to access the parallel port using the PPDEV interface you
 295 have to specify both --enable-parport AND --enable-parport-ppdev, since the
 296 the later option is an option to the parport driver (see
 297 http://forum.sparkfun.com/viewtopic.php?t=3795 for more info).
 298
 299 The same is true for the --enable-parport-giveio option, you
 300 have to use both the --enable-parport AND the --enable-parport-giveio
 301 option if you want to use giveio instead of ioperm parallel port access
 302 method.
 303
 304 FT2232C Based USB Dongles
 305 -------------------------
 306
 307 There are 2 methods of using the FTD2232, either (1) using the
 308 FTDICHIP.COM closed source driver, or (2) the open (and free) driver
 309 libftdi.
 310
 311 Using LIBFTDI
 312 -------------
 313
 314 The libftdi source code can be download from the following website:
 315
 316   http://www.intra2net.com/en/developer/libftdi/download.php
 317
 318 For both Linux and Windows, both libusb and libftdi must be built and
 319 installed.  To use the newer FT2232H chips, supporting RTCK and USB high
 320 speed (480 Mbps), use libftdi version 0.17 or newer.  Many Linux
 321 distributions provide suitable packages for these libraries.
 322
 323 For Windows, libftdi is supported with versions 0.14 and later.
 324
 325 With these prerequisites met, configure the libftdi solution like this:
 326
 327   ./configure --prefix=/path/for/your/install --enable-ft2232_libftdi
 328
 329 Then type ``make'', and perhaps ``make install''.
 330
 331 Using FTDI's FTD2XX
 332 -------------------
 333
 334 The (closed source) FTDICHIP.COM solution is faster on MS-Windows.  That
 335 is the motivation for supporting it even though its licensing restricts
 336 it to non-redistributable OpenOCD binaries, and it is not available for
 337 all operating systems used with OpenOCD.  You may, however, build such
 338 copies for personal use.
 339
 340 The FTDICHIP drivers come as either a (win32) ZIP file, or a (Linux)
 341 TAR.GZ file. You must unpack them ``some where'' convenient. As of this
 342 writing FTDICHIP does not supply means to install these files "in an
 343 appropriate place."
 344
 345 If your distribution does not package these, there are several
 346 './configure' options to solve this problem:
 347
 348   --with-ftd2xx-win32-zipdir
 349                           Where (CYGWIN/MINGW) the zip file from ftdichip.com
 350                           was unpacked <default=search>
 351   --with-ftd2xx-linux-tardir
 352                           Where (Linux/Unix) the tar file from ftdichip.com
 353                           was unpacked <default=search>
 354   --with-ftd2xx-lib       Use static or shared ftd2xx libs on default static
 355
 356 If you are using the FTDICHIP.COM driver, download and unpack the
 357 Windows or Linux FTD2xx drivers from the following location:
 358
 359         http://www.ftdichip.com/Drivers/D2XX.htm
 360
 361 Remember, this library is binary-only, while OpenOCD is licenced
 362 according to GNU GPLv2 without any exceptions.  That means that
 363 _distributing_ copies of OpenOCD built with the FTDI code would violate
 364 the OpenOCD licensing terms.
 365
 366 Linux Notes
 367 ***********
 368
 369 The Linux tar.gz archive contains a directory named libftd2xx0.4.16
 370 (or similar).  Assuming that you have extracted this archive in the same
 371 directory as the OpenOCD package, you could configure with options like
 372 the following:
 373
 374    ./configure \
 375         --enable-ft2232_ftd2xx \
 376         --with-ft2xx-linux-tardir=../libftd2xx0.4.16 \
 377         ... other options ...
 378
 379 Note that on Linux there is no good reason to use these FTDI binaries;
 380 they are no faster (on Linux) than libftdi, and cause licensing issues.
 381
 382 ==========================
 383 Obtaining OpenOCD From GIT
 384 ==========================
 385
 386 You can download the current GIT version with a GIT client of your
 387 choice from the main repository:
 388
 389    git://openocd.git.sourceforge.net/gitroot/openocd/openocd
 390
 391 You may prefer to use a mirror:
 392
 393    http://repo.or.cz/r/openocd.git
 394    git://repo.or.cz/openocd.git
 395
 396 Using the GIT command line client, you might use the following command
 397 to set up a local copy of the current repository (make sure there is no
 398 directory called "openocd" in the current directory):
 399
 400    git clone git://openocd.git.sourceforge.net/gitroot/openocd/openocd
 401
 402 Then you can update that at your convenience using
 403
 404    git pull
 405
 406 There is also a gitweb interface, which you can use either to browse
 407 the repository or to download arbitrary snapshots using HTTP:
 408
 409    http://openocd.git.sourceforge.net/git/gitweb.cgi?p=openocd/openocd
 410    http://repo.or.cz/w/openocd.git
 411
 412 Snapshots are compressed tarballs of the source tree, about 1.3 MBytes
 413 each at this writing.
 414
 415
 416 Tips For Building From a GIT Repository
 417 ---------------------------------------
 418
 419 Building OpenOCD from a repository requires a recent version of the GNU
 420 autotools (autoconf >= 2.59 and automake >= 1.9).
 421
 422 1) Run './bootstrap' to create the 'configure' script and prepare
 423    the build process for your host system.
 424
 425 2) Run './configure --enable-maintainer-mode' with other options.