CAN总线控制器

CAN总线控制器 的协作图:

结构体
struct	xwds_can_msg
	CAN消息 更多...
struct	xwds_canc_bd_cfg
	CAN总线控制器波特率配置 更多...
struct	xwds_canc_txobj_cfg
	CAN发送对象（消息）配置 更多...
struct	xwds_canc_rxobj_cfg
	CAN接收对象（消息）配置 更多...
struct	xwds_canc_cfg
	CAN控制器配置 更多...
struct	xwds_canc_driver
	BSP中需要提供的CAN控制器驱动函数表 更多...
struct	xwds_canc_cbtbl
	CAN控制器应用层回调函数表 更多...
struct	xwds_canc_rxqueue
	CAN控制器接收队列 更多...
struct	xwds_canc
	CAN控制器 更多...

宏定义
#define	__xwds_canc_cbtbl_qualifier
#define	XWDS_CANC_RXQNUM   (XWCDCFG_ds_CAN_CONTROLLER_RXQNUM)
#define	XWDS_CANC_SDU_MAXSIZE   (XWCDCFG_ds_CAN_CONTROLLER_SDU_MAXSIZE)

枚举
enum	xwds_can_msgflag_em { XWDS_CAN_MSG_F_EXID = (1U) , XWDS_CAN_MSG_F_REMOTE = (2U) }
	CAN消息标志枚举 更多...
enum	xwds_canc_hwobj_type_em { XWDS_CANC_HWOBJ_T_ID_STD = ((xwbmp_t)1 << ( 0 )) , XWDS_CANC_HWOBJ_T_ID_EXT = ((xwbmp_t)1 << ( 1 )) , XWDS_CANC_HWOBJ_T_ID_MIXED = ((xwbmp_t)1 << ( 0 )) | ((xwbmp_t)1 << ( 1 )) }
	CAN对象（消息）类型 更多...
enum	xwds_canc_mode_em {   XWDS_CANC_MODE_MIN = 0 , XWDS_CANC_MODE_UNINIT = XWDS_CANC_MODE_MIN , XWDS_CANC_MODE_STOPPED , XWDS_CANC_MODE_STARTED ,   XWDS_CANC_MODE_SLEEP , XWDS_CANC_MODE_NUM }
	CAN控制器的模式 更多...
enum	xwds_canc_err_em {   CANC_ERR_NOERR = 0 , CANC_ERR_BUS , CANC_ERR_STUFF , CANC_ERR_FORM ,   CANC_ERR_ACK , CANC_ERR_CRC , CANC_ERR_B1 , CANC_ERR_B0 ,   CANC_ERR_ACKDELIMITER , CANC_ERR_PASSIVE , CANC_ERR_WARNING }
	CAN控制器的错误码 更多...

函数
void	xwds_canc_construct (struct xwds_canc *canc)
	XWDS API：CAN控制器的构造函数
void	xwds_canc_destruct (struct xwds_canc *canc)
	XWDS API：CAN控制器对象的析构函数
xwer_t	xwds_canc_grab (struct xwds_canc *canc)
	XWDS API：增加对象的引用计数
xwer_t	xwds_canc_put (struct xwds_canc *canc)
	XWDS API：减少对象的引用计数
xwer_t	xwds_canc_write (struct xwds_canc *canc, xwid_t txobjid, struct xwds_can_msg *msg)
	XWDS API：将一条CAN消息写入发送邮箱
xwer_t	xwds_canc_enable_irqs (struct xwds_canc *canc)
	XWDS API：开启CAN控制器的中断
xwer_t	xwds_canc_disable_irqs (struct xwds_canc *canc)
	XWDS API：关闭CAN控制器的中断
xwer_t	xwds_canc_set_mode (struct xwds_canc *canc, xwsq_t mode)
	XWDS API：设置CAN控制器的模式
xwer_t	xwds_canc_set_bd (struct xwds_canc *canc, xwid_t bdcfgid)
	XWDS API：设置CAN控制器的波特率
void	xwds_canc_setcb_tx_indication (struct xwds_canc *canc, void(*cb)(struct xwds_canc *, xwid_t, xwer_t))
	XWDS API：设置 指示发送结果 的回调函数
void	xwds_canc_setcb_rx_indication (struct xwds_canc *canc, void(*cb)(struct xwds_canc *, xwid_t, struct xwds_can_msg *))
	XWDS API：设置 指示接收结果 的回调函数
