设备基类

设备基类 的协作图:

结构体
struct	xwds_virtual_operation
	基本操作的虚函数表（类似C++的虚函数表） 更多...
struct	xwds_driver
	基本驱动函数表（所有设备驱动的基类） 更多...
struct	xwds_device
	设备（所有设备的基类） 更多...

宏定义
#define	xwds_itr_next_device(ds, p)
	向前迭代每个设备
#define	xwds_itr_prev_device(ds, p)
	向后迭代每个设备
#define	xwds_itr_next_device_safe(ds, p, n)
	向前迭代每个设备（可安全删除设备）
#define	xwds_itr_prev_device_safe(ds, p, n)
	向后迭代每个设备（可安全删除设备）
#define	__IOC_NRBITS   8
#define	__IOC_TYPEBITS   8
#define	__IOC_SIZEBITS   14
#define	__IOC_DIRBITS   2
#define	__IOC_NRMASK   ((1 << __IOC_NRBITS) - 1)
#define	__IOC_TYPEMASK   ((1 << __IOC_TYPEBITS) - 1)
#define	__IOC_SIZEMASK   ((1 << __IOC_SIZEBITS) - 1)
#define	__IOC_DIRMASK   ((1 << __IOC_DIRBITS) - 1)
#define	__IOC_NRSHIFT   0
#define	__IOC_TYPESHIFT   (__IOC_NRSHIFT + __IOC_NRBITS)
#define	__IOC_SIZESHIFT   (__IOC_TYPESHIFT + __IOC_TYPEBITS)
#define	__IOC_DIRSHIFT   (__IOC_SIZESHIFT + __IOC_SIZEBITS)
#define	__IOC_CTRL   0U
#define	__IOC_WRITE   1U
#define	__IOC_READ   2U
#define	__IOC(dir, type, nr, size)

函数
xwer_t	xwds_device_vop_probe (struct xwds_device *dev)
	设备基本操作函数：探测设备
xwer_t	xwds_device_vop_remove (struct xwds_device *dev)
	设备基本操作函数：删除设备
xwer_t	xwds_device_vop_start (struct xwds_device *dev)
	设备基本操作函数：启动设备
xwer_t	xwds_device_vop_stop (struct xwds_device *dev)
	设备基本操作函数：停止设备
xwer_t	xwds_device_vop_suspend (struct xwds_device *dev)
	设备基本操作函数：暂停设备
xwer_t	xwds_device_vop_resume (struct xwds_device *dev)
	设备基本操作函数：继续设备
void	xwds_device_construct (struct xwds_device *dev)
	XWDS API：设备的构造函数
void	xwds_device_destruct (struct xwds_device *dev)
	XWDS API：设备的析构函数
xwer_t	xwds_device_probe (struct xwds *ds, struct xwds_device *dev, xwobj_gc_f gcfunc)
	XWDS API：探测设备
xwer_t	xwds_device_remove (struct xwds_device *dev)
	XWDS API：删除设备
xwer_t	xwds_device_start (struct xwds_device *dev)
	XWDS API：启动设备
xwer_t	xwds_device_stop (struct xwds_device *dev)
	XWDS API：停止设备
xwer_t	xwds_device_suspend (struct xwds_device *dev)
	XWDS API：暂停设备
xwer_t	xwds_device_resume (struct xwds_device *dev)
	XWDS API：继续设备
xwer_t	xwds_device_suspend_all (struct xwds *ds, bool ign_err)
	XWDS API：暂停所有设备
xwer_t	xwds_device_resume_all (struct xwds *ds, bool ign_err)
	XWDS API：继续所有设备
static xwsq_t	xwds_device_get_tik (struct xwds_device *dev)
	XWDS API：获取设备对象的标签
static xwer_t	xwds_device_grab (struct xwds_device *dev)
	XWDS API：增加对象的引用计数
static xwer_t	xwds_device_put (struct xwds_device *dev)
	XWDS API：减少对象的引用计数
static xwsq_t	xwds_device_get_refcnt (struct xwds_device *dev)
	XWDS API：得到对象的引用计数

详细描述

宏定义说明

__IOC

#define __IOC	(		dir,
			type,
			nr,
			size
	)

值:

        (((dir)  << __IOC_DIRSHIFT) |   \
         ((type) << __IOC_TYPESHIFT) |  \
         ((nr)   << __IOC_NRSHIFT) |    \
         ((size) << __IOC_SIZESHIFT))

