*openUBMC 支持设置/查询服务器系统强制启动状态IPMI命令迁移 功能详细设计说明书*

<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/13</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/13</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>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优化等；以及该需求对用户（含组件）带来什么具体价值，如果没有该需求，对用户（含组件）带来什么损失； -->
设置服务器系统强制启动状态IPMI命令SetDpuForcePowerOnState为某厂商定制命令，要求定制化能力开启才能使用；查询服务器系统强制启动状态IPMI命令GetDpuForcePowerOnState 也是专为满足客户定制化场景需求而设计。
然而，当前这两条IPMI命令实现在了network_adapter组件仓，这造成了通用组件和定制化能力的耦合，故需要实现相关IPMI命令迁移。

## 1.2 功能描述
<!-- 描述该需求交付的整体功能，主要实现XXX功能，解决XXX问题，明确方案如何实现 -->
支持设置/查询服务器系统强制启动状态IPMI命令迁移，保持原有功能不变。

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

## 1.4 功能列表
<!-- 描述该需求交付的功能列表，内容包括：列出功能详细描述，标题、描述。 -->
| 功能编号 | 功能标题 | 功能描述 |
| ------- | ------- | -------- |
| 1 | 支持设置服务器系统强制启动状态IPMI命令迁移 | 支持设置服务器系统强制启动状态IPMI命令迁移，保持原有功能不变。  |
| 2 | 支持查询服务器系统强制启动状态IPMI命令迁移 | 支持查询服务器系统强制启动状态IPMI命令迁移，保持原有功能不变。  |

# 2.功能设计
## 2.1 总体方案分析
<!-- 描述该方案的总体设计（注：相关输出方案可同步刷新到各组件仓） -->
### 2.1.1 方案详细设计
#### 2.1.1.1 方案概述
<!-- 描述该方案的整体实现，内容包括：涉及的关键点，实现策略等 -->
修改前：
```mermaid
graph LR
    A[👤</span> 网管] -->|IPMI| B[network_adapter]
    B -->|返回| A
```

修改后：
```mermaid
graph LR
    A[👤</span> 网管] -->|IPMI| B[定制化组件]
    B -->|返回| A
```

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

#### 2.1.1.3 运行视图
<!-- 运行视图面向系统运行，描述系统启动过程、运行期交互的视图，主要解决系统运行期交互，描述各可执行交付件在运行期的交互关系 -->
- **设置服务器系统强制启动状态**：
```mermaid
sequenceDiagram
    participant 网管
    participant 定制化组件

    网管 ->>定制化组件: SetDpuForcePowerOnState
    定制化组件 ->> 定制化组件: .bios_boot_wait_flag = 1
    定制化组件 -->> 网管: 返回
```
- **带外查询服务器系统强制启动状态**：
```mermaid
sequenceDiagram
    participant 网管
    participant 定制化组件

    网管 ->>定制化组件: GetDpuForcePowerOnState
    定制化组件 -->> 网管: 返回
```
- **带内查询服务器系统强制启动状态**：
```mermaid
sequenceDiagram
    participant 网管
    participant 定制化组件

    网管 ->>定制化组件: GetDpuForcePowerOnState
    定制化组件 -->> 定制化组件: 关闭强制启动状态.bios_boot_wait_flag = 0
    定制化组件 -->> 网管: 返回原值
```

### 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 兼容性分析
<!-- 当前的功能对现有在网的功能是否有影响，具体的影响点进行分析之后输出影响分析表格 -->
设置/查询服务器系统强制启动状态IPMI命令保持原有功能一致

### 2.1.6 定制化接口分析
<!-- 如果支持定制化设置，则需要给出定制化时的默认值（空定制化项条件下的设置值），如果涉及到定制化接口变更或新增，注意定制化接口文档需配套修改。注意定制化默认值变更对白牌包的影响 -->
设置/查询服务器系统强制启动状态IPMI命令在定制化场景下可以使用，非定制化场景下不可使用；不涉及定制化接口新增或变更。

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

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

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

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

