【待评审】新增上下电管理相关类和接口

适用场景

管理板作为机框级管理单元,需要对框内多块节点单板和共享器件提供统一框级上下电管理能力,例如查询整框上下电状态、通过 Web 界面或命令行操作共享器件上下电。
新增/变更资源协作接口,包括路径、接口、属性、方法、信号和错误消息定义。

注意事项
1)资源协作接口评审点以接口作为最小评审单元;
2)资源协作接口评审点需要明确说明资源协作接口的评审关键变化:新增,还是变更;
3)资源协作接口评审点需要明确说明接口下属性、信号、方法的变更方式、详细描述和变更影响;
4)资源协作接口评审点需要明确说明接口变化的影响范围,例如作用于哪些路径;

详细描述

评审点1:新增资源协作接口 bmc.kepler.DataStorage.SmmFruCtrl

注意事项
1)适用于新增未定义的资源协作接口以及接口下的属性、方法和信号描述。
2)接口设计应当遵循功能内聚、职责单一、接口抽象、支持扩展的基本原则。
3)接口设计主要评审接口关键字相关内容,组件模型实现关键字仅作为评审参考。

接口描述:整框上下电管理根接口,归属 DataStorage 整框管理功能域。承载整框状态机 State 属性,对外暴露整框 PowerCtrl / 单 SSU SsuPowerCtrl / 跨控 RPC 入口(PsonCtrl/SSUCtrl/SetPowerPermission/GetPowerStatus/GetSsuPowerStates/GetState)共 8 个方法。部署在管理板,双控各持一份独立实例,主节点独占发布 State,从节点仅在内存跟随。接口由 shelf_mgmt 组件独占定义(已从 mdb_interface 迁移),mdb_interface 仅作为 required 依赖消费方。

新增属性

属性名称 签名 只读 变化通知 属性描述 访问权限 属性来源 持久化类型 易变属性
State y False true 整框状态机状态,默认值为0,取值范围包括[0,1,2,3,4,5,6],分别表示"未安装(S0)"、“未激活(S1)”、“激活请求(S2)”、“激活进行中(S3)”、“活动(S4)”、“去激活请求(S5)”、“去激活进行中(S6)” Read: ReadOnly
Write: PowerMgmt
CSR 掉电持久化 false

新增方法

方法名称 请求签名 请求参数描述 响应签名 响应参数描述 方法描述 访问权限
PowerCtrl say Param1: OperateType(String),操作类型,取值[“On”,“Off”,“PowerCycle”,“ForcePowerCycle”,“ACCycle”]
Param2: SsuId(Array),SSU ID列表(1~12),空数组表示全部
i Param1: CmdResult(S32),业务执行结果,0=成功,-1=失败 整框上下电:On/Off 控制 SSU 子系统上下电,三种 Cycle 等价(异步任务后台执行) PowerMgmt
SsuPowerCtrl sy Param1: OperateType(String),操作类型,取值[“On”,“Off”,“ForceOff”]
Param2: SsuId(U8),单个 SSU ID(1~12)
i Param1: CmdResult(S32),0=成功,-1=失败 单 SSU 上下电,按 URI 指定 ssuid PowerMgmt
PsonCtrl s Param1: OperateType(String),取值[“On”,“Off”] i Param1: CmdResult(S32),0=成功,-1=失败 跨控 RPC 入口:远端调本控 PSON 开关。不受主从门控 PowerMgmt
SSUCtrl s Param1: OperateType(String),取值[“On”,“Off”] i Param1: CmdResult(S32),0=成功,-1=失败 跨控 RPC 入口:远端调本控 SSU 上下电。不受主从门控 PowerMgmt
SetPowerPermission b Param1: Allow(Boolean),true=允许上电(解锁),false=禁止上电(加锁) i Param1: CmdResult(S32),0=成功,-1=失败 跨控 RPC 入口:远端调本控上电锁。不受主从门控 PowerMgmt
GetPowerStatus (ys) Param1: SlotId(U8),本控槽位号
Param2: PsonState(String),本控 PSON 状态
跨控 RPC 入口:返回本控 SlotId + PsonState。不受主从门控 ReadOnly
GetSsuPowerStates (a(ys)) Param1: SsuStates(Array),每个元素含 SsuId(U8) + PowerState(String,ON/OFF/ONING/OFFING) 跨控 RPC 入口:返回本控所有 SSU PowerState。不受主从门控 ReadOnly
GetState y Param1: State(U8),状态机状态(0-6) 跨控 RPC 入口:返回本控状态机 State。不受主从门控 ReadOnly

