spi: pxa2xx: MacBook8,1 quirk and LPSS S3 resume state fixes
Subsystems (3)
v5 cover spi: pxa2xx: MacBook8,1 quirk and LPSS S3 resume state fixes
Hi Mark,
This patch series resolves two issues in the spi-pxa2xx host controller driver related to Intel LPSS SPI controllers.
Patch 1 moves the forced PIO mode quirk for the Apple MacBook8,1 LPSS SPI controller from the client driver (applespi) to the host controller PCI glue driver (spi-pxa2xx-pci) where it belongs. It also fixes a runtime PM issue:
when DMA is disabled, aggressive runtime clock gating causes PCIe Completion Timeouts on subsequent MMIO accesses.
Patch 2 fixes S3 suspend/resume for Intel LPSS SPI controllers. The LPSS power domain is fully removed across S3, losing all private register state. Accessing MMIO on resume while the block is held in reset causes a PCIe Completion Timeout and a watchdog system reset. To fix this, we save the LPSS private registers in struct driver_data during suspend, de-assert resets first on resume, and restore the saved registers.
Changes in v5:
- Addressed feedback from Sashiko review on the v4 patchset:
- Reverted runtime PM configuration in spi-pxa2xx-pci.c to be unconditional. This prevents the usage count from leaking by +1 on unbind for PIO mode, while letting pxa2xx_spi_probe()'s pm_runtime_get_noresume() and pxa2xx_spi_remove()'s pm_runtime_put_noidle() handle the permanent autosuspend lockout for PIO devices symmetrically.
- Removed the pm_runtime_forbid() call from pxa2xx_spi_remove(). This resolves reference leaks for non-PCI platform devices where pm_runtime_allow() was never called during probe.
- Delayed clearing the drv_data->suspended flag on resume until after LPSS reset deassertion and private register restoration are complete. This prevents a shared interrupt from firing during resume and attempting to read the SSSR register while the LPSS block is still held in reset.
- Set drv_data->suspended = true on spi_controller_resume() failure path in pxa2xx_spi_resume(). This ensures that subsequent shared interrupts do not attempt register access once the clock is disabled.
Changes in v4:
- Track clock state using drv_data->clk_enabled via pxa2xx_spi_clk_enable() and pxa2xx_spi_clk_disable() helper functions. This guarantees clock enable/disable symmetry, preventing clock disable count underflows and framework warnings on S3 resume or runtime autosuspend error paths.
- Introduce drv_data->suspended flag to protect MMIO access in ssp_int() during system suspend and runtime suspend transition windows.
- Initialize drv_data->suspended = true early in probe(), clearing it only after the clock is successfully enabled. This completely prevents shared interrupt handler races during device probe when the clock is still off.
- Call synchronize_irq() after setting drv_data->suspended = true in suspend and runtime_suspend. This ensures any running shared interrupt handlers finish executing before the clock is physically turned off.
Changes in v3:
- Avoid PM reference leaks on probe bind/unbind cycle by keeping probe PM configuration symmetric.
- Prevent userspace (PowerTOP, udev) from overriding runtime PM settings when DMA is disabled by holding a PM reference via pm_runtime_get_noresume() in pxa2xx_spi_probe() and dropping it in remove/error paths.
- Check device status in the shared interrupt handler ssp_int() using pm_runtime_get_if_active() instead of pm_runtime_suspended(). If the device is suspending (RPM_SUSPENDING) or suspended, ssp_int() immediately returns IRQ_NONE to avoid reading unclocked MMIO registers during power transition.
- Adjust the driver teardown order in pxa2xx_spi_remove() and probe error paths:
always call free_irq() to unregister the handler before calling clk_disable_unprepare() to turn off the clock, preventing concurrent interrupts from reading registers while the clock is disabled.
- On S3 suspend success path, return 0 directly without dropping the PM reference. This preserves the acquired PM reference across suspend. On S3 resume, release it via pm_runtime_put_autosuspend(), and ensure all error paths in resume (clock enable failure or spi_controller_resume failure) jump to out_put to correctly release the reference, preventing reference count underflow and leaks.
- Avoid duplicate can-DMA pci_info() logging by checking the pre-computed enable_dma status in probe and passing a verbose flag to can_dma().
Changes in v2:
- Addressed feedback from Mark Brown on the original v1 series.
- Used drv_data->lpss_base together with relative offsets rather than hardcoding absolute MMIO offsets that vary between LPSS IP revisions.
- Moved the register save block in suspend to after the controller is quiesced (after spi_controller_suspend() and pxa_ssp_disable()).
- Store the context array lpss_priv_ctx[6] inside struct driver_data instead of struct pxa2xx_spi_controller. This keeps the changes entirely local to the core driver, preventing symbol version mismatches (disagrees about version of symbol) for other subsystem components (e.g., spi-pxa2xx-platform.ko).
- Restrict the save/restore loop to the first 6 LPSS private registers (offsets 0x00 to 0x14). Offsets beyond 0x14 (except CS control at 0x18, which is re-initialised by lpss_ssp_setup()) are reserved/unimplemented on LPT platforms (such as MacBook8,1), and writing to them triggers a PCIe Completion Timeout causing a system freeze.
- Added named constants for LPSS_PRIV_RESETS and the de-assert value.
- Wrapped S3 suspend/resume with pm_runtime_resume_and_get() and pm_runtime_put_autosuspend() respectively.
Shih-Yuan Lee (2):
spi: pxa2xx: disable DMA and fix runtime PM for Apple MacBook8,1
spi: pxa2xx: restore LPSS private register state on S3 resume
drivers/spi/spi-pxa2xx-pci.c | 37 ++++++- drivers/spi/spi-pxa2xx.c | 195 +++++++++++++++++++++++++++++------ drivers/spi/spi-pxa2xx.h | 4 + 3 files changed, 204 insertions(+), 32 deletions(-)
Signature · 1 line
2.39.5
PATCH v5 1/2 spi: pxa2xx: disable DMA and fix runtime PM for Apple MacBook8,1
On MacBook8,1 (early 2015 12" MacBook), the LPSS SPI controller at 00:15.4 has two related problems: DMA handshake/interrupt routing fails, and runtime PM autosuspend clock-gates the LPSS block, triggering PCIe Completion Timeouts.
Move the force-PIO DMI quirk to spi-pxa2xx-pci.c (the LPSS host controller driver) to avoid layering violations in the client driver.
To prevent the PCIe Completion Timeout crash when operating in PIO mode:
- If DMA is disabled (either statically via the DMI quirk / module parameter or dynamically due to channel exhaustion), call pm_runtime_get_noresume() in pxa2xx_spi_probe() to hold a runtime PM reference, and release it via pm_runtime_put_noidle() in the remove/error paths. This keeps the PM count above 0 and permanently locks the device out of autosuspend, preventing userspace tools (like PowerTOP) or udev rules from overriding it.
- Implement helper functions pxa2xx_spi_clk_enable() and pxa2xx_spi_clk_disable() to track clock state via drv_data->clk_enabled, preventing clock disable count underflows and framework warnings on resume/autosuspend error paths.
- Check device status in the shared interrupt handler ssp_int() using pm_runtime_get_if_active() and drv_data->suspended. If the device is suspended, suspending (RPM_SUSPENDING), or clock-disabled, ssp_int() immediately returns IRQ_NONE to avoid reading unclocked MMIO registers.
- Initialize drv_data->suspended to true early in probe, and clear it only after the clock is successfully enabled, preventing shared interrupt handler races during device initialization.
- In pxa2xx_spi_runtime_suspend() and pxa2xx_spi_suspend(), set drv_data->suspended to true and call synchronize_irq() to wait for any active handlers on the shared interrupt line to finish before disabling the clock.
- Adjust the driver teardown order in pxa2xx_spi_remove() and probe error paths:
always call free_irq() to unregister the handler before calling clk_disable_unprepare() to turn off the clock, preventing concurrent interrupts from reading registers while the clock is disabled.
Avoid duplicate can-DMA pci_info() logging by checking the pre-computed enable_dma status in probe and passing a verbose flag to can_dma().
--- drivers/spi/spi-pxa2xx-pci.c | 37 ++++++++++- drivers/spi/spi-pxa2xx.c | 115 +++++++++++++++++++++++++++-------- drivers/spi/spi-pxa2xx.h | 3 + 3 files changed, 129 insertions(+), 26 deletions(-)
drivers/spi/spi-pxa2xx-pci.c +35 -2
@@ -18,9 +18,14 @@#include <linux/dmaengine.h> #include <linux/platform_data/dma-dw.h> +#include <linux/dmi.h> #include "spi-pxa2xx.h" +static bool spi_pxa2xx_force_pio; +module_param_named (force_pio, spi_pxa2xx_force_pio, bool,0444 ); +MODULE_PARM_DESC (force_pio,"Force PIO mode (disables DMA) for SPI transfers. ([0] = disabled, 1 = enabled)" ); +#define PCI_DEVICE_ID_INTEL_QUARK_X1000 0x0935#define PCI_DEVICE_ID_INTEL_BYT 0x0f0e#define PCI_DEVICE_ID_INTEL_MRFLD 0x1194
@@ -93,6 +98,34 @@ static void lpss_dma_put_device(void *dma_dev)pci_dev_put (dma_dev); } +static const struct dmi_system_id pxa2xx_spi_pci_dmi_table[] = { + { + .ident ="Apple MacBook8,1" , + .matches = { +DMI_MATCH (DMI_SYS_VENDOR ,"Apple Inc." ), +DMI_MATCH (DMI_PRODUCT_NAME ,"MacBook8,1" ), + }, + }, + { } +}; + +static bool pxa2xx_spi_pci_can_dma (struct pci_dev *dev,bool verbose) +{ +if (spi_pxa2xx_force_pio) { +if (verbose) +pci_info (dev,"Forcing PIO mode (disabling DMA)\n" ); +return false; + } + +if (dmi_check_system (pxa2xx_spi_pci_dmi_table)) { +if (verbose) +pci_info (dev,"MacBook8,1 detected: disabling DMA to force PIO mode\n" ); +return false; + } + +return true; +} +static int lpss_spi_setup (struct pci_dev *dev,struct pxa2xx_spi_controller *c) {struct ssp_device *ssp = &c->ssp;
@@ -166,7 +199,7 @@ static int lpss_spi_setup(struct pci_dev *dev, struct pxa2xx_spi_controller *c) c->dma_filter = lpss_dma_filter; c->dma_burst_size =1 ; - c->enable_dma =1 ; + c->enable_dma =pxa2xx_spi_pci_can_dma (dev, true);return 0 ; }
@@ -238,7 +271,7 @@ static int mrfld_spi_setup(struct pci_dev *dev, struct pxa2xx_spi_controller *c) c->dma_filter = lpss_dma_filter; c->dma_burst_size =8 ; - c->enable_dma =1 ; + c->enable_dma =pxa2xx_spi_pci_can_dma (dev, true);return 0 ; }
drivers/spi/spi-pxa2xx.c +91 -24
217 lines not on this page · raw message
drivers/spi/spi-pxa2xx.h +3 -0
@@ -72,6 +72,9 @@ struct driver_data {void __iomem *lpss_base; +bool suspended; +bool clk_enabled; +/* Optional slave FIFO ready signal */ struct gpio_desc *gpiod_ready; };
Signature · 1 line
2.39.5
PATCH v5 2/2 spi: pxa2xx: restore LPSS private register state on S3 resume
In reply to Shih-Yuan LeeIntel LPSS SPI controllers lose all private register state across S3 suspend because the LPSS power domain is fully removed. On resume the driver only re-enables the SSP clock, leaving the LPSS private registers in their power-on-reset state, which causes two problems:
1. LPSS_PRIV_RESETS (offset 0x04 within the LPSS private space) stays zero, keeping the functional block in reset. Any MMIO access while the block is held in reset causes a PCIe Completion Timeout and a watchdog-triggered system reset. LPSS_PRIV_RESETS_FUNC and LPSS_PRIV_RESETS_IDMA must be de-asserted before any other register access on resume.
2. The LPSS software chip-select control register must not be blindly restored from its suspend-time snapshot: if CS was asserted at the moment of suspend, restoring that state corrupts the first post-resume SPI transaction. Instead, call lpss_ssp_setup() which unconditionally writes SW_MODE | CS_HIGH (idle/deasserted), matching the state established at probe time.
To resolve these issues safely:
- Wrap S3 suspend/resume with pm_runtime_resume_and_get() and pm_runtime_put_autosuspend() respectively. This ensures that if the device was runtime-suspended, it is temporarily resumed to active state prior to suspend. This guarantees that the clock and power domain are active during MMIO register access, and that the private registers are consistently saved and restored across S3 sleep cycles.
- On S3 suspend success path, return 0 directly without dropping the PM reference. This preserves the acquired PM reference across suspend. On S3 resume, release it via pm_runtime_put_autosuspend(), and ensure all error paths in resume (clock enable failure or spi_controller_resume failure) jump to out_put to correctly release the reference, preventing reference count underflow and leaks.
- Save only the first 6 LPSS private registers (offsets 0x00 to 0x14) via drv_data->lpss_base during suspend. Offsets beyond 0x14 (except CS control at 0x18, which is re-initialised by lpss_ssp_setup()) are reserved/unimplemented on LPT platforms (such as MacBook8,1), and writing to them triggers a PCIe Completion Timeout causing a system freeze.
- Clear drv_data->suspended only after de-asserting the resets and restoring the private registers on resume. This prevents shared interrupt handlers from performing unclocked/held-in-reset MMIO accesses if an interrupt fires during the resume process.
- Revert drv_data->suspended to true on spi_controller_resume() failure to ensure subsequent interrupts do not attempt register reads after the clock is disabled.
- Store the saved context in drv_data->lpss_priv_ctx[6] (inside struct driver_data) which is private to the core driver. This avoids changing the layout of struct pxa2xx_spi_controller, preventing ABI symbol version mismatches with uncompiled platform drivers (e.g., spi-pxa2xx-platform.ko).
On resume, de-assert resets first, restore all other saved registers, then call lpss_ssp_setup() to re-initialise CS.
--- drivers/spi/spi-pxa2xx.c | 88 +++++++++++++++++++++++++++++++++++----- drivers/spi/spi-pxa2xx.h | 1 + 2 files changed, 79 insertions(+), 10 deletions(-)
drivers/spi/spi-pxa2xx.c +78 -10
@@ -72,7 +72,12 @@ struct chip_data {#define LPSS_CAPS_CS_EN_SHIFT 9#define LPSS_CAPS_CS_EN_MASK (0xf << LPSS_CAPS_CS_EN_SHIFT) -#define LPSS_PRIV_CLOCK_GATE 0x38 +/* Offsets from drv_data->lpss_base */ +#define LPSS_PRIV_RESETS 0x04 +#define LPSS_PRIV_RESETS_IDMA BIT(2) +#define LPSS_PRIV_RESETS_FUNC 0x3 + +#define LPSS_PRIV_CLOCK_GATE 0x38#define LPSS_PRIV_CLOCK_GATE_CLK_CTL_MASK 0x3#define LPSS_PRIV_CLOCK_GATE_CLK_CTL_FORCE_ON 0x3#define LPSS_PRIV_CLOCK_GATE_CLK_CTL_FORCE_OFF 0x0
@@ -1532,19 +1537,43 @@ static int pxa2xx_spi_suspend(struct device *dev)struct ssp_device *ssp = drv_data->ssp;int status; + status =pm_runtime_resume_and_get (dev); +if (status <0 ) +return status; + status =spi_controller_suspend (drv_data->controller);if (status) -return status; + goto out_put; +/* Mark as suspended and synchronize IRQ before disabling clock */ drv_data->suspended = true;synchronize_irq (ssp->irq);pxa_ssp_disable (ssp); -if (!pm_runtime_suspended (dev)) -pxa2xx_spi_clk_disable (drv_data); +if (is_lpss_ssp (drv_data)) { +unsigned int i; +/* +* Save the first 6 LPSS private registers (offsets 0x00 to 0x14) +* while the clock is still enabled. They are lost when the LPSS +* power domain is removed across S3 and must be restored on resume. +* Use drv_data->lpss_base so the correct per-platform offset +* is applied regardless of LPSS IP revision. +* Registers beyond 0x14 (except CS control at 0x18) are reserved +* or unimplemented on LPT, and accessing them triggers a PCIe +* Completion Timeout causing a system halt. +*/ +for (i =0 ; i <6 ; i++) + drv_data->lpss_priv_ctx[i] =readl (drv_data->lpss_base + i *4 ); + } + +pxa2xx_spi_clk_disable (drv_data);return 0 ; + +out_put: +pm_runtime_put_noidle (dev); +return status; }static int pxa2xx_spi_resume (struct device *dev)
@@ -1554,12 +1583,46 @@ static int pxa2xx_spi_resume(struct device *dev)int status;/* Enable the SSP clock */ -if (!pm_runtime_suspended (dev)) { - status =pxa2xx_spi_clk_enable (drv_data); -if (status) -return status; + status =pxa2xx_spi_clk_enable (drv_data); +if (status) + goto out_put; + +if (is_lpss_ssp (drv_data)) { +unsigned int i; + +/* +* The LPSS power domain is removed across S3, taking +* all private registers with it. De-assert the +* functional block and IDMA resets first; any MMIO +* access while the block is held in reset causes a +* PCIe Completion Timeout and a watchdog-triggered +* system reset. +*/ +writel (LPSS_PRIV_RESETS_FUNC |LPSS_PRIV_RESETS_IDMA , + drv_data->lpss_base +LPSS_PRIV_RESETS ); + +/* Restore the other 5 saved private registers */ +for (i =0 ; i <6 ; i++) { +if (i ==LPSS_PRIV_RESETS /4 ) +continue ; +writel (drv_data->lpss_priv_ctx[i], + drv_data->lpss_base + i *4 ); + } + +/* +* Re-initialise the SW chip-select control register so +* CS starts deasserted (SW_MODE | CS_HIGH), regardless +* of the state it was in at suspend time. A stale +* asserted CS on the first post-resume transaction +* corrupts the write-status response from the device. +*/ +lpss_ssp_setup (drv_data); } +/* +* Now that resets are de-asserted and registers are restored, +* it is safe to handle interrupts. +*/ drv_data->suspended = false;/* Start the queue running */
@@ -1567,10 +1630,15 @@ static int pxa2xx_spi_resume(struct device *dev)if (status) { drv_data->suspended = true;pxa2xx_spi_clk_disable (drv_data); -return status; + goto out_put; } -return 0 ; +out_put: +/* Let runtime PM autosuspend again if needed */ +pm_runtime_mark_last_busy (dev); +pm_runtime_put_autosuspend (dev); + +return status; }static int pxa2xx_spi_runtime_suspend (struct device *dev)
drivers/spi/spi-pxa2xx.h +1 -0
@@ -71,6 +71,7 @@ struct driver_data {irqreturn_t (*transfer_handler)(struct driver_data *drv_data);void __iomem *lpss_base; +u32 lpss_priv_ctx[6 ];bool suspended;bool clk_enabled;
Signature · 1 line
2.39.5