*openUBMC xx功能详细设计说明书*

<table>
    <tr>
        <td>所属SIG组:</td>
        <td>hardware</td>
    </tr>
    <tr>
        <td>落入版本:</td>
        <td>openUBMC26.00</td>
    </tr>
    <tr>
        <td>设计人员:</td>
        <td>黄鼎</td>
    </tr>
    <tr>
        <td>日期:</td>
        <td>2026.01.10</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优化等；以及该需求对用户（含组件）带来什么具体价值，如果没有该需求，对用户（含组件）带来什么损失； -->
在之前的PCIe卡告警流程中，系统告警由bios传递给sdk模块，之后sdk将设备的rootBDF和告警值发送到pcie_device组件实现告警。

在JBOX场景中，链路存在PCIeSwitch，相关转接关系如图1，操作系统内部可以观察到PCIeSwitch设备，但在BMC管理的机框中不存在PCIeSwitch以及下挂的PCIe卡，告警需要使用软件方式。

```mermaid
graph TD
    System1 --> bri2[PCIe_Bridge【0000:16:00.0】]:::prupleNode

    bri2 --【0000:17:00.0】--> sw1[PCIe_Switch【0000:18:00.0】]:::greenNode
    sw1 --> pcie2[PCIeDevice2【0000:19:00.0】]:::greyNode
    sw1 --> pcie3[PCIeDevice3【0000:1a:00.0】]:::greyNode

    classDef greenNode fill:#ccff99,stroke:#00ff00
    classDef greyNode fill:#e0e0e0,stroke:#404040
    classDef prupleNode fill:#cc99ff,stroke:#6600cc
```
<center> 图1. 系统视角的JBOX设备 </center>

## 1.2 功能描述
<!-- 描述该需求交付的整体功能，主要实现XXX功能，解决XXX问题，明确方案如何实现 -->
主要支持以下告警：

| 告警码 | 对应RPC方法 |
| ----- | ----------- |
| 0x08000001 | SetUCEByBIOS |
| 0x08000065 | SetPredictiveFault |
| 0x080000F3 | SetLinkSpeedReduced |
| 0x0800006F | SetBandWidthReduction |

## 1.3 功能场景
<!-- 描述该需求的业务使用场景，内容包括：
1) 场景出发条件及对象：什么角色/工具/接口等在什么具体情况下使用该特性，使用对象技能如何？
2) 使用时间及频度
3) 描述该特性主要有哪些场景、子场景及关键任务操作 -->

上报PCIe设备错误。

## 1.4 功能列表
<!-- 描述该需求交付的功能列表，内容包括：列出功能详细描述，标题、描述。 -->
| 功能编号 | 功能标题 | 功能描述 |
| ------- | ------- | -------- |
| 1 | 上报UCE错误 | 设置JBOX设备UCE故障 |
| 2 | 上报预故障告警 | 设置JBOX设备预故障告警 |
| 3 | 上报降速率事件 | 设置JBOX设备降速率事件 |
| 4 | 上报降带宽事件 | 设置JBOX设备降带宽事件 |

# 2.功能设计
## 2.1 总体方案分析
<!-- 描述该方案的总体设计（注：相关输出方案可同步刷新到各组件仓） -->

sdk接收到bios上报的故障事件，会判断是否是发送到pcie_device里

### 2.1.1 方案详细设计
#### 2.1.1.1 方案概述
<!-- 描述该方案的整体实现，内容包括：涉及的关键点，实现策略等 -->

```mermaid
graph TD
    Bios([bios]) --> sdk[/bios上报故障/]
    sdk --> pcie[/sdk向通过rootBDF向pcie_device上报故障/]
    pcie --> if_report_success{上报成功}
    if_report_success --是--> normal_alarm[/旧告警流程/]
    if_report_success --否--> jbog_alarm[/尝试通过deviceBDF的方式触发告警/]
    jbog_alarm --> is_jbog_obj{是否是JBOG设备}
    is_jbog_obj --是--> soft[/设置软件告警/]
    is_jbog_obj --否--> alarm_error[/返回错误/]
```

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

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

Sdk触发告警逻辑如下：
```mermaid
sequenceDiagram
    participant Bios
    participant Sdk
    participant pcie_device

    Bios->>Sdk: 上报带内告警信息
    Sdk->>Sdk: 递归查找RootBDF
    Sdk->>pcie_device: 通过RootBDF触发告警
    pcie_device->>Sdk: 返回告警状态返回值
    alt 失败
        Sdk->>pcie_device: 通过DevBDF触发告警
        pcie_device->>Sdk: 返回告警状态返回值
    end
```