void	xwds_canc_setcb_wakeup_notification (struct xwds_canc *canc, void(*cb)(struct xwds_canc *))
	XWDS API：设置 唤醒通知 回调函数
void	xwds_canc_setcb_mode_indication (struct xwds_canc *canc, void(*cb)(struct xwds_canc *, xwsq_t))
	XWDS API：设置 模式切换通知 回调函数
void	xwds_canc_setcb_err_indication (struct xwds_canc *canc, void(*cb)(struct xwds_canc *, xwsq_t, xwsq_t, xwsq_t))
	XWDS API：设置 错误通知 回调函数
void	xwds_canc_setcb_busoff_indication (struct xwds_canc *canc, void(*cb)(struct xwds_canc *))
	XWDS API：设置 BUSOFF通知 回调函数
void	xwds_canc_rxq_init (struct xwds_canc_rxqueue *rxq)
	XWDS API：初始化接收缓冲队列
void	xwds_canc_rxq_publish (struct xwds_canc_rxqueue *rxq, struct xwds_can_msg *msg)
	XWDS API：发布一条消息到接收缓冲队列中
xwer_t	xwds_canc_rxq_acquire (struct xwds_canc_rxqueue *rxq, struct xwds_can_msg *buf, xwtm_t to)
	XWDS API：从接收缓冲队列中获取一条消息
void	xwds_canc_drvcb_init_msg (struct xwds_can_msg *msg, xwu32_t canid, xwsq_t flag, xwsz_t dlc, xwu8_t sdu[])
	XWDS Driver Callback：初始化CAN总线消息结构体
void	xwds_canc_drvcb_tx_indication (struct xwds_canc *canc, xwid_t txobjid, xwer_t rc)
	XWDS Driver Callback：指示发送结果
void	xwds_canc_drvcb_rx_indication (struct xwds_canc *canc, xwid_t rxobjid, struct xwds_can_msg *rxmsg)
	XWDS Driver Callback：接收到CAN消息后的回调函数
void	xwds_canc_drvcb_wakeup_notification (struct xwds_canc *canc)
	XWDS Driver Callback：CAN控制器的唤醒通知
void	xwds_canc_drvcb_mode_indication (struct xwds_canc *canc, xwsq_t mode)
	XWDS Driver Callback：指示CAN控制器的模式已经切换
void	xwds_canc_drvcb_err_indication (struct xwds_canc *canc, xwsq_t errcode, xwsq_t tec, xwsq_t rec)
	XWDS Driver Callback：指示CAN控制器发生错误
void	xwds_canc_drvcb_busoff_indication (struct xwds_canc *canc)
	XWDS Driver Callback：指示CAN控制器发生busoff

详细描述

宏定义说明

__xwds_canc_cbtbl_qualifier

#define __xwds_canc_cbtbl_qualifier

在文件 controller.h 第 46 行定义.

XWDS_CANC_RXQNUM

#define XWDS_CANC_RXQNUM   (XWCDCFG_ds_CAN_CONTROLLER_RXQNUM)

在文件 controller.h 第 49 行定义.

XWDS_CANC_SDU_MAXSIZE

#define XWDS_CANC_SDU_MAXSIZE   (XWCDCFG_ds_CAN_CONTROLLER_SDU_MAXSIZE)

在文件 controller.h 第 50 行定义.

枚举类型说明

xwds_can_msgflag_em

enum xwds_can_msgflag_em

CAN消息标志枚举

枚举值
XWDS_CAN_MSG_F_EXID	扩展ID，BIT(0)
XWDS_CAN_MSG_F_REMOTE	远程帧，BIT(1)

在文件 controller.h 第 55 行定义.

                         {
        XWDS_CAN_MSG_F_EXID = (1U), 
        XWDS_CAN_MSG_F_REMOTE = (2U), 
};

xwds_canc_err_em

enum xwds_canc_err_em

CAN控制器的错误码

枚举值
CANC_ERR_NOERR
CANC_ERR_BUS	bus error
CANC_ERR_STUFF	stuff error
CANC_ERR_FORM	form error
CANC_ERR_ACK	ACK error
CANC_ERR_CRC	CRC Error Flag
CANC_ERR_B1	Recessive Bit Error Flag
CANC_ERR_B0	Dominant Bit Error Flag
CANC_ERR_ACKDELIMITER	ACK Delimiter Error Flag
CANC_ERR_PASSIVE	TX/RX Error counter > 127
CANC_ERR_WARNING	TX/RX Error counter > WARNING limit

