src/jtag/drivers/ftdi: fix swd pin comment and links
[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 facilitate 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.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, EnSilica eSi-RISC, FA526, MIPS
121 EJTAG, NDS32, XScale, Intel Quark.
122
123 Flash drivers
124 -------------
125
126 ADUC702x, AT91SAM, ATH79, AVR, CFI, DSP5680xx, EFM32, EM357, eSi-TSMC, FM3,
127 FM4, Freedom E SPI, Kinetis, LPC8xx/LPC1xxx/LPC2xxx/LPC541xx, LPC2900,
128 LPCSPIFI, Marvell QSPI, Milandr, NIIET, NuMicro, PIC32mx, PSoC4, PSoC5LP,
129 SiM3x, Stellaris, STM32, STMSMI, STR7x, STR9x, nRF51; NAND controllers of
130 AT91SAM9, LPC3180, LPC32xx, i.MX31, MXC, NUC910, Orion/Kirkwood, S3C24xx,
131 S3C6400, XMC1xxx, XMC4xxx.
132
133
134 ==================
135 Installing OpenOCD
136 ==================
137
138 A Note to OpenOCD Users
139 -----------------------
140
141 If you would rather be working "with" OpenOCD rather than "on" it, your
142 operating system or JTAG interface supplier may provide binaries for
143 you in a convenient-enough package.
144
145 Such packages may be more stable than git mainline, where
146 bleeding-edge development takes place. These "Packagers" produce
147 binary releases of OpenOCD after the developers produces new "release"
148 versions of the source code. Previous versions of OpenOCD cannot be
149 used to diagnose problems with the current release, so users are
150 encouraged to keep in contact with their distribution package
151 maintainers or interface vendors to ensure suitable upgrades appear
152 regularly.
153
154 Users of these binary versions of OpenOCD must contact their Packager to
155 ask for support or newer versions of the binaries; the OpenOCD
156 developers do not support packages directly.
157
158 A Note to OpenOCD Packagers
159 ---------------------------
160
161 You are a PACKAGER of OpenOCD if you:
162
163 - Sell dongles and include pre-built binaries;
164 - Supply tools or IDEs (a development solution integrating OpenOCD);
165 - Build packages (e.g. RPM or DEB files for a GNU/Linux distribution).
166
167 As a PACKAGER, you will experience first reports of most issues.
168 When you fix those problems for your users, your solution may help
169 prevent hundreds (if not thousands) of other questions from other users.
170
171 If something does not work for you, please work to inform the OpenOCD
172 developers know how to improve the system or documentation to avoid
173 future problems, and follow-up to help us ensure the issue will be fully
174 resolved in our future releases.
175
176 That said, the OpenOCD developers would also like you to follow a few
177 suggestions:
178
179 - Send patches, including config files, upstream, participate in the
180   discussions;
181 - Enable all the options OpenOCD supports, even those unrelated to your
182   particular hardware;
183 - Use "ftdi" interface adapter driver for the FTDI-based devices.
184
185
186 ================
187 Building OpenOCD
188 ================
189
190 The INSTALL file contains generic instructions for running 'configure'
191 and compiling the OpenOCD source code. That file is provided by
192 default for all GNU autotools packages. If you are not familiar with
193 the GNU autotools, then you should read those instructions first.
194
195 The remainder of this document tries to provide some instructions for
196 those looking for a quick-install.
197
198 OpenOCD Dependencies
199 --------------------
200
201 GCC or Clang is currently required to build OpenOCD. The developers
202 have begun to enforce strict code warnings (-Wall, -Werror, -Wextra,
203 and more) and use C99-specific features: inline functions, named
204 initializers, mixing declarations with code, and other tricks. While
205 it may be possible to use other compilers, they must be somewhat
206 modern and could require extending support to conditionally remove
207 GCC-specific extensions.
208
209 You'll also need:
210
211 - make
212 - libtool
213 - pkg-config >= 0.23 (or compatible)
214
215 Additionally, for building from git:
216
217 - autoconf >= 2.64
218 - automake >= 1.14
219 - texinfo
220
221 USB-based adapters depend on libusb-1.0 and some older drivers require
222 libusb-0.1 or libusb-compat-0.1. A compatible implementation, such as
223 FreeBSD's, additionally needs the corresponding .pc files.
224
225 USB-Blaster, ASIX Presto and OpenJTAG interface adapter
226 drivers need:
227   - libftdi: http://www.intra2net.com/en/developer/libftdi/index.php
228
229 CMSIS-DAP support needs HIDAPI library.
230
231 Permissions delegation
232 ----------------------
233
234 Running OpenOCD with root/administrative permissions is strongly
235 discouraged for security reasons.
236
237 For USB devices on GNU/Linux you should use the contrib/60-openocd.rules
238 file. It probably belongs somewhere in /etc/udev/rules.d, but
239 consult your operating system documentation to be sure. Do not forget
240 to add yourself to the "plugdev" group.
241
242 For parallel port adapters on GNU/Linux and FreeBSD please change your
243 "ppdev" (parport* or ppi*) device node permissions accordingly.
244
245 For parport adapters on Windows you need to run install_giveio.bat
246 (it's also possible to use "ioperm" with Cygwin instead) to give
247 ordinary users permissions for accessing the "LPT" registers directly.
248
249 Compiling OpenOCD
250 -----------------
251
252 To build OpenOCD, use the following sequence of commands:
253
254   ./bootstrap (when building from the git repository)
255   ./configure [options]
256   make
257   sudo make install
258
259 The 'configure' step generates the Makefiles required to build
260 OpenOCD, usually with one or more options provided to it. The first
261 'make' step will build OpenOCD and place the final executable in
262 './src/'. The final (optional) step, ``make install'', places all of
263 the files in the required location.
264
265 To see the list of all the supported options, run
266   ./configure --help
267
268 Cross-compiling Options
269 -----------------------
270
271 Cross-compiling is supported the standard autotools way, you just need
272 to specify the cross-compiling target triplet in the --host option,
273 e.g. for cross-building for Windows 32-bit with MinGW on Debian:
274
275   ./configure --host=i686-w64-mingw32 [options]
276
277 To make pkg-config work nicely for cross-compiling, you might need an
278 additional wrapper script as described at
279
280   http://www.flameeyes.eu/autotools-mythbuster/pkgconfig/cross-compiling.html
281
282 This is needed to tell pkg-config where to look for the target
283 libraries that OpenOCD depends on. Alternatively, you can specify
284 *_CFLAGS and *_LIBS environment variables directly, see "./configure
285 --help" for the details.
286
287 Parallel Port Dongles
288 ---------------------
289
290 If you want to access the parallel port using the PPDEV interface you
291 have to specify both --enable-parport AND --enable-parport-ppdev, since the
292 the later option is an option to the parport driver.
293
294 The same is true for the --enable-parport-giveio option, you have to
295 use both the --enable-parport AND the --enable-parport-giveio option
296 if you want to use giveio instead of ioperm parallel port access
297 method.
298
299
300 ==========================
301 Obtaining OpenOCD From GIT
302 ==========================
303
304 You can download the current GIT version with a GIT client of your
305 choice from the main repository:
306
307    git://git.code.sf.net/p/openocd/code
308
309 You may prefer to use a mirror:
310
311    http://repo.or.cz/r/openocd.git
312    git://repo.or.cz/openocd.git
313
314 Using the GIT command line client, you might use the following command
315 to set up a local copy of the current repository (make sure there is no
316 directory called "openocd" in the current directory):
317
318    git clone git://git.code.sf.net/p/openocd/code openocd
319
320 Then you can update that at your convenience using
321
322    git pull
323
324 There is also a gitweb interface, which you can use either to browse
325 the repository or to download arbitrary snapshots using HTTP:
326
327    http://repo.or.cz/w/openocd.git
328
329 Snapshots are compressed tarballs of the source tree, about 1.3 MBytes
330 each at this writing.