SWE-D10-02软件详细设计报告(嵌入式)

1、软 件 详 细 设 计 报 告（ 嵌 入 式 ）v0.9 项 目 号：项目名称：编制：日期：审核/会签日期审核/会签日期审核/会签日期批准日期软件详细设计报告（嵌入式）2/9 修 订 页编号修订内容简述修订日期修订后版本号修订人审核人批准人1 将前期讨论的结果根据公司模板格式要求重新整理2007-9-18 v0.5 2 统一升级预发布版本，修订部分细节2007-11-7 v0.9 软件详细设计报告（嵌入式）3/9 目录1.概述 . 4 1.1.本文档的目的. 4 1.2.单板软件概述. 4 2.功能描述 . 4 2.1.软件功能说明. 4 2.2.软件功能框图. 4 3.开关、跳线、指示灯说明

2、. 4 3.1.开关跳线 . 4 3.2.指示灯 . 4 4.编译说明 . 4 4.1.固化文件的生成. 4 4.2.物理软件的烧制. 5 5.数据结构 . 5 5.1.常量定义 . 5 5.2.全局变量定义. 5 5.3.全局结构定义. 5 6.程序流程 . 5 6.1.模块 1. 5 6.2.模块 2. 7 7.需求跟踪 . 7 7.1.系统功能需求实现. 8 7.2.系统性能需求实现. 8 7.3.系统其他需求实现. 8 8.源文件列表 . 8 9.其它 . 8 软件详细设计报告（嵌入式）4/9 关键词：能够体现文档描述内容主要方面的词汇。摘要 ：缩略语清单：对本文所用缩略语进行说明，要

3、求提供每个缩略语的英文全名和中文解释。1.概述1.1.本文档的目的说明本文档的编写的目的，包含的内容，适合的软件版本。如为升级文档还要说明升级的原因，主要增加了哪些功能，解决了哪些问题。1.2.单板软件概述简要说明单板软件所属的产品名称，承载软件的单板在整个产品中的位置、作用、和其它单板的关系。说明该单板软件所属的成品板及能够兼容的所有制成板。2.功能描述2.1.软件功能说明这里是对单板软件概要设计功能描述的细化，功能说明应严格与概要设计功能描述一致，保持需求与设计的一致性。2.2.软件功能框图根据以上外部功能，采用图形方式详细说明单板软件采用何种功能结构完成这些功能。3.开关、跳线、指示灯说

4、明3.1.开关跳线说明所有可由程序读取其状态的拨码开关、跳线、键盘等分别代表的功能和cpu读取其状态的方式。如有可能也请列出不受程序控制的拨码开关、跳线、键盘等分别代表的含义。3.2.指示灯说明所有受程序控制和不受程序控制的指示灯所代表的信息，以及指示灯与cpu的连接方式，受控和不受控的原因。详细描述各指示灯显示规则。4.编译说明4.1.固化文件的生成软件详细设计报告（嵌入式）5/9 详细说明软件的编译连接过程，包括如何使用编译、连接批处理文件，最后生成的固化文件的名称。4.2.物理软件的烧制详细说明物理软件的固化过程和方法，如果软件可以加载，请详细说明加载过程。5.数据结构应尽可能详细列出详

5、细设计部分定义的常数、全局变量、全局结构体。5.1.常量定义说明主要/全部常量或常数表的含义，并说明这些常量取当前值的原因。5.2.全局变量定义定义主要/全部全局变量的含义。建议按照模块划分，更能明确的说明常量的意义。对于所有模块都使用的变量会增加整个系统模块间的关联行，应说明其存在的理由。5.3.全局结构定义定义主要/全部全局结构体的含义， 建议按照模块划分，每个模块必须要包括它的核心数据结构。多个模块使用的数据结构会导致模块间的关联性，应说明其存在的理由。6.程序流程本部分介绍了单板软件的程序设计，应尽量按照模块划分，便于进行需求跟踪。对于单任务的单板软件系统，可以按照（主程序或主函数、子

6、程序或子函数、中断服务程序）的说明要点。对于多任务可以按照任务划分来说明函数的实现方法。要求函数必须有流程图或伪代码描述说明，函数设计要明确，可以达到根据设计实现编程的目的。6.1.模块 1 此处说明模块功能，在软件系统中位置，与其他模块关系和接口。6.1.1.函数 1 软件详细设计报告（嵌入式）6/9 1)函数原型给出被说明函数的原型。2)功能说明函数的功能。3)入口参数请对程序所有的入口参数进行说明。4)出口参数请对程序的所有出口参数进行说明。5)局部变量说明在程序范围所有的局部变量和功能。6)函数调用说明程序为了完成其功能必须调用哪些函数。7)全局变量使用说明程序中使用了那些全局变量，对

7、可能引起的中断重入/任务抢占采用了那些措施。8)流程图画出主程序的流程图或用伪代码说明。6.1.2.函数 2 6.1.3.函数 3 中断服务程序1)函数原型软件详细设计报告（嵌入式）7/9 给出被说明函数的原型。2)功能说明函数的功能。模块内部如果涉及底层驱动的中断服务程序，应明确标明中断类型（外部中断、内部中断）、中断优先级等信息。3)入口参数请对程序所有的入口参数进行说明。4)出口参数请对程序的所有出口参数进行说明。5)局部变量说明在程序范围所有的局部变量和功能。6)函数调用说明程序为了完成其功能必须调用哪些函数。7)全局变量使用说明程序中使用了那些全局变量，对可能引起的中断重入/任务抢占采用了那些措施。8)流程图画出主程序的流程图或用伪代码说明。6.2.模块 2 。 。 。 。 。7.需求跟踪软件详细设计报告（嵌入式）8/9 为保证所有单板软件概要设计中的需求描述在详细设计中都得到体现，这里需要对所有的需求实现进行描述。7.1.系统功能需求实现列出各项系统功能需求在详细设计中的实现函数；7.2.系统性能需求实现列出各项系统性能需求在详细设计中的实现函数；7.3.系统其他需求实现列出各项系统其他需求在详细设计中的实现函数；8.源文件列表罗列所有的源程序文件名并分别说明用途，要求在提交本文档同时提交这些源程序文件