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 including:
   6
   7 - (X)SVF playback to faciliate automated boundary scan and FPGA/CPLD
   8   programming;
   9 - debug target support (e.g. ARM, MIPS): single-stepping,
  10   breakpoints/watchpoints, gprof profiling, etc;
  11 - flash chip drivers (e.g. CFI, NAND, internal flash);
  12 - embedded TCL interpreter for easy scripting.
  13
  14 Several network interfaces are available for interacting with OpenOCD:
  15 telnet, TCL, and GDB. The GDB server enables OpenOCD to function as a
  16 "remote target" for source-level debugging of embedded systems using
  17 the GNU GDB program (and the others who talk GDB protocol, e.g. IDA
  18 Pro).
  19
  20 This README file contains an overview of the following topics:
  21
  22 - quickstart instructions,
  23 - how to find and build more OpenOCD documentation,
  24 - list of the supported hardware,
  25 - the installation and build process,
  26 - packaging tips.
  27
  28
  29 ============================
  30 Quickstart for the impatient
  31 ============================
  32
  33 If you have a popular board then just start OpenOCD with its config,
  34 e.g.:
  35
  36   openocd -f board/stm32f4discovery.cfg
  37
  38 If you are connecting a particular adapter with some specific target,
  39 you need to source both the jtag interface and the target configs,
  40 e.g.:
  41
  42   openocd -f interface/ftdi/jtagkey2.cfg -c "transport select jtag" \
  43           -f target/ti_calypso.cfg
  44
  45   openocd -f interface/stlink-v2-1.cfg -c "transport select hla_swd" \
  46           -f target/stm32l0.cfg
  47
  48 NB: when using an FTDI-based adapter you should prefer configs in the
  49 ftdi directory; the old configs for the ft2232 are deprecated.
  50
  51 After OpenOCD startup, connect GDB with
  52
  53   (gdb) target extended-remote localhost:3333
  54
  55
  56 =====================
  57 OpenOCD Documentation
  58 =====================
  59
  60 In addition to the in-tree documentation, the latest manuals may be
  61 viewed online at the following URLs:
  62
  63   OpenOCD User's Guide:
  64     http://openocd.sourceforge.net/doc/html/index.html
  65
  66   OpenOCD Developer's Manual:
  67     http://openocd.sourceforge.net/doc/doxygen/html/index.html
  68
  69 These reflect the latest development versions, so the following section
  70 introduces how to build the complete documentation from the package.
  71
  72 For more information, refer to these documents or contact the developers
  73 by subscribing to the OpenOCD developer mailing list:
  74
  75         openocd-devel@lists.sourceforge.net
  76
  77 Building the OpenOCD Documentation
  78 ----------------------------------
  79
  80 By default the OpenOCD build process prepares documentation in the
  81 "Info format" and installs it the standard way, so that "info openocd"
  82 can access it.
  83
  84 Additionally, the OpenOCD User's Guide can be produced in the
  85 following different formats:
  86
  87   # If PDFVIEWER is set, this creates and views the PDF User Guide.
  88   make pdf && ${PDFVIEWER} doc/openocd.pdf
  89
  90   # If HTMLVIEWER is set, this creates and views the HTML User Guide.
  91   make html && ${HTMLVIEWER} doc/openocd.html/index.html
  92
  93 The OpenOCD Developer Manual contains information about the internal
  94 architecture and other details about the code:
  95
  96   # NB! make sure doxygen is installed, type doxygen --version
  97   make doxygen && ${HTMLVIEWER} doxygen/index.html
  98
  99
 100 ==================
 101 Supported hardware
 102 ==================
 103
 104 JTAG adapters
 105 -------------
 106
 107 AICE, ARM-JTAG-EW, ARM-USB-OCD, ARM-USB-TINY, AT91RM9200, axm0432,
 108 BCM2835, Bus Blaster, Buspirate, Chameleon, CMSIS-DAP, Cortino, DENX,
 109 Digilent JTAG-SMT2, DLC 5, DLP-USB1232H, embedded projects, eStick,
 110 FlashLINK, FlossJTAG, Flyswatter, Flyswatter2, Gateworks, Hoegl, ICDI,
 111 ICEBear, J-Link, JTAG VPI, JTAGkey, JTAGkey2, JTAG-lock-pick, KT-Link,
 112 Lisa/L, LPC1768-Stick, MiniModule, NGX, NXHX, OOCDLink, Opendous,
 113 OpenJTAG, Openmoko, OpenRD, OSBDM, Presto, Redbee, RLink, SheevaPlug
 114 devkit, Stellaris evkits, ST-LINK (SWO tracing supported),
 115 STM32-PerformanceStick, STR9-comStick, sysfsgpio, TUMPA, Turtelizer,
 116 ULINK, USB-A9260, USB-Blaster, USB-JTAG, USBprog, VPACLink, VSLLink,
 117 Wiggler, XDS100v2, Xverve.
 118
 119 Debug targets
 120 -------------
 121
 122 ARM11, ARM7, ARM9, AVR32, Cortex-A, Cortex-R, Cortex-M,
 123 Feroceon/Dragonite, DSP563xx, DSP5680xx, FA526, MIPS EJTAG, NDS32,
 124 XScale, Intel Quark.
 125
 126 Flash drivers
 127 -------------
 128
 129 ADUC702x, AT91SAM, AVR, CFI, DSP5680xx, EFM32, EM357, FM3, Kinetis,
 130 LPC2000, LPC2900, LPCSPIFI, Milandr, NuMicro, PIC32mx, PSoC4, Stellaris,
 131 STM32, STMSMI, STR7x, STR9x, nRF51; NAND controllers of AT91SAM9, LPC3180,
 132 LPC32xx, i.MX31, MXC, NUC910, Orion/Kirkwood, S3C24xx, S3C6400.
 133
 134
 135 ==================
 136 Installing OpenOCD
 137 ==================
 138
 139 A Note to OpenOCD Users
 140 -----------------------
 141
 142 If you would rather be working "with" OpenOCD rather than "on" it, your
 143 operating system or JTAG interface supplier may provide binaries for
 144 you in a convenient-enough package.
 145
 146 Such packages may be more stable than git mainline, where
 147 bleeding-edge development takes place. These "Packagers" produce
 148 binary releases of OpenOCD after the developers produces new "release"
 149 versions of the source code. Previous versions of OpenOCD cannot be
 150 used to diagnose problems with the current release, so users are
 151 encouraged to keep in contact with their distribution package
 152 maintainers or interface vendors to ensure suitable upgrades appear
 153 regularly.
 154
 155 Users of these binary versions of OpenOCD must contact their Packager to
 156 ask for support or newer versions of the binaries; the OpenOCD
 157 developers do not support packages directly.
 158
 159 A Note to OpenOCD Packagers
 160 ---------------------------
 161
 162 You are a PACKAGER of OpenOCD if you:
 163
 164 - Sell dongles and include pre-built binaries;
 165 - Supply tools or IDEs (a development solution integrating OpenOCD);
 166 - Build packages (e.g. RPM or DEB files for a GNU/Linux distribution).
 167
 168 As a PACKAGER, you will experience first reports of most issues.
 169 When you fix those problems for your users, your solution may help
 170 prevent hundreds (if not thousands) of other questions from other users.
 171
 172 If something does not work for you, please work to inform the OpenOCD
 173 developers know how to improve the system or documentation to avoid
 174 future problems, and follow-up to help us ensure the issue will be fully
 175 resolved in our future releases.
 176
 177 That said, the OpenOCD developers would also like you to follow a few
 178 suggestions:
 179
 180 - Send patches, including config files, upstream, participate in the
 181   discussions;
 182 - Enable all the options OpenOCD supports, even those unrelated to your
 183   particular hardware;
 184 - Use "ftdi" interface adapter driver for the FTDI-based devices.
 185
 186 As a PACKAGER, never link against the FTD2XX library, as the resulting
 187 binaries can't be legally distributed, due to the restrictions of the
 188 GPL.
 189
 190
 191 ================
 192 Building OpenOCD
 193 ================
 194
 195 The INSTALL file contains generic instructions for running 'configure'
 196 and compiling the OpenOCD source code. That file is provided by
 197 default for all GNU autotools packages. If you are not familiar with
 198 the GNU autotools, then you should read those instructions first.
 199
 200 The remainder of this document tries to provide some instructions for
 201 those looking for a quick-install.
 202
 203 OpenOCD Dependencies
 204 --------------------
 205
 206 GCC or Clang is currently required to build OpenOCD. The developers
 207 have begun to enforce strict code warnings (-Wall, -Werror, -Wextra,
 208 and more) and use C99-specific features: inline functions, named
 209 initializers, mixing declarations with code, and other tricks. While
 210 it may be possible to use other compilers, they must be somewhat
 211 modern and could require extending support to conditionally remove
 212 GCC-specific extensions.
 213
 214 You'll also need:
 215
 216 - make
 217 - libtool
 218 - pkg-config >= 0.23 (or compatible)
 219
 220 Additionally, for building from git:
 221
 222 - autoconf >= 2.64
 223 - automake >= 1.9
 224 - texinfo
 225
 226 USB-based adapters depend on libusb-1.0 and some older drivers require
 227 libusb-0.1 or libusb-compat-0.1. A compatible implementation, such as
 228 FreeBSD's, additionally needs the corresponding .pc files.
 229
 230 USB-Blaster, ASIX Presto, OpenJTAG and ft2232 interface adapter
 231 drivers need either one of:
 232   - libftdi: http://www.intra2net.com/en/developer/libftdi/index.php
 233   - ftd2xx: http://www.ftdichip.com/Drivers/D2XX.htm (proprietary,
 234     GPL-incompatible)
 235
 236 CMSIS-DAP support needs HIDAPI library.
 237
 238 Permissions delegation
 239 ----------------------
 240
 241 Running OpenOCD with root/administrative permissions is strongly
 242 discouraged for security reasons.
 243
 244 For USB devices on GNU/Linux you should use the contrib/99-openocd.rules
 245 file. It probably belongs somewhere in /etc/udev/rules.d, but
 246 consult your operating system documentation to be sure. Do not forget
 247 to add yourself to the "plugdev" group.
 248
 249 For parallel port adapters on GNU/Linux and FreeBSD please change your
 250 "ppdev" (parport* or ppi*) device node permissions accordingly.
 251
 252 For parport adapters on Windows you need to run install_giveio.bat
 253 (it's also possible to use "ioperm" with Cygwin instead) to give
 254 ordinary users permissions for accessing the "LPT" registers directly.
 255
 256 Compiling OpenOCD
 257 -----------------
 258
 259 To build OpenOCD, use the following sequence of commands:
 260
 261   ./bootstrap (when building from the git repository)
 262   ./configure [options]
 263   make
 264   sudo make install
 265
 266 The 'configure' step generates the Makefiles required to build
 267 OpenOCD, usually with one or more options provided to it. The first
 268 'make' step will build OpenOCD and place the final executable in
 269 './src/'. The final (optional) step, ``make install'', places all of
 270 the files in the required location.
 271
 272 To see the list of all the supported options, run
 273   ./configure --help
 274
 275 Cross-compiling Options
 276 -----------------------
 277
 278 Cross-compiling is supported the standard autotools way, you just need
 279 to specify the cross-compiling target triplet in the --host option,
 280 e.g. for cross-building for Windows 32-bit with MinGW on Debian:
 281
 282   ./configure --host=i686-w64-mingw32 [options]
 283
 284 To make pkg-config work nicely for cross-compiling, you might need an
 285 additional wrapper script as described at
 286
 287   http://www.flameeyes.eu/autotools-mythbuster/pkgconfig/cross-compiling.html
 288
 289 This is needed to tell pkg-config where to look for the target
 290 libraries that OpenOCD depends on. Alternatively, you can specify
 291 *_CFLAGS and *_LIBS environment variables directly, see "./configure
 292 --help" for the details.
 293
 294 Parallel Port Dongles
 295 ---------------------
 296
 297 If you want to access the parallel port using the PPDEV interface you
 298 have to specify both --enable-parport AND --enable-parport-ppdev, since the
 299 the later option is an option to the parport driver.
 300
 301 The same is true for the --enable-parport-giveio option, you have to
 302 use both the --enable-parport AND the --enable-parport-giveio option
 303 if you want to use giveio instead of ioperm parallel port access
 304 method.
 305
 306 Using FTDI's FTD2XX
 307 -------------------
 308
 309 The (closed source) FTDICHIP.COM solution is faster than libftdi on
 310 Windows. That is the motivation for supporting it even though its
 311 licensing restricts it to non-redistributable OpenOCD binaries, and it
 312 is not available for all operating systems used with OpenOCD. You may,
 313 however, build such copies for personal use.
 314
 315 The FTDICHIP drivers come as either a (win32) ZIP file, or a (Linux)
 316 TAR.GZ file. You must unpack them ``some where'' convenient. As of this
 317 writing FTDICHIP does not supply means to install these files "in an
 318 appropriate place."
 319
 320 You should use the following ./configure options to make use of
 321 FTD2XX:
 322
 323   --with-ftd2xx-win32-zipdir
 324                           Where (CYGWIN/MINGW) the zip file from ftdichip.com
 325                           was unpacked <default=search>
 326   --with-ftd2xx-linux-tardir
 327                           Where (Linux/Unix) the tar file from ftdichip.com
 328                           was unpacked <default=search>
 329   --with-ftd2xx-lib=(static|shared)
 330                           Use static or shared ftd2xx libs (default is static)
 331
 332 Remember, this library is binary-only, while OpenOCD is licenced
 333 according to GNU GPLv2 without any exceptions. That means that
 334 _distributing_ copies of OpenOCD built with the FTDI code would
 335 violate the OpenOCD licensing terms.
 336
 337 Note that on Linux there is no good reason to use these FTDI binaries;
 338 they are no faster (on Linux) than libftdi, and cause licensing issues.
 339
 340
 341 ==========================
 342 Obtaining OpenOCD From GIT
 343 ==========================
 344
 345 You can download the current GIT version with a GIT client of your
 346 choice from the main repository:
 347
 348    git://git.code.sf.net/p/openocd/code
 349
 350 You may prefer to use a mirror:
 351
 352    http://repo.or.cz/r/openocd.git
 353    git://repo.or.cz/openocd.git
 354
 355 Using the GIT command line client, you might use the following command
 356 to set up a local copy of the current repository (make sure there is no
 357 directory called "openocd" in the current directory):
 358
 359    git clone git://git.code.sf.net/p/openocd/code openocd
 360
 361 Then you can update that at your convenience using
 362
 363    git pull
 364
 365 There is also a gitweb interface, which you can use either to browse
 366 the repository or to download arbitrary snapshots using HTTP:
 367
 368    http://repo.or.cz/w/openocd.git
 369
 370 Snapshots are compressed tarballs of the source tree, about 1.3 MBytes
 371 each at this writing.