在文件 device.h 第 88 行定义.

__IOC_CTRL

#define __IOC_CTRL   0U

在文件 device.h 第 84 行定义.

__IOC_DIRBITS

#define __IOC_DIRBITS   2

在文件 device.h 第 72 行定义.

__IOC_DIRMASK

#define __IOC_DIRMASK   ((1 << __IOC_DIRBITS) - 1)

在文件 device.h 第 77 行定义.

__IOC_DIRSHIFT

#define __IOC_DIRSHIFT   (__IOC_SIZESHIFT + __IOC_SIZEBITS)

在文件 device.h 第 82 行定义.

__IOC_NRBITS

#define __IOC_NRBITS   8

在文件 device.h 第 69 行定义.

__IOC_NRMASK

#define __IOC_NRMASK   ((1 << __IOC_NRBITS) - 1)

在文件 device.h 第 74 行定义.

__IOC_NRSHIFT

#define __IOC_NRSHIFT   0

在文件 device.h 第 79 行定义.

__IOC_READ

#define __IOC_READ   2U

在文件 device.h 第 86 行定义.

__IOC_SIZEBITS

#define __IOC_SIZEBITS   14

在文件 device.h 第 71 行定义.

__IOC_SIZEMASK

#define __IOC_SIZEMASK   ((1 << __IOC_SIZEBITS) - 1)

在文件 device.h 第 76 行定义.

__IOC_SIZESHIFT

#define __IOC_SIZESHIFT   (__IOC_TYPESHIFT + __IOC_TYPEBITS)

在文件 device.h 第 81 行定义.

__IOC_TYPEBITS

#define __IOC_TYPEBITS   8

在文件 device.h 第 70 行定义.

__IOC_TYPEMASK

#define __IOC_TYPEMASK   ((1 << __IOC_TYPEBITS) - 1)

在文件 device.h 第 75 行定义.

__IOC_TYPESHIFT

#define __IOC_TYPESHIFT   (__IOC_NRSHIFT + __IOC_NRBITS)

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

__IOC_WRITE

#define __IOC_WRITE   1U

在文件 device.h 第 85 行定义.

xwds_itr_next_device

#define xwds_itr_next_device	(		ds,
			p
	)

值:

        xwlib_bclst_itr_next_entry(p, &(ds)->devhead,  \
                                   struct xwds_device, obj.node)

向前迭代每个设备

在文件 device.h 第 44 行定义.

xwds_itr_next_device_safe

#define xwds_itr_next_device_safe	(		ds,
			p,
			n
	)

值:

        xwlib_bclst_itr_next_entry_safe(p, n, &(ds)->devhead,  \
                                        struct xwds_device, obj.node)

向前迭代每个设备（可安全删除设备）

在文件 device.h 第 58 行定义.

xwds_itr_prev_device

#define xwds_itr_prev_device	(		ds,
			p
	)

值:

        xwlib_bclst_itr_prev_entry(p, &(ds)->devhead,  \
                                   struct xwds_device, obj.node)

向后迭代每个设备

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

xwds_itr_prev_device_safe

#define xwds_itr_prev_device_safe	(		ds,
			p,
			n
	)

值:

        xwlib_bclst_itr_prev_entry_safe(p, n, &(ds)->devhead,  \
                                        struct xwds_device, obj.node)

向后迭代每个设备（可安全删除设备）

在文件 device.h 第 65 行定义.

函数说明

xwds_device_construct()

void xwds_device_construct

(

struct xwds_device *

dev

)

XWDS API：设备的构造函数

参数

[in]

dev

设备对象的指针

在文件 device.c 第 48 行定义.

{
        xwds_obj_construct(&dev->obj);
        dev->vop = &xwds_dev_vop;
        dev->ds = NULL;
}

函数调用图:

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

xwds_device_destruct()

void xwds_device_destruct

(

struct xwds_device *

dev

)

XWDS API：设备的析构函数

参数

[in]

dev

设备对象的指针

在文件 device.c 第 56 行定义.

{
        xwds_obj_destruct(&dev->obj);
}

函数调用图:

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

xwds_device_get_refcnt()

static xwsq_t xwds_device_get_refcnt ( struct xwds_device *  dev )

inlinestatic

XWDS API：得到对象的引用计数

参数

[in]

dev

设备对象的指针

返回

引用计数

在文件 device.h 第 293 行定义.

{
        return xwds_obj_get_refcnt(&dev->obj);
}