pcie_device返回告警状态返回值逻辑如下：
```mermaid
sequenceDiagram
    participant Sdk
    participant pcie_device

    Sdk->>pcie_device: 调用触发告警rpc方法
    pcie_device->>pcie_device: 查看是否是RootBDF
    alt 是
        pcie_device->>pcie_device: 按原来方式触发告警
    else
        pcie_device->>pcie_device: 向上找一级RootBDF
        alt 是JBOG设备
            pcie_device->>Sdk: 返回告警成功
        else
            pcie_device->>Sdk: 返回告警失败
        end
    end
```

另外，检测到下电信息时，pcie_device要去消除告警

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

### 2.1.3 外部依赖分析
<!-- 是否涉及与平台SDK的依赖关系 -->
依赖新版本的Sdk实现功能

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

### 2.1.5 兼容性分析
<!-- 当前的功能对现有在网的功能是否有影响，具体的影响点进行分析之后输出影响分析表格 -->
| pcie_device | sdk | 影响分析 |
| ----------- | --- | ------- |
| 新          | 新   | 无影响，支持新功能  |
| 旧          | 旧   | 无影响，但不支持新功能  |
| 旧          | 新   | 无影响，但不支持新功能  |
| 新          | 旧   | 无影响，但不支持新功能  |

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

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

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

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

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

### 2.1.11 用例场景分析
<!-- 以表格的形式输出该需求涉及的用例场景 -->
| 编号 | 场景描述 |
| --- | -------- |
| Case1 | 带内上报错误 |

### 2.1.12 装备能力差异分析
<!-- 当前功能是否在装备版本和Release版本中存在能力差异，若有差异需要进行说明 -->
不涉及

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

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

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

| 编号 | 用例描述 | 环境要求 | 测试步骤 | 预期结果 |
| --- | -------- | -------- | ------- | ------- |
| Case1 | 测试上报UCE错误 | 环境存在Bios，可以上报ipmi命令 | 在带内报送UCE错误（通过RASTool） | 显示0x08000001软件告警 |
| Case2 | 测试上报预故障告警 | 环境存在Bios，可以上报ipmi命令 | 在带内报送预故障告警（通过RASTool） | 显示0x08000065软件告警 |
| Case3 | 测试上报降速率事件 | 环境存在Bios，可以上报ipmi命令 | 在带内报送降速率事件（通过RASTool） | 显示0x080000F3软件告警 |
| Case4 | 测试上报降带宽事件 | 环境存在Bios，可以上报ipmi命令 | 在带内报送降带宽事件（通过RASTool） | 显示0x0800006F软件告警 |
### 2.2.4 资料分析
<!-- 是否涉及资料修改 -->
不涉及

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

### 2.2.6 可靠性分析
| 编号 | 场景 | 问题描述 | 可靠性影响 | 问题级别 | 建议解决方案/需求 | 讨论结果 | 跟踪人 | 备注 |
| --- | --- | --- | --- | --- | --- | --- | --- | --- |
| 1 | DC场景 ||||||||
| 2 | AC场景 ||||||||
| 3 | BMC场景 ||||||||
| 4 | 服务重启 ||||||||
| 5 | 数据获取异常状态 ||||||||

### SFEMA
| 用例编号 | 正交步骤 | 故障模式 | 故障影响 | 容错措施 | 故障注入方法 | 备注 |
| ------- | -------- | ------- | ------- | -------- | ----------- | ----- |
| Case1   | 访问拓扑数据库中没有对应BDF | 部分消息失败 | 无法判断是否是JBOX设备 | 获取失败时先查看是否有尚未落盘的拓扑数据，等所有数据落盘时若还没有，不告警 | 手动上报不存在拓扑数据库中的BDF | 无 |

### 2.2.7 安全性分析
| 安全合规项 | 是否涉及 | 现有的防护措施 |
| --- | --- | --- |
| 访问控制（通道、文件权限、用户权限、查询权限、配置权限、接口权限） | 不涉及 |  |
| 敏感数据 | 不涉及 |  |
| 日志（操作日志、维护日志、安全日志、运行日志） | 不涉及 |  |
| 文档 | 不涉及 |  |
| 加密及算法 | 不涉及 |  |
| 新增关键资源（密钥、证书、关键配置）备份、恢复 | 不涉及 |  |
| 新增对外接口入参校验 | 不涉及 |  |
| 新增开源及三方软件引入 | 不涉及 |  |
# 3.功能实现
<!-- 通过表格、流程图、简明文字描述提供，力求容易看懂、容易实现，详细描述细节。 -->
## 3.1【功能编号】支持接收bios发送的带内拓扑信息功能实现
### 3.1.1 功能实现设计

