*openUBMC 支持CPU直出网口光模块故障告警功能详细设计说明书*

<table>
    <tr>
        <td>所属SIG组:</td>
        <td>hardware_sig</td>
    </tr>
    <tr>
        <td>落入版本:</td>
        <td>25.09</td>
    </tr>
    <tr>
        <td>设计人员:</td>
        <td>黄明浩+yelmh</td>
    </tr>
    <tr>
        <td>日期:</td>
        <td>2025.07.26</td>
    </tr>
</table>


**Copyright © 2025 openUBMC Community**

您对&quot;本文档&quot;的复制，使用，修改及分发受木兰宽松许可证, 第2版协议(以下简称&quot;MulanPSL2&quot;)的约束。
为了方便用户理解，您可以通过访问<https://license.coscl.org.cn/MulanPSL2>了解MulanPSL2的概要 (但不是替代)。
MulanPSL2的完整协议内容您可以访问如下网址获取：<https://license.coscl.org.cn/MulanPSL2>。

**改版记录**

<table>
    <tr>
        <th>日期</th>
        <th>修订版本</th>
        <th>修订描述</th>
        <th>作者</th>
        <th>审核</th>
    </tr>
    <tr>
        <td>xxx</td>
        <td>xxx</td>
        <td>xxx</td>
        <td>xxx</td>
        <td>xxx</td>
    </tr>
    <tr>
        <td>xxx</td>
        <td>xxx</td>
        <td>xxx</td>
        <td>xxx</td>
        <td>xxx</td>
    </tr>
</table>

**List of abbreviations**  **缩略语清单** ：

<table>
    <tr>
        <th>Abbreviations 缩略语</th>
        <th>Full spelling 英文全名</th>
        <th>Chinese explanation 中文解释</th>
    </tr>
    <tr>
        <td>xxx</td>
        <td>xxx</td>
        <td>xxx</td>
    </tr>
    <tr>
        <td>xxx</td>
        <td>xxx</td>
        <td>xxx</td>
    </tr>
</table>

[TOC]

# 1.功能分析
## 1.1 功能背景
<!-- 描述该需求的来源或背景，比如：支撑XXX功能、XXX优化等；以及该需求对用户（含组件）带来什么具体价值，如果没有该需求，对用户（含组件）带来什么损失； -->
支持CPU直出网口光模块故障告警，用户能够检测并处理光模块故障。

## 1.2 功能描述
<!-- 描述该需求交付的整体功能，主要实现XXX功能，解决XXX问题，明确方案如何实现 -->
支持CPU直出网口光模块故障告警，通过IMU或者其他方式获取对应属性用于告警，只支持Type为1并且网口介质类型为光口的NIC网卡。

## 1.3 功能场景
<!-- 描述该需求的业务使用场景，内容包括：
1) 场景出发条件及对象：什么角色/工具/接口等在什么具体情况下使用该特性，使用对象技能如何？
2) 使用时间及频度
3) 描述该特性主要有哪些场景、子场景及关键任务操作 -->
运维人员/工具可以通过对应告警检测光模块是否发生了故障。

## 1.4 功能列表
<!-- 描述该需求交付的功能列表，内容包括：列出功能详细描述，标题、描述。 -->
| 功能编号 | 功能标题 | 功能描述 |
| ------- | ------- | -------- |
| 1 | 支持CPU直出网口光模块故障告警 | 支持CPU直出网口光模块故障告警：光信号丢失（LoS）告警、发送偏置电流异常告警、发送光功率异常告警、接收光功率异常告警、发送故障（Tx Fault）告警、温度异常告警、电压异常告警 |

# 2.功能设计
## 2.1 总体方案分析
<!-- 描述该方案的总体设计（注：相关输出方案可同步刷新到各组件仓） -->
告警码已有，在对应网卡csr中配置告警对象。

### 2.1.1 方案详细设计
#### 2.1.1.1 方案概述
<!-- 描述该方案的整体实现，内容包括：涉及的关键点，实现策略等 -->
光信号丢失（LoS）告警 0x29000013 

发送偏置电流异常告警 0x29000011

发送光功率异常告警 0x29000017

接收光功率异常告警 0x29000017

发送故障（Tx Fault）告警 0x29000021

温度异常告警 低温 0x29000015 高温  0x0D000017

电压异常告警 0x2900000F

具体模拟触发告警见验证报告

