CSDN专栏嵌入式程序开发实战嵌入式双范式AI编程嵌入式开发必掌握嵌入式求职面试技术资料第42讲嵌入式四段式万能Spec模板——适配所有驱动/任务/协议一、四段式Spec模板概述四段式Spec模板是嵌入式开发的万能模板适用于所有场景驱动开发、任务设计、协议实现。1.1 四段式结构第一层需求层Requirement第二层设计层Design第三层编码层Coding第四层测试层Test第一层需求层Requirement功能需求性能需求安全需求第二层设计层Design硬件层设计数据层设计函数契约设计容错边界设计第三层编码层Coding编码规范命名规范注释规范第四层测试层Test单元测试集成测试覆盖率要求1.2 模板特点特点一通用性适用于GPIO驱动UART驱动SPI驱动I2C驱动ADC驱动PWM驱动RTOS任务通信协议特点二完整性覆盖所有功能需求所有接口定义所有异常处理所有性能要求特点三可追溯性每个Spec条款有唯一IDREQ-001需求IDDES-001设计IDCOD-001编码IDTEST-001测试ID二、万能Spec模板2.1 完整模板## Spec[模块名称] ### 1. 需求层Requirement #### 1.1 功能需求 - REQ-001[功能需求1] - REQ-002[功能需求2] - REQ-003[功能需求3] #### 1.2 性能需求 - REQ-010[性能需求1] - REQ-011[性能需求2] #### 1.3 安全需求 - REQ-020[安全需求1] - REQ-021[安全需求2] ### 2. 设计层Design #### 2.1 硬件层约束 - DES-001[硬件约束1] - 约束类型[时序/电气/环境] - 约束值[具体数值] - 验证方法[验证方法] - DES-002[硬件约束2] #### 2.2 数据层约束 - DES-010[数据结构定义] - 类型[数据类型] - 范围[最小值, 最大值] - 默认值[默认值] - 校验方法[校验方法] - DES-011[数据格式定义] #### 2.3 函数契约 - DES-020[函数名] - 签名[函数签名] - 入参约束[参数约束] - 出参约束[输出约束] - 返回值约束[返回值约束] - 副作用[副作用描述] - 执行时间上限[时间上限] - DES-021[函数名2] #### 2.4 容错边界 - DES-030[异常类型1] - 检测方法[检测方法] - 响应措施[响应措施] - 恢复策略[恢复策略] - 记录要求[记录要求] - DES-031[异常类型2] ### 3. 编码层Coding #### 3.1 编码规范 - COD-001遵循MISRA C:2012规范 - COD-002禁止动态内存分配 - COD-003禁止指针运算 - COD-004所有变量必须初始化 - COD-005所有函数必须有单一出口 #### 3.2 命名规范 - COD-010函数命名模块名_功能名如UART_Init - COD-011变量命名类型前缀_模块_名称如u8_UART_TxBuffer - COD-012宏定义全大写如UART_BUFFER_SIZE #### 3.3 注释规范 - COD-020使用Doxygen格式注释 - COD-021每个函数必须有注释块 - COD-022注释必须标注对应Spec ID ### 4. 测试层Test #### 4.1 单元测试 - TEST-001[测试用例1] - 测试目标[目标Spec ID] - 测试输入[输入数据] - 期望输出[期望结果] - 前置条件[前置条件] - TEST-002[测试用例2] #### 4.2 集成测试 - TEST-010[集成测试场景1] - TEST-011[集成测试场景2] #### 4.3 覆盖率要求 - TEST-020语句覆盖率≥80% - TEST-021分支覆盖率≥80% ### 5. 追溯层Traceability #### 5.1 需求追溯矩阵 | 需求ID | 设计ID | 代码文件 | 函数名 | 测试ID | |-------|--------|---------|--------|--------| | REQ-001 | DES-020 | uart.c | UART_Init | TEST-001 | | REQ-002 | DES-021 | uart.c | UART_Send | TEST-002 | ### 6. AI生成指令 根据以上Spec生成代码要求 1. 严格遵守所有Spec约束 2. 每个函数注释标注对应Spec ID 3. 包含所有Spec要求的功能 4. 包含所有Spec要求的容错处理 5. 符合编码规范三、模板应用示例3.1 GPIO驱动Spec## SpecGPIO驱动 ### 1. 需求层 #### 1.1 功能需求 - REQ-001配置GPIO引脚为输入/输出模式 - REQ-002读取GPIO输入状态 - REQ-003设置GPIO输出状态 - REQ-004切换GPIO输出状态 #### 1.2 性能需求 - REQ-010GPIO操作响应时间1us #### 1.3 安全需求 - REQ-020参数检查防止非法引脚号 ### 2. 设计层 #### 2.1 硬件层约束 - DES-001GPIO端口 - GPIOAPA0-PA15 - GPIOBPB0-PB15 - GPIOCPC0-PC15 - DES-002GPIO模式 - 输入模式GPIO_MODE_INPUT - 输出模式GPIO_MODE_OUTPUT_PP/GPIO_MODE_OUTPUT_OD - 复用模式GPIO_MODE_AF_PP/GPIO_MODE_AF_OD - 模拟模式GPIO_MODE_ANALOG #### 2.2 数据层约束 - DES-010GPIO引脚号 - 类型uint16_t - 范围GPIO_PIN_0 ~ GPIO_PIN_15 - 默认值无 - DES-011GPIO状态 - 类型uint8_t - 范围0或1 - 默认值无 #### 2.3 函数契约 - DES-020GPIO_Init - 签名int8_t GPIO_Init(uint32_t port, uint16_t pin, uint8_t mode) - 入参约束port有效pin有效mode有效 - 返回值约束0成功-1失败 - 执行时间上限100us - DES-021GPIO_Read - 签名int8_t GPIO_Read(uint32_t port, uint16_t pin, uint8_t *state) - 入参约束port有效pin有效state非空 - 出参约束state为0或1 - 返回值约束0成功-1失败 - DES-022GPIO_Write - 签名int8_t GPIO_Write(uint32_t port, uint16_t pin, uint8_t state) - 入参约束port有效pin有效state为0或1 - 返回值约束0成功-1失败 #### 2.4 容错边界 - DES-030非法端口 - 检测方法端口枚举检查 - 响应措施返回-1 - DES-031非法引脚 - 检测方法引脚范围检查 - 响应措施返回-1 ### 3. 编码层 - COD-001遵循MISRA C:2012规范 - COD-010函数命名GPIO_功能名 - COD-020使用Doxygen格式注释 ### 4. 测试层 - TEST-001测试GPIO输出 - 测试目标DES-022 - 测试输入portGPIOA, pinGPIO_PIN_5, state1 - 期望输出PA5输出高电平 - TEST-002测试GPIO输入 - 测试目标DES-021 - 测试输入portGPIOC, pinGPIO_PIN_13 - 期望输出正确读取PC13状态 ### 5. AI生成指令 根据以上Spec生成GPIO驱动代码3.2 UART驱动Spec## SpecUART驱动 ### 1. 需求层 #### 1.1 功能需求 - REQ-001初始化UART - REQ-002发送数据 - REQ-003接收数据 - REQ-004配置波特率、数据位、停止位、校验位 #### 1.2 性能需求 - REQ-010波特率误差2% - REQ-011发送超时100ms - REQ-012接收超时100ms #### 1.3 安全需求 - REQ-020参数检查防止空指针 - REQ-021超时处理防止卡死 ### 2. 设计层 #### 2.1 硬件层约束 - DES-001UART实例 - USART1PA9(TX), PA10(RX) - USART2PA2(TX), PA3(RX) - USART3PB10(TX), PB11(RX) - DES-002UART配置 - 波特率9600/19200/38400/57600/115200 - 数据位8位 - 停止位1位 - 校验位无 #### 2.2 数据层约束 - DES-010发送缓冲区 - 类型uint8_t[256] - 大小256字节 - DES-011接收缓冲区 - 类型uint8_t[256] - 大小256字节 #### 2.3 函数契约 - DES-020UART_Init - 签名int8_t UART_Init(uint8_t uartId, uint32_t baudrate) - 入参约束uartId有效baudrate有效 - 返回值约束0成功-1失败 - DES-021UART_Send - 签名int8_t UART_Send(uint8_t uartId, uint8_t *data, uint16_t len) - 入参约束uartId有效data非空len0 - 返回值约束0成功-1失败 - DES-022UART_Receive - 签名int8_t UART_Receive(uint8_t uartId, uint8_t *data, uint16_t len) - 入参约束uartId有效data非空len0 - 返回值约束0成功-1失败 #### 2.4 容错边界 - DES-030发送超时 - 检测方法超时计时器 - 响应措施返回-1 - DES-031接收超时 - 检测方法超时计时器 - 响应措施返回-1 - DES-032空指针 - 检测方法指针检查 - 响应措施返回-1 ### 3. 编码层 - COD-001遵循MISRA C:2012规范 - COD-010函数命名UART_功能名 - COD-020使用Doxygen格式注释 ### 4. 测试层 - TEST-001测试UART发送 - 测试目标DES-021 - 测试输入Hello - 期望输出正确发送 - TEST-002测试UART接收 - 测试目标DES-022 - 测试输入接收5字节 - 期望输出正确接收 ### 5. AI生成指令 根据以上Spec生成UART驱动代码四、模板使用方法4.1 填写步骤步骤一填写需求层步骤二填写设计层步骤三填写编码层步骤四填写测试层步骤一填写需求层列出所有功能需求列出所有性能需求列出所有安全需求步骤二填写设计层定义硬件约束定义数据结构定义函数契约定义容错边界步骤三填写编码层定义编码规范定义命名规范定义注释规范步骤四填写测试层设计单元测试设计集成测试定义覆盖率要求4.2 AI生成代码Prompt【Spec】 [粘贴完整Spec] 【指令】 请根据以上Spec生成代码4.3 验证代码验证清单功能完整性接口正确性容错完整性性能达标编码规范五、本讲核心要点5.1 记住这三句话四段式Spec模板需求层→设计层→编码层→测试层适配所有场景模板特点通用性、完整性、可追溯性使用方法填写Spec→AI生成→验证代码5.2 下讲预告第43讲将详细讲解硬件层Spec引脚定义、时钟、电压、时序约束如何编写硬件层Spec定义硬件约束下一讲将详细讲解。