Polish up the docs a bit. Use smallexample instead of example for

wide tty output.  Document a trick to find out about the serial
numbers of all JTAG ICEs attached to USB.


git-svn-id: svn://svn.savannah.nongnu.org/avrdude/trunk/avrdude@534 81a1dc3b-b13d-400b-aceb-764788c761c2
This commit is contained in:
joerg_wunsch 2005-09-27 08:25:18 +00:00
parent 818aafe4fc
commit 63638e9911
2 changed files with 58 additions and 33 deletions

View File

@ -1,3 +1,10 @@
2005-09-27 Joerg Wunsch <j@uriah.heep.sax.de>
* doc/avrdude.texi: Polish up the docs a bit. Use smallexample
instead of example for wide tty output. Document a trick to
find out about the serial numbers of all JTAG ICEs attached
to USB.
2005-09-26 Joerg Wunsch <j@uriah.heep.sax.de> 2005-09-26 Joerg Wunsch <j@uriah.heep.sax.de>
* jtagmkII.c (jtagmkII_paged_write): default the page size early so the * jtagmkII.c (jtagmkII_paged_write): default the page size early so the

View File

@ -28,7 +28,7 @@ This file documents the avrdude program.
For avrdude version @value{VERSION}, @value{UPDATED}. For avrdude version @value{VERSION}, @value{UPDATED}.
Copyright @copyright{} 2003,2005 Brian Dean Copyright @copyright{} 2003, 2005 Brian Dean
Permission is granted to make and distribute verbatim copies of Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission notice this manual provided the copyright notice and this permission notice
@ -59,9 +59,9 @@ by the Free Software Foundation.
@author by Brian S. Dean @author by Brian S. Dean
@page @page
@hfill (Send bugs and comments on AVRDUDE to @w{@email{avrdude-dev@@nongnu.org}}.) Send comments on AVRDUDE to @w{@email{avrdude-dev@@nongnu.org}}.
@vfill Use @uref{http://savannah.nongnu.org/bugs/?group=avrdude} to report bugs.
Copyright @copyright{} 2003,2005 Brian S. Dean Copyright @copyright{} 2003,2005 Brian S. Dean
@sp 2 @sp 2
@ -94,6 +94,12 @@ This file documents the avrdude program for downloading/uploading
programs to Atmel AVR microcontrollers. programs to Atmel AVR microcontrollers.
For avrdude version @value{VERSION}, @value{UPDATED}. For avrdude version @value{VERSION}, @value{UPDATED}.
Send comments on AVRDUDE to @w{@email{avrdude-dev@@nongnu.org}}.
Use @uref{http://savannah.nongnu.org/bugs/?group=avrdude} to report bugs.
Copyright @copyright{} 2003,2005 Brian S. Dean
@end ifinfo @end ifinfo
@menu @menu
@ -223,9 +229,9 @@ Roth.
@noindent @noindent
AVRDUDE is a command line tool, used as follows: AVRDUDE is a command line tool, used as follows:
@example @smallexample
avrdude -p partno @var{options} @dots{} avrdude -p partno @var{options} @dots{}
@end example @end smallexample
@noindent @noindent
Command line options are used to control AVRDUDE's behaviour. The Command line options are used to control AVRDUDE's behaviour. The
@ -554,6 +560,8 @@ matched against the serial number read from any JTAG ICE mkII found on
USB. The match is done after stripping any existing colons from the USB. The match is done after stripping any existing colons from the
given serial number, and right-to-left, so only the least significant given serial number, and right-to-left, so only the least significant
bytes from the serial number need to be given. bytes from the serial number need to be given.
For a trick how to find out the serial numbers of all JTAG ICEs
attached to USB, see @ref{Example Command Line Invocations}.
@item -q @item -q
Disable (or quell) output of the progress bar while reading or writing Disable (or quell) output of the progress bar while reading or writing
@ -699,7 +707,7 @@ should not be used.
Download the file @code{diag.hex} to the ATmega128 chip using the Download the file @code{diag.hex} to the ATmega128 chip using the
STK500 programmer connected to the default serial port: STK500 programmer connected to the default serial port:
@example @smallexample
@cartouche @cartouche
% avrdude -p m128 -c stk500 -e -U flash:w:diag.hex % avrdude -p m128 -c stk500 -e -U flash:w:diag.hex
@ -735,7 +743,7 @@ avrdude done. Thank you.
% %
@end cartouche @end cartouche
@end example @end smallexample
@page @page
@noindent @noindent
@ -743,7 +751,7 @@ Upload the flash memory from the ATmega128 connected to the STK500
programmer and save it in raw binary format in the file named programmer and save it in raw binary format in the file named
@code{c:/diag flash.bin}: @code{c:/diag flash.bin}:
@example @smallexample
@cartouche @cartouche
% avrdude -p m128 -c stk500 -U flash:r:"c:/diag flash.bin":r % avrdude -p m128 -c stk500 -U flash:r:"c:/diag flash.bin":r
@ -764,7 +772,7 @@ avrdude done. Thank you.
% %
@end cartouche @end cartouche
@end example @end smallexample
@page @page
@noindent @noindent
@ -772,7 +780,7 @@ Using the default programmer, download the file @code{diag.hex} to
flash, @code{eeprom.hex} to EEPROM, and set the Extended, High, and Low flash, @code{eeprom.hex} to EEPROM, and set the Extended, High, and Low
fuse bytes to 0xff, 0x89, and 0x2e respectively: fuse bytes to 0xff, 0x89, and 0x2e respectively:
@example @smallexample
@cartouche @cartouche
% avrdude -p m128 -u -U flash:w:diag.hex \ % avrdude -p m128 -u -U flash:w:diag.hex \
@ -813,14 +821,14 @@ avrdude done. Thank you.
% %
@end cartouche @end cartouche
@end example @end smallexample
@page @page
@noindent @noindent
Connect to the JTAG ICE mkII which serial number ends up in 1C37 via Connect to the JTAG ICE mkII which serial number ends up in 1C37 via
USB, and enter terminal mode: USB, and enter terminal mode:
@example @smallexample
@cartouche @cartouche
% avrdude -c jtag2 -p m649 -P usb:1c:37 -t % avrdude -c jtag2 -p m649 -P usb:1c:37 -t
@ -836,8 +844,27 @@ avrdude: Device signature = 0x1e9603
avrdude done. Thank you. avrdude done. Thank you.
@end cartouche @end cartouche
@end example @end smallexample
@noindent
List the serial numbers of all JTAG ICEs attached to USB. This is
done by specifying an invalid serial number, and increasing the
verbosity level.
@smallexample
@cartouche
% avrdude -c jtag2 -p m128 -P usb:xx -v
[...]
Using Port : usb:xxx
Using Programmer : jtag2
avrdude: usbdev_open(): Found JTAG ICE, serno: 00A000001C6B
avrdude: usbdev_open(): Found JTAG ICE, serno: 00A000001C3A
avrdude: usbdev_open(): Found JTAG ICE, serno: 00A000001C30
avrdude: usbdev_open(): did not find any (matching) USB device "usb:xxx"
@end cartouche
@end smallexample
@c @c
@ -958,7 +985,7 @@ Display the current target supply voltage and JTAG bit clock rate/period.
@noindent @noindent
Display part parameters, modify eeprom cells, perform a chip erase: Display part parameters, modify eeprom cells, perform a chip erase:
@example @smallexample
@cartouche @cartouche
% avrdude -p m128 -c stk500 -t % avrdude -p m128 -c stk500 -t
@ -1010,7 +1037,7 @@ avrdude> dump eeprom 0 16
avrdude> avrdude>
@end cartouche @end cartouche
@end example @end smallexample
@noindent @noindent
@ -1020,7 +1047,7 @@ rising power). Note since we are working with fuse bits the -u (unsafe)
option is specified, which allows you to modify the fuse bits. First option is specified, which allows you to modify the fuse bits. First
display the factory defaults, then reprogram: display the factory defaults, then reprogram:
@example @smallexample
@cartouche @cartouche
% avrdude -p m128 -u -c stk500 -t % avrdude -p m128 -u -c stk500 -t
@ -1050,7 +1077,7 @@ avrdude> w lfuse 0 0x2f
avrdude> avrdude>
@end cartouche @end cartouche
@end example @end smallexample
@c @c
@ -1119,7 +1146,7 @@ option.
@noindent @noindent
The format of the programmer definition is as follows: The format of the programmer definition is as follows:
@example @smallexample
programmer programmer
id = <id1> [, <id2> [, <id3>] ...] ; # <idN> are quoted strings id = <id1> [, <id2> [, <id3>] ...] ; # <idN> are quoted strings
desc = <description> ; # quoted string desc = <description> ; # quoted string
@ -1135,7 +1162,7 @@ programmer
pgmled = <num> ; # pin number pgmled = <num> ; # pin number
vfyled = <num> ; # pin number vfyled = <num> ; # pin number
; ;
@end example @end smallexample
@c @c
@ -1144,7 +1171,7 @@ programmer
@node Part Definitions, Other Notes, Programmer Definitions, Configuration File @node Part Definitions, Other Notes, Programmer Definitions, Configuration File
@section Part Definitions @section Part Definitions
@example @smallexample
part part
id = <id> ; # quoted string id = <id> ; # quoted string
desc = <description> ; # quoted string desc = <description> ; # quoted string
@ -1177,7 +1204,7 @@ part
writepage = <instruction format> ; writepage = <instruction format> ;
; ;
; ;
@end example @end smallexample
@menu @menu
* Instruction Format:: * Instruction Format::
@ -1226,7 +1253,7 @@ specification closely follows the instruction data provided in Atmel's
data sheets for their parts. For example, the EEPROM read and write data sheets for their parts. For example, the EEPROM read and write
instruction for an AT90S2313 AVR part could be encoded as: instruction for an AT90S2313 AVR part could be encoded as:
@example @smallexample
read = "1 0 1 0 0 0 0 0 x x x x x x x x", read = "1 0 1 0 0 0 0 0 x x x x x x x x",
"x a6 a5 a4 a3 a2 a1 a0 o o o o o o o o"; "x a6 a5 a4 a3 a2 a1 a0 o o o o o o o o";
@ -1234,7 +1261,7 @@ read = "1 0 1 0 0 0 0 0 x x x x x x x x",
write = "1 1 0 0 0 0 0 0 x x x x x x x x", write = "1 1 0 0 0 0 0 0 x x x x x x x x",
"x a6 a5 a4 a3 a2 a1 a0 i i i i i i i i"; "x a6 a5 a4 a3 a2 a1 a0 i i i i i i i i";
@end example @end smallexample
@ -1750,6 +1777,7 @@ line driven and for writing the batch files.
@noindent @noindent
In general, please report any bugs encountered via In general, please report any bugs encountered via
@*
@url{http://savannah.nongnu.org/bugs/?group=avrdude}. @url{http://savannah.nongnu.org/bugs/?group=avrdude}.
@ -1791,16 +1819,6 @@ Problem: I'm not using linux and my AVR910 programmer is really slow.
Solutions: The reasons for this are the same as above. Solutions: The reasons for this are the same as above.
If you know how to work around this on your OS, please let us know. If you know how to work around this on your OS, please let us know.
@item
Problem: I cannot modify the fuse bits on my AVR!
Solution: You probably forgot to specify the -u option, which allows you to modify fuse bits.
This is done to prevent corrupt data from changing the fuse bits without you knowing about it, and
currently also prevents the user from changing the fuse bits by accident. This patch was added in
response to a number of occasions when an AVR had stopped responding because the fuse bits got changed
by an error caused by the programmer. Programmer of course meaning both the physical device, and the
person sitting at the keyboard.
@item @item
Problem: AVRDUDE says my device is not supported when using the AVR109 boot loader Problem: AVRDUDE says my device is not supported when using the AVR109 boot loader