| 描述                     | 告警码     | Reading                         | Condition                                                    | OperatorId |
| ------------------------ | ---------- | ------------------------------- | ------------------------------------------------------------ | ---------- |
| 光信号丢失（LoS）告警     | 0x29000013 | RxLoS，parent.LinkStatusNumeric |                                                              |            |
| 发送偏置电流异常告警     | 0x29000011 | TXBiasCurrentMilliAmps          | BC_TXUpperThresholdCritical,<br />BC_TXLowerThresholdCritical |            |
| 发送光功率异常告警       | 0x29000017 | RXInputPowerMilliWatts          | RXUpperThresholdCritical<br />RXLowerThresholdCritical       |            |
| 接收光功率异常告警       | 0x29000017 | TXOutputPowerMilliWatts         | Power_TXUpperThresholdCritical<br />Power_TXLowerThresholdCritical |            |
| 发送故障（Tx Fault）告警 | 0x29000021 | TxFaultState                    |                                                              |            |
| 温度异常告警 低温        | 0x29000015 | ReadingCelsius                  | TemperatureLowerThresholdCritical                            |            |
| 温度异常告警 高温        | 0x0D000017 | ReadingCelsius                  | TemperatureUpperThresholdCritical                            |            |
| 电压异常告警             | 0x2900000F | SupplyVoltage                   | VoltageLowerThresholdCritical<br />VoltageUpperThresholdCritical |            |



#### 2.1.1.2 开发视图
<!-- 开发视图面向系统开发及软件管理，描述系统代码结构，构建结构的视图，主要解决系统技术实现和开发的问题，它依托逻辑视图，描述代码、构建结构 -->
不涉及

#### 2.1.1.3 运行视图
<!-- 运行视图面向系统运行，描述系统启动过程、运行期交互的视图，主要解决系统运行期交互，描述各可执行交付件在运行期的交互关系 -->
不涉及

### 2.1.2 内部依赖分析
<!-- 是否涉及与其他组件接口依赖，如果涉及需要确认当前是否已完成，是否匹配当前需求开发诉求 -->
不涉及

### 2.1.3 外部依赖分析
<!-- 是否涉及与平台SDK的依赖关系 -->
不涉及新增依赖

### 2.1.4 北向接口分析
<!-- 需要分析当前功能是否有以下接口影响，如果有影响，则需要具体的补充影响点。其中注意点如下：
（1）如果有新增IPMI接口，请排查代码中IPMI命令注册的过滤字段，是否完全和IPMI命令的定义一致？
（2）新增一个接口时，需要咨询SIG组是否还有其他的接口受影响 -->

| 特性 | SNMP | CLI | WEB | KVM_VMM | IPMI(RMCP/RMCP+) | HMM | Redfish |
| ---- | ---- | ---- | --- | ------ | ---------------- | --- | ------- |
|  | NA | |  | NA | NA | NA |  |

### 2.1.5 兼容性分析
<!-- 当前的功能对现有在网的功能是否有影响，具体的影响点进行分析之后输出影响分析表格 -->
不涉及

### 2.1.6 定制化接口分析
<!-- 如果支持定制化设置，则需要给出定制化时的默认值（空定制化项条件下的设置值），如果涉及到定制化接口变更或新增，注意定制化接口文档需配套修改。注意定制化默认值变更对白牌包的影响 -->
不涉及

### 2.1.7 导入导出分析
<!-- 如果支持导入导出的配置，则需要分析导入导出的schema。 -->
不涉及

### 2.1.8 传感器分析
<!-- 如果需要新增传感器，则需要提前登记和评审新增的传感器要素。新增传感器评审需要上SIG-Interface进行评审 -->
不涉及

### 2.1.9 精准告警事件分析
<!-- 如果需要新增事件，则需要提前登记和评审新增的时间要素 -->
无新增时间

### 2.1.10 系统锁定分析
<!-- 对外的接口或者命令是否支持系统锁定 -->
不涉及

