README 16.2 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
Welcome to OpenOCD!
===================

OpenOCD provides on-chip programming and debugging support with a
layered architecture of JTAG interface and TAP support, debug target
support (e.g. ARM, MIPS), and flash chip drivers (e.g. CFI, NAND, etc.).
Several network interfaces are available for interactiving with OpenOCD:
HTTP, 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.

This README file contains an overview of the following topics:
- how to find and build more OpenOCD documentation,
- the build process
- packaging tips.
- configuration options

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

In addition to in-tree documentation, the latest documentation may be
viewed on-line at the following URLs:

 OpenOCD User's Guide:
    http://openocd.berlios.de/doc/html/index.html

 OpenOCD Developer's Manual:
    http://openocd.berlios.de/doc/doxygen/index.html

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:

	openocd-development@lists.berlios.de

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

The OpenOCD User's Guide can be produced in two different format:

  # 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:

54
  # NB! make sure doxygen is installed, type doxygen --version
55
56
57
  make doxygen

  # If HTMLVIEWER is set, this views the HTML Doxygen output.
58
  ${HTMLVIEWER} doxygen/index.html
59
60
61
62
63
64
65
66

The remaining sections describe how to configure the system such that
you can build the in-tree documentation.

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

67
68
On Linux, you may have permissions problems to address.  The best way
to do this is to use the contrib/openocd.udev rules file.  It probably
69
70
71
72
belongs somewhere in /etc/udev/rules.d, but consult your operating
system documentation to be sure.  In particular, make sure that it
matches the syntax used by your operating system's version of udev.

73
74
75
76
A Note to OpenOCD Users
-----------------------

If you would rather be working "with" OpenOCD rather than "on" it, your
77
78
operating system or JTAG interface supplier may provide binaries for
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
83
OpenOCD after the developers produces new "release" versions of the
source code.  Previous versions of OpenOCD cannot be used to diagnose
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
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.

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:

- Sell dongles: and include pre-built binaries
- Supply tools: A complete development solution
- Supply IDEs: like Eclipse, or RHIDE, etc.
- Build packages: RPM files, or DEB files for a Linux Distro

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:

- Send patches, including config files, upstream.
- Always build with printer ports enabled.
- Use libftdi + libusb for FT2232 support.

Remember, the FTD2XX library cannot be used in binary distributions, due
to restrictions of the GPL v2.

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

The INSTALL file contains generic instructions for running 'configure'
and compiling the OpenOCD source code.  That file is provided by default
zwelch's avatar
zwelch committed
127
for all GNU automake packages.  If you are not familiar with the GNU
128
autotools, then you should read those instructions first.
129

zwelch's avatar
zwelch committed
130
131
The remainder of this document tries to provide some instructions for
those looking for a quick-install.
132
133
134
135

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

136
137
138
139
140
141
142
143
Presently, GCC is 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.

Also, you need to install the appropriate driver files, if you want to
144
145
146
147
148
149
150
build support for a USB or FTDI-based interface:

- ft2232, jlink, rlink, vsllink, usbprog, arm-jtag-ew:
  - libusb: required for portable communication with USB dongles
- ft2232 also requires:
  - libftdi: http://www.intra2net.com/opensource/ftdi/  *OR*
  - ftd2xx: http://www.ftdichip.com/Drivers/D2XX.htm,
