From patchwork Wed Oct 7 22:38:00 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Allen Martin X-Patchwork-Id: 527476 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by ozlabs.org (Postfix) with ESMTP id 2A958140D72 for ; Thu, 8 Oct 2015 09:38:37 +1100 (AEDT) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1750872AbbJGWig (ORCPT ); Wed, 7 Oct 2015 18:38:36 -0400 Received: from hqemgate16.nvidia.com ([216.228.121.65]:14802 "EHLO hqemgate16.nvidia.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1750730AbbJGWif (ORCPT ); Wed, 7 Oct 2015 18:38:35 -0400 Received: from hqnvupgp08.nvidia.com (Not Verified[216.228.121.13]) by hqemgate16.nvidia.com id ; Wed, 07 Oct 2015 15:38:37 -0700 Received: from hqemhub02.nvidia.com ([172.20.150.31]) by hqnvupgp08.nvidia.com (PGP Universal service); Wed, 07 Oct 2015 15:37:34 -0700 X-PGP-Universal: processed; by hqnvupgp08.nvidia.com on Wed, 07 Oct 2015 15:37:34 -0700 Received: from chrome.nvidia.com (172.20.144.16) by hqemhub02.nvidia.com (172.20.150.31) with Microsoft SMTP Server (TLS) id 8.3.342.0; Wed, 7 Oct 2015 15:38:34 -0700 From: Allen Martin To: CC: , , Allen Martin Subject: [cbootimage PATCH] Add man pages Date: Wed, 7 Oct 2015 15:38:00 -0700 Message-ID: <1444257480-24964-1-git-send-email-amartin@nvidia.com> X-Mailer: git-send-email 1.9.1 X-NVConfidentiality: public MIME-Version: 1.0 Sender: linux-tegra-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-tegra@vger.kernel.org Add man pages for cbootimge(1) and bct_dump(1) Signed-off-by: Allen Martin --- src/Makefile.am | 17 +++++++++++ src/bct_dump.1.in | 56 ++++++++++++++++++++++++++++++++++ src/cbootimage.1.in | 87 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 160 insertions(+) create mode 100644 src/bct_dump.1.in create mode 100644 src/cbootimage.1.in diff --git a/src/Makefile.am b/src/Makefile.am index 64c4ea52b8e2..285f9dbd629c 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -84,3 +84,20 @@ bct_dump_SOURCES = \ t132/nvboot_sdram_param_t132.h \ t210/nvboot_bct_t210.h \ t210/nvboot_sdram_param_t210.h + +man_MANS = cbootimage.1 bct_dump.1 + +EXTRA_DIST = cbootimage.1.in bct_dump.1.in +DISTCLEANFILES = cbootimage.1 cbootimage.man bct_dump.1 bct_dump.man + +cbootimage.1: $(srcdir)/cbootimage.1.in + sed 's|VERSION|$(VERSION)|g' $< >$@ + +cbootimage.man: $(srcdir)/cbootimage.1 + nroff -man $< >$@ + +bct_dump.1: $(srcdir)/bct_dump.1.in + sed 's|VERSION|$(VERSION)|g' $< >$@ + +bct_dump.man: $(srcdir)/bct_dump.1 + nroff -man $< >$@ diff --git a/src/bct_dump.1.in b/src/bct_dump.1.in new file mode 100644 index 000000000000..329e379e91b0 --- /dev/null +++ b/src/bct_dump.1.in @@ -0,0 +1,56 @@ +.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 disassmble 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) + +.SH AUTHOR +Anton Staaf diff --git a/src/cbootimage.1.in b/src/cbootimage.1.in new file mode 100644 index 000000000000..dd60dee8a69c --- /dev/null +++ b/src/cbootimage.1.in @@ -0,0 +1,87 @@ +.TH cbootimage 1 "6 October 2015" "cbootimage-VERSION" "NVIDIA Tegra Firmware Signing Tool" +.IX cbootimage +.SH NAME +cbootimage \- tegra BCT compiler +.SH SYNOPSIS +.B cbootimage +[ +.I options +] configfile [ +.I inputimage +] +.I outputimage +.SH DESCRIPTION +This program is used to create images suitable to place into the boot flash of a +device using a Tegra SoC. There are two primary modes of operation of +cbootimage: + +.nr step 1 1 +.IP \n[step] 3 +Compile a textual representation of a BCT into a binary image. +.IP \n+[step] +Generate an entire boot image from a previously compiled BCT and a bootloader +binary. + +.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 COMMANDS +.TP +.B \-gbct +Generate the new bct file from the given config file. +.TP +.B \-h, \-\-help, \-? +Print help text and exit. + +.SH OPTIONS +.TP +.B \-d, \-\-debug +Output debugging information. +.TP +.B \-o\fIodm_data\fP +Specify the odm_data(in hex). +.TP +.B \-t, \-\-tegra \fINN\fP +Select target device. Must be one of: 20, 30, 114, 124, 132, 210. +.TP +.B \-s, \-\-ssoc \fItegraNN\fP +Select target device. Must be one of: tegra20, tegra30, tegra114, tegra124, +tegra32, tegra210. +.TP +.B \-u \-\-update +Copy input image data and update bct configs into new image file + +.SH EXAMPLES +To generate a bct file from a text description obtained either through +bct_dump(1) or cbootimage-configs: + +.nf +$ cbootimage -gbct -t124 PM375_Hynix_2GB_H5TC4G63AFR_RDA_924MHz.bct.cfg PM375_Hynix_2GB_H5TC4G63AFR_RDA_924MHz.bct +New BCT file PM375_Hynix_2GB_H5TC4G63AFR_RDA_924MHz.bct has been successfully generated! +.fi + +To generate a boot image file including the newly generated bct: +.nf +cbootimage -t124 jetson-tk1-emmc.img.cfg jetson-tk1-emmc.img +Image file jetson-tk1-emmc.img has been successfully generated! +.fi + +.SH RETURN VALUE +If any error occurs a non zero exit status is returned. + +.SH SEE ALSO +.BR tegrarcm (1), bct_dump(1) + +.SH AUTHOR +Peer Chen