Provide some useful information in README file, rather than punting.
[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, 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.berlios.de/doc/html/index.html
27
28  OpenOCD Developer's Manual:
29     http://openocd.berlios.de/doc/doxygen/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-development@lists.berlios.de
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   make doxygen
55
56   # If HTMLVIEWER is set, this views the HTML Doxygen output.
57   ${HTMLVIEWER} doxyegen/index.html
58
59 The remaining sections describe how to configure the system such that
60 you can build the in-tree documentation.
61
62 ==================
63 Installing OpenOCD
64 ==================
65
66 A Note to OpenOCD Users
67 -----------------------
68
69 If you would rather be working "with" OpenOCD rather than "on" it, your
70 operating system or interface supplier may provide binaries for you in a
71 convenient package.
72
73 Such packages should be more stable than SVN trunk, where bleeding-edge
74 development takes place.  These "Packagers" produce binary releases of
75 OpenOCD after the developers produces new "stable" versions of the
76 source code.  Previous versions of OpenOCD cannot be used to diagnosed
77 problems with the current release, so users are encouraged to keep in
78 contact with their distribution package maintainers or interface vendors
79 to ensure suitable upgrades appear regularly.
80
81 Users of these binary versions of OpenOCD must contact their Packager to
82 ask for support or newer versions of the binaries; the OpenOCD
83 developers do not support packages directly.
84
85 A Note to OpenOCD Packagers
86 ---------------------------
87
88 You are a PACKAGER of OpenOCD if you:
89
90 - Sell dongles: and include pre-built binaries
91 - Supply tools: A complete development solution
92 - Supply IDEs: like Eclipse, or RHIDE, etc.
93 - Build packages: RPM files, or DEB files for a Linux Distro
94
95 As a PACKAGER, you will experience first reports of most issues.
96 When you fix those problems for your users, your solution may help
97 prevent hundreds (if not thousands) of other questions from other users.
98
99 If something does not work for you, please work to inform the OpenOCD
100 developers know how to improve the system or documentation to avoid
101 future problems, and follow-up to help us ensure the issue will be fully
102 resolved in our future releases.
103
104 That said, the OpenOCD developers would also like you to follow a few
105 suggestions:
106
107 - Send patches, including config files, upstream.
108 - Always build with printer ports enabled.
109 - Use libftdi + libusb for FT2232 support.
110
111 Remember, the FTD2XX library cannot be used in binary distributions, due
112 to restrictions of the GPL v2.
113
114 ================
115 Building OpenOCD
116 ================
117
118 The INSTALL file contains generic instructions for running 'configure'
119 and compiling the OpenOCD source code.  That file is provided by default
120 for all GNU automake packages, and 
121
122 if you are not familiar with the GNU autotools, then you should read
123 those instructions first.  
124 Still, the
125 remainder of this document tries to provide complete instructions for
126 those looking for a quick-install
127
128 OpenOCD Dependencies
129 --------------------
130
131 You will need to install the appropriate driver files, if you want to
132 build support for a USB or FTDI-based interface:
133
134 - ft2232, jlink, rlink, vsllink, usbprog, arm-jtag-ew:
135   - libusb: required for portable communication with USB dongles
136 - ft2232 also requires:
137   - libftdi: http://www.intra2net.com/opensource/ftdi/  *OR*
138   - ftd2xx: http://www.ftdichip.com/Drivers/D2XX.htm,
139     or the Amontec version (from @uref{http://www.amontec.com}), for
140     easier support of JTAGkey's vendor and product IDs.
141
142 Compiling OpenOCD
143 -----------------
144
145 To build OpenOCD (on both Linux and Cygwin), use the following sequence
146 of commands:
147
148    ./configure [with some options listed in the next section]
149    make 
150    make install
151
152 The 'configure' step generates the Makefiles required to build OpenOCD,
153 usually with one or more options provided to it.  The first 'make' step
154 will build OpenOCD and place the final executable in ./src/.  The
155 final (optional) step, ``make install'', places all of the files in the
156 required location.
157
158 Configuration Options
159 ---------------------
160
161 The configure script takes numerous options, specifying which JTAG
162 interfaces should be included (among other things).  The following list
163 of options was extracted from the output of './configure --help'.  Other
164 options may be available there:
165
166   --enable-maintainer-mode  enable make rules and dependencies not useful
167                           (and sometimes confusing) to the casual installer
168                           NOTE: This option is *required* for SVN builds!
169                           It should *not* be used to build a release.
170
171   --enable-dummy          Enable building the dummy JTAG port driver
172
173   --enable-ft2232_libftdi Enable building support for FT2232 based devices
174                           using the libftdi driver, opensource alternate of
175                           FTD2XX
176   --enable-ft2232_ftd2xx  Enable building support for FT2232 based devices
177                           using the FTD2XX driver from ftdichip.com
178   --enable-ftd2xx-highspeed
179                           Enable building support for FT2232H and
180                           FT4232H-based devices (requires >=libftd2xx-0.4.16)
181
182   --enable-gw16012        Enable building support for the Gateworks GW16012
183                           JTAG Programmer
184
185   --enable-parport        Enable building the pc parallel port driver
186   --disable-parport-ppdev Disable use of ppdev (/dev/parportN) for parport
187                           (for x86 only)
188   --enable-parport-giveio Enable use of giveio for parport (for CygWin only)
189
190   --enable-presto_libftdi Enable building support for ASIX Presto Programmer
191                           using the libftdi driver
192   --enable-presto_ftd2xx  Enable building support for ASIX Presto Programmer
193                           using the FTD2XX driver
194
195   --enable-amtjtagaccel   Enable building the Amontec JTAG-Accelerator driver
196   --enable-arm-jtag-ew    Enable building support for the Olimex ARM-JTAG-EW
197                           Programmer
198   --enable-jlink          Enable building support for the Segger J-Link JTAG
199                           Programmer
200   --enable-rlink          Enable building support for the Raisonance RLink
201                           JTAG Programmer
202   --enable-usbprog        Enable building support for the usbprog JTAG
203                           Programmer
204   --enable-vsllink        Enable building support for the Versaloon-Link JTAG
205                           Programmer
206
207   --enable-oocd_trace     Enable building support for the OpenOCD+trace ETM
208                           capture device
209
210   --enable-ep93xx         Enable building support for EP93xx based SBCs
211   --enable-at91rm9200     Enable building support for AT91RM9200 based SBCs
212
213   --enable-ecosboard      Enable building support for eCos based JTAG debugger
214   --enable-zy1000         Enable ZY1000 interface
215
216   --enable-minidriver-dummy
217                           Enable the dummy minidriver.
218
219   --enable-ioutil         Enable ioutil functions - useful for standalone
220                           OpenOCD implementations
221   --enable-httpd          Enable builtin httpd server - useful for standalone
222                           OpenOCD implementations
223
224 Miscellaneous Configure Options
225 -------------------------------
226
227 The following additional options may also be useful:
228
229   --disable-assert        turn off assertions
230
231   --enable-verbose        Enable verbose JTAG I/O messages (for debugging).
232   --enable-verbose-jtag-io
233                           Enable verbose JTAG I/O messages (for debugging).
234   --enable-verbose-usb-io Enable verbose USB I/O messages (for debugging)
235   --enable-verbose-usb-comms
236                           Enable verbose USB communication messages (for
237                           debugging)
238   --enable-malloc-logging Include free space in logging messages (requires
239                           malloc.h).
240
241   --disable-gccwarnings   Disable extra gcc warnings during build.
242   --disable-wextra        Disable extra compiler warnings
243   --disable-werror        Do not treat warnings as errors
244
245   --enable-release        Enable building of an OpenOCD release.  This
246                           option is intended for project maintainers.
247                           It simply omits the svn version string when
248                           the openocd -v is executed (to KISS).
249
250   --disable-option-checking
251                           Ignore unrecognized --enable and --with options.
252   --disable-dependency-tracking  speeds up one-time build
253   --enable-shared[=PKGS]  build shared libraries [default=no]
254   --enable-static[=PKGS]  build static libraries [default=yes]
255
256 Parallel Port Dongles
257 ---------------------
258
259 If you want to access the parallel port using the PPDEV interface you
260 have to specify both --enable-parport AND --enable-parport-ppdev, since the
261 the later option is an option to the parport driver (see
262 http://forum.sparkfun.com/viewtopic.php?t=3795 for more info).
263
264 The same is true for the --enable-parport-giveio option, you
265 have to use both the --enable-parport AND the --enable-parport-giveio
266 option if you want to use giveio instead of ioperm parallel port access
267 method.
268
269 FT2232C Based USB Dongles 
270 -------------------------
271
272 There are 2 methods of using the FTD2232, either (1) using the
273 FTDICHIP.COM closed source driver, or (2) the open (and free) driver
274 libftdi. 
275
276 Using LIBFTDI
277 -------------
278
279 For both Linux and Windows, both libusb and libftdi must be built and
280 installed.  To use the newer FT2232H chips, supporting RTCK and USB high
281 speed (480 Mbps), you need libftdi version 0.16 or newer.  Many Linux
282 distributions provide suitable packages for these libraries.
283
284 For Windows, libftdi is supported with versions 0.14 and later.  
285
286 With these prerequisites met, configure the libftdi solution like this:
287
288   ./configure --prefix=/path/for/your/install --enable-ft2232_libftdi
289
290 Then type ``make'', and perhaps ``make install''.
291
292 Using FTDI's FTD2XX
293 -------------------
294
295 Some claim the (closed) FTDICHIP.COM solution is faster, which
296 is the motivation for supporting it even though its licensing restricts
297 it to non-redistributable OpenOCD binaries, and it is not available for
298 all operating systems used with OpenOCD.  You may, however, build such
299 copies for personal use.
300
301 The FTDICHIP drivers come as either a (win32) ZIP file, or a (Linux)
302 TAR.GZ file. You must unpack them ``some where'' convient. As of this
303 writing FTDICHIP does not supply means to install these files "in an
304 appropriate place."  
305
306 If your distribution does not package these, there are several
307 './configure' options to solve this problem:
308
309   --with-ftd2xx-win32-zipdir
310                           Where (CYGWIN/MINGW) the zip file from ftdichip.com
311                           was unpacked <default=search>
312   --with-ftd2xx-linux-tardir
313                           Where (Linux/Unix) the tar file from ftdichip.com
314                           was unpacked <default=search>
315   --with-ftd2xx-lib       Use static or shared ftd2xx libs on default static
316
317 If you are using the FTDICHIP.COM driver, download and unpack the
318 Windows or Linux FTD2xx drivers from the following location:
319
320         http://www.ftdichip.com/Drivers/D2XX.htm
321
322 Remember, this library is binary-only, while OpenOCD is licenced
323 according to GNU GPLv2 without any exceptions.  That means that
324 _distributing_ copies of OpenOCD built with the FTDI code would violate
325 the OpenOCD licensing terms.  
326
327
328 Cygwin/Win32 Notes
329 ******************
330
331 The Cygwin/Win32 ZIP file contains a directory named ftd2xx.win32.
332 Assuming that you have extracted this archive in the same directory as
333 the OpenOCD package, you could configure with options like the following:
334
335    ./configure \
336         --enable-ft2232_ftd2xx \
337         --with-ftd2xx-win32-zipdir=../ftd2xx.win32 \
338         ... other options ...
339
340 Linux Notes
341 ***********
342
343 The Linux tar.gz archive contains a directory named libftd2xx0.4.16
344 (or similar).  Assuming that you have extracted this archive in the same
345 directory as the OpenOCD package, you could configure with options like
346 the following:
347
348    ./configure \
349         --enable-ft2232_ftd2xx \
350         --with-ft2xx-linux-tardir=../libftd2xx0.4.16 \
351         ... other options ...
352
353 =================================
354 Obtaining OpenOCD From Subversion
355 ---------------------------------
356
357 You can download the current SVN version with an SVN client of your
358 choice from the following repositories:
359
360    svn://svn.berlios.de/openocd/trunk
361 or
362    http://svn.berlios.de/svnroot/repos/openocd/trunk
363
364 Using the SVN command line client, you can use the following command to
365 fetch the latest version (make sure there is no (non-svn) directory
366 called "openocd" in the current directory):
367
368    svn checkout svn://svn.berlios.de/openocd/trunk openocd
369
370 If you prefer GIT based tools, the @command{git-svn} package works too:
371
372    git svn clone -s svn://svn.berlios.de/openocd
373
374 Tips For Building From The Subversion Repository
375 ************************************************
376
377 Building OpenOCD from a repository requires a recent version of the GNU
378 autotools (autoconf >= 2.59 and automake >= 1.9).  For building on
379 Windows, you have to use Cygwin. Make sure that your @env{PATH}
380 environment variable contains no other locations with Unix utils (like
381 UnxUtils) - these can't handle the Cygwin paths, resulting in obscure
382 dependency errors.  This was an observation gathered from the logs of
383 one user; please correct us if this is wrong.
384
385 1) Run './bootstrap' to create the 'configure' script and prepare
386    the build process for your host system.
387
388 2) Run './configure --enable-maintainer-mode' with other options.
389
390