新增信号

无新增信号。

新增接口影响

路径 新增接口影响 CSR配置影响 持久化影响 其他影响
/bmc/kepler/DataStorage/SmmFruCtrl 对外提供整框上下电控制与状态查询功能 SmmFruCtrl CSR 属性绑定 ShortButtonEvent/LongButtonEvent/ACDownEvent/HardwarePowerOnConditions(CPLD Scanner,按 SlotId 选 offset+Mask);PSONSwitch 通过 SR Accessor_PwrPsOn 绑定 State 由 hwdiscovery 从 SR 重新加载;EEPROM ShelfAllowPowerOff 由本接口业务逻辑写入 需实现新增 8 个方法;接口所有权归 shelf_mgmt,已从 mdb_interface 迁移;不提供 WebREST 集合 URL

评审点2:新增资源协作接口 bmc.kepler.DataStorage.ControlledNode

注意事项
1)适用于新增未定义的资源协作接口以及接口下的属性、方法和信号描述。
2)接口设计应当遵循功能内聚、职责单一、接口抽象、支持扩展的基本原则。
3)接口设计主要评审接口关键字相关内容,组件模型实现关键字仅作为评审参考。

接口描述:受控节点(ExpBoard)单板属性接口,归属 DataStorage 整框管理功能域。按 SlotId 提供在位、共板、主备角色、上电状态。纯属性对象,无方法,由 hwdiscovery 根据 SR InstanceId 动态创建并通过 add_object_callback 推送给 smm_fructrl。不提供北向入口,仅资源树内部使用。接口由 shelf_mgmt 组件独占定义。

新增属性

属性名称 签名 只读 变化通知 属性描述 访问权限 属性来源 持久化类型 易变属性
SlotId y True false 受控节点槽位号(0-based),默认值为0,与 NodeLocation.LocationId 同源。path 占位符 :Id 由 SR InstanceId 填充,与 SlotId 属性同源但用途不同 Read: ReadOnly 掉电持久化 false
IsLocal b True false 是否为当前管理组件所在本控节点,true=本控,false=对控。运行时由本控 NodeLocation.LocationId 与对象 SlotId 比较得出,非硬件直读 Read: ReadOnly 掉电持久化 false
Present b True false 控制节点在位状态,true=在位,false=不在位。CSR 绑定 CPLD 寄存器 0x433 ctr_online,bit0=A控在位,bit1=B控在位 Read: ReadOnly 掉电持久化 false
IsMaster b True false 主备角色,true=Master,false=Standby。CSR 绑定 CPLD 寄存器 0x4e4 master_slave_flag,bit1:0=A控主从(01=主机),bit3:2=B控主从(01=主机) Read: ReadOnly 掉电持久化 false
PowerState b False true 受控节点上电状态,true=已上电,false=已下电,默认值为false。由 smm_fructrl 例测线程写入:本控读 fructrl Systems.FruCtrl.PowerState,对控走跨控 RPC;写入后经 bmc_datasync PropertySync 同步到对控 Read: ReadOnly
Write: PowerMgmt
掉电持久化 掉电持久化 true

新增方法

无新增方法。纯属性对象。

新增信号

无新增信号。

新增接口影响

路径 新增接口影响 CSR配置影响 持久化影响 其他影响
/bmc/kepler/DataStorage/ControlledNode/:Id 对外提供受控节点状态属性查询功能 5 个 CSR 属性绑定到 Scanner_SlotId 区分双控;SlotId/IsLocal/Present/IsMaster 绑定 CPLD Scanner,PowerState 由 smm_fructrl 例测线程周期写入 不涉及新增主键持久化 需实现新增 5 个属性;path 占位符 :Id 与业务属性 SlotId 区分(:Id 是路径枚举键,SlotId 是业务属性)

评审点3:新增资源协作路径 /bmc/kepler/DataStorage/SmmFruCtrl

注意事项
1)新增路径需要描述目的背景、功能用途等基本信息
2)新增资源协作接口需要增加独立的资源协作接口评审点,并排列在新增资源协作路径评审点之前

路径描述:整框上下电状态机根对象,归属 DataStorage 整框管理功能域。承载整框 State 属性(S0-S6),对外暴露整框 PowerCtrl / 单 SSU 控制 / 跨控 RPC 入口 / 多控状态查询。层级为机框整框管理根对象(单例),双控各持一份独立实例,主节点独占发布 State,从节点仅在内存跟随。

