X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=doc%2Fopenocd.texi;h=c2ee20dea3e84517459f4575f4e148c2c35eff7b;hp=91c50f1a49b1024434f4d951075744cc0d37a274;hb=27f0497efa3c4fe14510979c1fa6905be74ad43b;hpb=1dd462a6d613a48d518e925738b680b124055e61 diff --git a/doc/openocd.texi b/doc/openocd.texi index 91c50f1a49..c2ee20dea3 100644 --- a/doc/openocd.texi +++ b/doc/openocd.texi @@ -174,7 +174,7 @@ The OpenOCD web site provides the latest public news from the community: The user's guide you are now reading may not be the latest one available. A version for more recent code may be available. -Its HTML form is published irregularly at: +Its HTML form is published regularly at: @uref{http://openocd.sourceforge.net/doc/html/index.html} @@ -192,6 +192,17 @@ instead of this forum. @uref{http://forum.sparkfun.com/viewforum.php?f=18} +@section OpenOCD User's Mailing List + +The OpenOCD User Mailing List provides the primary means of +communication between users: + +@uref{https://lists.sourceforge.net/mailman/listinfo/openocd-user} + +@section OpenOCD IRC + +Support can also be found on irc: +@uref{irc://irc.freenode.net/openocd} @node Developers @chapter OpenOCD Developer Resources @@ -467,6 +478,9 @@ The simplest solution is to get linux to ignore the ST-LINK using one of the fol @item @b{estick} @* Link: @url{http://code.google.com/p/estick-jtag/} + +@item @b{Keil ULINK v1} +@* Link: @url{http://www.keil.com/ulink1/} @end itemize @section IBM PC Parallel Printer Port Based @@ -2616,33 +2630,56 @@ This is a write-once setting. @end deffn @deffn {Interface Driver} {jlink} -Segger jlink USB adapter -@c command: jlink caps -@c dumps jlink capabilities -@c command: jlink config -@c access J-Link configurationif no argument this will dump the config -@c command: jlink config kickstart [val] -@c set Kickstart power on JTAG-pin 19. -@c command: jlink config mac_address [ff:ff:ff:ff:ff:ff] -@c set the MAC Address -@c command: jlink config ip [A.B.C.D[/E] [F.G.H.I]] -@c set the ip address of the J-Link Pro, " -@c where A.B.C.D is the ip, -@c E the bit of the subnet mask -@c F.G.H.I the subnet mask -@c command: jlink config reset -@c reset the current config -@c command: jlink config save -@c save the current config -@c command: jlink config usb_address [0x00 to 0x03 or 0xff] -@c set the USB-Address, -@c This will change the product id -@c command: jlink info -@c dumps status -@c command: jlink hw_jtag (2|3) -@c sets version 2 or 3 -@c command: jlink pid -@c set the pid of the interface we want to use +Segger J-Link family of USB adapters. It currently supports only the JTAG transport. + +@quotation Compatibility Note +Segger released many firmware versions for the many harware versions they +produced. OpenOCD was extensively tested and intended to run on all of them, +but some combinations were reported as incompatible. As a general +recommendation, it is advisable to use the latest firmware version +available for each hardware version. However the current V8 is a moving +target, and Segger firmware versions released after the OpenOCD was +released may not be compatible. In such cases it is recommended to +revert to the last known functional version. For 0.5.0, this is from +"Feb 8 2012 14:30:39", packed with 4.42c. For 0.6.0, the last known +version is from "May 3 2012 18:36:22", packed with 4.46f. +@end quotation + +@deffn {Command} {jlink caps} +Display the device firmware capabilities. +@end deffn +@deffn {Command} {jlink info} +Display various device information, like hardware version, firmware version, current bus status. +@end deffn +@deffn {Command} {jlink hw_jtag} [@option{2}|@option{3}] +Set the JTAG protocol version to be used. Without argument, show the actual JTAG protocol version. +@end deffn +@deffn {Command} {jlink config} +Display the J-Link configuration. +@end deffn +@deffn {Command} {jlink config kickstart} [val] +Set the Kickstart power on JTAG-pin 19. Without argument, show the Kickstart configuration. +@end deffn +@deffn {Command} {jlink config mac_address} [@option{ff:ff:ff:ff:ff:ff}] +Set the MAC address of the J-Link Pro. Without argument, show the MAC address. +@end deffn +@deffn {Command} {jlink config ip} [@option{A.B.C.D}(@option{/E}|@option{F.G.H.I})] +Set the IP configuration of the J-Link Pro, where A.B.C.D is the IP address, + E the bit of the subnet mask and + F.G.H.I the subnet mask. Without arguments, show the IP configuration. +@end deffn +@deffn {Command} {jlink config usb_address} [@option{0x00} to @option{0x03} or @option{0xff}] +Set the USB address; this will also change the product id. Without argument, show the USB address. +@end deffn +@deffn {Command} {jlink config reset} +Reset the current configuration. +@end deffn +@deffn {Command} {jlink config save} +Save the current configuration to the internal persistent storage. +@end deffn +@deffn {Config} {jlink pid} val +Set the USB PID of the interface. As a configuration command, it can be used only before 'init'. +@end deffn @end deffn @deffn {Interface Driver} {parport} @@ -2795,6 +2832,10 @@ Manually sets the stlink api used, valid options are 1 or 2. opendous-jtag is a freely programmable USB adapter. @end deffn +@deffn {Interface Driver} {ulink} +This is the Keil ULINK v1 JTAG debugger. +@end deffn + @deffn {Interface Driver} {ZY1000} This is the Zylin ZY1000 JTAG debugger. @end deffn @@ -4034,7 +4075,7 @@ The value should normally correspond to a static mapping for the @item @code{-rtos} @var{rtos_type} -- enable rtos support for target, @var{rtos_type} can be one of @option{auto}|@option{eCos}|@option{ThreadX}| -@option{FreeRTOS}|@option{linux}. +@option{FreeRTOS}|@option{linux}|@option{ChibiOS}. @end itemize @end deffn @@ -4611,6 +4652,30 @@ flash bank $_FLASHNAME cfi 0x00000000 0x02000000 2 4 $_TARGETNAME @c "cfi part_id" disabled @end deffn +@deffn {Flash Driver} lpcspifi +@cindex NXP SPI Flash Interface +@cindex SPIFI +@cindex lpcspifi +NXP's LPC43xx and LPC18xx families include a proprietary SPI +Flash Interface (SPIFI) peripheral that can drive and provide +memory mapped access to external SPI flash devices. + +The lpcspifi driver initializes this interface and provides +program and erase functionality for these serial flash devices. +Use of this driver @b{requires} a working area of at least 1kB +to be configured on the target device; more than this will +significantly reduce flash programming times. + +The setup command only requires the @var{base} parameter. All +other parameters are ignored, and the flash size and layout +are configured by the driver. + +@example +flash bank $_FLASHNAME lpcspifi 0x14000000 0 0 0 $_TARGETNAME +@end example + +@end deffn + @deffn {Flash Driver} stmsmi @cindex STMicroelectronics Serial Memory Interface @cindex SMI @@ -7514,6 +7579,11 @@ A socket (TCP/IP) connection is typically started as follows: target remote localhost:3333 @end example This would cause GDB to connect to the gdbserver on the local pc using port 3333. + +It is also possible to use the GDB extended remote protocol as follows: +@example +target extended-remote localhost:3333 +@end example @item A pipe connection is typically started as follows: @example