NetBurner 3.5.7
PDF Version
serial.h
1/*NB_REVISION*/
2
3/*NB_COPYRIGHT*/
4
112#ifndef _NB_SERIAL_H
113#define _NB_SERIAL_H
114
115#include <basictypes.h>
116
121#define SERIAL_ERR_NOSUCH_PORT (-1)
122#define SERIAL_ERR_PORT_NOTOPEN (-2)
123#define SERIAL_ERR_PORT_ALREADYOPEN (-3)
124#define SERIAL_ERR_PARAM_ERROR (-4)
128#define ADDR_ESCAPE_CHAR (0xFF)
129
135#define UART_ERR_BREAK (0x08)
136#define UART_ERR_FRAME (0x04)
137#define UART_ERR_PARITY (0x02)
138#define UART_ERR_OVERRUN (0x01)
159
216int OpenSerial(int portnum, unsigned int baudrate, int stop_bits, int data_bits, parity_mode parity);
217
229#define SimpleOpenSerial(p, b) OpenSerial(p, b, 1, 8, eParityNone)
230
245
256void SerialExpandRxBuffer(int fd, int nb);
257
268int SerialClose(int portnum);
269
281void SerialEnableTxFlow(int port, int enab);
282
293void SerialEnableRxFlow(int port, int enab);
294
315void SerialEnableHwTxFlow(int port, int enab);
316
333void SerialEnableHwRxFlow(int port, int enab);
334
350void Serial485HalfDupMode(int port, int enab);
351
368void SendBreak(int port, uint32_t time);
369
385int serwriteaddress(int fd, const char c);
386
435int GetUartErrorReg(int fd);
436
445void SetRTS(int port, bool val);
446
447#if (defined CB34EX || defined SB700EX || defined SB72EX || defined SB800EX)
459BOOL GetCD(int port);
460
472BOOL GetRI(int port);
473
485BOOL GetDSR(int port);
486
495void SetDTR(int port, BOOL val);
496#endif /* CB34EX/SB700EX/SB72EX/SB800EX */
497
509
510#if (defined SAME70) || (defined __MIMXRT10xx__) || (defined __MIMXRT11xx__)
511
526typedef void (*serRxIdleCallback_t)(int portnum);
527
536typedef void (*serTxCompCallback_t)(int portnum, uint32_t bytesSinceLast);
537
574
617
618 // end of serialIsrCallbacks
619
620#endif
621
622#endif /* _NB_SERIAL_H */
623
int OpenDefaultSerial()
Opens the Default serial port as defined by the Boot Config settings.
int GetUartErrorReg(int fd)
Get and clear the accumulated UART error register.
void SerialExpandRxBuffer(int fd, int nb)
Expand the received serial buffer.
int OpenSerial(int portnum, unsigned int baudrate, int stop_bits, int data_bits, parity_mode parity)
Open a serial port.
void SetRTS(int port, bool val)
Set or clear the Request To Send (RTS) signal.
parity_mode
Serial port parity modes.
Definition serial.h:151
void SerialEnableTxFlow(int port, int enab)
Enable transmit software flow control on the specified UART.
int serwriteaddress(int fd, const char c)
Send an address character in multidrop mode.
void SerialEnableRxFlow(int port, int enab)
Enable receive software flow control on the specified UART.
void Serial485HalfDupMode(int port, int enab)
Enable or disable RS-485 half-duplex mode.
void SerialEnableHwTxFlow(int port, int enab)
Enable clear-to-send hardware flow control on transmit (TxCTS).
BOOL SerialSendComplete(int fd)
Check whether serial transmission is complete.
void SerialEnableHwRxFlow(int port, int enab)
Enable request-to-send hardware flow control on receive (RxRTS).
void SendBreak(int port, uint32_t time)
Send a break condition on the specified UART.
int SerialClose(int portnum)
Close a serial port.
@ eParityMultiEven
Multi-drop mode with even parity.
Definition serial.h:157
@ eParityNone
No parity checking (default)
Definition serial.h:152
@ eParityMulti
Multi-drop mode: 9th bit used for address/data framing.
Definition serial.h:155
@ eParityMultiOdd
Multi-drop mode with odd parity.
Definition serial.h:156
@ eParityEven
Even parity: parity bit set so total number of 1-bits is even.
Definition serial.h:154
@ eParityOdd
Odd parity: parity bit set so total number of 1-bits is odd.
Definition serial.h:153
serRxIdleCallback_t RegisterSerIdleCallback(int fd, int num_bits, serRxIdleCallback_t pFunc)
Register a receive-idle callback.
serTxCompCallback_t RegisterTxEmptyCallback(int fd, serTxCompCallback_t pFunc)
Register a transmit-complete callback.
void(* serRxIdleCallback_t)(int portnum)
Callback type for serial port receive-idle detection.
Definition serial.h:526
void(* serTxCompCallback_t)(int portnum, uint32_t bytesSinceLast)
Callback type for serial port transmit-complete notification.
Definition serial.h:536