[PATCH] Set error_state to pci_channel_io_normal in eeh_report_reset()

[Linas Vepstas]

Hi,

2009/4/10 Mike Mason <mmlnx at us.ibm.com>:
> While adding native EEH support to Emulex and Qlogic drivers, it was
> discovered that dev->error_state was set to pci_io_channel_normal too late
> in the recovery process. These drivers rely on error_state to determine if
> they can access the device in their slot_reset callback, thus error_state
> needs to be set to pci_io_channel_norm in eeh_report_reset(). Below is a
> detailed explanation (courtesy of Richard Lary) as to why this is necessary.
>
> Background:
> PCI MMIO or DMA accesses to a frozen slot generate additional EEH errors. If
> the number of additional EEH errors exceeds EEH_MAX_FAILS the adapter will
> be shutdown. To avoid triggering excessive EEH errors and an undesirable
> adapter shutdown, some drivers use the pci_channel_offline(dev) wrapper
> function to return a Boolean value based on the value of
> pci_dev->error_state to determine if PCI MMIO or DMA accesses are safe. If
> the wrapper returns TRUE, drivers must not make PCI MMIO or DMA access to
> their hardware.
>
> The pci_dev structure member error_state reflects one of three values, 1)
> pci_channel_io_normal, 2) pci_channel_io_frozen, 3)
> pci_channel_io_perm_failure. Function pci_channel_offline(dev) returns TRUE
> if error_state is pci_channel_io_frozen or pci_channel_io_perm_failure.
>
> The EEH driver sets pci_dev->error_state to pci_channel_io_frozen at the
> point where the PCI slot is frozen. Currently, the EEH driver restores
> dev->error_state to pci_channel_io_normal in eeh_report_resume() before
> calling the driver's resume callback. However, when the EEH driver calls the
> driver's slot_reset callback() from eeh_report_reset(), it incorrectly
> indicates the error state is still pci_channel_io_frozen.
>
> Waiting until eeh_report_resume() to restore dev->error_state to
> pci_channel_io_normal is too late for Emulex and QLogic FC drivers and any
> other drivers which are designed to use common code paths in these two
> cases: i) those called after the driver's slot_reset callback() and ii)
> those called after the PCI slot is frozen but before the driver's slot_reset
> callback is called. Case i) all driver paths executed to reinitialize the
> hardware after a reset and case ii) all code paths executed by driver kernel
> threads that run asynchronous to the main driver thread, such as interrupt
> handlers and worker threads to process driver work queues.
>
> Emulex and QLogic FC drivers are designed with common code paths which
> require that pci_channel_offline(dev) reflect the true state of the
> hardware. The state transitions that the hardware takes from Normal
> Operations to Slot Frozen to Reset to Normal Operations are documented in
> the Power Architecture™ Platform Requirements+ (PAPR+) in Table 75. PE State
> Control.
>
> PAPR defines the following 3 states:
>
> 0 -- Not reset, Not EEH stopped, MMIO load/store allowed, DMA allowed
> (Normal Operations)
> 1 -- Reset, Not EEH stopped, MMIO load/store disabled, DMA disabled
> 2 -- Not reset, EEH stopped, MMIO load/store disabled, DMA disabled (Slot
> Frozen)
>
> An EEH error places the slot in state 2 (Frozen) and the adapter driver is
> notified that an EEH error was detected. If the adapter driver returns
> PCI_ERS_RESULT_NEED_RESET, the EEH driver calls eeh_reset_device() to place
> the slot into state 1 (Reset) and eeh_reset_device completes by placing the
> slot into State 0 (Normal Operations). Upon return from eeh_reset_device(),
> the EEH driver calls eeh_report_reset, which then calls the adapter's
> slot_reset callback. At the time the adapter's slot_reset callback is
> called, the true state of the hardware is Normal Operations and should be
> accurately reflected by setting dev->error_state to pci_channel_io_normal.
>
> The current implementation of EEH driver does not do so and requires the
> following patch to correct this deficiency.
>
> Signed-off-by: Mike Mason <mmlnx at us.ibm.com>

Yes, the analysis sounds correct; this looks like the
right thing to do.

I'm rather surprised, as this is an "obvious" bug,
and should have been long gone.  I thought that
Emulex, QLogic  were not the only ones that were
using pci_channel_offline(dev) in this fashion.
I thought that the symbios scsi and the e1000 did,
too ... Hmm. Perhaps these used their own, private
flag for the same purpose, and reset it at the earlier,
correct time.

Thanks for the fix!

Signed-off-by: Linas Vepstas <linasvepstas at gmail.com>