.\"                                      Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH AVRPROG 1 "jun 25, 2001"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
avrprog \- Programmer for Atmel AVR microcontrolers
.SH SYNOPSIS
.B avrprog
.RI "[ -r | -w | -c | -e | -b " reset-pin-value " | -L " lock-mode " ]"
.RI "[ -E ] [ -d " device " ] [ -p " port-address " ] [ -R ] [ -v ]"
.RI "[ -V ] [ -h ]"
.br
.SH DESCRIPTION
Programmer for Atmel AVR microcontrollers that uses PC parallel port
to program the device in serial mode. The device can be programmed
"in-system". It comes with a schematic of the hardware required.
The hardware was designed to be efficient and unexpensive.
.br
This program gets/sends data from stdin/stdout in Intel Hexadecimal
Object File Format and reads/writes to the AVR device.
.br
.SH OPTIONS
.TP
.B -r
reads data from device and send to stdout.
.TP
.B -w
reads data from stdin and write to device.
.TP
.B -c
reads data from stdin and from device and compares both.
.TP
.B -e
erases device program and eeprom memory.
.TP
.B -b reset-pin-value
reset-pin-value must be 0 or 1. This option just changes device reset
pin logic level and exit.
.TP
.B -L lock-mode
set device lock bits mode. See AVR manual for details.
WARNING: in some devices, even erasing chip (\-e) didn't clear the
lock bits... so we lost the chips... use this option at your own risk.
.br
If lock-mode is 0, sets LB2=0; LB1=0.
If lock-mode is 1, sets LB2=0; LB1=1.
If lock-mode is 2, sets LB2=1; LB1=0.
If lock-mode is 3, sets LB2=0; LB1=1.
.TP
.B -E
eeprom memory mode. Without this option, reads, writes and compares are
made to device program memory. With this option they are made in eeprom
memory.
.TP
.B -d device
Without this option, avrprog will try do autodetect the device by
reading it's signature bytes. Use this option if you want to overide
device detection.
.B device
is case sensitive and can be any supported devices. To see supported
devices try
.B "\'-d ?\'"
.
.TP
.B -p port-address
chooses parallel port address (hexa value). Check avrprog.conf file
for default and valid values.
.TP
.B -R
sets AVR reset pin to 1 when exiting, enabling software execution.
Default is leave chip disabled (reset=0) when exiting.
.TP
.B -v
verbose mode.
.TP
.B -V
shows program version, copyright and exit.
.TP
.B -h
shows program help and exit.
.LP
Note: some options can't be used at the same time with other options.
In case you specify more than one exclusive option, just one of them
will be executed. (priority b,c,r,L,e,w).
.LP
Without any options, avrprog just tries to detect the device and leaves
reset pin at 0 (software in device is halted).
.SH EXAMPLES
.B avrprog -r > file.hex
.br
Read device program memory and write it to file.hex.
.LP
.B avrprog -w < file.hex
.br
Read contents of file.hex and write to program memory in device.
.LP
.B avrprog -w -R < file.hex
.br
Read contents of file.hex and write to program memory in device. After
writting, starts device software execution by setting reset pin to 1.
.LP
.B avrprog -r -E > file.hex
.br
Read device eeprom memory and write it to file.hex.
.LP
.B avrprog
.br
Identifies the device and halts software execution.
.LP
.B avrprog -R
.br
Identifies the device and starts software execution.
.LP
.B avrprog -b 0
.br
Just set device reset pin to 0 (halt software execution)
.LP
.B avrprob -b 1
.br
Just set device reset pin to 1 (start software execution)
.SH INPUT AND OUTPUT FORMAT
Input and output formats are
.B Intel Hexadecimal Object File Format
You can find this specification at
.br
ftp://download.intel.com/support/processors/
.br
i960/devtools/INTELHEX.PDF
.br
Record types 00 and 01 are implemented in this version.
In input lines, LF and CR+LF are accepted as newline markers.
Output files are generated with LF as a newline marker.
.SH FILES
.TP
.B /etc/avrprog/devices.conf
handles devices signatures. Human readable. Take a look and add new
devices. Don't forget to write us the lines you added, so next versions
can have a more complete list of devices.
.TP
.B /etc/avrprog/avrprog.conf
general configuration file. Human readable. Handles parallel port address.
.SH BUGS
If you found any, please send the authors an e-mail.
.SH TODO
.LP
Write a kernel module so this program does not need to run setuid root. Or
write a daemon and the program can connect to the daemon using tcp.
.LP
Write messages using functions that support locales.
.SH SEE ALSO
http://www.autsens.com/avrprog
.br
http://avrprog.sourceforge.net
.SH AVRPROG AUTHORS
Jose Roberto B. de A. Monteiro <jrm@autsens.com>
.br
Pedro Zorzenon Neto <pzn@autsens.com>
.PP
.SH MANPAGE AUTHOR
This manual page was written by Pedro Zorzenon Neto <pzn@autsens.com>,
for the Debian GNU/Linux system (but may be used by others).