README 11 KB
Newer Older
1
2
3
4
Welcome to OpenOCD!
===================

OpenOCD provides on-chip programming and debugging support with a
Paul Fertser's avatar
Paul Fertser committed
5
6
layered architecture of JTAG interface and TAP support including:

Paul Fertser's avatar
Paul Fertser committed
7
- (X)SVF playback to facilitate automated boundary scan and FPGA/CPLD
Paul Fertser's avatar
Paul Fertser committed
8
9
  programming;
- debug target support (e.g. ARM, MIPS): single-stepping,
10
  breakpoints/watchpoints, gprof profiling, etc;
Paul Fertser's avatar
Paul Fertser committed
11
- flash chip drivers (e.g. CFI, NAND, internal flash);
12
- embedded TCL interpreter for easy scripting.
Paul Fertser's avatar
Paul Fertser committed
13
14
15
16
17
18

Several network interfaces are available for interacting with OpenOCD:
telnet, TCL, and GDB. The GDB server enables OpenOCD to function as a
"remote target" for source-level debugging of embedded systems using
the GNU GDB program (and the others who talk GDB protocol, e.g. IDA
Pro).
19
20

This README file contains an overview of the following topics:
Paul Fertser's avatar
Paul Fertser committed
21
22

- quickstart instructions,
23
- how to find and build more OpenOCD documentation,
Paul Fertser's avatar
Paul Fertser committed
24
25
- list of the supported hardware,
- the installation and build process,
26
- packaging tips.
Paul Fertser's avatar
Paul Fertser committed
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41


============================
Quickstart for the impatient
============================

If you have a popular board then just start OpenOCD with its config,
e.g.:

  openocd -f board/stm32f4discovery.cfg

If you are connecting a particular adapter with some specific target,
you need to source both the jtag interface and the target configs,
e.g.:

42
43
44
45
46
  openocd -f interface/ftdi/jtagkey2.cfg -c "transport select jtag" \
          -f target/ti_calypso.cfg

  openocd -f interface/stlink-v2-1.cfg -c "transport select hla_swd" \
          -f target/stm32l0.cfg
Paul Fertser's avatar
Paul Fertser committed
47
48
49
50
51

After OpenOCD startup, connect GDB with

  (gdb) target extended-remote localhost:3333

52
53
54
55
56

=====================
OpenOCD Documentation
=====================

Paul Fertser's avatar
Paul Fertser committed
57
58
In addition to the in-tree documentation, the latest manuals may be
viewed online at the following URLs:
59

Paul Fertser's avatar
Paul Fertser committed
60
  OpenOCD User's Guide:
61
    http://openocd.org/doc/html/index.html
62

Paul Fertser's avatar
Paul Fertser committed
63
  OpenOCD Developer's Manual:
64
    http://openocd.org/doc/doxygen/html/index.html
65
66
67
68
69
70
71

These reflect the latest development versions, so the following section
introduces how to build the complete documentation from the package.

For more information, refer to these documents or contact the developers
by subscribing to the OpenOCD developer mailing list:

72
	openocd-devel@lists.sourceforge.net
73
74
75
76

Building the OpenOCD Documentation
----------------------------------

Paul Fertser's avatar
Paul Fertser committed
77
78
79
80
81
82
By default the OpenOCD build process prepares documentation in the
"Info format" and installs it the standard way, so that "info openocd"
can access it.

Additionally, the OpenOCD User's Guide can be produced in the
following different formats:
83
84
85
86
87
88
89
90
91
92

  # If PDFVIEWER is set, this creates and views the PDF User Guide.
  make pdf && ${PDFVIEWER} doc/openocd.pdf

  # If HTMLVIEWER is set, this creates and views the HTML User Guide.
  make html && ${HTMLVIEWER} doc/openocd.html/index.html

The OpenOCD Developer Manual contains information about the internal
architecture and other details about the code:

93
  # NB! make sure doxygen is installed, type doxygen --version
Paul Fertser's avatar
Paul Fertser committed
94
95
96
97
98
99
100
101
102
  make doxygen && ${HTMLVIEWER} doxygen/index.html


==================
Supported hardware
==================

JTAG adapters
-------------
103

Paul Fertser's avatar
Paul Fertser committed
104
AICE, ARM-JTAG-EW, ARM-USB-OCD, ARM-USB-TINY, AT91RM9200, axm0432,
105
BCM2835, Bus Blaster, Buspirate, Chameleon, CMSIS-DAP, Cortino, DENX,
106
107
108
109
110
111
Digilent JTAG-SMT2, DLC 5, DLP-USB1232H, embedded projects, eStick,
FlashLINK, FlossJTAG, Flyswatter, Flyswatter2, Gateworks, Hoegl, ICDI,
ICEBear, J-Link, JTAG VPI, JTAGkey, JTAGkey2, JTAG-lock-pick, KT-Link,
Lisa/L, LPC1768-Stick, MiniModule, NGX, NXHX, OOCDLink, Opendous,
OpenJTAG, Openmoko, OpenRD, OSBDM, Presto, Redbee, RLink, SheevaPlug
devkit, Stellaris evkits, ST-LINK (SWO tracing supported),
Paul Fertser's avatar
Paul Fertser committed
112
113
114
115
116
117
118
STM32-PerformanceStick, STR9-comStick, sysfsgpio, TUMPA, Turtelizer,
ULINK, USB-A9260, USB-Blaster, USB-JTAG, USBprog, VPACLink, VSLLink,
Wiggler, XDS100v2, Xverve.

