component_drivers:基于 openUBMC 的 BMC 硬件部件驱动项目

基于服务器管理南向接口技术要求实现的部件驱动库。Hardware component drivers framework with unified management interface

分支2Tags0
文件最后提交记录最后更新时间
2 个月前
1 个月前
11 个月前
14 天前
24 天前
14 天前
14 天前
15 天前
1 个月前
14 天前
14 天前
14 天前
4 个月前
4 个月前
1 个月前
14 天前
2 个月前
1 个月前
4 个月前
3 个月前
1 年前
2 个月前
14 天前
14 天前
14 天前
4 个月前
14 天前
23 天前
1 个月前
16 天前
1 个月前

component_drivers

验证说明:本文档是 component_drivers 组件构建与测试的唯一指导文档,验证流程请严格按本文档执行。docs/ 目录下的文档为特性说明文档,不涉及构建流程。本组件支持 Ubuntu 24.04 LTS(x86-64) 和 openEuler 24.03 LTS(aarch64/Kunpeng) 构建,推荐使用 Ubuntu 24.04 LTS;CentOS、Debian 等其他系统均不支持,不要尝试使用其他镜像替代。

component_drivers 是 openUBMC 的部件驱动组件,提供硬件设备驱动基础框架和特定设备适配器实现(如 PCIe 网卡、GPU、PSU、VRD 等驱动),用于监控和管理各种硬件设备。


目录


仓库地址

https://gitcode.com/openUBMC/component_drivers


系统要求

项目 要求
操作系统 Ubuntu 24.04 LTS(x86-64,推荐)
openEuler 24.03 LTS(aarch64/Kunpeng,验证基线 LTS-SP4)
芯片架构 x86-64(amd64)、aarch64(arm64)
Python >= 3.10(init.py 运行依赖)

bingo、Conan 等构建工具由 init.py 自动安装,无需手动准备。

容器构建镜像

推荐使用 Docker 容器进行构建,可使用以下镜像快速启动开发环境。

x86-64(Ubuntu,推荐)

docker pull swr.cn-north-4.myhuaweicloud.com/openubmc/ubuntu:24.04.2_26.06

aarch64(openEuler,ARM 构建)

docker pull --platform linux/arm64 swr.cn-north-4.myhuaweicloud.com/openubmc/openeuler:20261024_1

环境依赖

构建 component_drivers 前需完成 openUBMC 开发环境初始化(安装 bingo、Conan、Node.js、配置 Conan 远程仓库等)。完整初始化步骤和常见问题排查请参阅 openUBMC 构建指导书,该文档包含容器环境搭建、init.py 执行、Conan 登录验证等全部操作说明。

禁止手动安装 bingo 和 Conan:手动安装(如 pip install conan)会导致 Conan 远程仓库认证失败,bingo build 无法拉取依赖包。所有构建工具必须通过 manifest 仓库的 init.py 流程一键安装。


构建

获取组件代码

前提:已完成 环境依赖 中的 init.py 初始化流程,bingo 和 conan 命令可用。

cd /home/workspace
git clone https://gitcode.com/openUBMC/component_drivers.git

组件级构建

进入 component_drivers 组件目录后,使用 bingo 执行构建:

cd /home/workspace/component_drivers

# 默认 dev 阶段构建
bingo build --stage=dev

# 构建并发布到 stable 阶段
bingo build --stage=stable

# Release 类型构建
bingo build --stage=dev -bt release

本地 Meson 构建(smart_build.sh)

不走 bingo/Conan 时,在组件目录执行:

./scripts/smart_build.sh

新装 Ubuntu 24.04 上脚本会先用 apt 补齐宿主依赖,再编译。已安装的包会跳过。2026-10 时 Ubuntu 24.04 软件源中的对应版本为:meson 1.3.2、ninja 1.11.1、pkg-config 1.8.1、moreutils 0.69(提供日志时间戳命令 ts)、Lua 5.4.6(liblua5.4-dev)。没有 conan temp 里的 Lua 时,自动改用这份系统 Lua 5.4,避免 meson: command not found 和 mcapp 找不到 lua.h。

