Menu
▾
▴
openocd-commit — OpenOCD commit maling list - read only
You can subscribe to this list here.
| 2008 |
Jan
|
Feb
|
Mar
|
Apr
|
May
|
Jun
|
Jul
|
Aug
|
Sep
|
Oct
|
Nov
|
Dec
(75) |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2009 |
Jan
(70) |
Feb
(20) |
Mar
(52) |
Apr
(149) |
May
(387) |
Jun
(466) |
Jul
(133) |
Aug
(87) |
Sep
(122) |
Oct
(140) |
Nov
(185) |
Dec
(105) |
| 2010 |
Jan
(85) |
Feb
(45) |
Mar
(75) |
Apr
(17) |
May
(41) |
Jun
(52) |
Jul
(33) |
Aug
(29) |
Sep
(36) |
Oct
(15) |
Nov
(26) |
Dec
(34) |
| 2011 |
Jan
(26) |
Feb
(25) |
Mar
(26) |
Apr
(29) |
May
(20) |
Jun
(27) |
Jul
(15) |
Aug
(32) |
Sep
(13) |
Oct
(64) |
Nov
(60) |
Dec
(10) |
| 2012 |
Jan
(64) |
Feb
(63) |
Mar
(39) |
Apr
(43) |
May
(54) |
Jun
(11) |
Jul
(30) |
Aug
(45) |
Sep
(11) |
Oct
(70) |
Nov
(24) |
Dec
(23) |
| 2013 |
Jan
(17) |
Feb
(8) |
Mar
(35) |
Apr
(40) |
May
(20) |
Jun
(24) |
Jul
(36) |
Aug
(25) |
Sep
(42) |
Oct
(40) |
Nov
(9) |
Dec
(21) |
| 2014 |
Jan
(29) |
Feb
(24) |
Mar
(60) |
Apr
(22) |
May
(22) |
Jun
(46) |
Jul
(11) |
Aug
(23) |
Sep
(26) |
Oct
(10) |
Nov
(14) |
Dec
(2) |
| 2015 |
Jan
(28) |
Feb
(47) |
Mar
(33) |
Apr
(58) |
May
(5) |
Jun
(1) |
Jul
|
Aug
(8) |
Sep
(12) |
Oct
(25) |
Nov
(58) |
Dec
(21) |
| 2016 |
Jan
(12) |
Feb
(40) |
Mar
(2) |
Apr
(1) |
May
(67) |
Jun
(2) |
Jul
(5) |
Aug
(36) |
Sep
|
Oct
(24) |
Nov
(17) |
Dec
(50) |
| 2017 |
Jan
(14) |
Feb
(16) |
Mar
(2) |
Apr
(35) |
May
(14) |
Jun
(16) |
Jul
(3) |
Aug
(3) |
Sep
|
Oct
(19) |
Nov
|
Dec
(16) |
| 2018 |
Jan
(55) |
Feb
(11) |
Mar
(34) |
Apr
(14) |
May
(4) |
Jun
(20) |
Jul
(39) |
Aug
(16) |
Sep
(17) |
Oct
(16) |
Nov
(20) |
Dec
(30) |
| 2019 |
Jan
(29) |
Feb
(24) |
Mar
(37) |
Apr
(26) |
May
(19) |
Jun
(21) |
Jul
(2) |
Aug
(3) |
Sep
(9) |
Oct
(12) |
Nov
(12) |
Dec
(12) |
| 2020 |
Jan
(47) |
Feb
(36) |
Mar
(54) |
Apr
(44) |
May
(37) |
Jun
(19) |
Jul
(32) |
Aug
(13) |
Sep
(16) |
Oct
(24) |
Nov
(32) |
Dec
(11) |
| 2021 |
Jan
(14) |
Feb
(5) |
Mar
(40) |
Apr
(32) |
May
(42) |
Jun
(31) |
Jul
(29) |
Aug
(47) |
Sep
(38) |
Oct
(17) |
Nov
(74) |
Dec
(33) |
| 2022 |
Jan
(11) |
Feb
(15) |
Mar
(40) |
Apr
(21) |
May
(39) |
Jun
(44) |
Jul
(19) |
Aug
(46) |
Sep
(79) |
Oct
(35) |
Nov
(21) |
Dec
(15) |
| 2023 |
Jan
(56) |
Feb
(13) |
Mar
(43) |
Apr
(28) |
May
(60) |
Jun
(15) |
Jul
(29) |
Aug
(28) |
Sep
(32) |
Oct
(21) |
Nov
(42) |
Dec
(39) |
| 2024 |
Jan
(35) |
Feb
(17) |
Mar
(28) |
Apr
(7) |
May
(14) |
Jun
(35) |
Jul
(30) |
Aug
(35) |
Sep
(30) |
Oct
(28) |
Nov
(38) |
Dec
(18) |
| 2025 |
Jan
(21) |
Feb
(28) |
Mar
(36) |
Apr
(35) |
May
(34) |
Jun
(58) |
Jul
(9) |
Aug
(54) |
Sep
(47) |
Oct
(15) |
Nov
(47) |
Dec
|
|
From: ntfreak at B. <nt...@ma...> - 2009-03-24 10:40:08
|
Author: ntfreak Date: 2009-03-24 10:40:03 +0100 (Tue, 24 Mar 2009) New Revision: 1431 Modified: trunk/src/target/board/keil_mcb2140.cfg trunk/src/target/board/olimex_lpc_h2148.cfg trunk/src/target/interface/stm32-stick.cfg trunk/src/target/interface/str9-comstick.cfg trunk/src/target/target/ixp42x.cfg Log: - update str9 and stm32 comstick configs - add missing svn props Modified: trunk/src/target/board/keil_mcb2140.cfg =================================================================== --- trunk/src/target/board/keil_mcb2140.cfg 2009-03-24 07:44:47 UTC (rev 1430) +++ trunk/src/target/board/keil_mcb2140.cfg 2009-03-24 09:40:03 UTC (rev 1431) @@ -1,8 +1,8 @@ -# -# Keil MCB2140 eval board -# -# http://www.keil.com/mcb2140/picture.asp -# - -source [find target/lpc2148.cfg] - +# +# Keil MCB2140 eval board +# +# http://www.keil.com/mcb2140/picture.asp +# + +source [find target/lpc2148.cfg] + Property changes on: trunk/src/target/board/keil_mcb2140.cfg ___________________________________________________________________ Name: svn:eol-style + native Modified: trunk/src/target/board/olimex_lpc_h2148.cfg =================================================================== --- trunk/src/target/board/olimex_lpc_h2148.cfg 2009-03-24 07:44:47 UTC (rev 1430) +++ trunk/src/target/board/olimex_lpc_h2148.cfg 2009-03-24 09:40:03 UTC (rev 1431) @@ -1,8 +1,8 @@ -# -# Olimex LPC-H2148 eval board -# -# http://www.olimex.com/dev/lpc-h2148.html -# - -source [find target/lpc2148.cfg] - +# +# Olimex LPC-H2148 eval board +# +# http://www.olimex.com/dev/lpc-h2148.html +# + +source [find target/lpc2148.cfg] + Property changes on: trunk/src/target/board/olimex_lpc_h2148.cfg ___________________________________________________________________ Name: svn:eol-style + native Modified: trunk/src/target/interface/stm32-stick.cfg =================================================================== --- trunk/src/target/interface/stm32-stick.cfg 2009-03-24 07:44:47 UTC (rev 1430) +++ trunk/src/target/interface/stm32-stick.cfg 2009-03-24 09:40:03 UTC (rev 1431) @@ -2,4 +2,4 @@ interface ft2232 ft2232_device_desc "STM32-PerformanceStick A" ft2232_layout stm32stick - +ft2232_vid_pid 0x0640 0x002d Modified: trunk/src/target/interface/str9-comstick.cfg =================================================================== --- trunk/src/target/interface/str9-comstick.cfg 2009-03-24 07:44:47 UTC (rev 1430) +++ trunk/src/target/interface/str9-comstick.cfg 2009-03-24 09:40:03 UTC (rev 1431) @@ -1,3 +1,4 @@ interface ft2232 ft2232_device_desc "STR9-comStick A" ft2232_layout comstick +ft2232_vid_pid 0x0640 0x002c Modified: trunk/src/target/target/ixp42x.cfg =================================================================== --- trunk/src/target/target/ixp42x.cfg 2009-03-24 07:44:47 UTC (rev 1430) +++ trunk/src/target/target/ixp42x.cfg 2009-03-24 09:40:03 UTC (rev 1431) @@ -1,32 +1,32 @@ -#xscale ixp42x CPU - - -if { [info exists CHIPNAME] } { - set _CHIPNAME $CHIPNAME -} else { - set _CHIPNAME ixp42x -} - -if { [info exists ENDIAN] } { - set _ENDIAN $ENDIAN -} else { - # this defaults to a bigendian - set _ENDIAN big -} - -if { [info exists CPUTAPID ] } { - set _CPUTAPID $CPUTAPID -} else { - # force an error till we get a good number - set _CPUTAPID 0xffffffff -} - -#use combined on interfaces or targets that can?t set TRST/SRST separately -reset_config srst_only srst_pulls_trst -#jtag scan chain - -jtag newtap $_CHIPNAME cpu -irlen 7 -ircapture 0x1 -irmask 0x7f -expected-id $_CPUTAPID - -set _TARGETNAME [format "%s.cpu" $_CHIPNAME] -target create $_TARGETNAME xscale -endian $_ENDIAN -chain-position $_TARGETNAME -variant ixp42x - +#xscale ixp42x CPU + + +if { [info exists CHIPNAME] } { + set _CHIPNAME $CHIPNAME +} else { + set _CHIPNAME ixp42x +} + +if { [info exists ENDIAN] } { + set _ENDIAN $ENDIAN +} else { + # this defaults to a bigendian + set _ENDIAN big +} + +if { [info exists CPUTAPID ] } { + set _CPUTAPID $CPUTAPID +} else { + # force an error till we get a good number + set _CPUTAPID 0xffffffff +} + +#use combined on interfaces or targets that can?t set TRST/SRST separately +reset_config srst_only srst_pulls_trst +#jtag scan chain + +jtag newtap $_CHIPNAME cpu -irlen 7 -ircapture 0x1 -irmask 0x7f -expected-id $_CPUTAPID + +set _TARGETNAME [format "%s.cpu" $_CHIPNAME] +target create $_TARGETNAME xscale -endian $_ENDIAN -chain-position $_TARGETNAME -variant ixp42x + Property changes on: trunk/src/target/target/ixp42x.cfg ___________________________________________________________________ Name: svn:eol-style + native |
|
From: oharboe at B. <oh...@ma...> - 2009-03-24 08:44:51
|
Author: oharboe
Date: 2009-03-24 08:44:47 +0100 (Tue, 24 Mar 2009)
New Revision: 1430
Modified:
trunk/src/target/arm_disassembler.c
Log:
Hiroshi Ito <it...@ml...> disassemble Arm926ejs clz instruction
Modified: trunk/src/target/arm_disassembler.c
===================================================================
--- trunk/src/target/arm_disassembler.c 2009-03-24 06:24:23 UTC (rev 1429)
+++ trunk/src/target/arm_disassembler.c 2009-03-24 07:44:47 UTC (rev 1430)
@@ -818,7 +818,7 @@
}
/* CLZ */
- if ((opcode & 0x0060000f0) == 0x00300010)
+ if ((opcode & 0x006000f0) == 0x00600010)
{
u8 Rm, Rd;
instruction->type = ARM_CLZ;
@@ -829,8 +829,8 @@
address, opcode, COND(opcode), Rd, Rm);
}
- /* BLX */
- if ((opcode & 0x0060000f0) == 0x00200030)
+ /* BLX(2) */
+ if ((opcode & 0x006000f0) == 0x00200030)
{
u8 Rm;
instruction->type = ARM_BLX;
|
|
From: <oh...@ma...> - 2009-03-24 07:24:27
|
Author: oharboe Date: 2009-03-24 07:24:23 +0100 (Tue, 24 Mar 2009) New Revision: 1429 Added: trunk/src/target/board/keil_mcb2140.cfg trunk/src/target/board/olimex_lpc_h2148.cfg Log: Uwe Hermann <uw...@he...> Add new board configs: Olimex LPC-H2148, Keil MCB2140. Both boards use an LPC2148, no external flash or RAM. Added: trunk/src/target/board/keil_mcb2140.cfg =================================================================== --- trunk/src/target/board/keil_mcb2140.cfg 2009-03-24 06:23:00 UTC (rev 1428) +++ trunk/src/target/board/keil_mcb2140.cfg 2009-03-24 06:24:23 UTC (rev 1429) @@ -0,0 +1,8 @@ +# +# Keil MCB2140 eval board +# +# http://www.keil.com/mcb2140/picture.asp +# + +source [find target/lpc2148.cfg] + Added: trunk/src/target/board/olimex_lpc_h2148.cfg =================================================================== --- trunk/src/target/board/olimex_lpc_h2148.cfg 2009-03-24 06:23:00 UTC (rev 1428) +++ trunk/src/target/board/olimex_lpc_h2148.cfg 2009-03-24 06:24:23 UTC (rev 1429) @@ -0,0 +1,8 @@ +# +# Olimex LPC-H2148 eval board +# +# http://www.olimex.com/dev/lpc-h2148.html +# + +source [find target/lpc2148.cfg] + |
|
From: <oh...@ma...> - 2009-03-24 07:23:05
|
Author: oharboe
Date: 2009-03-24 07:23:00 +0100 (Tue, 24 Mar 2009)
New Revision: 1428
Added:
trunk/src/target/target/ixp42x.cfg
Removed:
trunk/src/target/target/pxi42x.cfg
Modified:
trunk/src/target/target/nslu2.cfg
Log:
Uwe Hermann <uw...@he...> spelling fixes
Added: trunk/src/target/target/ixp42x.cfg
===================================================================
--- trunk/src/target/target/ixp42x.cfg 2009-03-23 19:12:42 UTC (rev 1427)
+++ trunk/src/target/target/ixp42x.cfg 2009-03-24 06:23:00 UTC (rev 1428)
@@ -0,0 +1,32 @@
+#xscale ixp42x CPU
+
+
+if { [info exists CHIPNAME] } {
+ set _CHIPNAME $CHIPNAME
+} else {
+ set _CHIPNAME ixp42x
+}
+
+if { [info exists ENDIAN] } {
+ set _ENDIAN $ENDIAN
+} else {
+ # this defaults to a bigendian
+ set _ENDIAN big
+}
+
+if { [info exists CPUTAPID ] } {
+ set _CPUTAPID $CPUTAPID
+} else {
+ # force an error till we get a good number
+ set _CPUTAPID 0xffffffff
+}
+
+#use combined on interfaces or targets that can?t set TRST/SRST separately
+reset_config srst_only srst_pulls_trst
+#jtag scan chain
+
+jtag newtap $_CHIPNAME cpu -irlen 7 -ircapture 0x1 -irmask 0x7f -expected-id $_CPUTAPID
+
+set _TARGETNAME [format "%s.cpu" $_CHIPNAME]
+target create $_TARGETNAME xscale -endian $_ENDIAN -chain-position $_TARGETNAME -variant ixp42x
+
Modified: trunk/src/target/target/nslu2.cfg
===================================================================
--- trunk/src/target/target/nslu2.cfg 2009-03-23 19:12:42 UTC (rev 1427)
+++ trunk/src/target/target/nslu2.cfg 2009-03-24 06:23:00 UTC (rev 1428)
@@ -1,7 +1,7 @@
-# This is for the LinkSys (CYSCO) LSLU2 board
-# It is an Intel XSCALE IPX420 CPU.
+# This is for the LinkSys (CISCO) NSLU2 board
+# It is an Intel XSCALE IXP420 CPU.
-source [find target/ipx42x.cfg]
+source [find target/ixp42x.cfg]
# The _TARGETNAME is set by the above.
$_TARGETNAME configure -work-area-virt 0 -work-area-phys 0x00020000 -work-area-size 0x10000 -work-area-backup 0
Deleted: trunk/src/target/target/pxi42x.cfg
===================================================================
--- trunk/src/target/target/pxi42x.cfg 2009-03-23 19:12:42 UTC (rev 1427)
+++ trunk/src/target/target/pxi42x.cfg 2009-03-24 06:23:00 UTC (rev 1428)
@@ -1,32 +0,0 @@
-#xscale ixp42x CPU
-
-
-if { [info exists CHIPNAME] } {
- set _CHIPNAME $CHIPNAME
-} else {
- set _CHIPNAME ipx42x
-}
-
-if { [info exists ENDIAN] } {
- set _ENDIAN $ENDIAN
-} else {
- # this defaults to a bigendian
- set _ENDIAN big
-}
-
-if { [info exists CPUTAPID ] } {
- set _CPUTAPID $CPUTAPID
-} else {
- # force an error till we get a good number
- set _CPUTAPID 0xffffffff
-}
-
-#use combined on interfaces or targets that can?t set TRST/SRST separately
-reset_config srst_only srst_pulls_trst
-#jtag scan chain
-
-jtag newtap $_CHIPNAME cpu -irlen 7 -ircapture 0x1 -irmask 0x7f -expected-id $_CPUTAPID
-
-set _TARGETNAME [format "%s.cpu" $_CHIPNAME]
-target create $_TARGETNAME xscale -endian $_ENDIAN -chain-position $_TARGETNAME -variant ipxP42x
-
|
|
From: <oh...@ma...> - 2009-03-23 20:12:43
|
Author: oharboe
Date: 2009-03-23 20:12:42 +0100 (Mon, 23 Mar 2009)
New Revision: 1427
Modified:
trunk/src/target/target/lpc2148.cfg
Log:
Uwe Hermann <uw...@he...> eal _CPUTAPID entry for the LPC2148. I don't know
if they're the same for all LPC214x, this number is from an Olimex
LPC-H2148. The chip on that board is LPC2148FBD64.
Also fix a few cosmetic issues and comments in the file and add
more docs and pointers to the datasheet.
Modified: trunk/src/target/target/lpc2148.cfg
===================================================================
--- trunk/src/target/target/lpc2148.cfg 2009-03-23 07:43:46 UTC (rev 1426)
+++ trunk/src/target/target/lpc2148.cfg 2009-03-23 19:12:42 UTC (rev 1427)
@@ -1,49 +1,51 @@
-
if { [info exists CHIPNAME] } {
- set _CHIPNAME $CHIPNAME
-} else {
- set _CHIPNAME lpc2148
+ set _CHIPNAME $CHIPNAME
+} else {
+ set _CHIPNAME lpc2148
}
-if { [info exists ENDIAN] } {
- set _ENDIAN $ENDIAN
-} else {
- set _ENDIAN little
+if { [info exists ENDIAN] } {
+ set _ENDIAN $ENDIAN
+} else {
+ set _ENDIAN little
}
if { [info exists CPUTAPID ] } {
set _CPUTAPID $CPUTAPID
} else {
- # force an error till we get a good number
- set _CPUTAPID 0xffffffff
+ set _CPUTAPID 0x4f1f0f0f
}
-#delays on reset lines
jtag_nsrst_delay 200
jtag_ntrst_delay 200
-# NOTE!!! LPCs need reset pulled while RTCK is low. 0 to activate
+# NOTE!!! LPCs need reset pulled while RTCK is low. 0 to activate
# JTAG, power-on reset is not enough, i.e. you need to perform a
-# reset before being able to talk to the LPC2148, attach is not
-# possible.
+# reset before being able to talk to the LPC2148, attach is not possible.
-#use combined on interfaces or targets that can't set TRST/SRST separately
reset_config trst_and_srst srst_pulls_trst
-#jtag scan chain
jtag newtap $_CHIPNAME cpu -irlen 4 -ircapture 0x1 -irmask 0xf -expected-id $_CPUTAPID
set _TARGETNAME [format "%s.cpu" $_CHIPNAME]
+
target create $_TARGETNAME arm7tdmi -endian $_ENDIAN -chain-position $_TARGETNAME -variant arm7tdmi-s_r4
+
$_TARGETNAME configure -work-area-virt 0 -work-area-phys 0x40000000 -work-area-size 0x4000 -work-area-backup 0
+
$_TARGETNAME configure -event reset-init {
- # Force target into ARM state
+ # Force target into ARM state.
soft_reset_halt
- #do not remap 0x0000-0x0020 to anything but the flash
- mwb 0xE01FC040 0x01
-
+
+ # Do not remap 0x0000-0x0020 to anything but the flash (i.e. select
+ # "User Flash Mode" where interrupt vectors are _not_ remapped,
+ # and reside in flash instead).
+ #
+ # See section 7.1 on page 32 ("Memory Mapping control register") in
+ # "UM10139: Volume 1: LPC214x User Manual", Rev. 02 -- 25 July 2006.
+ # http://www.standardics.nxp.com/support/documents/microcontrollers/pdf/user.manual.lpc2141.lpc2142.lpc2144.lpc2146.lpc2148.pdf
+ mwb 0xE01FC040 0x01
}
-
-#flash bank lpc2000 <base> <size> 0 0 <target#> <variant>
+# flash bank lpc2000 <base> <size> 0 0 <target#> <variant> <clock> [calc_checksum]
flash bank lpc2000 0x0 0x7d000 0 0 0 lpc2000_v2 14765
|
|
From: oharboe at B. <oh...@ma...> - 2009-03-23 08:43:47
|
Author: oharboe Date: 2009-03-23 08:43:46 +0100 (Mon, 23 Mar 2009) New Revision: 1426 Modified: trunk/doc/openocd.texi Log: Uwe Hermann <uw...@he...> - Explicitly mention autoconf >= 2.59 as requirement (as per configure.in). Also automake >= 1.9 (though I'm not sure which if that's really the minimum requirement). - Document various missing configure options. - Fix various typos and inconsistencies. Modified: trunk/doc/openocd.texi =================================================================== --- trunk/doc/openocd.texi 2009-03-23 07:38:38 UTC (rev 1425) +++ trunk/doc/openocd.texi 2009-03-23 07:43:46 UTC (rev 1426) @@ -51,7 +51,7 @@ @insertcopying @menu -* About:: About OpenOCD. +* About:: About OpenOCD * Developers:: OpenOCD Developers * Building:: Building OpenOCD * JTAG Hardware Dongles:: JTAG Hardware Dongles @@ -71,7 +71,7 @@ * TFTP:: TFTP * GDB and OpenOCD:: Using GDB and OpenOCD * Tcl Scripting API:: Tcl Scripting API -* Upgrading:: Deprecated/Removed commands +* Upgrading:: Deprecated/Removed Commands * Target Library:: Target Library * FAQ:: Frequently Asked Questions * Tcl Crash Course:: Tcl Crash Course @@ -80,7 +80,7 @@ @comment case issue with ``Index.html'' and ``index.html'' @comment Occurs when creating ``--html --no-split'' output @comment This fix is based on: http://sourceware.org/ml/binutils/2006-05/msg00215.html -* OpenOCD Index:: Main index. +* OpenOCD Index:: Main Index @end menu @node About @@ -95,17 +95,17 @@ with the JTAG (IEEE 1149.1) compliant taps on your target board. @b{Dongles:} OpenOCD currently supports many types of hardware dongles: USB -Based, Parallel Port Based, and other standalone boxes that run +based, parallel port based, and other standalone boxes that run OpenOCD internally. See the section titled: @xref{JTAG Hardware Dongles}. @b{GDB Debug:} It allows ARM7 (ARM7TDMI and ARM720t), ARM9 (ARM920T, ARM922T, ARM926EJ--S, ARM966E--S), XScale (PXA25x, IXP42x) and Cortex-M3 (Luminary Stellaris LM3 and ST STM32) based cores to be -debugged via the GDB Protocol. +debugged via the GDB protocol. @b{Flash Programing:} Flash writing is supported for external CFI compatible flashes (Intel and AMD/Spansion command set) and several -internal flashes (LPC2000, AT91SAM7, STR7x, STR9x, LM3 and +internal flashes (LPC2000, AT91SAM7, STR7x, STR9x, LM3, and STM32x). Preliminary support for using the LPC3180's NAND flash controller is included. @@ -121,7 +121,7 @@ Other developers have contributed support for additional targets and flashes as well as numerous bugfixes and enhancements. See the AUTHORS file for regular contributors. -The main OpenOCD web site is available at @uref{http://openocd.berlios.de/web/} +The main OpenOCD web site is available at @uref{http://openocd.berlios.de/web/}. @node Building @chapter Building @@ -135,7 +135,7 @@ @section Packagers Please Read! -If you are a @b{PACKAGER} of OpenOCD if you +You are a @b{PACKAGER} of OpenOCD if you @enumerate @item @b{Sell dongles} and include pre-built binaries @@ -151,31 +151,29 @@ suggestions: @enumerate -@item @b{Always build with printer ports enabled} -@item @b{Try to use LIBFTDI + LIBUSB where possible}. You cover more bases +@item @b{Always build with printer ports enabled.} +@item @b{Try to use LIBFTDI + LIBUSB where possible. You cover more bases.} @end enumerate -It is your decision.. - @itemize @bullet -@item @b{Why YES to LIBFTDI + LIBUSB} +@item @b{Why YES to LIBFTDI + LIBUSB?} @itemize @bullet @item @b{LESS} work - libusb perhaps already there -@item @b{LESS} work - identical code multiple platforms +@item @b{LESS} work - identical code, multiple platforms @item @b{MORE} dongles are supported @item @b{MORE} platforms are supported @item @b{MORE} complete solution @end itemize -@item @b{Why not LIBFTDI + LIBUSB} (i.e.: ftd2xx instead) +@item @b{Why not LIBFTDI + LIBUSB} (i.e.: ftd2xx instead)? @itemize @bullet -@item @b{LESS} Some say it is slower. +@item @b{LESS} speed - some say it is slower @item @b{LESS} complex to distribute (external dependencies) @end itemize @end itemize @section Building From Source -You can download the current SVN version with SVN client of your choice from the +You can download the current SVN version with an SVN client of your choice from the following repositories: @uref{svn://svn.berlios.de/openocd/trunk} @@ -192,8 +190,8 @@ svn checkout svn://svn.berlios.de/openocd/trunk openocd @end example -Building OpenOCD requires a recent version of the GNU autotools. -On my build system, I'm using autoconf 2.13 and automake 1.9. For building on Windows, +Building OpenOCD requires a recent version of the GNU autotools (autoconf >= 2.59 and automake >= 1.9). +For building on Windows, you have to use Cygwin. Make sure that your @env{PATH} environment variable contains no other locations with Unix utils (like UnxUtils) - these can't handle the Cygwin paths, resulting in obscure dependency errors (This is an observation I've gathered @@ -201,72 +199,93 @@ You further need the appropriate driver files, if you want to build support for a FTDI FT2232 based interface: + @itemize @bullet @item @b{ftdi2232} libftdi (@uref{http://www.intra2net.com/opensource/ftdi/}) @item @b{ftd2xx} libftd2xx (@uref{http://www.ftdichip.com/Drivers/D2XX.htm}) @item When using the Amontec JTAGkey, you have to get the drivers from the Amontec -homepage (@uref{www.amontec.com}), as the JTAGkey uses a non-standard VID/PID. +homepage (@uref{http://www.amontec.com}), as the JTAGkey uses a non-standard VID/PID. @end itemize -libftdi is supported under Windows. Do not use versions earlier then 0.14. +libftdi is supported under Windows. Do not use versions earlier than 0.14. In general, the D2XX driver provides superior performance (several times as fast), but has the draw-back of being binary-only - though that isn't that bad, as it isn't a kernel module, only a user space library. To build OpenOCD (on both Linux and Cygwin), use the following commands: + @example ./bootstrap @end example + Bootstrap generates the configure script, and prepares building on your system. + @example ./configure [options, see below] @end example + Configure generates the Makefiles used to build OpenOCD. + @example make make install @end example + Make builds OpenOCD, and places the final executable in ./src/, the last step, ``make install'' is optional. The configure script takes several options, specifying which JTAG interfaces -should be included: +should be included (among other things): @itemize @bullet @item -@option{--enable-parport} - Bit bang pc printer ports. +@option{--enable-parport} - Enable building the PC parallel port driver. @item -@option{--enable-parport_ppdev} - Parallel Port [see below] +@option{--enable-parport_ppdev} - Enable use of ppdev (/dev/parportN) for parport. @item -@option{--enable-parport_giveio} - Parallel Port [see below] +@option{--enable-parport_giveio} - Enable use of giveio for parport instead of ioperm. @item -@option{--enable-amtjtagaccel} - Parallel Port [Amontec, see below] +@option{--enable-amtjtagaccel} - Enable building the Amontec JTAG-Accelerator driver. @item -@option{--enable-ft2232_ftd2xx} - Numerous USB Type ARM JTAG dongles use the FT2232C chip from this FTDICHIP.COM chip (closed source). +@option{--enable-ecosboard} - Enable building support for eCosBoard based JTAG debugger. @item -@option{--enable-ft2232_libftdi} - An open source (free) alternate to FTDICHIP.COM ftd2xx solution (Linux, MacOS, Cygwin) +@option{--enable-ioutil} - Enable ioutil functions - useful for standalone OpenOCD implementations. @item +@option{--enable-httpd} - Enable builtin httpd server - useful for standalone OpenOCD implementations. +@item +@option{--enable-ep93xx} - Enable building support for EP93xx based SBCs. +@item +@option{--enable-at91rm9200} - Enable building support for AT91RM9200 based SBCs. +@item +@option{--enable-gw16012} - Enable building support for the Gateworks GW16012 JTAG programmer. +@item +@option{--enable-ft2232_ftd2xx} - Numerous USB type ARM JTAG dongles use the FT2232C chip from this FTDICHIP.COM chip (closed source). +@item +@option{--enable-ft2232_libftdi} - An open source (free) alternative to FTDICHIP.COM ftd2xx solution (Linux, MacOS, Cygwin). +@item @option{--with-ftd2xx-win32-zipdir=PATH} - If using FTDICHIP.COM ft2232c, point at the directory where the Win32 FTDICHIP.COM 'CDM' driver zip file was unpacked. @item -@option{--with-ftd2xx-linux-tardir=PATH} - Linux only equal of @option{--with-ftd2xx-win32-zipdir}, where you unpacked the TAR.GZ file. +@option{--with-ftd2xx-linux-tardir=PATH} - Linux only. Equivalent of @option{--with-ftd2xx-win32-zipdir}, where you unpacked the TAR.GZ file. @item -@option{--with-ftd2xx-lib=shared|static} - Linux only. Default: static, specifies how the FTDICHIP.COM libftd2xx driver should be linked. Note 'static' only works in conjunction with @option{--with-ftd2xx-linux-tardir}. Shared is supported (12/26/2008), however you must manually install the required header files and shared libraries in an appropriate place. This uses ``libusb'' internally. +@option{--with-ftd2xx-lib=shared|static} - Linux only. Default: static. Specifies how the FTDICHIP.COM libftd2xx driver should be linked. Note: 'static' only works in conjunction with @option{--with-ftd2xx-linux-tardir}. The 'shared' value is supported (12/26/2008), however you must manually install the required header files and shared libraries in an appropriate place. This uses ``libusb'' internally. @item -@option{--enable-gw16012} +@option{--enable-presto_libftdi} - Enable building support for ASIX Presto programmer using the libftdi driver. @item -@option{--enable-usbprog} +@option{--enable-presto_ftd2xx} - Enable building support for ASIX Presto programmer using the FTD2XX driver. @item -@option{--enable-presto_libftdi} +@option{--enable-usbprog} - Enable building support for the USBprog JTAG programmer. @item -@option{--enable-presto_ftd2xx} +@option{--enable-oocd_trace} - Enable building support for the OpenOCD+trace ETM capture device. @item -@option{--enable-jlink} - From SEGGER +@option{--enable-jlink} - Enable building support for the Segger J-Link JTAG programmer. @item -@option{--enable-vsllink} +@option{--enable-vsllink} - Enable building support for the Versaloon-Link JTAG programmer. @item -@option{--enable-rlink} - Raisonance.com dongle. +@option{--enable-rlink} - Enable building support for the Raisonance RLink JTAG programmer. @item -@option{--enable-arm-jtag-ew} - Olimex ARM-JTAG-EW dongle. +@option{--enable-arm-jtag-ew} - Enable building support for the Olimex ARM-JTAG-EW programmer. +@item +@option{--enable-dummy} - Enable building the dummy port driver. @end itemize @section Parallel Port Dongles @@ -276,6 +295,9 @@ the @option{--enable-parport_ppdev} option actually is an option to the parport driver (see @uref{http://forum.sparkfun.com/viewtopic.php?t=3795} for more info). +The same is true for the @option{--enable-parport_giveio} option, you have to +use both the @option{--enable-parport} AND the @option{--enable-parport_giveio} option if you want to use giveio instead of ioperm parallel port access method. + @section FT2232C Based USB Dongles There are 2 methods of using the FTD2232, either (1) using the @@ -292,51 +314,53 @@ 1) Check out the latest version of ``openocd'' from SVN. -2) Download & Unpack either the Windows or Linux FTD2xx Drivers - (@uref{http://www.ftdichip.com/Drivers/D2XX.htm}) +2) Download & unpack either the Windows or Linux FTD2xx drivers + (@uref{http://www.ftdichip.com/Drivers/D2XX.htm}). @example /home/duane/ftd2xx.win32 => the Cygwin/Win32 ZIP file contents. - /home/duane/libftd2xx0.4.16 => the Linux TAR file contents. + /home/duane/libftd2xx0.4.16 => the Linux TAR.GZ file contents. @end example 3) Configure with these options: @example -Cygwin FTCICHIP solution - ./configure --prefix=/home/duane/mytools \ - --enable-ft2232_ftd2xx \ - --with-ftd2xx-win32-zipdir=/home/duane/ftd2xx.win32 +Cygwin FTDICHIP solution: + ./configure --prefix=/home/duane/mytools \ + --enable-ft2232_ftd2xx \ + --with-ftd2xx-win32-zipdir=/home/duane/ftd2xx.win32 -Linux FTDICHIP solution +Linux FTDICHIP solution: ./configure --prefix=/home/duane/mytools \ - --enable-ft2232_ftd2xx \ - --with-ft2xx-linux-tardir=/home/duane/libftd2xx0.4.16 + --enable-ft2232_ftd2xx \ + --with-ft2xx-linux-tardir=/home/duane/libftd2xx0.4.16 -Cygwin/Linux LIBFTDI solution +Cygwin/Linux LIBFTDI solution: Assumes: 1a) For Windows: The Windows port of LIBUSB is in place. - 1b) For Linux: libusb has been built and is inplace. + 1b) For Linux: libusb has been built/installed and is in place. 2) And libftdi has been built and installed Note: libftdi - relies upon libusb. ./configure --prefix=/home/duane/mytools \ - --enable-ft2232_libftdi + --enable-ft2232_libftdi @end example 4) Then just type ``make'', and perhaps ``make install''. -@section Miscellaneous configure options +@section Miscellaneous Configure Options @itemize @bullet @item -@option{--enable-gccwarnings} - enable extra gcc warnings during build. +@option{--disable-option-checking} - Ignore unrecognized @option{--enable} and @option{--with} options. +@item +@option{--enable-gccwarnings} - Enable extra gcc warnings during build. Default is enabled. @item -@option{--enable-release} - enable building of a openocd release, generally +@option{--enable-release} - Enable building of an OpenOCD release, generally this is for developers. It simply omits the svn version string when the openocd @option{-v} is executed. @end itemize |
|
From: oharboe at B. <oh...@ma...> - 2009-03-23 08:38:39
|
Author: oharboe Date: 2009-03-23 08:38:38 +0100 (Mon, 23 Mar 2009) New Revision: 1425 Modified: trunk/src/target/target/omap5912.cfg Log: Uwe Hermann <uw...@he...> typo Modified: trunk/src/target/target/omap5912.cfg =================================================================== --- trunk/src/target/target/omap5912.cfg 2009-03-20 14:30:41 UTC (rev 1424) +++ trunk/src/target/target/omap5912.cfg 2009-03-23 07:38:38 UTC (rev 1425) @@ -57,7 +57,7 @@ } # omap5912 lcd frame buffer as working area -$_TARGENAME configure -work-area-virt 0 -work-area-phys 0x20000000 -work-area-size 0x3e800 -work-area-backup 0 +$_TARGETNAME configure -work-area-virt 0 -work-area-phys 0x20000000 -work-area-size 0x3e800 -work-area-backup 0 #flash bank <driver> <base> <size> <chip_width> <bus_width> flash bank cfi 0x00000000 0x1000000 2 2 0 |
|
From: ntfreak at B. <nt...@ma...> - 2009-03-20 15:30:42
|
Author: ntfreak
Date: 2009-03-20 15:30:41 +0100 (Fri, 20 Mar 2009)
New Revision: 1424
Modified:
trunk/src/target/target/str9comstick.cfg
Log:
- fix another typo in str9comstick.cfg
Modified: trunk/src/target/target/str9comstick.cfg
===================================================================
--- trunk/src/target/target/str9comstick.cfg 2009-03-20 14:08:03 UTC (rev 1423)
+++ trunk/src/target/target/str9comstick.cfg 2009-03-20 14:30:41 UTC (rev 1424)
@@ -34,7 +34,7 @@
} else {
set _CPUTAPID 0x25966041
}
-jtag newtap $_CHIPNAME cpu -irlen 4 -ircapture 0xf -irmask 0xf -expected-id $_CPUTAPID
+jtag newtap $_CHIPNAME cpu -irlen 4 -ircapture 0x1 -irmask 0xf -expected-id $_CPUTAPID
if { [info exists BSTAPID ] } {
set _BSTAPID $BSTAPID
|
|
From: ntfreak at B. <nt...@ma...> - 2009-03-20 15:08:04
|
Author: ntfreak
Date: 2009-03-20 15:08:03 +0100 (Fri, 20 Mar 2009)
New Revision: 1423
Modified:
trunk/src/target/target/imx35.cfg
Log:
- add missing svn props from previous commit
Modified: trunk/src/target/target/imx35.cfg
===================================================================
--- trunk/src/target/target/imx35.cfg 2009-03-20 13:27:02 UTC (rev 1422)
+++ trunk/src/target/target/imx35.cfg 2009-03-20 14:08:03 UTC (rev 1423)
@@ -1,50 +1,50 @@
-# imx35 config
-#
-
-if { [info exists CHIPNAME] } {
- set _CHIPNAME $CHIPNAME
-} else {
- set _CHIPNAME imx35
-}
-
-if { [info exists ENDIAN] } {
- set _ENDIAN $ENDIAN
-} else {
- set _ENDIAN little
-}
-
-if { [info exists CPUTAPID ] } {
- set _CPUTAPID $CPUTAPID
-} else {
- set _CPUTAPID 0x07b3601d
-}
-
-if { [info exists SDMATAPID ] } {
- set _SDMATAPID $SDMATAPID
-} else {
- set _SDMATAPID 0x0882601d
-}
-
-#========================================
-# The "system jtag controller"
-# IMX31 reference manual, page 6-28 - figure 6-14
-if { [info exists SJCTAPID ] } {
- set _SJCTAPID $SJCTAPID
-} else {
- set _SJCTAPID 0x2b900f0f
-}
-
-jtag newtap $_CHIPNAME sjc -irlen 4 -ircapture 0x0 -irmask 0x0 -expected-id $_SJCTAPID
-
-jtag newtap $_CHIPNAME cpu -irlen 5 -ircapture 0x1 -irmask 0x1f -expected-id $_CPUTAPID
-
-# No IDCODE for this TAP
-jtag newtap $_CHIPNAME whatchacallit -irlen 4 -ircapture 0 -irmask 0x0 -expected-id 0x0
-
-jtag newtap $_CHIPNAME smda -irlen 5 -ircapture 0x1 -irmask 0x1f -expected-id $_SDMATAPID
-
-set _TARGETNAME [format "%s.cpu" $_CHIPNAME]
-target create $_TARGETNAME arm11 -endian $_ENDIAN -chain-position $_TARGETNAME
-
-proc power_restore {} { puts "Sensed power restore. No action." }
-proc srst_deasserted {} { puts "Sensed nSRST deasserted. No action." }
+# imx35 config
+#
+
+if { [info exists CHIPNAME] } {
+ set _CHIPNAME $CHIPNAME
+} else {
+ set _CHIPNAME imx35
+}
+
+if { [info exists ENDIAN] } {
+ set _ENDIAN $ENDIAN
+} else {
+ set _ENDIAN little
+}
+
+if { [info exists CPUTAPID ] } {
+ set _CPUTAPID $CPUTAPID
+} else {
+ set _CPUTAPID 0x07b3601d
+}
+
+if { [info exists SDMATAPID ] } {
+ set _SDMATAPID $SDMATAPID
+} else {
+ set _SDMATAPID 0x0882601d
+}
+
+#========================================
+# The "system jtag controller"
+# IMX31 reference manual, page 6-28 - figure 6-14
+if { [info exists SJCTAPID ] } {
+ set _SJCTAPID $SJCTAPID
+} else {
+ set _SJCTAPID 0x2b900f0f
+}
+
+jtag newtap $_CHIPNAME sjc -irlen 4 -ircapture 0x0 -irmask 0x0 -expected-id $_SJCTAPID
+
+jtag newtap $_CHIPNAME cpu -irlen 5 -ircapture 0x1 -irmask 0x1f -expected-id $_CPUTAPID
+
+# No IDCODE for this TAP
+jtag newtap $_CHIPNAME whatchacallit -irlen 4 -ircapture 0 -irmask 0x0 -expected-id 0x0
+
+jtag newtap $_CHIPNAME smda -irlen 5 -ircapture 0x1 -irmask 0x1f -expected-id $_SDMATAPID
+
+set _TARGETNAME [format "%s.cpu" $_CHIPNAME]
+target create $_TARGETNAME arm11 -endian $_ENDIAN -chain-position $_TARGETNAME
+
+proc power_restore {} { puts "Sensed power restore. No action." }
+proc srst_deasserted {} { puts "Sensed nSRST deasserted. No action." }
Property changes on: trunk/src/target/target/imx35.cfg
___________________________________________________________________
Name: svn:eol-style
+ native
|
|
From: ntfreak at B. <nt...@ma...> - 2009-03-20 14:27:04
|
Author: ntfreak
Date: 2009-03-20 14:27:02 +0100 (Fri, 20 Mar 2009)
New Revision: 1422
Modified:
trunk/configure.in
trunk/doc/openocd.texi
Log:
- docs patch from Thomas Kindler
Modified: trunk/configure.in
===================================================================
--- trunk/configure.in 2009-03-20 12:32:17 UTC (rev 1421)
+++ trunk/configure.in 2009-03-20 13:27:02 UTC (rev 1422)
@@ -80,7 +80,7 @@
# Option Given.
cat << __EOF__
-The option: --with-ftd2xx=<PATH> has been removed replaced.
+The option: --with-ftd2xx=<PATH> has been removed.
On Linux, the new option is:
--with-ftd2xx-linux-tardir=/path/to/files
Modified: trunk/doc/openocd.texi
===================================================================
--- trunk/doc/openocd.texi 2009-03-20 12:32:17 UTC (rev 1421)
+++ trunk/doc/openocd.texi 2009-03-20 13:27:02 UTC (rev 1422)
@@ -52,7 +52,7 @@
@menu
* About:: About OpenOCD.
-* Developers:: OpenOCD developers
+* Developers:: OpenOCD Developers
* Building:: Building OpenOCD
* JTAG Hardware Dongles:: JTAG Hardware Dongles
* Running:: Running OpenOCD
@@ -70,11 +70,11 @@
* Sample Scripts:: Sample Target Scripts
* TFTP:: TFTP
* GDB and OpenOCD:: Using GDB and OpenOCD
-* TCL scripting API:: Tcl scripting API
-* Upgrading:: Deprecated/Removed Commands
-* Target library:: Target library
+* Tcl Scripting API:: Tcl Scripting API
+* Upgrading:: Deprecated/Removed commands
+* Target Library:: Target Library
* FAQ:: Frequently Asked Questions
-* TCL Crash Course:: TCL Crash Course
+* Tcl Crash Course:: Tcl Crash Course
* License:: GNU Free Documentation License
@comment DO NOT use the plain word ``Index'', reason: CYGWIN filename
@comment case issue with ``Index.html'' and ``index.html''
@@ -92,14 +92,14 @@
devices.
@b{JTAG:} OpenOCD uses a ``hardware interface dongle'' to communicate
-with the JTAG (IEEE 1149.1) complient taps on your target board.
+with the JTAG (IEEE 1149.1) compliant taps on your target board.
-@b{Dongles:} OpenOCD currently many types of hardware dongles: USB
+@b{Dongles:} OpenOCD currently supports many types of hardware dongles: USB
Based, Parallel Port Based, and other standalone boxes that run
OpenOCD internally. See the section titled: @xref{JTAG Hardware Dongles}.
-@b{GDB Debug:} It allows ARM7 (ARM7TDMI and ARM720t), ARM9 (ARM920t,
-ARM922t, ARM926ej--s, ARM966e--s), XScale (PXA25x, IXP42x) and
+@b{GDB Debug:} It allows ARM7 (ARM7TDMI and ARM720t), ARM9 (ARM920T,
+ARM922T, ARM926EJ--S, ARM966E--S), XScale (PXA25x, IXP42x) and
Cortex-M3 (Luminary Stellaris LM3 and ST STM32) based cores to be
debugged via the GDB Protocol.
@@ -139,9 +139,9 @@
@enumerate
@item @b{Sell dongles} and include pre-built binaries
-@item @b{Supply tools} ie: A complete development solution
+@item @b{Supply tools} i.e.: A complete development solution
@item @b{Supply IDEs} like Eclipse, or RHIDE, etc.
-@item @b{Build packages} ie: RPM files, or DEB files for a Linux Distro
+@item @b{Build packages} i.e.: RPM files, or DEB files for a Linux Distro
@end enumerate
As a @b{PACKAGER} - you are at the top of the food chain. You solve
@@ -151,8 +151,8 @@
suggestions:
@enumerate
-@item @b{Always build with Printer Ports Enabled}
-@item @b{Try where possible to use LIBFTDI + LIBUSB} You cover more bases
+@item @b{Always build with printer ports enabled}
+@item @b{Try to use LIBFTDI + LIBUSB where possible}. You cover more bases
@end enumerate
It is your decision..
@@ -166,7 +166,7 @@
@item @b{MORE} platforms are supported
@item @b{MORE} complete solution
@end itemize
-@item @b{Why not LIBFTDI + LIBUSB} (ie: ftd2xx instead)
+@item @b{Why not LIBFTDI + LIBUSB} (i.e.: ftd2xx instead)
@itemize @bullet
@item @b{LESS} Some say it is slower.
@item @b{LESS} complex to distribute (external dependencies)
@@ -178,11 +178,11 @@
You can download the current SVN version with SVN client of your choice from the
following repositories:
- (@uref{svn://svn.berlios.de/openocd/trunk})
+ @uref{svn://svn.berlios.de/openocd/trunk}
or
- (@uref{http://svn.berlios.de/svnroot/repos/openocd/trunk})
+ @uref{http://svn.berlios.de/svnroot/repos/openocd/trunk}
Using the SVN command line client, you can use the following command to fetch the
latest version (make sure there is no (non-svn) directory called "openocd" in the
@@ -208,7 +208,7 @@
homepage (@uref{www.amontec.com}), as the JTAGkey uses a non-standard VID/PID.
@end itemize
-libftdi is supported under windows. Do not use versions earlier then 0.14.
+libftdi is supported under Windows. Do not use versions earlier then 0.14.
In general, the D2XX driver provides superior performance (several times as fast),
but has the draw-back of being binary-only - though that isn't that bad, as it isn't
@@ -282,7 +282,7 @@
FTDICHIP.COM closed source driver, or (2) the open (and free) driver
libftdi. Some claim the (closed) FTDICHIP.COM solution is faster.
-The FTDICHIP drivers come as either a (win32) ZIP file, or a (linux)
+The FTDICHIP drivers come as either a (win32) ZIP file, or a (Linux)
TAR.GZ file. You must unpack them ``some where'' convient. As of this
writing (12/26/2008) FTDICHIP does not supply means to install these
files ``in an appropriate place'' As a result, there are two
@@ -315,7 +315,7 @@
Cygwin/Linux LIBFTDI solution
Assumes:
- 1a) For Windows: The windows port of LIBUSB is in place.
+ 1a) For Windows: The Windows port of LIBUSB is in place.
1b) For Linux: libusb has been built and is inplace.
2) And libftdi has been built and installed
@@ -344,11 +344,11 @@
@node JTAG Hardware Dongles
@chapter JTAG Hardware Dongles
@cindex dongles
-@cindex ftdi
+@cindex FTDI
@cindex wiggler
@cindex zy1000
@cindex printer port
-@cindex usb adapter
+@cindex USB Adapter
@cindex rtck
Defined: @b{dongle}: A small device that plugins into a computer and serves as
@@ -378,7 +378,7 @@
@section USB FT2232 Based
-There are many USB jtag dongles on the market, many of them are based
+There are many USB JTAG dongles on the market, many of them are based
on a chip from ``Future Technology Devices International'' (FTDI)
known as the FTDI FT2232.
@@ -505,7 +505,7 @@
@itemize @bullet
@item @b{ep93xx}
-@* An EP93xx based linux machine using the GPIO pins directly.
+@* An EP93xx based Linux machine using the GPIO pins directly.
@item @b{at91rm9200}
@* Like the EP93xx - but an ATMEL AT91RM9200 based solution using the GPIO pins on the chip.
@@ -589,8 +589,8 @@
@section Small configuration file method
-This is the prefered method, it is simple and is works well for many
-people. The developers of OpenOCD would encourage you to use this
+This is the preferred method. It is simple and works well for many
+people. The developers of OpenOCD would encourage you to use this
method. If you create a new configuration please email new
configurations to the development list.
@@ -663,10 +663,10 @@
Some key things you should look at and understand are:
@enumerate
-@item The RESET configuration of your debug environment as a hole
+@item The reset configuration of your debug environment as a whole
@item Is there a ``work area'' that OpenOCD can use?
@* For ARM - work areas mean up to 10x faster downloads.
-@item For MMU/MPU based ARM chips (ie: ARM9 and later) will that work area still be available?
+@item For MMU/MPU based ARM chips (i.e.: ARM9 and later) will that work area still be available?
@item For complex targets (multiple chips) the JTAG SPEED becomes an issue.
@end enumerate
@@ -679,26 +679,25 @@
OpenOCD. These are guidelines for creating new boards and new target
configurations as of 28/Nov/2008.
-However, you the user of OpenOCD should be some what familiar with
+However, you, the user of OpenOCD, should be somewhat familiar with
this section as it should help explain some of the internals of what
you might be looking at.
-The user should find under @t{$(INSTALLDIR)/lib/openocd} the
-following directories:
+The user should find the following directories under @t{$(INSTALLDIR)/lib/openocd} :
@itemize @bullet
@item @b{interface}
-@*Think JTAG Dongle. Files that configure the jtag dongle go here.
+@*Think JTAG Dongle. Files that configure the JTAG dongle go here.
@item @b{board}
-@* Thing Circuit Board, PWA, PCB, they go by many names. Board files
+@* Think Circuit Board, PWA, PCB, they go by many names. Board files
contain initialization items that are specific to a board - for
example: The SDRAM initialization sequence for the board, or the type
of external flash and what address it is found at. Any initialization
-sequence to enable that external flash or sdram should be found in the
-board file. Boards may also contain multiple targets, ie: Two cpus, or
+sequence to enable that external flash or SDRAM should be found in the
+board file. Boards may also contain multiple targets, i.e.: Two CPUs, or
a CPU and an FPGA or CPLD.
@item @b{target}
-@* Think CHIP. The ``target'' directory represents a jtag tap (or
+@* Think chip. The ``target'' directory represents a JTAG tap (or
chip) OpenOCD should control, not a board. Two common types of targets
are ARM chips and FPGA or CPLD chips.
@end itemize
@@ -722,7 +721,7 @@
today, that said, perhaps some interfaces have only been used by the
sole developer who created it.
-@b{FIXME/NOTE:} We need to add support for a variable like TCL variable
+@b{FIXME/NOTE:} We need to add support for a variable like Tcl variable
tcl_platform(platform), it should be called jim_platform (because it
is jim, not real tcl) and it should contain 1 of 3 words: ``linux'',
``cygwin'' or ``mingw''
@@ -745,12 +744,12 @@
The board file should contain one or more @t{source [find
target/FOO.cfg]} statements along with any board specific things.
-In summery the board files should contain (if present)
+In summary the board files should contain (if present)
@enumerate
-@item External flash configuration (ie: the flash on CS0)
-@item SDRAM configuration (size, speed, etc)
-@item Board specific IO configuration (ie: GPIO pins might disable a 2nd flash)
+@item External flash configuration (i.e.: the flash on CS0)
+@item SDRAM configuration (size, speed, etc.
+@item Board specific IO configuration (i.e.: GPIO pins might disable a 2nd flash)
@item Multiple TARGET source statements
@item All things that are not ``inside a chip''
@item Things inside a chip go in a 'target' file
@@ -766,15 +765,15 @@
openocd -f target/FOOBAR.cfg
@end example
-In summery the target files should contain
+In summary the target files should contain
@enumerate
-@item Set Defaults
-@item Create Taps
-@item Reset Configuration
-@item Work Areas
-@item CPU/Chip/CPU-Core Specific features
-@item OnChip Flash
+@item Set defaults
+@item Create taps
+@item Reset configuration
+@item Work areas
+@item CPU/Chip/CPU-Core specific features
+@item On-Chip flash
@end enumerate
@subsection Important variable names
@@ -793,8 +792,8 @@
@* When OpenOCD examines the JTAG chain, it will attempt to identify
every chip. If the @t{-expected-id} is nonzero, OpenOCD attempts
to verify the tap id number verses configuration file and may issue an
-error or warning like this. The hope is this will help pin point
-problem OpenOCD configurations.
+error or warning like this. The hope is that this will help to pinpoint
+problems in OpenOCD configurations.
@example
Info: JTAG tap: sam7x256.cpu tap/device found: 0x3f0f0f0f (Manufacturer: 0x787, Part: 0xf0f0, Version: 0x3)
@@ -830,12 +829,12 @@
@end itemize
-@subsection TCL Variables Guide Line
+@subsection Tcl Variables Guide Line
The Full Tcl/Tk language supports ``namespaces'' - JIM-Tcl does not.
Thus the rule we follow in OpenOCD is this: Variables that begin with
-a leading underscore are temporal in nature, and can be modified and
-used at will within a ?TARGET? configuration file
+a leading underscore are temporary in nature, and can be modified and
+used at will within a ?TARGET? configuration file.
@b{EXAMPLE:} The user should be able to do this:
@@ -849,14 +848,14 @@
source [find target/pxa270.cfg]
# variable: _TARGETNAME = network.cpu
# other commands can refer to the "network.cpu" tap.
- $_TARGETNAME configure .... params for this cpu..
+ $_TARGETNAME configure .... params for this CPU..
set ENDIAN little
set CHIPNAME video
source [find target/pxa270.cfg]
# variable: _TARGETNAME = video.cpu
# other commands can refer to the "video.cpu" tap.
- $_TARGETNAME configure .... params for this cpu..
+ $_TARGETNAME configure .... params for this CPU..
unset ENDIAN
set CHIPNAME xilinx
@@ -896,7 +895,7 @@
@end example
@subsection Creating Taps
-After the ``defaults'' are choosen, [see above], the taps are created.
+After the ``defaults'' are choosen [see above] the taps are created.
@b{SIMPLE example:} such as an Atmel AT91SAM7X256
@@ -943,7 +942,7 @@
@b{Tap Naming Convention}
-See the command ``jtag newtap'' for detail, but in breif the names you should use are:
+See the command ``jtag newtap'' for detail, but in brief the names you should use are:
@itemize @bullet
@item @b{tap}
@@ -963,20 +962,20 @@
@subsection Work Areas
Work areas are small RAM areas used by OpenOCD to speed up downloads,
-and to download small snippits of code to program flash chips.
+and to download small snippets of code to program flash chips.
-If the chip includes an form of ``on-chip-ram'' - and many do - define
+If the chip includes a form of ``on-chip-ram'' - and many do - define
a reasonable work area and use the ``backup'' option.
@b{PROBLEMS:} On more complex chips, this ``work area'' may become
-inaccessable if/when the application code enables or disables the MMU.
+inaccessible if/when the application code enables or disables the MMU.
@subsection ARM Core Specific Hacks
-If the chip has a DCC, enable it. If the chip is an arm9 with some
-special high speed download - enable it.
+If the chip has a DCC, enable it. If the chip is an ARM9 with some
+special high speed download features - enable it.
-If the chip has an ARM ``vector catch'' feature - by defeault enable
+If the chip has an ARM ``vector catch'' feature - by default enable
it for Undefined Instructions, Data Abort, and Prefetch Abort, if the
user is really writing a handler for those situations - they can
easily disable it. Experiance has shown the ``vector catch'' is
@@ -1010,31 +1009,31 @@
learn more about JIM here: @url{http://jim.berlios.de}
@itemize @bullet
-@item @b{JIM vrs TCL}
+@item @b{JIM vs. Tcl}
@* JIM-TCL is a stripped down version of the well known Tcl language,
which can be found here: @url{http://www.tcl.tk}. JIM-Tcl has far
fewer features. JIM-Tcl is a single .C file and a single .H file and
-impliments the basic TCL command set along. In contrast: Tcl 8.6 is a
-4.2MEG zip file containing 1540 files.
+impliments the basic Tcl command set along. In contrast: Tcl 8.6 is a
+4.2 MB .zip file containing 1540 files.
@item @b{Missing Features}
-@* Our practice has been: Add/clone the Real TCL feature if/when
+@* Our practice has been: Add/clone the real Tcl feature if/when
needed. We welcome JIM Tcl improvements, not bloat.
@item @b{Scripts}
@* OpenOCD configuration scripts are JIM Tcl Scripts. OpenOCD's
-command interpretor today (28/nov/2008) is a mixture of (newer)
-JIM-Tcl commands, and (older) the orginal command interpretor.
+command interpreter today (28/nov/2008) is a mixture of (newer)
+JIM-Tcl commands, and (older) the orginal command interpreter.
@item @b{Commands}
@* At the OpenOCD telnet command line (or via the GDB mon command) one
can type a Tcl for() loop, set variables, etc.
@item @b{Historical Note}
-@* JIM-Tcl was introduced to OpenOCD in Spring 2008.
+@* JIM-Tcl was introduced to OpenOCD in spring 2008.
-@item @b{Need a Crash Course In TCL?}
-@* See: @xref{TCL Crash Course}.
+@item @b{Need a crash course in Tcl?}
+@* See: @xref{Tcl Crash Course}.
@end itemize
@@ -1071,9 +1070,9 @@
@item @b{tcl_port} <@var{number}>
@cindex tcl_port
@*Intended as a machine interface. Port on which to listen for
-incoming TCL syntax. This port is intended as a simplified RPC
+incoming Tcl syntax. This port is intended as a simplified RPC
connection that can be used by clients to issue commands and get the
-output from the TCL engine.
+output from the Tcl engine.
@item @b{gdb_port} <@var{number}>
@cindex gdb_port
@@ -1097,14 +1096,14 @@
@item @b{gdb_detach} <@var{resume|reset|halt|nothing}>
@cindex gdb_detach
-@*Configures what OpenOCD will do when gdb detaches from the daemon.
+@*Configures what OpenOCD will do when GDB detaches from the daemon.
Default behaviour is <@var{resume}>
@item @b{gdb_memory_map} <@var{enable|disable}>
@cindex gdb_memory_map
-@*Set to <@var{enable}> to cause OpenOCD to send the memory configuration to gdb when
-requested. gdb will then know when to set hardware breakpoints, and program flash
-using the gdb load command. @option{gdb_flash_program enable} will also need enabling
+@*Set to <@var{enable}> to cause OpenOCD to send the memory configuration to GDB when
+requested. GDB will then know when to set hardware breakpoints, and program flash
+using the GDB load command. @option{gdb_flash_program enable} must also be enabled
for flash programming to work.
Default behaviour is <@var{enable}>
@xref{gdb_flash_program}.
@@ -1153,10 +1152,10 @@
@verbatim
interface arm-jtag-ew
@end verbatim
-@section Interface Conmmand
+@section Interface Command
-The interface command tells OpenOCD what type of jtag dongle you are
-using. Depending upon the type of dongle, you may need to have one or
+The interface command tells OpenOCD what type of JTAG dongle you are
+using. Depending on the type of dongle, you may need to have one or
more additional commands.
@itemize @bullet
@@ -1194,16 +1193,16 @@
@* Gateworks GW16012 JTAG programmer.
@item @b{jlink}
-@* Segger jlink usb adapter
+@* Segger jlink USB adapter
@item @b{rlink}
-@* Raisonance RLink usb adapter
+@* Raisonance RLink USB adapter
@item @b{vsllink}
@* vsllink is part of Versaloon which is a versatile USB programmer.
@item @b{arm-jtag-ew}
-@* Olimex ARM-JTAG-EW usb adapter
+@* Olimex ARM-JTAG-EW USB adapter
@comment - End parameters
@end itemize
@comment - End Interface
@@ -1283,7 +1282,7 @@
specified, the FTDI default value is used. This setting is only valid
if compiled with FTD2XX support.
-@b{TODO:} Confirm the following: On windows the name needs to end with
+@b{TODO:} Confirm the following: On Windows the name needs to end with
a ``space A''? Or not? It has to do with the FTD2xx driver. When must
this be added and when must it not be added? Why can't the code in the
interface or in OpenOCD automatically add this if needed? -- Duane.
@@ -1300,7 +1299,7 @@
@item @b{usbjtag}
"USBJTAG-1" layout described in the original OpenOCD diploma thesis
@item @b{jtagkey}
-Amontec JTAGkey and JTAGkey-tiny
+Amontec JTAGkey and JTAGkey-Tiny
@item @b{signalyzer}
Signalyzer
@item @b{olimex-jtag}
@@ -1326,17 +1325,17 @@
@item @b{ft2232_vid_pid} <@var{vid}> <@var{pid}>
@*The vendor ID and product ID of the FTDI FT2232 device. If not specified, the FTDI
-default values are used. Multiple <@var{vid}>, <@var{pid}> pairs may be given, eg.
+default values are used. Multiple <@var{vid}>, <@var{pid}> pairs may be given, e.g.
@example
ft2232_vid_pid 0x0403 0xcff8 0x15ba 0x0003
@end example
@item @b{ft2232_latency} <@var{ms}>
-@*On some systems using ft2232 based JTAG interfaces the FT_Read function call in
+@*On some systems using FT2232 based JTAG interfaces the FT_Read function call in
ft2232_read() fails to return the expected number of bytes. This can be caused by
USB communication delays and has proved hard to reproduce and debug. Setting the
-FT2232 latency timer to a larger value increases delays for short USB packages but it
+FT2232 latency timer to a larger value increases delays for short USB packets but it
also reduces the risk of timeouts before receiving the expected number of bytes.
-The OpenOCD default value is 2 and for some systems a value of 10 has proved useful.
+The OpenOCD default value is 2 and for some systems a value of 10 has proved useful.
@end itemize
@subsection ep93xx options
@@ -1349,9 +1348,9 @@
@cindex jtag_khz
It is debatable if this command belongs here - or in a board
-configuration file. In fact, in some situations the jtag speed is
-changed during the target initialization process (ie: (1) slow at
-reset, (2) program the cpu clocks, (3) run fast)
+configuration file. In fact, in some situations the JTAG speed is
+changed during the target initialisation process (i.e.: (1) slow at
+reset, (2) program the CPU clocks, (3) run fast)
Speed 0 (khz) selects RTCK method. A non-zero speed is in KHZ. Hence: 3000 is 3mhz.
@@ -1359,11 +1358,11 @@
support the rate asked for, or can not translate from kHz to
jtag_speed, then an error is returned.
-Make sure the jtag clock is no more than @math{1/6th CPU-Clock}. This is
+Make sure the JTAG clock is no more than @math{1/6th CPU-Clock}. This is
especially true for synthesized cores (-S). Also see RTCK.
@b{NOTE: Script writers} If the target chip requires/uses RTCK -
-please use the command: 'jtag_rclk FREQ'. This TCL proc (in
+please use the command: 'jtag_rclk FREQ'. This Tcl proc (in
startup.tcl) attempts to enable RTCK, if that fails it falls back to
the specified frequency.
@@ -1372,7 +1371,7 @@
jtag_rclk 3000
@end example
-@item @b{DEPRICATED} @b{jtag_speed} - please use jtag_khz above.
+@item @b{DEPRECATED} @b{jtag_speed} - please use jtag_khz above.
@cindex jtag_speed
@*Limit the maximum speed of the JTAG interface. Usually, a value of zero means maximum
speed. The actual effect of this option depends on the JTAG interface used.
@@ -1394,7 +1393,7 @@
@node Reset Configuration
@chapter Reset Configuration
-@cindex reset configuration
+@cindex Reset Configuration
Every system configuration may require a different reset
configuration. This can also be quite confusing. Please see the
@@ -1416,7 +1415,7 @@
@section reset_config
-@b{Note:} To maintainer types and integrators. Where exactly the
+@b{Note:} To maintainers and integrators: Where exactly the
``reset configuration'' goes is a good question. It touches several
things at once. In the end, if you have a board file - the board file
should define it and assume 100% that the DONGLE supports
@@ -1426,17 +1425,17 @@
@* @b{Problems:}
@enumerate
-@item Every JTAG Dongle is slightly different, some dongles impliment reset differently.
+@item Every JTAG Dongle is slightly different, some dongles implement reset differently.
@item Every board is also slightly different; some boards tie TRST and SRST together.
@item Every chip is slightly different; some chips internally tie the two signals together.
-@item Some may not impliment all of the signals the same way.
+@item Some may not implement all of the signals the same way.
@item Some signals might be push-pull, others open-drain/collector.
@end enumerate
@b{Best Case:} OpenOCD can hold the SRST (push-button-reset), then
reset the TAP via TRST and send commands through the JTAG tap to halt
the CPU at the reset vector before the 1st instruction is executed,
and finally release the SRST signal.
-@*Depending upon your board vendor, your chip vendor, etc, these
+@*Depending on your board vendor, chip vendor, etc., these
signals may have slightly different names.
OpenOCD defines these signals in these terms:
@@ -1459,11 +1458,11 @@
[@var{combination}] is an optional value specifying broken reset
signal implementations. @option{srst_pulls_trst} states that the
-testlogic is reset together with the reset of the system (e.g. Philips
+test logic is reset together with the reset of the system (e.g. Philips
LPC2000, "broken" board layout), @option{trst_pulls_srst} says that
the system is reset together with the test logic (only hypothetical, I
haven't seen hardware with such a bug, and can be worked around).
-@option{combined} imples both @option{srst_pulls_trst} and
+@option{combined} implies both @option{srst_pulls_trst} and
@option{trst_pulls_srst}. The default behaviour if no option given is
@option{separate}.
@@ -1498,7 +1497,7 @@
@itemize @bullet
@item @b{Debug Target} A tap can be used by a GDB debug target
@item @b{Flash Programing} Some chips program the flash via JTAG
-@item @b{Boundry Scan} Some chips support boundry scan.
+@item @b{Boundry Scan} Some chips support boundary scan.
@end itemize
@@ -1542,12 +1541,12 @@
@itemize @bullet
@item @b{-expected-id NUMBER}
@* By default it is zero. If non-zero represents the
-expected tap ID used when the Jtag Chain is examined. See below.
+expected tap ID used when the JTAG chain is examined. See below.
@item @b{-disable}
@item @b{-enable}
@* By default not specified the tap is enabled. Some chips have a
-jtag route controller (JRC) that is used to enable and/or disable
-specific jtag taps. You can later enable or disable any JTAG tap via
+JTAG route controller (JRC) that is used to enable and/or disable
+specific JTAG taps. You can later enable or disable any JTAG tap via
the command @b{jtag tapenable DOTTED.NAME} or @b{jtag tapdisable
DOTTED.NAME}
@comment END Optional
@@ -1562,22 +1561,22 @@
@* newtap is a sub command of the ``jtag'' command
@item @b{Big Picture Background}
@*GDB Talks to OpenOCD using the GDB protocol via
-tcpip. OpenOCD then uses the JTAG interface (the dongle) to
+TCP/IP. OpenOCD then uses the JTAG interface (the dongle) to
control the JTAG chain on your board. Your board has one or more chips
in a @i{daisy chain configuration}. Each chip may have one or more
-jtag taps. GDB ends up talking via OpenOCD to one of the taps.
+JTAG taps. GDB ends up talking via OpenOCD to one of the taps.
@item @b{NAME Rules}
@*Names follow ``C'' symbol name rules (start with alpha ...)
@item @b{TAPNAME - Conventions}
@itemize @bullet
@item @b{tap} - should be used only FPGA or CPLD like devices with a single tap.
-@item @b{cpu} - the main cpu of the chip, alternatively @b{foo.arm} and @b{foo.dsp}
+@item @b{cpu} - the main CPU of the chip, alternatively @b{foo.arm} and @b{foo.dsp}
@item @b{flash} - if the chip has a flash tap, example: str912.flash
@item @b{bs} - for boundary scan if this is a seperate tap.
-@item @b{jrc} - for jtag route controller (example: OMAP3530 found on Beagleboards)
+@item @b{jrc} - for JTAG route controller (example: OMAP3530 found on Beagleboards)
@item @b{unknownN} - where N is a number if you have no idea what the tap is for
@item @b{Other names} - Freescale IMX31 has a SDMA (smart dma) with a JTAG tap, that tap should be called the ``sdma'' tap.
-@item @b{When in doubt} - use the chip makers name in their data sheet.
+@item @b{When in doubt} - use the chip maker's name in their data sheet.
@end itemize
@item @b{DOTTED.NAME}
@* @b{CHIPNAME}.@b{TAPNAME} creates the tap name, aka: the
@@ -1591,12 +1590,12 @@
@item @b{Multi Tap Example}
@* This example is based on the ST Microsystems STR912. See the ST
document titled: @b{STR91xFAxxx, Section 3.15 Jtag Interface, Page:
-28/102, Figure 3: Jtag chaining inside the STR91xFA}.
+28/102, Figure 3: JTAG chaining inside the STR91xFA}.
@url{http://eu.st.com/stonline/products/literature/ds/13495.pdf}
@*@b{checked: 28/nov/2008}
-The diagram shows the TDO pin connects to the flash tap, flash TDI
+The diagram shows that the TDO pin connects to the flash tap, flash TDI
connects to the CPU debug tap, CPU TDI connects to the boundary scan
tap which then connects to the TDI pin.
@@ -1631,7 +1630,7 @@
@* @b{Removed: 28/nov/2008} This command has been removed and replaced
by the ``jtag newtap'' command. The documentation remains here so that
one can easily convert the old syntax to the new syntax. About the old
-syntax: The old syntax is positional, ie: The 3rd parameter is the
+syntax: The old syntax is positional, i.e.: The 3rd parameter is the
``irmask''. The new syntax requires named prefixes, and supports
additional options, for example ``-expected-id 0x3f0f0f0f''. Please refer to the
@b{jtag newtap} command for details.
@@ -1657,20 +1656,20 @@
@cindex JRC
@cindex route controller
-These commands are used when your target has a JTAG Route controller
-that effectively adds or removes a tap from the jtag chain in a
+These commands are used when your target has a JTAG route controller
+that effectively adds or removes a tap from the JTAG chain in a
non-standard way.
The ``standard way'' to remove a tap would be to place the tap in
bypass mode. But with the advent of modern chips, this is not always a
good solution. Some taps operate slowly, others operate fast, and
-there are other JTAG clock syncronization problems one must face. To
-solve that problem, the JTAG Route controller was introduced. Rather
-then ``bypass'' the tap, the tap is completely removed from the
+there are other JTAG clock synchronisation problems one must face. To
+solve that problem, the JTAG route controller was introduced. Rather
+than ``bypass'' the tap, the tap is completely removed from the
circuit and skipped.
-From OpenOCD's view point, a JTAG TAP is in one of 3 states:
+From OpenOCD's point of view, a JTAG tap is in one of 3 states:
@itemize @bullet
@item @b{Enabled - Not In ByPass} and has a variable bit length
@@ -1685,15 +1684,15 @@
This command returns 1 if the named tap is currently enabled, 0 if not.
This command exists so that scripts that manipulate a JRC (like the
-Omap3530 has) can determine if OpenOCD thinks a tap is presently
-enabled, or disabled.
+OMAP3530 has) can determine if OpenOCD thinks a tap is presently
+enabled or disabled.
@page
@node Target Configuration
@chapter Target Configuration
-This chapter discusses how to create a GDB Debug Target. Before
-creating a ``target'' a JTAG Tap DOTTED.NAME must exist first.
+This chapter discusses how to create a GDB debug target. Before
+creating a ``target'' a JTAG tap DOTTED.NAME must exist first.
@section targets [NAME]
@b{Note:} This command name is PLURAL - not singular.
@@ -1701,8 +1700,8 @@
With NO parameter, this plural @b{targets} command lists all known
targets in a human friendly form.
-With a parameter, this pural @b{targets} command sets the current
-target to the given name. (ie: If there are multiple debug targets)
+With a parameter, this plural @b{targets} command sets the current
+target to the given name. (i.e.: If there are multiple debug targets)
Example:
@verbatim
@@ -1722,7 +1721,7 @@
The TARGET command accepts these sub-commands:
@itemize @bullet
@item @b{create} .. parameters ..
-@* creates a new target, See below for details.
+@* creates a new target, see below for details.
@item @b{types}
@* Lists all supported target types (perhaps some are not yet in this document).
@item @b{names}
@@ -1768,8 +1767,8 @@
@b{Model:} The Tcl/Tk language has the concept of object commands. A
good example is a on screen button, once a button is created a button
-has a name (a path in TK terms) and that name is useable as a 1st
-class command. For example in TK, one can create a button and later
+has a name (a path in Tk terms) and that name is useable as a 1st
+class command. For example in Tk, one can create a button and later
configure it like this:
@example
@@ -1784,13 +1783,13 @@
@end example
In OpenOCD's terms, the ``target'' is an object just like a Tcl/Tk
-button. Commands avaialble as a ``target object'' are:
+button. Commands available as a ``target object'' are:
@comment START targetobj commands.
@itemize @bullet
@item @b{configure} - configure the target; see Target Config/Cget Options below
@item @b{cget} - query the target configuration; see Target Config/Cget Options below
-@item @b{curstate} - current target state (running, halt, etc)
+@item @b{curstate} - current target state (running, halt, etc.
@item @b{eventlist}
@* Intended for a human to see/read the currently configure target events.
@item @b{Various Memory Commands} See the ``mww'' command elsewhere.
@@ -1845,7 +1844,7 @@
via ``$_TARGETNAME configure'' see this example.
Syntactially, the option is: ``-event NAME BODY'' where NAME is a
-target event name, and BODY is a tcl procedure or string of commands
+target event name, and BODY is a Tcl procedure or string of commands
to execute.
The programmers model is the ``-command'' option used in Tcl/Tk
@@ -1865,9 +1864,9 @@
The following events are available:
@itemize @bullet
@item @b{debug-halted}
-@* The target has halted for debug reasons (ie: breakpoint)
+@* The target has halted for debug reasons (i.e.: breakpoint)
@item @b{debug-resumed}
-@* The target has resumed (ie: gdb said run)
+@* The target has resumed (i.e.: gdb said run)
@item @b{early-halted}
@* Occurs early in the halt process
@item @b{examine-end}
@@ -1889,7 +1888,7 @@
@item @b{gdb-flash-write-end}
@* After GDB writes to the flash
@item @b{gdb-start}
-@* Before the taret steps, gdb is trying to start/resume the tarfget
+@* Before the taret steps, gdb is trying to start/resume the target
@item @b{halted}
@* The target has halted
@item @b{old-gdb_program_config}
@@ -1944,7 +1943,6 @@
@end example
@end itemize
-
@section target create
@cindex target
@cindex target creation
@@ -1960,7 +1958,7 @@
DOTTED.NAME, this name is also used to create the target object
command.
@item @b{TYPE}
-@* Specifies the target type, ie: arm7tdmi, or cortexM3. Currently supported targes are:
+@* Specifies the target type, i.e.: ARM7TDMI, or Cortex-M3. Currently supported targets are:
@comment START types
@itemize @minus
@item @b{arm7tdmi}
@@ -1978,8 +1976,7 @@
@comment end TYPES
@end itemize
@item @b{PARAMS}
-@*PARAMs are various target configure parameters, the following are mandatory
-at configuration:
+@*PARAMs are various target configuration parameters. The following ones are mandatory:
@comment START mandatory
@itemize @bullet
@item @b{-endian big|little}
@@ -2000,7 +1997,7 @@
@item @b{-work-area-size [ADDRESS]} specify/set the work area
@item @b{-work-area-backup [0|1]} does the work area get backed up
@item @b{-endian [big|little]}
-@item @b{-variant [NAME]} some chips have varients OpenOCD needs to know about
+@item @b{-variant [NAME]} some chips have variants OpenOCD needs to know about
@item @b{-chain-position DOTTED.NAME} the tap name this target refers to.
@end itemize
Example:
@@ -2013,14 +2010,14 @@
@}
@end example
-@section Target Varients
+@section Target Variants
@itemize @bullet
@item @b{arm7tdmi}
@* Unknown (please write me)
@item @b{arm720t}
-@* Unknown (please write me) (simular to arm7tdmi)
+@* Unknown (please write me) (similar to arm7tdmi)
@item @b{arm9tdmi}
-@* Varients: @option{arm920t}, @option{arm922t} and @option{arm940t}
+@* Variants: @option{arm920t}, @option{arm922t} and @option{arm940t}
This enables the hardware single-stepping support found on these
cores.
@item @b{arm920t}
@@ -2028,7 +2025,7 @@
@item @b{arm966e}
@* None (this is also used as the ARM946)
@item @b{cortex_m3}
-@* use variant <@var{-variant lm3s}> when debugging luminary lm3s targets. This will cause
+@* use variant <@var{-variant lm3s}> when debugging Luminary lm3s targets. This will cause
OpenOCD to use a software reset rather than asserting SRST to avoid a issue with clearing
the debug registers. This is fixed in Fury Rev B, DustDevil Rev B, Tempest, these revisions will
be detected and the normal reset behaviour used.
@@ -2042,7 +2039,7 @@
OpenOCD to instead use an EJTAG software reset command to reset the
processor. You still need to enable @option{srst} on the reset
configuration command to enable OpenOCD hardware reset functionality.
-@comment END varients
+@comment END variants
@end itemize
@section working_area - Command Removed
@cindex working_area
@@ -2064,11 +2061,11 @@
performing a backup slows down operation.
@node Flash Configuration
-@chapter Flash Programing
+@chapter Flash programming
@cindex Flash Configuration
@b{Note:} As of 28/nov/2008 OpenOCD does not know how to program a SPI
-flash that a micro may boot from. Perhaps you the reader would like to
+flash that a micro may boot from. Perhaps you, the reader, would like to
contribute support for this.
Flash Steps:
@@ -2081,7 +2078,7 @@
flash on your board.
@item GDB Flashing
@* Flashing via GDB requires the flash be configured via ``flash
-bank'', and the GDB flash features be enabled. See the Daemon
+bank'', and the GDB flash features be enabled. See the daemon
configuration section for more details.
@end enumerate
@@ -2175,16 +2172,16 @@
@subsection External Flash - cfi options
@cindex cfi options
-CFI flash are external flash chips - often they are connected to a
-specific chip select on the micro. By default at hard reset most
-micros have the ablity to ``boot'' from some flash chip - typically
-attached to the chips CS0 pin.
+CFI flashes are external flash chips - often they are connected to a
+specific chip select on the CPU. By default, at hard reset, most
+CPUs have the ablity to ``boot'' from some flash chip - typically
+attached to the CPU's CS0 pin.
For other chip selects: OpenOCD does not know how to configure, or
-access a specific chip select. Instead you the human might need to via
-other commands (like: mww) configure additional chip selects, or
+access a specific chip select. Instead you, the human, might need to
+configure additional chip selects via other commands (like: mww) , or
perhaps configure a GPIO pin that controls the ``write protect'' pin
-on the FLASH chip.
+on the flash chip.
@b{flash bank cfi} <@var{base}> <@var{size}> <@var{chip_width}> <@var{bus_width}>
<@var{target#}> [@var{jedec_probe}|@var{x16_as_x8}]
@@ -2194,11 +2191,11 @@
@var{chip_width} and @var{bus_width} are specified in bytes.
-The @var{jedec_probe} option is used to detect certain non-CFI flash roms, like AM29LV010 and similar types.
+The @var{jedec_probe} option is used to detect certain non-CFI flash ROMs, like AM29LV010 and similar types.
@var{x16_as_x8} ???
-@subsection Internal Flash (Micro Controllers)
+@subsection Internal Flash (Microcontrollers)
@subsubsection lpc2000 options
@cindex lpc2000 options
@@ -2230,7 +2227,7 @@
@cindex str9 options
@b{flash bank str9x} <@var{base}> <@var{size}> 0 0 <@var{target#}>
-@*The str9 needs the flash controller to be configured prior to Flash programming, eg.
+@*The str9 needs the flash controller to be configured prior to Flash programming, e.g.
@example
str9x flash_config 0 4 2 0 0x80000
@end example
@@ -2239,17 +2236,17 @@
@subsubsection str9 options (str9xpec driver)
@b{flash bank str9xpec} <@var{base}> <@var{size}> 0 0 <@var{target#}>
-@*Before using the flash commands the turbo mode will need enabling using str9xpec
+@*Before using the flash commands the turbo mode must be enabled using str9xpec
@option{enable_turbo} <@var{num>.}
Only use this driver for locking/unlocking the device or configuring the option bytes.
Use the standard str9 driver for programming. @xref{STR9 specific commands}.
-@subsubsection stellaris (LM3Sxxx) options
-@cindex stellaris (LM3Sxxx) options
+@subsubsection Stellaris (LM3Sxxx) options
+@cindex Stellaris (LM3Sxxx) options
@b{flash bank stellaris} <@var{base}> <@var{size}> 0 0 <@var{target#}>
-@*stellaris flash plugin only require the @var{target#}.
+@*Stellaris flash plugin only require the @var{target#}.
@subsubsection stm32x options
@cindex stm32x options
@@ -2263,8 +2260,8 @@
@b{flash bank aduc702x} 0 0 0 0 <@var{target#}>
@*The aduc702x flash plugin works with Analog Devices model numbers ADUC7019 through ADUC7028. The setup command only requires the @var{target#} argument (all devices in this family have the same memory layout).
-@subsection mFlash configuration
-@cindex mFlash configuration
+@subsection mFlash Configuration
+@cindex mFlash Configuration
@b{mflash bank} <@var{soc}> <@var{base}> <@var{chip_width}> <@var{bus_width}>
<@var{RST pin}> <@var{WP pin}> <@var{DPD pin}> <@var{target #}>
@cindex mflash bank
@@ -2283,12 +2280,12 @@
mflash bank pxa270 0x08000000 2 2 43 -1 51 0
@end example
-@section Micro Controller Specific Flash Commands
+@section Microcontroller specific Flash Commands
@subsection AT91SAM7 specific commands
@cindex AT91SAM7 specific commands
The flash configuration is deduced from the chip identification register. The flash
-controller handles erases automatically on a page (128/265 byte) basis so erase is
+controller handles erases automatically on a page (128/265 byte) basis, so erase is
not necessary for flash programming. AT91SAM7 processors with less than 512K flash
only have a single flash bank embedded on chip. AT91SAM7xx512 have two flash planes
that can be erased separatly. Only an EraseAll command is supported by the controller
@@ -2308,11 +2305,11 @@
@itemize @bullet
@item @b{str9xpec enable_turbo} <@var{num}>
@cindex str9xpec enable_turbo
-@*enable turbo mode, simply this will remove the str9 from the chain and talk
+@*enable turbo mode, will simply remove the str9 from the chain and talk
directly to the embedded flash controller.
@item @b{str9xpec disable_turbo} <@var{num}>
@cindex str9xpec disable_turbo
-@*restore the str9 into jtag chain.
+@*restore the str9 into JTAG chain.
@item @b{str9xpec lock} <@var{num}>
@cindex str9xpec lock
@*lock str9 device. The str9 will only respond to an unlock command that will
@@ -2336,13 +2333,13 @@
Standard driver @option{str9x} programmed via the str9 core. Normally used for
flash programming as it is faster than the @option{str9xpec} driver.
@item
-Direct programming @option{str9xpec} using the flash controller, this is
+Direct programming @option{str9xpec} using the flash controller. This is an
ISC compilant (IEEE 1532) tap connected in series with the str9 core. The str9
core does not need to be running to program using this flash driver. Typical use
for this driver is locking/unlocking the target and programming the option bytes.
@end enumerate
-Before we run any cmds using the @option{str9xpec} driver we must first disable
+Before we run any commands using the @option{str9xpec} driver we must first disable
the str9 core. This example assumes the @option{str9xpec} driver has been
configured for flash bank 0.
@example
@@ -2363,7 +2360,7 @@
The above example will read the str9 option bytes.
When performing a unlock remember that you will not be able to halt the str9 - it
has been locked. Halting the core is not required for the @option{str9xpec} driver
-as mentioned above, just issue the cmds above manually or from a telnet prompt.
+as mentioned above, just issue the commands above manually or from a telnet prompt.
@subsection STR9 configuration
@cindex STR9 configuration
@@ -2373,7 +2370,7 @@
@cindex str9x flash_config
@*Configure str9 flash controller.
@example
-eg. str9x flash_config 0 4 2 0 0x80000
+e.g. str9x flash_config 0 4 2 0 0x80000
This will setup
BBSR - Boot Bank Size register
NBBSR - Non Boot Bank Size register
@@ -2432,13 +2429,12 @@
@*mass erase flash memory.
@end itemize
-
@node General Commands
@chapter General Commands
@cindex commands
The commands documented in this chapter here are common commands that
-you a human may want to type and see the output of. Configuration type
+you, as a human, may want to type and see the output of. Configuration type
commands are documented elsewhere.
Intent:
@@ -2446,10 +2442,10 @@
@item @b{Source Of Commands}
@* OpenOCD commands can occur in a configuration script (discussed
elsewhere) or typed manually by a human or supplied programatically,
-or via one of several Tcp/Ip Ports.
+or via one of several TCP/IP Ports.
@item @b{From the human}
-@* A human should interact with the Telnet interface (default port: 4444,
+@* A human should interact with the telnet interface (default port: 4444,
or via GDB, default port 3333)
To issue commands from within a GDB session, use the @option{monitor}
@@ -2457,7 +2453,7 @@
command. All output is relayed through the GDB session.
@item @b{Machine Interface}
-The TCL interface intent is to be a machine interface. The default TCL
+The Tcl interface's intent is to be a machine interface. The default Tcl
port is 5555.
@end itemize
@@ -2471,7 +2467,7 @@
@subsection shutdown
@cindex shutdown
-@*Close the OpenOCD daemon, disconnecting all clients (GDB, Telnet, Other).
+@*Close the OpenOCD daemon, disconnecting all clients (GDB, telnet, other).
@subsection debug_level [@var{n}]
@cindex debug_level
@@ -2503,7 +2499,7 @@
@subsection script <@var{file}>
@cindex script
@*Execute commands from <file>
-Also see: ``source [find FILENAME]''
+See also: ``source [find FILENAME]''
@section Target state handling
@subsection power <@var{on}|@var{off}>
@@ -2516,8 +2512,8 @@
@cindex reg
@*Access a single register by its number[@option{#}] or by its [@option{name}].
No arguments: list all available registers for the current target.
-Number or name argument: display a register
-Number or name and value arguments: set register value
+Number or name argument: display a register.
+Number or name and value arguments: set register value.
@subsection poll [@option{on}|@option{off}]
@cindex poll
@@ -2536,7 +2532,7 @@
@cindex wait_halt
@*Wait for the target to enter debug mode. Optional [@option{ms}] is
a timeout in milliseconds. Default [@option{ms}] is 5 seconds if no
-arg given.
+arg is given.
@subsection resume [@var{address}]
@cindex resume
@@ -2567,18 +2563,18 @@
@subsection soft_reset_halt
@cindex reset
-@*Requesting target halt and executing a soft reset. This often used
+@*Requesting target halt and executing a soft reset. This is often used
when a target cannot be reset and halted. The target, after reset is
released begins to execute code. OpenOCD attempts to stop the CPU and
-then sets the Program counter back at the reset vector. Unfortunatlly
-that code that was executed may have left hardware in an unknown
+then sets the program counter back to the reset vector. Unfortunately
+the code that was executed may have left the hardware in an unknown
state.
@section Memory access commands
@subsection meminfo
-display available ram memory.
-@subsection Memory Peek/Poke type commands
+display available RAM memory.
+@subsection Memory peek/poke type commands
These commands allow accesses of a specific size to the memory
system. Often these are used to configure the current target in some
special way. For example - one may need to write certian values to the
@@ -2586,7 +2582,7 @@
@enumerate
@item To change the current target see the ``targets'' (plural) command
-@item In system level scripts these commands are depricated, please use the TARGET object versions.
+@item In system level scripts these commands are deprecated, please use the TARGET object versions.
@end enumerate
@itemize @bullet
@@ -2610,7 +2606,7 @@
@*write memory byte (8bit)
@end itemize
-@section Image Loading Commands
+@section Image loading commands
@subsection load_image
@b{load_image} <@var{file}> <@var{address}> [@option{bin}|@option{ihex}|@option{elf}]
@cindex load_image
@@ -2621,18 +2617,18 @@
@cindex fast_load_image
@anchor{fast_load_image}
@*Normally you should be using @b{load_image} or GDB load. However, for
-testing purposes or when IO overhead is significant(OpenOCD running on embedded
-host), then storing the image in memory and uploading the image to the target
+testing purposes or when I/O overhead is significant(OpenOCD running on an embedded
+host), storing the image in memory and uploading the image to the target
can be a way to upload e.g. multiple debug sessions when the binary does not change.
-Arguments as @b{load_image}, but image is stored in OpenOCD host
+Arguments are the same as @b{load_image}, but the image is stored in OpenOCD host
memory, i.e. does not affect target. This approach is also useful when profiling
-target programming performance as IO and target programming can easily be profiled
-seperately.
+target programming performance as I/O and target programming can easily be profiled
+separately.
@subsection fast_load
@b{fast_load}
@cindex fast_image
@anchor{fast_image}
-@*Loads image stored in memory by @b{fast_load_image} to current target. Must be preceeded by fast_load_image.
+@*Loads an image stored in memory by @b{fast_load_image} to the current target. Must be preceeded by fast_load_image.
@subsection dump_image
@b{dump_image} <@var{file}> <@var{address}> <@var{size}>
@cindex dump_image
@@ -2643,7 +2639,7 @@
@b{verify_image} <@var{file}> <@var{address}> [@option{bin}|@option{ihex}|@option{elf}]
@cindex verify_image
@*Verify <@var{file}> against target memory starting at <@var{address}>.
-This will first attempt comparison using a crc checksum, if this fails it will try a binary compare.
+This will first attempt a comparison using a CRC checksum, if this fails it will try a binary compare.
@section Breakpoint commands
@@ -2668,7 +2664,8 @@
@itemize
@item @b{profile} <@var{seconds}> <@var{gmon.out}>
-Profiling samples the CPU PC as quickly as OpenOCD is able, which will be used as a random sampling of PC.
+Profiling samples the CPU's program counter as quickly as possible, which is useful for non-intrusive stochastic profiling.
+
@end itemize
@section Target Specific Commands
@@ -2700,7 +2697,7 @@
@cindex ARM7/9 specific commands
These commands are specific to ARM7 and ARM9 targets, like ARM7TDMI, ARM720t,
-ARM920t or ARM926EJ-S.
+ARM920T or ARM926EJ-S.
@itemize @bullet
@item @b{arm7_9 dbgrq} <@var{enable}|@var{disable}>
@cindex arm7_9 dbgrq
@@ -2711,13 +2708,13 @@
@anchor{arm7_9 fast_memory_access}
@*Allow OpenOCD to read and write memory without checking completion of
the operation. This provides a huge speed increase, especially with USB JTAG
-cables (FT2232), but might be unsafe if used with targets running at a very low
-speed, like the 32kHz startup clock of an AT91RM9200.
+cables (FT2232), but might be unsafe if used with targets running at very low
+speeds, like the 32kHz startup clock of an AT91RM9200.
@item @b{arm7_9 dcc_downloads} <@var{enable}|@var{disable}>
@cindex arm7_9 dcc_downloads
@*Enable the use of the debug communications channel (DCC) to write larger (>128 byte)
amounts of memory. DCC downloads offer a huge speed increase, but might be potentially
-unsafe, especially with targets running at a very low speed. This command was introduced
+unsafe, especially with targets running at very low speeds. This command was introduced
with OpenOCD rev. 60.
@end itemize
@@ -2749,7 +2746,7 @@
@option{reset} @option{undef} @option{swi} @option{pabt} @option{dabt} @option{reserved}
@option{irq} @option{fiq}.
-Can also be used on other arm9 based cores, arm966, arm920t and arm926ejs.
+Can also be used on other ARM9 based cores such as ARM966, ARM920T and ARM926EJ-S.
@end itemize
@subsection ARM966E specific commands
@@ -2773,8 +2770,8 @@
@*display/modify cp15 (interpreted access) <@option{opcode}> [@option{value}] [@option{address}]
@item @b{arm920t cache_info}
@cindex arm920t cache_info
-@*Print information about the caches found. This allows you to see if your target
-is a ARM920T (2x16kByte cache) or ARM922T (2x8kByte cache).
+@*Print information about the caches found. This allows to see whether your target
+is an ARM920T (2x16kByte cache) or ARM922T (2x8kByte cache).
@item @b{arm920t md<bhw>_phys} <@var{addr}> [@var{count}]
@cindex arm920t md<bhw>_phys
@*Display memory at physical address addr.
@@ -2792,8 +2789,8 @@
@*Translate a virtual address to a physical address.
@end itemize
-@subsection ARM926EJS specific commands
-@cindex ARM926EJS specific commands
+@subsection ARM926EJ-S specific commands
+@cindex ARM926EJ-S specific commands
@itemize @bullet
@item @b{arm926ejs cp15} <@var{num}> [@var{value}]
@@ -2857,13 +2854,13 @@
@node JTAG Commands
@chapter JTAG Commands
-@cindex JTAG commands
+@cindex JTAG Commands
Generally most people will not use the bulk of these commands. They
are mostly used by the OpenOCD developers or those who need to
directly manipulate the JTAG taps.
In general these commands control JTAG taps at a very low level. For
-example if you need to control a JTAG Route Controller (ie: the
+example if you need to control a JTAG Route Controller (i.e.: the
OMAP3530 on the Beagle Board has one) you might use these commands in
a script or an event procedure.
@section Commands
@@ -2943,33 +2940,33 @@
@node TFTP
@chapter TFTP
@cindex TFTP
-If OpenOCD runs on an embedded host(as ZY1000 does), then tftp can
-be used to access files on PCs(either developer PC or some other PC).
+If OpenOCD runs on an embedded host(as ZY1000 does), then TFTP can
+be used to access files on PCs (either the developer's PC or some other PC).
The way this works on the ZY1000 is to prefix a filename by
-"/tftp/ip/" and append the tftp path on the tftp
-server(tftpd). E.g. "load_image /tftp/10.0.0.96/c:\temp\abc.elf" will
+"/tftp/ip/" and append the TFTP path on the TFTP
+server (tftpd). E.g. "load_image /tftp/10.0.0.96/c:\temp\abc.elf" will
load c:\temp\abc.elf from the developer pc (10.0.0.96) into memory as
if the file was hosted on the embedded host.
-In order to achieve decent performance, you must choose a tftp server
-that supports a packet size bigger than the default packet size(512 bytes). There
-are numerous tftp servers out there(free and commercial) and you will have to do
+In order to achieve decent performance, you must choose a TFTP server
+that supports a packet size bigger than the default packet size (512 bytes). There
+are numerous TFTP servers out there (free and commercial) and you will have to do
a bit of googling to find something that fits your requirements.
@node Sample Scripts
@chapter Sample Scripts
@cindex scripts
-This page shows how to use the target library.
+This page shows how to use the Target Library.
-The configuration script can be divided in the following section:
+The configuration script can be divided into the following sections:
@itemize @bullet
-@item daemon configuration
-@item interface
-@item jtag scan chain
-@item target configuration
-@item flash configuration
+@item Daemon configuration
+@item Interface
+@item JTAG scan chain
+@item Target configuration
+@item Flash configuration
@end itemize
Detailed information about each section can be found at OpenOCD configuration.
@@ -2993,14 +2990,14 @@
@cindex Connecting to GDB
@anchor{Connecting to GDB}
Use GDB 6.7 or newer with OpenOCD if you run into trouble. For
-instance 6.3 has a known bug where it produces bogus memory access
+instance GDB 6.3 has a known bug that produces bogus memory access
errors, which has since been fixed: look up 1836 in
@url{http://sourceware.org/cgi-bin/gnatsweb.pl?database=gdb}
@*OpenOCD can communicate with GDB in two ways:
@enumerate
@item
-A socket (tcp) connection is typically started as follows:
+A socket (TCP/IP) connection is typically started as follows:
@example
target remote localhost:3333
@end example
@@ -3016,14 +3013,14 @@
@end enumerate
@*To see a list of available OpenOCD commands type @option{monitor help} on the
-GDB commandline.
+GDB command line.
OpenOCD supports the gdb @option{qSupported} packet, this enables information
-to be sent by the gdb server (OpenOCD) to GDB. Typical information includes
-packet size and device memory map.
+to be sent by the GDB remote server (i.e. OpenOCD) to GDB. Typical information includes
+packet size and the device's memory map.
Previous versions of OpenOCD required the following GDB options to increase
-the packet size and speed up GDB communication.
+the packet size and speed up GDB communication:
@example
set remote memory-write-packet-size 1024
set remote memory-write-packet-size fixed
@@ -3035,25 +3032,25 @@
@section Programming using GDB
@cindex Programming using GDB
-By default the target memory map is sent to GDB, this can be disabled by
-the following OpenOCD config option:
+By default the target memory map is sent to GDB. This can be disabled by
+the following OpenOCD configuration option:
@example
gdb_memory_map disable
@end example
-For this to function correctly a valid flash config must also be configured
+For this to function correctly a valid flash configuration must also be set
in OpenOCD. For faster performance you should also configure a valid
working area.
Informing GDB of the memory map of the target will enable GDB to protect any
-flash area of the target and use hardware breakpoints by default. This means
+flash areas of the target and use hardware breakpoints by default. This means
that the OpenOCD option @option{gdb_breakpoint_override} is not required when
using a memory map. @xref{gdb_breakpoint_override}.
-To view the configured memory map in GDB, use the gdb command @option{info mem}
-All other unasigned addresses within GDB are treated as RAM.
+To view the configured memory map in GDB, use the GDB command @option{info mem}
+All other unassigned addresses within GDB are treated as RAM.
-GDB 6.8 and higher set any memory area not in the memory map as inaccessible,
-this can be changed to the old behaviour by using the following GDB command.
+GDB 6.8 and higher set any memory area not in the memory map as inaccessible.
+This can be changed to the old behaviour by using the following GDB command
@example
set mem inaccessible-by-default off
@end example
@@ -3066,7 +3063,7 @@
will be used.
If the target needs configuring before GDB programming, an event
-script can be executed.
+script can be executed:
@example
$_TARGETNAME configure -event EVENTNAME BODY
@end example
@@ -3074,11 +3071,11 @@
To verify any flash programming the GDB command @option{compare-sections}
can be used.
-@node TCL scripting API
-@chapter TCL scripts
-@cindex TCL scripting API
-@cindex TCL scripts
-@section API Rules
+@node Tcl Scripting API
+@chapter Tcl Scripting API
+@cindex Tcl Scripting API
+@cindex Tcl scripts
+@section API rules
The commands are stateless. E.g. the telnet command line has a concept
of currently active target, the Tcl API proc's take this sort of state
@@ -3115,36 +3112,36 @@
Lists returned must be relatively small. Otherwise a range
should be passed in to the proc in question.
-@section Internal Low Level Commands
+@section Internal low-level Commands
-By Low level, the intent is a human would not directly use these commands.
+By low-level, the intent is a human would not directly use these commands.
-Low level commands are (should be) prefixed with "openocd_", e.g. openocd_flash_banks
+Low-level commands are (should be) prefixed with "openocd_", e.g. openocd_flash_banks
is the low level API upon which "flash banks" is implemented.
@itemize @bullet
@item @b{ocd_mem2array} <@var{varname}> <@var{width}> <@var{addr}> <@var{nelems}>
-Read memory and return as a TCL array for script processing
+Read memory and return as a Tcl array for script processing
@item @b{ocd_array2mem} <@var{varname}> <@var{width}> <@var{addr}> <@var{nelems}>
-Convert a TCL array to memory locations and write the values
+Convert a Tcl array to memory locations and write the values
@item @b{ocd_flash_banks} <@var{driver}> <@var{base}> <@var{size}> <@var{chip_width}> <@var{bus_width}> <@var{target}> [@option{driver options} ...]
Return information about the flash banks
@end itemize
OpenOCD commands can consist of two words, e.g. "flash banks". The
-startup.tcl "unknown" proc will translate this into a tcl proc
+startup.tcl "unknown" proc will translate this into a Tcl proc
called "flash_banks".
@section OpenOCD specific Global Variables
@subsection HostOS
-Real TCL has ::tcl_platform(), and platform::identify, and many other
-variables. JimTCL, as implimented in OpenOCD creates $HostOS which
-holds...
[truncated message content] |
|
From: oharboe at B. <oh...@ma...> - 2009-03-20 13:32:17
|
Author: oharboe
Date: 2009-03-20 13:32:17 +0100 (Fri, 20 Mar 2009)
New Revision: 1421
Added:
trunk/src/target/target/imx35.cfg
Log:
Alan Carvalho de Assis <ac...@gm...> adds support to i.MX35 processor.
Added: trunk/src/target/target/imx35.cfg
===================================================================
--- trunk/src/target/target/imx35.cfg 2009-03-20 10:29:12 UTC (rev 1420)
+++ trunk/src/target/target/imx35.cfg 2009-03-20 12:32:17 UTC (rev 1421)
@@ -0,0 +1,50 @@
+# imx35 config
+#
+
+if { [info exists CHIPNAME] } {
+ set _CHIPNAME $CHIPNAME
+} else {
+ set _CHIPNAME imx35
+}
+
+if { [info exists ENDIAN] } {
+ set _ENDIAN $ENDIAN
+} else {
+ set _ENDIAN little
+}
+
+if { [info exists CPUTAPID ] } {
+ set _CPUTAPID $CPUTAPID
+} else {
+ set _CPUTAPID 0x07b3601d
+}
+
+if { [info exists SDMATAPID ] } {
+ set _SDMATAPID $SDMATAPID
+} else {
+ set _SDMATAPID 0x0882601d
+}
+
+#========================================
+# The "system jtag controller"
+# IMX31 reference manual, page 6-28 - figure 6-14
+if { [info exists SJCTAPID ] } {
+ set _SJCTAPID $SJCTAPID
+} else {
+ set _SJCTAPID 0x2b900f0f
+}
+
+jtag newtap $_CHIPNAME sjc -irlen 4 -ircapture 0x0 -irmask 0x0 -expected-id $_SJCTAPID
+
+jtag newtap $_CHIPNAME cpu -irlen 5 -ircapture 0x1 -irmask 0x1f -expected-id $_CPUTAPID
+
+# No IDCODE for this TAP
+jtag newtap $_CHIPNAME whatchacallit -irlen 4 -ircapture 0 -irmask 0x0 -expected-id 0x0
+
+jtag newtap $_CHIPNAME smda -irlen 5 -ircapture 0x1 -irmask 0x1f -expected-id $_SDMATAPID
+
+set _TARGETNAME [format "%s.cpu" $_CHIPNAME]
+target create $_TARGETNAME arm11 -endian $_ENDIAN -chain-position $_TARGETNAME
+
+proc power_restore {} { puts "Sensed power restore. No action." }
+proc srst_deasserted {} { puts "Sensed nSRST deasserted. No action." }
|
|
From: ntfreak at B. <nt...@ma...> - 2009-03-20 11:29:13
|
Author: ntfreak
Date: 2009-03-20 11:29:12 +0100 (Fri, 20 Mar 2009)
New Revision: 1420
Modified:
trunk/doc/openocd.texi
Log:
- revert texi changes from rev 1418 as it breaks build
- original patch will be reviewed before next commit
Modified: trunk/doc/openocd.texi
===================================================================
--- trunk/doc/openocd.texi 2009-03-19 22:27:43 UTC (rev 1419)
+++ trunk/doc/openocd.texi 2009-03-20 10:29:12 UTC (rev 1420)
@@ -70,11 +70,11 @@
* Sample Scripts:: Sample Target Scripts
* TFTP:: TFTP
* GDB and OpenOCD:: Using GDB and OpenOCD
-* Tcl scripting API:: Tcl scripting API
+* TCL scripting API:: Tcl scripting API
* Upgrading:: Deprecated/Removed Commands
* Target library:: Target library
* FAQ:: Frequently Asked Questions
-* Tcl Crash Course:: Tcl Crash Course
+* TCL Crash Course:: TCL Crash Course
* License:: GNU Free Documentation License
@comment DO NOT use the plain word ``Index'', reason: CYGWIN filename
@comment case issue with ``Index.html'' and ``index.html''
@@ -92,14 +92,14 @@
devices.
@b{JTAG:} OpenOCD uses a ``hardware interface dongle'' to communicate
-with the JTAG (IEEE 1149.1) compliant taps on your target board.
+with the JTAG (IEEE 1149.1) complient taps on your target board.
-@b{Dongles:} OpenOCD currently supports many types of hardware dongles: USB
+@b{Dongles:} OpenOCD currently many types of hardware dongles: USB
Based, Parallel Port Based, and other standalone boxes that run
OpenOCD internally. See the section titled: @xref{JTAG Hardware Dongles}.
-@b{GDB Debug:} It allows ARM7 (ARM7TDMI and ARM720t), ARM9 (ARM920T,
-ARM922T, ARM926EJ--S, ARM966E--S), XScale (PXA25x, IXP42x) and
+@b{GDB Debug:} It allows ARM7 (ARM7TDMI and ARM720t), ARM9 (ARM920t,
+ARM922t, ARM926ej--s, ARM966e--s), XScale (PXA25x, IXP42x) and
Cortex-M3 (Luminary Stellaris LM3 and ST STM32) based cores to be
debugged via the GDB Protocol.
@@ -139,9 +139,9 @@
@enumerate
@item @b{Sell dongles} and include pre-built binaries
-@item @b{Supply tools} i.e.: A complete development solution
+@item @b{Supply tools} ie: A complete development solution
@item @b{Supply IDEs} like Eclipse, or RHIDE, etc.
-@item @b{Build packages} i.e.: RPM files, or DEB files for a Linux Distro
+@item @b{Build packages} ie: RPM files, or DEB files for a Linux Distro
@end enumerate
As a @b{PACKAGER} - you are at the top of the food chain. You solve
@@ -151,8 +151,8 @@
suggestions:
@enumerate
-@item @b{Always build with printer ports enabled}.
-@item @b{Try to use LIBFTDI + LIBUSB where possible}. You cover more bases.
+@item @b{Always build with Printer Ports Enabled}
+@item @b{Try where possible to use LIBFTDI + LIBUSB} You cover more bases
@end enumerate
It is your decision..
@@ -166,7 +166,7 @@
@item @b{MORE} platforms are supported
@item @b{MORE} complete solution
@end itemize
-@item @b{Why not LIBFTDI + LIBUSB} (i.e.: ftd2xx instead)
+@item @b{Why not LIBFTDI + LIBUSB} (ie: ftd2xx instead)
@itemize @bullet
@item @b{LESS} Some say it is slower.
@item @b{LESS} complex to distribute (external dependencies)
@@ -208,7 +208,7 @@
homepage (@uref{www.amontec.com}), as the JTAGkey uses a non-standard VID/PID.
@end itemize
-libftdi is supported under Windows. Do not use versions earlier then 0.14.
+libftdi is supported under windows. Do not use versions earlier then 0.14.
In general, the D2XX driver provides superior performance (several times as fast),
but has the draw-back of being binary-only - though that isn't that bad, as it isn't
@@ -282,7 +282,7 @@
FTDICHIP.COM closed source driver, or (2) the open (and free) driver
libftdi. Some claim the (closed) FTDICHIP.COM solution is faster.
-The FTDICHIP drivers come as either a (win32) ZIP file, or a (Linux)
+The FTDICHIP drivers come as either a (win32) ZIP file, or a (linux)
TAR.GZ file. You must unpack them ``some where'' convient. As of this
writing (12/26/2008) FTDICHIP does not supply means to install these
files ``in an appropriate place'' As a result, there are two
@@ -315,7 +315,7 @@
Cygwin/Linux LIBFTDI solution
Assumes:
- 1a) For Windows: The Windows port of LIBUSB is in place.
+ 1a) For Windows: The windows port of LIBUSB is in place.
1b) For Linux: libusb has been built and is inplace.
2) And libftdi has been built and installed
@@ -344,11 +344,11 @@
@node JTAG Hardware Dongles
@chapter JTAG Hardware Dongles
@cindex dongles
-@cindex FTDI
+@cindex ftdi
@cindex wiggler
@cindex zy1000
@cindex printer port
-@cindex USB adapter
+@cindex usb adapter
@cindex rtck
Defined: @b{dongle}: A small device that plugins into a computer and serves as
@@ -378,7 +378,7 @@
@section USB FT2232 Based
-There are many USB JTAG dongles on the market, many of them are based
+There are many USB jtag dongles on the market, many of them are based
on a chip from ``Future Technology Devices International'' (FTDI)
known as the FTDI FT2232.
@@ -505,7 +505,7 @@
@itemize @bullet
@item @b{ep93xx}
-@* An EP93xx based Linux machine using the GPIO pins directly.
+@* An EP93xx based linux machine using the GPIO pins directly.
@item @b{at91rm9200}
@* Like the EP93xx - but an ATMEL AT91RM9200 based solution using the GPIO pins on the chip.
@@ -589,8 +589,8 @@
@section Small configuration file method
-This is the preferred method. It is simple and works well for many
-people. The developers of OpenOCD would encourage you to use this
+This is the prefered method, it is simple and is works well for many
+people. The developers of OpenOCD would encourage you to use this
method. If you create a new configuration please email new
configurations to the development list.
@@ -663,10 +663,10 @@
Some key things you should look at and understand are:
@enumerate
-@item The RESET configuration of your debug environment as a whole
+@item The RESET configuration of your debug environment as a hole
@item Is there a ``work area'' that OpenOCD can use?
@* For ARM - work areas mean up to 10x faster downloads.
-@item For MMU/MPU based ARM chips (i.e.: ARM9 and later) will that work area still be available?
+@item For MMU/MPU based ARM chips (ie: ARM9 and later) will that work area still be available?
@item For complex targets (multiple chips) the JTAG SPEED becomes an issue.
@end enumerate
@@ -679,25 +679,26 @@
OpenOCD. These are guidelines for creating new boards and new target
configurations as of 28/Nov/2008.
-However, you, the user of OpenOCD, should be somewhat familiar with
+However, you the user of OpenOCD should be some what familiar with
this section as it should help explain some of the internals of what
you might be looking at.
-The user should find the following directories under @t{$(INSTALLDIR)/lib/openocd} :
+The user should find under @t{$(INSTALLDIR)/lib/openocd} the
+following directories:
@itemize @bullet
@item @b{interface}
-@*Think JTAG Dongle. Files that configure the JTAG dongle go here.
+@*Think JTAG Dongle. Files that configure the jtag dongle go here.
@item @b{board}
-@* Think Circuit Board, PWA, PCB, they go by many names. Board files
+@* Thing Circuit Board, PWA, PCB, they go by many names. Board files
contain initialization items that are specific to a board - for
example: The SDRAM initialization sequence for the board, or the type
of external flash and what address it is found at. Any initialization
-sequence to enable that external flash or SDRAM should be found in the
-board file. Boards may also contain multiple targets, i.e.: Two CPUs, or
+sequence to enable that external flash or sdram should be found in the
+board file. Boards may also contain multiple targets, ie: Two cpus, or
a CPU and an FPGA or CPLD.
@item @b{target}
-@* Think chip. The ``target'' directory represents a JTAG tap (or
+@* Think CHIP. The ``target'' directory represents a jtag tap (or
chip) OpenOCD should control, not a board. Two common types of targets
are ARM chips and FPGA or CPLD chips.
@end itemize
@@ -721,7 +722,7 @@
today, that said, perhaps some interfaces have only been used by the
sole developer who created it.
-@b{FIXME/NOTE:} We need to add support for a variable like Tcl variable
+@b{FIXME/NOTE:} We need to add support for a variable like TCL variable
tcl_platform(platform), it should be called jim_platform (because it
is jim, not real tcl) and it should contain 1 of 3 words: ``linux'',
``cygwin'' or ``mingw''
@@ -744,12 +745,12 @@
The board file should contain one or more @t{source [find
target/FOO.cfg]} statements along with any board specific things.
-In summary the board files should contain (if present)
+In summery the board files should contain (if present)
@enumerate
-@item External flash configuration (i.e.: the flash on CS0)
-@item SDRAM configuration (size, speed, etc.
-@item Board specific IO configuration (i.e.: GPIO pins might disable a 2nd flash)
+@item External flash configuration (ie: the flash on CS0)
+@item SDRAM configuration (size, speed, etc)
+@item Board specific IO configuration (ie: GPIO pins might disable a 2nd flash)
@item Multiple TARGET source statements
@item All things that are not ``inside a chip''
@item Things inside a chip go in a 'target' file
@@ -765,7 +766,7 @@
openocd -f target/FOOBAR.cfg
@end example
-In summary the target files should contain
+In summery the target files should contain
@enumerate
@item Set Defaults
@@ -792,8 +793,8 @@
@* When OpenOCD examines the JTAG chain, it will attempt to identify
every chip. If the @t{-expected-id} is nonzero, OpenOCD attempts
to verify the tap id number verses configuration file and may issue an
-error or warning like this. The hope is that this will help to pinpoint
-problems in OpenOCD configurations.
+error or warning like this. The hope is this will help pin point
+problem OpenOCD configurations.
@example
Info: JTAG tap: sam7x256.cpu tap/device found: 0x3f0f0f0f (Manufacturer: 0x787, Part: 0xf0f0, Version: 0x3)
@@ -829,12 +830,12 @@
@end itemize
-@subsection Tcl Variables Guide Line
+@subsection TCL Variables Guide Line
The Full Tcl/Tk language supports ``namespaces'' - JIM-Tcl does not.
Thus the rule we follow in OpenOCD is this: Variables that begin with
-a leading underscore are temporary in nature, and can be modified and
-used at will within a ?TARGET? configuration file.
+a leading underscore are temporal in nature, and can be modified and
+used at will within a ?TARGET? configuration file
@b{EXAMPLE:} The user should be able to do this:
@@ -848,14 +849,14 @@
source [find target/pxa270.cfg]
# variable: _TARGETNAME = network.cpu
# other commands can refer to the "network.cpu" tap.
- $_TARGETNAME configure .... params for this CPU..
+ $_TARGETNAME configure .... params for this cpu..
set ENDIAN little
set CHIPNAME video
source [find target/pxa270.cfg]
# variable: _TARGETNAME = video.cpu
# other commands can refer to the "video.cpu" tap.
- $_TARGETNAME configure .... params for this CPU..
+ $_TARGETNAME configure .... params for this cpu..
unset ENDIAN
set CHIPNAME xilinx
@@ -895,7 +896,7 @@
@end example
@subsection Creating Taps
-After the ``defaults'' are choosen [see above] the taps are created.
+After the ``defaults'' are choosen, [see above], the taps are created.
@b{SIMPLE example:} such as an Atmel AT91SAM7X256
@@ -942,7 +943,7 @@
@b{Tap Naming Convention}
-See the command ``jtag newtap'' for detail, but in brief the names you should use are:
+See the command ``jtag newtap'' for detail, but in breif the names you should use are:
@itemize @bullet
@item @b{tap}
@@ -962,20 +963,20 @@
@subsection Work Areas
Work areas are small RAM areas used by OpenOCD to speed up downloads,
-and to download small snippets of code to program flash chips.
+and to download small snippits of code to program flash chips.
-If the chip includes a form of ``on-chip-ram'' - and many do - define
+If the chip includes an form of ``on-chip-ram'' - and many do - define
a reasonable work area and use the ``backup'' option.
@b{PROBLEMS:} On more complex chips, this ``work area'' may become
-inaccessible if/when the application code enables or disables the MMU.
+inaccessable if/when the application code enables or disables the MMU.
@subsection ARM Core Specific Hacks
-If the chip has a DCC, enable it. If the chip is an ARM9 with some
-special high speed download features - enable it.
+If the chip has a DCC, enable it. If the chip is an arm9 with some
+special high speed download - enable it.
-If the chip has an ARM ``vector catch'' feature - by default enable
+If the chip has an ARM ``vector catch'' feature - by defeault enable
it for Undefined Instructions, Data Abort, and Prefetch Abort, if the
user is really writing a handler for those situations - they can
easily disable it. Experiance has shown the ``vector catch'' is
@@ -1009,31 +1010,31 @@
learn more about JIM here: @url{http://jim.berlios.de}
@itemize @bullet
-@item @b{JIM vs. Tcl}
+@item @b{JIM vrs TCL}
@* JIM-TCL is a stripped down version of the well known Tcl language,
which can be found here: @url{http://www.tcl.tk}. JIM-Tcl has far
fewer features. JIM-Tcl is a single .C file and a single .H file and
-impliments the basic Tcl command set along. In contrast: Tcl 8.6 is a
-4.2 MB .zip file containing 1540 files.
+impliments the basic TCL command set along. In contrast: Tcl 8.6 is a
+4.2MEG zip file containing 1540 files.
@item @b{Missing Features}
-@* Our practice has been: Add/clone the real Tcl feature if/when
+@* Our practice has been: Add/clone the Real TCL feature if/when
needed. We welcome JIM Tcl improvements, not bloat.
@item @b{Scripts}
@* OpenOCD configuration scripts are JIM Tcl Scripts. OpenOCD's
-command interpreter today (28/nov/2008) is a mixture of (newer)
-JIM-Tcl commands, and (older) the orginal command interpreter.
+command interpretor today (28/nov/2008) is a mixture of (newer)
+JIM-Tcl commands, and (older) the orginal command interpretor.
@item @b{Commands}
@* At the OpenOCD telnet command line (or via the GDB mon command) one
can type a Tcl for() loop, set variables, etc.
@item @b{Historical Note}
-@* JIM-Tcl was introduced to OpenOCD in spring 2008.
+@* JIM-Tcl was introduced to OpenOCD in Spring 2008.
-@item @b{Need a Crash Course In Tcl?}
-@* See: @xref{Tcl Crash Course}.
+@item @b{Need a Crash Course In TCL?}
+@* See: @xref{TCL Crash Course}.
@end itemize
@@ -1070,9 +1071,9 @@
@item @b{tcl_port} <@var{number}>
@cindex tcl_port
@*Intended as a machine interface. Port on which to listen for
-incoming Tcl syntax. This port is intended as a simplified RPC
+incoming TCL syntax. This port is intended as a simplified RPC
connection that can be used by clients to issue commands and get the
-output from the Tcl engine.
+output from the TCL engine.
@item @b{gdb_port} <@var{number}>
@cindex gdb_port
@@ -1088,7 +1089,7 @@
@*Force breakpoint type for gdb 'break' commands.
The raison d'etre for this option is to support GDB GUI's without
a hard/soft breakpoint concept where the default OpenOCD and
-GDB behavior is not sufficient. Note that GDB will use hardware
+GDB behaviour is not sufficient. Note that GDB will use hardware
breakpoints if the memory map has been set up for flash regions.
This option replaces older arm7_9 target commands that addressed
@@ -1096,16 +1097,16 @@
@item @b{gdb_detach} <@var{resume|reset|halt|nothing}>
@cindex gdb_detach
-@*Configures what OpenOCD will do when GDB detaches from the daemon.
-Default behavior is <@var{resume}>
+@*Configures what OpenOCD will do when gdb detaches from the daemon.
+Default behaviour is <@var{resume}>
@item @b{gdb_memory_map} <@var{enable|disable}>
@cindex gdb_memory_map
-@*Set to <@var{enable}> to cause OpenOCD to send the memory configuration to GDB when
-requested. GDB will then know when to set hardware breakpoints, and program flash
-using the GDB load command. @option{gdb_flash_program enable} must also be enabled
+@*Set to <@var{enable}> to cause OpenOCD to send the memory configuration to gdb when
+requested. gdb will then know when to set hardware breakpoints, and program flash
+using the gdb load command. @option{gdb_flash_program enable} will also need enabling
for flash programming to work.
-Default behavior is <@var{enable}>
+Default behaviour is <@var{enable}>
@xref{gdb_flash_program}.
@item @b{gdb_flash_program} <@var{enable|disable}>
@@ -1113,7 +1114,7 @@
@anchor{gdb_flash_program}
@*Set to <@var{enable}> to cause OpenOCD to program the flash memory when a
vFlash packet is received.
-Default behavior is <@var{enable}>
+Default behaviour is <@var{enable}>
@comment END GDB Items
@end itemize
@@ -1152,10 +1153,10 @@
@verbatim
interface arm-jtag-ew
@end verbatim
-@section Interface Command
+@section Interface Conmmand
-The interface command tells OpenOCD what type of JTAG dongle you are
-using. Depending on the type of dongle, you may need to have one or
+The interface command tells OpenOCD what type of jtag dongle you are
+using. Depending upon the type of dongle, you may need to have one or
more additional commands.
@itemize @bullet
@@ -1193,16 +1194,16 @@
@* Gateworks GW16012 JTAG programmer.
@item @b{jlink}
-@* Segger jlink USB adapter
+@* Segger jlink usb adapter
@item @b{rlink}
-@* Raisonance RLink USB adapter
+@* Raisonance RLink usb adapter
@item @b{vsllink}
@* vsllink is part of Versaloon which is a versatile USB programmer.
@item @b{arm-jtag-ew}
-@* Olimex ARM-JTAG-EW USB adapter
+@* Olimex ARM-JTAG-EW usb adapter
@comment - End parameters
@end itemize
@comment - End Interface
@@ -1282,7 +1283,7 @@
specified, the FTDI default value is used. This setting is only valid
if compiled with FTD2XX support.
-@b{TODO:} Confirm the following: On Windows the name needs to end with
+@b{TODO:} Confirm the following: On windows the name needs to end with
a ``space A''? Or not? It has to do with the FTD2xx driver. When must
this be added and when must it not be added? Why can't the code in the
interface or in OpenOCD automatically add this if needed? -- Duane.
@@ -1299,7 +1300,7 @@
@item @b{usbjtag}
"USBJTAG-1" layout described in the original OpenOCD diploma thesis
@item @b{jtagkey}
-Amontec JTAGkey and JTAGkey-Tiny
+Amontec JTAGkey and JTAGkey-tiny
@item @b{signalyzer}
Signalyzer
@item @b{olimex-jtag}
@@ -1325,17 +1326,17 @@
@item @b{ft2232_vid_pid} <@var{vid}> <@var{pid}>
@*The vendor ID and product ID of the FTDI FT2232 device. If not specified, the FTDI
-default values are used. Multiple <@var{vid}>, <@var{pid}> pairs may be given, e.g.
+default values are used. Multiple <@var{vid}>, <@var{pid}> pairs may be given, eg.
@example
ft2232_vid_pid 0x0403 0xcff8 0x15ba 0x0003
@end example
@item @b{ft2232_latency} <@var{ms}>
-@*On some systems using FT2232 based JTAG interfaces the FT_Read function call in
+@*On some systems using ft2232 based JTAG interfaces the FT_Read function call in
ft2232_read() fails to return the expected number of bytes. This can be caused by
USB communication delays and has proved hard to reproduce and debug. Setting the
-FT2232 latency timer to a larger value increases delays for short USB packets but it
+FT2232 latency timer to a larger value increases delays for short USB packages but it
also reduces the risk of timeouts before receiving the expected number of bytes.
-The OpenOCD default value is 2 and for some systems a value of 10 has proved useful.
+The OpenOCD default value is 2 and for some systems a value of 10 has proved useful.
@end itemize
@subsection ep93xx options
@@ -1348,9 +1349,9 @@
@cindex jtag_khz
It is debatable if this command belongs here - or in a board
-configuration file. In fact, in some situations the JTAG speed is
-changed during the target initialization process (i.e.: (1) slow at
-reset, (2) program the CPU clocks, (3) run fast)
+configuration file. In fact, in some situations the jtag speed is
+changed during the target initialization process (ie: (1) slow at
+reset, (2) program the cpu clocks, (3) run fast)
Speed 0 (khz) selects RTCK method. A non-zero speed is in KHZ. Hence: 3000 is 3mhz.
@@ -1358,11 +1359,11 @@
support the rate asked for, or can not translate from kHz to
jtag_speed, then an error is returned.
-Make sure the JTAG clock is no more than @math{1/6th CPU-Clock}. This is
+Make sure the jtag clock is no more than @math{1/6th CPU-Clock}. This is
especially true for synthesized cores (-S). Also see RTCK.
@b{NOTE: Script writers} If the target chip requires/uses RTCK -
-please use the command: 'jtag_rclk FREQ'. This Tcl proc (in
+please use the command: 'jtag_rclk FREQ'. This TCL proc (in
startup.tcl) attempts to enable RTCK, if that fails it falls back to
the specified frequency.
@@ -1371,7 +1372,7 @@
jtag_rclk 3000
@end example
-@item @b{DEPRECATED} @b{jtag_speed} - please use jtag_khz above.
+@item @b{DEPRICATED} @b{jtag_speed} - please use jtag_khz above.
@cindex jtag_speed
@*Limit the maximum speed of the JTAG interface. Usually, a value of zero means maximum
speed. The actual effect of this option depends on the JTAG interface used.
@@ -1415,7 +1416,7 @@
@section reset_config
-@b{Note:} To maintainer and integrators: Where exactly the
+@b{Note:} To maintainer types and integrators. Where exactly the
``reset configuration'' goes is a good question. It touches several
things at once. In the end, if you have a board file - the board file
should define it and assume 100% that the DONGLE supports
@@ -1425,17 +1426,17 @@
@* @b{Problems:}
@enumerate
-@item Every JTAG Dongle is slightly different, some dongles implement reset differently.
+@item Every JTAG Dongle is slightly different, some dongles impliment reset differently.
@item Every board is also slightly different; some boards tie TRST and SRST together.
@item Every chip is slightly different; some chips internally tie the two signals together.
-@item Some may not implement all of the signals the same way.
+@item Some may not impliment all of the signals the same way.
@item Some signals might be push-pull, others open-drain/collector.
@end enumerate
@b{Best Case:} OpenOCD can hold the SRST (push-button-reset), then
reset the TAP via TRST and send commands through the JTAG tap to halt
the CPU at the reset vector before the 1st instruction is executed,
and finally release the SRST signal.
-@*Depending on your board vendor, chip vendor, etc., these
+@*Depending upon your board vendor, your chip vendor, etc, these
signals may have slightly different names.
OpenOCD defines these signals in these terms:
@@ -1458,12 +1459,12 @@
[@var{combination}] is an optional value specifying broken reset
signal implementations. @option{srst_pulls_trst} states that the
-test logic is reset together with the reset of the system (e.g. Philips
+testlogic is reset together with the reset of the system (e.g. Philips
LPC2000, "broken" board layout), @option{trst_pulls_srst} says that
the system is reset together with the test logic (only hypothetical, I
haven't seen hardware with such a bug, and can be worked around).
-@option{combined} implies both @option{srst_pulls_trst} and
-@option{trst_pulls_srst}. The default behavior if no option given is
+@option{combined} imples both @option{srst_pulls_trst} and
+@option{trst_pulls_srst}. The default behaviour if no option given is
@option{separate}.
The [@var{trst_type}] and [@var{srst_type}] parameters allow the
@@ -1497,7 +1498,7 @@
@itemize @bullet
@item @b{Debug Target} A tap can be used by a GDB debug target
@item @b{Flash Programing} Some chips program the flash via JTAG
-@item @b{Boundry Scan} Some chips support boundary scan.
+@item @b{Boundry Scan} Some chips support boundry scan.
@end itemize
@@ -1528,7 +1529,7 @@
the size of the IR.
@comment END REQUIRED
@end itemize
-An example of a FOOBAR tap
+An example of a FOOBAR Tap
@example
jtag newtap foobar tap -irlen 7 -ircapture 0x42 -irmask 0x55
@end example
@@ -1541,12 +1542,12 @@
@itemize @bullet
@item @b{-expected-id NUMBER}
@* By default it is zero. If non-zero represents the
-expected tap ID used when the JTAG chain is examined. See below.
+expected tap ID used when the Jtag Chain is examined. See below.
@item @b{-disable}
@item @b{-enable}
@* By default not specified the tap is enabled. Some chips have a
-JTAG route controller (JRC) that is used to enable and/or disable
-specific JTAG taps. You can later enable or disable any JTAG tap via
+jtag route controller (JRC) that is used to enable and/or disable
+specific jtag taps. You can later enable or disable any JTAG tap via
the command @b{jtag tapenable DOTTED.NAME} or @b{jtag tapdisable
DOTTED.NAME}
@comment END Optional
@@ -1561,22 +1562,22 @@
@* newtap is a sub command of the ``jtag'' command
@item @b{Big Picture Background}
@*GDB Talks to OpenOCD using the GDB protocol via
-TCP/IP. OpenOCD then uses the JTAG interface (the dongle) to
+tcpip. OpenOCD then uses the JTAG interface (the dongle) to
control the JTAG chain on your board. Your board has one or more chips
in a @i{daisy chain configuration}. Each chip may have one or more
-JTAG taps. GDB ends up talking via OpenOCD to one of the taps.
+jtag taps. GDB ends up talking via OpenOCD to one of the taps.
@item @b{NAME Rules}
@*Names follow ``C'' symbol name rules (start with alpha ...)
@item @b{TAPNAME - Conventions}
@itemize @bullet
@item @b{tap} - should be used only FPGA or CPLD like devices with a single tap.
-@item @b{cpu} - the main CPU of the chip, alternatively @b{foo.arm} and @b{foo.dsp}
+@item @b{cpu} - the main cpu of the chip, alternatively @b{foo.arm} and @b{foo.dsp}
@item @b{flash} - if the chip has a flash tap, example: str912.flash
@item @b{bs} - for boundary scan if this is a seperate tap.
-@item @b{jrc} - for JTAG route controller (example: OMAP3530 found on Beagleboards)
+@item @b{jrc} - for jtag route controller (example: OMAP3530 found on Beagleboards)
@item @b{unknownN} - where N is a number if you have no idea what the tap is for
@item @b{Other names} - Freescale IMX31 has a SDMA (smart dma) with a JTAG tap, that tap should be called the ``sdma'' tap.
-@item @b{When in doubt} - use the chip maker's name in their data sheet.
+@item @b{When in doubt} - use the chip makers name in their data sheet.
@end itemize
@item @b{DOTTED.NAME}
@* @b{CHIPNAME}.@b{TAPNAME} creates the tap name, aka: the
@@ -1590,12 +1591,12 @@
@item @b{Multi Tap Example}
@* This example is based on the ST Microsystems STR912. See the ST
document titled: @b{STR91xFAxxx, Section 3.15 Jtag Interface, Page:
-28/102, Figure 3: JTAG chaining inside the STR91xFA}.
+28/102, Figure 3: Jtag chaining inside the STR91xFA}.
@url{http://eu.st.com/stonline/products/literature/ds/13495.pdf}
@*@b{checked: 28/nov/2008}
-The diagram shows that the TDO pin connects to the flash tap, flash TDI
+The diagram shows the TDO pin connects to the flash tap, flash TDI
connects to the CPU debug tap, CPU TDI connects to the boundary scan
tap which then connects to the TDI pin.
@@ -1630,7 +1631,7 @@
@* @b{Removed: 28/nov/2008} This command has been removed and replaced
by the ``jtag newtap'' command. The documentation remains here so that
one can easily convert the old syntax to the new syntax. About the old
-syntax: The old syntax is positional, i.e.: The 3rd parameter is the
+syntax: The old syntax is positional, ie: The 3rd parameter is the
``irmask''. The new syntax requires named prefixes, and supports
additional options, for example ``-expected-id 0x3f0f0f0f''. Please refer to the
@b{jtag newtap} command for details.
@@ -1656,20 +1657,20 @@
@cindex JRC
@cindex route controller
-These commands are used when your target has a JTAG route controller
-that effectively adds or removes a tap from the JTAG chain in a
+These commands are used when your target has a JTAG Route controller
+that effectively adds or removes a tap from the jtag chain in a
non-standard way.
The ``standard way'' to remove a tap would be to place the tap in
bypass mode. But with the advent of modern chips, this is not always a
good solution. Some taps operate slowly, others operate fast, and
-there are other JTAG clock synchronization problems one must face. To
-solve that problem, the JTAG route controller was introduced. Rather
-than ``bypass'' the tap, the tap is completely removed from the
+there are other JTAG clock syncronization problems one must face. To
+solve that problem, the JTAG Route controller was introduced. Rather
+then ``bypass'' the tap, the tap is completely removed from the
circuit and skipped.
-From OpenOCD's point of view, a JTAG tap is in one of 3 states:
+From OpenOCD's view point, a JTAG TAP is in one of 3 states:
@itemize @bullet
@item @b{Enabled - Not In ByPass} and has a variable bit length
@@ -1684,15 +1685,15 @@
This command returns 1 if the named tap is currently enabled, 0 if not.
This command exists so that scripts that manipulate a JRC (like the
-OMAP3530 has) can determine if OpenOCD thinks a tap is presently
-enabled or disabled.
+Omap3530 has) can determine if OpenOCD thinks a tap is presently
+enabled, or disabled.
@page
@node Target Configuration
@chapter Target Configuration
-This chapter discusses how to create a GDB debug target. Before
-creating a ``target'' a JTAG tap DOTTED.NAME must exist first.
+This chapter discusses how to create a GDB Debug Target. Before
+creating a ``target'' a JTAG Tap DOTTED.NAME must exist first.
@section targets [NAME]
@b{Note:} This command name is PLURAL - not singular.
@@ -1700,8 +1701,8 @@
With NO parameter, this plural @b{targets} command lists all known
targets in a human friendly form.
-With a parameter, this plural @b{targets} command sets the current
-target to the given name. (i.e.: If there are multiple debug targets)
+With a parameter, this pural @b{targets} command sets the current
+target to the given name. (ie: If there are multiple debug targets)
Example:
@verbatim
@@ -1721,7 +1722,7 @@
The TARGET command accepts these sub-commands:
@itemize @bullet
@item @b{create} .. parameters ..
-@* creates a new target, see below for details.
+@* creates a new target, See below for details.
@item @b{types}
@* Lists all supported target types (perhaps some are not yet in this document).
@item @b{names}
@@ -1767,8 +1768,8 @@
@b{Model:} The Tcl/Tk language has the concept of object commands. A
good example is a on screen button, once a button is created a button
-has a name (a path in Tk terms) and that name is useable as a 1st
-class command. For example in Tk, one can create a button and later
+has a name (a path in TK terms) and that name is useable as a 1st
+class command. For example in TK, one can create a button and later
configure it like this:
@example
@@ -1783,13 +1784,13 @@
@end example
In OpenOCD's terms, the ``target'' is an object just like a Tcl/Tk
-button. Commands available as a ``target object'' are:
+button. Commands avaialble as a ``target object'' are:
@comment START targetobj commands.
@itemize @bullet
@item @b{configure} - configure the target; see Target Config/Cget Options below
@item @b{cget} - query the target configuration; see Target Config/Cget Options below
-@item @b{curstate} - current target state (running, halt, etc.
+@item @b{curstate} - current target state (running, halt, etc)
@item @b{eventlist}
@* Intended for a human to see/read the currently configure target events.
@item @b{Various Memory Commands} See the ``mww'' command elsewhere.
@@ -1844,7 +1845,7 @@
via ``$_TARGETNAME configure'' see this example.
Syntactially, the option is: ``-event NAME BODY'' where NAME is a
-target event name, and BODY is a Tcl procedure or string of commands
+target event name, and BODY is a tcl procedure or string of commands
to execute.
The programmers model is the ``-command'' option used in Tcl/Tk
@@ -1864,9 +1865,9 @@
The following events are available:
@itemize @bullet
@item @b{debug-halted}
-@* The target has halted for debug reasons (i.e.: breakpoint)
+@* The target has halted for debug reasons (ie: breakpoint)
@item @b{debug-resumed}
-@* The target has resumed (i.e.: gdb said run)
+@* The target has resumed (ie: gdb said run)
@item @b{early-halted}
@* Occurs early in the halt process
@item @b{examine-end}
@@ -1888,7 +1889,7 @@
@item @b{gdb-flash-write-end}
@* After GDB writes to the flash
@item @b{gdb-start}
-@* Before the taret steps, gdb is trying to start/resume the target
+@* Before the taret steps, gdb is trying to start/resume the tarfget
@item @b{halted}
@* The target has halted
@item @b{old-gdb_program_config}
@@ -1959,7 +1960,7 @@
DOTTED.NAME, this name is also used to create the target object
command.
@item @b{TYPE}
-@* Specifies the target type, i.e.: ARM7TDMI, or Cortex-M3. Currently supported targets are:
+@* Specifies the target type, ie: arm7tdmi, or cortexM3. Currently supported targes are:
@comment START types
@itemize @minus
@item @b{arm7tdmi}
@@ -1977,7 +1978,8 @@
@comment end TYPES
@end itemize
@item @b{PARAMS}
-@*PARAMs are various target configuration parameters. The following ones are mandatory:
+@*PARAMs are various target configure parameters, the following are mandatory
+at configuration:
@comment START mandatory
@itemize @bullet
@item @b{-endian big|little}
@@ -1998,7 +2000,7 @@
@item @b{-work-area-size [ADDRESS]} specify/set the work area
@item @b{-work-area-backup [0|1]} does the work area get backed up
@item @b{-endian [big|little]}
-@item @b{-variant [NAME]} some chips have variants OpenOCD needs to know about
+@item @b{-variant [NAME]} some chips have varients OpenOCD needs to know about
@item @b{-chain-position DOTTED.NAME} the tap name this target refers to.
@end itemize
Example:
@@ -2011,14 +2013,14 @@
@}
@end example
-@section Target Variants
+@section Target Varients
@itemize @bullet
@item @b{arm7tdmi}
@* Unknown (please write me)
@item @b{arm720t}
-@* Unknown (please write me) (similar to arm7tdmi)
+@* Unknown (please write me) (simular to arm7tdmi)
@item @b{arm9tdmi}
-@* Variants: @option{arm920t}, @option{arm922t} and @option{arm940t}
+@* Varients: @option{arm920t}, @option{arm922t} and @option{arm940t}
This enables the hardware single-stepping support found on these
cores.
@item @b{arm920t}
@@ -2026,10 +2028,10 @@
@item @b{arm966e}
@* None (this is also used as the ARM946)
@item @b{cortex_m3}
-@* use variant <@var{-variant lm3s}> when debugging Luminary lm3s targets. This will cause
+@* use variant <@var{-variant lm3s}> when debugging luminary lm3s targets. This will cause
OpenOCD to use a software reset rather than asserting SRST to avoid a issue with clearing
the debug registers. This is fixed in Fury Rev B, DustDevil Rev B, Tempest, these revisions will
-be detected and the normal reset behavior used.
+be detected and the normal reset behaviour used.
@item @b{xscale}
@* Supported variants are @option{ixp42x}, @option{ixp45x}, @option{ixp46x},@option{pxa250}, @option{pxa255}, @option{pxa26x}.
@item @b{arm11}
@@ -2040,7 +2042,7 @@
OpenOCD to instead use an EJTAG software reset command to reset the
processor. You still need to enable @option{srst} on the reset
configuration command to enable OpenOCD hardware reset functionality.
-@comment END variants
+@comment END varients
@end itemize
@section working_area - Command Removed
@cindex working_area
@@ -2066,7 +2068,7 @@
@cindex Flash Configuration
@b{Note:} As of 28/nov/2008 OpenOCD does not know how to program a SPI
-flash that a micro may boot from. Perhaps you, the reader, would like to
+flash that a micro may boot from. Perhaps you the reader would like to
contribute support for this.
Flash Steps:
@@ -2079,7 +2081,7 @@
flash on your board.
@item GDB Flashing
@* Flashing via GDB requires the flash be configured via ``flash
-bank'', and the GDB flash features be enabled. See the daemon
+bank'', and the GDB flash features be enabled. See the Daemon
configuration section for more details.
@end enumerate
@@ -2173,16 +2175,16 @@
@subsection External Flash - cfi options
@cindex cfi options
-CFI flashes are external flash chips - often they are connected to a
-specific chip select on the CPU. By default, at hard reset, most
-CPUs have the ablity to ``boot'' from some flash chip - typically
-attached to the CPU's CS0 pin.
+CFI flash are external flash chips - often they are connected to a
+specific chip select on the micro. By default at hard reset most
+micros have the ablity to ``boot'' from some flash chip - typically
+attached to the chips CS0 pin.
For other chip selects: OpenOCD does not know how to configure, or
-access a specific chip select. Instead you, the human, might need to
-configure additional chip selects via other commands (like: mww) , or
+access a specific chip select. Instead you the human might need to via
+other commands (like: mww) configure additional chip selects, or
perhaps configure a GPIO pin that controls the ``write protect'' pin
-on the flash chip.
+on the FLASH chip.
@b{flash bank cfi} <@var{base}> <@var{size}> <@var{chip_width}> <@var{bus_width}>
<@var{target#}> [@var{jedec_probe}|@var{x16_as_x8}]
@@ -2192,11 +2194,11 @@
@var{chip_width} and @var{bus_width} are specified in bytes.
-The @var{jedec_probe} option is used to detect certain non-CFI flash ROMs, like AM29LV010 and similar types.
+The @var{jedec_probe} option is used to detect certain non-CFI flash roms, like AM29LV010 and similar types.
@var{x16_as_x8} ???
-@subsection Internal Flash (Microcontrollers)
+@subsection Internal Flash (Micro Controllers)
@subsubsection lpc2000 options
@cindex lpc2000 options
@@ -2228,7 +2230,7 @@
@cindex str9 options
@b{flash bank str9x} <@var{base}> <@var{size}> 0 0 <@var{target#}>
-@*The str9 needs the flash controller to be configured prior to Flash programming, e.g.
+@*The str9 needs the flash controller to be configured prior to Flash programming, eg.
@example
str9x flash_config 0 4 2 0 0x80000
@end example
@@ -2237,17 +2239,17 @@
@subsubsection str9 options (str9xpec driver)
@b{flash bank str9xpec} <@var{base}> <@var{size}> 0 0 <@var{target#}>
-@*Before using the flash commands the turbo mode must be enabled using str9xpec
+@*Before using the flash commands the turbo mode will need enabling using str9xpec
@option{enable_turbo} <@var{num>.}
Only use this driver for locking/unlocking the device or configuring the option bytes.
Use the standard str9 driver for programming. @xref{STR9 specific commands}.
-@subsubsection Stellaris (LM3Sxxx) options
-@cindex Stellaris (LM3Sxxx) options
+@subsubsection stellaris (LM3Sxxx) options
+@cindex stellaris (LM3Sxxx) options
@b{flash bank stellaris} <@var{base}> <@var{size}> 0 0 <@var{target#}>
-@*Stellaris flash plugin only require the @var{target#}.
+@*stellaris flash plugin only require the @var{target#}.
@subsubsection stm32x options
@cindex stm32x options
@@ -2281,12 +2283,12 @@
mflash bank pxa270 0x08000000 2 2 43 -1 51 0
@end example
-@section Microcontroller specific flash commands
+@section Micro Controller Specific Flash Commands
@subsection AT91SAM7 specific commands
@cindex AT91SAM7 specific commands
The flash configuration is deduced from the chip identification register. The flash
-controller handles erases automatically on a page (128/265 byte) basis, so erase is
+controller handles erases automatically on a page (128/265 byte) basis so erase is
not necessary for flash programming. AT91SAM7 processors with less than 512K flash
only have a single flash bank embedded on chip. AT91SAM7xx512 have two flash planes
that can be erased separatly. Only an EraseAll command is supported by the controller
@@ -2306,11 +2308,11 @@
@itemize @bullet
@item @b{str9xpec enable_turbo} <@var{num}>
@cindex str9xpec enable_turbo
-@*enable turbo mode, will simply remove the str9 from the chain and talk
+@*enable turbo mode, simply this will remove the str9 from the chain and talk
directly to the embedded flash controller.
@item @b{str9xpec disable_turbo} <@var{num}>
@cindex str9xpec disable_turbo
-@*restore the str9 into JTAG chain.
+@*restore the str9 into jtag chain.
@item @b{str9xpec lock} <@var{num}>
@cindex str9xpec lock
@*lock str9 device. The str9 will only respond to an unlock command that will
@@ -2334,13 +2336,13 @@
Standard driver @option{str9x} programmed via the str9 core. Normally used for
flash programming as it is faster than the @option{str9xpec} driver.
@item
-Direct programming @option{str9xpec} using the flash controller. This is an
+Direct programming @option{str9xpec} using the flash controller, this is
ISC compilant (IEEE 1532) tap connected in series with the str9 core. The str9
core does not need to be running to program using this flash driver. Typical use
for this driver is locking/unlocking the target and programming the option bytes.
@end enumerate
-Before we run any commands using the @option{str9xpec} driver we must first disable
+Before we run any cmds using the @option{str9xpec} driver we must first disable
the str9 core. This example assumes the @option{str9xpec} driver has been
configured for flash bank 0.
@example
@@ -2361,7 +2363,7 @@
The above example will read the str9 option bytes.
When performing a unlock remember that you will not be able to halt the str9 - it
has been locked. Halting the core is not required for the @option{str9xpec} driver
-as mentioned above, just issue the commands above manually or from a telnet prompt.
+as mentioned above, just issue the cmds above manually or from a telnet prompt.
@subsection STR9 configuration
@cindex STR9 configuration
@@ -2371,7 +2373,7 @@
@cindex str9x flash_config
@*Configure str9 flash controller.
@example
-e.g. str9x flash_config 0 4 2 0 0x80000
+eg. str9x flash_config 0 4 2 0 0x80000
This will setup
BBSR - Boot Bank Size register
NBBSR - Non Boot Bank Size register
@@ -2431,12 +2433,12 @@
@end itemize
-@node General commands
-@chapter General commands
+@node General Commands
+@chapter General Commands
@cindex commands
The commands documented in this chapter here are common commands that
-you, as a human, may want to type and see the output of. Configuration type
+you a human may want to type and see the output of. Configuration type
commands are documented elsewhere.
Intent:
@@ -2444,10 +2446,10 @@
@item @b{Source Of Commands}
@* OpenOCD commands can occur in a configuration script (discussed
elsewhere) or typed manually by a human or supplied programatically,
-or via one of several TCP/IP Ports.
+or via one of several Tcp/Ip Ports.
@item @b{From the human}
-@* A human should interact with the telnet interface (default port: 4444,
+@* A human should interact with the Telnet interface (default port: 4444,
or via GDB, default port 3333)
To issue commands from within a GDB session, use the @option{monitor}
@@ -2455,7 +2457,7 @@
command. All output is relayed through the GDB session.
@item @b{Machine Interface}
-The Tcl interface's intent is to be a machine interface. The default Tcl
+The TCL interface intent is to be a machine interface. The default TCL
port is 5555.
@end itemize
@@ -2469,7 +2471,7 @@
@subsection shutdown
@cindex shutdown
-@*Close the OpenOCD daemon, disconnecting all clients (GDB, telnet, other).
+@*Close the OpenOCD daemon, disconnecting all clients (GDB, Telnet, Other).
@subsection debug_level [@var{n}]
@cindex debug_level
@@ -2478,13 +2480,13 @@
@subsection fast [@var{enable|disable}]
@cindex fast
-@*Default disabled. Set default behavior of OpenOCD to be "fast and dangerous". For instance ARM7/9 DCC memory
+@*Default disabled. Set default behaviour of OpenOCD to be "fast and dangerous". For instance ARM7/9 DCC memory
downloads and fast memory access will work if the JTAG interface isn't too fast and
the core doesn't run at a too low frequency. Note that this option only changes the default
and that the indvidual options, like DCC memory downloads, can be enabled and disabled
individually.
-The target specific "dangerous" optimization tweaking options may come and go
+The target specific "dangerous" optimisation tweaking options may come and go
as more robust and user friendly ways are found to ensure maximum throughput
and robustness with a minimum of configuration.
@@ -2501,7 +2503,7 @@
@subsection script <@var{file}>
@cindex script
@*Execute commands from <file>
-See also: ``source [find FILENAME]''
+Also see: ``source [find FILENAME]''
@section Target state handling
@subsection power <@var{on}|@var{off}>
@@ -2514,8 +2516,8 @@
@cindex reg
@*Access a single register by its number[@option{#}] or by its [@option{name}].
No arguments: list all available registers for the current target.
-Number or name argument: display a register.
-Number or name and value arguments: set register value.
+Number or name argument: display a register
+Number or name and value arguments: set register value
@subsection poll [@option{on}|@option{off}]
@cindex poll
@@ -2534,7 +2536,7 @@
@cindex wait_halt
@*Wait for the target to enter debug mode. Optional [@option{ms}] is
a timeout in milliseconds. Default [@option{ms}] is 5 seconds if no
-arg is given.
+arg given.
@subsection resume [@var{address}]
@cindex resume
@@ -2565,18 +2567,18 @@
@subsection soft_reset_halt
@cindex reset
-@*Requesting target halt and executing a soft reset. This is often used
+@*Requesting target halt and executing a soft reset. This often used
when a target cannot be reset and halted. The target, after reset is
released begins to execute code. OpenOCD attempts to stop the CPU and
-then sets the program counter back to the reset vector. Unfortunately
-the code that was executed may have left the hardware in an unknown
+then sets the Program counter back at the reset vector. Unfortunatlly
+that code that was executed may have left hardware in an unknown
state.
@section Memory access commands
@subsection meminfo
-display available RAM memory.
-@subsection Memory peek/poke type commands
+display available ram memory.
+@subsection Memory Peek/Poke type commands
These commands allow accesses of a specific size to the memory
system. Often these are used to configure the current target in some
special way. For example - one may need to write certian values to the
@@ -2584,7 +2586,7 @@
@enumerate
@item To change the current target see the ``targets'' (plural) command
-@item In system level scripts these commands are deprecated, please use the TARGET object versions.
+@item In system level scripts these commands are depricated, please use the TARGET object versions.
@end enumerate
@itemize @bullet
@@ -2608,7 +2610,7 @@
@*write memory byte (8bit)
@end itemize
-@section Image loading commands
+@section Image Loading Commands
@subsection load_image
@b{load_image} <@var{file}> <@var{address}> [@option{bin}|@option{ihex}|@option{elf}]
@cindex load_image
@@ -2619,18 +2621,18 @@
@cindex fast_load_image
@anchor{fast_load_image}
@*Normally you should be using @b{load_image} or GDB load. However, for
-testing purposes or when I/O overhead is significant(OpenOCD running on an embedded
-host), storing the image in memory and uploading the image to the target
+testing purposes or when IO overhead is significant(OpenOCD running on embedded
+host), then storing the image in memory and uploading the image to the target
can be a way to upload e.g. multiple debug sessions when the binary does not change.
-Arguments are the same as @b{load_image}, but the image is stored in OpenOCD host
+Arguments as @b{load_image}, but image is stored in OpenOCD host
memory, i.e. does not affect target. This approach is also useful when profiling
-target programming performance as I/O and target programming can easily be profiled
-separately.
+target programming performance as IO and target programming can easily be profiled
+seperately.
@subsection fast_load
@b{fast_load}
@cindex fast_image
@anchor{fast_image}
-@*Loads an image stored in memory by @b{fast_load_image} to the current target. Must be preceeded by fast_load_image.
+@*Loads image stored in memory by @b{fast_load_image} to current target. Must be preceeded by fast_load_image.
@subsection dump_image
@b{dump_image} <@var{file}> <@var{address}> <@var{size}>
@cindex dump_image
@@ -2641,7 +2643,7 @@
@b{verify_image} <@var{file}> <@var{address}> [@option{bin}|@option{ihex}|@option{elf}]
@cindex verify_image
@*Verify <@var{file}> against target memory starting at <@var{address}>.
-This will first attempt a comparison using a CRC checksum, if this fails it will try a binary compare.
+This will first attempt comparison using a crc checksum, if this fails it will try a binary compare.
@section Breakpoint commands
@@ -2661,22 +2663,21 @@
@*remove watchpoint <adress>
@end itemize
-@section Misc commands
-@cindex Other target commands
+@section Misc Commands
+@cindex Other Target Commands
@itemize
@item @b{profile} <@var{seconds}> <@var{gmon.out}>
-Profiling samples the CPU's program counter as quickly as possible, which is useful for non-intrusive stochastic profiling.
-
+Profiling samples the CPU PC as quickly as OpenOCD is able, which will be used as a random sampling of PC.
@end itemize
-@section Target specific commands
-@cindex Target specific commands
+@section Target Specific Commands
+@cindex Target Specific Commands
@page
-@section Architecture specific commands
-@cindex Architecture specific commands
+@section Architecture Specific Commands
+@cindex Architecture Specific Commands
@subsection ARMV4/5 specific commands
@cindex ARMV4/5 specific commands
@@ -2699,7 +2700,7 @@
@cindex ARM7/9 specific commands
These commands are specific to ARM7 and ARM9 targets, like ARM7TDMI, ARM720t,
-ARM920T or ARM926EJ-S.
+ARM920t or ARM926EJ-S.
@itemize @bullet
@item @b{arm7_9 dbgrq} <@var{enable}|@var{disable}>
@cindex arm7_9 dbgrq
@@ -2710,13 +2711,13 @@
@anchor{arm7_9 fast_memory_access}
@*Allow OpenOCD to read and write memory without checking completion of
the operation. This provides a huge speed increase, especially with USB JTAG
-cables (FT2232), but might be unsafe if used with targets running at very low
-speeds, like the 32kHz startup clock of an AT91RM9200.
+cables (FT2232), but might be unsafe if used with targets running at a very low
+speed, like the 32kHz startup clock of an AT91RM9200.
@item @b{arm7_9 dcc_downloads} <@var{enable}|@var{disable}>
@cindex arm7_9 dcc_downloads
@*Enable the use of the debug communications channel (DCC) to write larger (>128 byte)
amounts of memory. DCC downloads offer a huge speed increase, but might be potentially
-unsafe, especially with targets running at very low speeds. This command was introduced
+unsafe, especially with targets running at a very low speed. This command was introduced
with OpenOCD rev. 60.
@end itemize
@@ -2748,7 +2749,7 @@
@option{reset} @option{undef} @option{swi} @option{pabt} @option{dabt} @option{reserved}
@option{irq} @option{fiq}.
-Can also be used on other ARM9 based cores such as ARM966, ARM920T and ARM926EJ-S.
+Can also be used on other arm9 based cores, arm966, arm920t and arm926ejs.
@end itemize
@subsection ARM966E specific commands
@@ -2772,8 +2773,8 @@
@*display/modify cp15 (interpreted access) <@option{opcode}> [@option{value}] [@option{address}]
@item @b{arm920t cache_info}
@cindex arm920t cache_info
-@*Print information about the caches found. This allows to see whether your target
-is an ARM920T (2x16kByte cache) or ARM922T (2x8kByte cache).
+@*Print information about the caches found. This allows you to see if your target
+is a ARM920T (2x16kByte cache) or ARM922T (2x8kByte cache).
@item @b{arm920t md<bhw>_phys} <@var{addr}> [@var{count}]
@cindex arm920t md<bhw>_phys
@*Display memory at physical address addr.
@@ -2791,8 +2792,8 @@
@*Translate a virtual address to a physical address.
@end itemize
-@subsection ARM926EJ-S specific commands
-@cindex ARM926EJ-S specific commands
+@subsection ARM926EJS specific commands
+@cindex ARM926EJS specific commands
@itemize @bullet
@item @b{arm926ejs cp15} <@var{num}> [@var{value}]
@@ -2844,8 +2845,8 @@
encoding of the [M4:M0] bits of the PSR.
@end itemize
-@section Target requests
-@cindex Target requests
+@section Target Requests
+@cindex Target Requests
OpenOCD can handle certain target requests, currently debugmsg are only supported for arm7_9 and cortex_m3.
See libdcc in the contrib dir for more details.
@itemize @bullet
@@ -2856,13 +2857,13 @@
@node JTAG Commands
@chapter JTAG Commands
-@cindex JTAG Commands
+@cindex JTAG commands
Generally most people will not use the bulk of these commands. They
are mostly used by the OpenOCD developers or those who need to
directly manipulate the JTAG taps.
In general these commands control JTAG taps at a very low level. For
-example if you need to control a JTAG Route Controller (i.e.: the
+example if you need to control a JTAG Route Controller (ie: the
OMAP3530 on the Beagle Board has one) you might use these commands in
a script or an event procedure.
@section Commands
@@ -2942,27 +2943,27 @@
@node TFTP
@chapter TFTP
@cindex TFTP
-If OpenOCD runs on an embedded host(as ZY1000 does), then TFTP can
-be used to access files on PCs (Either the developer's PC or some other PC).
+If OpenOCD runs on an embedded host(as ZY1000 does), then tftp can
+be used to access files on PCs(either developer PC or some other PC).
The way this works on the ZY1000 is to prefix a filename by
-"/tftp/ip/" and append the TFTP path on the TFTP
-server (tftpd). E.g. "load_image /tftp/10.0.0.96/c:\temp\abc.elf" will
+"/tftp/ip/" and append the tftp path on the tftp
+server(tftpd). E.g. "load_image /tftp/10.0.0.96/c:\temp\abc.elf" will
load c:\temp\abc.elf from the developer pc (10.0.0.96) into memory as
if the file was hosted on the embedded host.
-In order to achieve decent performance, you must choose a TFTP server
-that supports a packet size bigger than the default packet size (512 bytes). There
-are numerous TFTP servers out there (free and commercial) and you will have to do
+In order to achieve decent performance, you must choose a tftp server
+that supports a packet size bigger than the default packet size(512 bytes). There
+are numerous tftp servers out there(free and commercial) and you will have to do
a bit of googling to find something that fits your requirements.
-@node Sample scripts
-@chapter Sample scripts
+@node Sample Scripts
+@chapter Sample Scripts
@cindex scripts
This page shows how to use the target library.
-The configuration script can be divided into the following sections:
+The configuration script can be divided in the following section:
@itemize @bullet
@item daemon configuration
@item interface
@@ -2992,14 +2993,14 @@
@cindex Connecting to GDB
@anchor{Connecting to GDB}
Use GDB 6.7 or newer with OpenOCD if you run into trouble. For
-instance GDB 6.3 has a known bug that produces bogus memory access
+instance 6.3 has a known bug where it produces bogus memory access
errors, which has since been fixed: look up 1836 in
@url{http://sourceware.org/cgi-bin/gnatsweb.pl?database=gdb}
@*OpenOCD can communicate with GDB in two ways:
@enumerate
@item
-A socket (TCP) connection is typically started as follows:
+A socket (tcp) connection is typically started as follows:
@example
target remote localhost:3333
@end example
@@ -3015,14 +3016,14 @@
@end enumerate
@*To see a list of available OpenOCD commands type @option{monitor help} on the
-GDB command line.
+GDB commandline.
OpenOCD supports the gdb @option{qSupported} packet, this enables information
-to be sent by the GDB remote server (i.e. OpenOCD) to GDB. Typical information includes
-packet size and the device's memory map.
+to be sent by the gdb server (OpenOCD) to GDB. Typical information includes
+packet size and device memory map.
Previous versions of OpenOCD required the following GDB options to increase
-the packet size and speed up GDB communication:
+the packet size and speed up GDB communication.
@example
set remote memory-write-packet-size 1024
set remote memory-write-packet-size fixed
@@ -3034,25 +3035,25 @@
@section Programming using GDB
@cindex Programming using GDB
-By default the target memory map is sent to GDB. This can be disabled by
-the following OpenOCD configuration option:
+By default the target memory map is sent to GDB, this can be disabled by
+the following OpenOCD config option:
@example
gdb_memory_map disable
@end example
-For this to function correctly a valid flash configuration must also be set
+For this to function correctly a valid flash config must also be configured
in OpenOCD. For faster performance you should also configure a valid
working area.
Informing GDB of the memory map of the target will enable GDB to protect any
-flash areas of the target and use hardware breakpoints by default. This means
+flash area of the target and use hardware breakpoints by default. This means
that the OpenOCD option @option{gdb_breakpoint_override} is not required when
using a memory map. @xref{gdb_breakpoint_override}.
-To view the configured memory map in GDB, use the GDB command @option{info mem}
-All other unassigned addresses within GDB are treated as RAM.
+To view the configured memory map in GDB, use the gdb command @option{info mem}
+All other unasigned addresses within GDB are treated as RAM.
-GDB 6.8 and higher set any memory area not in the memory map as inaccessible.
-This can be changed to the old behavior by using the following GDB command
+GDB 6.8 and higher set any memory area not in the memory map as inaccessible,
+this can be changed to the old behaviour by using the following GDB command.
@example
set mem inaccessible-by-default off
@end example
@@ -3065,7 +3066,7 @@
will be used.
If the target needs configuring before GDB programming, an event
-script can be executed:
+script can be executed.
@example
$_TARGETNAME configure -event EVENTNAME BODY
@end example
@@ -3073,11 +3074,11 @@
To verify any flash programming the GDB command @option{compare-sections}
can be used.
-@node Tcl scripting API
-@chapter Tcl scripts
-@cindex Tcl scripting API
-@cindex Tcl scripts
-@section API rules
+@node TCL scripting API
+@chapter TCL scripts
+@cindex TCL scripting API
+@cindex TCL scripts
+@section API Rules
The commands are stateless. E.g. the telnet command line has a concept
of currently active target, the Tcl API proc's take this sort of state
@@ -3114,36 +3115,36 @@
Lists returned must be relatively small. Otherwise a range
should be passed in to the proc in question.
-@section Internal low-level Commands
+@section Internal Low Level Commands
-By low-level, the intent is a human would not directly use these commands.
+By Low level, the intent is a human would not directly use these commands.
-Low-level commands are (should be) prefixed with "openocd_", e.g. openocd_flash_banks
+Low level commands are (should be) prefixed with "openocd_", e.g. openocd_flash_banks
is the low level API upon which "flash banks" is implemented.
@itemize @bullet
@item @b{ocd_mem2array} <@var{varname}> <@var{width}> <@var{addr}> <@var{nelems}>
-Read memory and return as a Tcl array for script processing
+Read memory and return as a TCL array for script processing
@item @b{ocd_array2mem} <@var{varname}> <@var{width}> <@var{addr}> <@var{nelems}>
-Convert a Tcl array to memory locations and write the values
+Convert a TCL array to memory locations and write the values
@item @b{ocd_flash_banks} <@var{driver}> <@var{base}> <@var{size}> <@var{chip_width}> <@var{bus_width}> <@var{target}> [@option{driver options} ...]
Return information about the flash banks
@end itemize
OpenOCD commands can consist of two words, e.g. "flash banks". The
-startup.tcl "unknown" proc will translate this into a Tcl proc
+startup.tcl "unknown" proc will translate this into a tcl proc
called "flash_banks".
-@section OpenOCD specific global variables
+@section OpenOCD specific Global Variables
@subsection HostOS
-Real Tcl has ::tcl_platform(), and pl...
[truncated message content] |
|
From: ntfreak at B. <nt...@ma...> - 2009-03-19 23:27:45
|
Author: ntfreak
Date: 2009-03-19 23:27:43 +0100 (Thu, 19 Mar 2009)
New Revision: 1419
Modified:
trunk/src/target/target/str9comstick.cfg
Log:
- fix incorrect str9comstick cfg
Modified: trunk/src/target/target/str9comstick.cfg
===================================================================
--- trunk/src/target/target/str9comstick.cfg 2009-03-19 15:51:28 UTC (rev 1418)
+++ trunk/src/target/target/str9comstick.cfg 2009-03-19 22:27:43 UTC (rev 1419)
@@ -10,7 +10,18 @@
#jtag scan chain
#format L IRC IRCM IDCODE (Length, IR Capture, IR Capture Mask, IDCODE)
+if { [info exists CHIPNAME] } {
+ set _CHIPNAME $CHIPNAME
+} else {
+ set _CHIPNAME str912
+}
+if { [info exists ENDIAN] } {
+ set _ENDIAN $ENDIAN
+} else {
+ set _ENDIAN little
+}
+
if { [info exists FLASHTAPID ] } {
set _FLASHTAPID $FLASHTAPID
} else {
@@ -25,7 +36,6 @@
}
jtag newtap $_CHIPNAME cpu -irlen 4 -ircapture 0xf -irmask 0xf -expected-id $_CPUTAPID
-
if { [info exists BSTAPID ] } {
set _BSTAPID $BSTAPID
} else {
@@ -36,7 +46,20 @@
set _TARGETNAME [format "%s.cpu" $_CHIPNAME]
target create $_TARGETNAME arm966e -endian $_ENDIAN -chain-position $_TARGETNAME -variant arm966e
+$_TARGETNAME configure -event reset-init {
+ # We can increase speed now that we know the target is halted.
+ #jtag_rclk 3000
+
+ # -- Enable 96K RAM
+ # PFQBC enabled / DTCM & AHB wait-states disabled
+ mww 0x5C002034 0x0191
+
+ str9x flash_config 0 4 2 0 0x80000
+ flash protect 0 0 7 off
+}
+
$_TARGETNAME configure -work-area-virt 0 -work-area-phys 0x50000000 -work-area-size 16384 -work-area-backup 0
#flash bank <driver> <base> <size> <chip_width> <bus_width>
flash bank str9x 0x00000000 0x00080000 0 0 0
+flash bank str9x 0x00080000 0x00008000 0 0 0
|
|
From: <oh...@ma...> - 2009-03-19 16:51:30
|
Author: oharboe
Date: 2009-03-19 16:51:28 +0100 (Thu, 19 Mar 2009)
New Revision: 1418
Modified:
trunk/doc/openocd.texi
trunk/src/jtag/jtag.c
trunk/src/target/board/stm32f10x_128k_eval.cfg
Log:
Thomas Kindler <mai...@t-...> typos
Modified: trunk/doc/openocd.texi
===================================================================
--- trunk/doc/openocd.texi 2009-03-18 11:59:31 UTC (rev 1417)
+++ trunk/doc/openocd.texi 2009-03-19 15:51:28 UTC (rev 1418)
@@ -70,11 +70,11 @@
* Sample Scripts:: Sample Target Scripts
* TFTP:: TFTP
* GDB and OpenOCD:: Using GDB and OpenOCD
-* TCL scripting API:: Tcl scripting API
+* Tcl scripting API:: Tcl scripting API
* Upgrading:: Deprecated/Removed Commands
* Target library:: Target library
* FAQ:: Frequently Asked Questions
-* TCL Crash Course:: TCL Crash Course
+* Tcl Crash Course:: Tcl Crash Course
* License:: GNU Free Documentation License
@comment DO NOT use the plain word ``Index'', reason: CYGWIN filename
@comment case issue with ``Index.html'' and ``index.html''
@@ -92,14 +92,14 @@
devices.
@b{JTAG:} OpenOCD uses a ``hardware interface dongle'' to communicate
-with the JTAG (IEEE 1149.1) complient taps on your target board.
+with the JTAG (IEEE 1149.1) compliant taps on your target board.
-@b{Dongles:} OpenOCD currently many types of hardware dongles: USB
+@b{Dongles:} OpenOCD currently supports many types of hardware dongles: USB
Based, Parallel Port Based, and other standalone boxes that run
OpenOCD internally. See the section titled: @xref{JTAG Hardware Dongles}.
-@b{GDB Debug:} It allows ARM7 (ARM7TDMI and ARM720t), ARM9 (ARM920t,
-ARM922t, ARM926ej--s, ARM966e--s), XScale (PXA25x, IXP42x) and
+@b{GDB Debug:} It allows ARM7 (ARM7TDMI and ARM720t), ARM9 (ARM920T,
+ARM922T, ARM926EJ--S, ARM966E--S), XScale (PXA25x, IXP42x) and
Cortex-M3 (Luminary Stellaris LM3 and ST STM32) based cores to be
debugged via the GDB Protocol.
@@ -139,9 +139,9 @@
@enumerate
@item @b{Sell dongles} and include pre-built binaries
-@item @b{Supply tools} ie: A complete development solution
+@item @b{Supply tools} i.e.: A complete development solution
@item @b{Supply IDEs} like Eclipse, or RHIDE, etc.
-@item @b{Build packages} ie: RPM files, or DEB files for a Linux Distro
+@item @b{Build packages} i.e.: RPM files, or DEB files for a Linux Distro
@end enumerate
As a @b{PACKAGER} - you are at the top of the food chain. You solve
@@ -151,8 +151,8 @@
suggestions:
@enumerate
-@item @b{Always build with Printer Ports Enabled}
-@item @b{Try where possible to use LIBFTDI + LIBUSB} You cover more bases
+@item @b{Always build with printer ports enabled}.
+@item @b{Try to use LIBFTDI + LIBUSB where possible}. You cover more bases.
@end enumerate
It is your decision..
@@ -166,7 +166,7 @@
@item @b{MORE} platforms are supported
@item @b{MORE} complete solution
@end itemize
-@item @b{Why not LIBFTDI + LIBUSB} (ie: ftd2xx instead)
+@item @b{Why not LIBFTDI + LIBUSB} (i.e.: ftd2xx instead)
@itemize @bullet
@item @b{LESS} Some say it is slower.
@item @b{LESS} complex to distribute (external dependencies)
@@ -208,7 +208,7 @@
homepage (@uref{www.amontec.com}), as the JTAGkey uses a non-standard VID/PID.
@end itemize
-libftdi is supported under windows. Do not use versions earlier then 0.14.
+libftdi is supported under Windows. Do not use versions earlier then 0.14.
In general, the D2XX driver provides superior performance (several times as fast),
but has the draw-back of being binary-only - though that isn't that bad, as it isn't
@@ -282,7 +282,7 @@
FTDICHIP.COM closed source driver, or (2) the open (and free) driver
libftdi. Some claim the (closed) FTDICHIP.COM solution is faster.
-The FTDICHIP drivers come as either a (win32) ZIP file, or a (linux)
+The FTDICHIP drivers come as either a (win32) ZIP file, or a (Linux)
TAR.GZ file. You must unpack them ``some where'' convient. As of this
writing (12/26/2008) FTDICHIP does not supply means to install these
files ``in an appropriate place'' As a result, there are two
@@ -315,7 +315,7 @@
Cygwin/Linux LIBFTDI solution
Assumes:
- 1a) For Windows: The windows port of LIBUSB is in place.
+ 1a) For Windows: The Windows port of LIBUSB is in place.
1b) For Linux: libusb has been built and is inplace.
2) And libftdi has been built and installed
@@ -344,11 +344,11 @@
@node JTAG Hardware Dongles
@chapter JTAG Hardware Dongles
@cindex dongles
-@cindex ftdi
+@cindex FTDI
@cindex wiggler
@cindex zy1000
@cindex printer port
-@cindex usb adapter
+@cindex USB adapter
@cindex rtck
Defined: @b{dongle}: A small device that plugins into a computer and serves as
@@ -378,7 +378,7 @@
@section USB FT2232 Based
-There are many USB jtag dongles on the market, many of them are based
+There are many USB JTAG dongles on the market, many of them are based
on a chip from ``Future Technology Devices International'' (FTDI)
known as the FTDI FT2232.
@@ -505,7 +505,7 @@
@itemize @bullet
@item @b{ep93xx}
-@* An EP93xx based linux machine using the GPIO pins directly.
+@* An EP93xx based Linux machine using the GPIO pins directly.
@item @b{at91rm9200}
@* Like the EP93xx - but an ATMEL AT91RM9200 based solution using the GPIO pins on the chip.
@@ -589,8 +589,8 @@
@section Small configuration file method
-This is the prefered method, it is simple and is works well for many
-people. The developers of OpenOCD would encourage you to use this
+This is the preferred method. It is simple and works well for many
+people. The developers of OpenOCD would encourage you to use this
method. If you create a new configuration please email new
configurations to the development list.
@@ -663,10 +663,10 @@
Some key things you should look at and understand are:
@enumerate
-@item The RESET configuration of your debug environment as a hole
+@item The RESET configuration of your debug environment as a whole
@item Is there a ``work area'' that OpenOCD can use?
@* For ARM - work areas mean up to 10x faster downloads.
-@item For MMU/MPU based ARM chips (ie: ARM9 and later) will that work area still be available?
+@item For MMU/MPU based ARM chips (i.e.: ARM9 and later) will that work area still be available?
@item For complex targets (multiple chips) the JTAG SPEED becomes an issue.
@end enumerate
@@ -679,26 +679,25 @@
OpenOCD. These are guidelines for creating new boards and new target
configurations as of 28/Nov/2008.
-However, you the user of OpenOCD should be some what familiar with
+However, you, the user of OpenOCD, should be somewhat familiar with
this section as it should help explain some of the internals of what
you might be looking at.
-The user should find under @t{$(INSTALLDIR)/lib/openocd} the
-following directories:
+The user should find the following directories under @t{$(INSTALLDIR)/lib/openocd} :
@itemize @bullet
@item @b{interface}
-@*Think JTAG Dongle. Files that configure the jtag dongle go here.
+@*Think JTAG Dongle. Files that configure the JTAG dongle go here.
@item @b{board}
-@* Thing Circuit Board, PWA, PCB, they go by many names. Board files
+@* Think Circuit Board, PWA, PCB, they go by many names. Board files
contain initialization items that are specific to a board - for
example: The SDRAM initialization sequence for the board, or the type
of external flash and what address it is found at. Any initialization
-sequence to enable that external flash or sdram should be found in the
-board file. Boards may also contain multiple targets, ie: Two cpus, or
+sequence to enable that external flash or SDRAM should be found in the
+board file. Boards may also contain multiple targets, i.e.: Two CPUs, or
a CPU and an FPGA or CPLD.
@item @b{target}
-@* Think CHIP. The ``target'' directory represents a jtag tap (or
+@* Think chip. The ``target'' directory represents a JTAG tap (or
chip) OpenOCD should control, not a board. Two common types of targets
are ARM chips and FPGA or CPLD chips.
@end itemize
@@ -722,7 +721,7 @@
today, that said, perhaps some interfaces have only been used by the
sole developer who created it.
-@b{FIXME/NOTE:} We need to add support for a variable like TCL variable
+@b{FIXME/NOTE:} We need to add support for a variable like Tcl variable
tcl_platform(platform), it should be called jim_platform (because it
is jim, not real tcl) and it should contain 1 of 3 words: ``linux'',
``cygwin'' or ``mingw''
@@ -745,12 +744,12 @@
The board file should contain one or more @t{source [find
target/FOO.cfg]} statements along with any board specific things.
-In summery the board files should contain (if present)
+In summary the board files should contain (if present)
@enumerate
-@item External flash configuration (ie: the flash on CS0)
-@item SDRAM configuration (size, speed, etc)
-@item Board specific IO configuration (ie: GPIO pins might disable a 2nd flash)
+@item External flash configuration (i.e.: the flash on CS0)
+@item SDRAM configuration (size, speed, etc.
+@item Board specific IO configuration (i.e.: GPIO pins might disable a 2nd flash)
@item Multiple TARGET source statements
@item All things that are not ``inside a chip''
@item Things inside a chip go in a 'target' file
@@ -766,7 +765,7 @@
openocd -f target/FOOBAR.cfg
@end example
-In summery the target files should contain
+In summary the target files should contain
@enumerate
@item Set Defaults
@@ -793,8 +792,8 @@
@* When OpenOCD examines the JTAG chain, it will attempt to identify
every chip. If the @t{-expected-id} is nonzero, OpenOCD attempts
to verify the tap id number verses configuration file and may issue an
-error or warning like this. The hope is this will help pin point
-problem OpenOCD configurations.
+error or warning like this. The hope is that this will help to pinpoint
+problems in OpenOCD configurations.
@example
Info: JTAG tap: sam7x256.cpu tap/device found: 0x3f0f0f0f (Manufacturer: 0x787, Part: 0xf0f0, Version: 0x3)
@@ -830,12 +829,12 @@
@end itemize
-@subsection TCL Variables Guide Line
+@subsection Tcl Variables Guide Line
The Full Tcl/Tk language supports ``namespaces'' - JIM-Tcl does not.
Thus the rule we follow in OpenOCD is this: Variables that begin with
-a leading underscore are temporal in nature, and can be modified and
-used at will within a ?TARGET? configuration file
+a leading underscore are temporary in nature, and can be modified and
+used at will within a ?TARGET? configuration file.
@b{EXAMPLE:} The user should be able to do this:
@@ -849,14 +848,14 @@
source [find target/pxa270.cfg]
# variable: _TARGETNAME = network.cpu
# other commands can refer to the "network.cpu" tap.
- $_TARGETNAME configure .... params for this cpu..
+ $_TARGETNAME configure .... params for this CPU..
set ENDIAN little
set CHIPNAME video
source [find target/pxa270.cfg]
# variable: _TARGETNAME = video.cpu
# other commands can refer to the "video.cpu" tap.
- $_TARGETNAME configure .... params for this cpu..
+ $_TARGETNAME configure .... params for this CPU..
unset ENDIAN
set CHIPNAME xilinx
@@ -896,7 +895,7 @@
@end example
@subsection Creating Taps
-After the ``defaults'' are choosen, [see above], the taps are created.
+After the ``defaults'' are choosen [see above] the taps are created.
@b{SIMPLE example:} such as an Atmel AT91SAM7X256
@@ -943,7 +942,7 @@
@b{Tap Naming Convention}
-See the command ``jtag newtap'' for detail, but in breif the names you should use are:
+See the command ``jtag newtap'' for detail, but in brief the names you should use are:
@itemize @bullet
@item @b{tap}
@@ -963,20 +962,20 @@
@subsection Work Areas
Work areas are small RAM areas used by OpenOCD to speed up downloads,
-and to download small snippits of code to program flash chips.
+and to download small snippets of code to program flash chips.
-If the chip includes an form of ``on-chip-ram'' - and many do - define
+If the chip includes a form of ``on-chip-ram'' - and many do - define
a reasonable work area and use the ``backup'' option.
@b{PROBLEMS:} On more complex chips, this ``work area'' may become
-inaccessable if/when the application code enables or disables the MMU.
+inaccessible if/when the application code enables or disables the MMU.
@subsection ARM Core Specific Hacks
-If the chip has a DCC, enable it. If the chip is an arm9 with some
-special high speed download - enable it.
+If the chip has a DCC, enable it. If the chip is an ARM9 with some
+special high speed download features - enable it.
-If the chip has an ARM ``vector catch'' feature - by defeault enable
+If the chip has an ARM ``vector catch'' feature - by default enable
it for Undefined Instructions, Data Abort, and Prefetch Abort, if the
user is really writing a handler for those situations - they can
easily disable it. Experiance has shown the ``vector catch'' is
@@ -1010,31 +1009,31 @@
learn more about JIM here: @url{http://jim.berlios.de}
@itemize @bullet
-@item @b{JIM vrs TCL}
+@item @b{JIM vs. Tcl}
@* JIM-TCL is a stripped down version of the well known Tcl language,
which can be found here: @url{http://www.tcl.tk}. JIM-Tcl has far
fewer features. JIM-Tcl is a single .C file and a single .H file and
-impliments the basic TCL command set along. In contrast: Tcl 8.6 is a
-4.2MEG zip file containing 1540 files.
+impliments the basic Tcl command set along. In contrast: Tcl 8.6 is a
+4.2 MB .zip file containing 1540 files.
@item @b{Missing Features}
-@* Our practice has been: Add/clone the Real TCL feature if/when
+@* Our practice has been: Add/clone the real Tcl feature if/when
needed. We welcome JIM Tcl improvements, not bloat.
@item @b{Scripts}
@* OpenOCD configuration scripts are JIM Tcl Scripts. OpenOCD's
-command interpretor today (28/nov/2008) is a mixture of (newer)
-JIM-Tcl commands, and (older) the orginal command interpretor.
+command interpreter today (28/nov/2008) is a mixture of (newer)
+JIM-Tcl commands, and (older) the orginal command interpreter.
@item @b{Commands}
@* At the OpenOCD telnet command line (or via the GDB mon command) one
can type a Tcl for() loop, set variables, etc.
@item @b{Historical Note}
-@* JIM-Tcl was introduced to OpenOCD in Spring 2008.
+@* JIM-Tcl was introduced to OpenOCD in spring 2008.
-@item @b{Need a Crash Course In TCL?}
-@* See: @xref{TCL Crash Course}.
+@item @b{Need a Crash Course In Tcl?}
+@* See: @xref{Tcl Crash Course}.
@end itemize
@@ -1071,9 +1070,9 @@
@item @b{tcl_port} <@var{number}>
@cindex tcl_port
@*Intended as a machine interface. Port on which to listen for
-incoming TCL syntax. This port is intended as a simplified RPC
+incoming Tcl syntax. This port is intended as a simplified RPC
connection that can be used by clients to issue commands and get the
-output from the TCL engine.
+output from the Tcl engine.
@item @b{gdb_port} <@var{number}>
@cindex gdb_port
@@ -1089,7 +1088,7 @@
@*Force breakpoint type for gdb 'break' commands.
The raison d'etre for this option is to support GDB GUI's without
a hard/soft breakpoint concept where the default OpenOCD and
-GDB behaviour is not sufficient. Note that GDB will use hardware
+GDB behavior is not sufficient. Note that GDB will use hardware
breakpoints if the memory map has been set up for flash regions.
This option replaces older arm7_9 target commands that addressed
@@ -1097,16 +1096,16 @@
@item @b{gdb_detach} <@var{resume|reset|halt|nothing}>
@cindex gdb_detach
-@*Configures what OpenOCD will do when gdb detaches from the daemon.
-Default behaviour is <@var{resume}>
+@*Configures what OpenOCD will do when GDB detaches from the daemon.
+Default behavior is <@var{resume}>
@item @b{gdb_memory_map} <@var{enable|disable}>
@cindex gdb_memory_map
-@*Set to <@var{enable}> to cause OpenOCD to send the memory configuration to gdb when
-requested. gdb will then know when to set hardware breakpoints, and program flash
-using the gdb load command. @option{gdb_flash_program enable} will also need enabling
+@*Set to <@var{enable}> to cause OpenOCD to send the memory configuration to GDB when
+requested. GDB will then know when to set hardware breakpoints, and program flash
+using the GDB load command. @option{gdb_flash_program enable} must also be enabled
for flash programming to work.
-Default behaviour is <@var{enable}>
+Default behavior is <@var{enable}>
@xref{gdb_flash_program}.
@item @b{gdb_flash_program} <@var{enable|disable}>
@@ -1114,7 +1113,7 @@
@anchor{gdb_flash_program}
@*Set to <@var{enable}> to cause OpenOCD to program the flash memory when a
vFlash packet is received.
-Default behaviour is <@var{enable}>
+Default behavior is <@var{enable}>
@comment END GDB Items
@end itemize
@@ -1153,10 +1152,10 @@
@verbatim
interface arm-jtag-ew
@end verbatim
-@section Interface Conmmand
+@section Interface Command
-The interface command tells OpenOCD what type of jtag dongle you are
-using. Depending upon the type of dongle, you may need to have one or
+The interface command tells OpenOCD what type of JTAG dongle you are
+using. Depending on the type of dongle, you may need to have one or
more additional commands.
@itemize @bullet
@@ -1194,16 +1193,16 @@
@* Gateworks GW16012 JTAG programmer.
@item @b{jlink}
-@* Segger jlink usb adapter
+@* Segger jlink USB adapter
@item @b{rlink}
-@* Raisonance RLink usb adapter
+@* Raisonance RLink USB adapter
@item @b{vsllink}
@* vsllink is part of Versaloon which is a versatile USB programmer.
@item @b{arm-jtag-ew}
-@* Olimex ARM-JTAG-EW usb adapter
+@* Olimex ARM-JTAG-EW USB adapter
@comment - End parameters
@end itemize
@comment - End Interface
@@ -1283,7 +1282,7 @@
specified, the FTDI default value is used. This setting is only valid
if compiled with FTD2XX support.
-@b{TODO:} Confirm the following: On windows the name needs to end with
+@b{TODO:} Confirm the following: On Windows the name needs to end with
a ``space A''? Or not? It has to do with the FTD2xx driver. When must
this be added and when must it not be added? Why can't the code in the
interface or in OpenOCD automatically add this if needed? -- Duane.
@@ -1300,7 +1299,7 @@
@item @b{usbjtag}
"USBJTAG-1" layout described in the original OpenOCD diploma thesis
@item @b{jtagkey}
-Amontec JTAGkey and JTAGkey-tiny
+Amontec JTAGkey and JTAGkey-Tiny
@item @b{signalyzer}
Signalyzer
@item @b{olimex-jtag}
@@ -1326,17 +1325,17 @@
@item @b{ft2232_vid_pid} <@var{vid}> <@var{pid}>
@*The vendor ID and product ID of the FTDI FT2232 device. If not specified, the FTDI
-default values are used. Multiple <@var{vid}>, <@var{pid}> pairs may be given, eg.
+default values are used. Multiple <@var{vid}>, <@var{pid}> pairs may be given, e.g.
@example
ft2232_vid_pid 0x0403 0xcff8 0x15ba 0x0003
@end example
@item @b{ft2232_latency} <@var{ms}>
-@*On some systems using ft2232 based JTAG interfaces the FT_Read function call in
+@*On some systems using FT2232 based JTAG interfaces the FT_Read function call in
ft2232_read() fails to return the expected number of bytes. This can be caused by
USB communication delays and has proved hard to reproduce and debug. Setting the
-FT2232 latency timer to a larger value increases delays for short USB packages but it
+FT2232 latency timer to a larger value increases delays for short USB packets but it
also reduces the risk of timeouts before receiving the expected number of bytes.
-The OpenOCD default value is 2 and for some systems a value of 10 has proved useful.
+The OpenOCD default value is 2 and for some systems a value of 10 has proved useful.
@end itemize
@subsection ep93xx options
@@ -1349,9 +1348,9 @@
@cindex jtag_khz
It is debatable if this command belongs here - or in a board
-configuration file. In fact, in some situations the jtag speed is
-changed during the target initialization process (ie: (1) slow at
-reset, (2) program the cpu clocks, (3) run fast)
+configuration file. In fact, in some situations the JTAG speed is
+changed during the target initialization process (i.e.: (1) slow at
+reset, (2) program the CPU clocks, (3) run fast)
Speed 0 (khz) selects RTCK method. A non-zero speed is in KHZ. Hence: 3000 is 3mhz.
@@ -1359,11 +1358,11 @@
support the rate asked for, or can not translate from kHz to
jtag_speed, then an error is returned.
-Make sure the jtag clock is no more than @math{1/6th CPU-Clock}. This is
+Make sure the JTAG clock is no more than @math{1/6th CPU-Clock}. This is
especially true for synthesized cores (-S). Also see RTCK.
@b{NOTE: Script writers} If the target chip requires/uses RTCK -
-please use the command: 'jtag_rclk FREQ'. This TCL proc (in
+please use the command: 'jtag_rclk FREQ'. This Tcl proc (in
startup.tcl) attempts to enable RTCK, if that fails it falls back to
the specified frequency.
@@ -1372,7 +1371,7 @@
jtag_rclk 3000
@end example
-@item @b{DEPRICATED} @b{jtag_speed} - please use jtag_khz above.
+@item @b{DEPRECATED} @b{jtag_speed} - please use jtag_khz above.
@cindex jtag_speed
@*Limit the maximum speed of the JTAG interface. Usually, a value of zero means maximum
speed. The actual effect of this option depends on the JTAG interface used.
@@ -1416,7 +1415,7 @@
@section reset_config
-@b{Note:} To maintainer types and integrators. Where exactly the
+@b{Note:} To maintainer and integrators: Where exactly the
``reset configuration'' goes is a good question. It touches several
things at once. In the end, if you have a board file - the board file
should define it and assume 100% that the DONGLE supports
@@ -1426,17 +1425,17 @@
@* @b{Problems:}
@enumerate
-@item Every JTAG Dongle is slightly different, some dongles impliment reset differently.
+@item Every JTAG Dongle is slightly different, some dongles implement reset differently.
@item Every board is also slightly different; some boards tie TRST and SRST together.
@item Every chip is slightly different; some chips internally tie the two signals together.
-@item Some may not impliment all of the signals the same way.
+@item Some may not implement all of the signals the same way.
@item Some signals might be push-pull, others open-drain/collector.
@end enumerate
@b{Best Case:} OpenOCD can hold the SRST (push-button-reset), then
reset the TAP via TRST and send commands through the JTAG tap to halt
the CPU at the reset vector before the 1st instruction is executed,
and finally release the SRST signal.
-@*Depending upon your board vendor, your chip vendor, etc, these
+@*Depending on your board vendor, chip vendor, etc., these
signals may have slightly different names.
OpenOCD defines these signals in these terms:
@@ -1459,12 +1458,12 @@
[@var{combination}] is an optional value specifying broken reset
signal implementations. @option{srst_pulls_trst} states that the
-testlogic is reset together with the reset of the system (e.g. Philips
+test logic is reset together with the reset of the system (e.g. Philips
LPC2000, "broken" board layout), @option{trst_pulls_srst} says that
the system is reset together with the test logic (only hypothetical, I
haven't seen hardware with such a bug, and can be worked around).
-@option{combined} imples both @option{srst_pulls_trst} and
-@option{trst_pulls_srst}. The default behaviour if no option given is
+@option{combined} implies both @option{srst_pulls_trst} and
+@option{trst_pulls_srst}. The default behavior if no option given is
@option{separate}.
The [@var{trst_type}] and [@var{srst_type}] parameters allow the
@@ -1498,7 +1497,7 @@
@itemize @bullet
@item @b{Debug Target} A tap can be used by a GDB debug target
@item @b{Flash Programing} Some chips program the flash via JTAG
-@item @b{Boundry Scan} Some chips support boundry scan.
+@item @b{Boundry Scan} Some chips support boundary scan.
@end itemize
@@ -1529,7 +1528,7 @@
the size of the IR.
@comment END REQUIRED
@end itemize
-An example of a FOOBAR Tap
+An example of a FOOBAR tap
@example
jtag newtap foobar tap -irlen 7 -ircapture 0x42 -irmask 0x55
@end example
@@ -1542,12 +1541,12 @@
@itemize @bullet
@item @b{-expected-id NUMBER}
@* By default it is zero. If non-zero represents the
-expected tap ID used when the Jtag Chain is examined. See below.
+expected tap ID used when the JTAG chain is examined. See below.
@item @b{-disable}
@item @b{-enable}
@* By default not specified the tap is enabled. Some chips have a
-jtag route controller (JRC) that is used to enable and/or disable
-specific jtag taps. You can later enable or disable any JTAG tap via
+JTAG route controller (JRC) that is used to enable and/or disable
+specific JTAG taps. You can later enable or disable any JTAG tap via
the command @b{jtag tapenable DOTTED.NAME} or @b{jtag tapdisable
DOTTED.NAME}
@comment END Optional
@@ -1562,22 +1561,22 @@
@* newtap is a sub command of the ``jtag'' command
@item @b{Big Picture Background}
@*GDB Talks to OpenOCD using the GDB protocol via
-tcpip. OpenOCD then uses the JTAG interface (the dongle) to
+TCP/IP. OpenOCD then uses the JTAG interface (the dongle) to
control the JTAG chain on your board. Your board has one or more chips
in a @i{daisy chain configuration}. Each chip may have one or more
-jtag taps. GDB ends up talking via OpenOCD to one of the taps.
+JTAG taps. GDB ends up talking via OpenOCD to one of the taps.
@item @b{NAME Rules}
@*Names follow ``C'' symbol name rules (start with alpha ...)
@item @b{TAPNAME - Conventions}
@itemize @bullet
@item @b{tap} - should be used only FPGA or CPLD like devices with a single tap.
-@item @b{cpu} - the main cpu of the chip, alternatively @b{foo.arm} and @b{foo.dsp}
+@item @b{cpu} - the main CPU of the chip, alternatively @b{foo.arm} and @b{foo.dsp}
@item @b{flash} - if the chip has a flash tap, example: str912.flash
@item @b{bs} - for boundary scan if this is a seperate tap.
-@item @b{jrc} - for jtag route controller (example: OMAP3530 found on Beagleboards)
+@item @b{jrc} - for JTAG route controller (example: OMAP3530 found on Beagleboards)
@item @b{unknownN} - where N is a number if you have no idea what the tap is for
@item @b{Other names} - Freescale IMX31 has a SDMA (smart dma) with a JTAG tap, that tap should be called the ``sdma'' tap.
-@item @b{When in doubt} - use the chip makers name in their data sheet.
+@item @b{When in doubt} - use the chip maker's name in their data sheet.
@end itemize
@item @b{DOTTED.NAME}
@* @b{CHIPNAME}.@b{TAPNAME} creates the tap name, aka: the
@@ -1591,12 +1590,12 @@
@item @b{Multi Tap Example}
@* This example is based on the ST Microsystems STR912. See the ST
document titled: @b{STR91xFAxxx, Section 3.15 Jtag Interface, Page:
-28/102, Figure 3: Jtag chaining inside the STR91xFA}.
+28/102, Figure 3: JTAG chaining inside the STR91xFA}.
@url{http://eu.st.com/stonline/products/literature/ds/13495.pdf}
@*@b{checked: 28/nov/2008}
-The diagram shows the TDO pin connects to the flash tap, flash TDI
+The diagram shows that the TDO pin connects to the flash tap, flash TDI
connects to the CPU debug tap, CPU TDI connects to the boundary scan
tap which then connects to the TDI pin.
@@ -1631,7 +1630,7 @@
@* @b{Removed: 28/nov/2008} This command has been removed and replaced
by the ``jtag newtap'' command. The documentation remains here so that
one can easily convert the old syntax to the new syntax. About the old
-syntax: The old syntax is positional, ie: The 3rd parameter is the
+syntax: The old syntax is positional, i.e.: The 3rd parameter is the
``irmask''. The new syntax requires named prefixes, and supports
additional options, for example ``-expected-id 0x3f0f0f0f''. Please refer to the
@b{jtag newtap} command for details.
@@ -1657,20 +1656,20 @@
@cindex JRC
@cindex route controller
-These commands are used when your target has a JTAG Route controller
-that effectively adds or removes a tap from the jtag chain in a
+These commands are used when your target has a JTAG route controller
+that effectively adds or removes a tap from the JTAG chain in a
non-standard way.
The ``standard way'' to remove a tap would be to place the tap in
bypass mode. But with the advent of modern chips, this is not always a
good solution. Some taps operate slowly, others operate fast, and
-there are other JTAG clock syncronization problems one must face. To
-solve that problem, the JTAG Route controller was introduced. Rather
-then ``bypass'' the tap, the tap is completely removed from the
+there are other JTAG clock synchronization problems one must face. To
+solve that problem, the JTAG route controller was introduced. Rather
+than ``bypass'' the tap, the tap is completely removed from the
circuit and skipped.
-From OpenOCD's view point, a JTAG TAP is in one of 3 states:
+From OpenOCD's point of view, a JTAG tap is in one of 3 states:
@itemize @bullet
@item @b{Enabled - Not In ByPass} and has a variable bit length
@@ -1685,15 +1684,15 @@
This command returns 1 if the named tap is currently enabled, 0 if not.
This command exists so that scripts that manipulate a JRC (like the
-Omap3530 has) can determine if OpenOCD thinks a tap is presently
-enabled, or disabled.
+OMAP3530 has) can determine if OpenOCD thinks a tap is presently
+enabled or disabled.
@page
@node Target Configuration
@chapter Target Configuration
-This chapter discusses how to create a GDB Debug Target. Before
-creating a ``target'' a JTAG Tap DOTTED.NAME must exist first.
+This chapter discusses how to create a GDB debug target. Before
+creating a ``target'' a JTAG tap DOTTED.NAME must exist first.
@section targets [NAME]
@b{Note:} This command name is PLURAL - not singular.
@@ -1701,8 +1700,8 @@
With NO parameter, this plural @b{targets} command lists all known
targets in a human friendly form.
-With a parameter, this pural @b{targets} command sets the current
-target to the given name. (ie: If there are multiple debug targets)
+With a parameter, this plural @b{targets} command sets the current
+target to the given name. (i.e.: If there are multiple debug targets)
Example:
@verbatim
@@ -1722,7 +1721,7 @@
The TARGET command accepts these sub-commands:
@itemize @bullet
@item @b{create} .. parameters ..
-@* creates a new target, See below for details.
+@* creates a new target, see below for details.
@item @b{types}
@* Lists all supported target types (perhaps some are not yet in this document).
@item @b{names}
@@ -1768,8 +1767,8 @@
@b{Model:} The Tcl/Tk language has the concept of object commands. A
good example is a on screen button, once a button is created a button
-has a name (a path in TK terms) and that name is useable as a 1st
-class command. For example in TK, one can create a button and later
+has a name (a path in Tk terms) and that name is useable as a 1st
+class command. For example in Tk, one can create a button and later
configure it like this:
@example
@@ -1784,13 +1783,13 @@
@end example
In OpenOCD's terms, the ``target'' is an object just like a Tcl/Tk
-button. Commands avaialble as a ``target object'' are:
+button. Commands available as a ``target object'' are:
@comment START targetobj commands.
@itemize @bullet
@item @b{configure} - configure the target; see Target Config/Cget Options below
@item @b{cget} - query the target configuration; see Target Config/Cget Options below
-@item @b{curstate} - current target state (running, halt, etc)
+@item @b{curstate} - current target state (running, halt, etc.
@item @b{eventlist}
@* Intended for a human to see/read the currently configure target events.
@item @b{Various Memory Commands} See the ``mww'' command elsewhere.
@@ -1845,7 +1844,7 @@
via ``$_TARGETNAME configure'' see this example.
Syntactially, the option is: ``-event NAME BODY'' where NAME is a
-target event name, and BODY is a tcl procedure or string of commands
+target event name, and BODY is a Tcl procedure or string of commands
to execute.
The programmers model is the ``-command'' option used in Tcl/Tk
@@ -1865,9 +1864,9 @@
The following events are available:
@itemize @bullet
@item @b{debug-halted}
-@* The target has halted for debug reasons (ie: breakpoint)
+@* The target has halted for debug reasons (i.e.: breakpoint)
@item @b{debug-resumed}
-@* The target has resumed (ie: gdb said run)
+@* The target has resumed (i.e.: gdb said run)
@item @b{early-halted}
@* Occurs early in the halt process
@item @b{examine-end}
@@ -1889,7 +1888,7 @@
@item @b{gdb-flash-write-end}
@* After GDB writes to the flash
@item @b{gdb-start}
-@* Before the taret steps, gdb is trying to start/resume the tarfget
+@* Before the taret steps, gdb is trying to start/resume the target
@item @b{halted}
@* The target has halted
@item @b{old-gdb_program_config}
@@ -1960,7 +1959,7 @@
DOTTED.NAME, this name is also used to create the target object
command.
@item @b{TYPE}
-@* Specifies the target type, ie: arm7tdmi, or cortexM3. Currently supported targes are:
+@* Specifies the target type, i.e.: ARM7TDMI, or Cortex-M3. Currently supported targets are:
@comment START types
@itemize @minus
@item @b{arm7tdmi}
@@ -1978,8 +1977,7 @@
@comment end TYPES
@end itemize
@item @b{PARAMS}
-@*PARAMs are various target configure parameters, the following are mandatory
-at configuration:
+@*PARAMs are various target configuration parameters. The following ones are mandatory:
@comment START mandatory
@itemize @bullet
@item @b{-endian big|little}
@@ -2000,7 +1998,7 @@
@item @b{-work-area-size [ADDRESS]} specify/set the work area
@item @b{-work-area-backup [0|1]} does the work area get backed up
@item @b{-endian [big|little]}
-@item @b{-variant [NAME]} some chips have varients OpenOCD needs to know about
+@item @b{-variant [NAME]} some chips have variants OpenOCD needs to know about
@item @b{-chain-position DOTTED.NAME} the tap name this target refers to.
@end itemize
Example:
@@ -2013,14 +2011,14 @@
@}
@end example
-@section Target Varients
+@section Target Variants
@itemize @bullet
@item @b{arm7tdmi}
@* Unknown (please write me)
@item @b{arm720t}
-@* Unknown (please write me) (simular to arm7tdmi)
+@* Unknown (please write me) (similar to arm7tdmi)
@item @b{arm9tdmi}
-@* Varients: @option{arm920t}, @option{arm922t} and @option{arm940t}
+@* Variants: @option{arm920t}, @option{arm922t} and @option{arm940t}
This enables the hardware single-stepping support found on these
cores.
@item @b{arm920t}
@@ -2028,10 +2026,10 @@
@item @b{arm966e}
@* None (this is also used as the ARM946)
@item @b{cortex_m3}
-@* use variant <@var{-variant lm3s}> when debugging luminary lm3s targets. This will cause
+@* use variant <@var{-variant lm3s}> when debugging Luminary lm3s targets. This will cause
OpenOCD to use a software reset rather than asserting SRST to avoid a issue with clearing
the debug registers. This is fixed in Fury Rev B, DustDevil Rev B, Tempest, these revisions will
-be detected and the normal reset behaviour used.
+be detected and the normal reset behavior used.
@item @b{xscale}
@* Supported variants are @option{ixp42x}, @option{ixp45x}, @option{ixp46x},@option{pxa250}, @option{pxa255}, @option{pxa26x}.
@item @b{arm11}
@@ -2042,7 +2040,7 @@
OpenOCD to instead use an EJTAG software reset command to reset the
processor. You still need to enable @option{srst} on the reset
configuration command to enable OpenOCD hardware reset functionality.
-@comment END varients
+@comment END variants
@end itemize
@section working_area - Command Removed
@cindex working_area
@@ -2068,7 +2066,7 @@
@cindex Flash Configuration
@b{Note:} As of 28/nov/2008 OpenOCD does not know how to program a SPI
-flash that a micro may boot from. Perhaps you the reader would like to
+flash that a micro may boot from. Perhaps you, the reader, would like to
contribute support for this.
Flash Steps:
@@ -2081,7 +2079,7 @@
flash on your board.
@item GDB Flashing
@* Flashing via GDB requires the flash be configured via ``flash
-bank'', and the GDB flash features be enabled. See the Daemon
+bank'', and the GDB flash features be enabled. See the daemon
configuration section for more details.
@end enumerate
@@ -2175,16 +2173,16 @@
@subsection External Flash - cfi options
@cindex cfi options
-CFI flash are external flash chips - often they are connected to a
-specific chip select on the micro. By default at hard reset most
-micros have the ablity to ``boot'' from some flash chip - typically
-attached to the chips CS0 pin.
+CFI flashes are external flash chips - often they are connected to a
+specific chip select on the CPU. By default, at hard reset, most
+CPUs have the ablity to ``boot'' from some flash chip - typically
+attached to the CPU's CS0 pin.
For other chip selects: OpenOCD does not know how to configure, or
-access a specific chip select. Instead you the human might need to via
-other commands (like: mww) configure additional chip selects, or
+access a specific chip select. Instead you, the human, might need to
+configure additional chip selects via other commands (like: mww) , or
perhaps configure a GPIO pin that controls the ``write protect'' pin
-on the FLASH chip.
+on the flash chip.
@b{flash bank cfi} <@var{base}> <@var{size}> <@var{chip_width}> <@var{bus_width}>
<@var{target#}> [@var{jedec_probe}|@var{x16_as_x8}]
@@ -2194,11 +2192,11 @@
@var{chip_width} and @var{bus_width} are specified in bytes.
-The @var{jedec_probe} option is used to detect certain non-CFI flash roms, like AM29LV010 and similar types.
+The @var{jedec_probe} option is used to detect certain non-CFI flash ROMs, like AM29LV010 and similar types.
@var{x16_as_x8} ???
-@subsection Internal Flash (Micro Controllers)
+@subsection Internal Flash (Microcontrollers)
@subsubsection lpc2000 options
@cindex lpc2000 options
@@ -2230,7 +2228,7 @@
@cindex str9 options
@b{flash bank str9x} <@var{base}> <@var{size}> 0 0 <@var{target#}>
-@*The str9 needs the flash controller to be configured prior to Flash programming, eg.
+@*The str9 needs the flash controller to be configured prior to Flash programming, e.g.
@example
str9x flash_config 0 4 2 0 0x80000
@end example
@@ -2239,17 +2237,17 @@
@subsubsection str9 options (str9xpec driver)
@b{flash bank str9xpec} <@var{base}> <@var{size}> 0 0 <@var{target#}>
-@*Before using the flash commands the turbo mode will need enabling using str9xpec
+@*Before using the flash commands the turbo mode must be enabled using str9xpec
@option{enable_turbo} <@var{num>.}
Only use this driver for locking/unlocking the device or configuring the option bytes.
Use the standard str9 driver for programming. @xref{STR9 specific commands}.
-@subsubsection stellaris (LM3Sxxx) options
-@cindex stellaris (LM3Sxxx) options
+@subsubsection Stellaris (LM3Sxxx) options
+@cindex Stellaris (LM3Sxxx) options
@b{flash bank stellaris} <@var{base}> <@var{size}> 0 0 <@var{target#}>
-@*stellaris flash plugin only require the @var{target#}.
+@*Stellaris flash plugin only require the @var{target#}.
@subsubsection stm32x options
@cindex stm32x options
@@ -2283,12 +2281,12 @@
mflash bank pxa270 0x08000000 2 2 43 -1 51 0
@end example
-@section Micro Controller Specific Flash Commands
+@section Microcontroller specific flash commands
@subsection AT91SAM7 specific commands
@cindex AT91SAM7 specific commands
The flash configuration is deduced from the chip identification register. The flash
-controller handles erases automatically on a page (128/265 byte) basis so erase is
+controller handles erases automatically on a page (128/265 byte) basis, so erase is
not necessary for flash programming. AT91SAM7 processors with less than 512K flash
only have a single flash bank embedded on chip. AT91SAM7xx512 have two flash planes
that can be erased separatly. Only an EraseAll command is supported by the controller
@@ -2308,11 +2306,11 @@
@itemize @bullet
@item @b{str9xpec enable_turbo} <@var{num}>
@cindex str9xpec enable_turbo
-@*enable turbo mode, simply this will remove the str9 from the chain and talk
+@*enable turbo mode, will simply remove the str9 from the chain and talk
directly to the embedded flash controller.
@item @b{str9xpec disable_turbo} <@var{num}>
@cindex str9xpec disable_turbo
-@*restore the str9 into jtag chain.
+@*restore the str9 into JTAG chain.
@item @b{str9xpec lock} <@var{num}>
@cindex str9xpec lock
@*lock str9 device. The str9 will only respond to an unlock command that will
@@ -2336,13 +2334,13 @@
Standard driver @option{str9x} programmed via the str9 core. Normally used for
flash programming as it is faster than the @option{str9xpec} driver.
@item
-Direct programming @option{str9xpec} using the flash controller, this is
+Direct programming @option{str9xpec} using the flash controller. This is an
ISC compilant (IEEE 1532) tap connected in series with the str9 core. The str9
core does not need to be running to program using this flash driver. Typical use
for this driver is locking/unlocking the target and programming the option bytes.
@end enumerate
-Before we run any cmds using the @option{str9xpec} driver we must first disable
+Before we run any commands using the @option{str9xpec} driver we must first disable
the str9 core. This example assumes the @option{str9xpec} driver has been
configured for flash bank 0.
@example
@@ -2363,7 +2361,7 @@
The above example will read the str9 option bytes.
When performing a unlock remember that you will not be able to halt the str9 - it
has been locked. Halting the core is not required for the @option{str9xpec} driver
-as mentioned above, just issue the cmds above manually or from a telnet prompt.
+as mentioned above, just issue the commands above manually or from a telnet prompt.
@subsection STR9 configuration
@cindex STR9 configuration
@@ -2373,7 +2371,7 @@
@cindex str9x flash_config
@*Configure str9 flash controller.
@example
-eg. str9x flash_config 0 4 2 0 0x80000
+e.g. str9x flash_config 0 4 2 0 0x80000
This will setup
BBSR - Boot Bank Size register
NBBSR - Non Boot Bank Size register
@@ -2433,12 +2431,12 @@
@end itemize
-@node General Commands
-@chapter General Commands
+@node General commands
+@chapter General commands
@cindex commands
The commands documented in this chapter here are common commands that
-you a human may want to type and see the output of. Configuration type
+you, as a human, may want to type and see the output of. Configuration type
commands are documented elsewhere.
Intent:
@@ -2446,10 +2444,10 @@
@item @b{Source Of Commands}
@* OpenOCD commands can occur in a configuration script (discussed
elsewhere) or typed manually by a human or supplied programatically,
-or via one of several Tcp/Ip Ports.
+or via one of several TCP/IP Ports.
@item @b{From the human}
-@* A human should interact with the Telnet interface (default port: 4444,
+@* A human should interact with the telnet interface (default port: 4444,
or via GDB, default port 3333)
To issue commands from within a GDB session, use the @option{monitor}
@@ -2457,7 +2455,7 @@
command. All output is relayed through the GDB session.
@item @b{Machine Interface}
-The TCL interface intent is to be a machine interface. The default TCL
+The Tcl interface's intent is to be a machine interface. The default Tcl
port is 5555.
@end itemize
@@ -2471,7 +2469,7 @@
@subsection shutdown
@cindex shutdown
-@*Close the OpenOCD daemon, disconnecting all clients (GDB, Telnet, Other).
+@*Close the OpenOCD daemon, disconnecting all clients (GDB, telnet, other).
@subsection debug_level [@var{n}]
@cindex debug_level
@@ -2480,13 +2478,13 @@
@subsection fast [@var{enable|disable}]
@cindex fast
-@*Default disabled. Set default behaviour of OpenOCD to be "fast and dangerous". For instance ARM7/9 DCC memory
+@*Default disabled. Set default behavior of OpenOCD to be "fast and dangerous". For instance ARM7/9 DCC memory
downloads and fast memory access will work if the JTAG interface isn't too fast and
the core doesn't run at a too low frequency. Note that this option only changes the default
and that the indvidual options, like DCC memory downloads, can be enabled and disabled
individually.
-The target specific "dangerous" optimisation tweaking options may come and go
+The target specific "dangerous" optimization tweaking options may come and go
as more robust and user friendly ways are found to ensure maximum throughput
and robustness with a minimum of configuration.
@@ -2503,7 +2501,7 @@
@subsection script <@var{file}>
@cindex script
@*Execute commands from <file>
-Also see: ``source [find FILENAME]''
+See also: ``source [find FILENAME]''
@section Target state handling
@subsection power <@var{on}|@var{off}>
@@ -2516,8 +2514,8 @@
@cindex reg
@*Access a single register by its number[@option{#}] or by its [@option{name}].
No arguments: list all available registers for the current target.
-Number or name argument: display a register
-Number or name and value arguments: set register value
+Number or name argument: display a register.
+Number or name and value arguments: set register value.
@subsection poll [@option{on}|@option{off}]
@cindex poll
@@ -2536,7 +2534,7 @@
@cindex wait_halt
@*Wait for the target to enter debug mode. Optional [@option{ms}] is
a timeout in milliseconds. Default [@option{ms}] is 5 seconds if no
-arg given.
+arg is given.
@subsection resume [@var{address}]
@cindex resume
@@ -2567,18 +2565,18 @@
@subsection soft_reset_halt
@cindex reset
-@*Requesting target halt and executing a soft reset. This often used
+@*Requesting target halt and executing a soft reset. This is often used
when a target cannot be reset and halted. The target, after reset is
released begins to execute code. OpenOCD attempts to stop the CPU and
-then sets the Program counter back at the reset vector. Unfortunatlly
-that code that was executed may have left hardware in an unknown
+then sets the program counter back to the reset vector. Unfortunately
+the code that was executed may have left the hardware in an unknown
state.
@section Memory access commands
@subsection meminfo
-display available ram memory.
-@subsection Memory Peek/Poke type commands
+display available RAM memory.
+@subsection Memory peek/poke type commands
These commands allow accesses of a specific size to the memory
system. Often these are used to configure the current target in some
special way. For example - one may need to write certian values to the
@@ -2586,7 +2584,7 @@
@enumerate
@item To change the current target see the ``targets'' (plural) command
-@item In system level scripts these commands are depricated, please use the TARGET object versions.
+@item In system level scripts these commands are deprecated, please use the TARGET object versions.
@end enumerate
@itemize @bullet
@@ -2610,7 +2608,7 @@
@*write memory byte (8bit)
@end itemize
-@section Image Loading Commands
+@section Image loading commands
@subsection load_image
@b{load_image} <@var{file}> <@var{address}> [@option{bin}|@option{ihex}|@option{elf}]
@cindex load_image
@@ -2621,18 +2619,18 @@
@cindex fast_load_image
@anchor{fast_load_image}
@*Normally you should be using @b{load_image} or GDB load. However, for
-testing purposes or when IO overhead is significant(OpenOCD running on embedded
-host), then storing the image in memory and uploading the image to the target
+testing purposes or when I/O overhead is significant(OpenOCD running on an embedded
+host), storing the image in memory and uploading the image to the target
can be a way to upload e.g. multiple debug sessions when the binary does not change.
-Arguments as @b{load_image}, but image is stored in OpenOCD host
+Arguments are the same as @b{load_image}, but the image is stored in OpenOCD host
memory, i.e. does not affect target. This approach is also useful when profiling
-target programming performance as IO and target programming can easily be profiled
-seperately.
+target programming performance as I/O and target programming can easily be profiled
+separately.
@subsection fast_load
@b{fast_load}
@cindex fast_image
@anchor{fast_image}
-@*Loads image stored in memory by @b{fast_load_image} to current target. Must be preceeded by fast_load_image.
+@*Loads an image stored in memory by @b{fast_load_image} to the current target. Must be preceeded by fast_load_image.
@subsection dump_image
@b{dump_image} <@var{file}> <@var{address}> <@var{size}>
@cindex dump_image
@@ -2643,7 +2641,7 @@
@b{verify_image} <@var{file}> <@var{address}> [@option{bin}|@option{ihex}|@option{elf}]
@cindex verify_image
@*Verify <@var{file}> against target memory starting at <@var{address}>.
-This will first attempt comparison using a crc checksum, if this fails it will try a binary compare.
+This will first attempt a comparison using a CRC checksum, if this fails it will try a binary compare.
@section Breakpoint commands
@@ -2663,21 +2661,22 @@
@*remove watchpoint <adress>
@end itemize
-@section Misc Commands
-@cindex Other Target Commands
+@section Misc commands
+@cindex Other target commands
@itemize
@item @b{profile} <@var{seconds}> <@var{gmon.out}>
-Profiling samples the CPU PC as quickly as OpenOCD is able, which will be used as a random sampling of PC.
+Profiling samples the CPU's program counter as quickly as possible, which is useful for non-intrusive stochastic profiling.
+
@end itemize
-@section Target Specific Commands
-@cindex Target Specific Commands
+@section Target specific commands
+@cindex Target specific commands
@page
-@section Architecture Specific Commands
-@cindex Architecture Specific Commands
+@section Architecture specific commands
+@cindex Architecture specific commands
@subsection ARMV4/5 specific commands
@cindex ARMV4/5 specific commands
@@ -2700,7 +2699,7 @@
@cindex ARM7/9 specific commands
These commands are specific to ARM7 and ARM9 targets, like ARM7TDMI, ARM720t,
-ARM920t or ARM926EJ-S.
+ARM920T or ARM926EJ-S.
@itemize @bullet
@item @b{arm7_9 dbgrq} <@var{enable}|@var{disable}>
@cindex arm7_9 dbgrq
@@ -2711,13 +2710,13 @@
@anchor{arm7_9 fast_memory_access}
@*Allow OpenOCD to read and write memory without checking completion of
the operation. This provides a huge speed increase, especially with USB JTAG
-cables (FT2232), but might be unsafe if used with targets running at a very low
-speed, like the 32kHz startup clock of an AT91RM9200.
+cables (FT2232), but might be unsafe if used with targets running at very low
+speeds, like the 32kHz startup clock of an AT91RM9200.
@item @b{arm7_9 dcc_downloads} <@var{enable}|@var{disable}>
@cindex arm7_9 dcc_downloads
@*Enable the use of the debug communications channel (DCC) to write larger (>128 byte)
amounts of memory. DCC downloads offer a huge speed increase, but might be potentially
-unsafe, especially with targets running at a very low speed. This command was introduced
+unsafe, especially with targets running at very low speeds. This command was introduced
with OpenOCD rev. 60.
@end itemize
@@ -2749,7 +2748,7 @@
@option{reset} @option{undef} @option{swi} @option{pabt} @option{dabt} @option{reserved}
@option{irq} @option{fiq}.
-Can also be used on other arm9 based cores, arm966, arm920t and arm926ejs.
+Can also be used on other ARM9 based cores such as ARM966, ARM920T and ARM926EJ-S.
@end itemize
@subsection ARM966E specific commands
@@ -2773,8 +2772,8 @@
@*display/modify cp15 (interpreted access) <@option{opcode}> [@option{value}] [@option{address}]
@item @b{arm920t cache_info}
@cindex arm920t cache_info
-@*Print information about the caches found. This allows you to see if your target
-is a ARM920T (2x16kByte cache) or ARM922T (2x8kByte cache).
+@*Print information about the caches found. This allows to see whether your target
+is an ARM920T (2x16kByte cache) or ARM922T (2x8kByte cache).
@item @b{arm920t md<bhw>_phys} <@var{addr}> [@var{count}]
@cindex arm920t md<bhw>_phys
@*Display memory at physical address addr.
@@ -2792,8 +2791,8 @@
@*Translate a virtual address to a physical address.
@end itemize
-@subsection ARM926EJS specific commands
-@cindex ARM926EJS specific commands
+@subsection ARM926EJ-S specific commands
+@cindex ARM926EJ-S specific commands
@itemize @bullet
@item @b{arm926ejs cp15} <@var{num}> [@var{value}]
@@ -2845,8 +2844,8 @@
encoding of the [M4:M0] bits of the PSR.
@end itemize
-@section Target Requests
-@cindex Target Requests
+@section Target requests
+@cindex Target requests
OpenOCD can handle certain target requests, currently debugmsg are only supported for arm7_9 and cortex_m3.
See libdcc in the contrib dir for more details.
@itemize @bullet
@@ -2857,13 +2856,13 @@
@node JTAG Commands
@chapter JTAG Commands
-@cindex JTAG commands
+@cindex JTAG Commands
Generally most people will not use the bulk of these commands. They
are mostly used by the OpenOCD developers or those who need to
directly manipulate the JTAG taps.
In general these commands control JTAG taps at a very low level. For
-example if you need to control a JTAG Route Controller (ie: the
+example if you need to control a JTAG Route Controller (i.e.: the
OMAP3530 on the Beagle Board has one) you might use these commands in
a script or an event procedure.
@section Commands
@@ -2943,27 +2942,27 @@
@node TFTP
@chapter TFTP
@cindex TFTP
-If OpenOCD runs on an embedded host(as ZY1000 does), then tftp can
-be used to access files on PCs(either developer PC or some other PC).
+If OpenOCD runs on an embedded host(as ZY1000 does), then TFTP can
+be used to access files on PCs (Either the developer's PC or some other PC).
The way this works on the ZY1000 is to prefix a filename by
-"/tftp/ip/" and append the tftp path on the tftp
-server(tftpd). E.g. "load_image /tftp/10.0.0.96/c:\temp\abc.elf" will
+"/tftp/ip/" and append the TFTP path on the TFTP
+server (tftpd). E.g. "load_image /tftp/10.0.0.96/c:\temp\abc.elf" will
load c:\temp\abc.elf from the developer pc (10.0.0.96) into memory as
if the file was hosted on the embedded host.
-In order to achieve decent performance, you must choose a tftp server
-that supports a packet size bigger than the default packet size(512 bytes). There
-are numerous tftp servers out there(free and commercial) and you will have to do
+In order to achieve decent performance, you must choose a TFTP server
+that supports a packet size bigger than the default packet size (512 bytes). There
+are numerous TFTP servers out there (free and commercial) and you will have to do
a bit of googling to find something that fits your requirements.
-@node Sample Scripts
-@chapter Sample Scripts
+@node Sample scripts
+@chapter Sample scripts
@cindex scripts
This page shows how to use the target library.
-The configuration script can be divided in the following section:
+The configuration script can be divided into the following sections:
@itemize @bullet
@item daemon configuration
@item interface
@@ -2993,14 +2992,14 @@
@cindex Connecting to GDB
@anchor{Connecting to GDB}
Use GDB 6.7 or newer with OpenOCD if you run into trouble. For
-instance 6.3 has a known bug where it produces bogus memory access
+instance GDB 6.3 has a known bug that produces bogus memory access
errors, which has since been fixed: look up 1836 in
@url{http://sourceware.org/cgi-bin/gnatsweb.pl?database=gdb}
@*OpenOCD can communicate with GDB in two ways:
@enumerate
@item
-A socket (tcp) connection is typically started as follows:
+A socket (TCP) connection is typically started as follows:
@example
target remote localhost:3333
@end example
@@ -3016,14 +3015,14 @@
@end enumerate
@*To see a list of available OpenOCD commands type @option{monitor help} on the
-GDB commandline.
+GDB command line.
OpenOCD supports the gdb @option{qSupported} packet, this enables information
-to be sent by the gdb server (OpenOCD) to GDB. Typical information includes
-packet size and device memory map.
+to be sent by the GDB remote server (i.e. OpenOCD) to GDB. Typical information includes
+packet size and the device's memory map.
Previous versions of OpenOCD required the following GDB options to increase
-the packet size and speed up GDB communication.
+the packet size and speed up GDB communication:
@example
set remote memory-write-packet-size 1024
set remote memory-write-packet-size fixed
@@ -3035,25 +3034,25 @@
@section Programming using GDB
@cindex Programming using GDB
-By default the target memory map is sent to GDB, this can be disabled by
-the following OpenOCD config option:
+By default the target memory map is sent to GDB. This can be disabled by
+the following OpenOCD configuration option:
@example
gdb_memory_map disable
@end example
-For this to function correctly a valid flash config must also be configured
+For this to function correctly a valid flash configuration must also be set
in OpenOCD. For faster performance you should also configure a valid
working area.
Informing GDB of the memory map of the target will enable GDB to protect any
-flash area of the target and use hardware breakpoints by default. This means
+flash areas of the target and use hardware breakpoints by default. This means
that the OpenOCD option @option{gdb_breakpoint_override} is not required when
using a memory map. @xref{gdb_breakpoint_override}.
-To view the configured memory map in GDB, use the gdb command @option{info mem}
-All other unasigned addresses within GDB are treated as RAM.
+To view the configured memory map in GDB, use the GDB command @option{info mem}
+All other unassigned addresses within GDB are treated as RAM.
-GDB 6.8 and higher set any memory area not in the memory map as inaccessible,
-this can be changed to the old behaviour by using the following GDB command.
+GDB 6.8 and higher set any memory area not in the memory map as inaccessible.
+This can be changed to the old behavior by using the following GDB command
@example
set mem inaccessible-by-default off
@end example
@@ -3066,7 +3065,7 @@
will be used.
If the target needs configuring before GDB programming, an event
-script can be executed.
+script can be executed:
@example
$_TARGETNAME configure -event EVENTNAME BODY
@end example
@@ -3074,11 +3073,11 @@
To verify any flash programming the GDB command @option{compare-sections}
can be used.
-@node TCL scripting API
-@chapter TCL scripts
-@cindex TCL scripting API
-@cindex TCL scripts
-@section API Rules
+@node Tcl scripting API
+@chapter Tcl scripts
+@cindex Tcl scripting API
+@cindex Tcl scripts
+@section API rules
The commands are stateless. E.g. the telnet command line has a concept
of currently active target, the Tcl API proc's take this sort of state
@@ -3115,36 +3114,36 @@
Lists returned must be relatively small. Otherwise a range
should be passed in to the proc in question.
-@section Internal Low Level Commands
+@section Internal low-level Commands
-By Low level, the intent is a human would not directly use these commands.
+By low-level, the intent is a human would not directly use these commands.
-Low level commands are (should be) prefixed with "openocd_", e.g. openocd_flash_banks
+Low-level commands are (should be) prefixed with "openocd_", e.g. openocd_flash_banks
is the low level API upon which "flash banks" is implemented.
@itemize @bullet
@item @b{ocd_mem2array} <@var{varname}> <@var{width}> <@var{addr}> <@var{nelems}>
-Read memory and return as a TCL array for script processing
+Read memory and return as a Tcl array for script processing
@item @b{ocd_array2mem} <@var{varname}> <@var{width}> <@var{addr}> <@var{nelems}>
-Convert a TCL array to memory locations and write the values
+Convert a Tcl array to memory locations and write the values
@item @b{ocd_flash_banks} <@var{driver}> <@var{base}> <@var{size}> <@var{chip_width}> <@var{bus_width}> <@var{target}> [@option{driver options} ...]
Return information about the flash banks
@end itemize
OpenOCD commands can consist of two words, e.g. "flash banks". The
-startup.tcl "unknown" proc will translate this into a tcl proc
+startup.tcl "unknown" proc will translate this into a Tcl proc
called "flash_banks".
-@section OpenOCD specific Global Variables
+@section OpenOCD specific global variables
@subsection HostOS
-Real TCL has ::tcl_platfo...
[truncated message content] |
|
From: oharboe at B. <oh...@ma...> - 2009-03-18 12:59:47
|
Author: oharboe
Date: 2009-03-18 12:59:31 +0100 (Wed, 18 Mar 2009)
New Revision: 1417
Modified:
trunk/doc/openocd.texi
trunk/src/server/gdb_server.c
Log:
Hiroshi Ito <it...@ml...> typos
Modified: trunk/doc/openocd.texi
===================================================================
--- trunk/doc/openocd.texi 2009-03-18 11:43:09 UTC (rev 1416)
+++ trunk/doc/openocd.texi 2009-03-18 11:59:31 UTC (rev 1417)
@@ -1083,7 +1083,7 @@
@section GDB Items
@itemize @bullet
-@item @b{gdb_breakpoint_override} <@var{hard|soft|disabled}>
+@item @b{gdb_breakpoint_override} <@var{hard|soft|disable}>
@cindex gdb_breakpoint_override
@anchor{gdb_breakpoint_override}
@*Force breakpoint type for gdb 'break' commands.
@@ -1097,7 +1097,7 @@
@item @b{gdb_detach} <@var{resume|reset|halt|nothing}>
@cindex gdb_detach
-@*Configures what OpenOCD will do when gdb detaches from the daeman.
+@*Configures what OpenOCD will do when gdb detaches from the daemon.
Default behaviour is <@var{resume}>
@item @b{gdb_memory_map} <@var{enable|disable}>
Modified: trunk/src/server/gdb_server.c
===================================================================
--- trunk/src/server/gdb_server.c 2009-03-18 11:43:09 UTC (rev 1416)
+++ trunk/src/server/gdb_server.c 2009-03-18 11:59:31 UTC (rev 1417)
@@ -2387,7 +2387,7 @@
register_command(command_context, NULL, "gdb_report_data_abort", handle_gdb_report_data_abort_command,
COMMAND_CONFIG, "enable or disable report data");
register_command(command_context, NULL, "gdb_breakpoint_override", handle_gdb_breakpoint_override_command,
- COMMAND_EXEC, "hard/soft/disabled - force breakpoint type for gdb 'break' commands."
+ COMMAND_EXEC, "hard/soft/disable - force breakpoint type for gdb 'break' commands."
"The raison d'etre for this option is to support GDB GUI's without "
"a hard/soft breakpoint concept where the default OpenOCD behaviour "
"is not sufficient");
|
|
From: oharboe at B. <oh...@ma...> - 2009-03-18 12:43:18
|
Author: oharboe
Date: 2009-03-18 12:43:09 +0100 (Wed, 18 Mar 2009)
New Revision: 1416
Modified:
trunk/src/target/trace.c
Log:
Hiroshi Ito <it...@ml...> fix division by 0
Modified: trunk/src/target/trace.c
===================================================================
--- trunk/src/target/trace.c 2009-03-17 10:22:26 UTC (rev 1415)
+++ trunk/src/target/trace.c 2009-03-18 11:43:09 UTC (rev 1416)
@@ -128,7 +128,11 @@
int i;
int first = 0;
int last = trace->trace_history_pos;
-
+
+ if ( !trace->trace_history_size ) {
+ command_print(cmd_ctx, "trace history buffer is not allocated");
+ return ERROR_OK;
+ }
if (trace->trace_history_overflowed)
{
first = trace->trace_history_pos;
|
|
From: ntfreak at B. <nt...@ma...> - 2009-03-17 11:22:27
|
Author: ntfreak Date: 2009-03-17 11:22:26 +0100 (Tue, 17 Mar 2009) New Revision: 1415 Modified: trunk/src/helper/log.c trunk/src/jtag/jtag.c trunk/src/target/xscale.c Log: - remove build warnings Modified: trunk/src/helper/log.c =================================================================== --- trunk/src/helper/log.c 2009-03-17 09:48:46 UTC (rev 1414) +++ trunk/src/helper/log.c 2009-03-17 10:22:26 UTC (rev 1415) @@ -27,6 +27,8 @@ #include "config.h" #endif +#include "replacements.h" + #include "log.h" #include "configuration.h" #include "time_support.h" @@ -36,6 +38,7 @@ #include <stdio.h> #include <stdlib.h> #include <string.h> +#include <unistd.h> #include <stdarg.h> #define PRINT_MEM() 0 Modified: trunk/src/jtag/jtag.c =================================================================== --- trunk/src/jtag/jtag.c 2009-03-17 09:48:46 UTC (rev 1414) +++ trunk/src/jtag/jtag.c 2009-03-17 10:22:26 UTC (rev 1415) @@ -4,11 +4,11 @@ * * * Copyright (C) 2007,2008 vind Harboe * * oyv...@zy... * - * - * Copyright (C) 2009 SoftPLC Corporation - * http://softplc.com - * di...@so... * * + * Copyright (C) 2009 SoftPLC Corporation * + * http://softplc.com * + * di...@so... * + * * * This program is free software; you can redistribute it and/or modify * * it under the terms of the GNU General Public License as published by * * the Free Software Foundation; either version 2 of the License, or * @@ -44,7 +44,6 @@ */ int jtag_error=ERROR_OK; - typedef struct cmd_queue_page_s { void *address; @@ -220,8 +219,8 @@ void jtag_add_end_state(tap_state_t endstate); void jtag_add_sleep(u32 us); int jtag_execute_queue(void); +int tap_state_by_name(const char *name); - /* jtag commands */ int handle_interface_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); int handle_jtag_speed_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); @@ -276,14 +275,13 @@ return n; } - jtag_tap_t *jtag_TapByString( const char *s ) { jtag_tap_t *t; char *cp; t = jtag_AllTaps(); - // try name first + /* try name first */ while(t){ if( 0 == strcmp( t->dotted_name, s ) ){ break; @@ -291,7 +289,7 @@ t = t->next_tap; } } - // backup plan is by number + /* backup plan is by number */ if( t == NULL ){ /* ok - is "s" a number? */ int n; @@ -538,7 +536,6 @@ int nth_tap; int scan_size = 0; - last_cmd = jtag_get_last_command_p(); /* allocate memory for a new list member */ @@ -560,7 +557,7 @@ for(;;){ int found = 0; - // do this here so it is not forgotten + /* do this here so it is not forgotten */ tap = jtag_NextEnabledTap(tap); if( tap == NULL ){ break; @@ -1510,7 +1507,7 @@ return ERROR_JTAG_INIT_FAILED; } - // point at the 1st tap + /* point at the 1st tap */ tap = jtag_NextEnabledTap(NULL); if( tap == NULL ){ LOG_ERROR("JTAG: No taps enabled?"); @@ -1714,9 +1711,7 @@ { .name = NULL, .value = -1 } }; -static int -jtag_tap_configure_cmd( Jim_GetOptInfo *goi, - jtag_tap_t * tap) +static int jtag_tap_configure_cmd( Jim_GetOptInfo *goi, jtag_tap_t * tap) { Jim_Nvp *n; Jim_Obj *o; @@ -2741,14 +2736,14 @@ return ERROR_COMMAND_SYNTAX_ERROR; } - // optional "-endstate" - // "statename" - // at the end of the arguments. - // assume none. + /* optional "-endstate" */ + /* "statename" */ + /* at the end of the arguments. */ + /* assume none. */ endstate = -1; if( argc >= 4 ){ - // have at least one pair of numbers. - // is last pair the magic text? + /* have at least one pair of numbers. */ + /* is last pair the magic text? */ if( 0 == strcmp( "-endstate", args[ argc - 2 ] ) ){ const char *cpA; const char *cpS; @@ -2762,13 +2757,12 @@ if( endstate >= 16 ){ return ERROR_COMMAND_SYNTAX_ERROR; } else { - // found - remove the last 2 args + /* found - remove the last 2 args */ argc -= 2; } } } - fields = malloc(sizeof(scan_field_t) * argc / 2); for (i = 0; i < argc / 2; i++) @@ -2791,7 +2785,7 @@ } jtag_add_ir_scan(argc / 2, fields, -1); - // did we have an endstate? + /* did we have an endstate? */ if( endstate >= 0 ){ jtag_add_end_state(endstate); } @@ -2819,9 +2813,9 @@ * args[2] = num_bits * args[3] = hex string * ... repeat num bits and hex string ... - * + * * .. optionally: - * args[N-2] = "-endstate" + * args[N-2] = "-endstate" * args[N-1] = statename */ if ((argc < 4) || ((argc % 2)!=0)) @@ -2832,13 +2826,12 @@ /* assume no endstate */ endstate = -1; - // validate arguments as numbers + /* validate arguments as numbers */ e = JIM_OK; for (i = 2; i < argc; i+=2) { long bits; const char *cp; - e = Jim_GetLong(interp, args[i], &bits); /* If valid - try next arg */ @@ -2877,7 +2870,7 @@ /* Still an error? */ if( e != JIM_OK ){ return e; /* too bad */ - } + } } /* validate args */ tap = jtag_TapByJimObj( interp, args[1] ); @@ -2907,9 +2900,9 @@ fields[field_count].in_handler = NULL; fields[field_count++].in_handler_priv = NULL; } - + jtag_add_dr_scan(num_fields, fields, -1); - // did we get an end state? + /* did we get an end state? */ if( endstate >= 0 ){ jtag_add_end_state( (tap_state_t)endstate ); } @@ -3009,7 +3002,6 @@ } } - /*-----<Cable Helper API>---------------------------------------*/ /* these Cable Helper API functions are all documented in the jtag.h header file, @@ -3085,7 +3077,6 @@ return ndx; } - int tap_get_tms_path( tap_state_t from, tap_state_t to ) { /* tap_move[i][j]: tap movement command to go from state i to state j @@ -3278,11 +3269,10 @@ return ret; } -int -tap_state_by_name( const char *name ) +int tap_state_by_name( const char *name ) { int x; - + for( x = 0 ; x < 16 ; x++ ){ /* be nice to the human */ if( 0 == strcasecmp( name, tap_state_name(x) ) ){ Modified: trunk/src/target/xscale.c =================================================================== --- trunk/src/target/xscale.c 2009-03-17 09:48:46 UTC (rev 1414) +++ trunk/src/target/xscale.c 2009-03-17 10:22:26 UTC (rev 1415) @@ -1450,17 +1450,18 @@ armv4_5_common_t *armv4_5 = target->arch_info; xscale_common_t *xscale = armv4_5->arch_info; - u32 current_pc, next_pc; + u32 next_pc; int retval; int i; - target->debug_reason = DBG_REASON_SINGLESTEP; /* calculate PC of next instruction */ if ((retval = arm_simulate_step(target, &next_pc)) != ERROR_OK) { - u32 current_opcode; + u32 current_opcode, current_pc; + current_pc = buf_get_u32(armv4_5->core_cache->reg_list[15].value, 0, 32); + target_read_u32(target, current_pc, ¤t_opcode); LOG_ERROR("BUG: couldn't calculate PC of next instruction, current opcode was 0x%8.8x", current_opcode); return retval; |
|
From: ntfreak at B. <nt...@ma...> - 2009-03-17 10:48:47
|
Author: ntfreak
Date: 2009-03-17 10:48:46 +0100 (Tue, 17 Mar 2009)
New Revision: 1414
Modified:
trunk/src/target/target/stm32stick.cfg
Log:
- fix incorrect stm32stick.cfg
Modified: trunk/src/target/target/stm32stick.cfg
===================================================================
--- trunk/src/target/target/stm32stick.cfg 2009-03-16 22:42:29 UTC (rev 1413)
+++ trunk/src/target/target/stm32stick.cfg 2009-03-17 09:48:46 UTC (rev 1414)
@@ -30,10 +30,10 @@
# Section 26.6.3
set _CPUTAPID 0x3ba00477
}
-jtag newtap $_CHIPNAME cpu -irlen 4 -ircapture 0xf -irmask 0xe -expected-id $_CPUTAPID
+jtag newtap $_CHIPNAME cpu -irlen 4 -ircapture 0x1 -irmask 0xf -expected-id $_CPUTAPID
# The boundery scan register, leave the "expected-id" undefined.
-jtag newtap $_CHIPNAME bs -irlen 5 -ircapture 0x1 -irmask 0x1e
+jtag newtap $_CHIPNAME bs -irlen 5 -ircapture 0x1 -irmask 0x1
# configure str750 connected to jtag chain
jtag newtap $_CHIPNAME unknown -irlen 4 -ircapture 0x1 -irmask 0x0f
|
|
From: ntfreak at B. <nt...@ma...> - 2009-03-16 23:42:30
|
Author: ntfreak Date: 2009-03-16 23:42:29 +0100 (Mon, 16 Mar 2009) New Revision: 1413 Modified: trunk/src/target/cortex_m3.c Log: - fix issue with cortex_m3 reset run. Thanks Perry Hung - https://lists.berlios.de/pipermail/openocd-development/2009-March/005028.html Modified: trunk/src/target/cortex_m3.c =================================================================== --- trunk/src/target/cortex_m3.c 2009-03-14 18:39:05 UTC (rev 1412) +++ trunk/src/target/cortex_m3.c 2009-03-16 22:42:29 UTC (rev 1413) @@ -243,6 +243,10 @@ swjdp_transaction_endcheck(swjdp); armv7m_invalidate_core_regs(target); + + /* make sure we have latest dhcsr flags */ + ahbap_read_system_atomic_u32(swjdp, DCB_DHCSR, &cortex_m3->dcb_dhcsr); + return ERROR_OK; } @@ -724,8 +728,12 @@ /* Set/Clear C_MASKINTS in a separate operation */ if (cortex_m3->dcb_dhcsr & C_MASKINTS) ahbap_write_system_atomic_u32(swjdp, DCB_DHCSR, DBGKEY | C_DEBUGEN | C_HALT); - + + /* clear any debug flags before resuming */ cortex_m3_clear_halt(target); + + /* clear C_HALT in dhcsr reg */ + cortex_m3_write_debug_halt_mask(target, 0, C_HALT); /* Enter debug state on reset, cf. end_reset_event() */ ahbap_write_system_u32(swjdp, DCB_DEMCR, TRCENA | VC_HARDERR | VC_BUSERR); |
|
From: <oh...@ma...> - 2009-03-14 19:39:08
|
Author: oharboe Date: 2009-03-14 19:39:05 +0100 (Sat, 14 Mar 2009) New Revision: 1412 Modified: trunk/src/target/interface/parport.cfg trunk/src/target/interface/parport_dlc5.cfg Log: Uwe Hermann <uw...@he...> clean out stuff that doesn't belong in interface(telnet/gdb port). Modified: trunk/src/target/interface/parport.cfg =================================================================== --- trunk/src/target/interface/parport.cfg 2009-03-12 14:48:51 UTC (rev 1411) +++ trunk/src/target/interface/parport.cfg 2009-03-14 18:39:05 UTC (rev 1412) @@ -1,8 +1,4 @@ -telnet_port 4444 -gdb_port 2001 - interface parport parport_port 0xc8b8 parport_cable wiggler jtag_speed 0 - Modified: trunk/src/target/interface/parport_dlc5.cfg =================================================================== --- trunk/src/target/interface/parport_dlc5.cfg 2009-03-12 14:48:51 UTC (rev 1411) +++ trunk/src/target/interface/parport_dlc5.cfg 2009-03-14 18:39:05 UTC (rev 1412) @@ -1,6 +1,3 @@ -telnet_port 4444 -gdb_port 2001 - interface parport parport_port /dev/parport0 parport_cable dlc5 |
|
From: oharboe at B. <oh...@ma...> - 2009-03-12 15:48:52
|
Author: oharboe
Date: 2009-03-12 15:48:51 +0100 (Thu, 12 Mar 2009)
New Revision: 1411
Modified:
trunk/BUGS
trunk/src/scripting.txt
trunk/src/target/target/readme.txt
trunk/src/tcl/README_ABOUT_TCL.txt
trunk/testing/examples/STM32-103/readme.txt
Log:
Uwe Hermann <uw...@he...> typos
Modified: trunk/BUGS
===================================================================
--- trunk/BUGS 2009-03-11 22:42:35 UTC (rev 1410)
+++ trunk/BUGS 2009-03-12 14:48:51 UTC (rev 1411)
@@ -4,7 +4,7 @@
To minimize work for OpenOCD developers, you can include
all the information below. If you feel that some of the
-items below are unecessary for a clear bug report, you
+items below are unnecessary for a clear bug report, you
leave them out.
Modified: trunk/src/scripting.txt
===================================================================
--- trunk/src/scripting.txt 2009-03-11 22:42:35 UTC (rev 1410)
+++ trunk/src/scripting.txt 2009-03-12 14:48:51 UTC (rev 1411)
@@ -31,7 +31,7 @@
is to ignore serial number and write a raw binary file
to beginning of first flash. Target script can dictate
file format and structure of serialnumber. Tcl allows
- an argument to consit of e.g. a list so the structure of
+ an argument to consist of e.g. a list so the structure of
the serial number is not limited to a single string.
- reset handling. Precise control of how srst, trst &
tms is handled.
Modified: trunk/src/target/target/readme.txt
===================================================================
--- trunk/src/target/target/readme.txt 2009-03-11 22:42:35 UTC (rev 1410)
+++ trunk/src/target/target/readme.txt 2009-03-12 14:48:51 UTC (rev 1411)
@@ -36,6 +36,6 @@
Note that a target/xxx.cfg file can invoke another target/yyy.cfg file,
so one can create target subtype configurations where e.g. only
-amount of DRAM, oscilator speeds differ and having a single
+amount of DRAM, oscillator speeds differ and having a single
config file for the default/common settings.
Modified: trunk/src/tcl/README_ABOUT_TCL.txt
===================================================================
--- trunk/src/tcl/README_ABOUT_TCL.txt 2009-03-11 22:42:35 UTC (rev 1410)
+++ trunk/src/tcl/README_ABOUT_TCL.txt 2009-03-12 14:48:51 UTC (rev 1411)
@@ -215,8 +215,8 @@
LEN
HUMAN
TYPE
- RWX - the access ablity.
- WIDTH - the accessable width.
+ RWX - the access ability.
+ WIDTH - the accessible width.
ie: Some regions of memory are not 'word'
accessible.
Modified: trunk/testing/examples/STM32-103/readme.txt
===================================================================
--- trunk/testing/examples/STM32-103/readme.txt 2009-03-11 22:42:35 UTC (rev 1410)
+++ trunk/testing/examples/STM32-103/readme.txt 2009-03-12 14:48:51 UTC (rev 1411)
@@ -1,4 +1,4 @@
-Olimx STM32-p103 board.
+Olimex STM32-p103 board.
main.elf is a file that can be programmed to flash for
testing purposes(e.g. test GDB load performance).
|
|
From: ntfreak at B. <nt...@ma...> - 2009-03-11 23:42:36
|
Author: ntfreak Date: 2009-03-11 23:42:35 +0100 (Wed, 11 Mar 2009) New Revision: 1410 Modified: trunk/src/jtag/rlink/ep1_cmd.h trunk/src/jtag/rlink/rlink.c Log: - add support for standalone rlink https://lists.berlios.de/pipermail/openocd-development/2009-March/004965.html Modified: trunk/src/jtag/rlink/ep1_cmd.h =================================================================== --- trunk/src/jtag/rlink/ep1_cmd.h 2009-03-11 01:53:23 UTC (rev 1409) +++ trunk/src/jtag/rlink/ep1_cmd.h 2009-03-11 22:42:35 UTC (rev 1410) @@ -46,8 +46,8 @@ /* a quick way to just read back one byte */ #define EP1_CMD_DTC_GET_CACHED_STATUS (0x16) -/* Writes upper 2 bits port D with argument */ -#define EP1_CMD_SET_PORTD_UPPER (0x19) +/* Writes upper 2 bits (SHDN and SEL) of port D with argument */ +#define EP1_CMD_SET_PORTD_VPP (0x19) /* Writes lower 2 bits (BUSY and ERROR) of port D with argument */ #define EP1_CMD_SET_PORTD_LEDS (0x1a) Modified: trunk/src/jtag/rlink/rlink.c =================================================================== --- trunk/src/jtag/rlink/rlink.c 2009-03-11 01:53:23 UTC (rev 1409) +++ trunk/src/jtag/rlink/rlink.c 2009-03-11 22:42:35 UTC (rev 1410) @@ -72,25 +72,40 @@ #define DTC_STATUS_POLL_BYTE (ST7_USB_BUF_EP0OUT + 0xff) -/* Symbolic names for some pins */ -#define ST7_PA_NJTAG_TRST ST7_PA1 -#define ST7_PA_NRLINK_RST ST7_PA3 -#define ST7_PA_NLINE_DRIVER_ENABLE ST7_PA5 - -/* mask for negative-logic pins */ -#define ST7_PA_NUNASSERTED (0 \ - | ST7_PA_NJTAG_TRST \ - | ST7_PA_NRLINK_RST \ - | ST7_PA_NLINE_DRIVER_ENABLE \ -) - #define ST7_PD_NBUSY_LED ST7_PD0 -#define ST7_PD_NERROR_LED ST7_PD1 -#define ST7_PD_NRUN_LED ST7_PD7 +#define ST7_PD_NRUN_LED ST7_PD1 +/* low enables VPP at adapter header, high connects it to GND instead */ +#define ST7_PD_VPP_SEL ST7_PD6 +/* low: VPP = 12v, high: VPP <= 5v */ +#define ST7_PD_VPP_SHDN ST7_PD7 +/* These pins are connected together */ #define ST7_PE_ADAPTER_SENSE_IN ST7_PE3 #define ST7_PE_ADAPTER_SENSE_OUT ST7_PE4 +/* Symbolic mapping between port pins and numbered IO lines */ +#define ST7_PA_IO1 ST7_PA1 +#define ST7_PA_IO2 ST7_PA2 +#define ST7_PA_IO4 ST7_PA4 +#define ST7_PA_IO8 ST7_PA6 +#define ST7_PA_IO10 ST7_PA7 +#define ST7_PB_IO5 ST7_PB5 +#define ST7_PC_IO9 ST7_PC1 +#define ST7_PC_IO3 ST7_PC2 +#define ST7_PC_IO7 ST7_PC3 +#define ST7_PE_IO6 ST7_PE5 + +/* Symbolic mapping between numbered IO lines and adapter signals */ +#define ST7_PA_RTCK ST7_PA_IO0 +#define ST7_PA_NTRST ST7_PA_IO1 +#define ST7_PC_TDI ST7_PC_IO3 +#define ST7_PA_DBGRQ ST7_PA_IO4 +#define ST7_PB_NSRST ST7_PB_IO5 +#define ST7_PE_TMS ST7_PE_IO6 +#define ST7_PC_TCK ST7_PC_IO7 +#define ST7_PC_TDO ST7_PC_IO9 +#define ST7_PA_DBGACK ST7_PA_IO10 + static usb_dev_handle *pHDev; @@ -986,37 +1001,92 @@ u8 bitmap; int usb_err; - bitmap = ((~(ST7_PA_NLINE_DRIVER_ENABLE)) & ST7_PA_NUNASSERTED); + /* Read port A for bit op */ + usb_err = ep1_generic_commandl( + pHDev, 4, + EP1_CMD_MEMORY_READ, + ST7_PADR >> 8, + ST7_PADR, + 1 + ); + if(usb_err < 0) { + LOG_ERROR("%s", usb_strerror()); + exit(1); + } + usb_err = usb_bulk_read( + pHDev, USB_EP1IN_ADDR, + (char *)&bitmap, 1, + USB_TIMEOUT_MS + ); + if(usb_err < 1) { + LOG_ERROR("%s", usb_strerror()); + exit(1); + } + if(trst) { - bitmap &= ~ST7_PA_NJTAG_TRST; + bitmap &= ~ST7_PA_NTRST; + } else { + bitmap |= ST7_PA_NTRST; } + + /* Write port A and read port B for bit op */ + /* port B has no OR, and we want to emulate open drain on NSRST, so we initialize DR to 0 and assert NSRST by setting DDR to 1. */ + usb_err = ep1_generic_commandl( + pHDev, 9, + EP1_CMD_MEMORY_WRITE, + ST7_PADR >> 8, + ST7_PADR, + 1, + bitmap, + EP1_CMD_MEMORY_READ, + ST7_PBDDR >> 8, + ST7_PBDDR, + 1 + ); + if(usb_err < 0) { + LOG_ERROR("%s", usb_strerror()); + exit(1); + } + + usb_err = usb_bulk_read( + pHDev, USB_EP1IN_ADDR, + (char *)&bitmap, 1, + USB_TIMEOUT_MS + ); + if(usb_err < 1) { + LOG_ERROR("%s", usb_strerror()); + exit(1); + } + if(srst) { - bitmap &= ~ST7_PA_NRLINK_RST; + bitmap |= ST7_PB_NSRST; + } else { + bitmap &= ~ST7_PB_NSRST; } + /* write port B and read dummy to ensure completion before returning */ usb_err = ep1_generic_commandl( pHDev, 6, - EP1_CMD_MEMORY_WRITE, - ST7_PADR >> 8, - ST7_PADR, + ST7_PBDDR >> 8, + ST7_PBDDR, 1, bitmap, EP1_CMD_DTC_GET_CACHED_STATUS ); if(usb_err < 0) { - LOG_ERROR("%s: %s\n", __func__, usb_strerror()); + LOG_ERROR("%s", usb_strerror()); exit(1); } usb_err = usb_bulk_read( pHDev, USB_EP1IN_ADDR, - &bitmap, 1, + (char *)&bitmap, 1, USB_TIMEOUT_MS ); if(usb_err < 1) { - LOG_ERROR("%s: %s\n", __func__, usb_strerror()); + LOG_ERROR("%s", usb_strerror()); exit(1); } } @@ -1691,9 +1761,9 @@ ST7_PEDR >> 8, ST7_PEDR, 3, - 0x00, - ST7_PE_ADAPTER_SENSE_OUT, - ST7_PE_ADAPTER_SENSE_OUT, + 0x00, /* DR */ + ST7_PE_ADAPTER_SENSE_OUT, /* DDR */ + ST7_PE_ADAPTER_SENSE_OUT, /* OR */ EP1_CMD_MEMORY_READ, /* Read back */ ST7_PEDR >> 8, ST7_PEDR, @@ -1725,9 +1795,9 @@ ST7_PEDR >> 8, ST7_PEDR, 3, - 0x00, - 0x00, - 0x00 + 0x00, /* DR */ + 0x00, /* DDR */ + 0x00 /* OR */ ); usb_bulk_read( @@ -1741,24 +1811,40 @@ LOG_WARNING("target not plugged in\n"); } - /* float port A, make sure DTC is stopped, set upper 2 bits of port D, and set up port A */ + /* float ports A and B */ ep1_generic_commandl( - pHDev, 15, + pHDev, 11, EP1_CMD_MEMORY_WRITE, ST7_PADDR >> 8, ST7_PADDR, 2, 0x00, 0x00, + EP1_CMD_MEMORY_WRITE, + ST7_PBDDR >> 8, + ST7_PBDDR, + 1, + 0x00 + ); + + /* make sure DTC is stopped, set VPP control, set up ports A and B */ + ep1_generic_commandl( + pHDev, 14, EP1_CMD_DTC_STOP, - EP1_CMD_SET_PORTD_UPPER, - ~(ST7_PD_NRUN_LED), + EP1_CMD_SET_PORTD_VPP, + ~(ST7_PD_VPP_SHDN), EP1_CMD_MEMORY_WRITE, ST7_PADR >> 8, ST7_PADR, 2, - ((~(ST7_PA_NLINE_DRIVER_ENABLE)) & ST7_PA_NUNASSERTED), - (ST7_PA_NLINE_DRIVER_ENABLE | ST7_PA_NRLINK_RST | ST7_PA_NJTAG_TRST) + ((~(0)) & (ST7_PA_NTRST)), + (ST7_PA_NTRST), + /* port B has no OR, and we want to emulate open drain on NSRST, so we set DR to 0 here and later assert NSRST by setting DDR bit to 1. */ + EP1_CMD_MEMORY_WRITE, + ST7_PBDR >> 8, + ST7_PBDR, + 1, + 0x00 ); /* set LED updating mode and make sure they're unlit */ @@ -1792,7 +1878,7 @@ EP1_CMD_LEDUE_NONE, EP1_CMD_SET_PORTD_LEDS, ~0, - EP1_CMD_SET_PORTD_UPPER, + EP1_CMD_SET_PORTD_VPP, ~0 ); |
|
From: <du...@ma...> - 2009-03-11 02:53:27
|
Author: duane Date: 2009-03-11 02:53:23 +0100 (Wed, 11 Mar 2009) New Revision: 1409 Modified: trunk/src/target/board/ti_beagleboard.cfg trunk/src/target/target/omap3530.cfg Log: Added eol-style props Property changes on: trunk/src/target/board/ti_beagleboard.cfg ___________________________________________________________________ Name: svn:eol-style + native Property changes on: trunk/src/target/target/omap3530.cfg ___________________________________________________________________ Name: svn:eol-style + native |
|
From: <du...@ma...> - 2009-03-11 02:49:24
|
Author: duane Date: 2009-03-11 02:48:54 +0100 (Wed, 11 Mar 2009) New Revision: 1408 Added: trunk/src/target/board/ti_beagleboard.cfg trunk/src/target/target/omap3530.cfg Log: Commit OMAP3530 and TI_BEAGLEBOARD config files from Kees, Dick, Derk, and others Added: trunk/src/target/board/ti_beagleboard.cfg =================================================================== --- trunk/src/target/board/ti_beagleboard.cfg 2009-03-11 01:42:05 UTC (rev 1407) +++ trunk/src/target/board/ti_beagleboard.cfg 2009-03-11 01:48:54 UTC (rev 1408) @@ -0,0 +1,11 @@ + +source [find target/omap3530.cfg] + +reset_config trst_and_srst +jtag_reset 1 1 +sleep 10 +runtest 10 +jtag_reset 0 0 + +endstate IDLE + Added: trunk/src/target/target/omap3530.cfg =================================================================== --- trunk/src/target/target/omap3530.cfg 2009-03-11 01:42:05 UTC (rev 1407) +++ trunk/src/target/target/omap3530.cfg 2009-03-11 01:48:54 UTC (rev 1408) @@ -0,0 +1,40 @@ +#File omap3530.cfg - as found on the BEAGLEBOARD +# Assumption is it is generic for all OMAP3530 + +#TI OMAP3 processor - http://www.ti.com + +if { [info exists CHIPNAME] } { + set _CHIPNAME $CHIPNAME +} else { + set _CHIPNAME omap3 +} + +if { [info exists ENDIAN] } { + set _ENDIAN $ENDIAN +} else { + # this defaults to a little endianness + set _ENDIAN little +} + +if { [info exists CPUTAPID ] } { + set _CPUTAPID $CPUTAPID +} else { + # force an error till we get a good number + set _CPUTAPID 0x0B6D602F +} + +#jtag scan chain +jtag newtap $_CHIPNAME cpu -irlen 4 -ircapture 0x1 -irmask 0x0 -expected-id $_CPUTAPID -disable +jtag newtap $_CHIPNAME jrc -irlen 6 -ircapture 0x1 -irmask 0xf -expected-id 0x0b7ae02f + +jtag configure $_CHIPNAME.cpu -event tap-enable { + puts "Enabling Cortex-A8 @ OMAP3" + irscan omap3.jrc 7 -endstate IRPAUSE + drscan omap3.jrc 8 0x89 -endstate DRPAUSE + irscan omap3.jrc 2 -endstate IRPAUSE + drscan omap3.jrc 32 0xa3002108 -endstate IDLE + irscan omap3.jrc 0x3F -endstate IDLE + runtest 10 + puts "Cortex-A8 @ OMAP3 enabled" +} + |
|
From: <du...@ma...> - 2009-03-11 02:42:08
|
Author: duane
Date: 2009-03-11 02:42:05 +0100 (Wed, 11 Mar 2009)
New Revision: 1407
Modified:
trunk/src/jtag/jtag.c
Log:
Added -endstate to irscan and drscan to support beagleboard (omap3530)
Modified: trunk/src/jtag/jtag.c
===================================================================
--- trunk/src/jtag/jtag.c 2009-03-09 21:04:33 UTC (rev 1406)
+++ trunk/src/jtag/jtag.c 2009-03-11 01:42:05 UTC (rev 1407)
@@ -2657,7 +2657,7 @@
int handle_endstate_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
{
- tap_state_t state;
+ int state;
if (argc < 1)
{
@@ -2665,14 +2665,13 @@
}
else
{
- for (state = 0; state < 16; state++)
- {
- if (strcmp(args[0], tap_state_name(state)) == 0)
- {
- jtag_add_end_state(state);
- jtag_execute_queue();
- }
+ state = tap_state_by_name( args[0] );
+ if( state < 0 ){
+ command_print( cmd_ctx, "Invalid state name: %s\n", args[0] );
+ return ERROR_COMMAND_SYNTAX_ERROR;
}
+ jtag_add_end_state( (tap_state_t)(state));
+ jtag_execute_queue();
}
command_print(cmd_ctx, "current endstate: %s", tap_state_name(cmd_queue_end_state));
@@ -2735,12 +2734,41 @@
int i;
scan_field_t *fields;
jtag_tap_t *tap;
+ int endstate;
if ((argc < 2) || (argc % 2))
{
return ERROR_COMMAND_SYNTAX_ERROR;
}
+ // optional "-endstate"
+ // "statename"
+ // at the end of the arguments.
+ // assume none.
+ endstate = -1;
+ if( argc >= 4 ){
+ // have at least one pair of numbers.
+ // is last pair the magic text?
+ if( 0 == strcmp( "-endstate", args[ argc - 2 ] ) ){
+ const char *cpA;
+ const char *cpS;
+ cpA = args[ argc-1 ];
+ for( endstate = 0 ; endstate < 16 ; endstate++ ){
+ cpS = tap_state_name( endstate );
+ if( 0 == strcmp( cpA, cpS ) ){
+ break;
+ }
+ }
+ if( endstate >= 16 ){
+ return ERROR_COMMAND_SYNTAX_ERROR;
+ } else {
+ // found - remove the last 2 args
+ argc -= 2;
+ }
+ }
+ }
+
+
fields = malloc(sizeof(scan_field_t) * argc / 2);
for (i = 0; i < argc / 2; i++)
@@ -2763,6 +2791,10 @@
}
jtag_add_ir_scan(argc / 2, fields, -1);
+ // did we have an endstate?
+ if( endstate >= 0 ){
+ jtag_add_end_state(endstate);
+ }
jtag_execute_queue();
for (i = 0; i < argc / 2; i++)
@@ -2781,11 +2813,16 @@
int field_count = 0;
int i, e;
jtag_tap_t *tap;
+ int endstate;
/* args[1] = device
* args[2] = num_bits
* args[3] = hex string
* ... repeat num bits and hex string ...
+ *
+ * .. optionally:
+ * args[N-2] = "-endstate"
+ * args[N-1] = statename
*/
if ((argc < 4) || ((argc % 2)!=0))
{
@@ -2793,15 +2830,56 @@
return JIM_ERR;
}
+ /* assume no endstate */
+ endstate = -1;
+ // validate arguments as numbers
+ e = JIM_OK;
for (i = 2; i < argc; i+=2)
{
long bits;
+ const char *cp;
+
e = Jim_GetLong(interp, args[i], &bits);
- if (e != JIM_OK)
+ /* If valid - try next arg */
+ if( e == JIM_OK ){
+ continue;
+ }
+
+ /* Not valid.. are we at the end? */
+ if ( ((i+2) != argc) ){
+ /* nope, then error */
return e;
- }
+ }
+ /* it could be: "-endstate FOO" */
+
+ /* get arg as a string. */
+ cp = Jim_GetString( args[i], NULL );
+ /* is it the magic? */
+ if( 0 == strcmp( "-endstate", cp ) ){
+ /* is the statename valid? */
+ cp = Jim_GetString( args[i+1], NULL );
+
+ /* see if it is a valid state name */
+ endstate = tap_state_by_name(cp);
+ if( endstate < 0 ){
+ /* update the error message */
+ Jim_SetResult_sprintf(interp,"endstate: %s invalid", cp );
+ } else {
+ /* valid - so clear the error */
+ e = JIM_OK;
+ /* and remove the last 2 args */
+ argc -= 2;
+ }
+ }
+
+ /* Still an error? */
+ if( e != JIM_OK ){
+ return e; /* too bad */
+ }
+ } /* validate args */
+
tap = jtag_TapByJimObj( interp, args[1] );
if( tap == NULL ){
return JIM_ERR;
@@ -2829,8 +2907,12 @@
fields[field_count].in_handler = NULL;
fields[field_count++].in_handler_priv = NULL;
}
-
+
jtag_add_dr_scan(num_fields, fields, -1);
+ // did we get an end state?
+ if( endstate >= 0 ){
+ jtag_add_end_state( (tap_state_t)endstate );
+ }
retval = jtag_execute_queue();
if (retval != ERROR_OK)
{
@@ -3196,4 +3278,19 @@
return ret;
}
+int
+tap_state_by_name( const char *name )
+{
+ int x;
+
+ for( x = 0 ; x < 16 ; x++ ){
+ /* be nice to the human */
+ if( 0 == strcasecmp( name, tap_state_name(x) ) ){
+ return x;
+ }
+ }
+ /* not found */
+ return -1;
+}
+
/*-----</Cable Helper API>--------------------------------------*/
|
