I2C主机

I2C主机 的协作图:

结构体
struct	xwds_i2cm_driver
	BSP中需要提供的I2C主机驱动函数表 更多...
struct	xwds_i2cm
	I2C主机 更多...

函数
void	xwds_i2cm_construct (struct xwds_i2cm *i2cm)
	XWDS API：I2C主机控制器的构造函数
void	xwds_i2cm_destruct (struct xwds_i2cm *i2cm)
	XWDS API：I2C主机控制器对象的析构函数
xwer_t	xwds_i2cm_grab (struct xwds_i2cm *i2cm)
	XWDS API：增加对象的引用计数
xwer_t	xwds_i2cm_put (struct xwds_i2cm *i2cm)
	XWDS API：减少对象的引用计数
xwer_t	xwds_i2cm_xfer (struct xwds_i2cm *i2cm, struct xwds_i2c_msg *msg, xwtm_t to)
	XWDS API：传输I2C消息
xwer_t	xwds_i2cm_abort (struct xwds_i2cm *i2cm, xwu16_t address, xwu16_t addrmode, xwtm_t to)
	XWDS API：中止I2C总线传输

详细描述

函数说明

xwds_i2cm_abort()

xwer_t xwds_i2cm_abort	(	struct xwds_i2cm *	i2cm,
		xwu16_t	address,
		xwu16_t	addrmode,
		xwtm_t	to
	)

XWDS API：中止I2C总线传输

参数

[in]	i2cm	I2C主机控制器对象指针
[in]	address	I2C地址
[in]	addrmode	I2C地址模式，取值： XWDS_I2C_F_7BITADDR 7位地址模式 XWDS_I2C_F_10BITADDR 10位地址模式
[in]	to	期望唤醒的时间点

返回

错误码

返回值

XWOK	没有错误
-EINVAL	设备对象不可引用
-ESHUTDOWN	设备没有运行
-EADDRNOTAVAIL	地址无响应
-ETIMEDOUT	超时

注解

• 上下文：线程
• 异步函数

to 表示等待超时的时间点：

• to 通常是未来的时间，即 当前系统时间 + delta ， 可以使用 xwtm_ft(delta) 表示；
• 如果 to 是过去的时间点，将直接返回 -ETIMEDOUT 。

<No error

在文件 master.c 第 240 行定义.

{
        xwer_t rc;
        const struct xwds_i2cm_driver * drv;
 
        XWDS_VALIDATE(i2cm, "nullptr", -EFAULT);
 
        rc = xwds_i2cm_grab(i2cm);
        if (rc < 0) {
                goto err_i2cm_grab;
        }
        rc = xwos_mtx_lock_to(&i2cm->abort.apimtx, to);
        if (rc < 0) {
                goto err_i2cm_lock;
        }
        drv = xwds_cast(const struct xwds_i2cm_driver *, i2cm->dev.drv);
        if ((drv) && (drv->abort)) {
                rc = drv->abort(i2cm, address, addrmode, to);
        } else {
                rc = -ENOSYS;
        }
        if (rc < 0) {
                goto err_drv_abort;
        }
        xwos_mtx_unlock(&i2cm->abort.apimtx);
        xwds_i2cm_put(i2cm);
        return XWOK;
 
err_drv_abort:
        xwos_mtx_unlock(&i2cm->abort.apimtx);
err_i2cm_lock:
        xwds_i2cm_put(i2cm);
err_i2cm_grab:
        return rc;
}

函数调用图:

xwds_i2cm_construct()

void xwds_i2cm_construct

(

struct xwds_i2cm *

i2cm

)

XWDS API：I2C主机控制器的构造函数

参数

[in]

i2cm

I2C主机控制器对象指针

在文件 master.c 第 58 行定义.

{
        xwds_device_construct(&i2cm->dev);
        i2cm->dev.vop = &xwds_i2cm_vop;
}

函数调用图:

xwds_i2cm_destruct()

void xwds_i2cm_destruct

(

struct xwds_i2cm *

i2cm

)

XWDS API：I2C主机控制器对象的析构函数

