X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=README;h=a6b4c5bd01194c879df33d01c00b4b7ed2cd3c25;hp=065994a3f85ab1f5c3087db0740404bca4f36e97;hb=baf08b0a1ad656434583e3c102a350d4cf885bf9;hpb=d19fafc8bdb30974e70bfc5a6ce63e7578b6e3b2 diff --git a/README b/README index 065994a3f8..a6b4c5bd01 100644 --- a/README +++ b/README @@ -39,7 +39,11 @@ 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.: - openocd -f interface/ftdi/jtagkey2.cfg -f target/ti_calypso.cfg + 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 NB: when using an FTDI-based adapter you should prefer configs in the ftdi directory; the old configs for the ft2232 are deprecated. @@ -57,10 +61,10 @@ In addition to the in-tree documentation, the latest manuals may be viewed online at the following URLs: OpenOCD User's Guide: - http://openocd.sourceforge.net/doc/html/index.html + http://openocd.org/doc/html/index.html OpenOCD Developer's Manual: - http://openocd.sourceforge.net/doc/doxygen/html/index.html + http://openocd.org/doc/doxygen/html/index.html These reflect the latest development versions, so the following section introduces how to build the complete documentation from the package. @@ -101,13 +105,13 @@ JTAG adapters ------------- AICE, ARM-JTAG-EW, ARM-USB-OCD, ARM-USB-TINY, AT91RM9200, axm0432, -BCM2835, Bus Blaster, Buspirate, Chameleon, Cortino, DENX, 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), +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, SheevaPlug +devkit, 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. @@ -117,15 +121,16 @@ Debug targets ARM11, ARM7, ARM9, AVR32, Cortex-A, Cortex-R, Cortex-M, Feroceon/Dragonite, DSP563xx, DSP5680xx, FA526, MIPS EJTAG, NDS32, -XScale. +XScale, Intel Quark. Flash drivers ------------- -ADUC702x, AT91SAM, AVR, CFI, DSP5680xx, EFM32, EM357, FM3, Kinetis, -LPC2000, LPC2900, LPCSPIFI, Milandr, NuMicro, PIC32mx, Stellaris, -STM32, STMSMI, STR7x, STR9x; NAND controllers of AT91SAM9, LPC3180, -LPC32xx, i.MX31, MXC, NUC910, Orion/Kirkwood, S3C24xx, S3C6400. +ADUC702x, AT91SAM, AVR, CFI, DSP5680xx, EFM32, EM357, FM3, FM4, Kinetis, +LPC8xx/LPC1xxx/LPC2xxx/LPC541xx, LPC2900, LPCSPIFI, Marvell QSPI, +Milandr, NIIET, NuMicro, PIC32mx, PSoC4, SiM3x, Stellaris, STM32, STMSMI, +STR7x, STR9x, nRF51; NAND controllers of AT91SAM9, LPC3180, LPC32xx, +i.MX31, MXC, NUC910, Orion/Kirkwood, S3C24xx, S3C6400, XMC4xxx. ================== @@ -229,14 +234,16 @@ drivers need either one of: - ftd2xx: http://www.ftdichip.com/Drivers/D2XX.htm (proprietary, GPL-incompatible) +CMSIS-DAP support needs HIDAPI library. + Permissions delegation ---------------------- Running OpenOCD with root/administrative permissions is strongly discouraged for security reasons. -For USB devices on GNU/Linux you should use the contrib/openocd.udev -rules file. It probably belongs somewhere in /etc/udev/rules.d, but +For USB devices on GNU/Linux you should use the contrib/99-openocd.rules +file. It probably belongs somewhere in /etc/udev/rules.d, but consult your operating system documentation to be sure. Do not forget to add yourself to the "plugdev" group.