SPIM

This section introduces the Serial Peripheral Interface Master (SPIM) 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 Serial Peripheral Interface Master (SPIM) 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.
SPI	Serial Peripheral Interface.

Supported Features

The SPI controller supports a wide range of SPI interface devices, including full-duplex transaction ability to communicate with both half-duplex and full-duplex devices.
For more details, please refer to SPIM datasheet.

• Support transaction format.
  SPIM driver's user can use struct mtk_spi_transfer to judge either the transfer is half-duplex or full-duplex.
  • Half-duplex transaction: There is only one valid transaction at a time on a single direction: either Send or Receive.
    • Send: Device driver should provide mtk_spi_transfer->opcode, mtk_spi_transfer->opcode_len, mtk_spi_transfer->tx_buf, mtk_spi_transfer->len and set mtk_spi_transfer->rx_buf = NULL.
      mtk_spi_transfer->opcode_len should be 1~4bytes, mtk_spi_transfer->len should be 0~32bytes.
    • Receive: Device driver should provide mtk_spi_transfer->opcode, mtk_spi_transfer->opcode_len, mtk_spi_transfer->rx_buf, mtk_spi_transfer->len and set mtk_spi_transfer->tx_buf = NULL.
      mtk_spi_transfer->opcode_len should be 0~4bytes, mtk_spi_transfer->len should be 1~32bytes.
  • Full-duplex transaction: There are two valid mutually inclusive transactions: Send and Receive.
    • Device driver should provide mtk_spi_transfer->len, mtk_spi_transfer->opcode, mtk_spi_transfer->opcode_len, mtk_spi_transfer->tx_buf and set mtk_spi_transfer->rx_buf at the same time.
    • mtk_spi_transfer->opcode_len should be 1~4bytes, mtk_spi_transfer->len should be 1~16bytes.

How to use this driver

• SW Architecture:
  See Overview of M-HAL SW Architecture for the details of SW architecture.

  This section describes the definition of APIs and provides an example on freeRTos about how to use these APIs to develop an OS-related SPI driver.
  Also this section provides an example about the sequence of APIs that should be used by the SPI slave.

• The OS-HAL freeRTos driver sample code is as follows:
  freeRTos SPIM sample code on github

Modules
	Define
	This section introduces the Macro definition which is used as SPIM M-HAL's API error return type.
	Enum
	This section introduces the enumerations that SPIM should configure before performing transfer.
	Function
	This section provides Fixed APIs(defined as Common Interface) to fully control the MediaTek SPIM HW.
	Struct
	This section introduces the structure that SPIM OS-HAL/M-HAL/HDL used.
	Typedef
	This section introduces the typedef that SPIM M-HAL used.