单板软件概要设计报告.docx

1、单板软件概要设计报告深圳市华为技术有限公司研究管理部文档中心文档编号产品版本密级产品名称：共14页单板软件概要设计报告(仅供内部使用)拟制：日期：yyyy/mm/dd审核：日期：yyyy/mm/dd审核：日期：yyyy/mm/dd批准：日期：yyyy/mm/dd深圳市华为技术有限公司版权所有 不得复制修订记录日期修订版本描述作者1999/01/301.00初稿完成作者名目 录1概述51.1本文档的目的51.2单板软件概述52需求描述52.1系统应用功能需求52.1.1系统应用功能需求152.1.2系统应用功能需求252.1.3系统应用功能需求352.2系统维护功能需求62.2.1系统维护功能需

2、求162.2.2系统维护功能需求262.2.3系统维护功能需求362.3性能需求62.3.1性能需求162.3.2性能需求262.3.3性能需求363设计思想63.1功能设计描述及框图63.2功能实现流程图63.3性能设计思想及实现性能参数的措施64接口协议64.1邮箱协议64.2与主机通讯协议64.3链路层通讯协议74.4内部模块间接口协议75操作系统75.1外购操作系统的名称，厂家和版本号75.2自编操作系统的来源及特点75.3选定该操作系统的依据75.4操作系统调度方法说明76编程协定76.1.CPU类型76.2编程语言，编译器和调试环境的选择和依据76.3.编程规范76.4.物理结构7

3、6.4.1ROM空间76.4.2RAM空间86.4.3内部存储区分配图87数据结构87.1常量定义87.2变量定义87.3结构定义87.4全局定义88测试计划88.1单元测试计划88.2集成测试计划88.3静态代码审查计划89其它810附件810.1单板软件概要设计评审表8单板软件概要设计报告关键词：摘 要：缩略语清单： 对本文所用缩略语进行说明，要求提供每个缩略语的英文全名和中文解释。 参考资料清单： 请在表格中罗列本文档所引用的有关参考文献名称、作者、标题、编号、发布日期和出版单位等基本信息。参考资料清单名称作者编号发布日期查阅地点或渠道出版单位（若不为本公司发布的文献，请填写此列）1 概

4、述.1 本文档的目的说明本文档的编写的目的，包含的内容，适合的软件版本。如为升级文档还要说明升级的原因，主要增加了哪些功能，解决了哪些问题。.2 单板软件概述简要说明单板软件所属的产品名称，在整个产品中的位置、作用、和其它单板的关系。说明该单板软件所属的成品板及能够兼容的制成板。2 需求描述.3 系统应用功能需求逐一列出并说明系统对本软件在应用方面的功能需求。.1 系统应用功能需求1.2 系统应用功能需求2.3 系统应用功能需求3。.4 系统维护功能需求逐一列出并说明系统对本软件在维护方面的功能需求，如版本上报、上电自检、误码统计等，详细内容可参考后附的单板软件概要设计评审表。.4 系统维护功

5、能需求1.5 系统维护功能需求2.6 系统维护功能需求3。.5 性能需求逐一列出并说明系统对本软件在性能方面的需求，所要达到的性能指标参数。如CPU处理能力，链路的最高速率，误码对软件的影响以及从软件的角度恢复硬件错误的能力等。.7 性能需求1.8 性能需求2.9 性能需求3。3 设计思想.6 功能设计描述及框图详细说明单板软件为实现系统功能需求所采的取设计思想、功能结构。.7 功能实现流程图画出软件为实现功能结构所做的信息处理、资源调配、进程或任务控制流程，并详细说明之。.8 性能设计思想及实现性能参数的措施详细说明软件为达到系统的性能需求所采取的各项措施。4 接口协议.9 邮箱协议如果单板

6、需要通过邮箱与外部通讯，要在这里写清楚邮箱协议文档名称、时间、作者。.10 与主机通讯协议如果单板要与主机的应用层（非操作系统）通讯，要在这里写清楚通讯协议文档名称、时间、作者。.11 链路层通讯协议如果单板需要通过数据链路与外部通讯，数据链路如为标准协议要在这里写清楚标准协议的名称、制定组织及颁布时间，数据链路如为公司内部协议要在这里写清楚协议文档的名称、时间和作者。.12 内部模块间接口协议如果单板软件有内部模块划分，请在这里写详细描述接口协议。如有专门的协议文档，请写清楚协议文档的名称、时间和作者。5 操作系统.13 外购操作系统的名称，厂家和版本号如选用外购操作系统，要写明外购操作系统

7、的名称、厂家和版本号。.14 自编操作系统的来源及特点如选用公司内部自编操作系统应说明操作系统出自哪里，在哪些系统上使用过，是否测试过该操作系统的性能指标。.15 选定该操作系统的依据说明选择该操作系统的依据，本软件为满足系统的需求对操作系统的需求是什么，所选操作系统的各项性能指标是否能满足系统的要求。.16 操作系统调度方法说明说明所选用操作系统的调度原理和调度方法并画出它实现调度的结构图或流程图。6 编程协定.17 CPU类型说明单板的CPU类型，生产厂家和型号.18 编程语言，编译器和调试环境的选择和依据说明软件采用何种编程语言。选择哪种编译器和调试器以及选择它们的依据。.19 编程规范

