Spim

This section introduces the Serial Peripheral Interface Master (SPIM) APIs including terms and acronyms, supported features, details on how to use this driver, enums, structures and functions. More...

Overview

This section introduces the Serial Peripheral Interface Master (SPIM) APIs including terms and acronyms, supported features, 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.
SPI	Serial Peripheral Interface.

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):

    - init SPIM
     -Call mtk_os_hal_spim_ctlr_init(spim_num bus_num)
       to init spim bus.
    
    - Use FIFO or DMA mode to do one blocking/synchronous SPI data transfer
      -Call mtk_os_hal_spim_transfer(spim_num bus_num,
                struct mtk_spi_config *config,
                struct mtk_spi_transfer *xfer)
    
    - Use FIFO or DMA mode to do one asynchronous SPI transfer
      -Call mtk_os_hal_spim_async_transfer(spim_num bus_num,
                  struct mtk_spi_config *config,
                  struct mtk_spi_transfer *xfer,
                  spi_usr_complete_callback complete,
                  void *context)
    
    - uninit SPIM
     - Call  mtk_os_hal_spim_ctlr_deinit(spim_num bus_num) to uninit
        spim and release resource.

Modules
	Enum
	This section introduces the enumerations that SPIM uses while performing transfer.
	Function
	This section provides high level APIs to upper layer.
	Typedef
	This section introduces the typedef that SPIM OS-HAL used.