Skip to content

HID: Intel-thc-hid: Refine error recovery flow

Even Xu linux-input lkml 6 versions – Applied

Status from this message: Applied, thanks.

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v5 Latest3 patches 1 replyApplied
  2. v4 posting 2/23 patches 0 repliesSuperseded
  3. v4 posting 1/23 patches 0 repliesSuperseded
Earlier versions · 3
VersionPostedPatchesRepliesStatus
v33 patches1 replySuperseded
v23 patches2 repliesSuperseded
v13 patches0 repliesSuperseded

Changes in v5 from the cover letter

- Add log message in quicki2c/quickspi driver to indicate driver function was disabled when recover failed.

Patches in v5 Applied

#Subject and filesSizeRepliesApplied
1/3HID: Intel-thc-hid: Intel-thc: Add API to reset read DMAdrivers/hid/intel-thc-hid/intel-thc/intel-thc-dma.c drivers/hid/intel-thc-hid/intel-thc/intel-thc-dma.h+52 -00 replies
2/3HID: Intel-thc-hid: Intel-quicki2c: Refine recover callbackdrivers/hid/intel-thc-hid/intel-quicki2c/pci-quicki2c.c drivers/hid/intel-thc-hid/intel-quicki2c/quicki2c-dev.h+49 -220 replies
3/3HID: Intel-thc-hid: Intel-quickspi: Refine recover callbackdrivers/hid/intel-thc-hid/intel-quickspi/pci-quickspi.c drivers/hid/intel-thc-hid/intel-quickspi/quickspi-dev.h+50 -270 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v5 yet.

Read the v5 thread

Cover letter [PATCH v5 0/3] HID: Intel-thc-hid: Refine error recovery flow

This series refines the fatal error recovery flow for the Intel THC (Touch Host Controller) subsystem, covering both the QuickI2C and QuickSPI drivers.

Currently, when a fatal DMA error is detected in the IRQ thread handler, the recovery is performed inline: the interrupt handler calls try_recover() directly, which unconfigures and reconfigures the DMA engine.

This approach has several problems:
1. Recovery runs in the IRQ thread context, which is not ideal for potentially slow reset operations.
2. The interrupt is re-enabled before recovery completes, risking an interrupt storm if DMA errors persist.
3. The DMA reset logic is open-coded in each protocol driver, leading to duplication and divergence over time.

This patch series addresses all of the above:

By adding a new thc_rxdma_reset() API to the THC core layer, QuickI2C and QuickSPI drivers can call it respectively to refine the recovery callback.

The synchronous try_recover() call in the IRQ thread is replaced with schedule_work(), deferring recovery to a workqueue. Within the work function:
- The interrupt line is disabled before any DMA manipulation.
- thc_rxdma_reset() is used instead of the open-coded sequence.
- On failure the device is marked DISABLED and the interrupt remains off, preventing an interrupt storm.

Change log:
v5:
- Add log message in quicki2c/quickspi driver to indicate driver function was disabled when recover failed.

v4:
- Refine cancel_work_sync() flow to reduce race condition of DMA operation confliction and reschedule.

v3:
- Quiesce external interrupt and disable THC internal interrupt in remove() and shutdown() callback before cancel_work_sync().

v2:
- Use dev_err() instead of dev_err_once() so repeated failures during recurring recovery are not silently suppressed.
- Pause both RxDMA channels via thc_wait_for_dma_pause() before calling thc_dma_unconfigure() to ensure the DMA engines are inactive before clearing PRD base addresses, preventing potential IOMMU faults or memory corruption.
- Hold a runtime PM reference inside try_recover() to prevent the device from suspending while the work accesses hardware registers.
- Add cancel_work_sync() in quicki2c_remove() and quicki2c_shutdown() to prevent use-after-free if recovery work is still queued at teardown.
- Only re-enable the interrupt in the IRQ thread handler when no recovery is needed; the work function handles re-enabling after successful reset, avoiding an interrupt storm from the uncleared hardware error state.

Even Xu (3):
HID: Intel-thc-hid: Intel-thc: Add API to reset read DMA
HID: Intel-thc-hid: Intel-quicki2c: Refine recover callback
HID: Intel-thc-hid: Intel-quickspi: Refine recover callback

 .../intel-quicki2c/pci-quicki2c.c             | 66 +++++++++++------
 .../intel-quicki2c/quicki2c-dev.h             |  5 ++
 .../intel-quickspi/pci-quickspi.c             | 71 ++++++++++++-------
 .../intel-quickspi/quickspi-dev.h             |  6 ++
 .../intel-thc-hid/intel-thc/intel-thc-dma.c   | 51 +++++++++++++
 .../intel-thc-hid/intel-thc/intel-thc-dma.h   |  1 +
 6 files changed, 151 insertions(+), 49 deletions(-)
Signature · 1 line
2.43.0