Skip to content

Commit

Permalink
doc/opal-api: Edit documentation for IMC opal call to include trace-imc
Browse files Browse the repository at this point in the history
OPAL call APIs for In-Memory Collection Counter infrastructure(IMC),
includes a new device type called OPAL_IMC_COUNTERS_TRACE. Edit the
documentation to include this information.

Signed-off-by: Anju T Sudhakar <anju@linux.vnet.ibm.com>
Signed-off-by: Stewart Smith <stewart@linux.ibm.com>
  • Loading branch information
anjutsudhakar authored and stewartsmith committed Mar 28, 2019
1 parent 09e9121 commit f3a0fb6
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions doc/opal-api/opal-imc-counters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ OPAL_IMC_COUNTERS_INIT
==============================
OPAL call interface to initialize In-memory collection
infrastructure. Call does multiple scom writes on each
incavation for Core IMC initialization. And for the
invocation for Core/Trace IMC initialization. And for the
Nest IMC, at this point, call is a no-op and returns
OPAL_SUCCESS. Incase of kexec, OS driver should first
stop the engine via OPAL_IMC_COUNTER_STOP(and then
Expand All @@ -24,7 +24,8 @@ Parameters
----------
``uint32_t type``
This parameter specifies the imc counter domain.
The value should be 'OPAL_IMC_COUNTERS_CORE'
The value can be 'OPAL_IMC_COUNTERS_NEST', 'OPAL_IMC_COUNTERS_CORE'
or 'OPAL_IMC_COUNTERS_TRACE'.

``uint64_t addr``
This parameter must have a non-zero value.
Expand All @@ -49,14 +50,14 @@ OPAL_SUCCESS
OPAL_IMC_COUNTERS_START
============================
OPAL call interface for starting the In-Memory Collection
counters for a specified domain (NEST/CORE).
counters for a specified domain (NEST/CORE/TRACE).

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'
The value can be 'OPAL_IMC_COUNTERS_NEST',
'OPAL_IMC_COUNTERS_CORE' or 'OPAL_IMC_COUNTERS_TRACE'.

``uint64_t cpu_pir``
This parameter specifices target cpu pir
Expand All @@ -77,7 +78,7 @@ OPAL_SUCCESS
OPAL_IMC_COUNTERS_STOP
======================
OPAL call interface for stoping In-Memory
Collection counters for a specified domain (NEST/CORE).
Collection counters for a specified domain (NEST/CORE/TRACE).
STOP should always be called after a related START.
While STOP *may* run successfully without an associated
START call, this is not gaurenteed.
Expand All @@ -86,8 +87,8 @@ 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'
The value can be 'OPAL_IMC_COUNTERS_NEST',
'OPAL_IMC_COUNTERS_CORE' or 'OPAL_IMC_COUNTERS_TRACE'

``uint64_t cpu_pir``
This parameter specifices target cpu pir
Expand Down

0 comments on commit f3a0fb6

Please sign in to comment.