*openUBMC 支持DPU卡通过imu获取Link信息功能详细设计说明书*

<table>
    <tr>
        <td>所属SIG组:</td>
        <td>hardware</td>
    </tr>
    <tr>
        <td>落入版本:</td>
        <td>26.01</td>
    </tr>
    <tr>
        <td>设计人员:</td>
        <td>dengshengang</td>
    </tr>
    <tr>
        <td>日期:</td>
        <td>2026/1/12</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>2026/1/12</td>
        <td>1.0</td>
        <td>初稿</td>
        <td>dengshengang</td>
        <td>/</td>
    </tr>
</table>

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

<table>
    <tr>
        <th>Abbreviations 缩略语</th>
        <th>Full spelling 英文全名</th>
        <th>Chinese explanation 中文解释</th>
    </tr>
    <tr>
        <td>IMU</td>
        <td>Intelligent Management Unit</td>
        <td>智能管理单元</td>
    </tr>
    <tr>
        <td>NCSI</td>
        <td>Network Controller Sideband Interface</td>
        <td>网络控制器边带接口</td>
    </tr>
    <tr>
        <td>MCTP</td>
        <td>Management Component Transport Protocol</td>
        <td>管理设备传输协议</td>
    </tr>
    <tr>
        <td>BMC</td>
        <td>Baseboard Management Controller</td>
        <td>基板管理控制器</td>
    </tr>
    <tr>
        <td>DT</td>
        <td>Developer Testing(开发者测试)</td>
        <td>是指开发者所做的测试，有别于专职测试人员进行的测试活动</td>
    </tr>
    <tr>
        <td>UT</td>
        <td>Unit Testing(单元测试)</td>
        <td>对最小粒度的功能单元进行验证的测试</td>
    </tr>
    <tr>
        <td>IT</td>
        <td>Integration Testing(集成测试)</td>
        <td>组件/模块/微服务对外接口测试，即1个组件/模块/微服务内部集成测试</td>
    </tr>

</table>

[TOC]

# 1.功能分析
## 1.1 功能背景
<!-- 描述该需求的来源或背景，比如：支撑XXX功能、XXX优化等；以及该需求对用户（含组件）带来什么具体价值，如果没有该需求，对用户（含组件）带来什么损失； -->

当前DPUCard对象的LinkWidthAbility、LinkWidth、LinkSpeedCapability、LinkSpeed属性配置为从NetworkAdapter对象同步，仅支持从Ncsi带外获取，这导致：

1. **维护效率低下**：当Ncsi over mctp不通时，无法获取到上述属性用于DPU卡Link信息显示。
   
该需求将为用户提供通过imu获取DPU卡Link信息的能力，提升系统维护的灵活性和安全性。

## 1.2 功能描述
<!-- 描述该需求交付的整体功能，主要实现XXX功能，解决XXX问题，明确方案如何实现 -->
主要实现通过imu获取DPUCard对象LinkWidthAbility、LinkWidth、LinkSpeedCapability、LinkSpeed属性的功能

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

### 1.3.1 场景触发条件及对象
- **使用角色**：系统管理员、运维人员、技术支持工程师
- **使用工具**：Redfish API等工具
- **使用技能**：具备基本的BMC管理经验

### 1.3.2 使用频度
- **使用频度**：周期性监控

### 1.3.3 主要场景及子场景
依赖imu获取DPU卡Link信息

## 1.4 功能列表
<!-- 描述该需求交付的功能列表，内容包括：列出功能详细描述，标题、描述。 -->
| 功能编号 | 功能标题 | 功能描述 |
| ------- | ------- | -------- |
| 1 | 支持从imu获取DPU卡Link信息 | 支持通过imu命令获取DPU卡Link信息，包括：最大链路带宽LinkWidthAbility、链路带宽LinkWidth、最大链路速率LinkSpeedCapability、链路速率LinkSpeed。在Ncsi over mctp不通，但imu支持时，DPU卡的Link信息仍可以正常显示。  |



# 2.功能设计
## 2.1 总体方案分析
<!-- 描述该方案的总体设计（注：相关输出方案可同步刷新到各组件仓） -->
### 2.1.1 方案详细设计
#### 2.1.1.1 方案概述
<!-- 描述该方案的整体实现，内容包括：涉及的关键点，实现策略等 -->

```mermaid
classDiagram
    class DPUCard {
        +LinkWidthAbility
        +LinkWidth
        +LinkSpeedCapability
        +LinkSpeed
    }
    
    class NetworkAdapter {
        LinkWidthCapability
        LinkWidth
        LinkSpeedCapability
        LinkSpeed
        +update_dpu_linkinfo_by_imu()
    }

    class mdbbus {
        ...
    }

    class Imu_cmd {
        ...
        +GetLinkInfo()
    }
    
    DPUCard --> NetworkAdapter 
    DPUCard --> mdbbus
    NetworkAdapter --> mdbbus
    NetworkAdapter ..> Imu_cmd
```