在文件 controller.h 第 154 行定义.

                      {
        CANC_ERR_NOERR = 0,
        CANC_ERR_BUS, 
        CANC_ERR_STUFF, 
        CANC_ERR_FORM, 
        CANC_ERR_ACK, 
        CANC_ERR_CRC, 
        CANC_ERR_B1, 
        CANC_ERR_B0, 
        CANC_ERR_ACKDELIMITER, 
        CANC_ERR_PASSIVE, 
        CANC_ERR_WARNING, 
};

xwds_canc_hwobj_type_em

enum xwds_canc_hwobj_type_em

CAN对象（消息）类型

枚举值
XWDS_CANC_HWOBJ_T_ID_STD	标准帧
XWDS_CANC_HWOBJ_T_ID_EXT	扩展帧
XWDS_CANC_HWOBJ_T_ID_MIXED	混合帧

在文件 controller.h 第 89 行定义.

                             {
        XWDS_CANC_HWOBJ_T_ID_STD = XWBOP_BIT(0), 
        XWDS_CANC_HWOBJ_T_ID_EXT = XWBOP_BIT(1), 
        XWDS_CANC_HWOBJ_T_ID_MIXED = XWBOP_BIT(0) | XWBOP_BIT(1), 
};

xwds_canc_mode_em

enum xwds_canc_mode_em

CAN控制器的模式

枚举值
XWDS_CANC_MODE_MIN
XWDS_CANC_MODE_UNINIT	UNINIT mode. Default mode of the CAN driver and all CAN controllers connected to one CAN network after power on.
XWDS_CANC_MODE_STOPPED	STOPPED mode. At least one of all CAN controllers connected to one CAN network are halted and does not operate on the bus.
XWDS_CANC_MODE_STARTED	STARTED mode. All CAN controllers connected to one CAN network are started by the CAN driver and in full-operational mode.
XWDS_CANC_MODE_SLEEP	SLEEP mode. At least one of all CAN controllers connected to one CAN network are set into the SLEEP mode and can be woken up by request of the CAN driver or by a network event (must be supported by CAN hardware)
XWDS_CANC_MODE_NUM	number of CAN controller modes

在文件 controller.h 第 130 行定义.

                       {
        XWDS_CANC_MODE_MIN = 0,
        XWDS_CANC_MODE_UNINIT = XWDS_CANC_MODE_MIN, 
        XWDS_CANC_MODE_STOPPED, 
        XWDS_CANC_MODE_STARTED, 
        XWDS_CANC_MODE_SLEEP, 
        XWDS_CANC_MODE_NUM, 
};

函数说明

xwds_canc_construct()

void xwds_canc_construct

(

struct xwds_canc *

canc

)

XWDS API：CAN控制器的构造函数

参数

[in]

canc

CAN控制器对象指针

在文件 controller.c 第 62 行定义.

{
        xwds_device_construct(&canc->bc.dev);
        canc->bc.dev.vop = &xwds_canc_vop;
}

函数调用图:

xwds_canc_destruct()

void xwds_canc_destruct

(

struct xwds_canc *

canc

)

XWDS API：CAN控制器对象的析构函数

参数

[in]

canc

CAN控制器对象指针

在文件 controller.c 第 69 行定义.

{
        xwds_device_destruct(&canc->bc.dev);
}

函数调用图:

xwds_canc_disable_irqs()

xwer_t xwds_canc_disable_irqs

(

struct xwds_canc *

canc

)

XWDS API：关闭CAN控制器的中断

参数

[in]

canc

CAN控制器对象指针

返回

错误码

返回值

XWOK	没有错误
-EFAULT	无效指针

注解

• 上下文：中断、中断底半部、线程

<No error

在文件 controller.c 第 257 行定义.

