Dma

This section describes the programing api of DMA OS-HAL layer, including terms and acronyms, supported features, details on how to use this driver, enums and functions. More...

Overview

This section describes the programing api of DMA OS-HAL layer, including terms and acronyms, supported features, details on how to use this driver, enums and functions.

Terms and Acronyms

Terms	Details
DMA	Direct Memory Access.
FIFO	First In, First Out.
VFF DMA	Virtual FIFO DMA.

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

    - Allocate one DMA channel
     -Call mtk_os_hal_dma_alloc_chan(enum dma_channel chn)
       to allocate one DMA channel.
    
    - Config one DMA channel
      -Call mtk_os_hal_dma_config(enum dma_channel chn,
               struct dma_setting *setting)
    
    - Start one DMA channel
     -Call mtk_os_hal_dma_start(enum dma_channel chn)
    
    - Stop one DMA channel
     -Call mtk_os_hal_dma_stop(enum dma_channel chn)
    
    - Pause one DMA channel
     -Call mtk_os_hal_dma_pause(enum dma_channel chn)
    
    - Resume one DMA channel
     -Call mtk_os_hal_dma_resume(enum dma_channel chn)
    
    - Get DMA channel status
     -Call mtk_os_hal_dma_get_status(enum dma_channel chn)
    
    - Register interrupt callback
     -Call mtk_os_hal_dma_register_isr(enum dma_channel chn,
               dma_interrupt_callback callback,
               void *callback_data,
               enum dma_interrupt_type isr_type)
    
    - Dump DMA registers
     - Call  mtk_os_hal_dma_dump_register(enum dma_channel chn)
    
    - Update VFF DMA channel swptr
     - Call  mtk_os_hal_dma_update_swptr(enum dma_channel chn,
               u32 length_byte)
    
    
    - Set DMA parameter which is defined in the #dma_param_type
     - Call  mtk_os_hal_dma_set_param(enum dma_channel chn,
               enum dma_param_type param_type, u32 value)
    
    - Get DMA parameter which is defined in the #dma_param_type
     - Call  mtk_os_hal_dma_get_param(enum dma_channel chn,
               enum dma_param_type param_type)
    
    - Release one DMA channel
     - Call  mtk_os_hal_dma_release_chan(enum dma_channel chn)
    
    - Reset DMA channel
     - Call  mtk_os_hal_dma_reset(enum dma_channel chn)
    
    - Clear dreq signal of DMA channel
     - Call  mtk_os_hal_dma_clr_dreq(enum dma_channel chn)

Modules
	Enum
	This section describes the enumeration definitions in DMA driver OS-HAL layer.
	Function
	This section provides DMA OS-HAL APIs to use DMA channel for data transfer.
	Struct
	This section introduces the structure definition in DMA OS-HAL.
	Typedef
	This section introduces the typedef used by DMA OS-HAL Layer.