[Skiboot] [RFC PATCH 23/23] doc/device-tree/ibm, opal: fix ReStructured Text syntax
Stewart Smith
stewart at linux.vnet.ibm.com
Wed Jul 27 17:43:24 AEST 2016
Signed-off-by: Stewart Smith <stewart at linux.vnet.ibm.com>
---
doc/device-tree/ibm,opal.rst | 8 +++++++
doc/device-tree/ibm,opal/diagnostics.rst | 5 ++---
doc/device-tree/ibm,opal/firmware.rst | 36 +++++++++++++++++++------------
doc/device-tree/ibm,opal/flash.rst | 28 +++++++++++-------------
doc/device-tree/ibm,opal/led.rst | 17 +++++++++------
doc/device-tree/ibm,opal/oppanel.rst | 7 +++---
doc/device-tree/ibm,opal/power-mgt.rst | 15 +++++++------
doc/device-tree/ibm,opal/sensors.rst | 37 ++++++++++++++++----------------
8 files changed, 85 insertions(+), 68 deletions(-)
diff --git a/doc/device-tree/ibm,opal.rst b/doc/device-tree/ibm,opal.rst
index 3ef8c2f..03f540c 100644
--- a/doc/device-tree/ibm,opal.rst
+++ b/doc/device-tree/ibm,opal.rst
@@ -1,5 +1,13 @@
ibm,opal
========
+
+.. toctree::
+ :maxdepth: 1
+ :glob:
+
+ ibm,opal/*
+
+
::
ibm,opal {
diff --git a/doc/device-tree/ibm,opal/diagnostics.rst b/doc/device-tree/ibm,opal/diagnostics.rst
index 14da91c..0314706 100644
--- a/doc/device-tree/ibm,opal/diagnostics.rst
+++ b/doc/device-tree/ibm,opal/diagnostics.rst
@@ -1,10 +1,9 @@
-
ibm,opal/diagnostics device tree entries
-----------------------------------
+========================================
The diagnostics node under ibm,opal describes a userspace-to-firmware
interface, supporting the runtime processor recovery diagnostics functions.
-The properties of a prd node are:
+The properties of a prd node are: ::
compatible = "ibm,opal-prd"
diff --git a/doc/device-tree/ibm,opal/firmware.rst b/doc/device-tree/ibm,opal/firmware.rst
index 3376fba..c936fce 100644
--- a/doc/device-tree/ibm,opal/firmware.rst
+++ b/doc/device-tree/ibm,opal/firmware.rst
@@ -1,9 +1,9 @@
System Firmware
----------------
+===============
-The 'firmware' node under 'ibm,opal' lists system and OPAL firmware version.
+The 'firmware' node under 'ibm,opal' lists system and OPAL firmware version. ::
-firmware {
+ firmware {
symbol-map = <0x0 0x300ac650 0x0 0x1b3f5>;
compatible = "ibm,opal-firmware";
ml-version = [4d 4c 20 46 57 37 37 30 2e 32 30 20 46 57 37 37 30 2e 32 30 20 46 57 37 37 30 2e 32 30];
@@ -11,20 +11,28 @@ firmware {
version = "skiboot-5.0-rc2";
phandle = <0x8e>;
linux,phandle = <0x8e>;
-};
+ };
-'compatible' property describes OPAL compatibility.
+``compatible``
+ property describes OPAL compatibility.
-'symbol-map' property describes OPAL symbol start address and size.
+``symbol-map``
+ property describes OPAL symbol start address and size.
-'version' property describes OPAL version. Replaces 'git-id', so may
-not be present. On POWER9 and above, it is always present.
+``version``
+ property describes OPAL version. Replaces 'git-id', so may
+ not be present. On POWER9 and above, it is always present.
-'mi-version' property describes Microcode Image. Only on IBM FSP systems.
-Will (likely) not be present on POWER9 systems.
+``mi-version``
+ property describes Microcode Image. Only on IBM FSP systems.
+ Will (likely) not be present on POWER9 systems.
-'ml-version' property describes Microcode Level. Only on IBM FSP systems.
-Will (likely) not be present on POWER9 systems.
+``ml-version``
+ property describes Microcode Level. Only on IBM FSP systems.
+ Will (likely) not be present on POWER9 systems.
-MI/ML format:
- <ML/MI> <T side version> <P side version> <boot side version>
+MI/ML format
+------------
+::
+
+ <ML/MI> <T side version> <P side version> <boot side version>
diff --git a/doc/device-tree/ibm,opal/flash.rst b/doc/device-tree/ibm,opal/flash.rst
index 872d623..28645e8 100644
--- a/doc/device-tree/ibm,opal/flash.rst
+++ b/doc/device-tree/ibm,opal/flash.rst
@@ -1,5 +1,5 @@
ibm,opal/flash device tree entries
-----------------------------------
+==================================
The flash@<n> nodes under ibm,opal describe flash devices that can be
accessed through the OPAL_FLASH_{READ,ERASE,WRITE} interface.
@@ -9,25 +9,23 @@ property of the node.
The properties under a flash node are:
- compatible = "ibm,opal-flash"
-
- ibm,opal-id = <id>
- - provides the index used for the OPAL_FLASH_ calls to reference this
- flash device
+- ``compatible = "ibm,opal-flash"``
- reg = <0 size>
- - the offset and size of the flash device
+``ibm,opal-id = <id>``
+ provides the index used for the OPAL_FLASH_XXX calls to reference this
+ flash device
- ibm,flash-block-size
- - the read/write/erase block size for the flash interface. Calls
- to read/write/erase must be aligned to the block size.
+``reg = <0 size>``
+ the offset and size of the flash device
- #address-cells = <1>
- #size-cells = <1>
- - flash devices are currently 32-bit addressable
+``ibm,flash-block-size``
+ the read/write/erase block size for the flash interface. Calls
+ to read/write/erase must be aligned to the block size.
+``#address-cells = <1>``, ``#size-cells = <1>``
+ flash devices are currently 32-bit addressable
-If valid partitions are found on the flash device, then partition@<offset>
+If valid partitions are found on the flash device, then ``partition@<offset>``
sub-nodes are added to the flash node. These match the Linux binding for
flash partitions; the reg parameter contains the offset and size of the
partition.
diff --git a/doc/device-tree/ibm,opal/led.rst b/doc/device-tree/ibm,opal/led.rst
index 5e48b85..48c45f1 100644
--- a/doc/device-tree/ibm,opal/led.rst
+++ b/doc/device-tree/ibm,opal/led.rst
@@ -1,10 +1,10 @@
Service Indicators (LEDS)
--------------------------
+=========================
The 'leds' node under 'ibm,opal' lists service indicators available in the
-system and their capabilities.
+system and their capabilities. ::
-leds {
+ leds {
compatible = "ibm,opal-v3-led";
phandle = <0x1000006b>;
linux,phandle = <0x1000006b>;
@@ -17,17 +17,20 @@ leds {
};
...
...
-};
+ };
-'compatible' property describes LEDs compatibility.
+compatible
+ property describes LEDs compatibility.
-'led-mode' property describes service indicator mode (lightpath/guidinglight).
+led-mode
+ property describes service indicator mode (lightpath/guidinglight).
Each node under 'leds' node describes location code of FRU/Enclosure.
The properties under each node:
- led-types : Supported indicators (attention/identify/fault).
+led-types
+ Supported indicators (attention/identify/fault).
These LEDs can be accessed through OPAL_LEDS_{GET/SET}_INDICATOR interfaces.
Refer to doc/opal-api/opal-led-get-set-114-115.txt for interface details.
diff --git a/doc/device-tree/ibm,opal/oppanel.rst b/doc/device-tree/ibm,opal/oppanel.rst
index 74a4d09..76b6c6c 100644
--- a/doc/device-tree/ibm,opal/oppanel.rst
+++ b/doc/device-tree/ibm,opal/oppanel.rst
@@ -1,11 +1,12 @@
Operator Panel (oppanel)
-------------------------
+========================
+::
-oppanel {
+ oppanel {
compatible = "ibm,opal-oppanel";
#lines = <0x2>;
#length = <0x10>;
-};
+ };
The Operator Panel is a device for displaying small amounts of textual
data to an administrator. On IBM POWER8 systems with an FSP, this is a
diff --git a/doc/device-tree/ibm,opal/power-mgt.rst b/doc/device-tree/ibm,opal/power-mgt.rst
index ca3487d..5bc1fb4 100644
--- a/doc/device-tree/ibm,opal/power-mgt.rst
+++ b/doc/device-tree/ibm,opal/power-mgt.rst
@@ -1,10 +1,11 @@
ibm,opal/power-mgt device tree entries
---------------------------------------
+======================================
All available CPU idle states are listed in ibm,cpu-idle-state-names
-For example:
-ibm,cpu-idle-state-names = "nap", "fastsleep_", "winkle";
+For example: ::
+
+ ibm,cpu-idle-state-names = "nap", "fastsleep_", "winkle";
The idle states are characterized by latency and residency
numbers which determine the breakeven point for entry into them. The
@@ -20,10 +21,10 @@ the measured latency numbers for the idle states. The residency numbers have
been arrived at experimentally after ensuring that the performance of latency
sensitive workloads do not regress while allowing deeper idle states to be
entered into during low load situations. The kernel is expected to use these
-values for optimal power efficiency.
-
-ibm,cpu-idle-state-residency-ns = <0x1 0x2 0x3>
-ibm,cpu-idle-state-latencies-ns = <0x1 0x2 0x3>
+values for optimal power efficiency. ::
+
+ ibm,cpu-idle-state-residency-ns = <0x1 0x2 0x3>
+ ibm,cpu-idle-state-latencies-ns = <0x1 0x2 0x3>
ibm,cpu-idle-state-pmicr ibm,cpu-idle-state-pmicr-mask
diff --git a/doc/device-tree/ibm,opal/sensors.rst b/doc/device-tree/ibm,opal/sensors.rst
index 80a6d81..f92c298 100644
--- a/doc/device-tree/ibm,opal/sensors.rst
+++ b/doc/device-tree/ibm,opal/sensors.rst
@@ -1,44 +1,43 @@
ibm,opal/sensors/ device tree nodes
---------------------------------------
+-----------------------------------
All sensors of a POWER8 system are made available to the OS in the
ibm,opal/sensors/ directory. Each sensor is identified with a node
-which name follows this pattern :
+which name follows this pattern : ::
<resource class name>@<resource identifier>/
-For example :
+For example : ::
core-temp at 20/
Each node has a minimum set of properties describing the sensor :
- - a "compatible" property which should be "ibm,opal-sensor"
+- a "compatible" property which should be "ibm,opal-sensor"
- - a "sensor-type" property, which can be "temp", "fan", "power".
- More will be added when new resources are supported. This type
- is used "as is" by the Linux driver to map sensors in the sysfs
- interface of the hwmon framework of Linux.
+- a "sensor-type" property, which can be "temp", "fan", "power".
+ More will be added when new resources are supported. This type
+ is used "as is" by the Linux driver to map sensors in the sysfs
+ interface of the hwmon framework of Linux.
- - a "sensor-data" property giving a unique handler for the
- OPAL_SENSOR_READ call to be used by Linux to get the value of
- a sensor attribute. A sensor handler has the following encoding :
+- a "sensor-data" property giving a unique handler for the
+ OPAL_SENSOR_READ call to be used by Linux to get the value of
+ a sensor attribute. A sensor handler has the following encoding : ::
| Attr. | Res. | Resource |
| Number | Class | Id |
|--------|--------|----------------|
- - a "sensor-status" property giving the state of the sensor. The
- status bits have the slightly meanings depending on the resource
- type but testing against 0x6 should raise an alarm.
-
- - an optional "label" property
+- a "sensor-status" property giving the state of the sensor. The
+ status bits have the slightly meanings depending on the resource
+ type but testing against 0x6 should raise an alarm.
+- an optional "label" property
Each node can have some extra properties depending on the resource
-they represent. See the tree below for more information.
+they represent. See the tree below for more information. ::
-ibm,opal/sensors/ {
+ ibm,opal/sensors/ {
/*
* Core temperatures (DTS) nodes.
@@ -90,4 +89,4 @@ ibm,opal/sensors/ {
label = "Centaur";
};
-};
+ };
--
2.7.4
More information about the Skiboot
mailing list