drivers/i2c/busses/i2c-k1.c
Source file repositories/reference/linux-study-clean/drivers/i2c/busses/i2c-k1.c
File Facts
- System
- Linux kernel
- Corpus path
drivers/i2c/busses/i2c-k1.c- Extension
.c- Size
- 22139 bytes
- Lines
- 792
- Domain
- Driver Families
- Bucket
- drivers/i2c
- 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.
- Touches IRQ or DMA behavior; this matters for the representative real-device path.
- Allocates kernel memory; connect allocation flags and lifetime to context constraints.
- Defines or uses C structs; map object ownership, embedded links, reference counts, and lock ownership.
Dependency Surface
linux/bitfield.hlinux/clk.hlinux/i2c.hlinux/iopoll.hlinux/module.hlinux/of_address.hlinux/platform_device.hlinux/reset.h
Detected Declarations
struct spacemit_i2c_devenum spacemit_i2c_statefunction spacemit_i2c_enablefunction spacemit_i2c_disablefunction spacemit_i2c_resetfunction spacemit_i2c_handle_errfunction spacemit_i2c_delayfunction spacemit_i2c_conditionally_reset_busfunction spacemit_i2c_wait_bus_idlefunction spacemit_i2c_check_bus_releasefunction spacemit_i2c_clear_int_statusfunction spacemit_i2c_initfunction spacemit_i2c_startfunction spacemit_i2c_is_last_msgfunction spacemit_i2c_completefunction spacemit_i2c_handle_writefunction spacemit_i2c_handle_readfunction spacemit_i2c_handle_startfunction spacemit_i2c_err_checkfunction spacemit_i2c_handle_statefunction wait_for_completion_timeoutfunction spacemit_i2c_wait_xfer_completefunction spacemit_i2c_xfer_msgfunction spacemit_i2c_irq_handlerfunction spacemit_i2c_calc_timeoutfunction spacemit_i2c_xfer_commonfunction spacemit_i2c_xferfunction spacemit_i2c_pio_xfer_atomicfunction spacemit_i2c_funcfunction spacemit_i2c_probefunction spacemit_i2c_remove
Annotated Snippet
struct spacemit_i2c_dev {
struct device *dev;
struct i2c_adapter adapt;
/* hardware resources */
void __iomem *base;
int irq;
u32 clock_freq;
struct i2c_msg *msgs;
u32 msg_num;
/* index of the current message being processed */
u32 msg_idx;
u8 *msg_buf;
/* the number of unprocessed bytes remaining in the current message */
u32 unprocessed;
enum spacemit_i2c_state state;
bool read;
bool use_pio;
struct completion complete;
u32 status;
};
static void spacemit_i2c_enable(struct spacemit_i2c_dev *i2c)
{
u32 val;
val = readl(i2c->base + SPACEMIT_ICR);
val |= SPACEMIT_CR_IUE;
writel(val, i2c->base + SPACEMIT_ICR);
}
static void spacemit_i2c_disable(struct spacemit_i2c_dev *i2c)
{
u32 val;
val = readl(i2c->base + SPACEMIT_ICR);
val &= ~SPACEMIT_CR_IUE;
writel(val, i2c->base + SPACEMIT_ICR);
}
static void spacemit_i2c_reset(struct spacemit_i2c_dev *i2c)
{
writel(SPACEMIT_CR_UR, i2c->base + SPACEMIT_ICR);
udelay(5);
writel(0, i2c->base + SPACEMIT_ICR);
}
static int spacemit_i2c_handle_err(struct spacemit_i2c_dev *i2c)
{
dev_dbg(i2c->dev, "i2c error status: 0x%08x\n", i2c->status);
/* Arbitration Loss Detected */
if (i2c->status & SPACEMIT_SR_ALD) {
spacemit_i2c_reset(i2c);
return -EAGAIN;
}
/* Bus Error No ACK/NAK */
if (i2c->status & SPACEMIT_SR_BED)
spacemit_i2c_reset(i2c);
return i2c->status & SPACEMIT_SR_ACKNAK ? -ENXIO : -EIO;
}
static inline void spacemit_i2c_delay(struct spacemit_i2c_dev *i2c, unsigned int us)
{
if (i2c->use_pio)
udelay(us);
else
fsleep(us);
}
static void spacemit_i2c_conditionally_reset_bus(struct spacemit_i2c_dev *i2c)
{
u32 status;
u8 clk_cnt;
/* if bus is locked, reset unit. 0: locked */
status = readl(i2c->base + SPACEMIT_IBMR);
if ((status & SPACEMIT_BMR_SDA) && (status & SPACEMIT_BMR_SCL))
return;
spacemit_i2c_reset(i2c);
spacemit_i2c_delay(i2c, 10);
for (clk_cnt = 0; clk_cnt < SPACEMIT_BUS_RESET_CLK_CNT_MAX; clk_cnt++) {
Annotation
- Immediate include surface: `linux/bitfield.h`, `linux/clk.h`, `linux/i2c.h`, `linux/iopoll.h`, `linux/module.h`, `linux/of_address.h`, `linux/platform_device.h`, `linux/reset.h`.
- Detected declarations: `struct spacemit_i2c_dev`, `enum spacemit_i2c_state`, `function spacemit_i2c_enable`, `function spacemit_i2c_disable`, `function spacemit_i2c_reset`, `function spacemit_i2c_handle_err`, `function spacemit_i2c_delay`, `function spacemit_i2c_conditionally_reset_bus`, `function spacemit_i2c_wait_bus_idle`, `function spacemit_i2c_check_bus_release`.
- Atlas domain: Driver Families / drivers/i2c.
- Implementation status: source implementation candidate.
- 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.