{
        const struct xwds_canc_driver * drv;
        xwer_t rc;
 
        XWDS_VALIDATE(canc, "nullptr", -EFAULT);
 
        rc = xwds_canc_grab(canc);
        if (rc < 0) {
                goto err_canc_grab;
        }
        drv = xwds_cast(const struct xwds_canc_driver *, canc->bc.dev.drv);
        if ((drv) && (drv->disable_irqs)) {
                rc = drv->disable_irqs(canc);
        } else {
                rc = -ENOSYS;
        }
        if (rc < 0) {
                goto err_canc_drv_disable_irqs;
        }
        xwds_canc_put(canc);
        return XWOK;
 
err_canc_drv_disable_irqs:
        xwds_canc_put(canc);
err_canc_grab:
        return rc;
}

函数调用图:

xwds_canc_drvcb_busoff_indication()

void xwds_canc_drvcb_busoff_indication

(

struct xwds_canc *

canc

)

XWDS Driver Callback：指示CAN控制器发生busoff

参数

[in]

canc

CAN控制器对象指针

此回调函数在中断上下文中被调用，用于通知BUSOFF。

在文件 controller.c 第 589 行定义.

{
        __xwds_canc_cbtbl_qualifier struct xwds_canc_cbtbl * cbtbl;
 
        cbtbl = canc->cbtbl;
        if ((cbtbl) && (cbtbl->busoff_indication)) {
                cbtbl->busoff_indication(canc);
        }
}

xwds_canc_drvcb_err_indication()

void xwds_canc_drvcb_err_indication	(	struct xwds_canc *	canc,
		xwsq_t	errcode,
		xwsq_t	tec,
		xwsq_t	rec
	)

XWDS Driver Callback：指示CAN控制器发生错误

参数

[in]	canc	CAN控制器对象指针
[in]	errcode	错误码
[in]	tec	发送错误计数
[in]	rec	接收错误计数

此回调函数在中断上下文中被调用，用于通知错误。

在文件 controller.c 第 577 行定义.

{
        __xwds_canc_cbtbl_qualifier struct xwds_canc_cbtbl * cbtbl;
 
        cbtbl = canc->cbtbl;
        if ((cbtbl) && (cbtbl->err_indication)) {
                cbtbl->err_indication(canc, errcode, tec, rec);
        }
}

xwds_canc_drvcb_init_msg()

void xwds_canc_drvcb_init_msg	(	struct xwds_can_msg *	msg,
		xwu32_t	canid,
		xwsq_t	flag,
		xwsz_t	dlc,
		xwu8_t	sdu[]
	)

XWDS Driver Callback：初始化CAN总线消息结构体

参数

[in]	msg	CAN总线消息结构体的指针
[in]	sdu	数据缓冲区的指针

在文件 controller.c 第 517 行定义.

{
        msg->id = canid;
        msg->flag = flag;
        msg->dlc = dlc;
        if (sdu) {
                memcpy(msg->sdu, sdu, dlc);
        } else {
                memset(msg->sdu, 0, XWDS_CANC_SDU_MAXSIZE);
        }
}

xwds_canc_drvcb_mode_indication()

void xwds_canc_drvcb_mode_indication	(	struct xwds_canc *	canc,
		xwsq_t	mode
	)

XWDS Driver Callback：指示CAN控制器的模式已经切换

参数

[in]	canc	CAN控制器对象指针
[in]	mode	当前模式

此回调函数在中断上下文中被调用，用于通知模式切换。

在文件 controller.c 第 566 行定义.

{
        __xwds_canc_cbtbl_qualifier struct xwds_canc_cbtbl * cbtbl;
 
        cbtbl = canc->cbtbl;
        if ((cbtbl) && (cbtbl->mode_indication)) {
                cbtbl->mode_indication(canc, mode);
        }
}

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

xwds_canc_drvcb_rx_indication()

void xwds_canc_drvcb_rx_indication	(	struct xwds_canc *	canc,
		xwid_t	rxobjid,
		struct xwds_can_msg *	rxmsg
	)

XWDS Driver Callback：接收到CAN消息后的回调函数

参数

[in]	canc	CAN控制器对象指针
[in]	rxobjid	接收邮箱的ID
[out]	rxmsg	指向缓冲区的指针，通过此缓冲区返回接收到的CAN消息

此回调函数在中断上下文中调用，用于通知接收结果。

rxmsg 所指向的缓冲区的生命周期只在这个函数内有效。

在文件 controller.c 第 543 行定义.

{
        __xwds_canc_cbtbl_qualifier struct xwds_canc_cbtbl * cbtbl;
 
        cbtbl = canc->cbtbl;
        if ((cbtbl) && (cbtbl->rx_indication)) {
                cbtbl->rx_indication(canc, rxobjid, rxmsg);
        }
}

