夜雨聆风还在为EEPROM驱动移植烦恼？这套AT24CXX驱动代码，让你的存储管理变得如此优雅！
在嵌入式开发中，配置参数的存储、日志数据的保存、用户设置的记忆，都离不开EEPROM。而AT24CXX系列作为最常用的I2C接口EEPROM，几乎出现在每一个嵌入式项目中。然而，有多少工程师还在为每次换平台就要重写一遍EEPROM驱动而苦恼？有多少项目因为EEPROM驱动的不稳定导致数据丢失？今天，我们来深度解析一套高可移植的AT24CXX驱动源码，这套代码来自小编开发的驱动代码版本1.4.0，结构清晰、嵌入式存储驱动。
一、驱动整体架构：分层设计的智慧
一套优秀的驱动代码，首先要有清晰的架构。这套AT24CXX驱动采用了经典的分层设计：
驱动分为两个核心文件：
at24cxx.h：接口定义、宏、枚举、句柄结构体at24cxx.c：驱动实现，包括初始化、读写、页处理等功能
这种分离设计让接口与实现解耦，上层应用只需关心at24cxx.h中定义的接口，底层硬件变化不会影响上层代码。
二、核心数据类型：严谨的枚举定义
代码从严谨的类型定义开始。这套驱动定义了完整的枚举类型，确保了代码的健壮性：
/*** @brief at24cxx 状态枚举定义*/typedef enum{AT24CXX_STATUS_OK = 0, /**< 成功 */AT24CXX_STATUS_ERROR = 1, /**< 错误 */AT24CXX_STATUS_INVALID = 2, /**< 无效句柄 */AT24CXX_STATUS_UNINIT = 3, /**< 句柄未初始化 */AT24CXX_STATUS_OUT_OF_RANGE = 4, /**< 地址超出范围 */}at24cxx_status_e;/*** @brief at24cxx 类型枚举定义*/typedef enum{AT24C01 = 128, // AT24C01芯片128字节容量AT24C02 = 256, // AT24C02芯片256字节容量AT24C04 = 512, // AT24C04芯片512字节容量AT24C08 = 1024, // AT24C08芯片1024字节容量AT24C16 = 2048, // AT24C16芯片2048字节容量AT24C32 = 4096, // AT24C32芯片4096字节容量AT24C64 = 8192, // AT24C64芯片8192字节容量AT24C128 = 16384, // AT24C128芯片16384字节容量AT24C256 = 32768, // AT24C256芯片32768字节容量AT24C512 = 65536, // AT24C512芯片65536字节容量AT24CM01 = 131072, // AT24CM01芯片131072字节容量AT24CM02 = 262144, // AT24CM02芯片262144字节容量} at24cxx_type_e;/*** @brief at24cxx 引脚地址枚举定义*/typedef enum{AT24CXX_ADDRESS_A000 = 0, // A2A1A0 000AT24CXX_ADDRESS_A001 = 1, // A2A1A0 001AT24CXX_ADDRESS_A010 = 2, // A2A1A0 010AT24CXX_ADDRESS_A011 = 3, // A2A1A0 011AT24CXX_ADDRESS_A100 = 4, // A2A1A0 100AT24CXX_ADDRESS_A101 = 5, // A2A1A0 101AT24CXX_ADDRESS_A110 = 6, // A2A1A0 110AT24CXX_ADDRESS_A111 = 7, // A2A1A0 111} at24cxx_address_e;
这样的枚举定义有三大好处：
提高代码可读性：
AT24CXX_STATUS_OK比数字0更有意义防止魔法数字：避免在代码中直接使用0、1、2等难以理解的数字
编译器检查：枚举类型可以在编译时发现类型错误
三、句柄结构体：面向对象思想
这是整套驱动的核心设计亮点！通过函数指针实现硬件抽象，让驱动与硬件完全解耦：
typedef struct at24cxx_handle_s{uint8_t iic_addr; // 设备的iic地址uint8_t (*iic_init)(void); // 指向iic初始化函数地址的指针uint8_t (*iic_deinit)(void); // 指向iic去初始化函数地址的指针uint8_t (*iic_read)(uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len); // 指向iic读取函数地址的指针uint8_t (*iic_write)(uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len); // 指向iic写入函数地址的指针uint8_t (*iic_read_address16)(uint8_t addr, uint16_t reg, uint8_t *buf, uint16_t len); // 指向iic读取16位地址函数地址的指针uint8_t (*iic_write_address16)(uint8_t addr, uint16_t reg, uint8_t *buf, uint16_t len); // 指向iic写入16位地址函数地址的指针void (*delay_ms)(uint32_t ms); // 指向延时函数地址的指针void (*debug_print)(const char *const fmt, ...); // 指向debug_print函数地址的指针uint32_t id; // 芯片iduint8_t inited; // 初始化标志位} at24cxx_handle_t;
设计思想解析：
函数指针封装硬件操作：驱动不直接操作硬件寄存器，而是通过函数指针调用
平台无关性：只需实现这些函数指针指向的具体函数，即可移植到任何平台
运行时绑定：函数指针在初始化时绑定，支持动态切换硬件
四、连接宏模块：优雅的硬件绑定机制
如何将用户的具体硬件函数绑定到驱动？ 这套代码提供了一组优雅的宏：
/*** @brief 初始化芯片结构体* @param[in] HANDLE at24cxx句柄结构的指针* @param[in] STRUCTURE at24cxx_handle_t* @note none*/#define AT24CXX_LINK_INIT(HANDLE, STRUCTURE) do{memset(HANDLE, 0, sizeof(STRUCTURE));}while(0)/*** @brief 连接debug_print函数* @param[in] HANDLE at24cxx句柄结构的指针* @param[in] FUC 指向debug_print函数地址的指针* @note none*/#define AT24CXX_LINK_DEBUG_PRINT(HANDLE, FUC) do{(HANDLE)->debug_print = FUC;}while(0)/*** @brief 连接iic_init函数* @param[in] HANDLE at24cxx句柄结构的指针* @param[in] FUC 指向iic_init函数地址的指针* @note none*/#define AT24CXX_LINK_IIC_INIT(HANDLE, FUC) do{(HANDLE)->iic_init = FUC;}while(0)/*** @brief 连接iic_deinit函数* @param[in] HANDLE at24cxx句柄结构的指针* @param[in] FUC 指向iic_deinit函数地址的指针* @note none*/#define AT24CXX_LINK_IIC_DEINIT(HANDLE, FUC) do{(HANDLE)->iic_deinit = FUC;}while(0)/*** @brief 连接iic_read函数* @param[in] HANDLE at24cxx句柄结构的指针* @param[in] FUC 指向iic_read函数地址的指针* @note none*/#define AT24CXX_LINK_IIC_READ(HANDLE, FUC) do{(HANDLE)->iic_read = FUC;}while(0)/*** @brief 连接iic_write函数* @param[in] HANDLE at24cxx句柄结构的指针* @param[in] FUC 指向iic_write函数地址的指针* @note none*/#define AT24CXX_LINK_IIC_WRITE(HANDLE, FUC) do{(HANDLE)->iic_write = FUC;}while(0)/*** @brief 连接iic_read_address16函数* @param[in] HANDLE at24cxx句柄结构的指针* @param[in] FUC 指向iic_read_address16函数地址的指针* @note none*/#define AT24CXX_LINK_IIC_READ_ADDRESS16(HANDLE, FUC) do{(HANDLE)->iic_read_address16 = FUC;}while(0)/*** @brief 连接iic_write_address16函数* @param[in] HANDLE at24cxx句柄结构的指针* @param[in] FUC 指向iic_write_address16函数地址的指针* @note none*/#define AT24CXX_LINK_IIC_WRITE_ADDRESS16(HANDLE, FUC) do{(HANDLE)->iic_write_address16 = FUC;}while(0)/*** @brief 连接delay_ms函数* @param[in] HANDLE at24cxx句柄结构的指针* @param[in] FUC 指向delay_ms函数地址的指针* @note none*/#define AT24CXX_LINK_DELAY_MS(HANDLE, FUC) do{(HANDLE)->delay_ms = FUC;}while(0)
/* 用户实现的硬件函数 */static at24cxx_status_e iic_init(void) {// 具体的I2C初始化代码return AT24CXX_STATUS_OK;}static at24cxx_status_e iic_read(uint8_t addr, uint8_t *buf, uint16_t len) {// 具体的I2C读取代码return AT24CXX_STATUS_OK;}void at24cxx_init(void){at24cxx_status_e enAt24cxxStatus;AT24CXX_LINK_INIT(&s_stAt24cxxHandle, at24cxx_handle_t); // 初始化句柄结构体AT24CXX_LINK_IIC_INIT(&s_stAt24cxxHandle, i2c_init); // 连接iic_init函数AT24CXX_LINK_IIC_DEINIT(&s_stAt24cxxHandle, i2c_deinit); // 连接iic_deinit函数AT24CXX_LINK_IIC_READ_ADDRESS16(&s_stAt24cxxHandle, i2c_read_address16); // 连接iic_read_address16函数AT24CXX_LINK_IIC_WRITE_ADDRESS16(&s_stAt24cxxHandle, i2c_write_address16); // 连接iic_write_address16函数AT24CXX_LINK_DELAY_MS(&s_stAt24cxxHandle, delay_ms); // 连接delay_ms函数AT24CXX_LINK_DEBUG_PRINT(&s_stAt24cxxHandle, usart_printf); // 连接debug_print函数enAt24cxxStatus = enAt24cxx_set_type(&s_stAt24cxxHandle, AT24C512); // 设置芯片类型if (enAt24cxxStatus != AT24CXX_STATUS_OK) // 检查设置芯片类型状态{usart_printf("at24cxx: set type failed.\n"); // 设置芯片类型失败return; // 返回}enAt24cxxStatus = enAt24cxx_set_addr_pin(&s_stAt24cxxHandle, AT24CXX_ADDRESS_A000); // 设置芯片地址引脚if (enAt24cxxStatus != AT24CXX_STATUS_OK) // 检查设置芯片地址引脚状态{usart_printf("at24cxx: set addr pin failed.\n"); // 设置芯片地址引脚失败return; // 返回}enAt24cxxStatus = enAt24cxx_init(&s_stAt24cxxHandle); // 初始化芯片if (enAt24cxxStatus != AT24CXX_STATUS_OK) // 检查初始化状态{usart_printf("at24cxx: init failed.\n"); // 初始化失败return; // 返回}}void at24cxx_deinit(void){at24cxx_status_e enAt24cxxStatus;enAt24cxxStatus = enAt24cxx_deinit(&s_stAt24cxxHandle); // 去初始化芯片if (enAt24cxxStatus != AT24CXX_STATUS_OK) // 检查去初始化状态{usart_printf("at24cxx: deinit failed.\n"); // 去初始化失败return; // 返回}}
五、初始化流程：严谨的启动检查
优秀的驱动必须有严谨的初始化检查，防止未初始化就使用：
at24cxx_status_e enAt24cxx_init(at24cxx_handle_t *handle){if (handle == NULL) // 检查句柄{return AT24CXX_STATUS_INVALID; // 返回句柄为空错误}if (handle->debug_print == NULL) // 检查 debug_print{return AT24CXX_STATUS_ERROR; // 返回错误}if (handle->iic_init == NULL) // 检查 iic_init{handle->debug_print("at24cxx: iic_init is null.\n"); // iic_init is nullreturn AT24CXX_STATUS_ERROR; // 返回错误}if (handle->iic_deinit == NULL) // 检查 iic_deinit{handle->debug_print("at24cxx: iic_deinit is null.\n"); // iic_deinit is nullreturn AT24CXX_STATUS_ERROR; // 返回错误}if (handle->iic_read == NULL && handle->iic_read_address16 == NULL) // 检查 iic_read{handle->debug_print("at24cxx: iic_read is null.\n"); // iic_read is nullreturn AT24CXX_STATUS_ERROR; // 返回错误}if (handle->iic_write == NULL && handle->iic_write_address16 == NULL) // 检查 iic_write{handle->debug_print("at24cxx: iic_write is null.\n"); // iic_write is nullreturn AT24CXX_STATUS_ERROR; // 返回错误}if (handle->delay_ms == NULL) // 检查 delay_ms{handle->debug_print("at24cxx: delay_ms is null.\n"); // delay_ms is nullreturn AT24CXX_STATUS_ERROR; // 返回错误}if (handle->iic_init() != 0) // iic初始化{handle->debug_print("at24cxx: iic init failed.\n"); // iic初始化失败return AT24CXX_STATUS_ERROR; // 返回错误}handle->inited = 1; // 标记初始化完成return AT24CXX_STATUS_OK; // 成功返回成功}
关键点分析：
NULL指针检查：防止空指针导致的崩溃
函数指针检查：确保所有必要的硬件函数都已绑定
硬件初始化反馈：检查硬件初始化是否成功
状态标志设置：明确标识驱动已初始化完成
六、芯片配置：灵活的设备管理
一套驱动支持全系列芯片，这是如何实现的？
at24cxx_status_e enAt24cxx_set_type(at24cxx_handle_t *handle, at24cxx_type_e type){if (handle == NULL) // 检查句柄{return AT24CXX_STATUS_INVALID; // 返回句柄为空错误}if(type < AT24C01 || type > AT24CM02) // 检查类型是否在有效范围内{return AT24CXX_STATUS_OUT_OF_RANGE; // 返回类型超出范围错误}handle->id = (uint32_t)type; // 设置idif(handle->id > (uint32_t)AT24C16){if(handle->iic_write_address16 == NULL || handle->iic_read_address16 == NULL) // 检查 iic_write_address16{handle->debug_print("at24cxx: iic_write_address16 is null.\n"); // iic_write_address16 is nullreturn AT24CXX_STATUS_ERROR; // 返回错误}}else{if(handle->iic_write == NULL || handle->iic_read == NULL) // 检查 iic_write{handle->debug_print("at24cxx: iic_write is null.\n"); // iic_write is nullreturn AT24CXX_STATUS_ERROR; // 返回错误}}return AT24CXX_STATUS_OK; // 成功返回成功}at24cxx_status_e enAt24cxx_set_addr_pin(at24cxx_handle_t *handle, at24cxx_address_e addr_pin){if (handle == NULL) // 检查句柄{return AT24CXX_STATUS_INVALID; // 返回句柄为空错误}handle->iic_addr = 0xA0; // 设置iic地址handle->iic_addr |= addr_pin << 1; // 设置iic地址引脚地址部分return AT24CXX_STATUS_OK; // 成功返回成功}
七、页大小与写入周期：EEPROM的关键特性
理解EEPROM的页特性是正确使用的关键：
staticuint16_tu16At24cxx_get_page_size(at24cxx_type_e enAt24cxxType){uint16_t page_size;switch (enAt24cxxType){case AT24C01:case AT24C02:page_size = 8; // 设置页大小8break; // 跳出循环case AT24C04:case AT24C08:case AT24C16:page_size = 16; // 设置页大小16break; // 跳出循环case AT24C32:case AT24C64:page_size = 32; // 设置页大小32break; // 跳出循环case AT24C128:case AT24C256:page_size = 64; // 设置页大小64break; // 跳出循环case AT24C512:page_size = 128; // 设置页大小128break; // 跳出循环case AT24CM01:case AT24CM02:page_size = 256; // 设置页大小256break; // 跳出循环default:page_size = 8; // 设置默认页大小8break; // 跳出循环}return page_size; // 返回页大小}/*** @brief 获取芯片的写入周期时间* @param[in] enAt24cxxType 芯片类型* @return uint8_t 写入周期时间(ms)* @note none*/staticuint8_tu8At24cxx_get_write_cycle_time(at24cxx_type_e enAt24cxxType){uint8_t write_cycle_time;switch (enAt24cxxType){case AT24C01:case AT24C02:case AT24C04:case AT24C08:case AT24C16:case AT24C32:case AT24C64:case AT24C128:case AT24C256:case AT24C512:case AT24CM01:write_cycle_time = 5; // 该芯片的写入周期时间为5msbreak; // 跳出循环case AT24CM02:write_cycle_time = 10; // 该芯片的写入周期时间为10msbreak; // 跳出循环default:write_cycle_time = 10; // 设置默认写入周期时间为10msbreak; // 跳出循环}return write_cycle_time; // 返回写入周期时间}
八、读操作实现：智能的地址处理
读操作的实现充分考虑了不同容量芯片的差异：
at24cxx_status_e enAt24cxx_read(at24cxx_handle_t *handle, uint32_t address, uint8_t *buf, uint16_t len){uint8_t page_remain;if (handle == NULL) // 检查句柄{return AT24CXX_STATUS_INVALID; // 返回句柄没有初始化错误}if (handle->inited != 1) // 检查句柄是否初始化{return AT24CXX_STATUS_UNINIT; // 返回没初始化错误}if ((address + len) > handle->id) // 检查地址和长度是否超出芯片范围{handle->debug_print("at24cxx: read out of range.\n"); // 读取超出范围return AT24CXX_STATUS_OUT_OF_RANGE; // 返回错误}uint16_t page_size = u16At24cxx_get_page_size((at24cxx_type_e)handle->id); // 获取页大小page_remain = (uint8_t)(page_size - address % page_size); // 获取页剩余长度if (len <= page_remain) // 页剩余长度{page_remain = (uint8_t)len; // 设置页剩余长度}if (handle->id > (uint32_t)AT24C16) // 选择ID以设置不同的地址{while (1){if (handle->iic_read_address16((uint8_t)(handle->iic_addr + ((address / 65536) << 1)),address % 65536, buf,page_remain) != 0) // 读取页{handle->debug_print("at24cxx: read failed.\n"); // 读取失败return AT24CXX_STATUS_ERROR; // 返回错误}if (page_remain == len) // 检查是否读取完成{break; // 跳出循环}else{address += page_remain; // 地址增加buf += page_remain; // 缓冲区指针增加len -= page_remain; // 长度减少if (len < page_size) // 检查剩余长度{page_remain = (uint8_t)len; // 设置剩余长度}else{page_remain = page_size; // 设置页大小}}}}else{while (1){if (handle->iic_read((uint8_t)(handle->iic_addr + ((address / 256) << 1)), address % 256, buf,page_remain) != 0) // 读取页{handle->debug_print("at24cxx: read failed.\n"); // 读取失败return AT24CXX_STATUS_ERROR; // 返回错误}if (page_remain == len) // 检查是否读取完成{break; // 跳出循环}else{address += page_remain; // 地址增加buf += page_remain; // 缓冲区指针增加len -= page_remain; // 长度减少if (len < page_size) // 检查剩余长度{page_remain = (uint8_t)len; // 设置剩余长度}else{page_remain = page_size; // 设置页大小}}}}return AT24CXX_STATUS_OK; // 成功返回成功}
九、写操作实现：安全的写入保护
写操作比读操作复杂得多，必须考虑页边界和写入周期：
at24cxx_status_e enAt24cxx_write(at24cxx_handle_t *handle, uint32_t address, uint8_t *buf, uint16_t len){uint8_t page_remain;if (handle == NULL) // 检查句柄{return AT24CXX_STATUS_INVALID; // 返回句柄没有初始化错误}if (handle->inited != 1) // 检查句柄初始化{return AT24CXX_STATUS_UNINIT; // 返回错误}if ((address + len) > handle->id) // 检查长度{handle->debug_print("at24cxx: write out of range.\n"); // 写入超出范围return AT24CXX_STATUS_OUT_OF_RANGE; // 返回地址越界错误}uint16_t page_size = u16At24cxx_get_page_size((at24cxx_type_e)handle->id); // 获取芯片页大小page_remain = (uint8_t)(page_size - address % page_size); // 获取当前页剩余空间uint8_t write_cycle_time = u8At24cxx_get_write_cycle_time((at24cxx_type_e)handle->id); // 获取芯片写入周期时间if (len <= page_remain) // 检查长度是否小于等于当前页剩余空间{page_remain = (uint8_t)len; // 设置当前页剩余空间}if (handle->id > (uint32_t)AT24C16) // 检查芯片IDs是否大于AT24C16以选择不同的地址方式{while (1){if (handle->iic_write_address16((uint8_t)(handle->iic_addr + ((address / 65536) << 1)),address % 65536, buf,page_remain) != 0) // 写入当前页数据{handle->debug_print("at24cxx: write failed.\n"); // 写入失败return AT24CXX_STATUS_ERROR; // 返回错误}handle->delay_ms(write_cycle_time); // 等待写入周期时间if (page_remain == len) // 检查是否完成{break; // 完成则跳出循环}else{address += page_remain; // 地址增加buf += page_remain; // 缓冲区指针增加len -= page_remain; // 长度减少if (len < page_size) // 检查长度是否小于当前页大小{page_remain = (uint8_t)len; // 写入剩余长度}else{page_remain = page_size; // 写入页大小长度}}}}else{while (1){if (handle->iic_write((uint8_t)(handle->iic_addr + ((address / 256) << 1)), address % 256, buf,page_remain) != 0) // 写入页数据{handle->debug_print("at24cxx: write failed.\n"); // 写入失败return AT24CXX_STATUS_ERROR; // 返回错误}handle->delay_ms(write_cycle_time); // 等待写入周期时间if (page_remain == len) // 检查是否完成{break; // 完成则跳出循环}else{address += page_remain; // 地址增加buf += page_remain; // 缓冲区指针增加len -= page_remain; // 长度减少if (len < page_size) // 检查长度是否小于当前页大小{page_remain = (uint8_t)len; // 写入剩余长度}else{page_remain = page_size; // 写入页大小长度}}}}return AT24CXX_STATUS_OK; // 成功返回成功}
写入操作的关键注意事项：
页边界处理：自动检测并处理跨页写入
写入周期等待：每次写入后必须等待指定的时间
错误处理：每一步都有错误检查，确保数据完整性
讨论： 您在24cxx EEPROM中遇到过哪些难题？结果如何？欢迎在下方留言分享您的实际经验！觉得这篇EEPROM驱动有帮助？ 点赞👍、转发给需要的同事、收藏📁备用，留言支持一下吧！可以给小编私信，发送完整的驱动代码和实例教程也欢迎各位指正驱动问题。（已经测试ATC02和ATC512,目前手上只有这两个芯片）
原创声明： 本文由【嵌入式小金】技术原创发布，欢迎分享。如需转载，请联系授权。
作者/编辑： 小金