Debug targets
-------------

119
ARM11, ARM7, ARM9, AVR32, Cortex-A, Cortex-R, Cortex-M, LS102x-SAP,
Paul Fertser's avatar
Paul Fertser committed
120
Feroceon/Dragonite, DSP563xx, DSP5680xx, FA526, MIPS EJTAG, NDS32,
121
XScale, Intel Quark.
Paul Fertser's avatar
Paul Fertser committed
122
123
124
125

Flash drivers
-------------

126
ADUC702x, AT91SAM, ATH79, 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
135
136
137
138
139
140


==================
Installing OpenOCD
==================

A Note to OpenOCD Users
-----------------------

If you would rather be working "with" OpenOCD rather than "on" it, your
141
142
operating system or JTAG interface supplier may provide binaries for
you in a convenient-enough package.
143

Paul Fertser's avatar
Paul Fertser committed
144
145
146
147
148
149
150
151
Such packages may be more stable than git mainline, where
bleeding-edge development takes place. These "Packagers" produce
binary releases of OpenOCD after the developers produces new "release"
versions of the source code. Previous versions of OpenOCD cannot be
used to diagnose problems with the current release, so users are
encouraged to keep in contact with their distribution package
maintainers or interface vendors to ensure suitable upgrades appear
regularly.
152
153
154
155
156
157
158
159
160
161

Users of these binary versions of OpenOCD must contact their Packager to
ask for support or newer versions of the binaries; the OpenOCD
developers do not support packages directly.

A Note to OpenOCD Packagers
---------------------------

You are a PACKAGER of OpenOCD if you:

Paul Fertser's avatar
Paul Fertser committed
162
163
164
- Sell dongles and include pre-built binaries;
- Supply tools or IDEs (a development solution integrating OpenOCD);
- Build packages (e.g. RPM or DEB files for a GNU/Linux distribution).
165
166
167
168
169
170
171
172
173
174
175
176
177

As a PACKAGER, you will experience first reports of most issues.
When you fix those problems for your users, your solution may help
prevent hundreds (if not thousands) of other questions from other users.

If something does not work for you, please work to inform the OpenOCD
developers know how to improve the system or documentation to avoid
future problems, and follow-up to help us ensure the issue will be fully
resolved in our future releases.

That said, the OpenOCD developers would also like you to follow a few
suggestions:

Paul Fertser's avatar
Paul Fertser committed
178
179
180
181
182
183
- Send patches, including config files, upstream, participate in the
  discussions;
- Enable all the options OpenOCD supports, even those unrelated to your
  particular hardware;
- Use "ftdi" interface adapter driver for the FTDI-based devices.

184
185
186
187
188
189

================
Building OpenOCD
================

The INSTALL file contains generic instructions for running 'configure'
Paul Fertser's avatar
Paul Fertser committed
190
191
192
and compiling the OpenOCD source code. That file is provided by
default for all GNU autotools packages. If you are not familiar with
the GNU autotools, then you should read those instructions first.
193

zwelch's avatar
zwelch committed
194
195
The remainder of this document tries to provide some instructions for
those looking for a quick-install.
196
197
198
199

OpenOCD Dependencies
--------------------

Paul Fertser's avatar
Paul Fertser committed
200
201
202
203
204
205
206
GCC or Clang is currently required to build OpenOCD. The developers
have begun to enforce strict code warnings (-Wall, -Werror, -Wextra,
and more) and use C99-specific features: inline functions, named
initializers, mixing declarations with code, and other tricks. While
it may be possible to use other compilers, they must be somewhat
modern and could require extending support to conditionally remove
GCC-specific extensions.
207

Paul Fertser's avatar
Paul Fertser committed
208
You'll also need:
209

Paul Fertser's avatar
Paul Fertser committed
210
211
- make
- libtool
212
- pkg-config >= 0.23 (or compatible)
213

Paul Fertser's avatar
Paul Fertser committed
214
Additionally, for building from git:
215

Paul Fertser's avatar
Paul Fertser committed
216
- autoconf >= 2.64
217
- automake >= 1.14
Paul Fertser's avatar
Paul Fertser committed
218
- texinfo
219

Paul Fertser's avatar
Paul Fertser committed
220
USB-based adapters depend on libusb-1.0 and some older drivers require
221
222
libusb-0.1 or libusb-compat-0.1. A compatible implementation, such as
FreeBSD's, additionally needs the corresponding .pc files.
223