#### 2.1.1.2 开发视图
<!-- 开发视图面向系统开发及软件管理，描述系统代码结构，构建结构的视图，主要解决系统技术实现和开发的问题，它依托逻辑视图，描述代码、构建结构 -->
```mermaid
graph TB
    subgraph "general_hardware组件"
        A[DPUCard] 
    end
    
    subgraph "network_adapter组件"
        B[NetworkAdapter]
        C[Imu_cmd]
    end

    subgraph "资源树"
        D[mdbbus]
    end

    subgraph "BIOS"
        E[Imu]
    end

    subgraph "网管工具界面"
        F[请求API]
    end
    A --> B
    A --> D
    B --> C
    B --> D
    C --> E
    F --> D
```

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

```mermaid
sequenceDiagram
    participant 网管
    participant mdbBus as 资源树
    participant general_hardware
    participant network_adapter
    participant Imu

    loop NCSI不通，且服务器处于上电状态
    network_adapter ->>+ Imu: GetLinkInfo()
    Imu -->>- network_adapter: 返回
    network_adapter ->> general_hardware: 同步到DPUCard对象
    general_hardware ->> mdbBus:更新DPUCard对象Link信息
    network_adapter ->>mdbBus:更新NetworkAdapter对象Link信息
    end
    网管->>mdbBus: 获取DPU卡Link信息
```

### 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 | NA | NA | NA |
   
### 2.1.5 兼容性分析
<!-- 当前的功能对现有在网的功能是否有影响，具体的影响点进行分析之后输出影响分析表格 -->
不影响原有的通过Ncsi带外获取LinkInfo功能

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

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

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

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

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

### 2.1.11 用例场景分析
<!-- 以表格的形式输出该需求涉及的用例场景 -->

| 用例编号 |  用例描述 | 前置条件 | 执行步骤 | 预期结果 | 
| ------- | ------- | ------- | ------- | ------- | 
| 1 | Ncsi不通，imu获取正常 |  BMC正常运行 | 网管工具（如redfish API: /redfish/v1/Chassis/chassis_id/<br>PCIeDevices/pciedevices_id/Functions/functions_id 获取DPU卡Link信息 | Link信息显示正常值，与带内查询 lspci -nn 设备id -vv 一致 |
| 2 | Ncsi不通，imu获取报错 | BMC正常运行 | 网管工具（如redfish API: /redfish/v1/Chassis/chassis_id/<br>PCIeDevices/pciedevices_id/Functions/functions_id 获取DPU卡Link信息 | 从imu获取到异常值，Link信息显示'N/A'，有错误日志打印 | 
| 3 | Ncsi不通，imu没有返回 | BMC正常运行 | 网管工具（如redfish API: /redfish/v1/Chassis/chassis_id/<br>PCIeDevices/pciedevices_id/Functions/functions_id 获取DPU卡Link信息 | Link信息不更新，为旧值, 有日志打印 | 
| 4 | Ncsi可以连通 | BMC正常运行 | 网管工具（如redfish API: /redfish/v1/Chassis/chassis_id/<br>PCIeDevices/pciedevices_id/Functions/functions_id 获取DPU卡Link信息 | Link信息显示正常值，与带内查询 lspci -nn 设备id -vv 一致 |
| 5 | Ncsi不通，服务器处于下电状态 | BMC正常运行 | 网管工具（如redfish API: /redfish/v1/Chassis/chassis_id/<br>PCIeDevices/pciedevices_id/Functions/functions_id 获取DPU卡Link信息 | 不触发从imu获取Link信息，Link信息不更新，为旧值 |

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

不涉及

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

不涉及

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

通过Postman等工具下发请求进行验证，可直接验证，按照测试用例覆盖验证。

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

不涉及

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

不涉及

### 2.2.6 可靠性分析
| 编号 | 场景 | 问题描述 | 可靠性影响 | 问题级别 | 建议解决方案/需求 | 讨论结果 | 跟踪人 | 备注 |
| --- | --- | --- | --- | --- | --- | --- | --- | --- |
| 1 | Ncsi不通时，从imu获取DPU卡Link信息 | imu获取报错 | Link信息显示'N/A'，添加错误日志打印 | 中 | 根据imu上报错误信息排查故障点，重新获取 |  |  | |
| 2 | Ncsi不通时，从imu获取DPU卡Link信息 | imu没有返回 | Link信息不更新，为旧值，添加异常打印 | 中 | 排查imu命令执行通路故障，重新获取 |  |  | |
| 3 | 服务器下电 | 服务器下电时不支持访问imu | Link信息不更新，为旧值，添加异常打印 | 中 | 服务器上电时才正常从imu获取 |  |  | |

