drivers/spi/spi-rockchip.c
Source file repositories/reference/linux-study-clean/drivers/spi/spi-rockchip.c
File Facts
- System
- Linux kernel
- Corpus path
drivers/spi/spi-rockchip.c- Extension
.c- Size
- 27543 bytes
- Lines
- 1045
- Domain
- Driver Families
- Bucket
- drivers/spi
- Inferred role
- Driver Families: implementation source
- Status
- source implementation candidate
Why This File Exists
Repeatable hardware-adapter layer. Deep compatibility for every driver is out of scope; this atlas records patterns, probe lifecycles, bus glue, IRQ/DMA usage, and links back to core abstractions.
- Repeatable hardware-adapter layer. Deep compatibility for every driver is out of scope; this atlas records patterns, probe lifecycles, bus glue, IRQ/DMA usage, and links back to core abstractions.
- Uses kernel synchronization; read lock ordering, sleepability, and interrupt context assumptions before translating.
- Touches IRQ or DMA behavior; this matters for the representative real-device path.
- Defines or uses C structs; map object ownership, embedded links, reference counts, and lock ownership.
Dependency Surface
linux/clk.hlinux/dmaengine.hlinux/interrupt.hlinux/module.hlinux/of.hlinux/pinctrl/consumer.hlinux/platform_device.hlinux/spi/spi.hlinux/pm_runtime.hlinux/scatterlist.h
Detected Declarations
struct rockchip_spifunction spi_enable_chipfunction wait_for_tx_idlefunction get_fifo_lenfunction rockchip_spi_set_csfunction rockchip_spi_handle_errfunction rockchip_spi_pio_writerfunction rockchip_spi_pio_readerfunction rockchip_spi_isrfunction rockchip_spi_prepare_irqfunction rockchip_spi_dma_rxcbfunction rockchip_spi_dma_txcbfunction rockchip_spi_calc_burst_sizefunction rockchip_spi_prepare_dmafunction rockchip_spi_configfunction rockchip_spi_max_transfer_sizefunction rockchip_spi_target_abortfunction rockchip_spi_transfer_onefunction rockchip_spi_can_dmafunction rockchip_spi_setupfunction rockchip_spi_probefunction rockchip_spi_removefunction rockchip_spi_suspendfunction rockchip_spi_resumefunction rockchip_spi_runtime_suspendfunction rockchip_spi_runtime_resume
Annotated Snippet
struct rockchip_spi {
struct device *dev;
struct clk *spiclk;
struct clk *apb_pclk;
void __iomem *regs;
dma_addr_t dma_addr_rx;
dma_addr_t dma_addr_tx;
const void *tx;
void *rx;
unsigned int tx_left;
unsigned int rx_left;
atomic_t state;
/*depth of the FIFO buffer */
u32 fifo_len;
/* frequency of spiclk */
u32 freq;
u8 n_bytes;
u8 rsd;
bool target_abort;
bool cs_inactive; /* spi target transmission stop when cs inactive */
bool cs_high_supported; /* native CS supports active-high polarity */
struct spi_transfer *xfer; /* Store xfer temporarily */
};
static inline void spi_enable_chip(struct rockchip_spi *rs, bool enable)
{
writel_relaxed((enable ? 1U : 0U), rs->regs + ROCKCHIP_SPI_SSIENR);
}
static inline void wait_for_tx_idle(struct rockchip_spi *rs, bool target_mode)
{
unsigned long timeout = jiffies + msecs_to_jiffies(5);
do {
if (target_mode) {
if (!(readl_relaxed(rs->regs + ROCKCHIP_SPI_SR) & SR_TARGET_TX_BUSY) &&
!((readl_relaxed(rs->regs + ROCKCHIP_SPI_SR) & SR_BUSY)))
return;
} else {
if (!(readl_relaxed(rs->regs + ROCKCHIP_SPI_SR) & SR_BUSY))
return;
}
} while (!time_after(jiffies, timeout));
dev_warn(rs->dev, "spi controller is in busy state!\n");
}
static u32 get_fifo_len(struct rockchip_spi *rs)
{
u32 ver;
ver = readl_relaxed(rs->regs + ROCKCHIP_SPI_VERSION);
switch (ver) {
case ROCKCHIP_SPI_VER2_TYPE1:
case ROCKCHIP_SPI_VER2_TYPE2:
return 64;
default:
return 32;
}
}
static void rockchip_spi_set_cs(struct spi_device *spi, bool enable)
{
struct spi_controller *ctlr = spi->controller;
struct rockchip_spi *rs = spi_controller_get_devdata(ctlr);
bool cs_asserted = spi->mode & SPI_CS_HIGH ? enable : !enable;
bool cs_actual;
/*
* SPI subsystem tries to avoid no-op calls that would break the PM
* refcount below. It can't however for the first time it is used.
* To detect this case we read it here and bail out early for no-ops.
*/
if (spi_get_csgpiod(spi, 0))
cs_actual = !!(readl_relaxed(rs->regs + ROCKCHIP_SPI_SER) & 1);
else
cs_actual = !!(readl_relaxed(rs->regs + ROCKCHIP_SPI_SER) &
BIT(spi_get_chipselect(spi, 0)));
if (unlikely(cs_actual == cs_asserted))
return;
Annotation
- Immediate include surface: `linux/clk.h`, `linux/dmaengine.h`, `linux/interrupt.h`, `linux/module.h`, `linux/of.h`, `linux/pinctrl/consumer.h`, `linux/platform_device.h`, `linux/spi/spi.h`.
- Detected declarations: `struct rockchip_spi`, `function spi_enable_chip`, `function wait_for_tx_idle`, `function get_fifo_len`, `function rockchip_spi_set_cs`, `function rockchip_spi_handle_err`, `function rockchip_spi_pio_writer`, `function rockchip_spi_pio_reader`, `function rockchip_spi_isr`, `function rockchip_spi_prepare_irq`.
- Atlas domain: Driver Families / drivers/spi.
- Implementation status: source implementation candidate.
- Synchronization appears in or near this file; preserve lock ordering, sleepability, and interrupt-context constraints.
- IRQ or DMA behavior appears here, which is relevant to the selected PCIe/NVMe device path.
Implementation Notes
- This generated page is the file-by-file coverage layer; curated subsystem chapters should link here when they synthesize a multi-file control flow.
- Core OS pages should be promoted from atlas-only to deep-reviewed when they explain data structures, invariants, locking, lifecycle, and C implementation snippets.
- Driver-family pages are intentionally pattern-oriented unless they are part of the selected PCIe/NVMe representative device path.