USB升级模块项目需求说明书.docx

1、USB升级模块项目需求说明书文 档 编 号版本号密级JL-TD01-XMBH-KHBH-PRV1.00机密项目需求说明书文档作者：朱海峰日期：2011-10-19项目经理：日期：审 核：日期：批 准：日期：文档历史发放及记录序号变更（+/-）说明作者版本号日期批准1创建朱海峰1.02011-10-19文档简要功能及适用范围1. 文档的简要功能详细说明USB升级模块功能要求；提供模块设计工作的文档支持。2. 文档的适用范围本文档适用于公司内部软件开发人员，为应用软件添加USB升级功能。目 录1、 引言 41.1 背景 41.2 模块信息 41.3 术语和缩略语 41.4 参考资料 52、 项目概

2、述 52.1 目标 52.2 与其他产品之间的关系 52.3 用户的特点 62.4 假定和约束 63、 功能需求 73.1 功能1 73.2 功能2 73.3 功能3 73.4 功能4 83.5 功能5 83.6 功能6 83.7 功能7 83.8 功能8 83.9 功能9 93.10 功能10 93.11 功能11 94、 属性需求 94.1 性能 94.2 易用性 104.3 安全性 104.4 可维护性 104.5 可靠性 104.6 灵活性 114.7 可移植性 115、 用户界面要求 116、 硬件需求 111、 引言1.1 背景简要说明该产品的市场背景和主要特点。目前，我们的软件中

3、有相关的USB升级模块，但是功能上、设计上都没有很好的规划过。这使得在实际应用中，我们还是会不断的做重复性的工作。同时，相关的文档，代码质量等指标，也都没有达到一定的要求。1.2 模块信息模块名称：USB升级模块任务提出者：袁同斌用户：软件开发人员任务开发者：朱海峰1.3 术语和缩略语对文中使用的术语和缩略语进行说明。缩略语/术语全 称说 明1.4 参考资料编写本文档时引用或参考的文档资料、有关标准等。2、 项目概述2.1 目标叙述该项产品开发的意图、应用目标、作用范围以及其他应向读者说明的有关该产品开发的背景材料。 目前，USB升级模块还只是在功能上满足相关的要求，但是作为一个公用模块，还没

4、有经过很好的模块化处理，代码质量以及相关文档等，都还不符合要求。通过对该功能模块的整理工作，为软件开发人员提供公版USB升级功能模块，使其在实际应该中，不需要考虑模块功能的具体实现，而只需要处理相关的移植工作。从而减少开发人员的工作，提高其工作效率，同时也提高我们的软件质量。同时也为维护模块的人员，提供相关文档，减少维护工作的难度。2.2 与其他产品之间的关系解释被开发产品与其他有关产品之间的关系。如果本产品是一项独立的产品，而且全部内容自含，则说明这一点。如果所定义的产品是一个更大的系统的一个组成部分，则应说明本产品与该系统中其他各组成部分之间的关系，为此可使用一张方框图来说明该系统的组成和

5、本产品同其他各部分的联系和接口。如图示，USB升级模块属于应用层的一个通用功能模块，在实际项目中应用比较广泛。模块内部实现相关升级的功能，对外提供相关接口，为功能模块提供平台、菜单等级别的功能支持。本模块作为一个独立的模块，提供给只要求USB升级功能的项目使用。不应该将其移植到USB多媒体应用模块中，为其提供升级功能，因为USB多媒体应用模块中已经包含升级功能。2.3 用户的特点列出本系统的最终用户的特点，充分说明操作人员、维护人员的教育水平和技术专长，以及本系统的预期使用频度。这些是产品设计工作的重要约束。使用者：公司内部员工，通常已经具备了相当水平的工作经验和技能，但对于该模块功能以及实际

6、应用了解程度不一。使用频度：较大。在通常的项目中，只要是STB配备USB接口，通常情况下都使用了该功能。2.4 假定和约束列出进行本产品开发工作的假定和约束，例如经费限制、开发期限等。 约束1、U盘要求：文件系统格式为fat、fat32、exfat，对U盘容量等其它指标没有要求2、升级文件格式：*.img或*.IMG3、指定升级文件在U盘中的路径：U盘根目录：update4、在指定文件夹下，只存放一个升级文件5、升级过程进度显示，条件满足时均采用细精度显示。否则采用阶段性的进度显示6、多Flash情况下（高清平台），只处理同一片选的情况，即只处理同一个Flash中的数据升级 假定1、升级过程中

