path: root/src/import/chips/p9/xip/p9_xip_tool.C
diff options
authorClaus Michael Olsen <>2017-05-16 04:10:01 -0500
committerSachin Gupta <>2017-05-19 02:25:28 -0400
commit21172ff3ef109bd7b0c2c95cb3ddb82bf7da6784 (patch)
tree99831ca8842a8476865d2c7e25f083a4cbd59bbc /src/import/chips/p9/xip/p9_xip_tool.C
parent1e3dfbf9393eae55ac373e0373a6ca6ed879519b (diff)
xip_tool: Removed the commented, and unnecessaryly identically repeated,
form of "usage" which is also printed out. Change-Id: I603e8f61fd780162164f3165e065cc531f514c4c Reviewed-on: Tested-by: Jenkins Server <> Tested-by: PPE CI <> Reviewed-by: Richard J. Knight <> Reviewed-by: Sumit Kumar <> Reviewed-by: Jennifer A. Stofer <> Reviewed-on: Reviewed-by: Hostboot Team <> Tested-by: FSP CI Jenkins <> Reviewed-by: Sachin Gupta <>
Diffstat (limited to 'src/import/chips/p9/xip/p9_xip_tool.C')
1 files changed, 0 insertions, 101 deletions
diff --git a/src/import/chips/p9/xip/p9_xip_tool.C b/src/import/chips/p9/xip/p9_xip_tool.C
index e6fe0793..03b8db9b 100644
--- a/src/import/chips/p9/xip/p9_xip_tool.C
+++ b/src/import/chips/p9/xip/p9_xip_tool.C
@@ -66,107 +66,6 @@ enum LISTING_MODE_ID
-// Usage: p9_xip_tool <image> [-<flag> ...] normalize
-// p9_xip_tool <image> [-<flag> ...] get <item>
-// p9_xip_tool <image> [-<flag> ...] getv <item> <index>
-// p9_xip_tool <image> [-<flag> ...] set <item> <value> [ <item1> <value1> ... ]
-// p9_xip_tool <image> [-<flag> ...] setv <item> <index> <value> [ <item1> <index1> <value1> ... ]
-// p9_xip_tool <image> [-<flag> ...] report [<regex>]
-// p9_xip_tool <image> [-<flag> ...] attrdump <attr dump file>
-// p9_xip_tool <image> [-<flag> ...] append <section> <file> [ <ddSupport> ]
-// p9_xip_tool <image> [-<flag> ...] extract <section> <file> [ <ddLevel> ]
-// p9_xip_tool <image> [-<flag> ...] delete <section> [ <section1> ... <sectionN> ]
-// p9_xip_tool <image> [-<flag> ...] dissect <ring section> [ table,short,normal(default),long,raw ]
-// p9_xip_tool <image> [-<flag> ...] disasm <text section>
-// This simple application uses the P9-XIP image APIs to normalize, search
-// update and edit P9-XIP images. This program encapsulates several commands
-// in a common command framework which requires an image to operate on, a
-// command name, and command arguments that vary by command. Commands that
-// modify the image always rewrite the image in-place in the filesystem;
-// however the original image is only modified if the command has completed
-// without error.
-// The program operates on a P9-XIP format binary image, which must be
-// normalized - unless the tool is being called to normalize the image in the
-// first place using the 'normalize' command. The tool also validates the
-// image prior to operating on the image.
-// The 'get' command retrieves a scalar value from the image and prints its
-// representation on stdout (followed by a newline). Scalar integer values
-// and image addresses are printed as hex numbers (0x...). Strings are printed
-// verbatim.
-// The 'getv' command retrieves a vector element from the image and prints its
-// representation on stdout (followed by a newline). Integer values
-// and image addresses are printed as hex numbers (0x...). Vectors of strings
-// are not supported.
-// The 'set' command allows setting integer and string values in the image.
-// New integer values can be specified in decimal or hex (0x...). Strings are
-// taken verbatim from the command line. Note that new string values will be
-// silently truncated to the length of the current string if the new value is
-// longer than the current string. Updating address values is currently not
-// supported. Any number of item/value pairs can be specified with a single
-// 'set' command.
-// The 'setv' command is provided to set individual vector elements of
-// integral arrays.
-// The 'report' command prints a report including a dump of the header and
-// section table, a listing of the types and values of all items that appear
-// in the TOC. The TOC listing includes the
-// sequence number of the entry in the TOC, the item name, the item type and
-// the item value.
-// The 'attrdump' command prints a listing of the names, types and values
-// of all attribute items that appear in the TOC and their value from
-// the attribute dump file
-// The 'append' command either creates or extends the section named by the
-// section argument, by appending the contents of the named file verbatim.
-// Currently the section must either be the final (highest address) section of
-// the image, or must be empty, in which case the append command creates the
-// section as the final section of the image. The 'append' command writes the
-// relocatable image address where the input file was loaded to stdout. The
-// last argument, ddSupport, indicates if the section being added has ddLevel
-// metadata support (=1) or not (=0). If this arg is omitted it's assumed
-// to be false (=0).
-// The 'extract' command extracts a section from the binary image. The last
-// argument, ddLevel, indicates [in hex] the DD level to be extracted. If
-// the section doesn't have DD level support, a message is returned stating
-// that and to reissue the command w/o the ddLevel arg. If the section does
-// have DD support but the specified ddLevel cannot be found, a message is
-// returned stating that and no section is returned. If the arg is omitted,
-// the entire XIP section is returned
-// The 'delete' command deletes 0 or more sections, starting with <section0>.
-// Each section to be deleted must either be the final (highest address)
-// section of the image at the time it is deleted, or must be empty. The
-// 'delete' command writes the size of the final modified image to stdout.
-// The 'dissect' command dissects the ring section named by the section argument
-// and summarizes the content of the ring section. The second argument to
-// 'dissect', i.e. [table,short,normal(default),long], specifies how much information
-// is included in the listing:
-// table: Tabular overview.
-// short: The bare necessities.
-// normal: Everything except a binary dump of the ring block.
-// long: Everything including a binary dump of the ring block.
-// raw: Everything including a dump of the raw decompressed ring.
-// Note that iff the second argument is omitted, a 'normal' listing of the ring
-// section will occur.
-// The 'disasm' command disassembles the section named by the section argument.
-// The following -i<flag> are supported:
-// -ifs
-// causes the validation step to ignore image size check against the file
-// size.
-// -iv
-// causes all validation checking to be ignored. (Skips validation step.)
const char* g_usage =
"Usage: p9_xip_tool <image> [-i<flag> ...] normalize\n"
" p9_xip_tool <image> [-i<flag> ...] get <item>\n"
OpenPOWER on IntegriCloud