diff options
author | 2023-10-10 14:33:42 +0000 | |
---|---|---|
committer | 2023-10-10 14:33:42 +0000 | |
commit | af1a266670d040d2f4083ff309d732d648afba2a (patch) | |
tree | 2fc46203448ddcc6f81546d379abfaeb323575e9 /roms/skiboot/doc/opal-api/opal-pci-get-set-pbcq-tunnel-bar-164-165.rst | |
parent | e02cda008591317b1625707ff8e115a4841aa889 (diff) |
Change-Id: Iaf8d18082d3991dec7c0ebbea540f092188eb4ec
Diffstat (limited to 'roms/skiboot/doc/opal-api/opal-pci-get-set-pbcq-tunnel-bar-164-165.rst')
-rw-r--r-- | roms/skiboot/doc/opal-api/opal-pci-get-set-pbcq-tunnel-bar-164-165.rst | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/roms/skiboot/doc/opal-api/opal-pci-get-set-pbcq-tunnel-bar-164-165.rst b/roms/skiboot/doc/opal-api/opal-pci-get-set-pbcq-tunnel-bar-164-165.rst new file mode 100644 index 000000000..dcbd62e31 --- /dev/null +++ b/roms/skiboot/doc/opal-api/opal-pci-get-set-pbcq-tunnel-bar-164-165.rst @@ -0,0 +1,70 @@ +.. _OPAL_PCI_GET_PBCQ_TUNNEL_BAR: + +OPAL_PCI_GET_PBCQ_TUNNEL_BAR +============================ + +.. code-block:: c + + #define OPAL_PCI_GET_PBCQ_TUNNEL_BAR 164 + + int64_t opal_pci_get_pbcq_tunnel_bar(uint64_t phb_id, uint64_t *addr); + +The host calls this function to read the address out of the PBCQ Tunnel +Bar register. + +Parameters +---------- + +``phb_id`` + The value from the PHB node ibm,opal-phbid property for the device. + +``addr`` + A pointer to where the address stored in the PBCQ Tunnel Bar register + will be copied. + +Return Values +------------- + +:ref:`OPAL_SUCCESS` + Operation was successful +:ref:`OPAL_PARAMETER` + Invalid PHB or addr parameter +:ref:`OPAL_UNSUPPORTED` + Not supported by hardware + +.. _OPAL_PCI_SET_PBCQ_TUNNEL_BAR: + +OPAL_PCI_SET_PBCQ_TUNNEL_BAR +============================ + +.. code-block:: c + + #define OPAL_PCI_SET_PBCQ_TUNNEL_BAR 165 + + int64_t opal_pci_set_pbcq_tunnel_bar(uint64_t phb_id, uint64_t addr); + +The host calls this function to set the PBCQ Tunnel Bar register. + +Parameters +---------- + +`phb_id` + The value from the PHB node ibm,opal-phbid property for the device. + +`addr` + The value of the address chosen for the PBCQ Tunnel Bar register. + If the address is 0, then the PBCQ Tunnel Bar register will be reset. + It the address is non-zero, then the PBCQ Tunnel Bar register will be + set with :: + + Bit[0:42] Bit[8:50] of the address + +Return Values +------------- + +:ref:`OPAL_SUCCESS` + Operation was successful +:ref:`OPAL_PARAMETER` + Invalid PHB or addr parameter +:ref:`OPAL_UNSUPPORTED` + Not supported by hardware |