本文将介绍嵌入式软件(SW)函数规格说明书。
SW函数规格说明书是描述SW开发中各函数设计内容的文档。该规格说明书明确记载了函数的目的、输入输出参数、前提条件、处理内容、返回值、异常处理等信息,为实现者提供准确编码的指导。
此外,SW功能规格书不仅用于团队内部的信息共享和审查,还可用于后续阶段的测试设计以及维护时的理解,因此它不仅仅是一份简单的编码指南,更是支撑SW质量和生产力的重要文档。
保持规格说明书与实现的一致性对于可靠的开发至关重要,因此在设计、实现和测试的各个阶段,都需要对规格说明书进行适当的更新和管理。
SW函数规格书的编制
SW函数规格书的编制,以A-SPICE为例,是基于“SWE.1 SW需求分析”和“SWE.2 SW架构设计”的结果,在“SWE.3 SW详细设计及初始构建”阶段进行编制。

SW函数规格项
SW函数规格书的项目如下表所示。
SWE | 规格项 | 概述 |
---|---|---|
2 or 3 | SW函数分类 | SW函数分类:SW组件(SWC)函数, UNIT函数,中断函数, 库函数, 宏函数 |
2 | 所属SWC名称 | UNIT的情况下,所属的SWC名称 |
2 | SW状态 | SWC的SW状态(对于UNIT,继承所属的SWC) |
2 | SW层 | SWC的SW层(对于UNIT,继承所属的SWC) |
2 | 处理时机 | SWC的处理时机(周期、事件)(对于UNIT,继承所属的SWC) |
2 | 处理优先级 | SWC的中断优先级或任务/线程的优先级(对于UNIT,继承所属的SWC) |
2 | 调用源函数名 | 对于UNIT,调用源函数名 |
2 | 呼叫顺序 | 对于UNIT,SWC内的呼叫顺序 |
2 or 3 | SW函数型 | SW函数型 |
2 or 3 | INPUT参数 | 类型、标签名称、LSB、单位 |
2 or 3 | OUTPUT参数 | 类型、标签名称、LSB、单位 |
2 or 3 | Return | 类型、标签名称、LSB、单位 |
2 or 3 | 处理概述 | SW函数的处理概述 |
2 or 3 | 处理详情 | 1) 函数输入 |
2 or 3 | 2) 预处理 | |
2 or 3 | 3) 条件判断 | |
2 or 3 | 4) 条件每项的运算或低级函数调用 | |
2 or 3 | 5) 事后处理 | |
2 or 3 | 6)函数输出 | |
1 or 3 | ROM常数 | 类型、标签名称、LSB、单位、值(值的计算公式) |
2 or 3 | 宏常量(#define) | 类型、标签名称、LSB、单位、值(值的计算公式) |
3 | 局部变数 | 类型、标签名称、LSB、单位、初始值 |
3 | 静态变数 | 类型、标签名称、LSB、单位、初始值 |
2 or 3 | 全局变量 | 类型、标签名称、LSB、单位、初始值 |