CAN总线接收器的协作图:

结构体
struct	xwds_cantrcv_cfg
	CAN接收器配置更多...

struct	xwds_cantrcv_driver
	BSP中需要提供的CAN接收器驱动函数表更多...

struct	xwds_cantrcv
	CAN接收器更多...

类型定义
typedef void(*	xwds_cantrcv_wkup_isr_f) (struct xwds_cantrcv , struct xwds_canc )
	唤醒中断回调函数

枚举
enum	xwds_cantrcv_opmode_em { XWDS_CANTRCV_OPMODE_NORMAL = 0 , XWDS_CANTRCV_OPMODE_SLEEP , XWDS_CANTRCV_OPMODE_STANDBY , XWDS_CANTRCV_OPMODE_NUM }
	CAN接收器模式枚举更多...

enum	xwds_cantrcv_wkuprs_em { XWDS_CANTRCV_WKUPRS_NONE = 0 , XWDS_CANTRCV_WKUPRS_BY_BUS , XWDS_CANTRCV_WKUPRS_BY_PIN , XWDS_CANTRCV_WKUPRS_INTERNALLY , XWDS_CANTRCV_WKUPRS_NOT_SUPPORTED , XWDS_CANTRCV_WKUPRS_POWER_ON , XWDS_CANTRCV_WKUPRS_RESET , XWDS_CANTRCV_WKUPRS_BY_SYSERR , XWDS_CANTRCV_WKUPRS_NUM }
	CAN接收器唤醒原因枚举更多...

函数
void	xwds_cantrcv_construct (struct xwds_cantrcv *cantrcv)
	XWDS API：CAN接收器的构造函数

void	xwds_cantrcv_destruct (struct xwds_cantrcv *cantrcv)
	XWDS API：CAN接收器对象的析构函数

xwer_t	xwds_cantrcv_grab (struct xwds_cantrcv *cantrcv)
	XWDS API：增加对象的引用计数

xwer_t	xwds_cantrcv_put (struct xwds_cantrcv *cantrcv)
	XWDS API：减少对象的引用计数

xwer_t	xwds_cantrcv_set_opmode (struct xwds_cantrcv *cantrcv, xwsq_t opmode)
	XWDS API：设置CAN接收器的运行模式

void	xwds_cantrcv_get_opmode (struct xwds_cantrcv cantrcv, xwsq_t opmode)
	XWDS API：设置CAN接收器的模式

xwer_t	xwds_cantrcv_enable_wkup (struct xwds_cantrcv *cantrcv)
	XWDS API：开启CAN接收器的唤醒

xwer_t	xwds_cantrcv_disable_wkup (struct xwds_cantrcv *cantrcv)
	XWDS API：关闭CAN接收器的唤醒

void	xwds_cantrcv_set_wkup_isr (struct xwds_cantrcv *cantrcv, xwds_cantrcv_wkup_isr_f isr)
	XWDS API：设置唤醒中断的回调函数

void	xwds_cantrcv_get_wkuprs (struct xwds_cantrcv cantrcv, xwsq_t wkuprs)
	XWDS API：获取CAN接收器的唤醒原因

void	xwds_cantrcv_clear_wkuprs (struct xwds_cantrcv *cantrcv)
	XWDS API：清除CAN接收器的唤醒原因

void	xwds_cantrcv_drvcb_wakeup_notification (struct xwds_cantrcv *cantrcv)
	CAN接收器回调函数：CAN接收器的唤醒通知

详细描述

类型定义说明

◆ xwds_cantrcv_wkup_isr_f

typedef void(* xwds_cantrcv_wkup_isr_f) (struct xwds_cantrcv *, struct xwds_canc *)

唤醒中断回调函数

在文件 transceiver.h 第 80 行定义.

枚举类型说明

◆ xwds_cantrcv_opmode_em

enum xwds_cantrcv_opmode_em

CAN接收器模式枚举

枚举值
XWDS_CANTRCV_OPMODE_NORMAL	Transceiver mode NORMAL
XWDS_CANTRCV_OPMODE_SLEEP	Transceiver mode SLEEP
XWDS_CANTRCV_OPMODE_STANDBY	Transceiver mode STANDBY
XWDS_CANTRCV_OPMODE_NUM	number of operation mode

在文件 transceiver.h 第 40 行定义.

                            {
        XWDS_CANTRCV_OPMODE_NORMAL = 0, 
        XWDS_CANTRCV_OPMODE_SLEEP, 
        XWDS_CANTRCV_OPMODE_STANDBY, 
        XWDS_CANTRCV_OPMODE_NUM, 
};

◆ xwds_cantrcv_wkuprs_em

enum xwds_cantrcv_wkuprs_em

CAN接收器唤醒原因枚举

