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