自动安装仅覆盖 Ubuntu(apt)。openEuler/aarch64 环境需先手动安装宿主依赖:

dnf install -y meson ninja-build pkgconf gcc gcc-c++ git python3 file ccache \
  boost-devel gtest-devel glib2-devel dbus-devel openssl-devel zlib-devel sqlite-devel lua-devel

openEuler 软件源不提供 moreutils(ts)和 lcov:脚本缺少 ts 时仅告警并继续编译,也可设置 SMART_BUILD_NO_TIMESTAMP=1 关闭时间戳;使用 --coverage 时需自行准备 lcov。

构建参数说明

bingo build [-h] [-bt BUILD_TYPE] [--stage STAGE] [-u] [-r REMOTE] [--conan2] [-nc] [-o OPTIONS] [--user USER] [-wb] [--ccache]
参数 说明 默认值
-bt / --build_type 构建类型,可选 debug、release debug
--stage 包发布阶段,可选 dev、pre、rc、stable dev
-u / --upload 上传组件包到 Conan 仓库 —
-r / --remote Conan 仓库别名 —
--conan2 强制使用 Conan2 构建组件 —
-nc / --no_cache 强制更新 Conan 缓存依赖 —
-o / --options 定义组件选项值 —
--user 指定 Conan 包的 user 字段 openubmc
-wb / --without_build 不强制源码构建组件自身 —
--ccache 使用 ccache 加速 C/C++ 编译 —

component_drivers 支持的组件选项(-o 参数):

选项 说明 默认值
asan 启用 AddressSanitizer False
gcov 启用代码覆盖率 False
test 启用测试构建 False
enable_luajit 启用 LuaJIT False
unidev 启用统一开发模式 False

测试

使用 bingo test 运行各类测试,需加 -jit 参数,否则测试会失败:

# 运行单元测试
bingo test -ut -jit

# 运行集成测试
bingo test -it -jit

# 运行单元测试并指定过滤
bingo test -ut -jit -f <filter>

# 运行单元测试并启用 ASAN
bingo test -ut -jit -as

# 运行 clang-tidy 静态检查
bingo test -ct -jit

常用测试参数:

参数 说明
-ut 启用单元测试
-it 启用集成测试
-mt 启用 mock 测试
-ft 启用 fuzz 测试
-f 测试过滤
-jit 需加此参数,否则测试会失败
-as 启用 AddressSanitizer
-ct 启用 clang-tidy 静态检查(详见 CONTRIBUTING.md)

项目结构

component_drivers/
├ include/              # 公共头文件
├ drivers/              # 驱动实现
│   ├ csr1/             # CSR 驱动
│   ├ internal/         # 内部驱动
│   ├ pcie_gpu_card/    # PCIe GPU 卡驱动
│   ├ pcie_nic_card/    # PCIe 网卡驱动
│   ├ psu/              # PSU 电源驱动
│   ├ scanner/          # Scanner 扫描器
│   └ vrd/              # VRD 电压调节驱动
├ libraries/            # 内部库(canbus, pmbus 等)
├ dmc/                  # Device Management Contract(设备管理契约 JSON)
├ scripts/              # 构建/测试/CI 脚本
├ tests/                # 测试数据与用例
├ docs/                 # 特性说明与驱动规范文档
├ stub/                 # Stub 文件
├ subprojects/          # Meson 子项目
├ conanfile.py          # Conan 构建定义
├ meson.build           # Meson 构建定义
├ meson_options.txt     # Meson 构建选项
├ LICENSE               # Mulan PSL v2 许可证
├ CHANGELOG             # 变更日志
└ README.md             # 本文件

文档导航


许可证

本项目基于 Mulan PSL v2 许可证开源。详情请参阅:http://license.coscl.org.cn/MulanPSL2

项目介绍

基于服务器管理南向接口技术要求实现的部件驱动库。Hardware component drivers framework with unified management interface

定制我的领域