*openUBMC 1825大板网口数量支持动态切换详细设计说明书*

<table>
    <tr>
        <td>所属SIG组:</td>
        <td>hardware_sig</td>
    </tr>
    <tr>
        <td>落入版本:</td>
        <td>26.4.0</td>
    </tr>
    <tr>
        <td>设计人员:</td>
        <td>范滔+Tao_A</td>
    </tr>
    <tr>
        <td>日期:</td>
        <td>2026.02.09</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优化等；以及该需求对用户（含组件）带来什么具体价值，如果没有该需求，对用户（含组件）带来什么损失； -->
1825大板网卡需要支持网口数量的动态切换，实现网卡从2网口模式到4网口模式的灵活切换，满足不同业务场景需求；

## 1.2 功能描述
<!-- 描述该需求交付的整体功能，主要实现XXX功能，解决XXX问题，明确方案如何实现 -->
1825大板网卡需要支持网口数量的动态切换，实现网卡从2网口模式到4网口模式，切换后需要OS复位联动网卡复位才能生效新的网口数量；


## 1.3 功能场景
<!-- 描述该需求的业务使用场景，内容包括：
1) 场景出发条件及对象：什么角色/工具/接口等在什么具体情况下使用该特性，使用对象技能如何？
2) 使用时间及频度
3) 描述该特性主要有哪些场景、子场景及关键任务操作 -->
1、通过Web和Redfish接口配置网卡的待生效网口数量；
2、网卡的待生效网口数量支持配置导入导出；


## 1.4 功能列表
<!-- 描述该需求交付的功能列表，内容包括：列出功能详细描述，标题、描述。 -->
| 功能编号 | 功能标题 | 功能描述 |
| ------- | ------- | -------- |
| 1 | 1825大板网卡支持网口数量动态模式切换 | 1825大板网卡需要支持网口数量的动态切换，实现网卡从2网口模式到4网口模式 |
# 2.功能设计
## 2.1 总体方案分析
<!-- 描述该方案的总体设计（注：相关输出方案可同步刷新到各组件仓） -->

### 2.1.1 方案详细设计
#### 2.1.1.1 方案概述
<!-- 描述该方案的整体实现，内容包括：涉及的关键点，实现策略等 -->
1、新增资源协作对象和接口承载预加载端口数量，可由web和redfish接口查询和设置；
```json
    "NetworkAdapterPreload_1": {
      "PortCount": 2,
      "PortCountAllowableValues": [2, 4]
    },
    "Connector_PCIE_2Port": {
      "Bom": "14140130",
      "Slot": 3,
      "Presence": "<=/NetworkAdapterPreload_1.PortCount|> expr($1 == 2 ? 1 : 0)",
      "Id": "1825",
      "AuxId": "2Port"
    },
    "Connector_PCIE_4Port": {
      "Bom": "14140130",
      "Slot": 3,
      "Presence": "<=/NetworkAdapterPreload_1.PortCount|> expr($1 == 4 ? 1 : 0)",
      "Id": "1825",
      "AuxId": "2Port"
    }
```
path：/bmc/kepler/Systems/:SystemId/NetworkAdapterPreloads/:ID<br>
interface:bmc.kepler.Systems.NetworkAdapter.PortConfig<br>
property：
- PortCount：预加载端口数量,掉电持久化
- PortCountAllowableValues：预加载端口数量取值，例如[2,4]表示支持配置成2口或4口
- NodeId：唯一标识，由网卡名加槽位号拼接而成，用于匹配该对象管理的网卡，例如EthernetAdapter1
method:
- SetPortCount：设置预加载端口数量
2、配置两个不同的网卡CSR文件分别对应2网口和4网口，自发现根据预加载端口数量选择加载不同的网卡CSR文件；
3、用户调用接口设置了预加载网口数量后，network_adapter组件判断是否为合理的值，如果合理再给网卡发送命令下发此配置，再修改PortCount的属性：例如PortCount从4变到2，Connector_PCIE_4Port的presence会从1变到0，它之前加载的2网口网卡CSR文件里所有对象会被卸载，Connector_PCIE_2Port的Presence会从0变成1，加载新的4网口的CSR文件；
#### 2.1.1.2 开发视图
<!-- 开发视图面向系统开发及软件管理，描述系统代码结构，构建结构的视图，主要解决系统技术实现和开发的问题，它依托逻辑视图，描述代码、构建结构 -->