函数调用图:

xwds_device_get_tik()

static xwsq_t xwds_device_get_tik ( struct xwds_device *  dev )

inlinestatic

XWDS API：获取设备对象的标签

参数

[in]

dev

设备对象的指针

返回

标签

在文件 device.h 第 254 行定义.

{
        return xwds_obj_get_tik(&dev->obj);
}

函数调用图:

xwds_device_grab()

static xwer_t xwds_device_grab ( struct xwds_device *  dev )

inlinestatic

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

参数

[in]

dev

设备对象的指针

返回

错误码

返回值

ref xwds_obj_grab()

< 去除未使用变量的警告

<No error

在文件 device.h 第 268 行定义.

{
        XWOS_UNUSED(dev);
        return XWOK;
}

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

xwds_device_probe()

xwer_t xwds_device_probe	(	struct xwds *	ds,
		struct xwds_device *	dev,
		xwobj_gc_f	gcfunc
	)

XWDS API：探测设备

参数

[in]	ds	设备栈控制块指针
[in]	dev	设备对象的指针
[in]	gcfunc	垃圾回收函数

返回

错误码

返回值

XWOK	没有错误发生
-EPERM	引用计数错误

注解

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

<No error

在文件 device.c 第 213 行定义.

{
        const struct xwds_virtual_operation * vop;
        xwer_t rc;
 
        XWDS_VALIDATE(ds, "nullptr", -EFAULT);
        XWDS_VALIDATE(dev, "nullptr", -EFAULT);
 
        rc = xwds_obj_probe(&dev->obj, gcfunc);
        if (rc < 0) {
                goto err_obj_probe;
        }
        /* refcnt == XWDS_OBJ_REF_SHUTDOWN */
 
        /* probe device */
        vop = dev->vop;
        if (vop && vop->probe) {
                rc = vop->probe(dev);
        } else {
                rc = xwds_device_vop_probe(dev);
        }
        if (rc < 0) {
                goto err_dev_vop_probe;
        }
 
        /* add to device stack */
        rc = xwds_obj_add(ds, &dev->obj);
        if (rc < 0) {
                goto err_xwds_obj_add;
        }
        dev->ds = ds;
 
        return XWOK;
 
err_xwds_obj_add:
        if ((vop) && (vop->remove)) {
                vop->remove(dev);
        } else {
                xwds_device_vop_probe(dev);
        }
err_dev_vop_probe:
        xwos_object_rawput(&dev->obj.xwobj);
err_obj_probe:
        return rc;
}

函数调用图:

xwds_device_put()

static xwer_t xwds_device_put ( struct xwds_device *  dev )

inlinestatic

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

参数

[in]

dev

设备对象的指针

返回

错误码

返回值

ref xwds_obj_put()

< 去除未使用变量的警告

<No error

在文件 device.h 第 281 行定义.

{
        XWOS_UNUSED(dev);
        return XWOK;
}

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

xwds_device_remove()

xwer_t xwds_device_remove

(

struct xwds_device *

dev

)

XWDS API：删除设备

参数

[in]

dev

设备对象的指针

返回

错误码

返回值

XWOK	没有错误发生
-EPERM	引用计数错误

注解

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

在文件 device.c 第 261 行定义.

{
        XWDS_VALIDATE(dev, "nullptr", -EFAULT);
 
        return xwds_obj_remove(&dev->obj);
}

函数调用图:

xwds_device_resume()

xwer_t xwds_device_resume

(

struct xwds_device *

dev

)

XWDS API：继续设备

参数

[in]

dev

设备对象的指针

返回

错误码

注解

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

<No error

在文件 device.c 第 366 行定义.

{
        const struct xwds_virtual_operation * vop;
        xwer_t rc;
 
        XWDS_VALIDATE(dev, "nullptr", -EFAULT);
 
        rc = xwds_obj_resume(&dev->obj);
        if (rc < 0) {
                goto err_obj_resume;
        }
        /* refcnt == XWDS_OBJ_REF_RUNNING */
 
        /* resume device */
        vop = dev->vop;
        if (vop && vop->resume) {
                rc = vop->resume(dev);
        } else {
                rc = xwds_device_vop_resume(dev);
        }
        if (rc < 0) {
                goto err_dev_vop_resume;
        }
        return XWOK;
 
err_dev_vop_resume:
        xwds_obj_suspend(&dev->obj);
err_obj_resume:
        return rc;
}

