Improve -B bitclock documentation

This commit is contained in:
Stefan Rueger 2022-10-23 22:26:07 +01:00
parent 2c7083f001
commit 16922842be
No known key found for this signature in database
GPG Key ID: B0B4F1FD86B1EC55
3 changed files with 32 additions and 26 deletions

View File

@ -332,18 +332,20 @@ programmed in high-voltage serial mode.
Override the RS-232 connection baud rate specified in the respective Override the RS-232 connection baud rate specified in the respective
programmer's entry of the configuration file. programmer's entry of the configuration file.
.It Fl B Ar bitclock .It Fl B Ar bitclock
Specify the bit clock period for the JTAG interface or the ISP clock (JTAG ICE only). Specify the bit clock period for the JTAG, PDI, TPI, UPDI, or ISP
The value is a floating-point number in microseconds. interface. The value is a floating-point number in microseconds.
Alternatively, the value might be suffixed with "Hz", "kHz", or "MHz", Alternatively, the value might be suffixed with "Hz", "kHz" or
in order to specify the bit clock frequency, rather than a period. "MHz" in order to specify the bit clock frequency rather than a
The default value of the JTAG ICE results in about 1 microsecond bit period. Some programmers default their bit clock value to a 1
clock period, suitable for target MCUs running at 4 MHz clock and microsecond bit clock period, suitable for target MCUs running at 4
above. MHz clock and above. Slower MCUs need a correspondingly higher bit
Unlike certain parameters in the STK500, the JTAG ICE resets all its clock period. Some programmers reset their bit clock value to the
parameters to default values when the programming software signs default value when the programming software signs off, whilst others
off from the ICE, so for MCUs running at lower clock speeds, this store the last used bit clock value. It is recommended to always
parameter must be specified on the command-line. specify the bit clock if read/write speed is important.
You can use the 'default_bitclock' keyword in your You can use the 'default_bitclock' keyword in your
.Pa ${HOME}/.config/avrdude/avrdude.rc
or
.Pa ${HOME}/.avrduderc .Pa ${HOME}/.avrduderc
file to assign a default value to keep from having to specify this file to assign a default value to keep from having to specify this
option on every invocation. option on every invocation.
@ -357,6 +359,8 @@ through the use of a config file to make
work with different programmers as long as the programmer supports the work with different programmers as long as the programmer supports the
Atmel AVR serial program method. You can use the 'default_programmer' Atmel AVR serial program method. You can use the 'default_programmer'
keyword in your keyword in your
.Pa ${HOME}/.config/avrdude/avrdude.rc
or
.Pa ${HOME}/.avrduderc .Pa ${HOME}/.avrduderc
file to assign a default programmer to keep from having to specify file to assign a default programmer to keep from having to specify
this option on every invocation. this option on every invocation.

View File

@ -440,19 +440,21 @@ Override the RS-232 connection baud rate specified in the respective
programmer's entry of the configuration file. programmer's entry of the configuration file.
@item -B @var{bitclock} @item -B @var{bitclock}
Specify the bit clock period for the JTAG interface or the ISP clock (JTAG ICE only). Specify the bit clock period for the JTAG, PDI, TPI, UPDI, or ISP
The value is a floating-point number in microseconds. interface. The value is a floating-point number in microseconds.
Alternatively, the value might be suffixed with "Hz", "kHz", or "MHz", Alternatively, the value might be suffixed with "Hz", "kHz" or
in order to specify the bit clock frequency, rather than a period. "MHz" in order to specify the bit clock frequency rather than a
The default value of the JTAG ICE results in about 1 microsecond bit period. Some programmers default their bit clock value to a 1
clock period, suitable for target MCUs running at 4 MHz clock and microsecond bit clock period, suitable for target MCUs running at 4
above. MHz clock and above. Slower MCUs need a correspondingly higher bit
Unlike certain parameters in the STK500, the JTAG ICE resets all its clock period. Some programmers reset their bit clock value to the
parameters to default values when the programming software signs default value when the programming software signs off, whilst
off from the ICE, so for MCUs running at lower clock speeds, this others store the last used bit clock value. It is recommended to
parameter must be specified on the command-line. always specify the bit clock if read/write speed is important. You
It can also be set in the configuration file by using the 'default_bitclock' can use the 'default_bitclock' keyword in your
keyword. @code{~/.config/avrdude/avrdude.rc} or @code{~/.avrduderc}
configuration file to assign a default value to keep from having to
specify this option on every invocation.
@item -c @var{programmer-id} @item -c @var{programmer-id}
Specify the programmer to be used. AVRDUDE knows about several common Specify the programmer to be used. AVRDUDE knows about several common

View File

@ -167,14 +167,14 @@ static void usage(void)
"Options:\n" "Options:\n"
" -p <partno> Specify AVR device\n" " -p <partno> Specify AVR device\n"
" -b <baudrate> Override RS-232 baud rate\n" " -b <baudrate> Override RS-232 baud rate\n"
" -B <bitclock> Specify JTAG/STK500v2 bit clock period (us)\n" " -B <bitclock> Specify bit clock period (us)\n"
" -C <config-file> Specify location of configuration file\n" " -C <config-file> Specify location of configuration file\n"
" -c <programmer> Specify programmer type\n" " -c <programmer> Specify programmer type\n"
" -A Disable trailing-0xff removal from file and AVR read\n" " -A Disable trailing-0xff removal from file and AVR read\n"
" -D Disable auto erase for flash memory; implies -A\n" " -D Disable auto erase for flash memory; implies -A\n"
" -i <delay> ISP Clock Delay [in microseconds]\n" " -i <delay> ISP Clock Delay [in microseconds]\n"
" -P <port> Specify connection port\n" " -P <port> Specify connection port\n"
" -F Override invalid signature check\n" " -F Override invalid signature or initialisation check\n"
" -e Perform a chip erase\n" " -e Perform a chip erase\n"
" -O Perform RC oscillator calibration (see AVR053)\n" " -O Perform RC oscillator calibration (see AVR053)\n"
" -U <memtype>:r|w|v:<filename>[:format]\n" " -U <memtype>:r|w|v:<filename>[:format]\n"