Welcome to OpenOCD!===================OpenOCD provides on-chip programming and debugging support with alayered architecture of JTAG interface and TAP support including:- (X)SVF playback to facilitate automated boundary scan and FPGA/CPLD  programming;- debug target support (e.g. ARM, MIPS): single-stepping,  breakpoints/watchpoints, gprof profiling, etc;- flash chip drivers (e.g. CFI, NAND, internal flash);- embedded TCL interpreter for easy scripting.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 usingthe GNU GDB program (and the others who talk GDB protocol, e.g. IDAPro).This README file contains an overview of the following topics:- quickstart instructions,- how to find and build more OpenOCD documentation,- list of the supported hardware,- the installation and build process,- packaging tips.============================Quickstart for the impatient============================If you have a popular board then just start OpenOCD with its config,e.g.:  openocd -f board/stm32f4discovery.cfgIf you are connecting a particular adapter with some specific target,you need to source both the jtag interface and the target configs,e.g.:  openocd -f interface/ftdi/jtagkey2.cfg -c "transport select jtag" \          -f target/ti_calypso.cfg  openocd -f interface/stlink.cfg -c "transport select hla_swd" \          -f target/stm32l0.cfgAfter OpenOCD startup, connect GDB with  (gdb) target extended-remote localhost:3333=====================OpenOCD Documentation=====================In addition to the in-tree documentation, the latest manuals may beviewed online at the following URLs:  OpenOCD User's Guide:http://openocd.org/doc/html/index.html  OpenOCD Developer's Manual:http://openocd.org/doc/doxygen/html/index.htmlThese reflect the latest development versions, so the following sectionintroduces how to build the complete documentation from the package.For more information, refer to these documents or contact the developersby subscribing to the OpenOCD developer mailing list:openocd-devel@lists.sourceforge.netBuilding the OpenOCD Documentation----------------------------------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 thefollowing different formats:  # 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.htmlThe OpenOCD Developer Manual contains information about the internalarchitecture and other details about the code:  # NB! make sure doxygen is installed, type doxygen --version  make doxygen && ${HTMLVIEWER} doxygen/index.html==================Supported hardware==================JTAG adapters-------------AICE, ARM-JTAG-EW, ARM-USB-OCD, ARM-USB-TINY, AT91RM9200, axm0432,BCM2835, Bus Blaster, Buspirate, Chameleon, CMSIS-DAP, Cortino, DENX,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, SheevaPlugdevkit, Stellaris evkits, ST-LINK (SWO tracing supported),STM32-PerformanceStick, STR9-comStick, sysfsgpio, TUMPA, Turtelizer,ULINK, USB-A9260, USB-Blaster, USB-JTAG, USBprog, VPACLink, VSLLink,Wiggler, XDS100v2, Xverve.Debug targets-------------ARM11, ARM7, ARM9, AVR32, Cortex-A, Cortex-R, Cortex-M, LS102x-SAP,Feroceon/Dragonite, DSP563xx, DSP5680xx, EnSilica eSi-RISC, FA526, MIPSEJTAG, NDS32, XScale, Intel Quark.Flash drivers-------------ADUC702x, AT91SAM, ATH79, AVR, CFI, DSP5680xx, EFM32, EM357, eSi-TSMC, FM3,FM4, Freedom E SPI, Kinetis, LPC8xx/LPC1xxx/LPC2xxx/LPC541xx, LPC2900,LPCSPIFI, Marvell QSPI, Milandr, NIIET, NuMicro, PIC32mx, PSoC4, PSoC5LP,SiM3x, Stellaris, STM32, STMSMI, STR7x, STR9x, nRF51; NAND controllers ofAT91SAM9, LPC3180, LPC32xx, i.MX31, MXC, NUC910, Orion/Kirkwood, S3C24xx,S3C6400, XMC1xxx, XMC4xxx.==================Installing OpenOCD==================A Note to OpenOCD Users-----------------------If you would rather be working "with" OpenOCD rather than "on" it, youroperating system or JTAG interface supplier may provide binaries foryou in a convenient-enough package.Such packages may be more stable than git mainline, wherebleeding-edge development takes place. These "Packagers" producebinary releases of OpenOCD after the developers produces new "release"versions of the source code. Previous versions of OpenOCD cannot beused to diagnose problems with the current release, so users areencouraged to keep in contact with their distribution packagemaintainers or interface vendors to ensure suitable upgrades appearregularly.Users of these binary versions of OpenOCD must contact their Packager toask for support or newer versions of the binaries; the OpenOCDdevelopers 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 or IDEs (a development solution integrating OpenOCD);- Build packages (e.g. RPM or DEB files for a GNU/Linux distribution).As a PACKAGER, you will experience first reports of most issues.When you fix those problems for your users, your solution may helpprevent hundreds (if not thousands) of other questions from other users.If something does not work for you, please work to inform the OpenOCDdevelopers know how to improve the system or documentation to avoidfuture problems, and follow-up to help us ensure the issue will be fullyresolved in our future releases.That said, the OpenOCD developers would also like you to follow a fewsuggestions:- 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.================Building OpenOCD================The INSTALL file contains generic instructions for running 'configure'and compiling the OpenOCD source code. That file is provided bydefault for all GNU autotools packages. If you are not familiar withthe GNU autotools, then you should read those instructions first.The remainder of this document tries to provide some instructions forthose looking for a quick-install.OpenOCD Dependencies--------------------GCC or Clang is currently required to build OpenOCD. The developershave begun to enforce strict code warnings (-Wall, -Werror, -Wextra,and more) and use C99-specific features: inline functions, namedinitializers, mixing declarations with code, and other tricks. Whileit may be possible to use other compilers, they must be somewhatmodern and could require extending support to conditionally removeGCC-specific extensions.You'll also need:- make- libtool- pkg-config >= 0.23 (or compatible)Additionally, for building from git:- autoconf >= 2.64- automake >= 1.14- texinfoUSB-based adapters depend on libusb-1.0 and some older drivers requirelibusb-0.1 or libusb-compat-0.1. A compatible implementation, such asFreeBSD's, additionally needs the corresponding .pc files.USB-Blaster, ASIX Presto and OpenJTAG interface adapterdrivers need:  - libftdi:http://www.intra2net.com/en/developer/libftdi/index.phpCMSIS-DAP support needs HIDAPI library.Permissions delegation----------------------Running OpenOCD with root/administrative permissions is stronglydiscouraged for security reasons.For USB devices on GNU/Linux you should use the contrib/60-openocd.rulesfile. It probably belongs somewhere in /etc/udev/rules.d, butconsult your operating system documentation to be sure. Do not forgetto add yourself to the "plugdev" group.For parallel port adapters on GNU/Linux and FreeBSD please change your"ppdev" (parport* or ppi*) device node permissions accordingly.For parport adapters on Windows you need to run install_giveio.bat(it's also possible to use "ioperm" with Cygwin instead) to giveordinary users permissions for accessing the "LPT" registers directly.Compiling OpenOCD-----------------To build OpenOCD, use the following sequence of commands:  ./bootstrap (when building from the git repository)  ./configure [options]  make  sudo make installThe 'configure' step generates the Makefiles required to buildOpenOCD, 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 ofthe files in the required location.To see the list of all the supported options, run  ./configure --helpCross-compiling Options-----------------------Cross-compiling is supported the standard autotools way, you just needto specify the cross-compiling target triplet in the --host option,e.g. for cross-building for Windows 32-bit with MinGW on Debian:  ./configure --host=i686-w64-mingw32 [options]To make pkg-config work nicely for cross-compiling, you might need anadditional wrapper script as described athttp://www.flameeyes.eu/autotools-mythbuster/pkgconfig/cross-compiling.htmlThis is needed to tell pkg-config where to look for the targetlibraries that OpenOCD depends on. Alternatively, you can specify*_CFLAGS and *_LIBS environment variables directly, see "./configure--help" for the details.Parallel Port Dongles---------------------If you want to access the parallel port using the PPDEV interface youhave to specify both --enable-parport AND --enable-parport-ppdev, since thethe later option is an option to the parport driver.The same is true for the --enable-parport-giveio option, you have touse both the --enable-parport AND the --enable-parport-giveio optionif you want to use giveio instead of ioperm parallel port accessmethod.==========================Obtaining OpenOCD From GIT==========================You can download the current GIT version with a GIT client of yourchoice from the main repository:   git://git.code.sf.net/p/openocd/codeYou may prefer to use a mirror:http://repo.or.cz/r/openocd.git   git://repo.or.cz/openocd.gitUsing the GIT command line client, you might use the following commandto set up a local copy of the current repository (make sure there is nodirectory called "openocd" in the current directory):   git clone git://git.code.sf.net/p/openocd/code openocdThen you can update that at your convenience using   git pullThere is also a gitweb interface, which you can use either to browsethe repository or to download arbitrary snapshots using HTTP:http://repo.or.cz/w/openocd.gitSnapshots are compressed tarballs of the source tree, about 1.3 MByteseach at this writing.