drivers/spi/spi-rspi.c
Source file repositories/reference/linux-study-clean/drivers/spi/spi-rspi.c
File Facts
- System
- Linux kernel
- Corpus path
drivers/spi/spi-rspi.c- Extension
.c- Size
- 37221 bytes
- Lines
- 1417
- 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/module.hlinux/kernel.hlinux/sched.hlinux/errno.hlinux/interrupt.hlinux/platform_device.hlinux/io.hlinux/clk.hlinux/dmaengine.hlinux/dma-mapping.hlinux/of.hlinux/pm_runtime.hlinux/reset.hlinux/sh_dma.hlinux/spi/spi.hlinux/spinlock.h
Detected Declarations
struct rspi_datastruct spi_opsfunction rspi_write8function rspi_write16function rspi_write32function rspi_read8function rspi_read16function rspi_write_datafunction rspi_read_datafunction rspi_set_ratefunction rspi_set_config_registerfunction rspi_rz_set_config_registerfunction qspi_set_config_registerfunction qspi_updatefunction qspi_set_send_triggerfunction qspi_set_receive_triggerfunction rspi_enable_irqfunction rspi_disable_irqfunction rspi_wait_for_interruptfunction rspi_wait_for_tx_emptyfunction rspi_wait_for_rx_fullfunction rspi_data_outfunction rspi_data_infunction rspi_pio_transferfunction rspi_dma_completefunction rspi_dma_transferfunction rspi_receive_initfunction rspi_rz_receive_initfunction qspi_receive_initfunction __rspi_can_dmafunction rspi_can_dmafunction rspi_dma_check_then_transferfunction rspi_common_transferfunction rspi_transfer_onefunction rspi_rz_transfer_onefunction qspi_trigger_transfer_out_infunction qspi_transfer_out_infunction qspi_transfer_outfunction qspi_transfer_infunction qspi_transfer_onefunction qspi_transfer_modefunction qspi_setup_sequencerfunction list_for_each_entryfunction rspi_setupfunction rspi_prepare_messagefunction rspi_unprepare_messagefunction rspi_irq_muxfunction rspi_irq_rx
Annotated Snippet
struct rspi_data {
void __iomem *addr;
u32 speed_hz;
struct spi_controller *ctlr;
struct platform_device *pdev;
wait_queue_head_t wait;
spinlock_t lock; /* Protects RMW-access to RSPI_SSLP */
struct clk *clk;
u16 spcmd;
u8 spsr;
u8 sppcr;
int rx_irq, tx_irq;
const struct spi_ops *ops;
unsigned dma_callbacked:1;
unsigned byte_access:1;
};
static void rspi_write8(const struct rspi_data *rspi, u8 data, u16 offset)
{
iowrite8(data, rspi->addr + offset);
}
static void rspi_write16(const struct rspi_data *rspi, u16 data, u16 offset)
{
iowrite16(data, rspi->addr + offset);
}
static void rspi_write32(const struct rspi_data *rspi, u32 data, u16 offset)
{
iowrite32(data, rspi->addr + offset);
}
static u8 rspi_read8(const struct rspi_data *rspi, u16 offset)
{
return ioread8(rspi->addr + offset);
}
static u16 rspi_read16(const struct rspi_data *rspi, u16 offset)
{
return ioread16(rspi->addr + offset);
}
static void rspi_write_data(const struct rspi_data *rspi, u16 data)
{
if (rspi->byte_access)
rspi_write8(rspi, data, RSPI_SPDR);
else /* 16 bit */
rspi_write16(rspi, data, RSPI_SPDR);
}
static u16 rspi_read_data(const struct rspi_data *rspi)
{
if (rspi->byte_access)
return rspi_read8(rspi, RSPI_SPDR);
else /* 16 bit */
return rspi_read16(rspi, RSPI_SPDR);
}
/* optional functions */
struct spi_ops {
int (*set_config_register)(struct rspi_data *rspi, int access_size);
int (*transfer_one)(struct spi_controller *ctlr,
struct spi_device *spi, struct spi_transfer *xfer);
u16 extra_mode_bits;
u16 min_div;
u16 max_div;
u16 flags;
u16 fifo_size;
u8 num_hw_ss;
};
static void rspi_set_rate(struct rspi_data *rspi)
{
unsigned long clksrc;
int brdv = 0, spbr;
clksrc = clk_get_rate(rspi->clk);
spbr = DIV_ROUND_UP(clksrc, 2 * rspi->speed_hz) - 1;
while (spbr > 255 && brdv < 3) {
brdv++;
spbr = DIV_ROUND_UP(spbr + 1, 2) - 1;
}
rspi_write8(rspi, clamp(spbr, 0, 255), RSPI_SPBR);
rspi->spcmd |= SPCMD_BRDV(brdv);
rspi->speed_hz = DIV_ROUND_UP(clksrc, (2U << brdv) * (spbr + 1));
}
/*
Annotation
- Immediate include surface: `linux/module.h`, `linux/kernel.h`, `linux/sched.h`, `linux/errno.h`, `linux/interrupt.h`, `linux/platform_device.h`, `linux/io.h`, `linux/clk.h`.
- Detected declarations: `struct rspi_data`, `struct spi_ops`, `function rspi_write8`, `function rspi_write16`, `function rspi_write32`, `function rspi_read8`, `function rspi_read16`, `function rspi_write_data`, `function rspi_read_data`, `function rspi_set_rate`.
- 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.