ao-tools: Change ao-eeprom into eeprom analysis tool
[fw/altos] / ao-tools / ao-eeprom / ao-eeprom.1
index 728f11ed2ffbb1bff79c956bd9ae195e81efa592..6257e125b3095b3c50991f5409de3ddee5332985 100644 (file)
 .\"
 .TH AO-EEPROM 1 "ao-eeprom" ""
 .SH NAME
-ao-eeprom \- Fetch eeprom contents from TeleMetrum device
+ao-eeprom \- Analyze an eeprom log
 .SH SYNOPSIS
 .B "ao-eeprom"
-[\-T \fItty-device\fP]
-[\--tty \fItty-device\fP]
-[\-D \fIaltos-device\fP]
-[\--device \fIaltos-device\fP]
+[\--raw]
+[\--csum]
+[\--verbose]
+[\--len <record-len>]
+{flight.eeprom} ...
 .SH OPTIONS
 .TP
-\-T tty-device | --tty tty-device
-This selects which tty device the debugger uses to communicate with
-the target device. The special name 'BITBANG' directs ao-dbg to use
-the cp2103 connection, otherwise this should be a usb serial port
-connected to a suitable cc1111 debug node.
+\-r | --raw
+This option makes ao-eeprom dump the raw bytes of each
+log record in hex format.
 .TP
-\-D AltOS-device | --device AltOS-device
-Search for a connected device. This requires an argument of one of the
-following forms:
-.IP
-TeleMetrum:2
-.br
-TeleMetrum
-.br
-2
-.IP
-Leaving out the product name will cause the tool to select a suitable
-product, leaving out the serial number will cause the tool to match
-one of the available devices.
+\-c | --csum
+This option makes ao-eeprom dump records that have checksum errors. By default,
+ao-eeprom skips such records.
+\-v | --verbose
+This option makes ao-eeprom report when records are skipped due to
+checksum errors.
+\-l <record-len> | --len <record-len
+Specify the eeprom record length rather than letting ao-eeprom
+automatically determine it based on the file contents.
 .SH DESCRIPTION
 .I ao-eeprom
-downloads the eeprom contents from a connected TeleMetrum device.
-.SH USAGE
-.I ao-eeprom
-connects to the specified target device and dumps each block of the
-eeprom to stdout in hexadecimal bytes.
+reads the specified eeprom log and display the contents of each
+record.
 .SH AUTHOR
 Keith Packard