diff mbox

[v7,10/10] skiboot: Add documentation for the Core IMC opal call

Message ID 1489036089-6529-11-git-send-email-maddy@linux.vnet.ibm.com
State Superseded
Headers show

Commit Message

maddy March 9, 2017, 5:08 a.m. UTC 
From: Hemant Kumar <hemant@linux.vnet.ibm.com>

Adds documentation for the opal_core_imc_counters_control() interface.

Signed-off-by: Hemant Kumar <hemant@linux.vnet.ibm.com>
Signed-off-by: Madhavan Srinivasan <maddy@linux.vnet.ibm.com>
---
 doc/opal-api/opal-core-imc-counters.rst | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 doc/opal-api/opal-core-imc-counters.rst
diff mbox

Patch

diff --git a/doc/opal-api/opal-core-imc-counters.rst b/doc/opal-api/opal-core-imc-counters.rst
new file mode 100644
index 000000000000..f7390a20f603
--- /dev/null
+++ b/doc/opal-api/opal-core-imc-counters.rst
@@ -0,0 +1,33 @@ 
+The interface can be extended to include more modes and operations
+available in core IMC.
+
+Parameters
+----------
+``uint64_t operation``
+  3 operations are supported for now (include/opal-api.h) :
+  - OPAL_CORE_IMC_DISABLE -- disable or stop the counters
+  - OPAL_CORE_IMC_ENABLE -- enable/resume the counters
+  - OPAL_CORE_IMC_INIT -- Initialize and enable the counters.
+
+``uint64_t addr``
+  For OPAL_CORE_IMC_INIT, this parameter must have a non-zero value.
+  This value must be a per-core physical address.
+  For other operations, this value is undefined and must be zero.
+
+``uint64_t value_1``
+  - This parameter is undefined for now and must be zero.
+
+``uint64_t value_2``
+  - This parameter is undefined for now and must be zero.
+
+Returns
+-------
+OPAL_PARAMETER
+  In any one/some/all of the following cases :
+  - Unsupported ``operation``
+  - Wrong ``addr`` for the given ``operation``
+  - Non-zero ``value_1`` or ``value_2``
+OPAL_HARDWARE
+   If xscom_write fails.
+OPAL_SUCCESS
+   On successful execution of the ``operation``.