Add AT45DBxx1D driver
[fw/altos] / ao-tools / ao-load / ao-load.1
1 .\"
2 .\" Copyright © 2009 Keith Packard <keithp@keithp.com>
3 .\"
4 .\" This program is free software; you can redistribute it and/or modify
5 .\" it under the terms of the GNU General Public License as published by
6 .\" the Free Software Foundation; either version 2 of the License, or
7 .\" (at your option) any later version.
8 .\"
9 .\" This program is distributed in the hope that it will be useful, but
10 .\" WITHOUT ANY WARRANTY; without even the implied warranty of
11 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12 .\" General Public License for more details.
13 .\"
14 .\" You should have received a copy of the GNU General Public License along
15 .\" with this program; if not, write to the Free Software Foundation, Inc.,
16 .\" 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
17 .\"
18 .\"
19 .TH AO-LOAD 1 "ao-load" ""
20 .SH NAME
21 ao-load \- flash a program to a AltOS device
22 .SH SYNOPSIS
23 .B "ao-load"
24 [\-T \fItty-device\fP]
25 [\--tty \fItty-device\fP]
26 [\-D \fIaltos-device\fP]
27 [\--device \fIaltos-device\fP]
28 [\--cal \fIradio-calibration\fP]
29 \fIfile.ihx\fP
30 \fIdevice serial number\fP
31 .SH DESCRIPTION
32 .I ao-load
33 loads the specified .ihx file into the target device flash memory,
34 customizing the AltOS image with the specified serial number.
35 .SH OPTIONS
36 .TP
37 \-T tty-device | --tty tty-device
38 This selects which tty device the debugger uses to communicate with
39 the target device. The special name 'BITBANG' directs ao-dbg to use
40 the cp2103 connection, otherwise this should be a usb serial port
41 connected to a suitable cc1111 debug node.
42 .TP
43 \-D AltOS-device | --device AltOS-device
44 Search for a connected device. This requires an argument of one of the
45 following forms:
46 .IP
47 TeleMetrum:2
48 .br
49 TeleMetrum
50 .br
51 2
52 .IP
53 Leaving out the product name will cause the tool to select a suitable
54 product, leaving out the serial number will cause the tool to match
55 one of the available devices.
56 .TP
57 \-c radio-calibration | --cal radio-calibration
58 This programs the radio calibration value into the image for hardware
59 which doesn't have any eeprom storage for this value. The value here
60 can be computed given the current radio calibration value, the
61 measured frequency and the desired frequency:
62 .IP
63         cal' = cal * (desired/measured)
64 .IP
65 The default calibration value is 1186611.
66 .SH USAGE
67 .I ao-load
68 reads the specified .ihx file into memory, locates the matching .map
69 file and edits the image to customize it using the specified serial
70 number. It then connects to the specified target device and writes the
71 program to the target device flash memory.
72 .SH AUTHOR
73 Keith Packard