CSR配置字典之UartCircularLog类
更新时间： 2026/05/11
在Gitcode上查看源码📋 文档信息
| 项目 | 内容 |
|---|---|
| 文档标题 | UartCircularLog类配置字典 |
| 版本 | v1.0 |
| 创建日期 | 2026/05/11 |
| 最后更新 | 2026/05/11 |
| 维护状态 | ✅ 活跃维护 |
📋 变更历史记录
文档变更记录
| 版本 | 发布日期 | 变更类型 | 变更内容 | 影响范围 | 维护人员 |
|---|---|---|---|---|---|
| v1.0 | 2026/05/11 | 初始版本 | 创建UartCircularLog类配置字典 | 全新文档 | bmc_soc组件组 |
🎯 类概览
UartCircularLog 类
| 属性 | 值 |
|---|---|
| 类名称 | UartCircularLog |
| 功能描述 | 串口环形日志配置管理，支持日志方向、大小、自动采集、文件命名、时间戳等配置 |
| 所属SIG组 | hardware |
| 所属组件 | bmc_soc |
| 责任人 | 基础服务组 |
| 最后更新 | 2026/05/11 |
| 状态 | 🟢 正常运行 |
📊 属性定义详表
UartCircularLog 类 - 必选属性
| 属性名 | 类型 | 默认值 | 取值范围 | 动态关联 | 描述 | 使用场景 | 举例 | 来源 | 分类 |
|---|---|---|---|---|---|---|---|---|---|
Id | U8 | - | U8 | - | 串口环形日志通道标识 | 配置日志通道 | 0 | CSR | 软件 |
LogDirection | U8 | - | U8 | - | 日志记录方向 | 配置日志方向 | 0 | CSR | 软件 |
RxSize | U8 | - | U8 | - | 接收缓冲区大小 | 配置接收日志大小 | 10 | CSR | 软件 |
TxSize | U8 | - | U8 | - | 发送缓冲区大小 | 配置发送日志大小 | 10 | CSR | 软件 |
IsSysCom | U8 | - | U8 | - | 是否为系统串口 | 配置串口类型 | 1 | CSR | 软件 |
LogEnable | U8 | - | U8 | - | 日志使能开关 | 配置日志开关 | 1 | CSR | 软件 |
AutoCollect | U8 | - | U8 | - | 自动采集开关 | 配置自动采集 | 1 | CSR | 软件 |
LogFileName | String | - | String | - | 日志文件名 | 配置日志文件名 | "uart_log" | CSR | 软件 |
UartCircularLog 类 - 可选属性
| 属性名 | 类型 | 默认值 | 取值范围 | 动态关联 | 描述 | 使用场景 | 举例 | 来源 | 分类 |
|---|---|---|---|---|---|---|---|---|---|
SystemId | U8 | 255 | U8 | - | 系统标识 | 配置系统编号 | 255 | CSR | 软件 |
TimestampEnable | Boolean | true | Boolean | - | 使能按时间间隔阈值记录串口日志时间戳 | 配置时间戳功能 | true | CSR | 软件 |
TimestampInterval | U16 | 10 | U16 | - | 距离上次记录串口日志的时间间隔超过该值后，下一次日志写入时插入时间戳（单位：分钟） | 配置时间戳间隔 | 10 | CSR | 软件 |
📝 配置示例
串口环形日志配置
json
{
"UartCircularLog": {
"Id": 0,
"LogDirection": 0,
"RxSize": 10,
"TxSize": 10,
"IsSysCom": 1,
"LogEnable": 1,
"AutoCollect": 1,
"SystemId": 255,
"LogFileName": "uart_log",
"TimestampEnable": true,
"TimestampInterval": 10
}
}🔧 使用指南
配置步骤
配置日志通道标识：设置 Id 确定日志通道编号
配置日志方向：设置 LogDirection 控制日志记录方向
配置缓冲区大小：设置 RxSize/TxSize 配置接收和发送缓冲区
配置日志使能：设置 LogEnable 开启或关闭日志功能
配置自动采集：设置 AutoCollect 控制是否自动采集日志
配置时间戳：设置 TimestampEnable 和 TimestampInterval 控制时间戳功能
注意事项
LogEnable=1 时启用日志记录，LogEnable=0 时关闭
TimestampInterval 单位为分钟，建议设置为 5-30 分钟之间
日志文件采用环形存储，新日志会覆盖旧日志
IsSysCom=1 表示系统串口，IsSysCom=0 表示普通串口
故障排查
日志无记录：检查 LogEnable 是否为 1
时间戳间隔异常：检查 TimestampInterval 配置值是否合理
日志覆盖过快：增大 RxSize/TxSize 或缩短 TimestampInterval