Add manual pages for remaining commands.

Manuals written for ao-bitbang, ao-eeprom, ao-load, ao-rawload and
ao-view.

Manual for ao-dbg updated to reflect program name change.

Signed-off-by: Keith Packard <keithp@keithp.com>

diff --git a/ao-tools/ao-bitbang/Makefile.am b/ao-tools/ao-bitbang/Makefile.am
index f094c7bd9bf4942ec39d775f8501842e42241b46..b27c409089414a2a4c7a2acb7250852a107bdbe3 100644 (file)
--- a/ao-tools/ao-bitbang/Makefile.am
+++ b/ao-tools/ao-bitbang/Makefile.am
@@ -8,3 +8,5 @@ ao_bitbang_DEPENDENCIES = $(AO_BITBANG_LIBS)
 ao_bitbang_LDADD=$(AO_BITBANG_LIBS) $(LIBUSB_LIBS)
 
 ao_bitbang_SOURCES = ao-bitbang.c
 ao_bitbang_LDADD=$(AO_BITBANG_LIBS) $(LIBUSB_LIBS)
 
 ao_bitbang_SOURCES = ao-bitbang.c

+
+man_MANS=ao-bitbang.1
\ No newline at end of file

diff --git a/ao-tools/ao-bitbang/ao-bitbang.1 b/ao-tools/ao-bitbang/ao-bitbang.1
new file mode 100644 (file)
index 0000000..44eea1e
--- /dev/null
+++ b/ao-tools/ao-bitbang/ao-bitbang.1
@@ -0,0 +1,196 @@
+.\"
+.\" Copyright © 2009 Keith Packard <keithp@keithp.com>
+.\"
+.\" This program is free software; you can redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation; either version 2 of the License, or
+.\" (at your option) any later version.
+.\"
+.\" This program is distributed in the hope that it will be useful, but
+.\" WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+.\" General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU General Public License along
+.\" with this program; if not, write to the Free Software Foundation, Inc.,
+.\" 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
+.\"
+.\"
+.TH AO-BITBANG 1 "ao-bitbang" ""
+.SH NAME
+ao-bitbang \- Low-level cc1111 interface diagnostic tool
+.SH SYNOPSIS
+.B "ao-bitbang"
+.SH DESCRIPTION
+.I ao-bitbang
+connects through a CP2103 usb-to-serial converter and uses the GPIO
+pins to communicate with the debug port on a cc1111 device. It
+provides raw access to the debug pins to help debug the lowest level
+communication path.
+.SH USAGE
+.I ao-bitbang
+reads a sequence of bit manipulations from stdin, sends them to the
+device and reports status on stdout.
+.P
+Each line on stdin should contain a single letter command for each of
+the three debug lines on the cc1111 -- clock, data and reset. Each bit
+can be in one of three states -- on (C, D or R), off (.) or tri-state
+(-) for input. Empty lines, or lines starting with '#' are
+ignored. Anything beyond the last bit in a line is also ignored. The
+bits must be listed in the correct order, and the 'on' values must
+match the desired bit.
+.SH EXAMPLE
+.IP "Reset the target device"
+# reset
+.br
+C D R
+.br
+C D R
+.br
+C D R
+.br
+C D R
+.IP "Get Chip ID"
+#
+.br
+# Debug mode - drive RESET_N low for two clock cycles
+.br
+#
+.br
+C D R
+.br
+. D .
+.br
+C D .
+.br
+. D .
+.br
+C D .
+.br
+. D R
+.br
+
+.br
+#
+.br
+# GET_CHIP_ID
+.br
+
+.br
+C . R  0
+.br
+. . R
+.br
+C D R  1
+.br
+. D R
+.br
+C D R  1
+.br
+. D R
+.br
+C . R  0
+.br
+. . R
+.br
+
+.br
+C D R  1
+.br
+. D R
+.br
+C . R  0
+.br
+. . R
+.br
+C . R  0
+.br
+. . R
+.br
+C . R  0
+.br
+. . R
+.br
+
+.br
+#
+.br
+# start reading again
+.br
+
+.br
+C D R
+.br
+. - R
+.br
+C - R
+.br
+. - R
+.br
+C - R
+.br
+. - R
+.br
+C - R
+.br
+. - R
+.br
+
+.br
+C - R
+.br
+. - R
+.br
+C - R
+.br
+. - R
+.br
+C - R
+.br
+. - R
+.br
+C - R
+.br
+. - R
+.br
+
+.br
+C - R
+.br
+. - R
+.br
+C - R
+.br
+. - R
+.br
+C - R
+.br
+. - R
+.br
+C - R
+.br
+. - R
+.br
+
+.br
+C - R
+.br
+. - R
+.br
+C - R
+.br
+. - R
+.br
+C - R
+.br
+. - R
+.br
+C - R
+.br
+. - R
+.br
+
+.br
+C D R
+.SH AUTHOR
+Keith Packard