产生的告警信息如下：
"JBOG PCIe Card(BOXID: %s SWID: %s SLOT:IO%s-%s BDF:%x:%x.%x)", box_id, switch_id, type_id, slot_number, bus, device, func

因此需要获取box_id, switch_id, type_id, slot_number, bus, device, func这些参数，其中box_id, switch_id, type_id, slot_number包含在SystemsPCIeTopoInfo对象的Slot和Reserved1中，规则如下：

JBOG设备使用13位的Physical Slot Number，其中低8位由Slot承载，高5位由Reserved1承载

<table border = "1" cellspacing = "0" cellpadding = "4"
    style = "border-collapse:collapse">
    <tr>
        <th> bit 12 </th>
        <th> bit 11 </th>
        <th> bit 10 </th>
        <th> bit 9 </th>
        <th> bit 8 </th>
        <th> bit 7 </th>
        <th> bit 6 </th>
        <th> bit 5 </th>
        <th> bit 4 </th>
        <th> bit 3 </th>
        <th> bit 2 </th>
        <th> bit 1 </th>
        <th> bit 0 </th>
    </tr>
    <tr>
        <th> BOX ID </th>
        <td colspan = "4"> Switch ID </td>
        <td colspan = "3"> 丝印X </td>
        <td colspan = "5"> 丝印Y </td>
    </tr>
    <tr>
        <th> BOX ID </th>
        <td colspan = "4"> 0x0C - Switch 0</br>0x0D - Switch 1</br>0x0E - Switch 2</br>0x0F - Switch 3 </td>
        <td colspan = "3"> 0-8 </br>SW最多挂4个 </td>
        <td colspan = "5"> 0-31</br>SW最多挂16个 </td>
    </tr>
</table>



设置告警和故障的rpc方法如下（以UCE故障为例）：

```json
"SetUCEByBIOS": {
    "req": {
        "Segment": {},
        "Bus": {},
        "Device": {},
        "Function": {},
        "Value": {
            "baseType": "U8"
        }
    }
}
```

Value可以承载状态，指定Value的第一位用于表示是否为Device的BDF

原先触发告警的值：00000001b

现触发告警的值：00000011b

### 3.1.2 功能详细设计

上报时判断是否为Device的BDF，如果是则查询addr，判断是否触发软件告警。

### 3.1.3 开发者测试
<!--
增加模块接口：以活动图/流程图等形式明确模块内处理流程，针对模块处理流程中的分支进行覆盖
修改模块接口处理流程：覆盖修改影响流程分支
-->
DT设计参考：
| 组件名 | 用例类型 | 测试用例描述 | 用例名称 | 预置条件 | 操作步骤 | 预期结果 |
| --- | --- | --- | --- | --- | --- | --- |
| firmware_mgmt | IT | 测试BMC固件更新生效状态 | test_update_bmc_active_status | 状态机为parallel_upgrading | 1.更新固件生效资源<br/>2.访问bmc.kepler.firmware_mgmt下/bmc/kepler/UpdateService/FirmwareActive/BMC接口<br/>3.查看/bmc/kepler/UpdateService/FirmwareActive中生效对象生效信息<br/>4.查看/bmc/kepler/UpdateService/FirmwareActive/BMC下bmc.kepler.UpdateService.FirmwareActiveInfo中生效信息 | 1.更新成功<br/>2.访问成功<br/>3.查询到bmc生效资源<br/>4.bmc生效信息：'FirmwareId'='BMC', 'FirmwareType'='BMC', 'ActiveStatus'='Ready' |
#### 3.1.3.1 单元测试
<!-- UT，主要是功能单元测试，测试对象是功能单元接口。UT测试设计要从黑盒（功能）角度设计，从输入(I)、处理（B）、预期输出（O）的角度进行用例分析设计，测试覆盖率仅作为反馈，用于分析哪些功能场景没有覆盖到，从而指导测试设计优化并补充测试用例 -->
#### 3.1.3.2 集成测试
<!-- IT，主要是组件/模块内的集成测试，测试对象是模块/组件接口。IT测试设计将模块/组件当作黑盒测试，IT测试用例中禁止对组件/模块内部代码打桩，如果确实有少量场景难以构造，可以考虑在测试框架中统一打桩并提供接口供测试用例调用构造场景。
说明：API测试属于IT，其测试对象是微服务接口。
PCST，是指PC上的服务集成测试，测试对象是功能需求。PCST测试设计，要覆盖正常功能、异常功能和交叉功能，采用灰盒 -->