git.gag.com Git - fw/altos/blob - ao-tools/ao-usbload/ao-usbload.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-usbload" ""
  20 .SH NAME
  21 ao-usbload \- flash a program to an ARM-based AltOS device
  22 .SH SYNOPSIS
  23 .B "ao-usbload"
  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 [\--serial \fserial-number\fP]
  30 \fIfile.elf\fP or \fIfile.ihx\fP
  31 .SH DESCRIPTION
  32 .I ao-usbload
  33 loads the specified .elf or .ihx file into the target device flash
  34 memory via the AltOS boot loader, using either existing serial number
  35 and radio calibration values or taking either of those from the
  36 command line.
  37 .SH OPTIONS
  38 .TP
  39 \-T tty-device | --tty tty-device
  40 This selects which tty device the debugger uses to communicate with
  41 the target device. The special name 'BITBANG' directs ao-dbg to use
  42 the cp2103 connection, otherwise this should be a usb serial port
  43 connected to a suitable cc1111 debug node.
  44 .TP
  45 \-D AltOS-device | --device AltOS-device
  46 Search for a connected device. This requires an argument of one of the
  47 following forms:
  48 .IP
  49 TeleMega:2
  50 .br
  51 TeleMega
  52 .br
  53 2
  54 .IP
  55 Leaving out the product name will cause the tool to select a suitable
  56 product, leaving out the serial number will cause the tool to match
  57 one of the available devices.
  58 .TP
  59 \-s serial-number | --serial serial-number
  60 This programs the device serial number into the image. If no serial
  61 number is specified, then the existing serial number, if any, will be
  62 read from the device.
  63 .TP
  64 \-c radio-calibration | --cal radio-calibration This programs the
  65 radio calibration value into the image for hardware which doesn't have
  66 any eeprom storage for this value. If no calibration value is
  67 specified, an existing calibration value will be used. The value here
  68 can be computed given the current radio calibration value, the
  69 measured frequency and the desired frequency:
  70 .IP
  71         cal' = cal * (desired/measured)
  72 .IP
  73 The default calibration value is 7119667.
  74 .SH USAGE
  75 .I ao-usbload
  76 reads the specified .elf file into memory, edits the image to
  77 customize it using the specified serial number and radio calibration
  78 values. It then connects to the debug dongle and writes the program to
  79 the target device flash memory.
  80 .SH AUTHOR
  81 Keith Packard