aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorReza Arbab <arbab@linux.ibm.com>2018-08-01 15:01:19 -0500
committerStewart Smith <stewart@linux.ibm.com>2018-08-06 03:00:59 -0500
commit1c62f56b33511f4208ae289afb68f3d1f24f3924 (patch)
tree214af8e2b948632005f16c0f8d6c623f2a7173ad /doc
parent736d8b150f8611af0c4d0bdf6b3273a7a0e2b1c2 (diff)
downloadskiboot-1c62f56b33511f4208ae289afb68f3d1f24f3924.zip
skiboot-1c62f56b33511f4208ae289afb68f3d1f24f3924.tar.gz
skiboot-1c62f56b33511f4208ae289afb68f3d1f24f3924.tar.bz2
doc/opal-api: Document npu2 relaxed ordering APIs
Add documentation for these new OPAL APIs: #define OPAL_NPU_SET_RELAXED_ORDER 168 #define OPAL_NPU_GET_RELAXED_ORDER 169 Signed-off-by: Reza Arbab <arbab@linux.ibm.com> Signed-off-by: Stewart Smith <stewart@linux.ibm.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/opal-api/opal-npu2-get-set-relaxed-order-168-169.rst67
1 files changed, 67 insertions, 0 deletions
diff --git a/doc/opal-api/opal-npu2-get-set-relaxed-order-168-169.rst b/doc/opal-api/opal-npu2-get-set-relaxed-order-168-169.rst
new file mode 100644
index 0000000..a27729c
--- /dev/null
+++ b/doc/opal-api/opal-npu2-get-set-relaxed-order-168-169.rst
@@ -0,0 +1,67 @@
+.. _OPAL_NPU_SET_RELAXED_ORDER:
+
+OPAL_NPU_SET_RELAXED_ORDER
+==========================
+
+Request that relaxed memory ordering be enabled or disabled for a device.
+
+Parameters
+----------
+::
+
+ uint64_t phb_id
+ uint16_t bdfn
+ bool request_enabled
+
+``phb_id``
+ OPAL ID of the PHB
+
+``bdfn``
+ Bus-Device-Function number of the device
+
+``request_enabled``
+ Requested state of relaxed memory ordering enablement
+
+Return values
+-------------
+
+``OPAL_SUCCESS``
+ Requested state set
+
+``OPAL_PARAMETER``
+ The given phb_id or bdfn is invalid or out of range
+
+``OPAL_CONSTRAINED``
+ Relaxed ordering can not be enabled until an enable request is made
+ for every device on this PHB.
+
+``OPAL_RESOURCE``
+ No more relaxed ordering sources are available
+
+.. _OPAL_NPU_GET_RELAXED_ORDER:
+
+OPAL_NPU_GET_RELAXED_ORDER
+==========================
+
+Query the relaxed memory ordering state of a device.
+
+Parameters
+----------
+::
+
+ uint64_t phb_id
+ uint64_t bdfn
+
+``phb_id``
+ OPAL ID of the PHB
+
+``bdfn``
+ Bus-Device-Function number of the device
+
+Return values
+-------------
+
+On success, the current relaxed ordering state is returned.
+
+``OPAL_PARAMETER``
+ The given phb_id or bdfn is invalid.