LIN控制器

LIN控制器 的协作图:

结构体
struct	xwds_lin_msg
	LIN消息结构体 更多...
struct	xwds_lin_msg_info
	LIN消息信息 更多...
struct	xwds_lin_cfg
	LIN控制器配置 更多...
struct	xwds_linc_driver
	LIN控制器驱动函数表 更多...
struct	xwds_linc
	LIN控制器 更多...

宏定义
#define	XWDS_LIN_DIAG_MSTREQ_MSG   0x3C
#define	XWDS_LIN_DIAG_SLCREP_MSG   0x3D
#define	XWDS_LIN_DEFAULT_DATA_SIZE   8
#define	LIN_ID_PARITY(id)
#define	LIN_ID_PARITY_FIELD(id)   (LIN_ID_PARITY(id) | ((id) & 0xFFU))

枚举
enum	xwds_lin_mode_em { XWDS_LIN_MODE_CLOSE = 0 , XWDS_LIN_MODE_TX = ((xwbmp_t)1 << ( 0 )) , XWDS_LIN_MODE_RX = ((xwbmp_t)1 << ( 1 )) }
	LIN接口模式枚举 更多...
enum	xwds_lin_chksum_type_em { XWDS_LIN_CHKSUM_CLASSIC = 0 , XWDS_LIN_CHKSUM_ENHANCED }
	LIN协议类型 更多...

函数
void	xwds_linc_construct (struct xwds_linc *linc)
	XWDS API：LIN控制器的构造函数
void	xwds_linc_destruct (struct xwds_linc *linc)
	XWDS API：LIN控制器对象的析构函数
xwer_t	xwds_linc_grab (struct xwds_linc *linc)
	XWDS API：增加对象的引用计数
xwer_t	xwds_linc_put (struct xwds_linc *linc)
	XWDS API：减少对象的引用计数
xwer_t	xwds_linc_msttx (struct xwds_linc *linc, xwu8_t id, struct xwds_lin_msg *msg, xwtm_t to)
	XWDS API：主机节点发送一条LIN消息
xwer_t	xwds_linc_slvtx (struct xwds_linc *linc, struct xwds_lin_msg *msg, xwtm_t to)
	XWDS API：从机节点发送一条LIN消息
xwer_t	xwds_linc_rx (struct xwds_linc *linc, struct xwds_lin_msg *msgbuf, xwtm_t to)
	XWDS API：接收一条LIN消息
xwer_t	xwds_linc_get_msg_size (struct xwds_linc *linc, xwu8_t protected_id, xwu8_t *ret)
	XWDS API：通过LIN保护ID查询消息大小

变量
const unsigned char	xwos_linid_table [64]
	LIN总线ID校验表

详细描述

宏定义说明

LIN_ID_PARITY

#define LIN_ID_PARITY

(

id

)

值:

                                ((((~(XWBOP_TBIT((id), 1U) ^ XWBOP_TBIT((id), 3U) ^ \
                                XWBOP_TBIT((id), 4U) ^ XWBOP_TBIT((id), 5U))) << 7U) | \
                            ((XWBOP_TBIT((id), 0U) ^ XWBOP_TBIT((id), 1U) ^ \
                              XWBOP_TBIT((id), 2U) ^ XWBOP_TBIT((id), 4U)) << 6U)) & \
                           0xC0U)

在文件 id.h 第 33 行定义.

LIN_ID_PARITY_FIELD

#define LIN_ID_PARITY_FIELD

(

id

)

(LIN_ID_PARITY(id) | ((id) & 0xFFU))

在文件 id.h 第 38 行定义.

XWDS_LIN_DEFAULT_DATA_SIZE

#define XWDS_LIN_DEFAULT_DATA_SIZE   8

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

XWDS_LIN_DIAG_MSTREQ_MSG

#define XWDS_LIN_DIAG_MSTREQ_MSG   0x3C

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

XWDS_LIN_DIAG_SLCREP_MSG

#define XWDS_LIN_DIAG_SLCREP_MSG   0x3D

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

枚举类型说明

xwds_lin_chksum_type_em

enum xwds_lin_chksum_type_em

LIN协议类型

