Add man page

Add a new man page for tegrarcm

Signed-off-by: Allen Martin <amartin@nvidia.com>
Change-Id: If9f587d708b80311c814218dc268d91d7edb1055
Reviewed-on: http://git-master/r/167545
Reviewed-by: Automatic_Commit_Validation_User
Reviewed-by: Stephen Warren <swarren@nvidia.com>
Tested-by: Stephen Warren <swarren@nvidia.com>

2 files changed, 111 insertions, 0 deletions

diff --git a/src/Makefile.am b/src/Makefile.am
index 4a6b71a..5aed236 100644
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -19,4 +19,12 @@ tegrarcm_SOURCES = \
 	tegra114-miniloader.h \
 	usb.h
 
+man_MANS = tegrarcm.1
+
+EXTRA_DIST = tegrarcm.1.in
+DISTCLEANFILES = tegrarcm.1
+
 tegrarcm_LDADD = $(LIBUSB_LIBS) -l$(CRYPTOLIB) -lpthread
+
+tegrarcm.1: $(srcdir)/tegrarcm.1.in
+	sed 's|VERSION|$(VERSION)|g' $< >$@
diff --git a/src/tegrarcm.1.in b/src/tegrarcm.1.in
new file mode 100644
index 0000000..4d1e1d6
--- /dev/null
+++ b/src/tegrarcm.1.in
@@ -0,0 +1,103 @@
+.TH tegrarcm 1 "29 November 2012" "tegrarcm-VERSION" "NVIDIA Tegra Firmware Download Tool"
+.IX tegrarcm
+.SH NAME
+tegrarcm \- tegra firmware download utility
+.SH SYNOPSIS
+.B tegrarcm
+[
+.I options
+]
+.SH DESCRIPTION
+This program is used to send code to a Tegra device in recovery mode.
+It does not supported locked devices with an encrypted boot key, only
+open devices such as the ventana or cardhu reference boards.  It is
+not capable of flashing firmware to a device, but can be used to
+download firmware that is then capable of flashing.  For example in
+ChromeOS tegrarcm is used to download a special build of u-boot to the
+target Tegra device with a payload that it then flashes to the boot
+device.
+
+.SS Platforms supported
+.IP \(bu
+.B Tegra20
+.IP \(bu
+.B Tegra30
+.IP \(bu
+.B Tegra114
+
+.SS How to use
+.IP \(em
+Connect a USB cable from your development system to your Tegra
+device.  You will either need a USB A to A cable or A to micro B
+depending on the target board.
+.IP \(em
+Find the appropriate BCT file for your board.  For reference boards,
+BCT files can be found in the L4T distribution from NVIDIA.
+.IP \(em
+Build some firmware for your device (such as u-boot)
+.IP \(em
+Run tegrarcm to download the firmware
+
+.SH OPTIONS
+.TP
+.B \-\-bct \fIbctfile\fP
+Specify the BCT file to download to the Tegra device.  This file contains
+memory configuation information for the board.  BCT files can be
+obtained through the NVIDIA L4T distribution or generated with
+cbootimage and a proper configuration file.
+.TP
+.B \-\-bootloader \fIblfile\fP
+Specify the bootloader file to download to the Tegra device.  This is
+the firmware file that will be downloaded and executed.
+.TP
+.B \-\-loadaddr \fIloadaddr\fP
+Specify the address the bootloader will be loaded at.  This should be
+specified in hex and is typically 0x108000 for a Tegra20 device or
+0x80108000 for a Tegra30 or Tegra114 device.
+.TP
+.B \-\-entryaddr \fIentryaddr\fP
+Specify the entry address that control will be passed to after the
+firmware is loaded.  This should be specified in hex.  If this option
+is omitted it is assumed to be the same as the load address.
+
+.SH EXAMPLE
+To download u-boot firmware to a Tegra20 seaboard:
+
+.nf
+$ sudo tegrarcm --bct seaboard.bct --bootloader u-boot.bin --loadaddr 0x108000
+bct file: seaboard.bct
+booloader file: u-boot.bin
+load addr 0x108000
+entry addr 0x108000
+device id: 0x7820
+uid:  0x33c20c0413fb217
+RCM version: 2.1
+downloading miniloader to target...
+miniloader downloaded successfully
+Chip UID:                0x33c20c0413fb217
+Chip ID:                 0x20
+Chip ID Major Version:   0x1
+Chip ID Minor Version:   0x4
+Chip SKU:                0x18 (t25)
+Boot ROM Version:        0x1
+Boot Device:             0x3 (SPI)
+Operating Mode:          0x3 (developer mode)
+Device Config Strap:     0x0
+Device Config Fuse:      0x0
+SDRAM Config Strap:      0x0
+sending file: seaboard.bct
+- 4080/4080 bytes sent
+seaboard.bct sent successfully
+sending file: u-boot.bin
+- 268314/268314 bytes sent
+u-boot.bin sent successfully
+.fi
+
+.SH RETURN VALUE
+If any error occurs a non zero exit status is returned.
+
+.SH SEE ALSO
+.BR cbootimage (1),
+
+.SH AUTHOR
+Allen Martin, <amartin@nvidia.com>