SPI主机模式控制器

SPI主机模式控制器 的协作图:

结构体
struct	xwds_spim_driver
	BSP中需要提供的SPI主机模式控制器驱动函数表 更多...
struct	xwds_spim
	SPI主机模式控制器 更多...

函数
void	xwds_spim_construct (struct xwds_spim *spim)
	XWDS API：SPI主机模式控制器对象的构造函数
void	xwds_spim_destruct (struct xwds_spim *spim)
	XWDS API：SPI主机模式控制器对象的析构函数
xwer_t	xwds_spim_grab (struct xwds_spim *spim)
	XWDS API：增加对象的引用计数
xwer_t	xwds_spim_put (struct xwds_spim *spim)
	XWDS API：减少对象的引用计数
xwer_t	xwds_spim_xfer (struct xwds_spim *spim, xwid_t cfgid, const xwu8_t txd[], xwu8_t *rxb, xwsz_t *size, xwtm_t to)
	XWDS API：启动SPI总线传输
xwer_t	xwds_spim_abort (struct xwds_spim *spim, xwtm_t to)
	XWDS API：中止SPI总线传输

详细描述

函数说明

xwds_spim_construct()

void xwds_spim_construct

(

struct xwds_spim *

spim

)

XWDS API：SPI主机模式控制器对象的构造函数

参数

[in]

spim

SPI主机模式控制器对象指针

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

{
        xwds_device_construct(&spim->dev);
        spim->dev.vop = &xwds_spim_vop;
}

函数调用图:

xwds_spim_destruct()

void xwds_spim_destruct

(

struct xwds_spim *

spim

)

XWDS API：SPI主机模式控制器对象的析构函数

参数

[in]

spim

SPI主机模式控制器对象指针

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

{
        struct xwds_device * dev;
 
        dev = xwds_cast(struct xwds_device *, spim);
        xwds_device_destruct(dev);
}

函数调用图:

xwds_spim_grab()

xwer_t xwds_spim_grab

(

struct xwds_spim *

spim

)

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

参数

[in]

spim

SPI主机模式控制器对象指针

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

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

函数调用图:

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

xwds_spim_put()

xwer_t xwds_spim_put

(

struct xwds_spim *

spim

)

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

参数

[in]

spim

SPI主机模式控制器对象指针

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

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

函数调用图:

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

xwds_spim_xfer()

xwer_t xwds_spim_xfer	(	struct xwds_spim *	spim,
		xwid_t	cfgid,
		const xwu8_t	txd[],
		xwu8_t *	rxb,
		xwsz_t *	size,
		xwtm_t	to
	)

XWDS API：启动SPI总线传输

参数

[in]	spim	SPI主机模式控制器对象指针
[in]	cfgid	SPI总线配置的ID
[in]	txd	发送数据缓冲区，可为NULL表示不发送数据
[out]	rxb	接收数据缓冲区，可为NULL表示不接收数据
[in,out]	size	指向缓冲区的指针，此缓冲区： (I) 作为输入时，表示缓冲区大小（单位：字节） (O) 作为输出时，返回实际传输的数据大小
[in]	to	期望唤醒的时间点

返回

错误码

返回值

XWOK	没有错误
-EFAULT	无效指针
-ECHRNG	配置ID不在配置表范围内
-EINVAL	参数错误
-EBUSY	总线繁忙
-EIO	传输错误
-ECANCELED	传输被取消
-ETIMEDOUT	超时

注解

• 上下文：线程

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

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

<No error

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

{
        const struct xwds_spim_driver * drv;
        xwer_t rc;
 
        XWDS_VALIDATE(spim, "nullptr", -EFAULT);
        XWDS_VALIDATE(((txd) || (rxb)), "invalid", -EINVAL);
        XWDS_VALIDATE((size), "nullptr", -EFAULT);
 
        rc = xwds_spim_grab(spim);
        if (rc < 0) {
                goto err_spim_grab;
        }
        if (cfgid >= spim->buscfg_num) {
                rc = -ECHRNG;
                goto err_chrng;
        }
        rc = xwos_mtx_lock_to(&spim->xfer.apimtx, to);
        if (rc < 0) {
                goto err_spim_lock;
        }
        drv = xwds_cast(const struct xwds_spim_driver *, spim->dev.drv);
        if ((drv) && (drv->xfer)) {
                rc = drv->xfer(spim, cfgid, txd, rxb, size, to);
        } else {
                rc = -ENOSYS;
        }
        if (rc < 0) {
                goto err_drv_xfer;
        }
        xwos_mtx_unlock(&spim->xfer.apimtx);
        xwds_spim_put(spim);
        return XWOK;
 
err_drv_xfer:
        xwos_mtx_unlock(&spim->xfer.apimtx);
err_spim_lock:
err_chrng:
        xwds_spim_put(spim);
err_spim_grab:
        return rc;
}

函数调用图:

xwds_spim_abort()

xwer_t xwds_spim_abort	(	struct xwds_spim *	spim,
		xwtm_t	to
	)

XWDS API：中止SPI总线传输

参数

[in]	spim	SPI主机控制器对象指针
[in]	to	期望唤醒的时间点

返回

错误码

返回值

XWOK	没有错误
-EINVAL	设备对象不可引用
-ETIMEDOUT	超时

注解

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

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

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

<No error

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

{
        const struct xwds_spim_driver * drv;
        xwer_t rc;
 
        XWDS_VALIDATE(spim, "nullptr", -EFAULT);
 
        rc = xwds_spim_grab(spim);
        if (rc < 0) {
                goto err_spim_grab;
        }
        drv = xwds_cast(const struct xwds_spim_driver *, spim->dev.drv);
        if ((drv) && (drv->abort)) {
                rc = drv->abort(spim, to);
        } else {
                rc = -ENOSYS;
        }
        if (rc < 0) {
                goto err_drv_abort;
        }
        xwds_spim_put(spim);
        return XWOK;
 
err_drv_abort:
        xwds_spim_put(spim);
err_spim_grab:
        return rc;
}

函数调用图: