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

User's Guide: TAP setup tweakage 

Highlight that the "-expected-id" probably comes from vendor
documentation, and that it *should* be used where possible.

Don't use ircapture/irmask in examples, to help discourage
use of those params when they're not required.  Explain a
bit better about why/when those params get used.

Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
This commit is contained in:
David Brownell 2009-11-05 11:31:32 -08:00
parent 98788d7a75
commit afed39c0fe
1 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/openocd.texi
View File

@ -1339,8 +1339,7 @@ The config file for the Atmel AT91SAM7X256
looks (in part) like this: looks (in part) like this:
@example @example
jtag newtap $_CHIPNAME cpu -irlen 4 -ircapture 0x1 -irmask 0xf \ jtag newtap $_CHIPNAME cpu -irlen 4 -expected-id $_CPUTAPID
-expected-id $_CPUTAPID
@end example @end example
A board with two such at91sam7 chips would be able A board with two such at91sam7 chips would be able
@ -2496,7 +2495,7 @@ requires explicit configuration of all TAP devices using
A command like this would declare one tap and name it @code{chip1.cpu}: A command like this would declare one tap and name it @code{chip1.cpu}:
@example @example
jtag newtap chip1 cpu -irlen 7 -ircapture 0x01 -irmask 0x55 jtag newtap chip1 cpu -irlen 4 -expected-id 0x3ba00477
@end example @end example
Each target configuration file lists the TAPs provided Each target configuration file lists the TAPs provided
@ -2641,13 +2640,21 @@ These codes are not required by all JTAG devices.
ID code could appear (for example, multiple versions). ID code could appear (for example, multiple versions).
Specify @var{number} as zero to suppress warnings about IDCODE Specify @var{number} as zero to suppress warnings about IDCODE
values that were found but not included in the list. values that were found but not included in the list.
Provide this value if at all possible, since it lets OpenOCD
tell when the scan chain it sees isn't right. These values
are provided in vendors' chip documentation, usually a technical
reference manual. Sometimes you may need to probe the JTAG
hardware to find these values.
@xref{Autoprobing}.
@item @code{-ircapture} @var{NUMBER} @item @code{-ircapture} @var{NUMBER}
@*The bit pattern loaded by the TAP into the JTAG shift register @*The bit pattern loaded by the TAP into the JTAG shift register
on entry to the @sc{ircapture} state, such as 0x01. on entry to the @sc{ircapture} state, such as 0x01.
JTAG requires the two LSBs of this value to be 01. JTAG requires the two LSBs of this value to be 01.
By default, @code{-ircapture} and @code{-irmask} are set By default, @code{-ircapture} and @code{-irmask} are set
up to verify that two-bit value; but you may provide up to verify that two-bit value. You may provide
additional bits, if you know them. additional bits, if you know them, or indicate that
a TAP doesn't conform to the JTAG specification.
@item @code{-irmask} @var{NUMBER} @item @code{-irmask} @var{NUMBER}
@*A mask used with @code{-ircapture} @*A mask used with @code{-ircapture}
to verify that instruction scans work correctly. to verify that instruction scans work correctly.
@ -6149,12 +6156,13 @@ to execute before they take effect.
@end deffn @end deffn
@c tms_sequence (short|long) @c tms_sequence (short|long)
@c ... temporary, debug-only, probably gone before 0.2 ships @c ... temporary, debug-only, other than USBprog bug workaround...
@deffn Command {verify_ircapture} (@option{enable}|@option{disable}) @deffn Command {verify_ircapture} (@option{enable}|@option{disable})
Verify values captured during @sc{ircapture} and returned Verify values captured during @sc{ircapture} and returned
during IR scans. Default is enabled, but this can be during IR scans. Default is enabled, but this can be
overridden by @command{verify_jtag}. overridden by @command{verify_jtag}.
This flag is ignored when validating JTAG chain configuration.
@end deffn @end deffn
@deffn Command {verify_jtag} (@option{enable}|@option{disable}) @deffn Command {verify_jtag} (@option{enable}|@option{disable})