[Skiboot] [PATCH v3 3/3] Document the device-tree entries for the VPD

[Neelesh Gupta]

Signed-off-by: Neelesh Gupta <neelegup at linux.vnet.ibm.com>
---
 doc/device-tree/vpd.txt |   64 +++++++++++++++++++++++++++++++++++++++++++++++
 doc/vpd-properties.txt  |   19 --------------
 2 files changed, 64 insertions(+), 19 deletions(-)
 create mode 100644 doc/device-tree/vpd.txt
 delete mode 100644 doc/vpd-properties.txt

diff --git a/doc/device-tree/vpd.txt b/doc/device-tree/vpd.txt
new file mode 100644
index 0000000..949ee0b
--- /dev/null
+++ b/doc/device-tree/vpd.txt
@@ -0,0 +1,64 @@
+VPD (Vital Product Data)
+------------------------
+
+VPD provides the information about the FRUs (Field Replaceable Unit) present in
+the system. Each vpd node represents a FRU, having properties as below.
+
+/vpd			: VPD root node
+<fru-name>@<rsrc-id>	: Node name
+ibm,vpd			: VPD data binary blob
+ccin			: Customer Card Identification Number
+fru-type		: FRU type label (2 bytes ASCII character)
+fru-number		: FRU stocking part number
+ibm,loc-code		: Location code
+part-number		: Part number
+serial-number		: Serial number
+ibm,chip-id		: Processor Id
+size			: DIMM size (applicable for DIMM VPD only)
+
+The VPD tree in the device tree depicts the hierarchial structure of the
+FRUs having parent-child relationship.
+
+root-node-vpd at a000
+    |-- enclosure at 1e00
+    |   |-- air-mover at 3a00
+    |   |-- air-mover at 3a01
+    |   |-- backplane at 800
+    |   |   |-- anchor-card at 500
+    |   |   |-- backplane-extender at 900
+    |   |   |   |-- serial-connector at 2a00
+    |   |   |   |-- usb-connector at 2900
+    |   |   |   `-- usb-connector at 2901
+    |   |   |-- ethernet-connector at 2800
+    |   |   |-- ethernet-connector at 2801
+    |   |   |-- ms-dimm at d002
+    |   |   |-- ms-dimm at d003
+    |   |   |-- processor at 1000
+    |   |   |-- processor at 1001
+    |   |   |-- usb-connector at 2902
+    |   |   |-- usb-connector at 2903
+    |   |   |-- usb-connector at 2904
+    |   |   `-- usb-connector at 2905
+    |   |-- dasd-backplane at 2400
+    |   |-- dasd-backplane at 2401
+    |   |-- power-supply at 3103
+    |   `-- service-processor at 200
+    |-- enclosure-fault-led at a300
+    |-- enclosure-led at a200
+    |-- root-node-vpd at a001
+    `-- system-vpd at 1c00
+
+Example vpd node:
+
+anchor-card at 500 {
+	ccin = "52FE";
+	fru-number = "00E2147";
+	description = "System Anchor Card - IBM Power 824";
+	ibm,loc-code = "U78C9.001.WZS007X-P1-C13";
+	serial-number = "YL10113BJ001";
+	ibm,vpd = <0x84cc0052 0x54045649 0x4e494452 0x10414e43 0x484f5220 0x20202020 0x20202020 0x20434501 0x31565a02 0x3031464e 0x7303045 0x32313437 0x504e0730 0x30453231 0x3438534e 0xc594c31 0x30313133 0x424a3030 0x31434304 0x35324645 0x50520881 0x300000 0x48 0x45043030 0x31304354 0x440b400 0x485702 0x14233 0x6000000 0x142 0x34010042 0x370c0000 0x0 0x0 0x4239 0x3c435333 0x22071917 0xd1569c53 0x50973c87 0x71f9c40 0x1d4d3142 0x985e80f1 0x5cb3614d 0x32a902cb 0xd9d714ab 0x164d3322 0xdda4f986 0x5a618f4d 0x340b157c 0x2cac0a94 0x6504603 0x78 0x0>;
+	fru-type = [41 56];
+	part-number = "00E2148";
+	phandle = <0x8d>;
+	linux,phandle = <0x8d>;
+};
diff --git a/doc/vpd-properties.txt b/doc/vpd-properties.txt
deleted file mode 100644
index ae18a7f..0000000
--- a/doc/vpd-properties.txt
+++ /dev/null
@@ -1,19 +0,0 @@
-VPD properties Description
-==========================
-
-/vpd		: VPD root node
-Node name	: <FRU description>@<Resource ID>
-ibm,vpd		: VPD data (binary blob)
-ccin		: Customer Card Identification Number
-fru-type	: FRU type label (two byte ASCII Char)
-fru-number	: FRU Stocking Part Number
-ibm,loc-code	: Location code
-part-number	: Part Number
-serial-number	: Serial Number
-ibm,chip-id	: Process ID
-size		: DIMM Size (applicable for DIMM VPD only)
-
-Child Node:
-===========
-A child node inherits its parent's VPD information except for the
-fru-type and location code.