[Openocd-svn] r1376 - trunk/doc

[oharboe at B. <oh...@ma...>]

Author: oharboe
Date: 2009-02-18 10:09:11 +0100 (Wed, 18 Feb 2009)
New Revision: 1376

Modified:
   trunk/doc/openocd.texi
Log:
Holger Schurig <hs...@ma...> incorporate some comments from Rick

Modified: trunk/doc/openocd.texi
===================================================================
--- trunk/doc/openocd.texi	2009-02-18 07:39:20 UTC (rev 1375)
+++ trunk/doc/openocd.texi	2009-02-18 09:09:11 UTC (rev 1376)
@@ -1509,9 +1509,12 @@
 parameters'', the required parameters are:
 @comment START REQUIRED
 @itemize @bullet
-@item @b{-irlen NUMBER} - the length in bits of the instruction register
-@item @b{-ircapture NUMBER} - the ID code capture command.
-@item @b{-irmask NUMBER} - the corresponding mask for the ir register.
+@item @b{-irlen NUMBER} - the length in bits of the instruction register, mostly 4 or 5 bits.
+@item @b{-ircapture NUMBER} - the IDCODE capture command, usually 0x01.
+@item @b{-irmask NUMBER} - the corresponding mask for the IR register. For
+some devices, there are bits in the IR that aren't used.  This lets you mask
+them off when doing comparisons.  In general, this should just be all ones for
+the size of the IR.
 @comment END REQUIRED
 @end itemize
 An example of a FOOBAR Tap