git.gag.com Git - fw/altos/blob - ao-tools/ao-sky-flash/ao-sky-flash.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-SKY-FLASH 1 "ao-sky-flash" ""
  20 .SH NAME
  21 ao-sky-flash \- flash GPS firmware program to a SkyTraq GPS chip
  22 .SH SYNOPSIS
  23 .B "ao-sky-flash"
  24 [\-T \fItty-device\fP]
  25 [\--tty \fItty-device\fP]
  26 [\-D \fIaltos-device\fP]
  27 [\--device \fIaltos-device\fP]
  28 [\--loader \fIboot-loader\fP]
  29 [\--firmware \fIgps-firmware\fP]
  30 [\--query]
  31 [\--quiet]
  32 [\--raw]
  33 .SH DESCRIPTION
  34 .I ao-sky-flash
  35 loads the specified GPS firmware file into the target GPS chip flash
  36 memory using the specified boot loader.
  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.
  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 \--loader boot-loader
  58 This specifies the desired boot loader to use for reflashing the
  59 device. You should use srec_115200.bin unless you have a good reason
  60 not to. This should be in S record format.
  61 .TP
  62 \--firmware gps-firmware
  63 This specifies the new GPS firmware image to load onto the target GPS
  64 chip. No checking is done on this device at all; flash garbage and the
  65 GPS chip will probably fail to boot.
  66 .TP
  67 \--query
  68 Instead of loading new firmware, query the current version of firmware
  69 running on the target device.
  70 .TP
  71 \--quiet
  72 Normally, ao-spy-flash is quite chatty. This shuts it up, except for
  73 error messages.
  74 .TP
  75 \--raw
  76 The expected target for reflashing is an Altus Metrum product with the
  77 GPS chip connected to the CPU on that board and not directly to the
  78 USB serial port. This option says that the target GPS chip is directly
  79 connected, which changes how things are initialized a bit.
  80 .SH USAGE
  81 .I ao-sky-flash
  82 loads the specified bootloader into device RAM and then uses that to
  83 load new firmware to flash.
  84 .SH AUTHOR
  85 Keith Packard