nz_serUart.h

Go to the documentation of this file.

//  UART - documentation module

#ifndef NZ_SERUART_H
#define NZ_SERUART_H

#if defined(HAS_SERPORT_UART)

#include "nz_circularBuffer.h"


#if (CLOCK_FREQ==32000000ul)
#ifndef UART_BAUD_1K2
#define UART_BAUD_1K2   3332    //0.01% error
#endif
#ifndef UART_BAUD_2K4
#define UART_BAUD_2K4   1666    //0.01% error
#endif
#ifndef UART_BAUD_4K8
#define UART_BAUD_4K8   832
#endif
#ifndef UART_BAUD_9K6
#define UART_BAUD_9K6   416 //0.07% error
#endif
#ifndef UART_BAUD_19K2
#define UART_BAUD_19K2  207 //0.16% error
#endif
#ifndef UART_BAUD_38K4
#define UART_BAUD_38K4  103 //0.16% error
#endif
#ifndef UART_BAUD_56K
#define UART_BAUD_56K   70  //0.6% error
#endif
#ifndef UART_BAUD_115K
#define UART_BAUD_115K  34  //0.62% error
#endif
#ifndef UART_BAUD_250K
#define UART_BAUD_250K  15  //0% error
#endif

#else
#error "UART does not support this CLOCK_FREQ"
#endif


//Transmit and Receive buffer sizes
#if !defined(UART1_RXBUF_SIZE)
#define    UART1_RXBUF_SIZE  64
#endif
#if !defined(UART1_TXBUF_SIZE)
#define    UART1_TXBUF_SIZE  256
#endif
#if !defined(UART2_RXBUF_SIZE)
#define    UART2_RXBUF_SIZE  32
#endif
#if !defined(UART2_TXBUF_SIZE)
#define    UART2_TXBUF_SIZE  128
#endif
#if !defined(UART3_RXBUF_SIZE)
#define    UART3_RXBUF_SIZE  32
#endif
#if !defined(UART3_TXBUF_SIZE)
#define    UART3_TXBUF_SIZE  128
#endif


//UART_TXION_STATUS_xx defines, 0=OK, 1=Added to Buffer, 0x80-0x8F=Error, 0xFF=Status Not Available
#define UART_TXION_STATUS_OK            0    //Currently OK, have not finished adding whole message to buffer
#define UART_TXION_STATUS_ADDED_TO_BUF  1    //Successfully added whole message to the buffer (from start to stop)
#define UART_TXION_STATUS_ERROR         4    //No space in buffer to add message
#define UART_TXION_STATUS_ERR_NOSPACE   5    //No space in buffer to add message
#define UART_TXION_STATUS_ERR_ADR_NOACK 6    //Slave did not ACK address we sent
#define UART_TXION_STATUS_ERR_DAT_NOACK 7    //Slave did not ACK data we sent
#define UART_TXION_STATUS_ERR_BUF_FRMT  8    //Buffer format error
#define UART_TXION_STATUS_ERR_TIMEOUT   9    //Timeout
#define UART_TXION_STATUS_NOT_AVAILABLE 0xFF //Status not available

//UART "Serial Data Port"
#if (defined(HAS_SERPORT_UART1) || defined(HAS_SERPORT_UART2) || defined(HAS_SERPORT_UART3) || defined(HAS_SERPORT_UART4))
    #if !defined(HAS_A_SERPORT)
    #define HAS_A_SERPORT
    #endif
#endif



//If "Power of 2" buffer used, size must by a power of 2
#if defined(CIRBUF_USE_CIRCULAR_BUFFER_PWR2)
#if defined(HAS_SERPORT_UART1)
    //Ensure size is power of 2
    #if ((UART1_TXBUF_SIZE & ~(UART1_TXBUF_SIZE-1))!=UART1_TXBUF_SIZE)
    #error "UART1 UART1_TXBUF_SIZE is not power of 2! Either change size defined in projdefs.h --OR-- use nz_circularBufferStd.c in stead of nz_circularBufferPwr2.c for project!"
    #endif

    //Ensure size is power of 2
    #if ((UART1_RXBUF_SIZE & ~(UART1_RXBUF_SIZE-1))!=UART1_RXBUF_SIZE)
    #error "UART1 UART1_RXBUF_SIZE is not power of 2! Either change size defined in projdefs.h --OR-- use nz_circularBufferStd.c in stead of nz_circularBufferPwr2.c for project!"
    #endif