### 2.1.11 用例场景分析
<!-- 以表格的形式输出该需求涉及的用例场景 -->
| 用例编号 | 用例描述 | 前置条件 | 执行步骤 | 预期结果 | 
| ------- |  ------- | ------- | ------- | ------- | 
| 1 | 定制化场景下，设置服务器强制启动状态 | BMC正常运行，有定制化功能 | 下发SetDpuForcePowerOnState命令 | 设置成功 | 
| 2 | 定制化场景下，带外查询服务器强制启动状态 | BMC正常运行，有定制化功能 | 带外下发GetDpuForcePowerOnState命令 | 查询成功 | 
| 3 | 定制化场景下，带内查询服务器强制启动状态 | BMC正常运行，有定制化功能 | 带内下发GetDpuForcePowerOnState命令 | 查询成功 | 
| 4 | 非定制化场景下，设置服务器强制启动状态 | BMC正常运行，无定制化功能 | 下发SetDpuForcePowerOnState命令 | 设置失败 |
| 5 | 非定制化场景下，查询服务器强制启动状态 | BMC正常运行，无定制化功能 | 下发GetDpuForcePowerOnState命令 | 查询失败 | 
 

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

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

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

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

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

不涉及

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

不涉及

### 2.2.6 可靠性分析
| 编号 | 场景 | 问题描述 | 可靠性影响 | 问题级别 | 建议解决方案/需求 | 讨论结果 | 跟踪人 | 备注 |
| --- | --- | --- | --- | --- | --- | --- | --- | --- |
| 不涉及 |  |  |  |  |  |  |  | |

### 2.2.7 安全性分析
| 安全合规项 | 是否涉及 | 现有的防护措施 |
| --- | --- | --- |
| 访问控制（通道、文件权限、用户权限、查询权限、配置权限、接口权限） | 是 | 定制化场景下才允许访问接口 |
| 敏感数据 | 否 | 不涉及敏感数据处理 |
| 日志（操作日志、维护日志、安全日志、运行日志） | 是 | 异常分支记录日志, 设置成功/失败时记录日志 |
| 文档 | 否 | 不涉及文档安全 |
| 加密及算法 | 否 | 不涉及加密算法 |
| 新增关键资源（密钥、证书、关键配置）备份、恢复 | 否 | 不涉及密钥证书管理 |
| 新增对外接口入参校验 | 否 | 不涉及 |
| 新增开源及三方软件引入 | 否 | 不涉及新的开源软件引入 |


## 3.1【功能编号】支持设置/查询服务器系统强制启动状态IPMI命令迁移
### 3.1.1 功能实现设计


### 3.1.2 功能详细设计
1、定义服务器系统强制启动标记属性bios_boot_wait_flag
详细描述：
|属性名称 | 数据类型 | 只读 |  属性描述 |  持久化类型 | 
|--- | --- | --- | --- | --- | 
|bios_boot_wait_flag | unsigned int |  false | 表示服务器系统强制启动状态，默认值为 0。<br> 取值范围：<br> - 0：强制启动状态为关闭，此时BIOS需要等待DPU系统启动完全才能进行引导<br> - 1：强制启动状态为开启，此时BIOS无需等待DPU系统启动就能才能进行引导<br>  |  不涉及 |

2、IPMI命令
（1）**SetDpuForcePowerOnState**
用于设置服务器系统强制启动状态为开启。
请求说明：
|**字节顺序** | **域内容**|
|:-- | :--|
|NetFn | 3ah|
|Cmd | f6h|
|1 | Sub command，子命令 = 00h|

响应说明：
| **字节顺序** | **域内容** |
|:---|:---|
| 1 | Completion Code |