8、说明软件编程是否依照编程规范，编程规范的名称是什么，出自哪里。.20 物理结构.10 ROM空间说明内部ROM和外部ROM的地址分配情况。.11 RAM空间说明外部RAM，内部设备、外部设备的地址分配情况，如果外部设备种存在间接寻址，应对间接寻址访问方法和分配情况进行说明。.12 内部存储区分配图说明内部存储空间（包括ROM、RAM）的地址分配情况和相关使用特点。7 数据结构.21 常量定义说明主要常量和常量表的定义，并说明这些常量取当前值的原因。.22 变量定义说明主要全局变量的定义.23 结构定义说明主要结构体的定义.24 全局定义定义所有全局性的参量，如预编译开关，编译前可调的全局常量等

9、。8 测试计划.25 单元测试计划依据本软件的特点说明是否要做单元测试，如要做单元测试，请在这里说明单元测试计划。.26 集成测试计划依据本软件的特点说明是否要做集成测试，如要做集成测试，请在这里说明集成测试计划。.27 静态代码审查计划依据本软件的特点说明是否要做静态代码审查，如要做静态代码审查，请在这里说明静态代码审查计划和审查是依据的编程规范。9 其它说明其它设计要点10 附件.28 单板软件概要设计评审表请在概要设计完成前填写下表，在此文档归档前将单板软件概要设计评审报告作为附件一并归档，手签件应扫描成电子件后附在此。单板软件概要设计评审报告（V1.0）请软件设计人员和审查人员根据以下

10、内容对提交的概要设计报告进行严格审查。审查板名：任务编号： 任务责任人：任务名称： 所有评审人签名评审要点（由开发人员填写，项目经理审核）拟制： 审核：单板软件概要设计评审表（由评审人员或评审小组填写）1. 文档1) 是否做了项目开发的文档计划是（ ）否（ ）2) 是否完成单板软件设计文档的概要设计阶段的内容是（ ）否（ ）3) 是否确定了调试记录的格式是（ ）否（ ）2. 开发设计方面1) 功能方面是否明确了系统对单板有那些方面的功能要求是（ ）否（ ）是否有确定的功能结构来实现这些功能是（ ）否（ ）2) 性能方面是否明确了系统对单板有那些方面的性能要求是（ ）否（ ）各项性能是否都有明确

11、的性能指标是（ ）否（ ）这些性能指标是否采取了有效措施来达到这些性能指标是（ ）否（ ）3) 是否采用模块化设计是（ ）否（ ）4) 操作系统是否采用（或设计）操作系统是（ ）否（ ）是否考虑了操作系统的可靠性是（ ）否（ ）操作系统的效率是否能满足单板的需求是（ ）否（ ）5) 协议是否要完成标准协议功能是（ ）否（ ）是否为保证协议的一致性采取了有效措施是（ ）否（ ）6) 接口方面是否有外部接口是（ ）否（ ）是否完成了外部接口协议的制定是（ ）否（ ）是否有内部模块间接口是（ ）否（ ）是否完成了模块间接口协议的制定是（ ）否（ ）是否要与主机通讯是（ ）否（ ）是否完成了与主机通讯

12、协议的制定是（ ）否（ ）7) 是否完成了全局数据结构的制定是（ ）否（ ）8) 后续程序编码是否要遵守编程规范是（ ）否（ ）9) 兼容性方面是否能兼容所有的硬件版本是（ ）否（ ）是否能兼容各种机型是（ ）否（ ）是否能兼容主流机型的各种版本是（ ）否（ ）10) 是否确定了使用的编译工具是（ ）否（ ）11) 是否确定了使用的调试工具是（ ）否（ ）3. 维护功能接口方面1) 是否有单板版本上报是（ ）否（ ）2) 是否有单板上电自检并向主机报自检结果是（ ）否（ ）3) 运行等是否按要求开工闪动是（ ）否（ ）4) 是否能及时上报物理链路上的误码、失步是（ ）否（ ）5) 是否能及时上

13、报单板资源的过载和过载恢复情况是（ ）否（ ）6) 是否考虑了单板过载时的措施是（ ）否（ ）7) 是否具备向主机上报CPU占用率的能力是（ ）否（ ）8) 是否具备对单板处理的各种帧的统计能力是（ ）否（ ）9) 是否具备在线环回测试能力是（ ）否（ ）10) 是否具备在线向主机发送调试信息的能力是（ ）否（ ）11) 出现异常情况时是否能用指示灯来告警是（ ）否（ ）12) 是否为调试设计了信息打印口是（ ）否（ ）4. 测试计划方面1) 单元测试是否准备做单元测试是（ ）否（ ）是否要做白盒测试是（ ）否（ ）是否要做黑盒测试是（ ）否（ ）测试用例是否要包含输入的合理等价和不合理等价值

14、是（ ）否（ ）测试用例是否要有合法边缘值和非法边缘值是（ ）否（ ）2) 集成测试是否准备做集成测试是（ ）否（ ）是否要按功能需求逐项制定测试用例是（ ）否（ ）是否要按性能指标逐项制定测试用例是（ ）否（ ）3) 可测性是否在设计中为提高软件的可测性采取了有效措施是（ ）否（ ）4) 要完成标准协议功能的请填写下栏公司是已有能满足要求的协议测试仪是（ ）否（ ）如没有协议测试仪，是否为一致性测试做了充分考虑是（ ）否（ ）5) 代码审查是否要做静态代码审查是（ ）否（ ）是否为静态代码审查制定了人员计划是（ ）否（ ）5. 配置管理方面1) 是否考虑了文档和源程序的版本管理是（ ）否（ ）2) 是否已确定了版本管理工具是（ ）否（ ）评审意见（由评审人员或评审小组填写）评审人：项目组反馈意见任务责任人签字： 时间：评审结论（评审组织人填写）签字： 时间：