北向入口(资源 URI + 动作混合形态,对齐 BMC 单板 Systems/FruCtrl 既有形态):

北向 URI / 命令 HTTP/CLI 类型 映射资源树方法 说明
ipmcget -d shelfpowerstate CLI 资源 GetState + ControlledNode 遍历 输出 Shelf state + 各受控节点 PSON 状态
ipmcset -d shelfpowerstate -v 0~4 CLI 动作 PowerCtrl 0=Off, 1=On, 2=PowerCycle, 3=ForcePowerCycle, 4=ACCycle
GET /redfish/v1/Systems/Shelf/FruCtrl GET 资源 GetState + ControlledNode 遍历 返回 ShelfState/PsonState/SsuState/NodesPowerOff
POST /redfish/v1/Systems/Shelf/FruCtrl POST 动作 PowerCtrl body 中 OperateType 支持 On/Off/PowerCycle/ForcePowerCycle/ACCycle
ipmcget -d ssupowerstate [-s <ssuid>] CLI 资源 GetSsuPowerStates 聚合 查询全部或单个 SSU 上下电状态
ipmcset -d ssupowerstate -v 0~2 -s <ssuid> CLI 动作 SsuPowerCtrl 0=Off, 1=On, 2=ForceOff
GET /redfish/v1/Systems/SSU:ssuid/FruCtrl GET 资源 mapping_config 聚合 返回 SSU PowerState(ssuid 1-12)
POST /redfish/v1/Systems/SSU:ssuid/FruCtrl POST 动作 SsuPowerCtrl body 中 OperateType 支持 Off/On/ForceOff

主从门控:PowerCtrl/SsuPowerCtrl 受主从门控,仅主控执行写操作,从控转发到主控执行;Cycle 进行中拒绝 On/Off;On 时双控 ExpBoard 都下电则拒绝(返回 -1)。PsonCtrl/SSUCtrl/SetPowerPermission/GetPowerStatus/GetSsuPowerStates/GetState 六个跨控 RPC 入口不受主从门控。

实现接口

实现接口 实现接口描述 CSR配置影响 持久化影响 其他影响
bmc.kepler.DataStorage.SmmFruCtrl 整框状态机单例,对外提供 8 个方法 + State 属性;属性经 bmc_datasync 主从同步;多控 PSON 状态查询走 ControlledNode.PowerState 遍历 SmmFruCtrl CSR 属性绑定 CPLD Scanner/Accessor(按 SlotId 选 offset+Mask) State 由 hwdiscovery 从 SR 重新加载;EEPROM ShelfAllowPowerOff 由业务逻辑写入 需实现新增 8 个方法;接口所有权归 shelf_mgmt;不提供 WebREST 集合 URL

评审点4:新增资源协作路径 /bmc/kepler/DataStorage/ControlledNode/:Id

注意事项
1)新增路径需要描述目的背景、功能用途等基本信息
2)新增资源协作接口需要增加独立的资源协作接口评审点,并排列在新增资源协作路径评审点之前

路径描述:框内受控节点(ExpBoard)单板对象,归属 DataStorage 整框管理功能域。按 SlotId 提供在位、共板、主备角色、上电状态。层级为机框、管理板。由 hwdiscovery 根据 SR InstanceId 动态创建并通过 add_object_callback 推送给 smm_fructrl。不提供北向入口,仅资源树内部使用,CLI/Redfish 通过遍历 ControlledNode.PowerState 聚合展示多控 PSON 状态。

实现接口

实现接口 实现接口描述 CSR配置影响 持久化影响 其他影响
bmc.kepler.DataStorage.ControlledNode 受控节点纯属性对象(5 个全部 CSR),由 hwdiscovery 动态创建;smm_fructrl 订阅对象增删回调同步业务列表;PowerState 由例测线程周期写入(本控读 fructrl + 对控跨控 RPC) 5 个 CSR 属性绑定到 Scanner_SlotId 区分双控 不涉及新增主键持久化 需实现新增 5 个属性;无方法;path 占位符 :Id 与业务属性 SlotId 区分

评审关注点


遗留问题


是否准备好AI预审

是

评审结论

是否需要提供这么多个控制接口,确认是否通过path驱动控制对象实现。

议题名称与评审点不符合

  1. 确认是需要多个状态获取接口
  2. 直接通过属性承载是否可以

接口标题过大,容易形成一个属性、方法大杂烩,建议按照具体功能点拆分

需要重新思考层级关系

参考AggregationService是否可以复用接口