IPC@CHIP® RTOS-LNX – API Documentation

Header image

Main page


Functions
Fossil API for Serial Ports

Detailed Description

Here is the API definition for access to the serial ports.

Functions

int fossil_initmode (int port, BOOL dcd, BOOL txDMA, BOOL rxDMA)
 Initialize the serial fossil driver for specified port. More...
 
void fossil_deinit (int port)
 Deinitialize the serial fossil driver for specified port. More...
 
int fossil_setbaud (int port, long baudrate, FOSSIL_PARITY parity, int wordlen, int stopbits)
 Set baud rate and port configuration for specified port. More...
 
int fossil_setbaud_std (int port, unsigned char config)
 Set a standard baud rate and port configuration. More...
 
void fossil_set_flowcontrol (int port, FOS_FLOW_CTRL flowctrl)
 Enable/Disable flow control for specified port. More...
 
void fossil_force_rts (int port, FOS_RTS_MODE mode)
 Force RTS# to low, high or reset to normal activity. More...
 
BYTE fossil_read_cts (int port)
 Read level on CTS# pin. More...
 
int fossil_status_request (int port)
 Get the serial port status. More...
 
void fossil_set_rs485 (int port, RS485_MODE mode)
 Enable/Disable the RS485 mode. More...
 
void fossil_set_rs485_txenable (int port, int pin)
 Select RS485 pin. More...
 
int fossil_putbyte_wait (int port, int ch)
 Put byte in output buffer, wait if needed. More...
 
int fossil_putbyte (int port, int ch)
 Put byte in output buffer, without wait. More...
 
unsigned int fossil_writeblock (int port, const BYTE *buffer, unsigned int count)
 Write a block of data to output buffer, without wait. More...
 
void fossil_writeblock_wait (int port, const BYTE *buffer, unsigned int count)
 Write a block of data to output buffer, wait if needed. More...
 
int fossil_output_done (int port)
 Check if output buffer and transmitter are empty. More...
 
void fossil_flush_output (int port)
 Flush output buffer, await empty transmit buffer. More...
 
void fossil_purge_output (int port)
 Purge output buffer and discard the data. More...
 
void fossil_send_break (int port, FOS_BREAK_SIZE break_size)
 Send break signal. More...
 
int fossil_data_avail (int port)
 Check if serial data bytes are available. More...
 
int fossil_count_bytes_waiting (int port)
 Check how much serial data bytes are available. More...
 
int fossil_getbyte_wait (int port)
 Get byte from serial input buffer, wait if needed. More...
 
int fossil_getbyte (int port)
 Get byte from serial input buffer, do not wait. More...
 
int fossil_peek_input (int port)
 Peek if next byte is available. More...
 
unsigned int fossil_readblock (int port, BYTE *buffer, unsigned int count)
 Read block of data from serial input buffer, do not wait. More...
 
void fossil_readblock_wait (int port, BYTE *buffer, unsigned int count)
 Read block of data from serial input buffer, wait if needed. More...
 
void fossil_purge_input (int port)
 Purge input buffer and discard the data. More...
 
int fossil_get_fd (int port)
 Gets the file descriptor of specific port. More...
 
int fossil_get_device (int port, char *devName, int devNameLen)
 Gets the device file name of specific port. More...
 





Top of page | Main page

Copyright © 2018 Beck IPC GmbH
Generated on Fri Jun 8 2018 12:48:20 by Doxygen 1.8.13