#endif
#if defined(HAS_SERPORT_UART2)
    //Ensure size is power of 2
    #if ((UART2_TXBUF_SIZE & ~(UART2_TXBUF_SIZE-1))!=UART2_TXBUF_SIZE)
    #error "UART2 UART2_TXBUF_SIZE is not power of 2! Either change size defined in projdefs.h --OR-- use nz_circularBufferStd.c in stead of nz_circularBufferPwr2.c for project!"
    #endif

    //Ensure size is power of 2
    #if ((UART2_RXBUF_SIZE & ~(UART2_RXBUF_SIZE-1))!=UART2_RXBUF_SIZE)
    #error "UART2 UART2_RXBUF_SIZE is not power of 2! Either change size defined in projdefs.h --OR-- use nz_circularBufferStd.c in stead of nz_circularBufferPwr2.c for project!"
    #endif
#endif
#if defined(HAS_SERPORT_UART3)
    //Ensure size is power of 2
    #if ((UART3_TXBUF_SIZE & ~(UART3_TXBUF_SIZE-1))!=UART3_TXBUF_SIZE)
    #error "UART3 UART3_TXBUF_SIZE is not power of 2! Either change size defined in projdefs.h --OR-- use nz_circularBufferStd.c in stead of nz_circularBufferPwr2.c for project!"
    #endif

    //Ensure size is power of 2
    #if ((UART3_RXBUF_SIZE & ~(UART3_RXBUF_SIZE-1))!=UART3_RXBUF_SIZE)
    #error "UART3 UART3_RXBUF_SIZE is not power of 2! Either change size defined in projdefs.h --OR-- use nz_circularBufferStd.c in stead of nz_circularBufferPwr2.c for project!"
    #endif
#endif
#if defined(HAS_SERPORT_UART4)
    //Ensure size is power of 2
    #if ((UART4_TXBUF_SIZE & ~(UART4_TXBUF_SIZE-1))!=UART4_TXBUF_SIZE)
    #error "UART4 UART4_TXBUF_SIZE is not power of 2! Either change size defined in projdefs.h --OR-- use nz_circularBufferStd.c in stead of nz_circularBufferPwr2.c for project!"
    #endif

    //Ensure size is power of 2
    #if ((UART4_RXBUF_SIZE & ~(UART4_RXBUF_SIZE-1))!=UART4_RXBUF_SIZE)
    #error "UART4 UART4_RXBUF_SIZE is not power of 2! Either change size defined in projdefs.h --OR-- use nz_circularBufferStd.c in stead of nz_circularBufferPwr2.c for project!"
    #endif
#endif
#endif



typedef struct __attribute__((aligned(2), packed))
{
    union {
        struct
        {
            unsigned int bFill : 16;        //Fill to ensure flags take up a 16-bit WORD
        } flags;
        WORD flagsVal;
    };

    // Not all values for UART1CON are possible, only following can be set:
    WORD    config1;

    //???=9.6kbits/sec
    WORD    baud;

} SERPORT_UART_CONFIG;

//DON'T change! Code that checks wrDstType.bit0 and wrDstType.bit1 assumes there values!
#define RD_DEST_TYPE_LISTENERS 0
#define RD_DEST_TYPE_POINTER   2
#define RD_DEST_TYPE_CIRBUF    3

typedef struct __attribute__((__packed__)) UART_ISR_SMFLAGS_
{
    union {
        struct
        {
            unsigned int sm : 4;                
            unsigned int isrTxionStatus : 1;
            unsigned int fill12 : 11;
        } bits;
        WORD val;                           
    };
} UART_ISR_SMFLAGS;

//Must be a power of two value: 4,8,16,32,64
#define UART_STATUS_BUF_SIZE 8