枚举值
XWDS_LIN_CHKSUM_CLASSIC
XWDS_LIN_CHKSUM_ENHANCED

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

                             {
        XWDS_LIN_CHKSUM_CLASSIC = 0,
        XWDS_LIN_CHKSUM_ENHANCED,
};

xwds_lin_mode_em

enum xwds_lin_mode_em

LIN接口模式枚举

枚举值
XWDS_LIN_MODE_CLOSE
XWDS_LIN_MODE_TX
XWDS_LIN_MODE_RX

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

                      {
        XWDS_LIN_MODE_CLOSE = 0,
        XWDS_LIN_MODE_TX = XWBOP_BIT(0),
        XWDS_LIN_MODE_RX = XWBOP_BIT(1),
};

函数说明

xwds_linc_construct()

void xwds_linc_construct

(

struct xwds_linc *

linc

)

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

参数

[in]

linc

LIN控制器对象指针

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

{
        xwds_device_construct(&linc->dev);
        linc->dev.vop = &xwds_linc_vop;
}

函数调用图:

xwds_linc_destruct()

void xwds_linc_destruct

(

struct xwds_linc *

linc

)

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

参数

[in]

linc

LIN控制器对象指针

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

{
        xwds_device_destruct(&linc->dev);
}

函数调用图:

xwds_linc_get_msg_size()

xwer_t xwds_linc_get_msg_size	(	struct xwds_linc *	linc,
		xwu8_t	protected_id,
		xwu8_t *	ret
	)

XWDS API：通过LIN保护ID查询消息大小

参数

[in]	linc	LIN控制器对象指针
[in]	protected_id	消息的LIN保护ID
[out]	ret	指向缓冲区的指针，通过此缓冲区返回消息大小

返回

错误码

返回值

XWOK	没有错误
-EFAULT	无效指针
-ENODEV	找不到ID

注解

• 上下文：任意

<No error

<No error

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

{
        const struct xwds_lin_msg_info * msgitbl;
        xwsz_t itemnum;
        xwer_t rc;
        xwsq_t i;
 
        XWDS_VALIDATE(linc, "nullptr", -EFAULT);
        XWDS_VALIDATE(ret, "nullptr", -EFAULT);
 
        msgitbl = linc->msgitable;
        itemnum = linc->msgitable_itemnum;
        rc = -ENODEV;
        if (!is_err_or_null(msgitbl)) {
                for (i = 0; i < itemnum; i++) {
                        if (protected_id == msgitbl[i].protected_id) {
                                *ret = msgitbl[i].size;
                                rc = XWOK;
                                break;
                        }
                }
                if (-ENODEV == rc) {
                        *ret = XWDS_LIN_DEFAULT_DATA_SIZE;
                }
        } else {
                rc = XWOK;
                *ret = XWDS_LIN_DEFAULT_DATA_SIZE;
        }
        return rc;
}

函数调用图:

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

xwds_linc_grab()

xwer_t xwds_linc_grab

(

struct xwds_linc *

linc

)

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

参数

[in]

linc

LIN控制器对象指针

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

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

函数调用图:

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

xwds_linc_msttx()

xwer_t xwds_linc_msttx	(	struct xwds_linc *	linc,
		xwu8_t	id,
		struct xwds_lin_msg *	msg,
		xwtm_t	to
	)

XWDS API：主机节点发送一条LIN消息

参数

[in]	linc	LIN控制器对象指针
[in]	id	主机节点调度消息的ID
[in]	msg	LIN消息结构体指针
[in]	to	期望唤醒的时间点

返回

错误码

返回值

XWOK	没有错误
-EFAULT	无效指针
-ENOSYS	控制器不支持主机模式发送

注解

• 上下文：线程

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

<No error

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