xwds_canc_drvcb_tx_indication()

void xwds_canc_drvcb_tx_indication	(	struct xwds_canc *	canc,
		xwid_t	txobjid,
		xwer_t	rc
	)

XWDS Driver Callback：指示发送结果

参数

[in]	canc	CAN控制器对象指针
[in]	txobjid	发送邮箱的ID
[in]	rc	发送结果

此回调函数在中断上下文中被调用，用于通知接收结果。

在文件 controller.c 第 531 行定义.

{
        __xwds_canc_cbtbl_qualifier struct xwds_canc_cbtbl * cbtbl;
 
        cbtbl = canc->cbtbl;
        if ((cbtbl) && (cbtbl->tx_indication)) {
                cbtbl->tx_indication(canc, txobjid, rc);
        }
}

xwds_canc_drvcb_wakeup_notification()

void xwds_canc_drvcb_wakeup_notification

(

struct xwds_canc *

canc

)

XWDS Driver Callback：CAN控制器的唤醒通知

参数

[in]

canc

CAN控制器对象指针

此回调函数在中断上下文中被调用，用于通知唤醒。

在文件 controller.c 第 555 行定义.

{
        __xwds_canc_cbtbl_qualifier struct xwds_canc_cbtbl * cbtbl;
 
        cbtbl = canc->cbtbl;
        if ((cbtbl) && (cbtbl->wakeup_notification)) {
                cbtbl->wakeup_notification(canc);
        }
}

xwds_canc_enable_irqs()

xwer_t xwds_canc_enable_irqs

(

struct xwds_canc *

canc

)

XWDS API：开启CAN控制器的中断

参数

[in]

canc

CAN控制器对象指针

返回

错误码

返回值

XWOK	没有错误
-EFAULT	无效指针

注解

• 上下文：中断、中断底半部、线程

<No error

在文件 controller.c 第 227 行定义.

{
        const struct xwds_canc_driver * drv;
        xwer_t rc;
 
        XWDS_VALIDATE(canc, "nullptr", -EFAULT);
 
        rc = xwds_canc_grab(canc);
        if (rc < 0) {
                goto err_canc_grab;
        }
        drv = xwds_cast(const struct xwds_canc_driver *, canc->bc.dev.drv);
        if ((drv) && (drv->enable_irqs)) {
                rc = drv->enable_irqs(canc);
        } else {
                rc = -ENOSYS;
        }
        if (rc < 0) {
                goto err_canc_drv_enable_irqs;
        }
        xwds_canc_put(canc);
        return XWOK;
 
err_canc_drv_enable_irqs:
        xwds_canc_put(canc);
err_canc_grab:
        return rc;
}

函数调用图:

xwds_canc_grab()

xwer_t xwds_canc_grab

(

struct xwds_canc *

canc

)

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

参数

[in]

canc

CAN控制器对象指针

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

{
        return xwds_device_grab(&canc->bc.dev);
}

函数调用图:

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

xwds_canc_put()

xwer_t xwds_canc_put

(

struct xwds_canc *

canc

)

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

参数

[in]

canc

CAN控制器对象指针

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

{
        return xwds_device_put(&canc->bc.dev);
}

函数调用图:

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

xwds_canc_rxq_acquire()

xwer_t xwds_canc_rxq_acquire	(	struct xwds_canc_rxqueue *	rxq,
		struct xwds_can_msg *	buf,
		xwtm_t	to
	)

XWDS API：从接收缓冲队列中获取一条消息

参数

[in]	rxq	接收缓冲队列对象指针
[in]	buf	获取CAN消息结构体的缓存指针
[in]	to	期望唤醒的时间点

返回

错误码

返回值

XWOK	没有错误
-EFAULT	无效指针

注解

• 上下文：线程

如果 to 是过去的时间点，将直接返回 -ETIMEDOUT 。

<No error

在文件 controller.c 第 400 行定义.

