[Skiboot] [PATCH v9 11/11] skiboot: Add documentation for IMC opal call

[Anju T Sudhakar]

This patch adds documentation for the the opal calls
opal_imc_counters_init(), opal_imc_counters_start(),
and opal_imc_counters_stop().

Signed-off-by: Anju T Sudhakar <anju at linux.vnet.ibm.com>
---
 doc/opal-api/opal-imc-counters.rst | 60 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 60 insertions(+)
 create mode 100644 doc/opal-api/opal-imc-counters.rst

diff --git a/doc/opal-api/opal-imc-counters.rst b/doc/opal-api/opal-imc-counters.rst
new file mode 100644
index 0000000..72cac70
--- /dev/null
+++ b/doc/opal-api/opal-imc-counters.rst
@@ -0,0 +1,60 @@
+OPAL_IMC_COUNTERS_INIT
+==============================
+OPAL call interface to initialize In-memory collection
+infrastructure. This call support initialization of only
+Core IMC type.
+
+Parameters
+----------
+``uint32_t type``
+ This parameter specifies the imc counter domain.
+ The value should be 'OPAL_IMC_COUNTERS_CORE'
+
+``uint64_t addr``
+  This parameter must have a non-zero value.
+  This value must be a physical address of the core.
+
+
+Returns
+-------
+OPAL_PARAMETER - In case of  unsupported ``type``
+OPAL_HARDWARE  - If xscom_write fails.
+OPAL_SUCCESS   - When core counters are succesfully initialized.
+
+
+OPAL_IMC_COUNTERS_START
+============================
+OPAL call interface for starting the In-Memory Collection
+counters for a specified domain (NEST/CORE).
+
+Parameters
+----------
+``uint32_t type``
+ This parameter specifies the imc counter domain.
+ The value can be either 'OPAL_IMC_COUNTERS_NEST'
+ or 'OPAL_IMC_COUNTERS_CORE'
+
+Returns
+-------
+OPAL_PARAMETER - In case of  Unsupported ``type``
+OPAL_HARDWARE  - If xscom_write fails.
+OPAL_SUCCESS   - On successful execution of the operation for the given ``type``.
+
+
+OPAL_IMC_COUNTERS_STOP
+===========================
+OPAL call interface for stoping In-Memory
+Collection counters for the domain CORE/NEST.
+
+Parameters
+----------
+``uint32_t type``
+ This parameter specifies the imc counter domain.
+ The value can be either 'OPAL_IMC_COUNTERS_NEST'
+ or 'OPAL_IMC_COUNTERS_CORE'
+
+Returns
+-------
+OPAL_PARAMETER - In case of  Unsupported ``type``
+OPAL_HARDWARE  - If xscom_write fails.
+OPAL_SUCCESS   - On successful execution of the operation for the given ``type``.
-- 
2.7.4