RAID 驱动规范
NOTE
契约 SSOT:dmc/。总览见 3-DeviceMgmtContract.md。 方案与协议栈背景:部件驱动开发简介、设备驱动开发指南。
1. 概述
本规范定义 PCIe RAID 卡(DeviceCategory: PCIeRaidCard)南向驱动需实现的对象树与 bmc.dev.Storage.* 接口组合。部件按契约实现后,可被 devmon 挂载到 /bmc/dev/StorageControllers/... 设备树。
RAID 驱动通常通过 SML(Storage Management Library)等存储管理库访问控制器,把控制器、逻辑盘、物理盘、BBU、DiskArray、Expander 等映射到设备树,因此本规范只约束「设备树上出现什么对象、每个对象组合哪些接口」,不约束库的调用方式。
设备特有器件通常包括:
- RAID 卡本体(控制器),对应主对象
PCIeRaidCard - 逻辑盘(Volume)与磁盘阵列(DiskArray)
- 控制器下的物理盘(Drive)
- 掉电保护单元(BBU)与端口扩展器(Expander)及其 PHY
入库状态
| 项 | 状态 |
|---|---|
dmc/intf(Storage.Controller* / Volume* / Drive* / BBU* / DiskArray* / Expander* / PCIeDevice* / PCIeCard) | 已有 |
dmc/path/.../PCIeRaidCard/ | 已有 PCIeRaidCard/(8 份 path 定义) |
| 型号 DDS | 已有,drivers/pcie_raid_card/lsi/csr/ 下 7 份,如 14140130_100010e2_10004010.dds |
2. 设备树
/bmc/dev/StorageControllers/{ControllerId}
├── Volumes/{VolumeId}
├── Drives/{DriveId}
├── BBUs/{BbuId}
├── DiskArrays/{ArrayId}
├── Expanders/{ExpanderId}
│ └── PHYs/{PhyId} # ExpanderPHY
└── PHYs/{PhyId} # ControllerPHY| 对象 | path 定义 | 说明 |
|---|---|---|
| PCIeRaidCard | PCIeRaidCard.json | RAID 卡主对象(控制器) |
| Volume | Volume.json | 逻辑盘 |
| Drive | Drive.json | 控制器下的物理盘 |
| BBU | BBU.json | 掉电保护单元 |
| DiskArray | DiskArray.json | 磁盘阵列 |
| Expander | Expander.json | 端口扩展器 |
| ControllerPHY | ControllerPHY.json | 控制器 PHY |
| ExpanderPHY | ExpanderPHY.json | 扩展器 PHY |
NOTE
命名说明:根路径是 /bmc/dev/StorageControllers/{ControllerId},既不在 Systems 下也不在 Chassis 下,不带 SystemId;型号 DDS 里写作 "Path": "/bmc/dev/StorageControllers/:Id"(如 drivers/pcie_raid_card/lsi/csr/14140130_100010e2_10004010.dds),与 dmc 的 {ControllerId} 语义一致。主对象类别名固定为 PCIeRaidCard。
3. 对象–接口矩阵
3.1 PCIeRaidCard(控制器)
| 接口 | 必选/可选 | dmc/intf |
|---|---|---|
bmc.dev.PCIeDevice | 必选 | PCIeDevice.json |
bmc.dev.PCIeDevice.PCIeFunction | 必选 | PCIeDevice/PCIeFunction.json |
bmc.dev.PCIeDevice.Status | 必选 | PCIeDevice/Status.json |
bmc.dev.PCIeDevice.Bandwidth | 必选 | PCIeDevice/Bandwidth.json |
bmc.dev.PCIeDevice.Oem | 必选 | PCIeDevice/Oem.json |
bmc.dev.PCIeCard | 必选 | PCIeCard.json |
bmc.dev.Storage.Controller | 必选 | Storage/Controller.json |
bmc.dev.Storage.Controller.Capability | 必选 | Storage/Controller/Capability.json |
bmc.dev.Storage.Controller.Capability.AccessPolicy | 必选 | Storage/Controller/Capability/AccessPolicy.json |
bmc.dev.Storage.Controller.Capability.DiskCachePolicy | 必选 | Storage/Controller/Capability/DiskCachePolicy.json |
bmc.dev.Storage.Controller.Capability.DiskWriteCachePolicy | 必选 | Storage/Controller/Capability/DiskWriteCachePolicy.json |
bmc.dev.Storage.Controller.Capability.IOPolicy | 必选 | Storage/Controller/Capability/IOPolicy.json |
bmc.dev.Storage.Controller.Capability.Mode | 必选 | Storage/Controller/Capability/Mode.json |
bmc.dev.Storage.Controller.Capability.RAIDLevel | 必选 | Storage/Controller/Capability/RAIDLevel.json |
bmc.dev.Storage.Controller.Capability.ReadPolicy | 必选 | Storage/Controller/Capability/ReadPolicy.json |
bmc.dev.Storage.Controller.Capability.WritePolicy | 必选 | Storage/Controller/Capability/WritePolicy.json |
bmc.dev.Storage.Controller.ForeignConfigurations | 必选 | Storage/Controller/ForeignConfigurations.json |
bmc.dev.Storage.Controller.LogCollection | 必选 | Storage/Controller/LogCollection.json |
bmc.dev.Storage.Controller.Metrics | 必选 | Storage/Controller/Metrics.json |
bmc.dev.Storage.Controller.Oem | 必选 | Storage/Controller/Oem.json |
bmc.dev.Storage.Controller.OOB | 必选 | Storage/Controller/OOB.json |
bmc.dev.Storage.Controller.Settings | 必选 | Storage/Controller/Settings.json |
bmc.dev.Storage.Controller.Status | 必选 | Storage/Controller/Status.json |
bmc.dev.Upgrade | 可选 | Upgrade.json |
NOTE
控制器带外接口名是 bmc.dev.Storage.Controller.OOB(三个字母,不是 OB)。bmc.dev.Upgrade 在 path 声明中可选:参考实现 drivers/pcie_raid_card/lsi/lsi_9560/lsi_9560_card.h:61-62 的 MC_OBJECT 组合了上表其余 23 个接口,未组合 Upgrade。
3.2 Volume(逻辑盘)
| 接口 | 必选/可选 | dmc/intf |
|---|---|---|
bmc.dev.Storage.Volume | 必选 | Storage/Volume.json |
bmc.dev.Storage.Volume.Association | 必选 | Storage/Volume/Association.json |
bmc.dev.Storage.Volume.Policy | 必选 | Storage/Volume/Policy.json |
bmc.dev.Storage.Volume.Settings | 必选 | Storage/Volume/Settings.json |
bmc.dev.Storage.Volume.Status | 必选 | Storage/Volume/Status.json |
3.3 Drive(控制器下物理盘)
| 接口 | 必选/可选 | dmc/intf |
|---|---|---|
bmc.dev.Storage.Drive | 必选 | Storage/Drive.json |
bmc.dev.Storage.Drive.Association | 必选 | Storage/Drive/Association.json |
bmc.dev.Storage.Drive.Interface | 必选 | Storage/Drive/Interface.json |
bmc.dev.Storage.Drive.Led | 必选 | Storage/Drive/Led.json |
bmc.dev.Storage.Drive.Metrics | 必选 | Storage/Drive/Metrics.json |
bmc.dev.Storage.Drive.PhysicalContext | 必选 | Storage/Drive/PhysicalContext.json |
bmc.dev.Storage.Drive.Settings | 必选 | Storage/Drive/Settings.json |
bmc.dev.Storage.Drive.Status | 必选 | Storage/Drive/Status.json |
3.4 BBU(掉电保护单元)
| 接口 | 必选/可选 | dmc/intf |
|---|---|---|
bmc.dev.Storage.BBU | 必选 | Storage/BBU.json |
bmc.dev.Storage.BBU.Status | 必选 | Storage/BBU/Status.json |
3.5 DiskArray(磁盘阵列)
| 接口 | 必选/可选 | dmc/intf |
|---|---|---|
bmc.dev.Storage.DiskArray | 必选 | Storage/DiskArray.json |
bmc.dev.Storage.DiskArray.Association | 必选 | Storage/DiskArray/Association.json |
3.6 Expander(端口扩展器)
| 接口 | 必选/可选 | dmc/intf |
|---|---|---|
bmc.dev.Storage.Expander | 必选 | Storage/Expander.json |
bmc.dev.Storage.Expander.PhysicalContext | 必选 | Storage/Expander/PhysicalContext.json |
bmc.dev.Storage.Expander.Status | 必选 | Storage/Expander/Status.json |
3.7 PHY 子对象
控制器 PHY(/bmc/dev/StorageControllers/{ControllerId}/PHYs/{PhyId}):
| 接口 | 必选/可选 | dmc/intf |
|---|---|---|
bmc.dev.Storage.Controller.PHY | 必选 | Storage/Controller/PHY.json |
bmc.dev.Storage.Controller.PHY.Metrics | 必选 | Storage/Controller/PHY.Metrics.json |
扩展器 PHY(/bmc/dev/StorageControllers/{ControllerId}/Expanders/{ExpanderId}/PHYs/{PhyId}):
| 接口 | 必选/可选 | dmc/intf |
|---|---|---|
bmc.dev.Storage.Expander.PHY | 必选 | Storage/Expander/PHY.json |
bmc.dev.Storage.Expander.PHY.Metrics | 必选 | Storage/Expander/PHY.Metrics.json |
NOTE
PHY.Metrics 是两个接口文件 Storage/Controller/PHY.Metrics.json、Storage/Expander/PHY.Metrics.json(用点号连写),不是 PHY/Metrics.json 目录,按接口名逐级展开会找错路径。子对象的接口集合与参考实现一一对应:lsi_9560_volume.h:33-35、lsi_9560_drive.h:39-41、lsi_9560_bbu.h:27、lsi_9560_diskarray.h:27、lsi_9560_expander.h:26-27、lsi_9560_controller_phy.h:27-28、lsi_9560_expander_phy.h:25。
属性与方法细节以 dmc/intf/bmc/dev/Storage/** 为准,本文不重复。
4. 与独立 NVMe 的边界
| 场景 | 归属规范 | 对象与接口 |
|---|---|---|
| 独立挂在 System 下的 PCIe NVMe 盘 | 《硬盘驱动规范》(component_driver/hdd_adapt/hdd_driver_spec.md) | PCIeNVMe + bmc.dev.NVMe.* |
| RAID 控制器下的物理盘 | 本文 | Drives/{DriveId} + bmc.dev.Storage.Drive.* |
| RAID 控制器下的逻辑盘 | 本文 | Volumes/{VolumeId} + bmc.dev.Storage.Volume.* |
同一个物理盘可能既被 RAID 控制器枚举、又被独立 NVMe 驱动枚举,两者挂在不同对象上,接口集合不重合,不要互相复用驱动实现。
5. 相关文档
- 3-DeviceMgmtContract.md
- 3.4 RAID 驱动规范(上游归档版本,本仓版本以本文为准)
docs/zh/release_designs/openUBMC RAID南向部件驱动特性设计说明书.md(特性设计视角,接口名以dmc为准)- 驱动实现:
drivers/pcie_raid_card/