protocol.h

浏览该文件的文档.

 
#ifndef __xwmd_isc_xwssc_protocol_h__
#define __xwmd_isc_xwssc_protocol_h__
 
#include <xwos/standard.h>
#include <xwos/lib/object.h>
#include <xwos/lib/xwbop.h>
#include <xwos/lib/xwaop.h>
#include <xwos/lib/bclst.h>
#include <xwos/lib/xwlog.h>
#include <xwos/mm/bma.h>
#include <xwos/osal/thd.h>
#include <xwos/osal/lock/spinlock.h>
#include <xwos/osal/lock/mtx.h>
#include <xwos/osal/sync/sem.h>
#include <xwos/osal/sync/cond.h>
#include <xwmd/isc/xwssc/hwifal.h>
#include <xwmd/isc/xwssc/mif.h>
 
#define XWSSC_SOF               ((xwu8_t)0xAA)
#define XWSSC_EOF               (XWSSC_SOF ^ (xwu8_t)0xFF)
#define XWSSC_SOF_SIZE          (2U)
#define XWSSC_EOF_SIZE          (2U)
 
#define XWSSC_FRMHEAD_SIZE(size)        ((size) & 0xFU)
#define XWSSC_FRMHEAD_SIZE_MIRROR(size) ((size) & 0xF0U)
#define XWSSC_FRMHEAD_MAXSIZE           (16U)
#define XWSSC_FRM_ONSTACK_MAXSIZE       (64U)
 
#define XWSSC_ID_MSK            (0xFFU)
#define XWSSC_ID(id)            ((xwu8_t)((xwu8_t)(id) & XWSSC_ID_MSK))
 
#define XWSSC_ECSIZE(head)      (XWSSC_FRMHEAD_SIZE((head)->headsize) - \
                                 sizeof(struct xwssc_frmhead))
#define XWSSC_SDUPOS(head)      (&((head)->ecsdusz[XWSSC_ECSIZE(head)]))
#define XWSSC_RXSDUSIZE(slot)   ((slot)->frmsize - \
                                 XWSSC_FRMHEAD_SIZE((slot)->frm.head.headsize) - \
                                 XWSSC_CRC32_SIZE - XWSSC_SOF_SIZE - XWSSC_EOF_SIZE)
#define XWSSC_CRC32_SIZE        (4U)
#define XWSSC_SDU_MAX_SIZE      (XWSSC_MEMPOOL_SIZE / 8)
 
#define XWSSC_TXTHD_STACK       (4096U)
#define XWSSC_RXTHD_STACK       (4096U)
 
#if defined(XWMDCFG_isc_xwssc_LOG) && (1 == XWMDCFG_isc_xwssc_LOG)
#  define xwssclogf(xwssc, lv, fmt, ...) xwlogf(lv, "%s", \
                                                fmt, xwssc->name, ##__VA_ARGS__)
#else
#  define xwssclogf(xwssc, lv, fmt, ...)
#endif
 
#define XWSSC_BUG()     XWOS_BUG()
#define XWSSC_BUG_ON(x) XWOS_BUG_ON(x)
 
#if defined(XWMDCFG_CHECK_PARAMETERS) && (1 == XWMDCFG_CHECK_PARAMETERS)
#define XWSSC_VALIDATE(exp, errstr, ...)        \
        if (!(exp)) {                           \
            return __VA_ARGS__;                 \
        }
#else
#  define XWSSC_VALIDATE(exp, errstr, ...)
#endif
 
#define XWSSC_VALIDATE_FORCE(exp, errstr, ...)  \
        if (!(exp)) {                           \
            return __VA_ARGS__;                 \
        }
 
enum xwssc_flag_em {
        XWSSC_FLAG_CONNECT = 0x10U, 
        XWSSC_FLAG_ACK = 0x80U, 
        XWSSC_FLAG_SDU = 0x00U, 
        XWSSC_FLAG_MSK = 0xF0U,
};
 
enum xwssc_frm_ack_em {
        XWSSC_ACK_OK = 0, 
        XWSSC_ACK_ECONNRESET, 
        XWSSC_ACK_EALREADY, 
        XWSSC_ACK_NOMEM, 
        XWSSC_ACK_NUM, 
};
 
struct __xwcc_packed xwssc_frmhead {
        xwu8_t headsize; 
        xwu8_t chksum; 
        xwu8_t port; 
        xwu8_t id; 
        xwu8_t qos; 
        xwu8_t ecsdusz[0]; 
};
 