{
        xwer_t rc;
        const struct xwds_linc_driver * drv;
 
        XWDS_VALIDATE(linc, "nullptr", -EFAULT);
        XWDS_VALIDATE(msg, "nullptr", -EFAULT);
 
        rc = xwds_linc_grab(linc);
        if (rc < 0) {
                goto err_linc_grab;
        }
        rc = xwos_mtx_lock_to(&linc->txlock, to);
        if (rc < 0) {
                goto err_linc_txlock;
        }
        drv = xwds_cast(const struct xwds_linc_driver *, linc->dev.drv);
        if ((drv) && (drv->msttx)) {
                rc = drv->msttx(linc, id, msg, to);
        } else {
                rc = -ENOSYS;
        }
        if (rc < 0) {
                goto err_drv_msttx;
        }
        xwos_mtx_unlock(&linc->txlock);
        xwds_linc_put(linc);
        return XWOK;
 
err_drv_msttx:
        xwos_mtx_unlock(&linc->txlock);
err_linc_txlock:
        xwds_linc_put(linc);
err_linc_grab:
        return rc;
}

函数调用图:

xwds_linc_put()

xwer_t xwds_linc_put

(

struct xwds_linc *

linc

)

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

参数

[in]

linc

LIN控制器对象指针

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

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

函数调用图:

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

xwds_linc_rx()

xwer_t xwds_linc_rx	(	struct xwds_linc *	linc,
		struct xwds_lin_msg *	msgbuf,
		xwtm_t	to
	)

XWDS API：接收一条LIN消息

参数

[in]	linc	LIN控制器对象指针
[out]	msgbuf	指向接收消息缓冲区的指针
[in,out]	to	期望唤醒的时间点

返回

错误码

返回值

XWOK	没有错误
-EFAULT	无效指针
-ENOSYS	控制器不支持接收

注解

• 上下文：线程

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

<No error

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

{
        xwer_t rc;
        const struct xwds_linc_driver * drv;
 
        XWDS_VALIDATE(linc, "nullptr", -EFAULT);
        XWDS_VALIDATE(msgbuf, "nullptr", -EFAULT);
 
        rc = xwds_linc_grab(linc);
        if (rc < 0) {
                goto err_linc_grab;
        }
        drv = xwds_cast(const struct xwds_linc_driver *, linc->dev.drv);
        if ((drv) && (drv->rx)) {
                rc = drv->rx(linc, msgbuf, to);
        } else {
                rc = -ENOSYS;
        }
        if (rc < 0) {
                goto err_drv_rx;
        }
        xwds_linc_put(linc);
        return XWOK;
 
err_drv_rx:
        xwds_linc_put(linc);
err_linc_grab:
        return rc;
}

函数调用图:

xwds_linc_slvtx()

xwer_t xwds_linc_slvtx	(	struct xwds_linc *	linc,
		struct xwds_lin_msg *	msg,
		xwtm_t	to
	)

XWDS API：从机节点发送一条LIN消息

参数

[in]	linc	LIN控制器对象指针
[in]	msg	LIN消息结构体指针
[in,out]	to	期望唤醒的时间点

返回

错误码

返回值

XWOK	没有错误
-EFAULT	无效指针
-ENOSYS	控制器不支持从机模式发送

注解

• 上下文：线程

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

<No error

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

{
        xwer_t rc;
        const struct xwds_linc_driver * drv;
 
        XWDS_VALIDATE(linc, "nullptr", -EFAULT);
        XWDS_VALIDATE(msg, "nullptr", -EFAULT);
 
        rc = xwds_linc_grab(linc);
        if (rc < 0) {
                goto err_linc_grab;
        }
        rc = xwos_mtx_lock_to(&linc->txlock, to);
        if (rc < 0) {
                goto err_linc_txlock;
        }
        drv = xwds_cast(const struct xwds_linc_driver *, linc->dev.drv);
        if ((drv) && (drv->slvtx)) {
                rc = drv->slvtx(linc, msg, to);
        } else {
                rc = -ENOSYS;
        }
        if (rc < 0) {
                goto err_drv_slvtx;
        }
        xwos_mtx_unlock(&linc->txlock);
        xwds_linc_put(linc);
        return XWOK;
 
err_drv_slvtx:
        xwos_mtx_unlock(&linc->txlock);
err_linc_txlock:
        xwds_linc_put(linc);
err_linc_grab:
        return rc;
}

函数调用图:

变量说明

xwos_linid_table

const unsigned char xwos_linid_table[64]

extern

LIN总线ID校验表