device.h

浏览该文件的文档.

 
#ifndef __xwcd_ds_device_h__
#define __xwcd_ds_device_h__
 
#include <xwcd/ds/standard.h>
#include <xwos/lib/xwaop.h>
#include <xwos/lib/bclst.h>
#include <xwos/osal/lock/mtx.h>
#include <xwcd/ds/object.h>
 
#define xwds_itr_next_device(ds, p) \
        xwlib_bclst_itr_next_entry(p, &(ds)->devhead,  \
                                   struct xwds_device, obj.node)
 
#define xwds_itr_prev_device(ds, p) \
        xwlib_bclst_itr_prev_entry(p, &(ds)->devhead,  \
                                   struct xwds_device, obj.node)
 
#define xwds_itr_next_device_safe(ds, p, n) \
        xwlib_bclst_itr_next_entry_safe(p, n, &(ds)->devhead,  \
                                        struct xwds_device, obj.node)
 
#define xwds_itr_prev_device_safe(ds, p, n) \
        xwlib_bclst_itr_prev_entry_safe(p, n, &(ds)->devhead,  \
                                        struct xwds_device, obj.node)
 
#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)      \
        (((dir)  << __IOC_DIRSHIFT) |   \
         ((type) << __IOC_TYPESHIFT) |  \
         ((nr)   << __IOC_NRSHIFT) |    \
         ((size) << __IOC_SIZESHIFT))
 
struct xwds_device;
 
struct xwds_virtual_operation {
        xwer_t (* probe)(struct xwds_device *); 
        xwer_t (* remove)(struct xwds_device *); 
        xwer_t (* start)(struct xwds_device *); 
        xwer_t (* stop)(struct xwds_device *); 
#if defined(XWCDCFG_ds_PM) && (1 == XWCDCFG_ds_PM)
        xwer_t (* suspend)(struct xwds_device *); 
        xwer_t (* resume)(struct xwds_device *); 
#endif
};
 
struct xwds_driver {
        /* public */
        const char * name;
        xwer_t (* probe)(struct xwds_device *); 
        xwer_t (* remove)(struct xwds_device *); 
        xwer_t (* start)(struct xwds_device *); 
        xwer_t (* stop)(struct xwds_device *); 
        xwer_t (* suspend)(struct xwds_device *); 
        xwer_t (* resume)(struct xwds_device *); 
};
 
struct xwds_device {
        struct xwds_object obj; 
        /* attribute */
        const char * name; 
        xwid_t id; 
        const struct xwds_resources * resources; 
        const struct xwds_driver * drv; 
        void * data; 
        /* private */
        struct xwds * ds; 
        const struct xwds_virtual_operation * vop; 
};
 
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);
 
#if defined(XWCDCFG_ds_PM) && (1 == XWCDCFG_ds_PM)
xwer_t xwds_device_vop_suspend(struct xwds_device * dev);
xwer_t xwds_device_vop_resume(struct xwds_device * dev);
#endif
 
void xwds_device_construct(struct xwds_device * dev);
 
void xwds_device_destruct(struct xwds_device * dev);
 
xwer_t xwds_device_probe(struct xwds * ds, struct xwds_device * dev,
                         xwobj_gc_f gcfunc);
 
xwer_t xwds_device_remove(struct xwds_device * dev);
 
xwer_t xwds_device_start(struct xwds_device * dev);
 
xwer_t xwds_device_stop(struct xwds_device * dev);
 
#if defined(XWCDCFG_ds_PM) && (1 == XWCDCFG_ds_PM)
xwer_t xwds_device_suspend(struct xwds_device * dev);
 
xwer_t xwds_device_resume(struct xwds_device * dev);
 
xwer_t xwds_device_suspend_all(struct xwds * ds, bool ign_err);
 
xwer_t xwds_device_resume_all(struct xwds * ds, bool ign_err);
#endif
 
static __xwds_inline_api
xwsq_t xwds_device_get_tik(struct xwds_device * dev)
{
        return xwds_obj_get_tik(&dev->obj);
}
 
#if defined(XWCDCFG_ds_LITE) && (1 == XWCDCFG_ds_LITE)
 
static __xwds_inline_api
xwer_t xwds_device_grab(struct xwds_device * dev)
{
        XWOS_UNUSED(dev);
        return XWOK;
}
 
static __xwds_inline_api
xwer_t xwds_device_put(struct xwds_device * dev)
{
        XWOS_UNUSED(dev);
        return XWOK;
}
 
static __xwds_inline_api
xwsq_t xwds_device_get_refcnt(struct xwds_device * dev)
{
        return xwds_obj_get_refcnt(&dev->obj);
}
 
#else
 
static __xwds_inline_api
xwer_t xwds_device_grab(struct xwds_device * dev)
{
        return xwds_obj_grab(&dev->obj);
}
 
static __xwds_inline_api
xwer_t xwds_device_put(struct xwds_device * dev)
{
        return xwds_obj_put(&dev->obj);
}
 
static __xwds_inline_api
xwsq_t xwds_device_get_refcnt(struct xwds_device * dev)
{
        return xwds_obj_get_refcnt(&dev->obj);
}
#endif
 
#endif /* xwcd/ds/device.h */