typedef struct UART_INFO_
//typedef struct __attribute__((__packed__)) UART_INFO_
//typedef struct __attribute__((aligned(2), packed)) UART_INFO_
{
    //Buffer containing status. Two bytes are used for each entry, the LSB=Address (0=empty), and MSB=Status.
    BYTE            bufStat[UART_STATUS_BUF_SIZE];
    BYTE            adr;        //Used by non-ISR functions to remember current slave address
    BYTE            taskSm;     //ISR State machine. 0 is idle.
    BYTE            isrAdr;     //Used in ISR - address of slave
    BYTE            isrRead;    //Used in ISR - number of bytes to to read
    BYTE            type;       //Protocol Type - 0=standard streaming serial port, 1=RS485
    
    WORD            isrRdDest;  //Destination for read, meaning depends on value of uart1.isr.bits.wrDstType
                                // - When 0, bits 0-15 indicates which "Circular Buffer" listeners are destinations (0=default)
                                // - When 1, contains pointer to destination BYTE array
    WORD            timeout;    //Used in task to check for a timeout
    CIRBUF*         pCbufTx;
    CIRBUF*         pCbufRx;
    UART_ISR_SMFLAGS isr;        //ISR State machine AND flags.
    union {
        struct
        {
            BYTE ch;
            BYTE currTxionStatus;
        } flags;
        WORD flagsVal;
    };
} UART_INFO;



//UART Functions for all ports

void serUartInit(void);

void serUartTask(UART_INFO* objUART);


BYTE serUartRegisterListener(CIRBUF* pBuf);


UART_INFO* uartGetInfoForBus(BYTE uartBus);


BYTE serUartIsBusy(UART_INFO* objUART);

BYTE serUartWrite(UART_INFO* objUART, BYTE b);


BYTE serUartWriteArray(UART_INFO* objUART, BYTE* arr, BYTE size);


BYTE serUartWriteString(UART_INFO* objUART, const char* str);


//BYTE serUartRead(UART_INFO* objUART, BYTE size);


//BYTE serUartReadToArray(UART_INFO* objUART, BYTE* buf, BYTE size);


//UART 1
#if defined(HAS_SERPORT_UART1)

#if !defined(SERPORT_UART1_CREATE_OWN_CIRBUFS)
#include "nz_serDataPorts.h"
#endif

//This is used by others
#ifndef THIS_IS_NZ_SERUART1_C
extern UART_INFO uart1Info;
#endif
#define UART1_INFO &uart1Info

//TX and RX "Circular Buffers". Use SERPORT_UART1_CREATE_OWN_CIRBUFS define to use this
//module without SERPORTs. If NOT defined, this modules requires nz_serDataPorts.c
#if defined(SERPORT_UART1_CREATE_OWN_CIRBUFS)
    //This is used by others
    #ifndef THIS_IS_NZ_SERUART1_C
    extern CIRBUF cbufTxUART1;
    extern CIRBUF cbufRxUART1;
    #endif

    #define CIRBUF_TX_UART1 &cbufTxUART1
    #define CIRBUF_RX_UART1 &cbufRxUART1
#endif


void serUart1Init(void);


void serUart1Task(void);


BYTE serUart1IsBusy(void);



BYTE serUart1Write(BYTE b);


BYTE serUart1WriteArray(BYTE* arr, BYTE size);


BYTE serUart1WriteString(const char* str);


#define serUart1GetTxBufFree()  cbufGetFree(CIRBUF_TX_UART1)


#define serUart1EmptyTxBuf() cbufEmpty(CIRBUF_TX_UART1)


#define serUart1IsTxBufEmpty()  cbufIsEmpty(CIRBUF_TX_UART1)


#define serUart1IsTxBufFull()   cbufIsFull(CIRBUF_TX_UART1)


#define serUart1GetRxBufCount() cbufGetCount(CIRBUF_RX_UART1)


#define serUart1HasData() cbufHasData(CIRBUF_RX_UART1)


#define serUart1IsRxBufEmpty()  cbufIsEmpty(CIRBUF_RX_UART1)


#define serUart1Read() cbufGetByte(CIRBUF_RX_UART1)
#define serUart1GetByte() cbufGetByte(CIRBUF_RX_UART1)


#define serUart1ReadArray(pDstArr, size) cbufGetArray(CIRBUF_RX_UART1, pDstArr, size)
#define serUart1GetArray(pDstArr, size) cbufGetArray(CIRBUF_RX_UART1, pDstArr, size)

#endif  //#if defined(HAS_SERPORT_UART1)

#endif  //#if defined(HAS_SERPORT_UART)
#endif  //#ifndef NZ_SERUART_H