### 2.2.7 安全性分析
| 安全合规项 | 是否涉及 | 现有的防护措施 |
| --- | --- | --- |
| 访问控制（通道、文件权限、用户权限、查询权限、配置权限、接口权限） | 是 | 保持与Link信息获取之前的权限控制一致 |
| 敏感数据 | 否 | 不涉及敏感数据处理 |
| 日志（操作日志、维护日志、安全日志、运行日志） | 否 | 不涉及 |
| 文档 | 否 | 不涉及文档安全 |
| 加密及算法 | 否 | 不涉及加密算法 |
| 新增关键资源（密钥、证书、关键配置）备份、恢复 | 否 | 不涉及密钥证书管理 |
| 新增对外接口入参校验 | 否 | 不涉及 |
| 新增开源及三方软件引入 | 否 | 不涉及新的开源软件引入 |


## 3.1【功能编号】支持通过imu获取DPU卡Link信息
### 3.1.1 功能实现设计


### 3.1.2 功能详细设计
LinkWidthAbility、LinkWidth、LinkSpeedCapability、LinkSpeed属性定义：
| 属性名 | 说明 | 类型 | 取值范围 | 
| --- | --- | --- | --- | 
| LinkWidthAbility | 最大链路带宽 | String | • 'X1': PCIe卡带宽 X1<br> • 'X2': PCIe卡带宽 X2<br> • 'X4': PCIe卡带宽 X4 <br>  • 'X8': PCIe卡带宽 X8 <br> • 'X12': PCIe卡带宽 X12 <br> • 'X16': PCIe卡带宽 X16 <br> • 'N/A': 缺省值/无效值 <br> |
| LinkWidth | 链路带宽 | String | 与LinkWidthAbility一致 |
| LinkSpeedCapability |最大链路速率  | String | • '2.5GT/s' <br>• '5.0GT/s' <br> • '8.0GT/s' <br>  • '16.0GT/s' <br> • '32.0GT/s' <br> • 'RsvdP' <br> • 'N/A': 缺省值/无效值 <br> |
| LinkSpeed | 链路速率 | String | 与LinkSpeedCapability一致 |

general_hardware组件添加DPUCard对象的LinkWidthAbility、LinkWidth、LinkSpeedCapability、LinkSpeed属性配置：
```
        "LinkWidthAbility": {
            "usage": [
                "CSR"
            ],
            "default": "N/A"
        },
        "LinkSpeedCapability": {
            "usage": [
                "CSR"
            ],
            "default": "N/A"
        },
        "LinkWidth": {
            "usage": [
                "CSR"
            ],
            "default": "N/A"
        },
        "LinkSpeed": {
            "usage": [
                "CSR"
            ],
            "default": "N/A"
        }
```
DPU卡Link信息更新流程：
```mermaid
graph TB
    A[向Imu下发Link信息查询命令] --> B[同步Link信息到DPUCard]
    B --> C[更新Link信息到资源树]
```
Readfish查询命令：
/redfish/v1/Chassis/chassis_id/PCIeDevices/pciedevices_id/Functions/functions_id

OS可用时，通过lspci对照带内信息：
lspci -nn 设备id -vv
### 3.1.3 开发者测试
#### 3.1.3.1 单元测试

|编号| 用例名称 | 预期结果 | 
| -------| ------- | ------- | 
|001| Ncsi不通，imu获取正常	| Link信息显示正常值，与带内查询 lspci -nn 设备id -vv 一致 | 
|002| Ncsi不通，imu获取报错	| 从imu获取到异常值，Link信息显示'N/A'，有错误日志打印|
|003| Ncsi不通，imu没有返回 | Link信息不更新，为旧值, 有日志打印|
|004| Ncsi可以连通	        |Link信息显示正常值，与带内查询 lspci -nn 设备id -vv 一致|
|005| Ncsi不通，服务器处于下电状态 |不触发从imu获取Link信息，Link信息不更新，为旧值|

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

|编号| 用例名称 | 预期结果 | 
| -------| ------- | ------- | 
|001| Ncsi不通，imu获取正常	| Link信息显示正常值，与带内查询 lspci -nn 设备id -vv 一致 | 
|002| Ncsi不通，imu获取报错	| 从imu获取到异常值，Link信息显示'N/A'，有错误日志打印|
|003| Ncsi不通，imu没有返回 | Link信息不更新，为旧值, 有日志打印|
|004| Ncsi可以连通	        |Link信息显示正常值，与带内查询 lspci -nn 设备id -vv 一致|
|005| Ncsi不通，服务器处于下电状态 |不触发从imu获取Link信息，Link信息不更新，为旧值|