Uart

This section introduces the Universal Asynchronous Receiver/Transmitter (UART) APIs including terms and acronyms, supported features, software architecture, details on how to use this driver, enums, structures and functions. More...

Overview

This section introduces the Universal Asynchronous Receiver/Transmitter (UART) APIs including terms and acronyms, supported features, software architecture, details on how to use this driver, enums, structures and functions.

Terms and Acronyms

Terms	Details
DMA	Direct Memory Access.
FIFO	First In, First Out.
PIO	Programming Input/Out Model.
UART	Universal Asynchronous Receiver/Transmitter.

Supported Features

See Supported Features for the details of Supported Features.

How to use this driver

• Device driver sample code is as follows:
  
  • sample code (this is the user application sample code on freeRTos):

    - Initialize UART
        - Call mtk_os_hal_uart_ctlr_init(UART_PORT port_num)
    
    - De-initialize UART
        - Call mtk_os_hal_uart_ctlr_deinit(UART_PORT port_num)
    
    - Set Baudarate
      - Call mtk_os_hal_uart_set_baudrate(UART_PORT port_num)
    
    - Set data format
      - Call mtk_os_hal_uart_set_format(UART_PORT port_num)
    
    - Set data format
      - Call mtk_os_hal_uart_set_format(UART_PORT port_num)
    
    - Get one byte of data blocking in PIO mode
      - Call mtk_os_hal_uart_get_char(UART_PORT port_num)
    
    - Get one byte of data directly in PIO mode
      - Call mtk_os_hal_uart_get_char_nowait(UART_PORT port_num)
    
    - Send one byte of data in PIO mode
      - Call mtk_os_hal_uart_put_char(UART_PORT port_num)
    
    - Set hardware flow control
      - Call mtk_os_hal_uart_set_hw_fc(UART_PORT port_num, u8 hw_fc)
    
    - Set software flow control
      - Call mtk_os_hal_uart_set_sw_fc(UART_PORT port_num,
        u8 xon1, u8 xoff1, u8 xon2, u8 xoff2, u8 escape_data)
    
    - Disable software flow control
      - Call mtk_os_hal_uart_disable_sw_fc(UART_PORT port_num)
    
    - Get and clear UART interrupt
      - Call mtk_os_hal_uart_clear_irq_status(UART_PORT port_num)
    
    - Set IRQ
      - Call mtk_os_hal_uart_set_irq(UART_PORT port_num, u8 irq_flag)
    
    - Send UART data in DMA mode
      - Call mtk_os_hal_uart_dma_send_data(UART_PORT port_num,
        u8 *data, u32 len, bool vff_mode, u32 timeout)
    
    - Get UART data in DMA mode
      - Call mtk_os_hal_uart_dma_get_data(UART_PORT port_num,
        u8 *data, u32 len, bool vff_mode, u32 timeout)

Modules
	Enum
	This section introduces the enumerations used by UART OS-HAL used.
	Function
	This section provides high level APIs to upper layer.