add README file

Signed-off-by: Allen Martin <amartin@nvidia.com>
Change-Id: I2cf10b932f489475c79d812a3f20f13aba18586c
Reviewed-on: http://git-master/r/111440
Reviewed-by: Automatic_Commit_Validation_User

3 files changed, 63 insertions, 3 deletions

diff --git a/Makefile.in b/Makefile.in
index 3057bc0..a44b83a 100644
--- a/Makefile.in
+++ b/Makefile.in
@@ -32,7 +32,7 @@ NORMAL_UNINSTALL = :
 PRE_UNINSTALL = :
 POST_UNINSTALL = :
 subdir = .
-DIST_COMMON = $(am__configure_deps) $(srcdir)/Makefile.am \
+DIST_COMMON = README $(am__configure_deps) $(srcdir)/Makefile.am \
 	$(srcdir)/Makefile.in $(srcdir)/config.h.in \
 	$(top_srcdir)/configure depcomp install-sh missing
 ACLOCAL_M4 = $(top_srcdir)/aclocal.m4
diff --git a/README b/README
new file mode 100644
index 0000000..89b019d
--- /dev/null
+++ b/README
@@ -0,0 +1,60 @@
+tegrarcm
+
+What is it?
+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.
+
+Platforms supported:
+-Tegra20
+-Tegra30
+
+How to use:
+- 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.
+- Find the appropriate BCT file for your board.  For reference boards,
+BCT files can be found in the L4T distribution from NVIDIA.
+- Build some firmware for your device (such as u-boot)
+- Run tegrarcm to download the firmware
+
+Example to download u-boot firmware to a Tegra20 seaboard:
+
+$ 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
+
+
+Changes:
+V1.1 - Added this README file and automake fixes from Mike Frysinger
+ <vapier@gentoo.org>
+V1.0 - Initial release
diff --git a/src/Makefile.in b/src/Makefile.in
index 7697b57..457df87 100644
--- a/src/Makefile.in
+++ b/src/Makefile.in
@@ -181,9 +181,9 @@ $(srcdir)/Makefile.in:  $(srcdir)/Makefile.am  $(am__configure_deps)
 	      exit 1;; \
 	  esac; \
 	done; \
-	echo ' cd $(top_srcdir) && $(AUTOMAKE) --gnu src/Makefile'; \
+	echo ' cd $(top_srcdir) && $(AUTOMAKE) --foreign src/Makefile'; \
 	$(am__cd) $(top_srcdir) && \
-	  $(AUTOMAKE) --gnu src/Makefile
+	  $(AUTOMAKE) --foreign src/Makefile
 .PRECIOUS: Makefile
 Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status
 	@case '$?' in \