枚举值
XWDS_CANTRCV_WKUPRS_NONE	No reason
XWDS_CANTRCV_WKUPRS_BY_BUS
XWDS_CANTRCV_WKUPRS_BY_PIN	The transceiver has detected, that the network has caused the wake up of the ECU.
XWDS_CANTRCV_WKUPRS_INTERNALLY	The transceiver has detected a wake-up event at one of the transceiver's pins (not at the CAN bus).
XWDS_CANTRCV_WKUPRS_NOT_SUPPORTED	The transceiver has detected, that the network has woken up by the ECU via a request to NORMAL mode.
XWDS_CANTRCV_WKUPRS_POWER_ON	The transceiver does not support any information for the wake up reason.
XWDS_CANTRCV_WKUPRS_RESET	The transceiver has detected, that the "wake up" is due to an ECU reset after power on.
XWDS_CANTRCV_WKUPRS_BY_SYSERR	The transceiver has detected, that the "wake up" is due to an ECU reset.
XWDS_CANTRCV_WKUPRS_NUM	The transceiver has detected, that the "wake up" of the ECU was caused by a HW related device failure. number of wakeup reason

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

                            {
        XWDS_CANTRCV_WKUPRS_NONE = 0, 
        XWDS_CANTRCV_WKUPRS_BY_BUS, 
        XWDS_CANTRCV_WKUPRS_BY_PIN, 
        XWDS_CANTRCV_WKUPRS_INTERNALLY, 
        XWDS_CANTRCV_WKUPRS_NOT_SUPPORTED, 
        XWDS_CANTRCV_WKUPRS_POWER_ON, 
        XWDS_CANTRCV_WKUPRS_RESET, 
        XWDS_CANTRCV_WKUPRS_BY_SYSERR, 
        XWDS_CANTRCV_WKUPRS_NUM, 
};

函数说明

◆ xwds_cantrcv_clear_wkuprs()

void xwds_cantrcv_clear_wkuprs ( struct xwds_cantrcv * cantrcv )

XWDS API：清除CAN接收器的唤醒原因

参数

[in] cantrcv CAN接收器对象指针

注解

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

在文件 transceiver.c 第 301 行定义.

{
        XWDS_VALIDATE(cantrcv, "nullptr");
 
        cantrcv->wkuprs = XWDS_CANTRCV_WKUPRS_NONE;
}

◆ xwds_cantrcv_construct()

void xwds_cantrcv_construct ( struct xwds_cantrcv * cantrcv )

XWDS API：CAN接收器的构造函数

参数

[in] cantrcv CAN接收器对象指针

在文件 transceiver.c 第 60 行定义.

{
        xwds_device_construct(&cantrcv->bc.dev);
        cantrcv->bc.dev.vop = &xwds_cantrcv_vop;
}

函数调用图:

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

◆ xwds_cantrcv_destruct()

void xwds_cantrcv_destruct ( struct xwds_cantrcv * cantrcv )

XWDS API：CAN接收器对象的析构函数

参数

[in] cantrcv CAN接收器对象指针

在文件 transceiver.c 第 67 行定义.

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

函数调用图:

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

◆ xwds_cantrcv_disable_wkup()

xwer_t xwds_cantrcv_disable_wkup ( struct xwds_cantrcv * cantrcv )

XWDS API：关闭CAN接收器的唤醒

参数

[in] cantrcv CAN接收器对象指针

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	空指针
-EOPNOTSUPP	不支持此API

注解

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

在文件 transceiver.c 第 254 行定义.

{
        xwer_t rc;
        const struct xwds_cantrcv_driver * drv;
        const struct xwds_cantrcv_cfg * cfg;
 
        XWDS_VALIDATE(cantrcv, "nullptr", -EFAULT);
 
        cfg = cantrcv->cfg;
        if (cfg->wkup_supported) {
                drv = xwds_cast(const struct xwds_cantrcv_driver *,
                                cantrcv->bc.dev.drv);
                if ((drv) && (drv->disable_wkup)) {
                        rc = drv->disable_wkup(cantrcv);
                } else {
                        rc = -ENOSYS;
                }
        } else {
                rc = -EOPNOTSUPP;
        }
        return rc;
}

◆ xwds_cantrcv_drvcb_wakeup_notification()

void xwds_cantrcv_drvcb_wakeup_notification ( struct xwds_cantrcv * cantrcv )

CAN接收器回调函数：CAN接收器的唤醒通知

参数

[in] cantrcv CAN接收器对象指针

注解

上下文：中断、中断底半部

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

在文件 transceiver.c 第 309 行定义.

{
        if (cantrcv->wkup_isr) {
                cantrcv->wkup_isr(cantrcv, cantrcv->canc);
        }/* else {} */
}

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

◆ xwds_cantrcv_enable_wkup()

xwer_t xwds_cantrcv_enable_wkup ( struct xwds_cantrcv * cantrcv )

XWDS API：开启CAN接收器的唤醒

参数

[in] cantrcv CAN接收器对象指针

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	空指针
-EOPNOTSUPP	不支持此API

注解

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

在文件 transceiver.c 第 230 行定义.

{
        xwer_t rc;
        const struct xwds_cantrcv_driver * drv;
        const struct xwds_cantrcv_cfg * cfg;
 
        XWDS_VALIDATE(cantrcv, "nullptr", -EFAULT);
 
        cfg = cantrcv->cfg;
        if (cfg->wkup_supported) {
                drv = xwds_cast(const struct xwds_cantrcv_driver *,
                                cantrcv->bc.dev.drv);
                if ((drv) && (drv->enable_wkup)) {
                        rc = drv->enable_wkup(cantrcv);
                } else {
                        rc = -ENOSYS;
                }
        } else {
                rc = -EOPNOTSUPP;
        }
        return rc;
}

