CSR配置字典之UsbLocalOMService类
更新时间:2025/7/29
在Gitcode上查看源码

📋 文档信息

项目内容
文档标题UsbLocalOMService类配置字典
版本v1.0
创建日期2025-07-29
最后更新2025-07-29
维护状态✅ 活跃维护

📋 变更历史记录

文档变更记录

版本发布日期变更类型变更内容影响范围维护人员
v1.02025-07-29初始版本创建UsbLocalOMService类配置字典全新文档系统管理员

🎯 类概览

UsbLocalOMService 类

属性
类名称UsbLocalOMService
功能描述USB近端运维服务管理,提供USB Type-C功能支持、CC芯片管理、LED状态控制和网络配置功能
所属SIG组interface
所属组件usb_entry
最后更新2025-07-29
状态🟢 正常运行

📊 属性定义详表

必选属性

属性名类型默认值取值范围动态关联描述使用场景举例来源分类
SupportedBoolean-Boolean-是否支持USB Type-C功能是否支持近端运维功能trueCSR配置软件
PresenceBoolean-BooleanScanner_RightEar面板USB口是否在位是否支持近端运维功能"<=/Scanner_RightEar.Value"硬件代理提供硬件
RefCcChipOnString-U8[]Chip_UsbCc_On引用的On厂商的CC chip用于近端运维功能"#/Chip_UsbCc_On"CSR配置硬件
RefCcChipSgmString-U8[]Chip_UsbCc_Sgm引用的Sgm厂商的CC chip用于近端运维功能"#/Chip_UsbCc_Sgm"CSR配置硬件
CcChipOnAttachStatusString-U8Scanner_CcChipOnAttachStatusUSB设备接入状态用于近端运维功能"#/Scanner_CcChipOnAttachStatus.Value"CSR配置硬件
CcChipSgmAttachStatusString-U8Scanner_CcChipSgmAttachStatusUSB设备接入状态用于近端运维功能"#/Scanner_CcChipSgmAttachStatus.Value"CSR配置硬件
GLedStatusString-U8Accessor_USBGreenLed绿灯状态用于近端运维点灯"#/Accessor_USBGreenLed.Value"CSR配置硬件
RLedStatusString-U8Accessor_USBRedLed红灯状态用于近端运维点灯"#/Accessor_USBRedLed.Value"CSR配置硬件
RndisHostIpAddrString-String-USB0口配置的IP,软件内无默认值用于近端网络功能"169.254.1.5"CSR配置软件
PortNumU8-U8-复合设备USB口,软件内无默认值用于近端网络功能3CSR配置软件

可选属性

属性名类型默认值取值范围动态关联描述使用场景举例来源分类
EnabledBooleantrueBoolean-USB Type-C功能使能状态用于控制USB Type-C功能开关trueCSR配置软件
CcChipSupportedBooleantrueBoolean-该机型是否支持CC芯片,默认为true表示支持CC芯片,目前只有A+X机型配置为false用于近端网络功能trueCSR配置软件

🔗 动态关联机制

语法规范

使用 #/xxx<=/xxx 格式实现动态关联:

yaml
# USB在位状态读取
Presence: "<=/Scanner_RightEar.Value"

# CC芯片关联
RefCcChipOn: "#/Chip_UsbCc_On"
RefCcChipSgm: "#/Chip_UsbCc_Sgm"

# 设备接入状态读取
CcChipOnAttachStatus: "#/Scanner_CcChipOnAttachStatus.Value"
CcChipSgmAttachStatus: "#/Scanner_CcChipSgmAttachStatus.Value"

# LED状态控制
GLedStatus: "#/Accessor_USBGreenLed.Value"
RLedStatus: "#/Accessor_USBRedLed.Value"

关联说明

  • Presence: 关联Scanner对象读取USB口在位状态
  • RefCcChipOn/RefCcChipSgm: 关联CC芯片对象
  • CcChipOnAttachStatus/CcChipSgmAttachStatus: 关联Scanner对象读取设备接入状态
  • GLedStatus/RLedStatus: 关联Accessor对象控制LED状态

📂 分类标准

硬件属性

  • 定义:与硬件USB设备直接相关的参数
  • 特点:通过硬件代理读取状态或控制硬件
  • 示例Presence, RefCcChipOn, RefCcChipSgm, CcChipOnAttachStatus, CcChipSgmAttachStatus, GLedStatus, RLedStatus

软件属性

  • 定义:用于软件逻辑控制和配置管理的参数
  • 特点:由CSR配置管理,用于功能控制和网络配置
  • 示例Supported, Enabled, RndisHostIpAddr, CcChipSupported, PortNum

📝 配置示例

标准USB近端运维配置

