diff options
author | Stewart Smith <stewart@linux.ibm.com> | 2019-05-31 16:13:15 +1000 |
---|---|---|
committer | Stewart Smith <stewart@linux.ibm.com> | 2019-06-03 10:20:00 +1000 |
commit | 2299cbb445b68a3588c9e8397ea667b21f972384 (patch) | |
tree | 89e42cbf93ca6a221d7acd54ef3f31e748f3458e | |
parent | 5b4d6f1f0e611c5355d0e7cfd9470bf1369e071e (diff) | |
download | skiboot-2299cbb445b68a3588c9e8397ea667b21f972384.zip skiboot-2299cbb445b68a3588c9e8397ea667b21f972384.tar.gz skiboot-2299cbb445b68a3588c9e8397ea667b21f972384.tar.bz2 |
doc: prettify OPAL_PCI_SET_PE
Signed-off-by: Stewart Smith <stewart@linux.ibm.com>
-rw-r--r-- | doc/opal-api/opal-pci-set-pe-31.rst | 36 |
1 files changed, 19 insertions, 17 deletions
diff --git a/doc/opal-api/opal-pci-set-pe-31.rst b/doc/opal-api/opal-pci-set-pe-31.rst index a101b90..41df454 100644 --- a/doc/opal-api/opal-pci-set-pe-31.rst +++ b/doc/opal-api/opal-pci-set-pe-31.rst @@ -1,9 +1,17 @@ +.. _OPAL_PCI_SET_PE: + OPAL_PCI_SET_PE =============== -:: + +.. code-block:: c #define OPAL_PCI_SET_PE 31 + int64_t opal_pci_set_pe(uint64_t phb_id, uint64_t pe_number, + uint64_t bus_dev_func, uint8_t bus_compare, + uint8_t dev_compare, uint8_t func_compare, + uint8_t pe_action); + **NOTE:** The following two paragraphs come from some old documentation and have not been checked for accuracy. Same goes for bus_compare, dev_compare and func_compare documentation. Do *NOT* assume this documentation is correct @@ -21,12 +29,6 @@ argument, for OPAL to correlate the RID (bus/dev/func) domain of the PE. If a PE domain is changed, the host must call this to reset the PE bus/dev/func domain and then call all other OPAL calls that map PHB IODA resources to update those domains within PHB facilities. -:: - - static int64_t opal_pci_set_pe(uint64_t phb_id, uint64_t pe_number, - uint64_t bus_dev_func, uint8_t bus_compare, - uint8_t dev_compare, uint8_t func_compare, - uint8_t pe_action) ``phb_id`` is the value from the PHB node ibm,opal-phbid property. @@ -75,17 +77,17 @@ update those domains within PHB facilities. OPAL_MAP_PE = 1 }; -Return value: +Returns +------- -OPAL_PARAMETER +:ref:`OPAL_PARAMETER` If one of the following: - - invalid phb - - invalid pe_action - - invalid bus_dev_func - - invalid bus_compare -OPAL_UNSUPPORTED + - invalid phb + - invalid pe_action + - invalid bus_dev_func + - invalid bus_compare +:ref:`OPAL_UNSUPPORTED` PHB does not support set_pe operation - -OPAL_SUCCESS - if opreation was successful +:ref:`OPAL_SUCCESS` + if operation was successful |