**1825 大板网口数量动态切换（以 PortCount=4→2 为例）**

```mermaid
sequenceDiagram
    participant User as 用户
    participant NA as network_adapter组件
    participant NIC as 网卡
    participant C4 as Connector_PCIE_4Port
    participant C2 as Connector_PCIE_2Port
    participant CSR2 as 2口网卡CSR文件
    participant CSR4 as 4口网卡CSR文件

    User->>NA: 设置网口数量为2
    NA->>NIC: 下发“预加载网口数量=2”的配置命令
    NIC-->>NA: 返回执行结果

    NA->>NA: 更新 PortCount 属性 4 → 2
    NA->>C4: 通知 PortCount 变更
    C4->>C4: Presence 1 -> 0
    C2->>C2: Presence 0 -> 1
    C4->>CSR4: 卸载 4 网口网卡 CSR 文件中已加载的所有对象
    C2->>CSR2: 加载 2 网口网卡 CSR 文件（创建对应对象）
```
#### 2.1.1.3 运行视图
<!-- 运行视图面向系统运行，描述系统启动过程、运行期交互的视图，主要解决系统运行期交互，描述各可执行交付件在运行期的交互关系 -->
NA
### 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 | √ |

### 2.1.5 兼容性分析
<!-- 当前的功能对现有在网的功能是否有影响，具体的影响点进行分析之后输出影响分析表格 -->
之前redfish设置LLDP使能实现错误，发送了错误的命令字，当前纠正为正确的命令字
### 2.1.6 定制化接口分析
<!-- 如果支持定制化设置，则需要给出定制化时的默认值（空定制化项条件下的设置值），如果涉及到定制化接口变更或新增，注意定制化接口文档需配套修改。注意定制化默认值变更对白牌包的影响 -->
不涉及
### 2.1.7 导入导出分析
<!-- 如果支持导入导出的配置，则需要分析导入导出的schema。 -->
涉及