函数调用图:

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

xwds_device_resume_all()

xwer_t xwds_device_resume_all	(	struct xwds *	ds,
		bool	ign_err
	)

XWDS API：继续所有设备

参数

[in]	ds	设备栈控制块指针
[in]	ign_err	是否忽略错误：若为假，发生错误时，函数会中止并返回

返回

错误码

注解

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

<No error

<No error

在文件 device.c 第 425 行定义.

{
        struct xwds_device * c, * n;
        xwreg_t cpuirq;
        xwer_t rc;
 
        XWDS_VALIDATE(ds, "nullptr", -EFAULT);
 
        rc = XWOK;
        xwos_sqlk_wr_lock_cpuirqsv(&ds->devlistlock, &cpuirq);
        xwds_itr_next_device_safe(ds, c, n) {
                xwos_sqlk_wr_unlock_cpuirqrs(&ds->devlistlock, cpuirq);
                rc = xwds_device_resume(c);
                xwos_sqlk_wr_lock_cpuirqsv(&ds->devlistlock, &cpuirq);
                if (rc < 0) {
                        if (ign_err) {
                                rc = XWOK;
                        } else {
                                break;
                        }
                }
        }
        xwos_sqlk_wr_unlock_cpuirqrs(&ds->devlistlock, cpuirq);
        return rc;
}

函数调用图:

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

xwds_device_start()

xwer_t xwds_device_start

(

struct xwds_device *

dev

)

XWDS API：启动设备

参数

[in]

dev

设备对象的指针

返回

错误码

返回值

XWOK	没有错误发生
-EPERM	引用计数错误

注解

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

<No error

在文件 device.c 第 269 行定义.

{
        const struct xwds_virtual_operation * vop;
        xwer_t rc;
 
        XWDS_VALIDATE(dev, "nullptr", -EFAULT);
 
        rc = xwds_obj_start(&dev->obj);
        if (rc < 0) {
                goto err_obj_start;
        }
        /* refcnt == XWDS_OBJ_REF_RUNNING */
 
        /* start device */
        vop = dev->vop;
        if (vop && vop->start) {
                rc = vop->start(dev);
        } else {
                rc = xwds_device_vop_start(dev);
        }
        if (rc < 0) {
                goto err_dev_vop_start;
        }
        return XWOK;
 
err_dev_vop_start:
        xwds_obj_stop(&dev->obj);
err_obj_start:
        return rc;
}

函数调用图:

xwds_device_stop()

xwer_t xwds_device_stop

(

struct xwds_device *

dev

)

XWDS API：停止设备

参数

[in]

dev

设备对象的指针

返回

错误码

注解

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

<No error

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

{
        const struct xwds_virtual_operation * vop;
        xwer_t rc;
 
        XWDS_VALIDATE(dev, "nullptr", -EFAULT);
 
        rc = xwds_obj_stop(&dev->obj);
        if (rc < 0) {
                goto err_obj_stop;
        }
        /* refcnt == XWDS_OBJ_REF_SHUTDOWN */
 
        /* stop device */
        vop = dev->vop;
        if (vop && vop->stop) {
                rc = vop->stop(dev);
        } else {
                rc = xwds_device_vop_stop(dev);
        }
        if (rc < 0) {
                goto err_dev_vop_stop;
        }
        return XWOK;
 
err_dev_vop_stop:
        xwds_obj_start(&dev->obj);
err_obj_stop:
        return rc;
}

函数调用图:

xwds_device_suspend()

xwer_t xwds_device_suspend

(

struct xwds_device *

dev

)

XWDS API：暂停设备

参数

[in]

dev

设备对象的指针

返回

错误码

注解

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

<No error

在文件 device.c 第 334 行定义.

{
        const struct xwds_virtual_operation * vop;
        xwer_t rc;
 
        XWDS_VALIDATE(dev, "nullptr", -EFAULT);
 
        rc = xwds_obj_suspend(&dev->obj);
        if (rc < 0) {
                goto err_obj_suspend;
        }
        /* refcnt == XWDS_OBJ_REF_SUSPEND */
 
        /* suspend device */
        vop = dev->vop;
        if (vop && vop->suspend) {
                rc = vop->suspend(dev);
        } else {
                rc = xwds_device_vop_suspend(dev);
        }
        if (rc < 0) {
                goto err_dev_vop_suspend;
        }
        return XWOK;
 
err_dev_vop_suspend:
        xwds_obj_resume(&dev->obj);
err_obj_suspend:
        return rc;
}

