AM64x MCU+ SDK  10.00.00
UART Migration Guide

This section describes the differences between UART APIs of MCU+ SDK and Processor SDK RTOS (PDK). This can be used as a migration aid when moving from Processor SDK RTOS (PDK) to MCU+ SDK.

In MCU+ SDK, the UART module provides higher level driver APIs.Refer UART for more details.

API changes

There are changes in functions names, structure names and macro names. The changes in function names are listed below.

PDK MCU+ SDK Change Description / Remarks
UART_init UART_init NO CHANGE
None UART_deinit In MCU+SDK, this API can be used to de-initialize the UART module.
UART_open UART_open NO CHANGE
UART_close UART_close NO CHANGE
UART_write UART_write NO CHANGE
UART_read UART_read NO CHANGE
UART_writeCancel UART_writeCancel NO CHANGE
UART_readCancel UART_readCancel NO CHANGE
None UART_getHandle In MCU+SDK, this API can be used to get the handle of an open UART instance from the instance index.
None UART_flushTxFifo In MCU+SDK, this API is used to flush a TX FIFO of peripheral specified by the UART handle
UART_Params_init UART_Params_init NO CHANGE
UART_transactionInit UART_Transaction_init API rename
UART_control None This is a dummy function in PDK also.
UART_writePolling UART_write Configuring field UART_Params::transferMode to Polled mode will do the equivalent of PDK UART API.
UART_readPolling UART_read Configuring field UART_Params::transferMode to Polled mode will do the equivalent of PDK UART API.
UART_read2 UART_read API rename
UART_write2 UART_write API rename

Important Notes

  • In MCU+ SDK, users are recommended to use SysConfig as this will greatly simplify the task of driver configuration.
  • In MCU+ SDK, UART_ReadReturnMode is introduced as compared to UART_ReturnMode in PDK.
  • In MCU+ SDK, UART_DataMode is not supported.

See Also