嵌入式软件概要设计模板

《嵌入式软件概要设计模板》由会员分享，可在线阅读，更多相关《嵌入式软件概要设计模板（16页珍藏版）》请在金锄头文库上搜索。

1、嵌入式软件概要设计（模板）目录1前言 51.1 编写目的 51.2 项目背景 51.3 定义 51.4 参考资料 52版本变更说明 53 任务概述 53.1 目标 53.2 嵌入式软件运行环境 54 总体设计 64.1 系统描述 64.2 设计约定 64.3 总体结构 64.4 处理流程 95 安全关键部件的设计 95.1 识别安全关键部件 95.2 安全关键部件设计 96 接口设计 96.1 接口示意图 106.2 用户接口设计 126.3 外部接口设计 126.4 内部接口设计 126.5 通信接口设计 126.6 硬件接口设计 127 运行设计 137.1 系统启动设计 138 异常信息

2、记录及处理设计 138.1 异常情况分析 138.2 异常处理对策 138.3 异常信息记录 139 容错设计 1310 维护设计 1310.1 调试信息的缓冲区管理 1310.2 调试策略 1410.3 调试信息级别 1410.4 调试 API 1410.5 软件可测性设计 1410.6 软硬件版本信息在线上报/在线加载 1410.7 数据设定与操作 1410.8 保密性设计 1511 软件包描述 1511.1 软件包结构 1511.2 发布介质 错误!未定义书签。11.3 软件可安装性 15模板使用说明：1、本模板发布后，新产品一律使用本模板撰写；2、本模板中的蓝色字是对模板内容的说明，用

3、于指导作者理解并按照模板要求进行编写， 具体编写时，可删除；3、本模板中的各个要点，在具体编写时如果不涉及，应在相关章节内写“无”或“不涉及” 而不能直接将相关章节删除；1 前言1.1 编写目的本文根据XX产品需求规格说明，对XX软件系统的总体结构设计，功能模块划分，模 块接口设计，以及 Web 页面框架设计进行描述；同时对 XX 产品软件的非功能性需求，包 括出错处理，可维护性等加以描述；以便指导详细设计和软件编码。本文档适用于系统设计师、软件设计者、软件开发者、软件测试工程师等相关人员阅读 和使用。1.2 项目背景软件名称：软件英文名称：软件标签：软件版本号：1.3 定义1.4 参考资料2

4、 版本变更说明首次设计时可写“无”后续设计本文档的修改，均应按以下表格对修改内容进行说明:版本号变更原因/目 的关联产品受影响的功 能模块兼容性说明受影响的测 试用例3 任务概述3.1 目标完成的软件设计，确定软件的总体结构，关键操作处理流程，功能模块划分3.2 嵌入式软件运行环境硬件环境4 总体设计4.1 系统描述根据产品系统总体方案和硬件概要设计的内容，总结出对嵌入式软件的设计要 求4.1.1 系统主要输入4.1.2 系统主要输出4.1.3 系统主要功能及安全关键功能识别除描述系统主要功能外，还需要分析这些功能中哪些属于安全关键功能，安全关键功 能指对系统安全性具有重大影响的功能。本文档识

5、别出安全关键功能后，针对这些功能的 设计可在详细设计文档中进行4.1.4 系统主要性能4.2 设计约定本嵌入式软件设计需要遵守的总体要求4.2.1 编程语言约定开发本程序所使用开发语言、平台及版本4.2.2 数据类型定义常用数据类型新类型名变量名称前缀typedef unsigned charBYTEbytypedef charCHARctypedef unsigned shortWORDwtypedef shortSWORDssw4.2.3 接口函数约定供外部模块调用的函数接口命令方式：模块名称+功能名称共内部模块调用的函数接口命名方式：模式名称+功能名称4.2.4 代码组织约定代码文件的组

6、织方式按照物理器件和逻辑功能来划分，即每一个设备器件分配一个文件，每一逻辑单元功能分配一个文件，对于需要集中管理的信息则单独分配文件，如寄存器定 总体结构 息等则单独分配文件，便于信息的查找和修改描述嵌入式软件总体结构4.3.1系统结构图根据对本系统的需求分析结果，对本系统的组成进行设计及相关内容的描述，以下样 例供使用者参考：样例1、系统结构图：I .门咁傀:| in齐皿伽d层丿二讥:|词绅代C上层业务逻綁接口子业务逻辑1子业务逻辑z瓷济边相处理层蛆件1高組件2髙组件彳高组件4高组件百髙层操作层操作层操作层操作T爼件1血姐件Z底组件吕底组杵4底组件戒层操作层操柞层操作层操作层操作4.3.2模

7、块划分根据本软件需要实现的需求对软件功能模块进行划分。 样例：业务逻辑丿云4.3.3模块功能描述针对上一章节的模块划分结果，对模块需要完成的功能进行描述。样例：Web UI应用层主要处理和用户的交互信息，由安全管理、系统配置、业务操作、系统 管理、系统告警、系统升级、在线诊断、用户帮助等组件组成，给用户提供可视化的业务 操作和图形化的信息显示。该模块只和业务处理层有接口交互，主要以消息交互的方式进 行信息交互。该模块首先接收用户发出的操作指令，然后转换成业务请求服务消息发送给 业务处理层，并接收业务处理层的响应，最后将结果以图形化的形式反馈给用户。4.3.4系统兼容性说明说明本软件与现有硬件的

