CSR配置字典之CSR公共配置
更新时间:2025/7/12
在Gitcode上查看源码📋 文档信息
| 项目 | 内容 |
|---|---|
| 文档标题 | CSR公共配置字典 |
| 版本 | v1.0 |
| 创建日期 | 2025-07-12 |
| 最后更新 | 2025-07-12 |
| 维护状态 | ✅ 活跃维护 |
📋 变更历史记录
| 版本 | 发布日期 | 变更类型 | 变更内容 | 影响范围 | 维护人员 |
|---|---|---|---|---|---|
| v1.0 | 2025-07-12 | 初始版本 | 创建CSR公共配置字典 | 全新文档 | Hardware SIG |
🎯 类概览
CSR公共配置
| 属性 | 值 |
|---|---|
| 类名称 | CSR公共配置 |
| 功能描述 | 定义所有CSR文件必须包含的基础配置信息,包括协议版本和数据版本 |
| 所属SIG组 | TC |
| 所属组件 | CSR框架 |
| 责任人 | TC |
| 最后更新 | 2025-07-12 |
| 状态 | 🟢 正常运行 |
📊 属性定义详表
必选属性
| 属性名 | 类型 | 默认值 | 取值范围 | 动态关联 | 描述 | 使用场景 | 举例 | 来源 | 分类 |
|---|---|---|---|---|---|---|---|---|---|
FormatVersion | String | N/A | 1.00 - 255.99 | - | FormatVersion为A.BC样式(A取值范围为1-255, B、C取值范围是0-9),范围约束: A为大版本,范围:1-255 BC为小版本,范围:01-99,小版本固定两位,不足两位需要补0 | CSR协议版本号 | "3.00" | CSR | 软件 |
DataVersion | String | N/A | 1.00 - 255.99 | - | DataVersion为A.BC样式(A取值范围为1-9, B、C取值范围是0-9),范围约束: A为大版本,范围:1-9 BC为小版本,范围:01-99,小版本固定两位,不足两位需要补0 | CSR数据版本号 | "3.00" | CSR | 硬件 |
可选属性
| 属性名 | 类型 | 默认值 | 取值范围 | 动态关联 | 描述 | 使用场景 | 举例 | 来源 | 分类 |
|---|---|---|---|---|---|---|---|---|---|
| 无 | - | - | - | - | - | - | - | - | - |
🔗 动态关联机制
语法规范
CSR公共配置为基础配置,不涉及动态关联。
📂 分类标准
软件属性
- 定义:用于CSR协议版本控制的参数
- 特点:由CSR框架定义和管理
- 示例:
FormatVersion
硬件属性
- 定义:与硬件数据版本相关的参数
- 特点:与硬件配置版本对应
- 示例:
DataVersion
📝 配置示例
标准CSR公共配置
json
{
"FormatVersion": "3.00",
"DataVersion": "3.00"
}完整CSR文件头部
json
{
"FormatVersion": "3.00",
"DataVersion": "3.00",
"Objects": {
"Scanner": {
// Scanner配置
},
"Accessor": {
// Accessor配置
},
"Component": {
// Component配置
}
}
}版本升级示例
json
{
"FormatVersion": "3.01",
"DataVersion": "3.00"
}高版本兼容性配置
json
{
"FormatVersion": "4.00",
"DataVersion": "4.00"
}🔧 使用指南
配置步骤
- 确定协议版本:根据BMC固件支持的版本设置
FormatVersion - 设置数据版本:根据硬件配置版本设置
DataVersion - 版本兼容性检查:确保版本号与系统兼容
- 格式验证:确保版本号格式符合A.BC规范
注意事项
- 版本号格式:必须严格按照
A.BC格式,小版本号不足两位需要补0 - 大版本范围:
FormatVersion的A范围为1-255,DataVersion的A范围为1-9 - 小版本范围:BC范围为
01-99,固定两位数 - 兼容性检查:升级前需要验证版本兼容性
- 文档同步:版本变更时需要同步更新相关文档
版本管理建议
FormatVersion管理:- 重大协议变更时增加大版本号
- 小幅协议修改时增加小版本号
- 保持与BMC固件版本的兼容性
DataVersion管理:- 硬件配置重大变更时增加大版本号
- 硬件配置小幅修改时增加小版本号
- 与硬件BOM版本保持对应关系
最佳实践
- 版本一致性:同一产品的所有CSR文件应使用相同的版本号
- 版本追溯:建立版本变更记录,便于问题追溯
- 兼容性测试:版本升级前进行充分的兼容性测试
- 文档维护:及时更新版本相关的文档和说明