summaryrefslogtreecommitdiff
path: root/src/bct_dump.1.in
diff options
context:
space:
mode:
authorAllen Martin <amartin@nvidia.com>2015-10-08 15:07:24 -0700
committerStephen Warren <swarren@nvidia.com>2015-10-08 16:20:30 -0600
commitd4d2e8a65ce794836abbe3d0115e13a39c01edf2 (patch)
tree230d8953533d635a9ed9148e00c93fb8e5af5d12 /src/bct_dump.1.in
parentee5c65e7c20d8d4e6e1e0adbfefbdbe147361c7f (diff)
downloadnvidia-cbootimage-d4d2e8a65ce794836abbe3d0115e13a39c01edf2.tar.gz
Add man pages
Add man pages for cbootimge(1) and bct_dump(1) Signed-off-by: Allen Martin <amartin@nvidia.com> Signed-off-by: Stephen Warren <swarren@nvidia.com>
Diffstat (limited to 'src/bct_dump.1.in')
-rw-r--r--src/bct_dump.1.in53
1 files changed, 53 insertions, 0 deletions
diff --git a/src/bct_dump.1.in b/src/bct_dump.1.in
new file mode 100644
index 0000000..0a6ca27
--- /dev/null
+++ b/src/bct_dump.1.in
@@ -0,0 +1,53 @@
+.TH bct_dump 1 "6 October 2015" "bct_dump-VERSION" "NVIDIA Tegra BCT Disassembly Tool"
+.IX bct_dump
+.SH NAME
+bct_dump \- tegra BCT disassembly tool
+.SH SYNOPSIS
+.B bct_dump
+.I bctfile
+.SH DESCRIPTION
+This program is used to take a binary Tegra Boot Configuration Table (BCT) and
+disassemble it into a text format suitable to be compiled with cbootimage(1).
+
+.SS Platforms supported
+.IP \(bu
+.B Tegra20
+.IP \(bu
+.B Tegra30
+.IP \(bu
+.B Tegra114
+.IP \(bu
+.B Tegra124
+.IP \(bu
+.B Tegra132
+.IP \(bu
+.B Tegra210
+
+.SH OPTIONS
+.TP
+.B \fIbctfile\fP
+Specify the BCT file to disassemble
+
+.SH EXAMPLES
+To disassemble the BCT file for a Tegra124 Jetson-TK1:
+
+.nf
+$ bct_dump PM375_Hynix_2GB_H5TC4G63AFR_RDA_924MHz.bct
+Version = 0x00400001;
+BlockSize = 0x00004000;
+PageSize = 0x00000200;
+PartitionSize = 0x01000000;
+OdmData = 0x800d8000;
+JtagCtrl = 0x00000000;
+ChipUid = 0x00000000000000000000000000000000;
+# Bootloader used = 0;
+# Bootloaders max = 4;
+# BCT size = 8192;
+ ...
+.fi
+
+.SH RETURN VALUE
+If any error occurs a non zero exit status is returned.
+
+.SH SEE ALSO
+.BR tegrarcm(1), cbootimage(1)