struct __xwcc_packed xwssc_frm {
        xwu8_t sof[XWSSC_SOF_SIZE]; 
        struct xwssc_frmhead head; 
        /* xwu8_t sdu[x]; 数据 */
        /* xwu8_t sducrc32[4]; 数据的CRC32校验码 */
        /* xwu8_t eof[XWSSC_EOF_SIZE]; 帧尾定界符（EOF:End-of-Frame Delimiter） */
};
 
union xwssc_slot {
        struct {
                xwssc_ntf_f ntfcb; 
                void * cbarg; 
                xwsz_t frmsize; 
                struct xwssc_frm frm; 
        } tx; 
        struct {
                struct xwlib_bclst_node node; 
                xwsz_t frmsize; 
                struct xwssc_frm frm; 
        } rx; 
};
 
struct xwssc_carrier {
        struct xwlib_bclst_node node; 
        atomic_xwu32_t state; 
        xwu16_t idx; 
        xwu8_t pri; 
        union xwssc_slot * slot;
};
 
struct xwssc {
        /* 基本信息 */
        struct xwos_object xwobj; 
        const char * name;
        atomic_xwsq_t hwifst; 
        const struct xwssc_hwifal_operation * hwifops; 
        void * hwifcb; 
        /* 内存池 */
        XWMM_BMA_RAWOBJ_DEF(mempool_bma_raw, XWSSC_MEMBLK_ODR); 
        struct xwmm_bma * mempool; 
        /* 发送状态机 */
        __xwcc_alignl1cache xwu8_t txthd_stack[XWSSC_TXTHD_STACK]; 
        struct xwos_thd txthdobj; 
        xwos_thd_d txthd; 
        struct {
                atomic_xwu32_t cnt; 
                struct xwssc_carrier car[XWSSC_MEMBLK_NUM]; 
                xwbmpaop_define(carbmp, XWSSC_MEMBLK_NUM); 
                struct xwlib_bclst_head q[XWSSC_PRI_NUM]; 
                xwbmpop_define(qnebmp, XWSSC_PRI_NUM); 
                struct xwos_splk qlock; 
                struct xwos_sem qsem; 
                struct xwos_mtx csmtx; 
                struct xwos_cond cscond; 
                struct {
                        xwu8_t ack; 
                        xwu8_t id; 
                } remote; 
                struct xwssc_carrier * tmp; 
                struct xwos_splk notiflk; 
        } txq; 
        /* 接收状态机 */
        __xwcc_alignl1cache xwu8_t rxthd_stack[XWSSC_RXTHD_STACK]; 
        struct xwos_thd rxthdobj; 
        xwos_thd_d rxthd; 
        struct {
                atomic_xwu32_t cnt; 
                struct xwlib_bclst_head q[XWSSC_PORT_NUM]; 
                struct xwos_splk lock[XWSSC_PORT_NUM]; 
                struct xwos_sem sem[XWSSC_PORT_NUM]; 
        } rxq; 
};
 
xwer_t xwssc_grab(struct xwssc * xwssc);
xwer_t xwssc_put(struct xwssc * xwssc);
void xwssc_encode_sdusize(xwsz_t sdusize, xwu8_t * ecsdusz, xwu8_t * ecsize);
void xwssc_decode_sdusize(xwu8_t * ecsdusz, xwsz_t * sdusize);
xwu8_t xwssc_cal_head_chksum(xwu8_t data[], xwsz_t size);
bool xwssc_chk_head(xwu8_t data[], xwsz_t size);
union xwssc_slot * xwssc_rxq_choose(struct xwssc * xwssc, xwu8_t port);
xwer_t xwssc_rxthd(struct xwssc * xwssc);
struct xwssc_carrier * xwssc_txq_carrier_alloc(struct xwssc * xwssc);
void xwssc_txq_carrier_free(struct xwssc * xwssc, struct xwssc_carrier * car);
struct xwssc_carrier * xwssc_txq_choose(struct xwssc * xwssc);
xwer_t xwssc_eq_msg(struct xwssc * xwssc,
                    const xwu8_t sdu[], xwsz_t sdusize,
                    xwu8_t pri, xwu8_t port, xwu8_t qos,
                    xwssc_ntf_f ntfcb, void * cbarg,
                    xwssc_txh_t * txhbuf);
xwer_t xwssc_tx_ack_sdu(struct xwssc * xwssc, xwu8_t port, xwu8_t id, xwu8_t ack);
xwer_t xwssc_txthd(struct xwssc * xwssc);
 
#endif /* xwmd/isc/xwssc/protocol.h */