libxtos-bcixtos_bci_get_config

xtos_bci_get_config

查询并严格验证 v1 配置和固件/寄存器回读,固定 v1.0.2 支持 Cyton 8 通道、250 Hz。

本页目录

声明

c
#include <xtos/bci.h>

int xtos_bci_get_config(xtos_bci_session_t *session,
                        struct xtos_bci_config_v1 *out);

参数

参数类型说明
sessionxtos_bci_session_t *非 NULL,调用方持有且负责生命周期;必须串行使用。
outstruct xtos_bci_config_v1 *非 NULL、调用方拥有的输出结构;失败保持所有原字节。

输出字段

字段类型含义
versionuint32_tABI 版本,无单位;必须为 1。
flagsuint32_t标志,无单位;本版本为 0。
channelsuint32_t通道数量;验证配置为 8。
sample_rate_hzuint32_t采样率,单位 Hz;验证配置为 250。
enabled_maskuint32_t通道使能标志,无单位;bit 0..7 对应通道 0..7,与 CHnSET 掉电位一致。
capabilitiesuint32_t能力标志,无单位:CONFIG_READBACK=1、FIRMWARE_READBACK=2、GAIN_CONTROL=4、IMPEDANCE=8、SELF_TEST=16;前两位必需,未知位拒绝;固定 Cyton 路径不声明阻抗/自检支持。
reserved0uint32_t[2]保留字段,无单位;两项均为 0。
generationuint64_t配置代次,无单位;设备寿命内成功验证提交时递增且非零,即使读回内容未变也递增,不是板卡唯一标识。
gainuint32_t[8]每通道无量纲增益;各项为 1、2、4、6、8、12 或 24,与寄存器回读一致。
registersuint8_t[24]24 个 ADS 寄存器的实际回读字节,无单位;CONFIG1 低三位为 6,CHnSET 验证增益和使能状态。
firmwarechar[256]固件 banner,无单位;非空、NUL 结尾,NUL 前为可打印 ASCII 或 CR/LF;不是唯一设备身份。
reserveduint32_t[8]保留字段,无单位;八项均为 0。

返回值

成功返回 0 并复制已验证配置;失败 -1/errno,out 不变。

错误

errno条件
EINVALsession/out 为 NULL。
EPROTO版本、保留字段、能力、增益/使能回读、固件字符串或固定 profile 无效。
ENODATA/ENODEV/ENOTTY/EOPNOTSUPP/system errno配置未验证、设备断开、接口不支持或底层 ioctl 错误。

注意事项

  • 同一会话的所有 API 必须由调用方串行化;SDK 无内部锁。调用可阻塞或分配,不能据此保证实时 deadline。
  • 内部仅设置请求 version=1;Cyton 返回驱动保存的最后已验证配置,查询本身不发送串口寄存器查询、不提交新代次,也不复位板卡。不是 GET_INFO 的旧缓存;配置更新发生于初始化、START 或成功配置事务。
  • 配置结构原生字节序、384 字节;实际校准/阻抗能力不能从接口存在推断。

示例

c
#include <xtos/bci.h>
int query_config(xtos_bci_session_t *s) {
    struct xtos_bci_config_v1 config;
    return xtos_bci_get_config(s, &config);
}

源码

本文按 OpenXTOS v1.0.2(c24e923717670c4724cdaf24c7c105caee8dc2fb)的头文件和实现编写。