◆ xwds_cantrcv_get_opmode()

void xwds_cantrcv_get_opmode	(	struct xwds_cantrcv *	cantrcv,
		xwsq_t *	opmode
	)

XWDS API：设置CAN接收器的模式

参数

[in]	cantrcv	CAN接收器对象指针
[out]	opmode	指向缓冲区的指针，通过次缓冲区返回模式

注解

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

在文件 transceiver.c 第 221 行定义.

{
        XWDS_VALIDATE(cantrcv, "nullptr");
        XWDS_VALIDATE(opmode, "nullptr");
 
        *opmode = cantrcv->opmode;
}

◆ xwds_cantrcv_get_wkuprs()

void xwds_cantrcv_get_wkuprs	(	struct xwds_cantrcv *	cantrcv,
		xwsq_t *	wkuprs
	)

XWDS API：获取CAN接收器的唤醒原因

参数

[in]	cantrcv	CAN接收器对象指针
[out]	wkuprs	指向缓冲区的指针，通过次缓冲区返回唤醒原因

注解

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

在文件 transceiver.c 第 285 行定义.

{
        const struct xwds_cantrcv_cfg * cfg;
 
        XWDS_VALIDATE(cantrcv, "nullptr");
        XWDS_VALIDATE(wkuprs, "nullptr");
 
        cfg = cantrcv->cfg;
        if (cfg->wkup_supported) {
                *wkuprs = cantrcv->wkuprs;
        } else {
                *wkuprs = XWDS_CANTRCV_WKUPRS_NOT_SUPPORTED;
        }
}

◆ xwds_cantrcv_grab()

xwer_t xwds_cantrcv_grab ( struct xwds_cantrcv * cantrcv )

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

参数

[in] cantrcv CAN接收器对象指针

在文件 transceiver.c 第 73 行定义.

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

函数调用图:

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

◆ xwds_cantrcv_put()

xwer_t xwds_cantrcv_put ( struct xwds_cantrcv * cantrcv )

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

参数

[in] cantrcv CAN接收器对象指针

在文件 transceiver.c 第 79 行定义.

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

函数调用图:

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

◆ xwds_cantrcv_set_opmode()

xwer_t xwds_cantrcv_set_opmode	(	struct xwds_cantrcv *	cantrcv,
		xwsq_t	opmode
	)

XWDS API：设置CAN接收器的运行模式

参数

[in]	cantrcv	CAN接收器对象指针
[in]	opmode	唤醒模式

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	空指针
-ERANGE	不支持的模式

注解

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

<No error

在文件 transceiver.c 第 196 行定义.

{
        xwer_t rc;
        const struct xwds_cantrcv_driver * drv;
 
        XWDS_VALIDATE(cantrcv, "nullptr", -EFAULT);
        XWDS_VALIDATE((opmode < XWDS_CANTRCV_OPMODE_NUM), "out-of-range", -ERANGE);
 
        drv = xwds_cast(const struct xwds_cantrcv_driver *, cantrcv->bc.dev.drv);
        if ((drv) && (drv->set_opmode)) {
                rc = drv->set_opmode(cantrcv, opmode);
        } else {
                rc = -ENOSYS;
        }
        if (rc < 0) {
                goto err_ops_set_opmode;
        }
        cantrcv->opmode = opmode;
        return XWOK;
 
err_ops_set_opmode:
        return rc;
}

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

◆ xwds_cantrcv_set_wkup_isr()

void xwds_cantrcv_set_wkup_isr	(	struct xwds_cantrcv *	cantrcv,
		xwds_cantrcv_wkup_isr_f	isr
	)

XWDS API：设置唤醒中断的回调函数

参数

[in]	cantrcv	CAN接收器对象指针
[in]	isr	回调函数

注解

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

必须调用 xwds_cantrcv_disable_wkup() 后才可修改回调函数。

在文件 transceiver.c 第 278 行定义.

{
        cantrcv->wkup_isr = isr;
}

结构体

类型定义

枚举

函数

详细描述

类型定义说明

◆ xwds_cantrcv_wkup_isr_f

枚举类型说明

◆ xwds_cantrcv_opmode_em

◆ xwds_cantrcv_wkuprs_em

函数说明

◆ xwds_cantrcv_clear_wkuprs()

◆ xwds_cantrcv_construct()

◆ xwds_cantrcv_destruct()

◆ xwds_cantrcv_disable_wkup()

◆ xwds_cantrcv_drvcb_wakeup_notification()

◆ xwds_cantrcv_enable_wkup()

◆ xwds_cantrcv_get_opmode()

◆ xwds_cantrcv_get_wkuprs()

◆ xwds_cantrcv_grab()

◆ xwds_cantrcv_put()

◆ xwds_cantrcv_set_opmode()

◆ xwds_cantrcv_set_wkup_isr()