### 2.1.11 用例场景分析
<!-- 以表格的形式输出该需求涉及的用例场景 -->
| 用例编号 | 描述 | 用例步骤 | 用例预期 |
| ---- | ---- | ---- | --- |
| 1 | 光信号丢失（LoS）告警验证 | 打桩触发告警，打桩解除告警 | 正确产生消除告警 |
| 2 | 发送偏置电流异常告警验证 | 打桩触发告警，打桩解除告警 | 正确产生消除告警 |
| 3 | 发送光功率异常告警验证 | 打桩触发告警，打桩解除告警 | 正确产生消除告警 |
| 4 | 接收光功率异常告警验证 | 打桩触发告警，打桩解除告警 | 正确产生消除告警 |
| 5 | 发送故障（Tx Fault）告警验证 | 打桩触发告警，打桩解除告警 | 正确产生消除告警 |
| 6 | 温度异常告警验证 | 打桩触发告警，打桩解除告警 | 正确产生消除告警 |
| 7 | 电压异常告警 | 打桩触发告警，打桩解除告警 | 正确产生消除告警 |

## 2.2 非功能质量属性设计
### 2.2.1 扩展性分析
<!-- 考虑后续新增类似功能可以很好地扩展 -->
不涉及

### 2.2.2 重用性分析
<!-- 是否为通用处理方式、接口，如果是得考虑重用性 -->
不涉及

### 2.2.3 可测试性分析
<!-- 此需求如何验证，是否可直接验证，or通过XXX功能覆盖验证，or需要单独怎加测试接口验证 -->
一键日志收集即可验证

### 2.2.4 资料分析
<!-- 是否涉及资料修改 -->
不涉及

### 2.2.5 资源使用分析
<!-- 新增线程、内存分配、模型属性名长度是否合理，CPU占用率是否会激增，Flash中新增文件是否合理（频繁读写Flash会大幅缩短emmc寿命）；是否涉及消息队列，如果涉及请检查是否存在某些场景下消息队列会满导致消息丢失，例如大量消息发送到队列且处理消息需要耗费较长时间的场景。 -->
不涉及

### 2.2.6 可靠性分析
| 编号 | 场景 | 问题描述 | 可靠性影响 | 问题级别 | 建议解决方案/需求 | 讨论结果 | 跟踪人 | 备注 |
| --- | --- | --- | --- | --- | --- | --- | --- | --- |
| 1 | DC场景 |不涉及|不影响||||||
| 2 | AC场景 |不涉及|不影响||||||
| 3 | BMC场景 |不涉及|不影响||||||
| 4 | 服务重启 |不涉及|不影响||||||
| 5 | 数据获取异常状态 |异常值正确打印|不影响||||||
### 2.2.7 安全性分析
| 安全合规项 | 是否涉及 | 现有的防护措施 |
| --- | --- | --- |
| 访问控制（通道、文件权限、用户权限、查询权限、配置权限、接口权限） |  不涉及|  |
| 敏感数据 | 不涉及 |  |
| 日志（操作日志、维护日志、安全日志、运行日志）不涉及 |          |  |
| 文档 | 不涉及 |  |
| 加密及算法 | 不涉及 |  |
| 新增关键资源（密钥、证书、关键配置）备份、恢复 | 不涉及 |  |
| 新增对外接口入参校验 | 不涉及 |  |
| 新增开源及三方软件引入 |不涉及  |  |
# 3.功能实现
<!-- 通过表格、流程图、简明文字描述提供，力求容易看懂、容易实现，详细描述细节。 -->
## 3.1【功能编号】支持XXX功能实现
### 3.1.1 功能实现设计
不再赘述
### 3.1.2 功能详细设计
不再赘述
### 3.1.3 开发者测试
<!--
增加模块接口：以活动图/流程图等形式明确模块内处理流程，针对模块处理流程中的分支进行覆盖
修改模块接口处理流程：覆盖修改影响流程分支
-->
#### 3.1.3.1 单元测试
<!-- UT，主要是功能单元测试，测试对象是功能单元接口。UT测试设计要从黑盒（功能）角度设计，从输入(I)、处理（B）、预期输出（O）的角度进行用例分析设计，测试覆盖率仅作为反馈，用于分析哪些功能场景没有覆盖到，从而指导测试设计优化并补充测试用例 -->
无组件仓代码修改，不涉及

#### 3.1.3.2 集成测试
<!-- IT，主要是组件/模块内的集成测试，测试对象是模块/组件接口。IT测试设计将模块/组件当作黑盒测试，IT测试用例中禁止对组件/模块内部代码打桩，如果确实有少量场景难以构造，可以考虑在测试框架中统一打桩并提供接口供测试用例调用构造场景。
说明：API测试属于IT，其测试对象是微服务接口。
PCST，是指PC上的服务集成测试，测试对象是功能需求。PCST测试设计，要覆盖正常功能、异常功能和交叉功能，采用灰盒 -->
不涉及