transceiver.h

浏览该文件的文档.

 
#ifndef __xwcd_ds_can_transceiver_h__
#define __xwcd_ds_can_transceiver_h__
 
#include <xwcd/ds/standard.h>
#include <xwos/lib/xwbop.h>
#include <xwcd/ds/device.h>
#include <xwcd/ds/can/controller.h>
#include <xwcd/ds/i2c/peripheral.h>
#include <xwcd/ds/spi/peripheral.h>
 
enum xwds_cantrcv_opmode_em {
        XWDS_CANTRCV_OPMODE_NORMAL = 0, 
        XWDS_CANTRCV_OPMODE_SLEEP, 
        XWDS_CANTRCV_OPMODE_STANDBY, 
        XWDS_CANTRCV_OPMODE_NUM, 
};
 
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, 
};
 
struct xwds_cantrcv;
 
typedef void (*xwds_cantrcv_wkup_isr_f)(struct xwds_cantrcv *, struct xwds_canc *);
 
struct xwds_cantrcv_cfg {
        xwsq_t init_opmode; 
        bool wkup_supported; 
        void * chipcfg; 
};
 
struct xwds_cantrcv;
 
struct xwds_cantrcv_driver {
        struct xwds_driver base; 
        xwer_t (* set_opmode)(struct xwds_cantrcv *, xwsq_t); 
        xwer_t (* enable_wkup)(struct xwds_cantrcv *); 
        xwer_t (* disable_wkup)(struct xwds_cantrcv *); 
};
 
struct xwds_cantrcv {
        union {
                struct xwds_device dev; 
#if (defined(XWCDCFG_ds_I2C_PERIPHERAL) && (1 == XWCDCFG_ds_I2C_PERIPHERAL))
                struct xwds_i2cp i2cp; 
#endif
#if (defined(XWCDCFG_ds_SPI_PERIPHERAL) && (1 == XWCDCFG_ds_SPI_PERIPHERAL))
                struct xwds_spip spip; 
#endif
        } bc; 
        /* attributes */
        struct xwds_canc * canc; 
        const struct xwds_cantrcv_cfg * cfg; 
        xwds_cantrcv_wkup_isr_f wkup_isr; 
        /* private */
        xwsq_t opmode; 
        xwsq_t wkuprs; 
};
 
void xwds_cantrcv_construct(struct xwds_cantrcv * cantrcv);
 
void xwds_cantrcv_destruct(struct xwds_cantrcv * cantrcv);
 
xwer_t xwds_cantrcv_grab(struct xwds_cantrcv * cantrcv);
 
xwer_t xwds_cantrcv_put(struct xwds_cantrcv * cantrcv);
 
xwer_t xwds_cantrcv_set_opmode(struct xwds_cantrcv * cantrcv, xwsq_t opmode);
 
void xwds_cantrcv_get_opmode(struct xwds_cantrcv * cantrcv, xwsq_t * opmode);
 
xwer_t xwds_cantrcv_enable_wkup(struct xwds_cantrcv * cantrcv);
 
xwer_t xwds_cantrcv_disable_wkup(struct xwds_cantrcv * cantrcv);
 
void xwds_cantrcv_set_wkup_isr(struct xwds_cantrcv * cantrcv,
                               xwds_cantrcv_wkup_isr_f isr);
 
void xwds_cantrcv_get_wkuprs(struct xwds_cantrcv * cantrcv, xwsq_t * wkuprs);
 
void xwds_cantrcv_clear_wkuprs(struct xwds_cantrcv * cantrcv);
 
/******** ******** Callbacks for Driver ******** ********/
void xwds_cantrcv_drvcb_wakeup_notification(struct xwds_cantrcv * cantrcv);
 
#endif /* xwcd/ds/can/transceiver.h */