Skip to content

Commit

Permalink
doc: prettify OPAL_INT_* calls
Browse files Browse the repository at this point in the history
Signed-off-by: Stewart Smith <stewart@linux.ibm.com>
  • Loading branch information
stewartsmith committed Jun 3, 2019
1 parent 6f0bb48 commit 3baffee
Show file tree
Hide file tree
Showing 5 changed files with 33 additions and 20 deletions.
13 changes: 8 additions & 5 deletions doc/opal-api/opal-int-eoi-124.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
.. _OPAL_INT_EOI:

OPAL_INT_EOI
============
::

static int64_t opal_xive_eoi(uint32_t xirr)
.. code-block:: c
#define OPAL_INT_EOI 124
**Not yet implemented.**
static int64_t opal_int_eoi(uint32_t xirr);
Modelled on the ``H_EOI`` PAPR call.

Expand All @@ -17,5 +20,5 @@ For P9 and above systems where host doesn't know about interrupt controller.
An OS can instead make OPAL calls for XICS emulation.

For an OS to use this OPAL call, an ``ibm,opal-intc`` compatible device must
exist in the device tree. If OPAL does not create such a device, the host
OS MUST NOT use this call.
exist in the device tree (see :ref:`xive-device-tree`). If OPAL does not create
such a device, the host OS MUST NOT use this call.
13 changes: 8 additions & 5 deletions doc/opal-api/opal-int-get-xirr-122.rst
Original file line number Diff line number Diff line change
@@ -1,16 +1,19 @@
.. _OPAL_INT_GET_XIRR:

OPAL_INT_GET_XIRR
=================
::

int64_t opal_xive_get_xirr(uint32_t *out_xirr, bool just_poll)
.. code-block:: c
#define OPAL_INT_GET_XIRR 122
**Not yet implemented.**
int64_t opal_int_get_xirr(uint32_t *out_xirr, bool just_poll);
Modelled on the PAPR call.

For P9 and above systems where host doesn't know about interrupt controller.
An OS can instead make OPAL calls for XICS emulation.

For an OS to use this OPAL call, an ``ibm,opal-intc`` compatible device must
exist in the device tree. If OPAL does not create such a device, the host
OS MUST NOT use this call.
exist in the device tree (see :ref:`xive-device-tree`). If OPAL does not create
such a device, the host OS MUST NOT use this call.
12 changes: 7 additions & 5 deletions doc/opal-api/opal-int-set-cppr-123.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
.. _OPAL_INT_SET_CPPR:

OPAL_INT_SET_CPPR
=================
::

static int64_t opal_xive_set_cppr(uint8_t cppr)
.. code-block:: c
#define OPAL_INT_SET_CPPR 123
**Not yet implemented.**
static int64_t opal_int_set_cppr(uint8_t cppr);
Modelled on the ``H_CPPR`` PAPR call.

For P9 and above systems where host doesn't know about interrupt controller.
An OS can instead make OPAL calls for XICS emulation.

For an OS to use this OPAL call, an ``ibm,opal-intc`` compatible device must
exist in the device tree. If OPAL does not create such a device, the host
OS MUST NOT use this call.
exist in the device tree (see :ref:`xive-device-tree`). If OPAL does not create
such a device, the host OS MUST NOT use this call.
14 changes: 9 additions & 5 deletions doc/opal-api/opal-int-set-mfrr-125.rst
Original file line number Diff line number Diff line change
@@ -1,16 +1,20 @@
.. _OPAL_INT_SET_MFRR:

OPAL_INT_SET_MFRR
=================
::

static int64_t opal_xive_set_mfrr(uint32_t cpu, uint8_t mfrr)
.. code-block:: c
#define OPAL_INT_SET_MFRR 125
static int64_t opal_int_set_mfrr(uint32_t cpu, uint8_t mfrr);
**Not yet implemented.**
Modelled on the ``H_IPI`` PAPR call.

For P9 and above systems where host doesn't know about interrupt controller.
An OS can instead make OPAL calls for XICS emulation.

For an OS to use this OPAL call, an ``ibm,opal-intc`` compatible device must
exist in the device tree. If OPAL does not create such a device, the host
OS MUST NOT use this call.
exist in the device tree (see :ref:`xive-device-tree`). If OPAL does not create
such a device, the host OS MUST NOT use this call.
1 change: 1 addition & 0 deletions doc/xive.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
P9 XIVE Exploitation
====================

.. _xive-device-tree:

I - Device-tree updates
-----------------------
Expand Down

0 comments on commit 3baffee

Please sign in to comment.