参数

[in]

i2cm

I2C主机控制器对象指针

在文件 master.c 第 65 行定义.

{
        xwds_device_destruct(&i2cm->dev);
}

函数调用图:

xwds_i2cm_grab()

xwer_t xwds_i2cm_grab

(

struct xwds_i2cm *

i2cm

)

XWDS API：增加对象的引用计数

参数

[in]

i2cm

I2C主机控制器对象指针

在文件 master.c 第 71 行定义.

{
        return xwds_device_grab(&i2cm->dev);
}

函数调用图:

这是这个函数的调用关系图:

xwds_i2cm_put()

xwer_t xwds_i2cm_put

(

struct xwds_i2cm *

i2cm

)

XWDS API：减少对象的引用计数

参数

[in]

i2cm

I2C主机控制器对象指针

在文件 master.c 第 77 行定义.

{
        return xwds_device_put(&i2cm->dev);
}

函数调用图:

这是这个函数的调用关系图:

xwds_i2cm_xfer()

xwer_t xwds_i2cm_xfer	(	struct xwds_i2cm *	i2cm,
		struct xwds_i2c_msg *	msg,
		xwtm_t	to
	)

XWDS API：传输I2C消息

参数

[in]	i2cm	I2C主机控制器对象指针
[in,out]	msg	I2C消息结构体的指针 (I) addr: 地址，只作为输入 (I) flag: 传输标志，只作为输入，取值： 地址标志： XWDS_I2C_F_7BITADDR: 7位地址 XWDS_I2C_F_10BITADDR: 10位地址 方向标志： XWDS_I2C_F_RD: 读 XWDS_I2C_F_WR: 写 开始/停止条件标志： XWDS_I2C_F_START: 产生开始条件 XWDS_I2C_F_STOP: 产生结束条件 data: 数据缓冲区： (I) 当方向标志为读时，只作为输入缓冲区 (O) 当方向标志为写时，只作为输出缓冲区 size: 传输的字节数 (I) 当作为输入时，表示缓冲区的大小 (O) 当作为输出时，返回实际传输的数据大小
[in]	to	期望唤醒的时间点

返回

错误码

返回值

XWOK	没有错误
-EINVAL	设备对象不可引用
-ESHUTDOWN	设备没有运行
-EADDRNOTAVAIL	地址无响应
-ETIMEDOUT	超时

注解

• 上下文：线程

to 表示等待超时的时间点：

• to 通常是未来的时间，即 当前系统时间 + delta ， 可以使用 xwtm_ft(delta) 表示；
• 如果 to 是过去的时间点，将直接返回 -ETIMEDOUT 。

<No error

在文件 master.c 第 201 行定义.

{
        xwer_t rc;
        const struct xwds_i2cm_driver * drv;
 
        XWDS_VALIDATE(i2cm, "nullptr", -EFAULT);
        XWDS_VALIDATE(msg, "nullptr", -EFAULT);
        XWDS_VALIDATE((msg->flag & XWDS_I2C_F_DIRMSK), "no-direction", -EINVAL);
 
        rc = xwds_i2cm_grab(i2cm);
        if (rc < 0) {
                goto err_i2cm_grab;
        }
        rc = xwos_mtx_lock_to(&i2cm->xfer.apimtx, to);
        if (rc < 0) {
                goto err_i2cm_lock;
        }
        drv = xwds_cast(const struct xwds_i2cm_driver *, i2cm->dev.drv);
        if ((drv) && (drv->xfer)) {
                rc = drv->xfer(i2cm, msg, to);
        } else {
                rc = -ENOSYS;
        }
        if (rc < 0) {
                goto err_drv_xfer;
        }
        xwos_mtx_unlock(&i2cm->xfer.apimtx);
        xwds_i2cm_put(i2cm);
        return XWOK;
 
err_drv_xfer:
        xwos_mtx_unlock(&i2cm->xfer.apimtx);
err_i2cm_lock:
        xwds_i2cm_put(i2cm);
err_i2cm_grab:
        return rc;
}

函数调用图:

这是这个函数的调用关系图: