产品软件产测接口设计标准文档讲解.doc

T&W COMMUNICATIONS, INC.

产品软件产测接口设计文档

Document Version
Date
Version
Written By
Remark
Oct 21, 2011
1.0
Huang Liang
1st released template

目录
1 总体说明 3
2 接口图例 3
3 接口说明 4
3.1 基础功能测试接口类型 4
3.1.1 写入MAC 4
3.1.2 检查MAC 4
3.1.3 写入SN 4
3.1.4 检查SN 4
3.1.5 按键测试 5
3.1.6 LED测试 5
3.1.7 USB测试 6
3.1.8 软件版本测试 6
3.1.9 硬件版本测试 6
3.1.10 LAN/WAN口测试 7
3.1.11 恢复出厂默认配置测试 7
3.2 主要功能测试接口类型 7
3.2.1 ADSL功能接口 <光通产品取消此项> 7
3.2.2 WiFi功能接口 7
3.2.3 PON功能接口 11
3.2.4 VoIP功能接口 11
3.3 软件初始状态 12
3.4 特殊功能测试接口类型 12

1 总体说明
产品软件产测接口设计标准，是产测软件针对我司目前工厂生产测试的状况对产品软件提出可生产可测试性功能模块的00000000000000000000000000000000000000000000000000000 `。
该接口设计标准按照接口类型可分成三大类。一、基础功能测试接口类型；二、主要功能测试接口类型（包括：DSL功能测试接口类型、WiFi功能测试接口类型、PON功能测试接口类型、PLC功能测试接口类型<暂无>、VoIP功能测试接口类型…）；三、特殊功能测试接口类型。
由于我司产品种类众多，软件平台有好多种。比如DSL事业部的BCM 3.X，BCM 4.02，BCM 4.06，BCM 4.10，ikanos，osk，RTL Linux原版，TBS，conxant；光通事业部的PMC，MARVAELL，TK，TBS，BCM 3.X，BCM 4.X；无线事业部的TBS，应用事业部的Atheros（原Intellon），Broadcom（原Gigle）...等平台。每一种平台相对应的产测软件接口都不太一致。为了描述方便，本文将重点采用TBS平台的产测软件接口部分，对产测软件的接口设计标准进行详细说明。
2 接口图例
产测软件接口设计可参考下列例子：
测试项
实现接口
输入
输出
需求说明
写入MAC
Telnet
protest --mac -w mac
成功：success；失败：false
如何写入MAC
检查MAC
Telnet
protest --mac -r
返回MAC的值
如何检查MAC
实现接口部分要求：必须采用网口访问的方式。原则上要求采用Telnet。不接受使用Console方式（如此项存在分歧，请提交事业部总经理进行协调）
该接口设计信息交互要求：一、必须是双向的，即有输入有输出；二、输出信息需明确定义出成功和失败，返回值部分建议采用success、false，不接受采用1、0、空、提示符。
3 接口说明
3.1 基础功能测试接口类型
3.1.1 写入MAC
接口名：protest --mac -w xxxxxxxxxxxx
接口说明：执行写入产品MAC地址操作
接口元素：执行成功，返回success；执行失败，返回false；
其它补充说明：如产品具备多个MAC时，需弄清楚产品出货时帖子产品外壳上的MAC标贴为哪个标贴，它与“写入MAC”命令中的MAC的关系为何。
3.1.2 检查MAC
接口名：protest --mac -r
接口说明：执行检查产品MAC地址操作
接口元素：执行成功，返回Mac地址；
其它补充说明：产品写入多少MAC，则要求检查多少MAC。比如产品写入LANMAC、WANMAC，则产测软件必须检查LANMAC、WANMAC。
3.1.3 写入SN
接口名：protest --sn -w sn xxxxxx
接口说明：执行写入产品SN操作
接口元素：执行成功，返回success；执行失败，返回false；
其它补充说明：该功能项可依据实际需求选择是否开发。有时候客户是不需要写入SN。
3.1.4 检查SN
接口名：protest --sn -r
接口说明：执行写入产品MAC地址操作
接口元素：执行成功，返回SN号；
其它补充说明：如写入SN有需求，则此功能项必须开发。
3.1.5 按键测试
该功能项主要实现对按键硬件功能进行测试，即检测按键是否可以被成功按下即可。该功能项可以细分为3个接口需求：
3.1.5.1 禁用按键正常功能
接口名：Protest --button -ban
接口说明：禁用按键正常功能，进入按键测试模式，如Reset按键被禁用正常功能后，按下Reset按键要求产品不执行重起操作。
接口元素：执行成功，返回success；执行失败，返回false；
其它补充说明：在执行按键测试时，会先执行此操作。
3.1.5.2 恢复按键正常功能
接口名：protest --button -resume
接口说明：恢复按键正常功能，退出按键测试模式
接口元素：执行成功，返回success；执行失败，返回false；
其它补充说明：如产品具备多个MAC时，需弄清楚产品出货时帖子产品外壳上的MAC标贴为哪个标贴，它与“写入MAC”命令中的MAC的关系为何。
3.1.5.3 获取按键信息
接口名：protest --button -r
接口说明：检测按键是否被按下
接口元素：执行成功，返回“reset:[time];wlan:[time];wps:[time];”；time表示按钮按下的时间，单位：s；以6位字符串表示；如果全为0，表示此按钮没有进行按下操作
其它补充说明： 无。
3.1.6 LED测试
该功能项主要实现对LED硬件功能进行测试，即检测LED是否可以被点亮以及被关闭。该功能项可以细分为2个接口需求
3.1.6.1 LED全亮
接口名：Protest --led -on
接口说明：控制所有的LED全亮；
接口元素：执行成功，返回success；执行失败，返回false；
其它补充说明：无。
3.1.6.2 LED全灭
接口名：Protest --led -off
接口说明：控制所有的LED全灭。
接口元素：执行成功，返回success；执行失败，返回false；
其它补充说明：无
3.1.7 USB测试
接口名：protest --usb
接口说明：执行USB硬件功能检测操作。（当 U 盘接上后，产品软件会检测U盘是否安装完成，然后在产品软件中提供一个命令，当这个命令执行时，产品软件自己去读一下U盘，确认可以读到数据就可以通过，然后返回一个结果。我们在生产测试时，用程序自动下这个命令，如果返回成功就通过，不成功就失败。）
接口元素：执行成功，返回USB信息；
其它补充说明：如产品拥有2个或以上的USB口，则输出部分需要区分出哪个USB口被检测到。
3.1.8 软件版本测试
接口名：protest --software -r
接口说明：执行产品软件版本检查操作
接口元素：执行成功，返回产品软件版本信息；
其它补充说明：无。
3.1.9 硬件版本测试
接口名：protest --hardware -r
接口说明：执行产品硬件版本检查操作
接口元素：执行成功，返回产品硬件版本信息；
其它补充说明：无。
3.1.10 LAN/WAN口测试
接口名：protest --lanwantest -r
接口说明：执行LAN WAN口测试操作。
接口元素：执行成功，返回“W0=M;L1=M;L2=M;L3=M;L4=M;”；返回值的定义：W0代表第一个Wan口；L1代表第一个Lan口；L2代表第二个Lan口；M代表10/100 Mbps；G代表1000 Mbps；N代表Not Active
其它补充说明：将Lan、Wan口全部与交换机相连，通过产品软件自检来判断产品的LAN/WAN口功能是否正常。
3.1.11 恢复出厂默认配置测试
所有的产品如非特殊要求，一律需要执行恢复出厂默认配置操作才能出货。该操作如非特殊说明，一律放在所有写值测试项之后。该功能项可细分为2个功能项：
3.1.11.1 执行恢复出厂默认配置操作
接口名：protest --restore
接口说明：执行恢复出厂默认配置操作；
接口元素：执行成功，返回success；执行失败，返回false；
其它补充说明：无。
3.1.11.2 检查产品是否处于恢复出厂默认配置状态
接口名：protest --restore -status
接口说明：检查产品是否处于恢复出厂默认配置状态；
接口元素：执行成功，返回success；执行失败，返回false；
其它补充说明：产品在作镜像文件时，需将此状态为工厂模式，即非恢复出厂默认配置模式。

3.2 主要功能测试接口类型
3.2.1 ADSL功能接口 <光通产品取消此项>
3.2.2 WiFi功能接口
该功能项可以细分为：
3.2.2.1 无线加密功能测试
3.2.2.1.1 启用无线加密功能
接口名：protest --wlan -wep enable
接口说明：实现启用无线加密功能操作；
接口元素：执行成功，返回success；执行失败，返回false；
其它补充说明：无。
3.2.2.1.2 禁用无线加密功能
接口名：protest --wlan -wep disable
接口说明：实现禁用无线加密功能操作；
接口元素：执行成功，返回success；执行失败，返回false；
其它补充说明：无。
3.2.2.2 无线QoS功能测试
3.2.2.2.1启用无线QoS功能
接口名：protest --wlan -wmm enable
接口说明：实现启用无线QoS功能操作；
接口元素：执行成功，返回success；执行失败，返回false；
其它补充说明：无。
3.2.2.2.2 禁用无线QoS功能
接口名：protest --wlan -wmm disable
接口说明：实现禁用无线QoS功能操作；
接口元素：执行成功，返回success；执行失败，返回false；
其它补充说明：无。
3.2.2.3 无线SSID测试
3.2.2.3.1 查看产品无线SSID
接口名：protest --ssid -r
接口说明：实现检查产品无线SSID操作；
接口元素：执行成功，返回产品当前无线SSID；
其它补充说明：无。
3.2.2.3.2 写入产品无线SSID
接口名：protest --ssid -w ssid
接口说明：实现写入产品无线SSID操作；
接口元素：执行成功，返回success；执行失败，返回false；
其它补充说明：无。
3.2.2.4 无线信道测试
3.2.2.4.1 查看产品无线信道
接口名：protest --channal -r
接口说明：实现检查产品当前无线信道操作；
接口元素：执行成功，返回产品当前无线信道；
其它补充说明：无。
3.2.2.4.2 写入产品无线信道
接口名：protest --channal -w channal
接口说明：实现设置产品当前无线信道操作；
接口元素：执行成功，返回success；执行失败，返回false；
其它补充说明：无。
3.2.2.5 无线国家代码测试
3.2.2.5.1 查看产品无线国家代码
接口名：protest --code -r
接口说明：实现检查产品当前无线国家代码操作；
接口元素：执行成功，返回产品当前无线国家代码；
其它补充说明：无。
3.2.2.5.2 写入产品无线国家代码
接口名：protest --code -w country code
接口说明：实现设置产品当前无线国家代码操作；
接口元素：执行成功，返回success；执行失败，返回false；
其它补充说明：无。
3.2.2.6 无线频偏测试
3.2.2.6.1 查看产品无线频偏Gain值
接口名：protest --address -r -l
接口说明：实现检查产品当前无线频偏Gain值操作；
接口元素：执行成功，返回产品当前无线频偏Gain值；
其它补充说明：无。
3.2.2.6.2 写入产品无线国家代码
接口名：protest --address -w -l value
接口说明：实现设置产品当前无线频偏Gain值操作；
接口元素：执行成功，返回success；执行失败，返回false；
其它补充说明：无。
3.2.2.7 无线功率测试
3.2.2.7.1 查看产品无线功率Gain值
接口名：protest --address -r -l
接口说明：实现检查产品当前无线功率Gain值操作；
接口元素：执行成功，返回产品当前无线功率Gain值；
其它补充说明：无。
3.2.2.7.2 写入产品无线功率Gain值
接口名：protest --address -w -l value
接口说明：实现设置产品当前无线功率Gain值操作；
接口元素：执行成功，返回success；执行失败，返回false；
其它补充说明：无。
3.2.2.8 无线速率测试
3.2.2.8.1 查看产品无线速率
接口名：protest --wlan -rate -r
接口说明：实现检查产品当前无线速率值操作；
接口元素：执行成功，返回产品当前无线速率；
其它补充说明：无。
3.2.2.8.2 设置产品无线速率
接口名：protest --wlan -rate -w xx
接口说明：实现设置产品当前无线速率操作；
接口元素：执行成功，返回success；执行失败，返回false；
其它补充说明：无。

3.2.3 PON功能接口
该功能项可以细分为：
3.2.3.1 光功率测试
3.2.3.1.1 长发光功能
接口名：protest --laser on
接口说明：实现产品光功率长发光功能操作；
接口元素：执行成功，返回success；执行失败，返回false；
其它补充说明：无。
3.2.3.1.2 关闭长发光功能
接口名：protest --laser off
接口说明：实现关闭产品光功率长发光功能操作；
接口元素：执行成功，返回success；执行失败，返回false；
其它补充说明：无。

3.2.4 VoIP功能接口
该功能项可以细分为：
3.2.4.1 VoIP启动状态查询
接口名：protest -voip status
接口说明：可查询产品VoIP功能模块是否启动完成；
接口元素：执行成功，返回success；执行失败，返回false；
其它补充说明：无。
3.2.4.2 打开VoIP工厂测试模式
接口名：protest -voip on
接口说明：实现进入工厂VoIP测试模式操作；
接口元素：执行成功，返回success；执行失败，返回false；
其它补充说明：该VoIP工厂测试模式有别于正常的VoIP测试，需要对此单独开发。由于该模块有一定的复杂度，在此不进行说明。详细描述请参考文档《VoIP工厂测试模式.xls》 。

3.2.4.3 关闭VoIP工厂测试模式
接口名：protest -voip off
接口说明：实现关闭工厂VoIP测试模式操作；
接口元素：执行成功，返回success；执行失败，返回false；
其它补充说明：无。

3.3 软件初始状态
SSID名称：test_ssid
说明：有相同的ssid亦可。
telnet状态：打开
说明：烧录后即可telnet登陆
IP：与复位后IP保持一致
说明：相同的IP有利于生产的一致性

其它补充说明：该状态为烧录flash后的状态，可大幅提高可生产测试性。

3.4 特殊功能测试接口类型
此类接口类型不存在普遍性，只存在某些比较特殊的项目上，另外有一部分需求来源于某些客户的特殊要求。因此在此将不对该类型接口进行统计以及描述。不过需要强调的是，如遇到此类需求，其接口部分请沿用“接口图例”中给出的规范以及要求。

产品软件产测接口设计文档 12