[Skiboot] [RFC PATCH 21/23] doc/device-tree: fix ReStructured Text syntax
Stewart Smith
stewart at linux.vnet.ibm.com
Wed Jul 27 17:43:22 AEST 2016
Signed-off-by: Stewart Smith <stewart at linux.vnet.ibm.com>
---
doc/device-tree/ibm,opal.rst | 20 ++++++++++++--------
doc/device-tree/nvlink.rst | 26 ++++++++++++++------------
doc/device-tree/nx.rst | 19 ++++++++++---------
doc/device-tree/reserved-memory.rst | 26 ++++++++++++++------------
doc/device-tree/vpd.rst | 37 +++++++++++++++++++------------------
5 files changed, 69 insertions(+), 59 deletions(-)
diff --git a/doc/device-tree/ibm,opal.rst b/doc/device-tree/ibm,opal.rst
index 3b90b5b..3ef8c2f 100644
--- a/doc/device-tree/ibm,opal.rst
+++ b/doc/device-tree/ibm,opal.rst
@@ -1,26 +1,30 @@
- ibm,opal {
+ibm,opal
+========
+::
+
+ ibm,opal {
#address-cells = <0x0>;
#size-cells = <0x0>;
compatible = "ibm,opal-v2", "ibm,opal-v3";
-; v2 is maintained for possible compatibility with very, very old kernels
-; it will go away at some point in the future. Detect and rely on ibm,opal-v3
-; ibm,opal-v2 is *NOT* present on POWER9 and above.
+ ; v2 is maintained for possible compatibility with very, very old kernels
+ ; it will go away at some point in the future. Detect and rely on ibm,opal-v3
+ ; ibm,opal-v2 is *NOT* present on POWER9 and above.
ibm,associativity-reference-points = <0x4 0x3>;
ibm,heartbeat-ms = <0x7d0>;
-; how often any OPAL call needs to be made to avoid a watchdog timer on BMC
-; from kicking in
+ ; how often any OPAL call needs to be made to avoid a watchdog timer on BMC
+ ; from kicking in
ibm,opal-memcons = <0x0 0x3007a000>;
-; location of in memory OPAL console buffer.
+ ; location of in memory OPAL console buffer.
ibm,opal-trace-mask = <0x0 0x3008c3f0>;
ibm,opal-traces = <0x0 0x3007b010 0x0 0x10077 0x0 0x3b001010 0x0 0x1000a7 0x0 0x3b103010 0x0 0x1000a7 0x0 0x3b205010 0x0 0x1000a7 0x0 0x3b307010 0x0 0x1000a7 0x0 0x3b409010 0x0 0x1000a7 0x10 0x1801010 0x0 0x1000a7 0x10 0x1903010 0x0 0x1000a7 0x10 0x1a05010 0x0 0x1000a7 0x10 0x1b07010 0x0 0x1000a7 0x10 0x1c09010 0x0 0x1000a7 0x10 0x1d0b010 0x0 0x1000a7 0x10 0x1e0d010 0x0 0x1000a7 0x10 0x1f0f010 0x0 0x1000a7 0x10 0x2011010 0x0 0x1000a7 0x10 0x2113010 0x0 0x1000a7 0x10 0x2215010 0x0 0x1000a7 0x10 0x2317010 0x0 0x1000a7 0x10 0x2419010 0x0 0x1000a7 0x10 0x251b010 0x0 0x1000a7 0x10 0x261d010 0x0 0x1000a7>;
-; see docs on tracing
+ ; see docs on tracing
linux,phandle = <0x10000003>;
opal-base-address = <0x0 0x30000000>;
diff --git a/doc/device-tree/nvlink.rst b/doc/device-tree/nvlink.rst
index 70e9545..641293b 100644
--- a/doc/device-tree/nvlink.rst
+++ b/doc/device-tree/nvlink.rst
@@ -4,16 +4,16 @@ Nvlink Device Tree Bindings
See doc/nvlink.txt for general Nvlink information.
-NPU bindings:
+NPU bindings: ::
-xscom at 3fc0000000000 {
+ xscom at 3fc0000000000 {
npu at 8013c00 {
reg = <0x8013c00 0x2c>;
compatible = "ibm,power8-npu";
ibm,npu-index = <0x0>;
ibm,npu-links = <0x4>;
-; Number of links wired up to this npu.
+ ; Number of links wired up to this npu.
phandle = <0x100002bc>;
linux,phandle = <0x100002bc>;
@@ -21,22 +21,22 @@ xscom at 3fc0000000000 {
link at 0 {
ibm,npu-pbcq = <0x1000000b>;
-; phandle to the pbcq which connects to the GPU.
+ ; phandle to the pbcq which connects to the GPU.
ibm,npu-phy = <0x80000000 0x8010c3f>;
-; SCOM address of the IBM PHY controlling this link.
+ ; SCOM address of the IBM PHY controlling this link.
compatible = "ibm,npu-link";
ibm,npu-lane-mask = <0xff>;
-; Mask specifying which IBM PHY lanes are used for this link.
+ ; Mask specifying which IBM PHY lanes are used for this link.
phandle = <0x100002bd>;
ibm,npu-link-index = <0x0>;
-; Hardware link index. Naples systems contain links at index 0,1,4 & 5.
-; Used to calculate various address offsets.
+ ; Hardware link index. Naples systems contain links at index 0,1,4 & 5.
+ ; Used to calculate various address offsets.
linux,phandle = <0x100002bd>;
};
@@ -71,14 +71,16 @@ xscom at 3fc0000000000 {
linux,phandle = <0x100002c0>;
};
};
-};
+ };
-Emulated PCI device bindings:
+Emulated PCI device bindings
+----------------------------
+::
pciex at 3fff000400000 {
ibm,npcq = <0x100002bc>;
-; phandle to the NPU node. Used to find associated PCI GPU devices.
+ ; phandle to the NPU node. Used to find associated PCI GPU devices.
compatible = "ibm,power8-npu-pciex", "ibm,ioda2-npu-phb";
@@ -91,7 +93,7 @@ Emulated PCI device bindings:
vendor-id = <0x1014>;
ibm,gpu = <0x100002f7>;
-; phandle pointing the associated GPU PCI device node
+ ; phandle pointing the associated GPU PCI device node
phandle = <0x100002fc>;
};
diff --git a/doc/device-tree/nx.rst b/doc/device-tree/nx.rst
index 84c97ac..4c54d4b 100644
--- a/doc/device-tree/nx.rst
+++ b/doc/device-tree/nx.rst
@@ -1,11 +1,11 @@
Nest (NX) Accelerator Coprocessor
----------------------------------
+=================================
The NX coprocessor is present in P7+ or later processors. Each NX node
represents a unique NX coprocessor. The nodes are located under an
-xscom node, as:
+xscom node, as: ::
-/xscom@<xscom_addr>/nx@<nx_addr>
+ /xscom@<xscom_addr>/nx@<nx_addr>
With unique xscom and nx addresses. Their compatible node contains
"ibm,power-nx".
@@ -16,9 +16,10 @@ NX 842 Coprocessor
This is the memory compression coprocessor, which uses the IBM proprietary
842 compression algorithm and format. Each nx node contains an 842 engine.
+::
-ibm,842-coprocessor-type : CT value common to all 842 coprocessors
-ibm,842-coprocessor-instance : CI value unique to all 842 coprocessors
+ ibm,842-coprocessor-type : CT value common to all 842 coprocessors
+ ibm,842-coprocessor-instance : CI value unique to all 842 coprocessors
Access to the coprocessor requires using the ICSWX instruction, which uses
a specific format including a Coprocessor Type (CT) and Coprocessor Instance
@@ -34,11 +35,11 @@ NX RNG Coprocessor
This is the Random Number Generator (RNG) coprocessor, which is a part
of each NX coprocessor. Each node represents a unique RNG coprocessor.
-Its nodes are not under the main nx node, they are located at:
+Its nodes are not under the main nx node, they are located at: ::
-/hwrng@<addr> : RNG at address <addr>
-ibm,chip-id : chip id where the RNG is
-reg : address of the register to read from
+ /hwrng@<addr> : RNG at address <addr>
+ ibm,chip-id : chip id where the RNG is
+ reg : address of the register to read from
Each read from the RNG register will provide a new random number.
diff --git a/doc/device-tree/reserved-memory.rst b/doc/device-tree/reserved-memory.rst
index ff0d6a4..c75d564 100644
--- a/doc/device-tree/reserved-memory.rst
+++ b/doc/device-tree/reserved-memory.rst
@@ -1,4 +1,5 @@
reserved-memory device tree nodes
+=================================
OPAL exposes reserved memory through a top-level reserved-memory node,
containing subnodes that represent each reserved memory region.
@@ -8,23 +9,24 @@ described in the kernel source tree, in:
Documentation/devicetree/bindings/reserved-memory/reserved-memory.txt
-The top-level /reserved-memory node contains:
+The top-level /reserved-memory node contains: ::
#size-cells = <2>
#address-cells = <2>
- - addresses and sizes are all 64-bits
- ranges;
- - the empty ranges node indicates no translation of physical
- addresses in the subnodes.
+Addresses and sizes are all 64-bits.
+
+``ranges``
+ the empty ranges node indicates no translation of physical
+ addresses in the subnodes.
The sub-nodes under the /reserved-memory node contain:
- reg = <address size>
- - the address and size of the reserved memory region. The address
- and size values are two cells each, as signified by the top-level
- #{address,size}-cells
+``reg = <address size>``
+ the address and size of the reserved memory region. The address
+ and size values are two cells each, as signified by the top-level
+ ``#{address,size}-cells``
- ibm,prd-label = "string"
- - a string token for use by the prd system. Specific ranges may be
- used by prd - those will be referenced by this label.
+``ibm,prd-label = "string"``
+ a string token for use by the prd system. Specific ranges may be
+ used by prd - those will be referenced by this label.
diff --git a/doc/device-tree/vpd.rst b/doc/device-tree/vpd.rst
index a2c5e63..65a1738 100644
--- a/doc/device-tree/vpd.rst
+++ b/doc/device-tree/vpd.rst
@@ -1,29 +1,30 @@
VPD (Vital Product Data)
-------------------------
+========================
VPD provides the information about the FRUs (Field Replaceable Unit) present in
the system and each vpd node in the device tree represents a FRU. These node and
their properties are specific to the FSP-based systems, passed to the skiboot in
the form of FSP-defined HDAT structures. skiboot parses these structures and
add respective nodes in the device tree.
+::
-/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)
-ibm,memory-bus-frequency: DIMM frequency (applicable for DIMM VPD only)
+ /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)
+ ibm,memory-bus-frequency: DIMM frequency (applicable for DIMM VPD only)
The VPD tree in the device tree depicts the hierarchial structure of the
-FRUs having parent-child relationship.
+FRUs having parent-child relationship. ::
-root-node-vpd at a000
+ root-node-vpd at a000
|-- enclosure at 1e00
| |-- air-mover at 3a00
| |-- air-mover at 3a01
@@ -52,9 +53,9 @@ root-node-vpd at a000
|-- root-node-vpd at a001
`-- system-vpd at 1c00
-Example vpd node:
+Example vpd node: ::
-anchor-card at 500 {
+ anchor-card at 500 {
ccin = "52FE";
fru-number = "00E2147";
description = "System Anchor Card - IBM Power 824";
@@ -65,4 +66,4 @@ anchor-card at 500 {
part-number = "00E2148";
phandle = <0x8d>;
linux,phandle = <0x8d>;
-};
+ };
--
2.7.4
More information about the Skiboot
mailing list