zwelch's avatar
zwelch committed
151
    or the Amontec version (from http://www.amontec.com), for
152
153
    easier support of JTAGkey's vendor and product IDs.

154
Many Linux distributions provide these packages through their automated
zwelch's avatar
zwelch committed
155
156
157
installation and update mechanisms; however, some Linux versions include
older versions of libftdi.  In particular, using Ubuntu 8.04 has been
problematic, but newer versions of Ubuntu do not have this problem.
158

159
160
161
162
163
164
165
Compiling OpenOCD
-----------------

To build OpenOCD (on both Linux and Cygwin), use the following sequence
of commands:

   ./configure [with some options listed in the next section]
166
   make
167
168
169
170
171
172
173
174
   make install

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.

175
176
177
178
179
180
181
182
Cross-Compiling Options
-----------------------

To cross-compile, you must specify both --build and --host options to
the 'configure' script.  For example, you can configure OpenOCD to
cross-compile on a x86 Linux host to run on Windows (MinGW32), you could
use the following configuration options:

183
  ./configure --build=i686-pc-linux-gnu --host=i586-mingw32msvc ...
184
185
186
187
188
189
190
191
192
193
194
195
196
197

Likewise, the following options allow OpenOCD to be cross-compiled for
an ARM target on the same x86 host:

  ./configure --build=i686-pc-linux-gnu --host=arm-elf ...

Both must be specified to work around bugs in autoconf.

Scripts for producing ARM cross-compilers can be found on the web with a
little searching.  A script to produce an x86 Linux-hosted MinGW32
cross-compiler can be downloaded from the following URL:

  http://www.mingw.org/wiki/LinuxCrossMinGW

198
199
200
201
202
203
204
205
206
207
Configuration Options
---------------------

The configure script takes numerous options, specifying which JTAG
interfaces should be included (among other things).  The following list
of options was extracted from the output of './configure --help'.  Other
options may be available there:

  --enable-maintainer-mode  enable make rules and dependencies not useful
                          (and sometimes confusing) to the casual installer
208
			  NOTE: This option is *required* for GIT builds!
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
			  It should *not* be used to build a release.

  --enable-dummy          Enable building the dummy JTAG port driver

  --enable-ft2232_libftdi Enable building support for FT2232 based devices
                          using the libftdi driver, opensource alternate of
                          FTD2XX
  --enable-ft2232_ftd2xx  Enable building support for FT2232 based devices
                          using the FTD2XX driver from ftdichip.com

  --enable-gw16012        Enable building support for the Gateworks GW16012
                          JTAG Programmer

  --enable-parport        Enable building the pc parallel port driver
  --disable-parport-ppdev Disable use of ppdev (/dev/parportN) for parport
                          (for x86 only)
  --enable-parport-giveio Enable use of giveio for parport (for CygWin only)

  --enable-presto_libftdi Enable building support for ASIX Presto Programmer
                          using the libftdi driver
  --enable-presto_ftd2xx  Enable building support for ASIX Presto Programmer
                          using the FTD2XX driver

  --enable-amtjtagaccel   Enable building the Amontec JTAG-Accelerator driver
  --enable-arm-jtag-ew    Enable building support for the Olimex ARM-JTAG-EW
                          Programmer
  --enable-jlink          Enable building support for the Segger J-Link JTAG
                          Programmer
  --enable-rlink          Enable building support for the Raisonance RLink
                          JTAG Programmer
  --enable-usbprog        Enable building support for the usbprog JTAG
                          Programmer
  --enable-vsllink        Enable building support for the Versaloon-Link JTAG
                          Programmer

  --enable-oocd_trace     Enable building support for the OpenOCD+trace ETM
                          capture device

  --enable-ep93xx         Enable building support for EP93xx based SBCs
  --enable-at91rm9200     Enable building support for AT91RM9200 based SBCs

  --enable-ecosboard      Enable building support for eCos based JTAG debugger
  --enable-zy1000         Enable ZY1000 interface

  --enable-minidriver-dummy
                          Enable the dummy minidriver.

  --enable-ioutil         Enable ioutil functions - useful for standalone
                          OpenOCD implementations
  --enable-httpd          Enable builtin httpd server - useful for standalone
                          OpenOCD implementations

261
262
263
  --disable-doxygen-html Disable building Doxygen manual as HTML.
  --enable-doxygen-pdf   Enable building Doxygen manual as PDF.

264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
Miscellaneous Configure Options
-------------------------------

The following additional options may also be useful:

  --disable-assert        turn off assertions

  --enable-verbose        Enable verbose JTAG I/O messages (for debugging).
  --enable-verbose-jtag-io
                          Enable verbose JTAG I/O messages (for debugging).
  --enable-verbose-usb-io Enable verbose USB I/O messages (for debugging)
  --enable-verbose-usb-comms
                          Enable verbose USB communication messages (for
                          debugging)
  --enable-malloc-logging Include free space in logging messages (requires
                          malloc.h).

  --disable-gccwarnings   Disable extra gcc warnings during build.
  --disable-wextra        Disable extra compiler warnings
  --disable-werror        Do not treat warnings as errors

  --disable-option-checking
                          Ignore unrecognized --enable and --with options.
  --disable-dependency-tracking  speeds up one-time build
  --enable-shared[=PKGS]  build shared libraries [default=no]
  --enable-static[=PKGS]  build static libraries [default=yes]

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
the later option is an option to the parport driver (see
http://forum.sparkfun.com/viewtopic.php?t=3795 for more info).

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
method.

304
FT2232C Based USB Dongles
305
306
307
308
-------------------------

There are 2 methods of using the FTD2232, either (1) using the
FTDICHIP.COM closed source driver, or (2) the open (and free) driver
309
libftdi.
310
311
312
313

Using LIBFTDI
-------------

314
315
316
317
The libftdi source code can be download from the following website:

  http://www.intra2net.com/en/developer/libftdi/download.php

318
319
320
321
322
For both Linux and Windows, both libusb and libftdi must be built and
installed.  To use the newer FT2232H chips, supporting RTCK and USB high
speed (480 Mbps), you need libftdi version 0.16 or newer.  Many Linux
distributions provide suitable packages for these libraries.

323
For Windows, libftdi is supported with versions 0.14 and later.
324
325
326
327
328
329
330
331
332
333

With these prerequisites met, configure the libftdi solution like this:

  ./configure --prefix=/path/for/your/install --enable-ft2232_libftdi

Then type ``make'', and perhaps ``make install''.

Using FTDI's FTD2XX
-------------------

334
The (closed source) FTDICHIP.COM solution is faster on MS-Windows.  That
335
336
337
338
339
340
is the motivation for supporting it even though its licensing restricts
it to non-redistributable OpenOCD binaries, and it is not available for
all operating systems used with OpenOCD.  You may, however, build such
copies for personal use.

The FTDICHIP drivers come as either a (win32) ZIP file, or a (Linux)
Uwe Hermann's avatar
Uwe Hermann committed
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
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363

If your distribution does not package these, there are several
'./configure' options to solve this problem:

  --with-ftd2xx-win32-zipdir
                          Where (CYGWIN/MINGW) the zip file from ftdichip.com
                          was unpacked <default=search>
  --with-ftd2xx-linux-tardir
                          Where (Linux/Unix) the tar file from ftdichip.com
                          was unpacked <default=search>
  --with-ftd2xx-lib       Use static or shared ftd2xx libs on default static

If you are using the FTDICHIP.COM driver, download and unpack the
Windows or Linux FTD2xx drivers from the following location:

	http://www.ftdichip.com/Drivers/D2XX.htm

Remember, this library is binary-only, while OpenOCD is licenced
according to GNU GPLv2 without any exceptions.  That means that
_distributing_ copies of OpenOCD built with the FTDI code would violate
364
the OpenOCD licensing terms.
365
366
367
368
369
370
371
372
373
374
375
376
377
378

Linux Notes
***********

The Linux tar.gz archive contains a directory named libftd2xx0.4.16
(or similar).  Assuming that you have extracted this archive in the same
directory as the OpenOCD package, you could configure with options like
the following:

   ./configure \
        --enable-ft2232_ftd2xx \
        --with-ft2xx-linux-tardir=../libftd2xx0.4.16 \
	... other options ...

379
380
381
Note that on Linux there is no good reason to use these FTDI binaries;
they are no faster (on Linux) than libftdi, and cause licensing issues.

382
383
384
==========================
Obtaining OpenOCD From GIT
==========================
385

386
387
You can download the current GIT version with a GIT client of your
choice from the main repository:
388

389
   git://openocd.git.sourceforge.net/gitroot/openocd/openocd
390

David Brownell's avatar
David Brownell committed
391
392
393
394
395
You may prefer to use a mirror:

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

396
397
398
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):
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
Uwe Hermann's avatar
Uwe Hermann committed
407
the repository or to download arbitrary snapshots using HTTP:
408
409

   http://openocd.git.sourceforge.net/git/gitweb.cgi?p=openocd/openocd
David Brownell's avatar
David Brownell committed
410
   http://repo.or.cz/w/openocd.git
411
412
413
414
415
416
417

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


Tips For Building From a GIT Repository
---------------------------------------
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
423
424
425

1) Run './bootstrap' to create the 'configure' script and prepare
   the build process for your host system.

2) Run './configure --enable-maintainer-mode' with other options.