学习 / TSENGCHEN BLOG

RK3576-Industrial-Bus-Driver-Course--03-Platform-Driver-From-Zero

01_Learning · 第 14 / 23 篇

第 3 章:从零写一个 Platform Driver

本章用一个教学控制器说明 platform driver 的完整结构,但源码严格按函数块讲解。真实 CAN、UART、DSMC 不需要你重造字符设备;本章只训练资源生命周期、中断与并发基本功。

1. DTS 是 probe 的输入

下面节点中的地址、IRQ、clock/reset ID 必须来自真实硬件。它不能直接复制到 RK3576:

lab_counter: counter@<base> {
	compatible = "acme,lab-counter";
	reg = <0x0 <base> 0x0 0x1000>;
	interrupts = <GIC_SPI <irq> IRQ_TYPE_LEVEL_HIGH>;
	clocks = <&cru <clock-id>>;
	clock-names = "bus";
	resets = <&cru <reset-id>>;
	reset-names = "core";
	status = "okay";
};

这个节点会让 platform core 依据 compatible 调用驱动的 probe。reg、interrupts、clocks、resets 与后续每一段资源获取一一对应;属性名不匹配时驱动必须失败,而不是静默继续。

2. 私有结构:先定义状态与所有权

struct lab_counter {
	struct device *dev;
	void __iomem *base;
	struct clk *clk;
	struct reset_control *rst;
	spinlock_t lock;
	wait_queue_head_t readq;
	u32 last_value;
	bool data_ready;
	struct miscdevice miscdev;
};

base 只保存被映射的 MMIO;last_value 与 data_ready 被 IRQ 和用户 read() 同时访问,因此需要 spinlock;readq 让无数据的进程睡眠;miscdev 只是教学接口。先定义谁拥有何种状态,才能正确选择锁和清理顺序。

3. 中断函数:只做最短路径

static irqreturn_t lab_counter_irq(int irq, void *arg)
{
	struct lab_counter *lc = arg;
	u32 status = readl(lc->base + LAB_INT_STATUS);
	unsigned long flags;

	if (!(status & LAB_INT_DATA))
		return IRQ_NONE;
	writel(status, lc->base + LAB_INT_STATUS);
	spin_lock_irqsave(&lc->lock, flags);
	lc->last_value = readl(lc->base + LAB_DATA);
	lc->data_ready = true;
	spin_unlock_irqrestore(&lc->lock, flags);
	wake_up_interruptible(&lc->readq);
	return IRQ_HANDLED;
}

IRQ 先确认来源;共享 IRQ 上不属于自己的事件必须返回 IRQ_NONE。再按 TRM 指定方式确认 pending 位,这里假设写一清,仅作为教学。中断上下文不能使用 mutex 或睡眠。保存最小数据后唤醒等待者;批量数据应使用 NAPI、DMA callback 或工作队列,而不是在这里循环拷贝。

4. 用户 read:与 IRQ 安全交接

static ssize_t lab_counter_read(struct file *file, char __user *buf,
				size_t count, loff_t *ppos)
{
	struct miscdevice *misc = file->private_data;
	struct lab_counter *lc = container_of(misc, struct lab_counter, miscdev);
	u32 value;
	unsigned long flags;

	if (count < sizeof(value))
		return -EINVAL;
	if (wait_event_interruptible(lc->readq, READ_ONCE(lc->data_ready)))
		return -ERESTARTSYS;
	spin_lock_irqsave(&lc->lock, flags);
	value = lc->last_value;
	lc->data_ready = false;
	spin_unlock_irqrestore(&lc->lock, flags);
	return copy_to_user(buf, &value, sizeof(value)) ? -EFAULT : sizeof(value);
}

等待队列条件必须能被 IRQ 更新并唤醒。取值和清标志必须在同一个临界区,否则第二个事件可能在错误时机覆盖状态。真实总线驱动还要决定队列深度、溢出策略和多进程语义;一个 bool 只适合教学的一项事件。

5. probe 第一段:内存、MMIO、clock

lc = devm_kzalloc(&pdev->dev, sizeof(*lc), GFP_KERNEL);
if (!lc)
	return -ENOMEM;
lc->base = devm_platform_ioremap_resource(pdev, 0);
if (IS_ERR(lc->base))
	return PTR_ERR(lc->base);
lc->clk = devm_clk_get(&pdev->dev, "bus");
if (IS_ERR(lc->clk))
	return PTR_ERR(lc->clk);
ret = clk_prepare_enable(lc->clk);
if (ret)
	return ret;

devm_ 负责内存与映射资源的释放,但 clk_prepare_enable() 是一个动作,仍必须在失败路径和 remove 中显式关闭。禁止在时钟未开时访问 base。

6. probe 第二段:reset、IRQ、接口注册

lc->rst = devm_reset_control_get_optional_exclusive(&pdev->dev, "core");
if (IS_ERR(lc->rst)) {
	ret = PTR_ERR(lc->rst);
	goto err_clock;
}
reset_control_reset(lc->rst);
spin_lock_init(&lc->lock);
init_waitqueue_head(&lc->readq);
ret = devm_request_irq(&pdev->dev, irq, lab_counter_irq, 0,
			       dev_name(&pdev->dev), lc);
if (ret)
	goto err_clock;

先获得并复位硬件,再初始化软件同步对象,最后申请 IRQ。只有在全部硬件和 IRQ 已准备好后才能注册面向用户的 misc 设备;否则用户可能在初始化未完成时打开设备。

7. 错误路径与 remove

err_clock:
	clk_disable_unprepare(lc->clk);
	return ret;

static int lab_counter_remove(struct platform_device *pdev)
{
	struct lab_counter *lc = platform_get_drvdata(pdev);

	writel(0, lc->base + LAB_INT_ENABLE);
	misc_deregister(&lc->miscdev);
	clk_disable_unprepare(lc->clk);
	return 0;
}

清理是取得资源的反向过程。真实驱动还必须停止 DMA、取消 work、禁用 NAPI 或 unregister netdevice。devm_request_irq()、devm_ioremap_resource() 和 devm_kzalloc() 随 device 释放,不应手工重复释放。

8. 匹配表与注册

static const struct of_device_id lab_counter_of_match[] = {
	{ .compatible = "acme,lab-counter" }, { }
};
MODULE_DEVICE_TABLE(of, lab_counter_of_match);

static struct platform_driver lab_counter_driver = {
	.probe = lab_counter_probe,
	.remove = lab_counter_remove,
	.driver = {
		.name = "lab-counter",
		.of_match_table = lab_counter_of_match,
	},
};
module_platform_driver(lab_counter_driver);

教学中应将此宏展开理解为注册 platform driver 和模块退出时注销。实际 SDK 驱动通常使用显式 struct platform_driver,例如 RK3576 CAN 的 rk3576_can_driver,便于挂载 PM 回调。

9. 把本章迁移到真实 SDK 驱动

拿 rk3576_can_probe() 或 rk_dsmc_probe(),逐段标注本章的对应关系:MMIO、clock/reset、DMA、IRQ、子系统注册、错误标签与 remove。完成这件事后,再去做 CAN 或 DSMC 的小功能改动;不要先从一个空白的千行驱动开始。

01_Learning · 文档目录
上一篇RK3576-Industrial-Bus-Driver-Course--02-Device-Tree-Deep-Dive下一篇RK3576-Industrial-Bus-Driver-Course--04-RK3576-CAN-Driver