diff --git a/ao-tools/ao-dbg/ao-dbg.1 b/ao-tools/ao-dbg/ao-dbg.1
index 1f544e5b199026459ea98d2db651ab108c49c26a..a850c45407ed76b7e845c92ac2ea109bc1cee84f 100644 (file)
--- a/ao-tools/ao-dbg/ao-dbg.1
+++ b/ao-tools/ao-dbg/ao-dbg.1
@@ -16,11 +16,11 @@
 .\" 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
 .\"
 .\"
 .\" 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
 .\"
 .\"

-.TH S51 1 "s51" ""
+.TH AO-DBG 1 "ao-dbg" ""

 .SH NAME
 .SH NAME

-s51 \- hex debugger for cc1111 processors
+ao-dbg \- hex debugger for cc1111 processors

 .SH SYNOPSIS
 .SH SYNOPSIS

-.B "s51"
+.B "ao-dbg"

 [\-t \fIcpu-type\fP]
 [\-X \fIfrequency\fP]
 [\-c]
 [\-t \fIcpu-type\fP]
 [\-X \fIfrequency\fP]
 [\-c]


@@ -36,13 +36,14 @@ s51 \- hex debugger for cc1111 processors
 [\-m]
 [\-T \fItty-device\fP]
 .SH DESCRIPTION
 [\-m]
 [\-T \fItty-device\fP]
 .SH DESCRIPTION

-.I s51
-connects to a cc1111 processor through a cp1203-based USB-to-serial
-converter board, using the GPIO pins available on that chip. It provides an
-interface compatible with the 8051 emulator of the same name (s51), but
-communicating with the real chip instead of an emulation. Using a modified
-version of the SDCC debugger (sdcdb), you can control program execution
-on the target machine at source-level.
+.I ao-dbg
+connects to a cc1111 processor through either a suitable cc1111 board
+or a cp2103 usb to serial converter board, using the GPIO pins
+available on that chip. It provides an interface compatible with the
+8051 emulator from sdcc called s51, but communicating with the real
+chip instead of an emulation. Using a modified version of the SDCC
+debugger (sdcdb), you can control program execution on the target
+machine at source-level.

 
 .SH OPTIONS
 The command line options are designed to be compatible with the 8051
 
 .SH OPTIONS
 The command line options are designed to be compatible with the 8051


@@ -65,9 +66,9 @@ The emulator and sdcdb communicate through a network socket. This option
 switches the debugger from communicating through stdin/stdout to listening
 on a specific network port instead. Once a connection is made, the debugger
 continues on, using that network port for command input and output. The
 switches the debugger from communicating through stdin/stdout to listening
 on a specific network port instead. Once a connection is made, the debugger
 continues on, using that network port for command input and output. The

-debugger uses port 9756, and attempts to connect before launching s51, so if
-s51 is listening on this port before sdcdb is started, sdcdb will end up
-talking to the existing s51 instance. That's often useful for debugging s51
+debugger uses port 9756, and attempts to connect before launching ao-dbg, so if
+ao-dbg is listening on this port before sdcdb is started, sdcdb will end up
+talking to the existing ao-dbg instance. That's often useful for debugging ao-dbg

 itself.
 .IP "\-p \fIprompt\fP"
 This sets the command prompt to the specified string.
 itself.
 .IP "\-p \fIprompt\fP"
 This sets the command prompt to the specified string.


