Move ocl (at91sam7x flash loader) sources to contrib

[openocd] / README

diff --git a/README b/README
index 0781dfc42044352d7b137d14944cb5f4155c6231..645ff652ace9087550fa94f5f7e46cf08982da78 100644 (file)
--- a/README
+++ b/README
@@ -7,9 +7,9 @@ layered architecture of JTAG interface and TAP support including:
 - (X)SVF playback to faciliate automated boundary scan and FPGA/CPLD
   programming;
 - debug target support (e.g. ARM, MIPS): single-stepping,
 - (X)SVF playback to faciliate automated boundary scan and FPGA/CPLD
   programming;
 - debug target support (e.g. ARM, MIPS): single-stepping,

-  breakpoints/watchpoints, etc;
+  breakpoints/watchpoints, gprof profiling, etc;

 - flash chip drivers (e.g. CFI, NAND, internal flash);
 - flash chip drivers (e.g. CFI, NAND, internal flash);

-- embedded TCL intepreter for easy scripting.
+- 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
 
 Several network interfaces are available for interacting with OpenOCD:
 telnet, TCL, and GDB. The GDB server enables OpenOCD to function as a


@@ -101,12 +101,13 @@ JTAG adapters
 -------------
 
 AICE, ARM-JTAG-EW, ARM-USB-OCD, ARM-USB-TINY, AT91RM9200, axm0432,
 -------------
 
 AICE, ARM-JTAG-EW, ARM-USB-OCD, ARM-USB-TINY, AT91RM9200, axm0432,

-BCM2835, Bus Blaster, Buspirate, Chameleon, Cortino, DLC 5,
-DLP-USB1232H, embedded projects, eStick, FlashLINK, FlossJTAG,
-Flyswatter, Flyswatter2, Hoegl, ICDI, ICEBear, J-Link, 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,
+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.
 STM32-PerformanceStick, STR9-comStick, sysfsgpio, TUMPA, Turtelizer,
 ULINK, USB-A9260, USB-Blaster, USB-JTAG, USBprog, VPACLink, VSLLink,
 Wiggler, XDS100v2, Xverve.


@@ -116,15 +117,15 @@ Debug targets
 
 ARM11, ARM7, ARM9, AVR32, Cortex-A, Cortex-R, Cortex-M,
 Feroceon/Dragonite, DSP563xx, DSP5680xx, FA526, MIPS EJTAG, NDS32,
 
 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,
 
 Flash drivers
 -------------
 
 ADUC702x, AT91SAM, AVR, CFI, DSP5680xx, EFM32, EM357, FM3, Kinetis,

-LPC2000, LPC2900, LPCSPIFI, PIC32mx, Stellaris, STM32, STMSMI, STR7x,
-STR9x; NAND controllers of AT91SAM9, LPC3180, LPC32xx, i.MX31, MXC,
-NUC910, Orion/Kirkwood, S3C24xx, S3C6400.
+LPC2000, LPC2900, LPCSPIFI, Milandr, NuMicro, PIC32mx, Stellaris,
+STM32, STMSMI, STR7x, STR9x, nRF51; NAND controllers of AT91SAM9, LPC3180,
+LPC32xx, i.MX31, MXC, NUC910, Orion/Kirkwood, S3C24xx, S3C6400.

 
 
 ==================
 
 
 ==================


@@ -210,15 +211,17 @@ You'll also need:
 
 - make
 - libtool
 
 - make
 - libtool

+- pkg-config >= 0.23 (or compatible)

 
 Additionally, for building from git:
 
 
 Additionally, for building from git:
 

-- autoconf >= 2.59
+- autoconf >= 2.64

 - automake >= 1.9
 - texinfo
 
 USB-based adapters depend on libusb-1.0 and some older drivers require
 - automake >= 1.9
 - texinfo
 
 USB-based adapters depend on libusb-1.0 and some older drivers require

-libusb-0.1 or libusb-compat-0.1.
+libusb-0.1 or libusb-compat-0.1. A compatible implementation, such as
+FreeBSD's, additionally needs the corresponding .pc files.

 
 USB-Blaster, ASIX Presto, OpenJTAG and ft2232 interface adapter
 drivers need either one of:
 
 USB-Blaster, ASIX Presto, OpenJTAG and ft2232 interface adapter
 drivers need either one of:


@@ -226,14 +229,16 @@ drivers need either one of:
   - ftd2xx: http://www.ftdichip.com/Drivers/D2XX.htm (proprietary,
     GPL-incompatible)
 
   - 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.
 
 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.
 
 consult your operating system documentation to be sure. Do not forget
 to add yourself to the "plugdev" group.
 


@@ -272,6 +277,16 @@ e.g. for cross-building for Windows 32-bit with MinGW on Debian:
 
   ./configure --host=i686-w64-mingw32 [options]
 
 
   ./configure --host=i686-w64-mingw32 [options]
 

+To make pkg-config work nicely for cross-compiling, you might need an
+additional wrapper script as described at
+
+  http://www.flameeyes.eu/autotools-mythbuster/pkgconfig/cross-compiling.html
+
+This is needed to tell pkg-config where to look for the target
+libraries that OpenOCD depends on. Alternatively, you can specify
+*_CFLAGS and *_LIBS environment variables directly, see "./configure
+--help" for the details.
+

 Parallel Port Dongles
 ---------------------
 
 Parallel Port Dongles
 ---------------------