json
{
  "UsbLocalOMService": {
    "Supported": true,
    "Presence": "<=/Scanner_RightEar.Value",
    "Enabled": true,
    "RefCcChipOn": "#/Chip_UsbCc_On",
    "RefCcChipSgm": "#/Chip_UsbCc_Sgm",
    "CcChipOnAttachStatus": "#/Scanner_CcChipOnAttachStatus.Value",
    "CcChipSgmAttachStatus": "#/Scanner_CcChipSgmAttachStatus.Value",
    "GLedStatus": "#/Accessor_USBGreenLed.Value",
    "RLedStatus": "#/Accessor_USBRedLed.Value",
    "RndisHostIpAddr": "169.254.1.5",
    "CcChipSupported": true,
    "PortNum": 3
  }
}

A+X机型配置(不支持CC芯片)

json
{
  "UsbLocalOMService": {
    "Supported": true,
    "Presence": "<=/Scanner_RightEar.Value",
    "Enabled": true,
    "RefCcChipOn": "#/Chip_UsbCc_On",
    "RefCcChipSgm": "#/Chip_UsbCc_Sgm",
    "CcChipOnAttachStatus": "#/Scanner_CcChipOnAttachStatus.Value",
    "CcChipSgmAttachStatus": "#/Scanner_CcChipSgmAttachStatus.Value",
    "GLedStatus": "#/Accessor_USBGreenLed.Value",
    "RLedStatus": "#/Accessor_USBRedLed.Value",
    "RndisHostIpAddr": "169.254.1.10",
    "CcChipSupported": false,
    "PortNum": 2
  }
}

禁用USB功能配置

json
{
  "UsbLocalOMService": {
    "Supported": false,
    "Presence": "<=/Scanner_RightEar.Value",
    "Enabled": false,
    "RefCcChipOn": "#/Chip_UsbCc_On",
    "RefCcChipSgm": "#/Chip_UsbCc_Sgm",
    "CcChipOnAttachStatus": "#/Scanner_CcChipOnAttachStatus.Value",
    "CcChipSgmAttachStatus": "#/Scanner_CcChipSgmAttachStatus.Value",
    "GLedStatus": "#/Accessor_USBGreenLed.Value",
    "RLedStatus": "#/Accessor_USBRedLed.Value",
    "RndisHostIpAddr": "169.254.1.1",
    "CcChipSupported": true,
    "PortNum": 1
  }
}

🔧 使用指南

配置步骤

  1. 设置功能支持:配置Supported标识是否支持USB Type-C功能
  2. 关联在位检测:通过Presence关联USB口在位检测
  3. 关联CC芯片:通过RefCcChipOn和RefCcChipSgm关联CC芯片
  4. 关联状态检测:通过CcChipOnAttachStatus和CcChipSgmAttachStatus关联设备接入状态
  5. 关联LED控制:通过GLedStatus和RLedStatus关联LED控制
  6. 配置网络参数:设置RndisHostIpAddr
  7. 配置USB口类型:设置PortNum
  8. 可选配置:根据需要配置Enabled和CcChipSupported
  9. 验证关联:确保所有关联对象已正确定义

注意事项

  • 功能支持:Supported必须根据实际硬件能力设置
  • CC芯片支持:CcChipSupported在A+X机型中需设置为false
  • 网络配置:RndisHostIpAddr必须配置有效的IP地址
  • 在位检测:Presence必须关联有效的Scanner对象
  • LED控制:GLedStatus和RLedStatus必须关联有效的Accessor对象

故障排查

  • USB功能不可用:检查Supported和Enabled配置
  • 设备检测失败:检查Presence和CcChipAttachStatus关联对象
  • LED不亮:检查GLedStatus和RLedStatus关联的Accessor对象
  • 网络连接失败:检查RndisHostIpAddr和PortNum配置
  • CC芯片异常:检查RefCcChipOn和RefCcChipSgm关联对象

USB Type-C功能管理

  • 功能控制:通过Supported和Enabled控制USB Type-C功能
  • 在位检测:通过Presence检测USB口物理在位状态
  • 设备接入:通过CcChipAttachStatus检测设备接入状态
  • 状态指示:通过LED指示USB连接和运行状态

CC芯片管理

  • 厂商支持:支持On厂商和Sgm厂商的CC芯片
  • 芯片关联:通过RefCcChipOn和RefCcChipSgm关联不同厂商芯片
  • 状态监控:通过CcChipAttachStatus监控芯片接入设备状态
  • 兼容性:通过CcChipSupported控制芯片功能使能

近端运维功能

  • 网络功能:通过RndisHostIpAddr配置USB网络接口
  • 配置管理:通过插入USB存储设备进行配置导入或导出
  • 设备管理:支持USB复合设备管理
  • 状态监控:实时监控USB设备连接状态
  • 故障诊断:提供USB连接故障的诊断信息

LED状态管理

  • 绿灯控制:通过GLedStatus控制绿色LED状态
  • 红灯控制:通过RLedStatus控制红色LED状态
  • 状态指示:LED用于指示USB连接和运行状态
  • 故障指示:通过LED颜色指示USB功能状态