mif.h

浏览该文件的文档.

 
#ifndef __xwmd_isc_xwssc_mif_h__
#define __xwmd_isc_xwssc_mif_h__
 
#include <xwos/standard.h>
 
#if (XWMDCFG_isc_xwssc_MEMBLK_SIZE & (XWMDCFG_isc_xwssc_MEMBLK_SIZE - 1))
#  error "XWMDCFG_isc_xwssc_MEMBLK_SIZE must be the power of 2!"
#endif
#if ((1 << XWMDCFG_isc_xwssc_MEMBLK_ODR) > 32768U)
#  error "power(2, XWMDCFG_isc_xwssc_MEMBLK_ODR) must be <= 32768!"
#endif
#if (XWMDCFG_isc_xwssc_PORT_NUM > 256)
#  error "XWSSC Only supports 256 ports (0 ~ 255)!"
#endif
#if (XWMDCFG_isc_xwssc_PRI_NUM > 64)
#  error "XWSSC Only supports 64 priorities!"
#endif
 
#define XWSSC_VERSION           ("1.0.0") 
#define XWSSC_VERSION_MAJOR     1U 
#define XWSSC_VERSION_MINOR     0U 
#define XWSSC_VERSION_REVISION  0U 
#define XWSSC_PRI_NUM (XWMDCFG_isc_xwssc_PRI_NUM) 
#define XWSSC_INVALID_PRI (0xFFU) 
#define XWSSC_MAX_PRI (XWSSC_PRI_NUM - 1U) 
#define XWSSC_PORT_NUM (XWMDCFG_isc_xwssc_PORT_NUM) 
#define XWSSC_RETRY_PERIOD (XWMDCFG_isc_xwssc_RETRY_PERIOD) 
#define XWSSC_RETRY_NUM (XWMDCFG_isc_xwssc_RETRY_NUM) 
#define XWSSC_MEMBLK_SIZE (XWMDCFG_isc_xwssc_MEMBLK_SIZE) 
#define XWSSC_MEMBLK_ODR (XWMDCFG_isc_xwssc_MEMBLK_ODR) 
#define XWSSC_MEMBLK_NUM (1U << XWSSC_MEMBLK_ODR) 
#define XWSSC_MEMPOOL_SIZE (XWSSC_MEMBLK_SIZE * XWSSC_MEMBLK_NUM) 
// cppcheck-suppress [misra-c2012-20.7]
#define XWSSC_DEF_MEMPOOL(name) __xwcc_alignl1cache xwu8_t name[XWSSC_MEMPOOL_SIZE]
 
struct xwssc;
struct xwssc_hwifal_operation;
struct xwssc_carrier;
 
typedef struct xwssc_carrier * xwssc_txh_t;
 
enum xwssc_carrier_state_em {
        XWSSC_CRS_IDLE = 0U,
        XWSSC_CRS_READY = 1U,
        XWSSC_CRS_INPROGRESS = 2U,
        XWSSC_CRS_ABORT = 3U,
        XWSSC_CRS_FINISH = 4U,
};
 
enum xwssc_msg_qos_em {
        XWSSC_MSG_QOS_0 = 0U, 
        XWSSC_MSG_QOS_1 = 1U, 
        XWSSC_MSG_QOS_2 = 2U, 
        XWSSC_MSG_QOS_3 = 3U, 
        XWSSC_MSG_QOS_NUM, 
        XWSSC_MSG_QOS_CHKSUM_MSK = (1U), 
        XWSSC_MSG_QOS_RELIABLE_MSK = (2U), 
        XWSSC_MSG_QOS_MSK = (XWSSC_MSG_QOS_CHKSUM_MSK |
                             XWSSC_MSG_QOS_RELIABLE_MSK), 
};
 
 
typedef void (* xwssc_ntf_f)(struct xwssc * /* xwssc */,
                             xwssc_txh_t /* txh */,
                             xwer_t /* rc */,
                             void * /* arg */);
 
xwer_t xwssc_start(struct xwssc * xwssc, const char * name,
                   const struct xwssc_hwifal_operation * hwifops, void * hwifcb,
                   xwu8_t * mem, xwsz_t memsize);
 
xwer_t xwssc_stop(struct xwssc * xwssc);
 
bool xwssc_tst_connected(struct xwssc * xwssc);
 
xwer_t xwssc_tx(struct xwssc * xwssc,
                const xwu8_t data[], xwsz_t * size,
                xwu8_t pri, xwu8_t port, xwu8_t qos,
                xwtm_t to);
 
xwer_t xwssc_eq(struct xwssc * xwssc,
                const xwu8_t data[], xwsz_t * size,
                xwu8_t pri, xwu8_t port, xwu8_t qos,
                xwssc_ntf_f ntfcb, void * cbarg,
                xwssc_txh_t * txhbuf);
 
xwer_t xwssc_abort(struct xwssc * xwssc, xwssc_txh_t txh);
 
xwsq_t xwssc_get_txstate(xwssc_txh_t txh);
 
xwer_t xwssc_rx(struct xwssc * xwssc, xwu8_t port,
                xwu8_t rxbuf[], xwsz_t * size, xwu8_t * qos,
                xwtm_t to);
 
xwer_t xwssc_try_rx(struct xwssc * xwssc, xwu8_t port,
                    xwu8_t rxbuf[], xwsz_t * size, xwu8_t * qos);
 
#endif /* xwmd/isc/xwssc/mif.h */