224
USB-Blaster, ASIX Presto and OpenJTAG interface adapter
225
drivers need:
Paul Fertser's avatar
Paul Fertser committed
226
  - libftdi: http://www.intra2net.com/en/developer/libftdi/index.php
227

228
229
CMSIS-DAP support needs HIDAPI library.

Paul Fertser's avatar
Paul Fertser committed
230
231
Permissions delegation
----------------------
232

Paul Fertser's avatar
Paul Fertser committed
233
234
Running OpenOCD with root/administrative permissions is strongly
discouraged for security reasons.
235

236
For USB devices on GNU/Linux you should use the contrib/60-openocd.rules
237
file. It probably belongs somewhere in /etc/udev/rules.d, but
Paul Fertser's avatar
Paul Fertser committed
238
239
consult your operating system documentation to be sure. Do not forget
to add yourself to the "plugdev" group.
240

Paul Fertser's avatar
Paul Fertser committed
241
242
For parallel port adapters on GNU/Linux and FreeBSD please change your
"ppdev" (parport* or ppi*) device node permissions accordingly.
243

Paul Fertser's avatar
Paul Fertser committed
244
245
246
For parport adapters on Windows you need to run install_giveio.bat
(it's also possible to use "ioperm" with Cygwin instead) to give
ordinary users permissions for accessing the "LPT" registers directly.
247

Paul Fertser's avatar
Paul Fertser committed
248
249
Compiling OpenOCD
-----------------
250

Paul Fertser's avatar
Paul Fertser committed
251
To build OpenOCD, use the following sequence of commands:
252

Paul Fertser's avatar
Paul Fertser committed
253
254
255
256
  ./bootstrap (when building from the git repository)
  ./configure [options]
  make
  sudo make install
257

Paul Fertser's avatar
Paul Fertser committed
258
259
260
261
262
The 'configure' step generates the Makefiles required to build
OpenOCD, usually with one or more options provided to it. The first
'make' step will build OpenOCD and place the final executable in
'./src/'. The final (optional) step, ``make install'', places all of
the files in the required location.
263

Paul Fertser's avatar
Paul Fertser committed
264
265
To see the list of all the supported options, run
  ./configure --help
266

Paul Fertser's avatar
Paul Fertser committed
267
268
Cross-compiling Options
-----------------------
269

Paul Fertser's avatar
Paul Fertser committed
270
271
272
Cross-compiling is supported the standard autotools way, you just need
to specify the cross-compiling target triplet in the --host option,
e.g. for cross-building for Windows 32-bit with MinGW on Debian:
273

Paul Fertser's avatar
Paul Fertser committed
274
  ./configure --host=i686-w64-mingw32 [options]
275

276
277
278
279
280
281
282
283
284
285
To make pkg-config work nicely for cross-compiling, you might need an
additional wrapper script as described at

  http://www.flameeyes.eu/autotools-mythbuster/pkgconfig/cross-compiling.html

This is needed to tell pkg-config where to look for the target
libraries that OpenOCD depends on. Alternatively, you can specify
*_CFLAGS and *_LIBS environment variables directly, see "./configure
--help" for the details.

286
287
288
289
290
Parallel Port Dongles
---------------------

If you want to access the parallel port using the PPDEV interface you
have to specify both --enable-parport AND --enable-parport-ppdev, since the
Paul Fertser's avatar
Paul Fertser committed
291
the later option is an option to the parport driver.
292

Paul Fertser's avatar
Paul Fertser committed
293
294
295
The same is true for the --enable-parport-giveio option, you have to
use both the --enable-parport AND the --enable-parport-giveio option
if you want to use giveio instead of ioperm parallel port access
296
297
method.

Paul Fertser's avatar
Paul Fertser committed
298

299
300
301
==========================
Obtaining OpenOCD From GIT
==========================
302

303
304
You can download the current GIT version with a GIT client of your
choice from the main repository:
305

Spencer Oliver's avatar
Spencer Oliver committed
306
   git://git.code.sf.net/p/openocd/code
307

David Brownell's avatar
David Brownell committed
308
309
310
311
312
You may prefer to use a mirror:

   http://repo.or.cz/r/openocd.git
   git://repo.or.cz/openocd.git

313
314
315
Using the GIT command line client, you might use the following command
to set up a local copy of the current repository (make sure there is no
directory called "openocd" in the current directory):
316

317
   git clone git://git.code.sf.net/p/openocd/code openocd
318

319
Then you can update that at your convenience using
320

321
   git pull
322

323
There is also a gitweb interface, which you can use either to browse
Uwe Hermann's avatar
Uwe Hermann committed
324
the repository or to download arbitrary snapshots using HTTP:
325

David Brownell's avatar
David Brownell committed
326
   http://repo.or.cz/w/openocd.git
327
328
329

Snapshots are compressed tarballs of the source tree, about 1.3 MBytes
each at this writing.