7、，不会出现断电等意外错误操作2、待移植软件中，USB驱动及Flash驱动工作正常3、U盘能正常使用4、Flash操作大量数据时稳定性高，不会出错3、 功能需求逐项定量和定性地叙述对系统所提出的功能要求。3.1 功能1到U盘指定路径，读取升级文件，并存储到内存中。3.2 功能2校验读取到的升级文件的IMG头信息，同Loader的相关版本信息做比较。提供强制升级和限制升级两种升级方式的校验处理。 强制升级：比较OUI、厂商号和硬件版本号。 限制升级：比较OUI、厂商号、硬件版本号、软件版本号。其他条件暂时不作考虑，有实际需求时再处理。进行数据的CRC校验。3.3 功能3判断升级文件IMG头Flag

8、标志位，进行升级数据是否去IMG头的处理。(适用于素材、字库等情况)3.4 功能4判断升级文件IMG头中的文件数据类型Image_type，来处理升级多Flash情况时（高清平台），写在哪个Flash上，调用相应的Flash处理函数。3.5 功能5升级附加数据。因为软件根据整个升级文件大小来进行数据保存处理，所以可以升级附加数据。若需要升级附加数据，只需要保证升级文件中第一个部分数据是一个完整的正确的IMG文件。在升级文件的后面连接上其他的附加数据，要求连接过程中不能改变第一个部分数据的IMG头信息，如IMG长度与CRC值。同时还要保证附加数据对应到Flash中的偏移地址正确。附加数据的长度，

9、不应该超出由升级文件IMG头（即第一个部分IMG文件的IMG头中，对应的数据类型Image_type）所确定的Flash的地址空间大小。即必须保证升级文件，即使加上了附加数据，都只能在同一个Flash中进行升级。3.6 功能6将正确的升级文件数据保存到Flash中。保存数据和过程中，需要考虑如APP分块等数据存储Flash空间不连续的情况。3.7 功能7显示升级过程。若升级过程中出错，显示相应的错误信息。3.8 功能8升级完成后，自动重启机顶盒。3.9 功能9提供平台级别的外部接口：Flash相关读写调用接口，测试接口。提供菜单显示级别的外部接口：将菜单分离出来。3.10 功能10提供前面板显

10、示接口。3.11 功能11预留其它升级文件格式的支持空间。（同升级文件想找过虑、以及文件信息校验相关。）4、 属性需求4.1 性能说明对于该产品的性能要求，如：开机时间、升级时间、应用启动时间、换台时间、遥控器和前面板按键的响应速度等。1、升级模块时间性能，主要受两个部分影响： 大数据量时的CRC校验； Flash擦写与保存数据。2、多Flash情况下，若需要升级附加数据，附加数据所保存的位置（偏移地址+长度）不能超出当前需要保存至的Flash的地址空间。也就是说，整个升级文件的升级数据，不能跨Flash进行升级，否则会出错，因为不同的Flash操作也不同。4.2 易用性 用户易于使用的要求，

11、如对菜单风格、操作方式、使用手册的要求。提供尽量少的平台与菜单配置接口，减少配置功能。提供尽量少的模块功能调用接口，方便调用该功能模块。提供相关的功能测试接口，方便了解和排查问题。提供调试、测试等不同级别的打印。4.3 安全性 这里指的是保护软件的要素，以防止各种非法的访问、使用，修改、破坏或者泄密等。 1、USB升级过程中，不能出现断电等意外情况，否则机顶盒升级失败，将无法再正常使用，必需重新烧写软件。2、允许开发人员进行修改，但是修改内容要求一定要做出书面报告，并提交至R版本管理组，重新审定修改，再入库、重发布。4.4 可维护性这里规定若干需求以确保软件是可维护的。完善功能需要，达到尽量全

12、面的考量。梳理和完善设计思路，提供设计报告，为维护提供支持。提供模块测试接口，支持维护工作。提供移植文档说明。4.5 可靠性要求升级过程中，不能出现断电等意外情况。因此而造成的升级失败是不可逆的。4.6 灵活性说明对该软件的灵活性的要求，即当需求发生某些变化时，该软件对这些变化的适应能力，如：操作方式上的变化；运行环境的变化；同其他软件的接口的变化；精度和有效时限的变化等。4.7 可移植性把软件从一种环境移植到另一种环境所要求的兼容方面的约束。提供移植文档。提供平台级别的接口，将模块对平台的依赖部分分离，增加可移植性。5、 用户界面要求允许定制特定界面。需要使用者提供进度显示接口。6、 硬件需求硬件需求基本能在规格说明书中描述。若规格说明书未完全确定，则可在此文档里补充，包括：技术参数、结构特征、硬件接口说明等。项目应用提供USB硬件接口。