@@ -77,17 +78,19 @@ sdcdb.
 .IP "\-h"
 This should print a usage message, but does nothing useful currently.
 .IP "\-m"
 .IP "\-h"
 This should print a usage message, but does nothing useful currently.
 .IP "\-m"

-This option is not present in the original 8051 emulator, and causes s51 to
+This option is not present in the original 8051 emulator, and causes ao-dbg to

 dump all commands and replies that are received from and sent to sdcdb.
 .IP "\-T"
 This selects which tty device the debugger uses to communicate with
 dump all commands and replies that are received from and sent to sdcdb.
 .IP "\-T"
 This selects which tty device the debugger uses to communicate with

-the target device.
+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.

 .SH COMMANDS
 .SH COMMANDS

-Once started, s51 connects to the cc1111 via the CP2103 using libusb2 and
-then reads and executes commands, either from stdin, or the nework
-connection to sdcdb.
+Once started, ao-dbg connects to the cc1111 and then reads and
+executes commands, either from stdin, or the nework connection to
+sdcdb.

 .PP
 .PP

-Unlike the command line, s51 contains built-in help for each of these
+Unlike the command line, ao-dbg contains built-in help for each of these

 commands, via the 'help' command. Most of the commands are available in a
 long form and a single character short form. Below, the short form follows
 the long form after a comma.
 commands, via the 'help' command. Most of the commands are available in a
 long form and a single character short form. Below, the short form follows
 the long form after a comma.


@@ -159,13 +162,12 @@ the original 8051 emulator.
 While the original purpose for this program was to connect the source
 debugger with the hardware, it can also be used as a low-level hex debugger
 all on its own. In particular, all of the cc1111 peripherals can be
 While the original purpose for this program was to connect the source
 debugger with the hardware, it can also be used as a low-level hex debugger
 all on its own. In particular, all of the cc1111 peripherals can be

-manipulated directly from the s51 command line.
-.IP "Starting s51"
-If the CP2103 is plugged in, and the CC1111 is connected correctly, the
-\'s51\' command itself should connect to the device without trouble.
-Note that the CP2103 must have the GPIO pins configured correctly as well.
+manipulated directly from the ao-dbg command line.
+.IP "Starting ao-dbg"
+First ensure that the target cc1111 device and intermediate cp2103 or
+cc111 board are all hooked up correctly.

 .IP
 .IP

-$ s51
+$ ao-dbg

 .br
 Welcome to the non-simulated processor
 .br
 .br
 Welcome to the non-simulated processor
 .br

diff --git a/ao-tools/ao-eeprom/Makefile.am b/ao-tools/ao-eeprom/Makefile.am
index 587acee7898e025139773cc12e831e2f05074ce4..ffd437e83bf229ca49872d6fe2ed72b39507923c 100644 (file)
--- a/ao-tools/ao-eeprom/Makefile.am
+++ b/ao-tools/ao-eeprom/Makefile.am
@@ -8,3 +8,5 @@ ao_eeprom_DEPENDENCIES = $(AO_EEPROM_LIBS)
 ao_eeprom_LDADD=$(AO_EEPROM_LIBS) $(LIBUSB_LIBS)
 
 ao_eeprom_SOURCES = ao-eeprom.c
 ao_eeprom_LDADD=$(AO_EEPROM_LIBS) $(LIBUSB_LIBS)
 
 ao_eeprom_SOURCES = ao-eeprom.c

+
+man_MANS = ao-eeprom.1
\ No newline at end of file

