核心内容摘要
【ROS/ROS2与实时Linux系列】第二十八篇 ROS 2 `launch`系统：实时任务启动编排
嵌入式Linux驱动套装含实战项目!大家好我是杂烩君。
在嵌入式项目中经常遇到这样的场景现场设备返回错误码-5对着日志一脸茫然——究竟是哪个模块出错是硬件故障还是参数非法翻代码查半天定义耽误定位时间。
更糟的情况是不同模块用了相同错误码表示不同含义跨模块调用时问题更难排查。
本文
总结嵌入式错误码设计的实用方法什么场景选什么方案、如何避免常见陷阱、错误码模块如何设计。
错误码方案选择错误码方案得看项目实际情况
项目规模与模块数量小型项目单MCU裸机、单驱动模块模块少、异常简单没必要搞复杂设计。
中大型项目多模块协同、嵌入式Linux、跨团队开发如果还用简单方案后面维护就是灾难。
运行平台特性裸机MCU没有系统标准错误码错误定义完全自己说了算关键是把硬件异常和逻辑异常都覆盖到。
嵌入式Linux或RTOS环境有系统自带的errno自定义错误码就得考虑兼容性别和系统码冲突。
异常类型复杂度简单场景参数校验、空指针、内存不足这种纯软件逻辑错误基础设计就够用。
复杂场景涉及SPI/CAN总线、Flash擦写、DMA传输这些硬件外设异常就需要细化错误信息不然现场定位问题根本摸不着头脑。
系统集成需求如果错误码只在设备内部用规则可以灵活点团队商量着来就行。
但要是跨设备传递、上报服务器、不同版本要兼容那就必须标准化设计不能随意改码值和含义。
三种方案方案一极简整型错误码这种方案最简单粗暴适合裸机小驱动、单功能模块这类异常类型少于10种的场景。
早期写单片机驱动时经常这么用见效快。
设计时遵循一个约定成功固定为0负数表示致命错误硬件故障、参数非法正数表示警告非致命可重试。
这样if(ret
就能快速判断是否出错。
下面是模块化的代码实现/** * file error_simple.h */#ifndefERROR_SIMPLE_H#defineERROR_SIMPLE_H#includestdint.h/* 全局通用错误码 */#defineERR_OK0/* 成功 */#defineERR_PARAM-1/* 参数非法 */#defineERR_TIMEOUT-2/* 超时 */#defineERR_HW_FAIL-3/* 硬件故障 */#defineWARN_BUSY1/* 设备忙非致命 *//* 获取错误描述字符串 */constchar*err_get_string(interr_code);#endif/* ERROR_SIMPLE_H *//** * file error_simple.c * brief 错误码解析实现 */#includeerror_simple.hconstchar*err_get_string(interr_code){switch(err_code){caseERR_OK:returnSuccess;caseERR_PARAM:returnInvalid parameter;caseERR_TIMEOUT:returnOperation timeout;caseERR_HW_FAIL:returnHardware failure;caseWARN_BUSY:returnDevice busy;default:returnUnknown error;}}方案二枚举型错误码中大型裸机或RTOS项目中模块多了之后用整型错误码就力不从心了。
枚举型方案能很好地解决这个问题异常类型在10~50种之间时特别合适。
这种方案有几个关键点使用枚举类型编译器能做类型检查防止低级错误每个模块独立定义枚举统一前缀比如GPIO_ERR_、SPI_ERR_提前规划码段GPIO占100199SPI占200299彻底避免冲突。
看看具体怎么写/** * file error_common.h * brief 通用错误码基础定义所有模块共享 */#ifndefERROR_COMMON_H#defineERROR_COMMON_H#includestdint.h/* 全局通用错误基类 */typedefenum{ERR_OK0,/* 全局成功标志 */ERR_PARAM1,/* 参数错误 */ERR_MEMORY2,/* 内存不足 */ERR_TIMEOUT3,/* 超时 */ERR_UNKNOWN0xFF/* 未知错误 */}err_base_t;/* 错误码转字符串回调函数类型 */typedefconstchar*(*err_to_string_fn)(interr_code);/* 注册错误码解析器 */voiderr_register_parser(uint8_tmodule_id,err_to_string_fn parser);/* 统一错误码解析入口 */constchar*err_parse(uint8_tmodule_id,interr_code);#endif/* ERROR_COMMON_H *//** * file error_common.c * brief 通用错误码解析实现 */#includeerror_common.h#includestddef.h#defineMAX_MODULES16staticstruct{uint8_tmodule_id;err_to_string_fn parser;}parser_table[MAX_MODULES];staticintparser_count0;voiderr_register_parser(uint8_tmodule_id,err_to_string_fn parser){if(parser_countMAX_MODULES||parserNULL){return;}parser_table[parser_count].module_idmodule_id;parser_table[parser_count].parserparser;parser_count;}constchar*err_parse(uint8_tmodule_id,interr_code){for(inti0;iparser_count;i){if(parser_table[i].module_idmodule_id){returnparser_table[i].parser(err_code);}}returnModule parser not found;}/** * file error_gpio.h * brief GPIO模块错误码定义 */#ifndefERROR_GPIO_H#defineERROR_GPIO_H#includeerror_common.h/* GPIO模块错误码段100~199 */typedefenum{GPIO_ERR_OKERR_OK,GPIO_ERR_PIN100,GPIO_ERR_MODE101,GPIO_ERR_HW102,GPIO_ERR_BUSY103}gpio_err_t;constchar*gpio_err_to_string(interr_code);gpio_err_tgpio_init(uint8_tpin,uint8_tmode);#endif/* ERROR_GPIO_H *//** * file error_gpio.c * brief GPIO模块错误处理实现 */#includeerror_gpio.h#includestddef.h#defineGPIO_MAX_PIN31constchar*gpio_err_to_string(interr_code){switch((gpio_err_t)err_code){caseGPIO_ERR_OK:returnGPIO success;caseGPIO_ERR_PIN:returnGPIO pin number invalid;caseGPIO_ERR_MODE:returnGPIO mode invalid;caseGPIO_ERR_HW:returnGPIO hardware init failed;caseGPIO_ERR_BUSY:returnGPIO pin is busy;default:returnGPIO unknown error;}}使用示例#includeerror_common.h#includeerror_gpio.h#includestdio.h#defineMODULE_ID_GPIO1intmain(void){/* 初始化时注册各模块的错误码解析器 */err_register_parser(MODULE_ID_GPIO,gpio_err_to_string);if(ret!GPIO_ERR_OK){printf(Error: %s\n,err_parse(MODULE_ID_GPIO,ret));}return0;}方案三结构化错误码遇到多MCU协同、Linux驱动加应用层、模块很多、或者需要把错误码上报云端的场景前面两种方案就不够用了。
结构化错误码通过32位整型拆分字段用位运算解析能精确表达错误的来源和细节。
字段划分是这样的用32位整型高8位存模块ID区分GPIO、SPI、CAN等中8位存主错误类型参数错误、硬件错误、总线错误等低16位存子错误细节比如SPI总线忙、CRC校验失败等具体原因。
|-----8bit-----|-----8bit-----|--------16bit--------| | 模块ID | 主错误码 | 子错误码 | | (MODULE_ID) | (MAIN_ERR) | (SUB_ERR) |模块化代码实现/** * file error_struct.h * brief 结构化错误码定义适用于大型系统 */#ifndefERROR_STRUCT_H#defineERROR_STRUCT_H#includestdint.h/* 错误码类型定义 */typedefuint32_terr_code_t;/* 字段位掩码定义 */#defineERR_MODULE_MASK0xFF000000U/* 高8位模块ID */#defineERR_MAIN_MASK0x00FF0000U/* 中8位主错误码 */#defineERR_SUB_MASK0x0000FFFFU/* 低16位子错误码 *//* 位移偏移量 */#defineERR_MODULE_SHIFT24#defineERR_MAIN_SHIFT16#defineERR_SUB_SHIFT0/* 模块ID枚举 */typedefenum{MODULE_SYSTEM0x00,/* 系统模块 */MODULE_GPIO0x01,/* GPIO模块 */MODULE_SPI0x02,/* SPI模块 */MODULE_CAN0x03,/* CAN模块 */MODULE_UART0x04,/* UART模块 */MODULE_APP0x10/* 应用层 */}module_id_t;/* 主错误类型枚举 */typedefenum{MAIN_ERR_OK0x00,/* 成功 */MAIN_ERR_PARAM0x01,/* 参数错误 */MAIN_ERR_HW0x02,/* 硬件错误 */MAIN_ERR_BUS0x03,/* 总线错误 */MAIN_ERR_TIMEOUT0x04,/* 超时 */MAIN_ERR_MEM0x05/* 内存错误 */}main_err_t;/* 构造结构化错误码 */#defineERR_MAKE(module,main,sub)\((err_code_t)(((module)ERR_MODULE_SHIFT)|\((main)ERR_MAIN_SHIFT)|\((sub)ERR_SUB_SHIFT)))/* 从错误码提取模块ID */#defineERR_GET_MODULE(err_code)\(((err_code)ERR_MODULE_MASK)ERR_MODULE_SHIFT)/* 从错误码提取主错误码 */#defineERR_GET_MAIN(err_code)\(((err_code)ERR_MAIN_MASK)ERR_MAIN_SHIFT)/* 从错误码提取子错误码 */#defineERR_GET_SUB(err_code)\((err_code)ERR_SUB_MASK)/* 判断是否成功 */#defineERR_IS_OK(err_code)\(ERR_GET_MAIN(err_code)MAIN_ERR_OK)/* 子错误码解析函数类型 */typedefconstchar*(*err_sub_parser_fn)(uint16_tsub_code);/* 注册模块的子错误码解析器 */voiderr_register_sub_parser(uint8_tmodule_id,err_sub_parser_fn parser);/* 解析错误码到字符串 */interr_parse_to_string(err_code_terr_code,char*buf,size_tlen);/* 获取模块名称 */constchar*err_get_module_name(uint8_tmodule_id);/* 获取主错误描述 */constchar*err_get_main_desc(uint8_tmain_err);#endif/* ERROR_STRUCT_H *//** * file error_struct.c * brief 结构化错误码解析实现 */#includeerror_struct.h#includestdio.h#includestring.h#defineMAX_MODULES16staticstruct{uint8_tmodule_id;err_sub_parser_fn parser;}sub_parser_table[MAX_MODULES];staticintsub_parser_count0;constchar*err_get_module_name(uint8_tmodule_id){switch(module_id){caseMODULE_SYSTEM:returnSYSTEM;caseMODULE_GPIO:returnGPIO;caseMODULE_SPI:returnSPI;caseMODULE_CAN:returnCAN;caseMODULE_UART:returnUART;caseMODULE_APP:returnAPP;default:returnUNKNOWN;}}constchar*err_get_main_desc(uint8_tmain_err){switch(main_err){caseMAIN_ERR_OK:returnSuccess;caseMAIN_ERR_PARAM:returnInvalid parameter;caseMAIN_ERR_HW:returnHardware failure;caseMAIN_ERR_BUS:returnBus error;caseMAIN_ERR_TIMEOUT:returnTimeout;caseMAIN_ERR_MEM:returnMemory error;default:returnUnknown error;}}voiderr_register_sub_parser(uint8_tmodule_id,err_sub_parser_fn parser){if(sub_parser_countMAX_MODULES||parserNULL){return;}sub_parser_table[sub_parser_count].module_idmodule_id;sub_parser_table[sub_parser_count].parserparser;sub_parser_count;}staticconstchar*find_sub_parser(uint8_tmodule_id,uint16_tsub_code){for(inti0;isub_parser_count;i){if(sub_parser_table[i].module_idmodule_id){returnsub_parser_table[i].parser(sub_code);}}returnNULL;}interr_parse_to_string(err_code_terr_code,char*buf,size_tlen){if(bufNULL||len
{return0;}uint8_tmoduleERR_GET_MODULE(err_code);uint8_tmainERR_GET_MAIN(err_code);uint16_tsubERR_GET_SUB(err_code);constchar*sub_descfind_sub_parser(module,sub);if(sub_desc!NULL){returnsnprintf(buf,len,[%s] %s - %s,err_get_module_name(module),err_get_main_desc(main),sub_desc);}else{returnsnprintf(buf,len,[%s] %s (sub:%d),err_get_module_name(module),err_get_main_desc(main),sub);}}使用示例/** * file spi_driver.c * brief SPI模块错误码实现 */#includeerror_struct.h#includestdio.h#includestddef.h/* SPI子错误码定义 */#defineSPI_SUB_ERR_NONE0#defineSPI_SUB_ERR_BUS_BUSY1#defineSPI_SUB_ERR_CRC_FAIL2#defineSPI_SUB_ERR_NO_DEVICE3/* SPI子错误码解析函数 */staticconstchar*spi_sub_err_to_string(uint16_tsub_code){switch(sub_code){caseSPI_SUB_ERR_NONE:returnNone;caseSPI_SUB_ERR_BUS_BUSY:returnBus busy;caseSPI_SUB_ERR_CRC_FAIL:returnCRC check failed;caseSPI_SUB_ERR_NO_DEVICE:returnNo device;default:returnUnknown sub error;}}/* SPI驱动函数 */err_code_tspi_transfer(uint8_t*data,uint32_tlen){if(dataNULL||len
{returnERR_MAKE(MODULE_SPI,MAIN_ERR_PARAM,SPI_SUB_ERR_NONE);}returnERR_MAKE(MODULE_SPI,MAIN_ERR_OK,SPI_SUB_ERR_NONE);}/* 应用层使用 */staticvoidprint_error(err_code_terr){charerr_str[128];err_parse_to_string(err,err_str,sizeof(err_str));printf( Parsed: %s\n,err_str);}intmain(void){err_code_tret;uint8_tdata[10]{0};err_register_sub_parser(MODULE_GPIO,gpio_sub_err_to_string);err_register_sub_parser(MODULE_SPI,spi_sub_err_to_string);printf(gpio_init(10,
:\n);retgpio_init(10,
;print_error(ret);printf(\n);printf(spi_transfer(valid):\n);retspi_transfer(data,
;print_error(ret);printf(\n);return0;}
三、
总结错误码设计的关键是匹配项目实际需求不是越复杂越好小型项目用极简或枚举方案开发效率高维护简单大型项目用结构化方案定位精准
注意事项错误码值不可修改。
一旦定义并发布了错误码的数值和含义永远不改只能新增。
尽量提供解析函数。
不写解析函数调试时看到数字要翻代码查定义效率太低。
避免跨模块码值冲突。
整型或枚举方案要提前规划码段比如GPIO占100199SPI占200299严格遵守。
错误码与处理逻辑解耦。
错误码只定义是什么错比如SPI_BUS_BUSY不定义怎么处理。
…