8、兼容关系，以及是否向下兼容。出现不兼容的情况，需说明 哪部分不兼容，对生产、服务、销售、市场有何影响。4.4处理流程描述主要业务的处理流程 样例：嵌入乂软_|w灌冋在舷欄圈T -7VInner Obj内如对城呢恵Onl inc Debug MgrAipplicaliDinFraims IE运WZeb OnlineDebug Apu*plicalaomFrameApplicatiOh Frame4.4.1业务1处理流程4.4.2业务2处理流程4.4.3业务N处理流程5安全关键部件的设计5.1识别安全关键部件对于以下软件部件，应作为安全关键部件加以识别，并在设计中进行可靠性设计:a b c d故障

9、检测的优先级结构及安全性控制或校正逻辑、处理相应响应故障的模块 中断处理程序、中断优先级模式及允许或禁止中断的例行程序；产生对硬件进行自主控制信号的软件；产生直接影响硬件部件运动或启动安全关键功能的信号的软件；e5.2安全关键部件设计对安全关键软件，必须列出可能的不期望事件，分析导致不期望事件的可能原因，提出 相应的软件处理需求。例如中断处理程序期望每5秒钟收到一次中断，那么要考虑如果5秒 时没有中断时，应如何处理6接口设计对本嵌入式软件所有接口进行设计6.1接口示意图6.1.1界面接口描述界面上需要体现的功能接口以及与下层软件的接口关系 样例：主菜单怏捷工具皑虑搦#墙备门控制而価性丹口慎号保

10、属性子蹴口模武牺性予密rrSt瑾器信息及配置子窗口日志怦理子慨n鼎阿配置于窗L 1泰龜升眾子嚮1在建第斷子胃nih面雌越口ZXz系统消息(SOCKET)业务处理(.SOCKET)浏览器Fbsh插件界面页面 请求(HTTP )Web Swi er处理器服务器6.1.2业务类接口根据系统功能图和系统结构图，对所需的业务接口进行定义，不同的业务接口由各种具 体的业务类来实现。样例：通莖口T-I通體类6.1.3非业务类接口系统中的非业务接口则由各种具体的功能类来实现，其中告警接口由告警类和事件类 来共同实现。样例：6.1.4内部接口可以将系统中较复杂的操作抽象成内部接口，使得系统既可以保持业务处理框架

11、的稳 定性，又降低了业务处理模块的复杂性。6.1.5算法接口如果系统中的算法较多，考虑到算法的可扩展性，可将系统中关键业务算法抽象出一个 算法接口，并且都由相关的算法类来实现，这样既保持了接口的稳定性，又增强了系统算法 的可扩展性。样例：6.2用户接口设计6./外父目关的接口进行设计，主要包括界面布局、UI设计等。根据6.1中定义的系统外部接口类，进行详细定义，包括接口输入/输出信息 样例：接口名称接口描述事件日志查询日志查询格式为：槽位号，查询开始时间，查询结束时间。 返回数据包格式：错误状态码，事件个数，发生事件槽位 号，事件编码，事件ID，事件描述，发生时间，事件参数 信息。事件自动上报

12、自动上报的数据为错误状态码，发生事件槽位号，事件编 码，事件ID，事件描述，发生时间，事件参数信息。6.4内部接口设计根据6.1中定义的系统内部接口、算法接口进行详细定义 样例：接口名称接口描述窗口查询根据窗口句柄遍历窗口联表，查询是否存在指定窗口获取开窗信号通道根据窗口跨屏的数量以及处理单元信息计算通道参数6.5通信接口设计对通信类接口进行详细设计 样例：侍节T(2字节 母亍JJ加辎ionlDCmcirDDataLenDataBody6.6硬件接口设计与硬件的总线的接口进行说明: 样例：接口名称通信协议Data总线宽度备注I2C串行总线协议8bit7 运行设计7.1 系统启动设计描述嵌入式软

13、件启动过程8 异常信息记录及处理设计8.1 异常情况分析对嵌入式系统可能出现的故障进行分析并定义类别，通常分提示性错误、一般错误、严 重错误、致命错误8.2 异常处理对策系统对异常情况必须做出处理，包括返回、告警提示等，系统作出处理应考虑实时性和 有效性8.3 异常信息记录设计时应考虑故障信息的记录方法,例如有文件系统的，应该提供日志功能；如果没有文 件系统的，可以提供网络远程记录9 容错设计对可靠性要求很高的系统应同时考虑硬件和软件的容错设计，而不能只考虑硬件容错设 计10 维护设计为了便于跟踪错误和调试代码，以便软件出现故障时提供有价值的参考信息，提高分析 问题和解决问题的效率，对调试信息的管理做出的设计。10.1 调试信息的缓冲区管理调试信息缓冲区的大小为128*16*1024bytes，每条信息的长度固定为128个字节，总共 可存储 16K 条的输出信息。当调试信息的长度超过127 个字节的长度时，第128 个字节到 最后一个字节的内容将被丢弃；当输出信息的数量超过可存储的大小时，将自动覆盖最旧的 打印信息。10.2 调试策略为了方便问题发生现场和开发等不同场合的调试，对程序中的调试信息的输出方式做了 动态策略设计。系统中将定义四类输出信息策略，调试