函数调用图:

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

xwds_device_suspend_all()

xwer_t xwds_device_suspend_all	(	struct xwds *	ds,
		bool	ign_err
	)

XWDS API：暂停所有设备

参数

[in]	ds	设备栈控制块指针
[in]	ign_err	是否忽略错误：若为假，发生错误时，函数会中止并返回

返回

错误码

注解

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

<No error

<No error

在文件 device.c 第 398 行定义.

{
        struct xwds_device * c, * n;
        xwreg_t cpuirq;
        xwer_t rc;
 
        XWDS_VALIDATE(ds, "nullptr", -EFAULT);
 
        rc = XWOK;
        xwos_sqlk_wr_lock_cpuirqsv(&ds->devlistlock, &cpuirq);
        xwds_itr_prev_device_safe(ds, c, n) {
                xwos_sqlk_wr_unlock_cpuirqrs(&ds->devlistlock, cpuirq);
                rc = xwds_device_suspend(c);
                xwos_sqlk_wr_lock_cpuirqsv(&ds->devlistlock, &cpuirq);
                if (rc < 0) {
                        if (ign_err) {
                                rc = XWOK;
                        } else {
                                break;
                        }
                }
        }
        xwos_sqlk_wr_unlock_cpuirqrs(&ds->devlistlock, cpuirq);
        return rc;
}

函数调用图:

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

xwds_device_vop_probe()

xwer_t xwds_device_vop_probe

(

struct xwds_device *

dev

)

设备基本操作函数：探测设备

参数

[in]

dev

设备对象的指针

<No error

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

{
        const struct xwds_driver * drv;
        xwer_t rc;
 
        drv = dev->drv;
        if ((drv) && (drv->probe)) {
                rc = drv->probe(dev);
        } else {
                rc = XWOK;
        }
        return rc;
}

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

xwds_device_vop_remove()

xwer_t xwds_device_vop_remove

(

struct xwds_device *

dev

)

设备基本操作函数：删除设备

参数

[in]

dev

设备对象的指针

<No error

在文件 device.c 第 86 行定义.

{
        const struct xwds_driver * drv;
        xwer_t rc;
 
        drv = dev->drv;
        if ((drv) && (drv->remove)) {
                rc = drv->remove(dev);
        } else {
                rc = XWOK;
        }
        return rc;
}

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

xwds_device_vop_resume()

xwer_t xwds_device_vop_resume

(

struct xwds_device *

dev

)

设备基本操作函数：继续设备

参数

[in]

dev

设备对象的指针

<No error

在文件 device.c 第 163 行定义.

{
        const struct xwds_driver * drv;
        xwer_t rc;
 
        drv = dev->drv;
        if ((drv) && (drv->resume)) {
                rc = drv->resume(dev);
        } else {
                rc = XWOK;
        }
        return rc;
}

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

xwds_device_vop_start()

xwer_t xwds_device_vop_start

(

struct xwds_device *

dev

)

设备基本操作函数：启动设备

参数

[in]

dev

设备对象的指针

<No error

在文件 device.c 第 105 行定义.

{
        const struct xwds_driver * drv;
        xwer_t rc;
 
        drv = dev->drv;
        if ((drv) && (drv->start)) {
                rc = drv->start(dev);
        } else {
                rc = XWOK;
        }
        return rc;
}

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

xwds_device_vop_stop()

xwer_t xwds_device_vop_stop

(

struct xwds_device *

dev

)

设备基本操作函数：停止设备

参数

[in]

dev

设备对象的指针

<No error

在文件 device.c 第 124 行定义.

{
        const struct xwds_driver * drv;
        xwer_t rc;
 
        drv = dev->drv;
        if ((drv) && (drv->stop)) {
                rc = drv->stop(dev);
        } else {
                rc = XWOK;
        }
        return rc;
}

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

xwds_device_vop_suspend()

xwer_t xwds_device_vop_suspend

(

struct xwds_device *

dev

)

设备基本操作函数：暂停设备

参数

[in]

dev

设备对象的指针

<No error

在文件 device.c 第 144 行定义.

{
        const struct xwds_driver * drv;
        xwer_t rc;
 
        drv = dev->drv;
        if ((drv) && (drv->suspend)) {
                rc = drv->suspend(dev);
        } else {
                rc = XWOK;
        }
        return rc;
}

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