I2s

This section introduces the Integrated Interchip Sound (I2S) 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 Integrated Interchip Sound (I2S) 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.
ISR	Interrupt Service Routine.
I2S	Integrated Interchip Sound.

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

    - initial I2S.
     -Call mtk_os_hal_request_i2s(i2s_no i2s_port)
       to initial I2S and reguest resource.
    
    - configure I2S and DMA.
      -Call mtk_os_hal_config_i2s(i2s_no i2s_port,
                     audio_parameter *parameter)
       to configure I2S and DMA for I2S settings and start up DMA.
    
    - Enable I2S transfer.
      -Call mtk_os_hal_enable_i2s(i2s_no i2s_port).
    
    - Disable I2S transfer.
     - Call  mtk_os_hal_disable_i2s(i2s_no i2s_port).
    
    - release I2S.
     - Call  mtk_os_hal_disable_i2s(i2s_no i2s_port) to release resource.

Modules
	Enum
	This section introduces the enumerations that I2S uses while performing transfer.
	Function
	This section provides high level APIs to upper layer.