serial.h

Go to the documentation of this file.

/*NB_REVISION*/
 
/*NB_COPYRIGHT*/
 
#ifndef _NB_SERIAL_H
#define _NB_SERIAL_H
 
#include <basictypes.h>
 
#define SERIAL_ERR_NOSUCH_PORT (-1)        
#define SERIAL_ERR_PORT_NOTOPEN (-2)       
#define SERIAL_ERR_PORT_ALREADYOPEN (-3)   
#define SERIAL_ERR_PARAM_ERROR (-4)        
// Special UART characters
#define ADDR_ESCAPE_CHAR (0xFF)   
 
/*
 * Definitions used to represent bits of the UART error register.  These are
 * associated with the GetUartErrorReg() function, which is only applicable to
 * the MOD5270, SB70 and SB72.
 */
#define UART_ERR_BREAK (0x08)
#define UART_ERR_FRAME (0x04)
#define UART_ERR_PARITY (0x02)
#define UART_ERR_OVERRUN (0x01)
 
typedef enum
{
    eParityNone,       
    eParityOdd,        
    eParityEven,       
    eParityMulti,      
    eParityMultiOdd,   
    eParityMultiEven   
} parity_mode;
 
int OpenSerial(int portnum, unsigned int baudrate, int stop_bits, int data_bits, parity_mode parity);
 
#define SimpleOpenSerial(p, b) OpenSerial(p, b, 1, 8, eParityNone)
 
int OpenDefaultSerial();
 
void SerialExpandRxBuffer(int fd, int nb);
 
int SerialClose(int portnum);
 
void SerialEnableTxFlow(int port, int enab);
 
void SerialEnableRxFlow(int port, int enab);
 
void SerialEnableHwTxFlow(int port, int enab);
 
void SerialEnableHwRxFlow(int port, int enab);
 
void Serial485HalfDupMode(int port, int enab);
 
void SendBreak(int port, uint32_t time);
 
int serwriteaddress(int fd, const char c);
 
int GetUartErrorReg(int fd);
 
void SetRTS(int port, bool val);
 
#if (defined CB34EX || defined SB700EX || defined SB72EX || defined SB800EX)
BOOL GetCD(int port);
 
BOOL GetRI(int port);
 
BOOL GetDSR(int port);
 
void SetDTR(int port, BOOL val);
#endif /* CB34EX/SB700EX/SB72EX */
 
BOOL SerialSendComplete(int fd);
 
#if (defined SAME70) || (defined __MIMXRT10xx__) || (defined __MIMXRT11xx__)
 
typedef void (*serTxCompCallback_t)(int portnum, uint32_t bytesSinceLast);
serTxCompCallback_t RegisterTxEmptyCallback(int fd, serTxCompCallback_t pFunc);
 
#endif
 
#endif /* _NB_SERIAL_H */