Skip to content

Commit

Permalink
doc: prettify OPAL_PCI_SET_PELTV
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 2299cbb commit 8ff8623
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions doc/opal-api/opal-pci-set-peltv-32.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
.. _OPAL_PCI_SET_PELTV:

OPAL_PCI_SET_PELTV
==================
::

.. code-block:: c
#define OPAL_PCI_SET_PELTV 32
int64_t opal_pci_set_peltv(uint64_t phb_id, uint32_t parent_pe,
uint32_t child_pe, uint8_t state);
**WARNING:** This documentation comes from an old source and is possibly not up
to date with OPALv3. Rely on this documentation only as a starting point,
use the source (and update the docs).

::

static int64_t opal_pci_set_peltv(uint64_t phb_id, uint32_t parent_pe,
uint32_t child_pe, uint8_t state)

This call sets the PELTV of a parent PE to add or remove a PE number as a PE
within that parent PE domain. The host must call this function for each child
Expand All @@ -38,7 +40,7 @@ of a parent PE.
and the upstream bridge PE of that switch -- an ERR_Fatal from either bridge
should result in a collateral freeze of that device PE.

::
.. code-block:: c
enum OpalPeltvAction {
OPAL_REMOVE_PE_FROM_DOMAIN = 0,
Expand All @@ -52,7 +54,9 @@ PE when the state argument is '1'. OPAL clears the PELTV bit in all RTT
entries for the parent PE when the state argument is '0' and setting the child
PE bit in the parent PELTV results in an all-zeros value for that PELTV.

Return value: ::
Return value:

.. code-block:: c
if (!phb)
return OPAL_PARAMETER;
Expand Down

0 comments on commit 8ff8623

Please sign in to comment.