interesting
/
riscv-openocd
mirror of https://github.com/riscv/riscv-openocd.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: J-Link commands added to the manual 

The J-Link related commands and configuration commands were added
to the "8.2 Interface Drivers" section of the manual.
(previously they were enumerated as comments).
The 'jlink pid' was marked as Config all other as Command.
A draft of a compatibility note was added, but probably
a table would be more appropriate.

Change-Id: Ifbe230706815196aaad4e3729ed5089d5088b769
Signed-off-by: Liviu Ionescu <ilg@livius.net>
Reviewed-on: http://openocd.zylin.com/680
Tested-by: jenkins
Reviewed-by: Spencer Oliver <spen@spen-soft.co.uk>
This commit is contained in:
Liviu Ionescu 2012-05-29 14:52:04 +03:00 committed by Spencer Oliver
parent d50ce65962
commit e571746735
1 changed files with 50 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

77
doc/openocd.texi
View File

@ -2616,33 +2616,56 @@ This is a write-once setting.
@end deffn @end deffn
@deffn {Interface Driver} {jlink} @deffn {Interface Driver} {jlink}
Segger jlink USB adapter Segger J-Link family of USB adapters. It currently supports only the JTAG transport.
@c command: jlink caps
@c dumps jlink capabilities @quotation Compatibility Note
@c command: jlink config Segger released many firmware versions for the many harware versions they
@c access J-Link configurationif no argument this will dump the config produced. OpenOCD was extensively tested and intended to run on all of them,
@c command: jlink config kickstart [val] but some combinations were reported as incompatible. As a general
@c set Kickstart power on JTAG-pin 19. recommendation, it is advisable to use the latest firmware version
@c command: jlink config mac_address [ff:ff:ff:ff:ff:ff] available for each hardware version. However the current V8 is a moving
@c set the MAC Address target, and Segger firmware versions released after the OpenOCD was
@c command: jlink config ip [A.B.C.D[/E] [F.G.H.I]] released may not be compatible. In such cases it is recommended to
@c set the ip address of the J-Link Pro, " revert to the last known functional version. For 0.5.0, this is from
@c where A.B.C.D is the ip, "Feb 8 2012 14:30:39", packed with 4.42c. For 0.6.0, the last known
@c E the bit of the subnet mask version is from "May 3 2012 18:36:22", packed with 4.46f.
@c F.G.H.I the subnet mask @end quotation
@c command: jlink config reset
@c reset the current config @deffn {Command} {jlink caps}
@c command: jlink config save Display the device firmware capabilities.
@c save the current config @end deffn
@c command: jlink config usb_address [0x00 to 0x03 or 0xff] @deffn {Command} {jlink info}
@c set the USB-Address, Display various device information, like hardware version, firmware version, current bus status.
@c This will change the product id @end deffn
@c command: jlink info @deffn {Command} {jlink hw_jtag} [@option{2}|@option{3}]
@c dumps status Set the JTAG protocol version to be used. Without argument, show the actual JTAG protocol version.
@c command: jlink hw_jtag (2|3) @end deffn
@c sets version 2 or 3 @deffn {Command} {jlink config}
@c command: jlink pid Display the J-Link configuration.
@c set the pid of the interface we want to use @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 @end deffn
@deffn {Interface Driver} {parport} @deffn {Interface Driver} {parport}