aboutsummaryrefslogtreecommitdiff
path: root/doc/opal-api/opal-pci-eeh-freeze-status-23.rst
blob: 035dc14e35b6e3ec8e2c20b263605d4c90ce4dde (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
.. _OPAL_PCI_EEH_FREEZE_STATUS:

OPAL_PCI_EEH_FREEZE_STATUS
==========================

.. code-block:: c

   #define OPAL_PCI_EEH_FREEZE_STATUS		23

   enum OpalFreezeState {
	OPAL_EEH_STOPPED_NOT_FROZEN = 0,
	OPAL_EEH_STOPPED_MMIO_FREEZE = 1,
	OPAL_EEH_STOPPED_DMA_FREEZE = 2,
	OPAL_EEH_STOPPED_MMIO_DMA_FREEZE = 3,
	OPAL_EEH_STOPPED_RESET = 4,
	OPAL_EEH_STOPPED_TEMP_UNAVAIL = 5,
	OPAL_EEH_STOPPED_PERM_UNAVAIL = 6
   };

   enum OpalPciStatusToken {
	OPAL_EEH_NO_ERROR	= 0,
	OPAL_EEH_IOC_ERROR	= 1,
	OPAL_EEH_PHB_ERROR	= 2,
	OPAL_EEH_PE_ERROR	= 3,
	OPAL_EEH_PE_MMIO_ERROR	= 4,
	OPAL_EEH_PE_DMA_ERROR	= 5
   };

   int64_t opal_pci_eeh_freeze_status(uint64_t phb_id, uint64_t pe_number,
                                      uint8_t *freeze_state,
                                      uint16_t *pci_error_type,
                                      uint64_t *phb_status);

.. note:: The ``phb_status`` parameter is deprecated as
	  of :ref:`skiboot-6.3-rc1`. Linux only ever passed in NULL,
	  and this was safe. Supplying a pointer was previously *unsafe*.
	  Always pass NULL.


Returns
-------

:ref:`OPAL_PARAMETER`
     Invalid address or PHB.
:ref:`OPAL_UNSUPPORTED`
     PHB does not support this operation.
:ref:`OPAL_HARDWARE`
     Hardware prohibited getting status, OPAL maybe marked it as broken.
:ref:`OPAL_SUCCESS`
     Retreived status.