{
        xwer_t rc;
        xwreg_t cpuirq;
 
        XWDS_VALIDATE(rxq, "nullptr", -EFAULT);
        XWDS_VALIDATE(buf, "nullptr", -EFAULT);
 
        rc = xwos_sem_wait_to(&rxq->sem, to);
        if (rc < 0) {
                goto err_sem_wait_to;
        }
        xwos_splk_lock_cpuirqsv(&rxq->lock, &cpuirq);
        *buf = rxq->q[rxq->pos];
        rxq->pos++;
        if (rxq->pos >= (xwssq_t)XWDS_CANC_RXQNUM) {
                rxq->pos = 0;
        }
        xwos_splk_unlock_cpuirqrs(&rxq->lock, cpuirq);
        return XWOK;
 
err_sem_wait_to:
        return rc;
}

函数调用图:

xwds_canc_rxq_init()

void xwds_canc_rxq_init

(

struct xwds_canc_rxqueue *

rxq

)

XWDS API：初始化接收缓冲队列

参数

[in]

rxq

接收缓冲队列对象指针

注解

• 上下文：中断、中断底半部、线程

在文件 controller.c 第 365 行定义.

{
        xwos_splk_init(&rxq->lock);
        memset(rxq->q, 0, sizeof(rxq->q));
        rxq->pos = 0;
        rxq->num = 0;
        xwos_sem_init(&rxq->sem, 0, XWDS_CANC_RXQNUM);
}

函数调用图:

xwds_canc_rxq_publish()

void xwds_canc_rxq_publish	(	struct xwds_canc_rxqueue *	rxq,
		struct xwds_can_msg *	msg
	)

XWDS API：发布一条消息到接收缓冲队列中

参数

[in]	rxq	接收缓冲队列对象指针
[in]	msg	待发布的CAN消息结构体指针

注解

• 上下文：中断、中断底半部、线程

在文件 controller.c 第 375 行定义.

{
        xwreg_t cpuirq;
 
        xwos_splk_lock_cpuirqsv(&rxq->lock, &cpuirq);
        memcpy(&rxq->q[rxq->num], msg, sizeof(struct xwds_can_msg));
        rxq->num++;
        if (rxq->num >= (xwssz_t)XWDS_CANC_RXQNUM) {
                rxq->num = 0;
        }
        if (rxq->num == rxq->pos) {
                /* Queue is overflow. Discard the oldest data */
                rxq->pos++;
                if (rxq->pos >= (xwssq_t)XWDS_CANC_RXQNUM) {
                        rxq->pos = 0;
                }
                xwos_splk_unlock_cpuirqrs(&rxq->lock, cpuirq);
        } else {
                xwos_splk_unlock_cpuirqrs(&rxq->lock, cpuirq);
                xwos_sem_post(&rxq->sem);
        }
}

函数调用图:

xwds_canc_set_bd()

xwer_t xwds_canc_set_bd	(	struct xwds_canc *	canc,
		xwid_t	bdcfgid
	)

XWDS API：设置CAN控制器的波特率

参数

[in]	canc	CAN控制器对象指针
[in]	id	波特率的ID

返回

错误码

返回值

XWOK	没有错误
-EFAULT	无效指针
-ERANGE	错误的波特率ID

注解

• 上下文：中断、中断底半部、线程

<No error

在文件 controller.c 第 327 行定义.

{
        xwer_t rc;
        const struct xwds_canc_driver * drv;
        const struct xwds_canc_bd_cfg * bdcfg;
 
        XWDS_VALIDATE(canc, "nullptr", -EFAULT);
 
        rc = xwds_canc_grab(canc);
        if (rc < 0) {
                goto err_canc_grab;
        }
        if (bdcfgid >= canc->cfg->bdcfgs_num) {
                rc = -ERANGE;
                goto err_nobd;
        }
        bdcfg = &canc->cfg->bdcfgs[bdcfgid];
        drv = xwds_cast(const struct xwds_canc_driver *, canc->bc.dev.drv);
        if ((drv) && (drv->set_bd)) {
                rc = drv->set_bd(canc, bdcfg);
        } else {
                rc = -ENOSYS;
        }
        if (rc < 0) {
                goto err_drv_set_bd;
        }
        xwds_canc_put(canc);
        return XWOK;
 
err_drv_set_bd:
err_nobd:
        xwds_canc_put(canc);
err_canc_grab:
        return rc;
}

函数调用图:

xwds_canc_set_mode()

xwer_t xwds_canc_set_mode	(	struct xwds_canc *	canc,
		xwsq_t	mode
	)

XWDS API：设置CAN控制器的模式

参数

[in]	canc	CAN控制器对象指针
[in]	mode	模式

返回

错误码

返回值

