controller.h

浏览该文件的文档.

 
#ifndef __xwcd_ds_uart_controller_h__
#define __xwcd_ds_uart_controller_h__
 
#include <xwcd/ds/standard.h>
#include <xwos/lib/xwbop.h>
#include <xwos/osal/lock/spinlock.h>
#include <xwos/osal/sync/sem.h>
#include <xwos/osal/lock/mtx.h>
#include <xwcd/ds/device.h>
#include <xwcd/ds/soc/dma.h>
 
enum xwds_uart_bits_em {
        XWDS_UART_BITS_5 = 0U,
        XWDS_UART_BITS_6,
        XWDS_UART_BITS_7,
        XWDS_UART_BITS_8,
        XWDS_UART_BITS_9,
};
 
enum xwds_uart_stopbits_em {
        XWDS_UART_STOPBITS_0_5 = 0U,
        XWDS_UART_STOPBITS_1_0,
        XWDS_UART_STOPBITS_1_5,
        XWDS_UART_STOPBITS_2_0,
};
 
enum xwds_uart_parity_em {
        XWDS_UART_PARITY_NONE = 0U,
        XWDS_UART_PARITY_EVEN,
        XWDS_UART_PARITY_ODD,
};
 
enum xwds_uart_hardwareflowcontrol_em {
        XWDS_UART_HFC_NONE = 0U,
        XWDS_UART_HFC_RTS = XWBOP_BIT(0),
        XWDS_UART_HFC_CTS = XWBOP_BIT(1),
};
 
enum xwds_uart_mode_em {
        XWDS_UART_MODE_CLOSE = 0U,
        XWDS_UART_MODE_TX = XWBOP_BIT(0),
        XWDS_UART_MODE_RX = XWBOP_BIT(1),
};
 
struct xwds_uart_cfg {
        xwu32_t baudrate; 
        struct {
                xwu8_t bits; 
                xwu8_t stopbits; 
                xwu8_t parity; 
                xwu8_t hfc; 
                xwu8_t mode; 
        } bus;
        void * soccfg; 
};
 
struct xwds_uartc;
 
typedef void (* xwds_uartc_eqcb_f)(struct xwds_uartc *, xwer_t);
 
struct xwds_uartc_driver {
        struct xwds_driver base; 
        xwer_t (* cfg)(struct xwds_uartc * /*uartc*/,
                       const struct xwds_uart_cfg * /*cfg*/); 
        xwer_t (* tx)(struct xwds_uartc * /*uartc*/,
                      const xwu8_t * /*data*/, xwsz_t * /*size*/,
                      xwtm_t /*to*/); 
        xwer_t (* etx)(struct xwds_uartc * /*uartc*/,
                       const xwu8_t * /*data*/, xwsz_t * /*size*/); 
        xwer_t (* eq)(struct xwds_uartc * /*uartc*/,
                      const xwu8_t * /*data*/, xwsz_t * /*size*/,
                      xwds_uartc_eqcb_f /*cb*/); 
        xwer_t (* putc)(struct xwds_uartc * /*uartc*/,
                        const xwu8_t /*byte*/); 
};
 
struct xwds_uartc {
        struct xwds_device dev; 
        /* attributes */
        const struct xwds_uart_cfg * cfg; 
        const struct xwds_resource_dma * rxdmarsc; 
        const struct xwds_resource_dma * txdmarsc; 
        /* TX */
        struct xwos_mtx txmtx; 
        /* RX */
        struct {
                struct xwos_sem sem; 
                struct xwos_splk lock; 
                xwsq_t pos; 
                xwsz_t tail; 
                xwsq_t idx; 
                xwu8_t * q; 
                xwsz_t qsize; 
        } rxq; 
};
 
/******** ******** APIs ******** ********/
void xwds_uartc_construct(struct xwds_uartc * uartc);
void xwds_uartc_destruct(struct xwds_uartc * uartc);
xwer_t xwds_uartc_grab(struct xwds_uartc * uartc);
xwer_t xwds_uartc_put(struct xwds_uartc * uartc);
 
xwer_t xwds_uartc_rx(struct xwds_uartc * uartc,
                     xwu8_t * buf, xwsz_t * size,
                     xwtm_t to);
 
xwer_t xwds_uartc_try_rx(struct xwds_uartc * uartc,
                         xwu8_t * buf, xwsz_t * size);
 
xwer_t xwds_uartc_tx(struct xwds_uartc * uartc,
                     const xwu8_t * data, xwsz_t * size,
                     xwtm_t to);
 
xwer_t xwds_uartc_etx(struct xwds_uartc * uartc,
                      const xwu8_t * data, xwsz_t * size);
 
xwer_t xwds_uartc_eq(struct xwds_uartc * uartc,
                     const xwu8_t * data, xwsz_t * size,
                     xwds_uartc_eqcb_f cb);
 
xwer_t xwds_uartc_putc(struct xwds_uartc * uartc,
                       const xwu8_t byte,
                       xwtm_t to);
 
xwer_t xwds_uartc_cfg(struct xwds_uartc * uartc,
                      const struct xwds_uart_cfg * cfg);
 
static __xwcc_inline
bool xwds_uart_tst_baudrate(xwu32_t baudrate)
{
        return ((50U == baudrate) || (75U == baudrate) || (110U == baudrate) ||
                (134U == baudrate) || (150U == baudrate) || (200U == baudrate) ||
                (300U == baudrate) || (600U == baudrate) || (1200U == baudrate) ||
                (1800U == baudrate) || (2400U == baudrate) || (4800U == baudrate) ||
                (9600U == baudrate) || (19200U == baudrate) || (38400U == baudrate) ||
                (57600U == baudrate) || (115200U == baudrate) ||
                (230400U == baudrate) || (460800U == baudrate) ||
                (576000U == baudrate) || (921600U == baudrate) ||
                (1000000U == baudrate) || (1152000U == baudrate) ||
                (1500000U == baudrate) || (2000000U == baudrate) ||
                (2500000U == baudrate) || (3000000U == baudrate) ||
                (3500000U == baudrate) || (4000000U == baudrate));
}
 
/******** ******** Callbacks for driver ******** ********/
void xwds_uartc_drvcb_rxq_flush(struct xwds_uartc * uartc);
 
xwsq_t xwds_uartc_drvcb_rxq_fill(struct xwds_uartc * uartc,
                                 xwu8_t bytes[], xwsz_t size);
 
void xwds_uartc_drvcb_rxq_pub(struct xwds_uartc * uartc, xwsq_t tail);
 
#endif /* xwcd/ds/uart/controller.h */