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