m2mb_uart.h File Reference

UART support. More...

Go to the source code of this file.

Data Structures
struct	M2MB_UART_CONFIG
	Structure to configure UART module. More...
#define	M2MB_CONSOLE_PORT   M2MB_UART_HS_PORT_E
enum	M2MB_UART_PORT_ID_E {   M2MB_UART_HS_PORT_E = 0,   M2MB_UART_DEBUG_PORT_E = 1,   M2MB_UART_MAX_PORTS_E }
	UART Port Identifier enumeration. More...
enum	M2MB_UART_PARITY_MODE_E {   M2MB_UART_NO_PARITY_E = 0,   M2MB_UART_ODD_PARITY_E = 1,   M2MB_UART_EVEN_PARITY_E = 2,   M2MB_UART_SPACE_PARITY_E = 3 }
	UART parity mode configuration enumeration. More...
enum	M2MB_UART_BITS_PER_CHAR_E {   M2MB_UART_5_BITS_PER_CHAR_E = 0,   M2MB_UART_6_BITS_PER_CHAR_E = 1,   M2MB_UART_7_BITS_PER_CHAR_E = 2,   M2MB_UART_8_BITS_PER_CHAR_E = 3 }
	UART bits per character configuration enumeration. More...
enum	M2MB_UART_NUM_STOP_BITS_E {   M2MB_UART_0_5_STOP_BITS_E = 0,   M2MB_UART_1_0_STOP_BITS_E = 1,   M2MB_UART_1_5_STOP_BITS_E = 2,   M2MB_UART_2_0_STOP_BITS_E = 3 }
	UART number of stop bits configuration enumeration. More...
typedef VOID *	M2MB_UART_HANDLE_T
	UART Handle pointer. More...
typedef VOID(*	M2MB_UART_CB_T) (UINT32 num_bytes, VOID *p_cb_data)
	UART call back prototype. More...
typedef struct M2MB_UART_CONFIG	M2MB_UART_CONFIG_T
	Structure to configure UART module. More...
M2MB_STATUS_T	m2mb_uart_open (M2MB_UART_HANDLE_T *p_handle, M2MB_UART_PORT_ID_E id, M2MB_UART_CONFIG_T *p_config)
	Opens the UART port. More...
M2MB_STATUS_T	m2mb_uart_close (M2MB_UART_HANDLE_T p_handle)
	Close UART port. More...
M2MB_STATUS_T	m2mb_uart_write (M2MB_UART_HANDLE_T p_handle, CHAR *p_buf, UINT32 bytes_to_tx, VOID *p_cb_data)
	Transmits data over UART port. More...
UINT8 *	m2mb_uart_read (HANDLE h, UINT32 *size, UINT32 timeout, UINT8 *buff, VOID *p_cb_data)
	Receives data from UART port. More...

Detailed Description

UART support.

we866e4/epl/inc/driver/m2m_uart.h

library for UART. The following functions are implemented: m2mb_uart_open m2mb_uart_close m2mb_uart_read m2mb_uart_write

Note

Dependencies:
"#include <m2mb_types.h>"
"#include <m2mb_status.h>"

Author

Sandeep Itha

Date

10/11/2017

Definition in file m2mb_uart.h.