*openUBMC 安全切面使能详细设计说明书*

<table>
    <tr>
        <td>所属SIG组:</td>
        <td>hardware</td>
    </tr>
    <tr>
        <td>落入版本:</td>
        <td>26.0</td>
    </tr>
    <tr>
        <td>设计人员:</td>
        <td>zhaohongbang</td>
    </tr>
    <tr>
        <td>日期:</td>
        <td>2026/02/3</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/02/3</td>
        <td>1.0</td>
        <td>CPLD自检方案优化</td>
        <td>赵鸿邦</td>
        <td>/</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优化等；以及该需求对用户（含组件）带来什么具体价值，如果没有该需求，对用户（含组件）带来什么损失； -->
当前的CPLD自检方案，仅支持对连续的寄存器地址进行自检，不支持对特定地址的多个寄存器进行自检。
并且自检时，方案为周期性访问寄存器，向寄存器内写入0x55和0xaa，读取出0x55和0xaa，检测到写入和读取一致，则认为正常。
这导致：
1. **无法覆盖多片选场景**：当一个cpld多片选时，或者一个单板上实现多个smc模块的时候，每一个片选和模块都需要检测。
此时只支持连续寄存器地址的自检的接口无法满足要求。
2. **无法覆盖异常场景**：主控设备（CPU/BMC）通过 Local Bus 向 CPLD 写入控制指令或数据时，假如对端CPLD挂死，会导致读入和读出值一致，无法检测出异常。
需开发更完善的CPLD自检方案以覆盖场景。

## 1.2 功能描述
<!-- 描述该需求交付的整体功能，主要实现XXX功能，解决XXX问题，明确方案如何实现 -->
1. 对当前的CPLD自检方案进行改进， 支持多个特定地址的寄存器进行自检；
2. 支持配置具体需要的写入值和校验值，以达到对寄存器按位取反的校验。

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

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

### 1.3.2 使用时间及频度
- **使用时间**：上电后、升级后、自愈流程中。
- **使用频度**：高频使用

### 1.3.3 主要场景及子场景
- 周期检测，主动预警、提升系统可用性

## 1.4 功能列表
<!-- 描述该需求交付的功能列表，内容包括：列出功能详细描述，标题、描述。 -->
| 功能编号 | 功能标题 | 功能描述 |
| ------- | ------- | -------- |
| 1 | 多片选自检 | 支持多个特定地址的寄存器进行自检 |
| 1 | 自定义预期校验值 | 支持对预期读出的值进行自定义配置，以校验可取反的寄存器 |
| 1 | 防抖 | 校验失败时连续校验，多次校验失败则上报告警|


# 2.功能设计
## 2.1 总体方案分析
<!-- 描述该方案的总体设计（注：相关输出方案可同步刷新到各组件仓） -->
具体涉及修改的代码仓和文件内容如下：
general_hardware仓
在model.json中新增对象LogicSelfTest，对象中新增私有属性RefChip、WriteReg、ReadReg、WriteVal、ReadVal等，
新增while循环来检测对应CPLD片选。

CSR仓中添加新的Accessor，event告警。

### 2.1.1 方案详细设计
#### 2.1.1.1 方案概述
<!-- 描述该方案的整体实现，内容包括：涉及的关键点，实现策略等 -->
```mermaid
graph LR
    A[👤</span> BMC] -->|localbus| B[CPLD]    
    B -->|写入0x55/0xaa| C[指定片选的逻辑检测寄存器]
    D[👤</span> 指定寄存器] -->|取反| E[CPLD]
    E -->|供读取| F[BMC校验]
```

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

#### 2.1.1.3 运行视图
<!-- 运行视图面向系统运行，描述系统启动过程、运行期交互的视图，主要解决系统运行期交互，描述各可执行交付件在运行期的交互关系 -->
- **全域复位**：
```mermaid
sequenceDiagram
    participant BMC
    participant CPLD
    participant 寄存器

    BMC->>CPLD: localbus
    CPLD->>寄存器: 写入0x55/0xaa(set_prop)
    寄存器-->>CPLD: 取反并返回（get_prop）
    CPLD-->>BMC: 读取
    BMC->>BMC: 校验、更新health_status、循环执行
```

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

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

### 2.1.4 北向接口分析
<!-- 需要分析当前功能是否有以下接口影响，如果有影响，则需要具体的补充影响点。其中注意点如下：
（1）如果有新增IPMI接口，请排查代码中IPMI命令注册的过滤字段，是否完全和IPMI命令的定义一致？
（2）新增一个接口时，需要咨询SIG组是否还有其他的接口受影响 
（3）新增接口需要将对应接口属性名称和属性值列出，属性值若有单位、异常值处理、范围限制或格式规范也需要列出，对于标准接口需要列出标准接口文档中对应的属性名称和属性值相关规定-->
| 特性 | SNMP | CLI | WEB | KVM_VMM | IPMI(RMCP/RMCP+) | HMM | Redfish |
| ---- | ---- | ---- | --- | ------ | ---------------- | --- | ------- |
| NA | NA | NA | NA | NA | NA | NA | NA |

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

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

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

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