diff --git a/ao-tools/ao-eeprom/ao-eeprom.1 b/ao-tools/ao-eeprom/ao-eeprom.1
new file mode 100644 (file)
index 0000000..8caff9d
--- /dev/null
+++ b/ao-tools/ao-eeprom/ao-eeprom.1
@@ -0,0 +1,33 @@
+.\"
+.\" Copyright © 2009 Keith Packard <keithp@keithp.com>
+.\"
+.\" This program is free software; you can redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation; either version 2 of the License, or
+.\" (at your option) any later version.
+.\"
+.\" This program is distributed in the hope that it will be useful, but
+.\" WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+.\" General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU General Public License along
+.\" with this program; if not, write to the Free Software Foundation, Inc.,
+.\" 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
+.\"
+.\"
+.TH AO-EEPROM 1 "ao-eeprom" ""
+.SH NAME
+ao-eeprom \- Fetch eeprom contents from TeleMetrum device
+.SH SYNOPSIS
+.B "ao-eeprom"
+[\-tty \fItty-device\fP]
+.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 hexidecimal bytes.
+.SH AUTHOR
+Keith Packard

diff --git a/ao-tools/ao-load/Makefile.am b/ao-tools/ao-load/Makefile.am
index 8a8392afb6d4fd76c09bd84b2e848705c3916d2d..e8fed8b090251800806024d7dafaef2e8023094a 100644 (file)
--- a/ao-tools/ao-load/Makefile.am
+++ b/ao-tools/ao-load/Makefile.am
@@ -8,3 +8,5 @@ ao_load_DEPENDENCIES = $(AO_LOAD_LIBS)
 ao_load_LDADD=$(AO_LOAD_LIBS) $(LIBUSB_LIBS)
 
 ao_load_SOURCES = ao-load.c
 ao_load_LDADD=$(AO_LOAD_LIBS) $(LIBUSB_LIBS)
 
 ao_load_SOURCES = ao-load.c

+
+man_MANS = ao-load.1
\ No newline at end of file

diff --git a/ao-tools/ao-load/ao-load.1 b/ao-tools/ao-load/ao-load.1
new file mode 100644 (file)
index 0000000..10484f3
--- /dev/null
+++ b/ao-tools/ao-load/ao-load.1
@@ -0,0 +1,38 @@
+.\"
+.\" Copyright © 2009 Keith Packard <keithp@keithp.com>
+.\"
+.\" This program is free software; you can redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation; either version 2 of the License, or
+.\" (at your option) any later version.
+.\"
+.\" This program is distributed in the hope that it will be useful, but
+.\" WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+.\" General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU General Public License along
+.\" with this program; if not, write to the Free Software Foundation, Inc.,
+.\" 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
+.\"
+.\"
+.TH AO-LOAD 1 "ao-load" ""
+.SH NAME
+ao-load \- flash a program to a AltOS device
+.SH SYNOPSIS
+.B "ao-load"
+[\-tty \fItty-device\fP]
+\fIfile.ihx\fP
+\fIdevice serial number\fP
+.SH DESCRIPTION
+.I ao-load
+loads the specified .ihx file into the target device flash memory,
+customizing the AltOS image with the specified serial number.
+.SH USAGE
+.I ao-load
+reads the specified .ihx file into memory, locates the matching .map
+file and edits the image to customize it using the specified serial
+number. It then connects to the specified target device and writes the
+program to the target device flash memory.
+.SH AUTHOR
+Keith Packard

diff --git a/ao-tools/ao-rawload/Makefile.am b/ao-tools/ao-rawload/Makefile.am
index 24013a85694727580fd60bd374d5708ad29bfb2c..c157d3d96969ea8ba7433f33b711fc7c4b9b4e71 100644 (file)
--- a/ao-tools/ao-rawload/Makefile.am
+++ b/ao-tools/ao-rawload/Makefile.am
@@ -8,3 +8,5 @@ ao_rawload_DEPENDENCIES = $(AO_RAWLOAD_LIBS)
 ao_rawload_LDADD=$(AO_RAWLOAD_LIBS) $(LIBUSB_LIBS)
 
 ao_rawload_SOURCES = ao-rawload.c
 ao_rawload_LDADD=$(AO_RAWLOAD_LIBS) $(LIBUSB_LIBS)
 
 ao_rawload_SOURCES = ao-rawload.c

+
+man_MANS=ao-rawload.1
\ No newline at end of file