OK	模式切换完成
-EFAULT	无效指针
-EALREADY	控制器已经处于此模式
-ERANGE	无效的模式

注解

• 上下文：中断、中断底半部、线程

<No error

在文件 controller.c 第 287 行定义.

{
        const struct xwds_canc_driver * drv;
        xwer_t rc;
 
        XWDS_VALIDATE(canc, "nullptr", -EFAULT);
        XWDS_VALIDATE((mode < XWDS_CANC_MODE_NUM), "out-of-range", -ERANGE);
 
        rc = xwds_canc_grab(canc);
        if (rc < 0) {
                goto err_canc_grab;
        }
 
        if (canc->mode == mode) {
                rc = -EALREADY;
                goto err_same_mode;
        }
        drv = xwds_cast(const struct xwds_canc_driver *, canc->bc.dev.drv);
        if ((drv) && (drv->set_mode)) {
                rc = drv->set_mode(canc, mode);
        } else {
                rc = -ENOSYS;
        }
        if (rc < 0) {
                goto err_drv_set_mode;
        }
        canc->mode = mode;
 
        xwds_canc_put(canc);
        xwds_canc_drvcb_mode_indication(canc, mode);
        return XWOK;
 
err_drv_set_mode:
err_same_mode:
        xwds_canc_put(canc);
err_canc_grab:
        return rc;
}

函数调用图:

xwds_canc_setcb_busoff_indication()

void xwds_canc_setcb_busoff_indication	(	struct xwds_canc *	canc,
		void(*)(struct xwds_canc *)	cb
	)

XWDS API：设置 BUSOFF通知 回调函数

参数

[in]	canc	CAN总线消息结构体的指针
[in]	cb	回调函数

注解

• 上下文：中断、中断底半部、线程

在文件 controller.c 第 503 行定义.

{
#if !defined(XWCDCFG_ds_CAN_CONTROLLER_ROCBT) || (1 != XWCDCFG_ds_CAN_CONTROLLER_ROCBT)
        if (canc->cbtbl) {
                canc->cbtbl->busoff_indication = cb;
        }
#else
        XWOS_UNUSED(canc);
        XWOS_UNUSED(cb);
#endif
}

xwds_canc_setcb_err_indication()

void xwds_canc_setcb_err_indication	(	struct xwds_canc *	canc,
		void(*)(struct xwds_canc *, xwsq_t, xwsq_t, xwsq_t)	cb
	)

XWDS API：设置 错误通知 回调函数

参数

[in]	canc	CAN总线消息结构体的指针
[in]	cb	回调函数

注解

• 上下文：中断、中断底半部、线程

在文件 controller.c 第 488 行定义.

{
#if !defined(XWCDCFG_ds_CAN_CONTROLLER_ROCBT) || (1 != XWCDCFG_ds_CAN_CONTROLLER_ROCBT)
        if (canc->cbtbl) {
                canc->cbtbl->err_indication = cb;
        }
#else
        XWOS_UNUSED(canc);
        XWOS_UNUSED(cb);
#endif
}

xwds_canc_setcb_mode_indication()

void xwds_canc_setcb_mode_indication	(	struct xwds_canc *	canc,
		void(*)(struct xwds_canc *, xwsq_t)	cb
	)

XWDS API：设置 模式切换通知 回调函数

参数

[in]	canc	CAN总线消息结构体的指针
[in]	cb	回调函数

注解

• 上下文：中断、中断底半部、线程

在文件 controller.c 第 474 行定义.

{
#if !defined(XWCDCFG_ds_CAN_CONTROLLER_ROCBT) || (1 != XWCDCFG_ds_CAN_CONTROLLER_ROCBT)
        if (canc->cbtbl) {
                canc->cbtbl->mode_indication = cb;
        }
#else
        XWOS_UNUSED(canc);
        XWOS_UNUSED(cb);
#endif
}

xwds_canc_setcb_rx_indication()

void xwds_canc_setcb_rx_indication	(	struct xwds_canc *	canc,
		void(*)(struct xwds_canc *, xwid_t, struct xwds_can_msg *)	cb
	)

XWDS API：设置 指示接收结果 的回调函数

参数

[in]	canc	CAN总线消息结构体的指针
[in]	cb	回调函数

注解

• 上下文：中断、中断底半部、线程

在文件 controller.c 第 444 行定义.