### 2.1.8 传感器分析
<!-- 如果需要新增传感器，则需要提前登记和评审新增的传感器要素。新增传感器评审需要上SIG-Interface进行评审 -->
不涉及
### 2.1.9 精准告警事件分析
<!-- 如果需要新增事件，则需要提前登记和评审新增的时间要素 -->
不涉及
### 2.1.10 系统锁定分析
<!-- 对外的接口或者命令是否支持系统锁定 -->
不涉及
### 2.1.11 用例场景分析
<!-- 以表格的形式输出该需求涉及的用例场景 -->
| 用例编号 | 前置条件 | 场景 | 预期 |
| ---- | ---- | ---- |  ---- |
| 1 | 网口数量从2切到4，不重启OS| 网卡正常上电 | BMC加载出4个网口，但只有前2个网口能正常获取到信息 |
| 2 | 网口数量从2切到4，再重启OS| 网卡正常上电 | BMC加载出4个网口，4个网口都能正常获取到信息 |
| 3 | 网口数量从4切到2，不重启OS| 网卡正常上电 |  BMC加载出前2个网口，前2个网口能正常获取到信息 |
| 4 | 网口数量从4切到2，再重启os| 网卡正常上电 | BMC加载出2个网口，前2个网口能正常获取到信息 |
| 5 | 网口数量设置为不支持的值| 网卡正常上电 | 设置失败，接口报错 |
| 6 | 网口数量设置为支持的值| 网卡下电 | 设置失败，接口报错 |
## 2.2 非功能质量属性设计
### 2.2.1 扩展性分析
<!-- 考虑后续新增类似功能可以很好地扩展 -->
不涉及
### 2.2.2 重用性分析
<!-- 是否为通用处理方式、接口，如果是得考虑重用性 -->
不涉及
### 2.2.3 可测试性分析
<!-- 此需求如何验证，是否可直接验证，or通过XXX功能覆盖验证，or需要单独怎加测试接口验证 -->
redfish接口、web接口、配置导入导出
### 2.2.4 资料分析
<!-- 是否涉及资料修改 -->
需修改redfish、web、配置导入导出资料，增加相关接口说明
### 2.2.5 资源使用分析
<!-- 新增线程、内存分配、模型属性名长度是否合理，CPU占用率是否会激增，Flash中新增文件是否合理（频繁读写Flash会大幅缩短emmc寿命）；是否涉及消息队列，如果涉及请检查是否存在某些场景下消息队列会满导致消息丢失，例如大量消息发送到队列且处理消息需要耗费较长时间的场景。 -->
不涉及
### 2.2.6 可靠性分析
| 编号 | 场景 | 问题描述 | 可靠性影响 | 问题级别 | 建议解决方案/需求 | 讨论结果 | 跟踪人 | 备注 |
| --- | --- | --- | --- | --- | --- | --- | --- | --- |
| 1 | 从2切到4口，OS未重启 | 网口实际生效数量还是2，后两个口会被加载出来，但信息获取是异常的 | 可能会触发后两个网口相关的误告警 |严重 | 后两个口获取不到信息时，不要设置属性为告警值 |
### 2.2.7 安全性分析
| 安全合规项 | 是否涉及 | 现有的防护措施 |
| --- | --- | --- |
| 访问控制（通道、文件权限、用户权限、查询权限、配置权限、接口权限） | 正常权限 |  |
| 敏感数据 | 不涉及 |  |
| 日志（操作日志、维护日志、安全日志、运行日志） | 设置有操作日志 |  |
| 文档 | 不涉及 |  |
| 加密及算法 | 不涉及 |  |
| 新增关键资源（密钥、证书、关键配置）备份、恢复 | 不涉及 |  |
| 新增对外接口入参校验 | 不涉及 |  |
| 新增开源及三方软件引入 | 不涉及 |  |
# 3.功能实现
<!-- 通过表格、流程图、简明文字描述提供，力求容易看懂、容易实现，详细描述细节。 -->
## 3.1 支持1825大板网卡网口数量切换
### 3.1.1 功能实现设计
N/A
### 3.1.2 功能详细设计
N/A
### 3.1.3 开发者测试
<!--
增加模块接口：以活动图/流程图等形式明确模块内处理流程，针对模块处理流程中的分支进行覆盖
修改模块接口处理流程：覆盖修改影响流程分支
-->
#### 3.1.3.1 单元测试
<!-- UT，主要是功能单元测试，测试对象是功能单元接口。UT测试设计要从黑盒（功能）角度设计，从输入(I)、处理（B）、预期输出（O）的角度进行用例分析设计，测试覆盖率仅作为反馈，用于分析哪些功能场景没有覆盖到，从而指导测试设计优化并补充测试用例 -->
| 组件名 | 用例类型 | 测试用例描述 | 用例名称 | 预置条件 | 操作步骤 | 预期结果 |
| --- | --- | --- | --- | --- | --- | --- |
| network_adapter | UT | 切换网口数量为PortCountAllowableValues里的任一值 | test_set_port_count_valid | 模拟给网卡发送命令返回成功 | 调用setportcount方法 | 设置成功 |
| network_adapter | UT | 切换网口数量为PortCountAllowableValues外的值 | test_set_port_count_invalid | NA | 调用setportcount方法 | 设置失败 |
#### 3.1.3.2 集成测试
<!-- IT，主要是组件/模块内的集成测试，测试对象是模块/组件接口。IT测试设计将模块/组件当作黑盒测试，IT测试用例中禁止对组件/模块内部代码打桩，如果确实有少量场景难以构造，可以考虑在测试框架中统一打桩并提供接口供测试用例调用构造场景。
说明：API测试属于IT，其测试对象是微服务接口。
PCST，是指PC上的服务集成测试，测试对象是功能需求。PCST测试设计，要覆盖正常功能、异常功能和交叉功能，采用灰盒 -->
N/A