diff --git a/ao-tools/ao-rawload/ao-rawload.1 b/ao-tools/ao-rawload/ao-rawload.1
new file mode 100644 (file)
index 0000000..e79645f
--- /dev/null
+++ b/ao-tools/ao-rawload/ao-rawload.1
@@ -0,0 +1,36 @@
+.\"
+.\" Copyright © 2009 Keith Packard <keithp@keithp.com>
+.\"
+.\" This program is free software; you can redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation; either version 2 of the License, or
+.\" (at your option) any later version.
+.\"
+.\" This program is distributed in the hope that it will be useful, but
+.\" WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+.\" General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU General Public License along
+.\" with this program; if not, write to the Free Software Foundation, Inc.,
+.\" 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
+.\"
+.\"
+.TH AO-RAWLOAD 1 "ao-rawload" ""
+.SH NAME
+ao-rawload \- flash a program to a AltOS device
+.SH SYNOPSIS
+.B "ao-rawload"
+[\-tty \fItty-device\fP]
+\fIfile.ihx\fP
+.SH DESCRIPTION
+.I ao-rawload
+loads the specified .ihx file, without modification, into the target
+device flash memory.
+.SH USAGE
+.I ao-rawload
+reads the specified .ihx file into memory. It then connects to the
+specified target device and writes the program to the target device
+flash memory.
+.SH AUTHOR
+Keith Packard

diff --git a/ao-view/Makefile.am b/ao-view/Makefile.am
index e0cd068c8fbc656ab347aa0d131d207d544fe629..17661c8e09d95f31fd09394ec86307c3f157bb08 100644 (file)
--- a/ao-view/Makefile.am
+++ b/ao-view/Makefile.am
@@ -29,5 +29,7 @@ BUILT_SOURCES = aoview_glade.h
 
 CLEANFILES = aoview_glade.h
 
 
 CLEANFILES = aoview_glade.h
 

+man_MANS=ao-view.1
+

 aoview_glade.h: aoview.glade
        sed -e 's/"/\\"/g' -e 's/^/"/' -e 's/$$/"/' $< > $@
 aoview_glade.h: aoview.glade
        sed -e 's/"/\\"/g' -e 's/^/"/' -e 's/$$/"/' $< > $@

diff --git a/ao-view/ao-view.1 b/ao-view/ao-view.1
new file mode 100644 (file)
index 0000000..99834c4
--- /dev/null
+++ b/ao-view/ao-view.1
@@ -0,0 +1,50 @@
+.\"
+.\" Copyright © 2009 Keith Packard <keithp@keithp.com>
+.\"
+.\" This program is free software; you can redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation; either version 2 of the License, or
+.\" (at your option) any later version.
+.\"
+.\" This program is distributed in the hope that it will be useful, but
+.\" WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+.\" General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU General Public License along
+.\" with this program; if not, write to the Free Software Foundation, Inc.,
+.\" 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
+.\"
+.\"
+.TH AO-VIEW 1 "ao-view" ""
+.SH NAME
+ao-view \- Rocket flight monitor
+.SH SYNOPSIS
+.B "ao-view"
+[\--tty \fItty-device\fP]
+.SH DESCRIPTION
+.I ao-view
+connects to a TeleDongle or TeleMetrum device through a USB serial device.
+It provides a user interface to monitor, record and review rocket flight data.
+.SH OPTIONS
+The usual Gtk+ command line options can be used, along with
+.IP "\--tty"
+This selects a target device to connect at startup time to.
+The target device may also be selected through the user interface.
+.SH USAGE
+When connected to a TeleDongle device, ao-view turns on the radio
+receiver and listens for telemetry packets. It displays the received
+telemetry data, and reports flight status via voice synthesis. All
+received telemetry information is recorded to a file.
+.P
+When connected to a TeleMetrum device, ao-view downloads the eeprom
+data and stores it in a file.
+.SH FILES
+All data log files are recorded into a user-specified directory
+(default ~/AltOS). Files are named using the current date, the serial
+number of the reporting device, the flight number recorded in the data
+and either '.telem' for telemetry data or '.eeprom' for eeprom data.
+.SH "SEE ALSO"
+ao-load(1), ao-eeprom(1)
+.SH AUTHOR
+Keith Packard