summaryrefslogtreecommitdiffstats
path: root/examples/README
diff options
context:
space:
mode:
authorJason Albert <albertj@us.ibm.com>2015-07-20 16:05:03 -0500
committerJason Albert <albertj@us.ibm.com>2015-07-20 16:05:03 -0500
commit62d4c52086c067bfd6600f314fb34c12565f7729 (patch)
treeae1ce66fccdce2075efa90e8400f8336faf99734 /examples/README
parent7142dafa575769dc963fd83111aeabf0e8e1f2c3 (diff)
downloadvpdtools-62d4c52086c067bfd6600f314fb34c12565f7729.tar.gz
vpdtools-62d4c52086c067bfd6600f314fb34c12565f7729.zip
Removed old examples and added new ones provided by Michael Lim
- Removed old memcard and sysplanar examples - Added new, more specific examples provided by Michael Lim - Added a new README that describes what each of the examples are for
Diffstat (limited to 'examples/README')
-rw-r--r--examples/README44
1 files changed, 44 insertions, 0 deletions
diff --git a/examples/README b/examples/README
new file mode 100644
index 0000000..10f7a5a
--- /dev/null
+++ b/examples/README
@@ -0,0 +1,44 @@
+Full Image Examples
+===================
+
+memcard1_ddr3: This is an example of a VPD template for a DDR3 memory riser
+ card with a single memory buffer(Centaur).
+
+memcard4_ddr3: This is an example of a VPD template for a DDR3 memory riser
+ card with 2 to 4 memory buffer (Centaurs).
+
+memcard1_ddr4: This is an example of a VPD template for a DDR4 memory riser
+ card with a single memory buffer(Centaur).
+
+memcard4_ddr4: This is an example of a VPD template for a DDR4 memory riser
+ card with 2 to 4 memory buffer (Centaurs).
+
+sysplanar: This is an example of a VPD template for an OpenPower system
+ planar (aka mother board) that does not have any memory
+ buffer on the card. A memory riser card will be plugged
+ onto this system planar.
+
+sysplanar32_ddr3: This is an example of a VPD template for an OpenPower system
+ planar (aka mother board) that has upto 32 memory buffers
+ (Centaurs) on the card. DDR3 ISDIMMs are plugged onto this
+ system planar.
+
+sysplanar32_ddr4: This is an example of a VPD template for an OpenPower system
+ planar (aka mother board) that has upto 32 memory buffers
+ (Centaurs) on the card. DDR3 ISDIMMs are plugged onto this
+ system planar.
+
+Syntax Examples
+===============
+bindatainput: Shows the syntax to have a binary input file for the keyword
+ data
+
+hexwithcomments: Shows inclusion of comments within hex data for easier reading
+
+rbinfile: Shows how to include a binary file that contains an entire
+ record. Can be created using the -r option on createVpd.py
+
+simple: Most basic syntax example
+
+tworecords: Shows how to define multiple records within one top level
+ input file \ No newline at end of file
OpenPOWER on IntegriCloud