{
#if !defined(XWCDCFG_ds_CAN_CONTROLLER_ROCBT) || (1 != XWCDCFG_ds_CAN_CONTROLLER_ROCBT)
        if (canc->cbtbl) {
                canc->cbtbl->rx_indication = cb;
        }
#else
        XWOS_UNUSED(canc);
        XWOS_UNUSED(cb);
#endif
}

xwds_canc_setcb_tx_indication()

void xwds_canc_setcb_tx_indication	(	struct xwds_canc *	canc,
		void(*)(struct xwds_canc *, xwid_t, xwer_t)	cb
	)

XWDS API：设置 指示发送结果 的回调函数

参数

[in]	canc	CAN总线消息结构体的指针
[in]	cb	回调函数

注解

• 上下文：中断、中断底半部、线程

在文件 controller.c 第 429 行定义.

{
#if !defined(XWCDCFG_ds_CAN_CONTROLLER_ROCBT) || (1 != XWCDCFG_ds_CAN_CONTROLLER_ROCBT)
        if (canc->cbtbl) {
                canc->cbtbl->tx_indication = cb;
        }
#else
        XWOS_UNUSED(canc);
        XWOS_UNUSED(cb);
#endif
}

xwds_canc_setcb_wakeup_notification()

void xwds_canc_setcb_wakeup_notification	(	struct xwds_canc *	canc,
		void(*)(struct xwds_canc *)	cb
	)

XWDS API：设置 唤醒通知 回调函数

参数

[in]	canc	CAN总线消息结构体的指针
[in]	cb	回调函数

注解

• 上下文：中断、中断底半部、线程

在文件 controller.c 第 460 行定义.

{
#if !defined(XWCDCFG_ds_CAN_CONTROLLER_ROCBT) || (1 != XWCDCFG_ds_CAN_CONTROLLER_ROCBT)
        if (canc->cbtbl) {
                canc->cbtbl->wakeup_notification = cb;
        }
#else
        XWOS_UNUSED(canc);
        XWOS_UNUSED(cb);
#endif
}

xwds_canc_write()

xwer_t xwds_canc_write	(	struct xwds_canc *	canc,
		xwid_t	txobjid,
		struct xwds_can_msg *	msg
	)

XWDS API：将一条CAN消息写入发送邮箱

参数

[in]	canc	CAN控制器对象指针
[in]	txobjid	发送邮箱的ID
[in]	msg	CAN消息结构体的指针

返回

错误码

返回值

XWOK	没有错误
-EFAULT	无效指针
-ERANGE	找不到邮箱
-EBADSLT	邮箱配置与消息类型不匹配
-ETIMEDOUT	超时

注解

• 上下文：线程

<No error

在文件 controller.c 第 173 行定义.

{
        const struct xwds_canc_txobj_cfg * txobjcfg;
        const struct xwds_canc_driver * drv;
        xwer_t rc;
 
        XWDS_VALIDATE(canc, "nullptr", -EFAULT);
        XWDS_VALIDATE(msg, "nullptr", -EFAULT);
 
        rc = xwds_canc_grab(canc);
        if (rc < 0) {
                goto err_canc_grab;
        }
 
        if (txobjid >= canc->cfg->txobjs_num) {
                rc = -ERANGE;
                goto err_txobjid;
        }
 
        txobjcfg = &canc->cfg->txobjs[txobjid];
        if (XWDS_CAN_MSG_F_EXID & msg->flag) {
                if (!(XWDS_CANC_HWOBJ_T_ID_EXT & txobjcfg->type)) {
                        rc = -EBADSLT;
                        goto err_badtxobj;
                }
        } else {
                if (!(XWDS_CANC_HWOBJ_T_ID_STD & txobjcfg->type)) {
                        rc = -EBADSLT;
                        goto err_badtxobj;
                }
        }
        drv = xwds_cast(const struct xwds_canc_driver *, canc->bc.dev.drv);
        if ((drv) && (drv->write)) {
                rc = drv->write(canc, txobjcfg, msg);
        } else {
                rc = -ENOSYS;
        }
        if (rc < 0) {
                goto err_drv_write;
        }
        xwds_canc_put(canc);
 
        return XWOK;
 
err_drv_write:
err_badtxobj:
err_txobjid:
        xwds_canc_put(canc);
err_canc_grab:
        return rc;
}

函数调用图: