UART

Overview

Defines standard APIs of universal asynchronous receiver/transmitter (UART) capabilities.

You can use this module to access the UART and enable the driver to operate a UART-compliant device. The functions in this module help you to obtain and release the UART device handle, read and write data, obtain and set the baud rate and device attributes.

Since:

1.0

Summary

Files

Data Structures

Enumerations

Functions

Details

Enumeration Type Documentation

UartTransMode

enum [UartTransMode](UART.md#gab9e041a0802a7e24da22215b458bf7db)

Description:

Enumerates UART transmission modes.

Attention:

The UART controller determines whether an enumerated transmission mode is supported.

Function Documentation

UartClose()

void UartClose (struct [DevHandle](DevHandle.md) * handle)

Description:

Releases the UART device handle.

If you no longer need to access the UART device, you should call this function to close its handle so as to release unused memory resources.

Parameters:

UartGetAttribute()

int32_t UartGetAttribute (struct [DevHandle](DevHandle.md) * handle, struct [UartAttribute](UartAttribute.md) * attribute )

Description:

Obtains the UART attribute.

UART attributes include data bits, stop bits, parity bit, CTS, RTS, and receiving and transmitting FIFO.

Parameters:

Returns:

Returns 0 if the UART attribute is obtained; returns a negative number otherwise.

UartGetBaud()

int32_t UartGetBaud (struct [DevHandle](DevHandle.md) * handle, uint32_t * baudRate )

Description:

Obtains the baud rate of the UART device.

Parameters:

Returns:

Returns 0 if the baud rate is obtained; returns a negative number otherwise.

UartOpen()

struct [DevHandle](DevHandle.md)* UartOpen (uint32_t port)

Description:

Obtains the UART device handle.

Before accessing the UART device, you must call this function to obtain the UART device handle.

Parameters:

Returns:

Returns the pointer to the UART device handle if the handle is obtained; returns NULL otherwise.

UartRead()

int32_t UartRead (struct [DevHandle](DevHandle.md) * handle, uint8_t * data, uint32_t size )

Description:

Reads data of a specified size from a UART device.

Parameters:

Returns:

Returns the size of the data that is successfully read; returns a negative number if the reading fails.

UartSetAttribute()

int32_t UartSetAttribute (struct [DevHandle](DevHandle.md) * handle, struct [UartAttribute](UartAttribute.md) * attribute )

Description:

Sets the UART attribute.

UART attributes include data bits, stop bits, parity bit, CTS, RTS, and receiving and transmitting FIFO.

Parameters:

Returns:

Returns 0 if the setting is successful; returns a negative number otherwise.

UartSetBaud()

int32_t UartSetBaud (struct [DevHandle](DevHandle.md) * handle, uint32_t baudRate )

Description:

Sets the baud rate for the UART device.

Parameters:

Returns:

Returns 0 if the setting is successful; returns a negative number otherwise.

UartSetTransMode()

int32_t UartSetTransMode (struct [DevHandle](DevHandle.md) * handle, enum [UartTransMode](UART.md#gab9e041a0802a7e24da22215b458bf7db) mode )

Description:

Sets the UART transmission mode.

Parameters:

Returns:

Returns 0 if the setting is successful; returns a negative number otherwise.

UartWrite()

int32_t UartWrite (struct [DevHandle](DevHandle.md) * handle, uint8_t * data, uint32_t size )

Description:

Writes data of a specified size into a UART device.

Parameters:

Returns:

Returns 0 if the data is successfully written; returns a negative number otherwise.