git.gag.com Git - fw/altos/blob - ao-tools/ao-stmload/ao-stmload.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-stmload" ""
  20 .SH NAME
  21 ao-stmload \- flash a program to an STM32-based AltOS device
  22 .SH SYNOPSIS
  23 .B "ao-stmload"
  24 [\-D \fI/dev/sgX\fP]
  25 [\--device \fI/dev/sgX\fP]
  26 [\--cal \fIradio-calibration\fP]
  27 [\--serial \fserial-number\fP]
  28 \fIfile.elf\fP
  29 .SH DESCRIPTION
  30 .I ao-stmload
  31 loads the specified .elf file into the target device flash memory,
  32 using either existing serial number and radio calibration values or
  33 taking either of those from the command line.
  34 .SH OPTIONS
  35 .TP
  36 \-D /dev/sgX | --device /dev/sgX
  37 This targets an STlinkV1 connection rather than STlinkV2
  38 .TP
  39 \-s serial-number | --serial serial-number
  40 This programs the device serial number into the image. If no serial
  41 number is specified, then the existing serial number, if any, will be
  42 read from the device.
  43 .TP
  44 \-c radio-calibration | --cal radio-calibration This programs the
  45 radio calibration value into the image for hardware which doesn't have
  46 any eeprom storage for this value. If no calibration value is
  47 specified, an existing calibration value will be used. The value here
  48 can be computed given the current radio calibration value, the
  49 measured frequency and the desired frequency:
  50 .IP
  51         cal' = cal * (desired/measured)
  52 .IP
  53 The default calibration value is 7119667.
  54 .SH USAGE
  55 .I ao-stmload
  56 reads the specified .elf file into memory, edits the image to
  57 customize it using the specified serial number and radio calibration
  58 values. It then connects to the debug dongle and writes the program to
  59 the target device flash memory.
  60 .SH AUTHOR
  61 Keith Packard