### 2.1.9 精准告警事件分析
<!-- 如果需要新增事件，则需要提前登记和评审新增的时间要素 -->
| 编号 | 描述 | 告警码 | 告警描述示例 | 触发场景 |
| ---- | ----| ---- | ---- | ---- |
| 1 | CPLD自检不通过 | 0X5D000007 | Expansion board 1 CPLD cs0 self-check result is abnormal. | CPLD连续校验失败，累计次数达到配置CSR中的防抖次数上限时触发 | 

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

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

| 用例编号 | 用例名称 | 前置条件 | 操作步骤 | 预期结果 |
| ---- | ---- | ---- | ---- | ---- |
| 1 | 验证检测能力 | 1. BMC正常运行 | 1. 设备启动自检，观察打印 | a. 能获取到类表的目标，可以读写寄存器，校验可通过
| 2 | 验证报错能力 | 1. 刻意配置无法通过校验的预期值 | 1. 设备启动自检，观察打印 | a. 出发防抖机制，重新读取，超过防抖次数上限仍然不通过则更新healthstatus |
| 3 | 验证告警清零 | 1. 设备已经产生告警 | 1. 产生告警后，重启或复位BMC | a. 告警清除，等待自检任务重新开始后，告警再根据实际情况重新告警 |

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

### 2.1.13 持久化分析
<!-- 当前的功能是否涉及持久化，尤其是持久化类型变更或某个属性新增了取值，是否兼容老版本 -->
不涉及

## 2.2 非功能质量属性设计
### 2.2.1 扩展性分析
<!-- 考虑后续新增类似功能可以很好地扩展 -->
本方案开发的功能具有良好扩展性，对后续其他期间的逻辑自检、读写寄存器地址不一致、预期读取值特殊等情况均能兼容。

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

### 2.2.3 可测试性分析
不涉及

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

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

### 2.2.6 可靠性分析
不涉及

### 2.2.7 安全性分析
| 安全合规项 | 是否涉及 | 现有的防护措施 |
| --- | --- | --- |
| 访问控制（通道、文件权限、用户权限、查询权限、配置权限、接口权限） | 不涉及 |  |
| 敏感数据 | 不涉及 |  |
| 日志（操作日志、维护日志、安全日志、运行日志） | 涉及 | 告警在产生和删除时会记录维护日志 |
| 文档 | 不涉及 |  |
| 加密及算法 | 不涉及 |  |
| 新增关键资源（密钥、证书、关键配置）备份、恢复 | 不涉及 |  |
| 新增对外接口入参校验 | 不涉及 |  |
| 新增开源及三方软件引入 | 不涉及 |  |
# 3.功能实现
<!-- 通过表格、流程图、简明文字描述提供，力求容易看懂、容易实现，详细描述细节。 -->
## 3.1 CPLD 自检方案优化
### 3.1.1 功能实现设计

### 3.1.2 开发者测试
<!--
增加模块接口：以活动图/流程图等形式明确模块内处理流程，针对模块处理流程中的分支进行覆盖
修改模块接口处理流程：覆盖修改影响流程分支
-->

#### 3.1.2.1 单元测试
<!-- UT，主要是功能单元测试，测试对象是功能单元接口。UT测试设计要从黑盒（功能）角度设计，从输入(I)、处理（B）、预期输出（O）的角度进行用例分析设计，测试覆盖率仅作为反馈，用于分析哪些功能场景没有覆盖到，从而指导测试设计优化并补充测试用例 -->
| 用例名称 | 测试场景 | 说明 | 操作步骤 | 预期结果 |
| ---- | ---- | ---- | ---- | ---- |
| test_update_logic_health_status | 更新期间健康状态测试 | 模拟失败计数和防抖计数 | 构造入参，失败次数达到防抖次数和未达到两种情况 | 经过update_logic_health_status后，未达到防抖次数上限时，预期healthstatus为0，否则为1 |
| test_logic_self_test_process | 测试自检异常场景 | 对寄存器读写异常及校验异常的场景测试 | 打桩原方法，让对寄存器的读写固定失败和校验固定失败，校验返回值 | 经过logic_self_test_process，预期logic_failcount为1 |
| test_logic_self_test_check_length | 测试输入长度校验 | 对writeval和readval构造异常场景，校验两者长度是否一致 | 打桩构造两组输入，分别构造长度一致与不一致场景，校验返回值 | 经过test_logic_self_test_check_length，预期长度一致时返回值为true，否则为false |

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