（2）**GetDpuForcePowerOnState**
用于查询服务器系统强制启动状态，同时带内查询自动恢复强制启动状态为关闭，带外查询不自动恢复。
请求说明：
| **字节顺序** | **域内容** |
|:---|:---|
| NetFn | 30h |
| Cmd | 93h |
| 1:3 | Manufacturer ID，LS Byte first。长度固定3个字节，例如，某厂家ID是2011，对应十六进制为0x0007DB，则字节序为第1个字节为DBh、第2个字节为07h、第3个字节为00h。 |
| 4 | Sub command，子命令=0x27 |
| 5 | 设备类型编号，固定为0x39 |
| 6 | 设备信息编号，固定为0xff |
| 7 | 设备信息，固定为0xc3 |
| 8 | Offset，读取的数据偏移，从0开始。 |
| 9 | Length，读取长度（最大为250Bytes） |

响应说明：
| **字节顺序** | **域内容** |
|:---|:---|
| 1 | Completion Code |
| 2:4 | Manufacturer ID，LS Byte first。长度固定3个字节，例如，某厂家ID是2011，对应十六进制为0x0007DB，则字节序为第1个字节为DBh、第2个字节为07h、第3个字节为00h。 |
| 5 | EndOfList：表示当前数据是否结束。当参数数据比较长的时候，可能需要分多次读取，通过此字段可以判断数据是否读完。<br>[7:1]：reserved<br>[0]：End of list<br>0=last data<br>1=middle data<br> |
| 6 | bios_boot_wait_flag |

### 3.1.3 开发者测试
#### 3.1.3.1 单元测试
| 用例编号 | 用例描述 | 前置条件 | 执行步骤 | 预期结果 | 
| ------- |  ------- | ------- | ------- | ------- | 
| 1 | 定制化场景下，设置服务器强制启动状态 | BMC正常运行，有定制化功能 | 下发SetDpuForcePowerOnState命令 | 设置成功 | 
| 2 | 定制化场景下，带外查询服务器强制启动状态 | BMC正常运行，有定制化功能 | 带外下发GetDpuForcePowerOnState命令 | 查询成功 | 
| 3 | 定制化场景下，带内查询服务器强制启动状态 | BMC正常运行，有定制化功能 | 带内下发GetDpuForcePowerOnState命令 | 查询成功 | 
| 4 | 非定制化场景下，设置服务器强制启动状态 | BMC正常运行，无定制化功能 | 下发SetDpuForcePowerOnState命令 | 设置失败 |
| 5 | 非定制化场景下，查询服务器强制启动状态 | BMC正常运行，无定制化功能 | 下发GetDpuForcePowerOnState命令 | 查询失败 | 

#### 3.1.3.2 集成测试
<!-- IT，主要是组件/模块内的集成测试，测试对象是模块/组件接口。IT测试设计将模块/组件当作黑盒测试，IT测试用例中禁止对组件/模块内部代码打桩，如果确实有少量场景难以构造，可以考虑在测试框架中统一打桩并提供接口供测试用例调用构造场景。
说明：API测试属于IT，其测试对象是微服务接口。
PCST，是指PC上的服务集成测试，测试对象是功能需求。PCST测试设计，要覆盖正常功能、异常功能和交叉功能，采用灰盒 -->
| 用例编号 | 用例描述 | 前置条件 | 执行步骤 | 预期结果 | 
| ------- |  ------- | ------- | ------- | ------- | 
| 1 | 定制化场景下，设置服务器强制启动状态 | BMC正常运行，有定制化功能 | 下发SetDpuForcePowerOnState命令 | 设置成功 | 
| 2 | 定制化场景下，带外查询服务器强制启动状态 | BMC正常运行，有定制化功能 | 带外下发GetDpuForcePowerOnState命令 | 查询成功 | 
| 3 | 定制化场景下，带内查询服务器强制启动状态 | BMC正常运行，有定制化功能 | 带内下发GetDpuForcePowerOnState命令 | 查询成功 | 
| 4 | 非定制化场景下，设置服务器强制启动状态 | BMC正常运行，无定制化功能 | 下发SetDpuForcePowerOnState命令 | 设置失败 |
| 5 | 非定制化场景下，查询服务器强制启动状态 | BMC正常运行，无定制化功能 | 下发GetDpuForcePowerOnState命令 | 查询失败 | 