diff --git a/README.md b/README.md index 16a25ca..56460ef 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ fru tools ========= -Tools to display/manipulate FMC FRU info +Tools to display/manipulate FMC FRU info. Althought the primary (only) +development happens on Linux, this is known to build and run on Windows, +(as a command line utility). The main documentation for this exists at: http://wiki.analog.com/resources/tools-software/linux-software/fru_dump @@ -12,4 +14,11 @@ http://ez.analog.com/community/linux-device-drivers Source is at: https://github.com/analogdevicesinc/fru_tools +Windows installer is at: +http://wiki.analog.com/resources/tools-software/linux-software/fru_dump + +If you are running Linux, and have the source, you can check out the man page with: +$ man -l ./fru-dump.1 +(That's a small L, not a 1, as in --local-file) + -Robin diff --git a/fru-dump.1 b/fru-dump.1 new file mode 100644 index 0000000..875ee2e --- /dev/null +++ b/fru-dump.1 @@ -0,0 +1,87 @@ +.TH FRU_DUMP 1 +.SH NAME +fru_dump \- print and manipulate FMC FRU file information +.SH SYNOPSIS +.B fru_dump +[\fB\-bcp\fR] +[\fB\-o\fR \fBOUTPUT_FILE\fR] +[\fB\-s \fBSERIAL_NUMBER\fR] +[\fB\-d \fBDATE\fR] +[\fB\-i\fR] +.IR file ... +.SH DESCRIPTION +.B fru_dump +The FMC specification includes a methodology where FMC mezzanine modules must +provide hardware definition information that can be read by an external controller +on the FMC Carrier platform (most of the time the FPGA on the carrier). This +hardware definition is defined by FRU (Field Replaceable Unit) Information +storage recorders, as defined in the Intel Platform Management FRU Information +Storage Definition V1.1 + +This utility allows you to dump and changes information for the FMC mezzanine modules FRU files. +.SH OPTIONS +.SS "Generic Program Information" +.IX Subsection "Generic Program Information" +.TP +.B \-? \-h +Print a useage message, summarizing these command line options, and then exit. +.TP +.BR \-i " FRU_FILE_IN" +This is the FMC mezzanine modules FRU file to manipulate or dump +.TP +.BR \-o " FRU_FILE_OUT" +If manipulating a field in the file, place the output to this file. +Stdout ("\-") can be provided as the filename. + +If -o is not specified, the default is not to write any file (and the changes +are made in memory only). +.SS "Options Controlling the Dump Output" +.IX Subsection "Options Controlling the Dump Output" +.TP +.BR \-b +Display the Board Info Area. This includes +Board Manufacturer(optional), +Board Product Name(optional), +Board Serial Number(optional), +Board Part Number(optional), +and the Date of Manufacture(non-optional). +This can also include optional/additional custom manufacture specific info fields. +Analog Devices uses these to denote the revision of the PCB. +.TP +.BR \-c +Display the FMC specific connector Info. This will detail how many (number) and +of what type (parallel or high speed transciever) pins are required on the mezzanine. +.TP +.BR \-p +Display the Power info. This will detail the power requirements (currents) of the board, +as well as the voltage I/O requirements in order that the FMC Carrier platform doesn't turn on something +that may damange the mezzanine module. +dump power supply info +.TP +.BR \-2 +Display any I2C devices which might be on the FMC mezzanine module, and it's address +.TP +.BR \-v +Be a little more verbose, and check a few more things +(like making sure ASCII strings, contain ASCII printable characters). +.SS "Options to Manipulate FMC mezzanine modules FRU file contents" +.IX Subsection "Options to Manipulate FMC mezzanine modules FRU file contents" +.TP +-d