深入解析Linux驱动开发中的dev_set_drvdata与dev_get_drvdata：从基础到实践

1. 理解dev_set_drvdata与dev_get_drvdata的基础概念在Linux内核驱动开发中每个设备都需要管理自己的私有数据。这就好比每个人都有自己的私人物品箱箱子里装着只有自己才知道如何使用的工具。dev_set_drvdata和dev_get_drvdata就是内核提供给我们的物品箱管理工具。这两个函数本质上是对struct device中driver_data成员的操作封装。driver_data是一个void*类型的指针可以指向任何类型的数据结构。想象一下这个指针就像是一个万能钥匙可以打开各种不同类型的锁数据结构。static inline void dev_set_drvdata(struct device *dev, void *data) { dev-driver_data data; } static inline void *dev_get_drvdata(const struct device *dev) { return dev-driver_data; }从代码可以看出dev_set_drvdata负责把数据指针保存到设备结构中而dev_get_drvdata则是把这个指针取出来。这种设计有三大优势类型安全虽然使用的是void*但我们可以通过强制类型转换来确保数据类型的正确性隔离性每个设备实例都有自己的私有数据互不干扰灵活性可以存储任意复杂的数据结构在实际开发中我们很少直接使用这两个基础函数而是使用针对特定设备类型的封装函数。比如对于平台设备我们会用platform_set_drvdata和platform_get_drvdata它们内部其实就是调用了基础函数。2. 设备私有数据的典型应用场景2.1 设备初始化阶段的数据管理在驱动的probe函数中我们通常需要为设备分配各种资源并初始化设备状态。这时候dev_set_drvdata就派上大用场了。来看一个实际的例子struct my_dev_data { int irq_num; void __iomem *reg_base; struct mutex lock; u32 config_flags; }; static int my_driver_probe(struct platform_device *pdev) { struct my_dev_data *data; data devm_kzalloc(pdev-dev, sizeof(*data), GFP_KERNEL); if (!data) return -ENOMEM; // 初始化各种资源 >static int my_driver_remove(struct platform_device *pdev) { struct my_dev_data *data platform_get_drvdata(pdev); // 释放中断 if (data-irq_num 0) devm_free_irq(pdev-dev,>static int my_driver_probe(struct platform_device *pdev) { struct my_dev_data *data; static int instance_count 0; data devm_kzalloc(pdev-dev, sizeof(*data), GFP_KERNEL); if (!data) return -ENOMEM; >static inline void platform_set_drvdata(struct platform_device *pdev, void *data) { dev_set_drvdata(pdev-dev, data); } static inline void *platform_get_drvdata(const struct platform_device *pdev) { return dev_get_drvdata(pdev-dev); }使用示例struct platform_data { u32 reg_val; bool enabled; }; static int platform_probe(struct platform_device *pdev) { struct platform_data *pdata; pdata devm_kzalloc(pdev-dev, sizeof(*pdata), GFP_KERNEL); if (!pdata) return -ENOMEM; pdata-reg_val 0x1234; pdata-enabled true; platform_set_drvdata(pdev, pdata); return 0; }3.2 I2C设备的封装I2C设备驱动也有自己的封装函数static inline void i2c_set_clientdata(struct i2c_client *client, void *data) { dev_set_drvdata(client-dev, data); } static inline void *i2c_get_clientdata(const struct i2c_client *client) { return dev_get_drvdata(client-dev); }使用示例struct i2c_sensor_data { struct i2c_client *client; int calibration; u8 config_reg; }; static int i2c_probe(struct i2c_client *client) { struct i2c_sensor_data *data; data devm_kzalloc(client-dev, sizeof(*data), GFP_KERNEL); if (!data) return -ENOMEM; >static inline void pci_set_drvdata(struct pci_dev *pdev, void *data) { dev_set_drvdata(pdev-dev, data); } static inline void *pci_get_drvdata(const struct pci_dev *pdev) { return dev_get_drvdata(pdev-dev); }使用示例struct pci_card_data { void __iomem *bar0; unsigned int flags; }; static int pci_probe(struct pci_dev *pdev, const struct pci_device_id *id) { struct pci_card_data *data; int ret; ret pci_enable_device(pdev); if (ret) return ret; data devm_kzalloc(pdev-dev, sizeof(*data), GFP_KERNEL); if (!data) return -ENOMEM; >struct device_hw { void __iomem *regs; int irq; spinlock_t reg_lock; }; struct device_stats { u64 read_count; u64 write_count; u64 error_count; }; struct device_priv { struct device_hw hw; struct device_stats stats; struct work_struct work; struct timer_list timer; atomic_t refcount; }; static int device_probe(struct platform_device *pdev) { struct device_priv *priv; priv devm_kzalloc(pdev-dev, sizeof(*priv), GFP_KERNEL); if (!priv) return -ENOMEM; // 初始化硬件部分 priv-hw.regs devm_platform_ioremap_resource(pdev, 0); spin_lock_init(priv-hw.reg_lock); // 初始化统计 memset(priv-stats, 0, sizeof(priv-stats)); // 初始化引用计数 atomic_set(priv-refcount, 1); platform_set_drvdata(pdev, priv); return 0; }4.2 线程安全与锁机制当驱动需要在中断上下文和进程上下文共享数据时必须考虑线程安全问题。常见的做法是对于频繁访问的简单变量使用原子操作对于复杂数据结构使用自旋锁或互斥锁对于读多写少的情况考虑读写锁示例struct safe_data { atomic_t counter; struct mutex config_lock; u32 config[10]; }; static int safe_probe(struct platform_device *pdev) { struct safe_data *data; int i; data devm_kzalloc(pdev-dev, sizeof(*data), GFP_KERNEL); if (!data) return -ENOMEM; atomic_set(data-counter, 0); mutex_init(data-config_lock); for (i 0; i 10; i) >static int mem_probe(struct platform_device *pdev) { struct resource *res; void __iomem *regs; dma_addr_t dma_handle; void *dma_buf; // 自动管理的IO内存映射 regs devm_platform_ioremap_resource(pdev, 0); if (IS_ERR(regs)) return PTR_ERR(regs); // 自动管理的DMA内存 dma_buf devm_kzalloc(pdev-dev, PAGE_SIZE, GFP_KERNEL | GFP_DMA); if (!dma_buf) return -ENOMEM; dma_handle dma_map_single(pdev-dev, dma_buf, PAGE_SIZE, DMA_BIDIRECTIONAL); // 手动管理的内存示例不推荐 res kzalloc(sizeof(*res), GFP_KERNEL); if (!res) return -ENOMEM; platform_set_drvdata(pdev, res); return 0; } static int mem_remove(struct platform_device *pdev) { struct resource *res platform_get_drvdata(pdev); // 需要手动释放手动分配的内存 kfree(res); return 0; }5. 常见问题与调试技巧5.1 为什么我的驱动在获取私有数据时崩溃这通常有几个可能的原因在设置数据前就尝试获取确保在probe函数中先设置数据再使用数据已被释放检查是否错误地释放了内存设备指针无效确认传入的dev指针是有效的调试方法void *data dev_get_drvdata(dev); if (!data) { dev_err(dev, Driver data is NULL!\n); return -EINVAL; } // 或者更详细的检查 if (WARN_ON(!data)) { dev_err(dev, Driver data is NULL at %s:%d\n, __func__, __LINE__); dump_stack(); return -EINVAL; }5.2 如何调试私有数据被意外修改的问题这类问题通常很难调试可以采用以下方法添加魔术字在数据结构开始处添加特殊标识使用内存屏障确保多核访问的正确性启用内存调试工具如KASAN示例struct debug_data { #define MAGIC_NUMBER 0xDEADBEEF u32 magic; // 实际数据... }; static int debug_probe(struct platform_device *pdev) { struct debug_data *data; data devm_kzalloc(pdev-dev, sizeof(*data), GFP_KERNEL); if (!data) return -ENOMEM; >struct multi_dev { int instance_id; struct list_head list; // 其他实例特定数据... }; static DEFINE_MUTEX(dev_list_lock); static LIST_HEAD(dev_list); static int multi_probe(struct platform_device *pdev) { struct multi_dev *dev; static int next_id 0; dev devm_kzalloc(pdev-dev, sizeof(*dev), GFP_KERNEL); if (!dev) return -ENOMEM; mutex_lock(dev_list_lock); dev-instance_id next_id; list_add_tail(dev-list, dev_list); mutex_unlock(dev_list_lock); platform_set_drvdata(pdev, dev); return 0; } static int multi_remove(struct platform_device *pdev) { struct multi_dev *dev platform_get_drvdata(pdev); mutex_lock(dev_list_lock); list_del(dev-list); mutex_unlock(dev_list_lock); return 0; }在实际项目中我曾经遇到过因为忘记加锁而导致设备列表损坏的问题。后来通过添加严格的锁检查和调试代码最终定位并解决了问题。这也让我意识到在多设备环境下数据隔离和同步机制的重要性怎么强调都不为过。