serinternal.h

/*NB_REVISION*/
 
/*NB_COPYRIGHT*/
 
#ifndef _NB_SER_INTERNAL
#define _NB_SER_INTERNAL
#include <buffers.h>
 
#define UART_INIT (0x0001) /* UART is initialized */
 
#define UART_TX_EMPTY (0x0002) /* UART Tx buffer is empty */
 
#define UART_SENT_STOP (0x0004) /* UART has sent XOFF */
 
#define UART_RX_STOP (0x0008) /* UART has received XOFF */
 
#define UART_FLOW_TX                          \
    (0x0010) /* UART must respond to received \
                flow control */
 
#define UART_FLOW_RX                         \
    (0x0020) /* UART is allowed to send flow \
                control */
 
#define UART_FLOW_NEED_TOSTOP (0x0040) /* UART needs to send XOFF */
 
#define UART_FLOW_NEED_TOSTART (0x0080) /* UART needs to send XON */
 
#define UART_RS485_TX_MODE                   \
    (0x0100) /* UART is in RS-485 HD/FD mode \
                (not used) */
 
#define UART_MULTI_MODE (0x0200) /* UART is in multi-drop mode */
 
#define UART_FLOW_TXRTSCTS                   \
    (0x0400) /* UART has TxCTS hardware flow \
                control enabled */
 
#define UART_FLOW_TX485FD                     \
    (0x0800) /* UART is in RS-485 full-duplex \
                mode */
 
#define UART_FLOW_TX485HD                     \
    (0x1000) /* UART is in RS-485 half-duplex \
                mode */
 
#define UART_FLOW_RXRTSCTS                   \
    (0x2000) /* UART has RxRTS hardware flow \
                control enabled */
 
#define UART_RS422_MODE (0x4000) /* UART is in RS-422 mode */
 
#define UART_TX_LAST_BIT                      \
    (0x8000) /* UART has transmitted the last \
                stop bit of the last byte */
 
#define XON (0x11)
#define XOFF (0x13)
 
#define UART_XOFF_LIMIT (100)
#define UART_XON_LIMIT (200)
 
typedef int(GetNextCharFunc)(int uartnum);
typedef void(PutNextCharFunc)(int uartnum, uint8_t c);
 
int BaseGetChar(int num);
void BasePutChar(int num, uint8_t c);
 
enum dataBits_t
{
    DATA_BITS_5 = 0,
    DATA_BITS_6 = 1,
    DATA_BITS_7 = 2,
    DATA_BITS_8 = 3,
    DATA_BITS_9 = 4,
    DATA_BITS_10 = 5,
    DATA_BITS_11 = 6,
    DATA_BITS_12 = 7,
};
 
constexpr inline uint8_t GetBitCount(dataBits_t bits)
{
    return bits + 5;
}
 
//#define SERIAL_USE_RING_BUFFER
#ifdef SERIAL_USE_RING_BUFFER
class serRingBuf
{
    uint8_t *buf;
    uint16_t siz;
    uint16_t used;
    uint16_t wr;
    uint16_t rd;
    static int idx;
 
    int put(uint8_t d) volatile;
    int get(uint8_t *d) volatile;
 
   public:
    void Init(uint8_t max_buffers, uint8_t fromisr = 1);
    void Reset(uint8_t max_buffers);
    int WriteData(uint8_t *d, int len) volatile;
    int ReadData(uint8_t *d, int len) volatile;
    uint8_t PeekData();
    bool Full();
    bool Empty();
 
    uint16_t SpaceAvail();
    inline void SetMaxChunkLen(uint32_t maxStorage) { return; }
    inline void SetStartOffset(uint32_t offset)     { return; }
    inline void SetMaxBuffers(uint8_t max_buffers)  { return; }
    inline uint32_t GetMaxBuffers()  { return 1; }
    inline uint32_t GetMaxChunkLen() { return siz; }
    inline uint32_t GetStartOffset() { return 0; }
    inline uint32_t GetMinimumFullSize(int maxSegments = -1) { return siz; }
};
 
typedef serRingBuf serialBuf_t;
#else
typedef fifo_buffer_storage serialBuf_t;
#endif
 
struct UartDataRec
{
    serialBuf_t m_FifoRead;
    serialBuf_t m_FifoWrite;
    GetNextCharFunc *m_pGetCharFunc;
    PutNextCharFunc *m_pPutCharFunc;
    int m_UartState;
    uint8_t m_Errors;
    dataBits_t m_dataBits : 3;
};
 
extern UartDataRec UartData[];
 
void WakeTx(int x);
 
#endif /* _NB_SER_INTERNAL */