From: <zw...@ma...> - 2009-05-15 00:16:27
|
Author: zwelch Date: 2009-05-15 00:16:20 +0200 (Fri, 15 May 2009) New Revision: 1789 Modified: trunk/doc/manual/jtag.txt trunk/doc/manual/main.txt trunk/doc/manual/primer/jtag.txt Log: Several minor fixes for the new doxygen manual. Modified: trunk/doc/manual/jtag.txt =================================================================== --- trunk/doc/manual/jtag.txt 2009-05-14 21:55:56 UTC (rev 1788) +++ trunk/doc/manual/jtag.txt 2009-05-14 22:16:20 UTC (rev 1789) @@ -1,7 +1,7 @@ /** @page jtagdocs OpenOCD JTAG APIs -This document contains @subpage jtagprimer, which introduces the -IEEE JTAG interface. +For new developers unfamiliar with the technology, @ref primerjtag provides +a brief introduction to the IEEE JTAG interface. The OpenOCD JTAG library API covers several functional areas: Modified: trunk/doc/manual/main.txt =================================================================== --- trunk/doc/manual/main.txt 2009-05-14 21:55:56 UTC (rev 1788) +++ trunk/doc/manual/main.txt 2009-05-14 22:16:20 UTC (rev 1789) @@ -7,9 +7,9 @@ */ -/** @page primer OpenOCD Techincal Primers +/** @page primer OpenOCD Technical Primers -This pages lists Techincal Primers available for OpenOCD Developers. +This pages lists Technical Primers available for OpenOCD Developers. They seek to provide information to pull novices up the learning curves associated with the fundamental technologies used by OpenOCD. Modified: trunk/doc/manual/primer/jtag.txt =================================================================== --- trunk/doc/manual/primer/jtag.txt 2009-05-14 21:55:56 UTC (rev 1788) +++ trunk/doc/manual/primer/jtag.txt 2009-05-14 22:16:20 UTC (rev 1789) @@ -30,10 +30,10 @@ TMS which will select different shift registers. The first thing you need to do is reset the state machine, because when -you connect to a chip you dont know what state the jtag is in,you need +you connect to a chip you do not know what state the controller is in,you need to clock TMS as 1, at least 7 times. This will put you into "Test Logic Reset" State. Knowing this, you can, once reset, then track what each -transition on TMS will do, and hence know what state the jtag state +transition on TMS will do, and hence know what state the JTAG state machine is in. There are 2 "types" of shift registers. The Instruction shift register @@ -47,7 +47,7 @@ For example, one of the data registers will be known as "bypass" this is (usually) a single bit which has no function and is used to bypass the -chip. Eg, assume we have 3 identical chips, wired up like the picture +chip. Assume we have 3 identical chips, wired up like the picture and each has a 3 bit instruction register, and there are 2 known instructions (110 = bypass, 010 = some other function) if we want to use "some other function", on the second chip in the line, and not change @@ -88,7 +88,8 @@ 0 1 0 1 0 1 1 1 1 0 -Again, we are clocking the lsbit first. Then we would clock TMS: +Again, we are clocking the least-significant bit first. Then we would +clock TMS: 1 1 0 |