STM32H735xx HAL User Manual: stm32h7xx_hal

DMA HAL module driver. This file provides firmware functions to manage the following functionalities of the Direct Memory Access (DMA) peripheral: + Initialization and de-initialization functions + IO operation functions + Peripheral State and errors functions. More...

#include "stm32h7xx_hal.h"

Go to the source code of this file.

Data Structures
struct	DMA_Base_Registers
struct	BDMA_Base_Registers
Defines
#define	HAL_TIMEOUT_DMA_ABORT (5U) /* 5 ms */
#define	BDMA_PERIPH_TO_MEMORY (0x00000000U)
#define	BDMA_MEMORY_TO_PERIPH ((uint32_t)BDMA_CCR_DIR)
#define	BDMA_MEMORY_TO_MEMORY ((uint32_t)BDMA_CCR_MEM2MEM)
#define	DMA_TO_BDMA_DIRECTION(__DMA_DIRECTION__)
#define	DMA_TO_BDMA_PERIPHERAL_INC(__DMA_PERIPHERAL_INC__) ((__DMA_PERIPHERAL_INC__) >> 3U)
#define	DMA_TO_BDMA_MEMORY_INC(__DMA_MEMORY_INC__) ((__DMA_MEMORY_INC__) >> 3U)
#define	DMA_TO_BDMA_PDATA_SIZE(__DMA_PDATA_SIZE__) ((__DMA_PDATA_SIZE__) >> 3U)
#define	DMA_TO_BDMA_MDATA_SIZE(__DMA_MDATA_SIZE__) ((__DMA_MDATA_SIZE__) >> 3U)
#define	DMA_TO_BDMA_MODE(__DMA_MODE__) ((__DMA_MODE__) >> 3U)
#define	DMA_TO_BDMA_PRIORITY(__DMA_PRIORITY__) ((__DMA_PRIORITY__) >> 4U)
#define	IS_DMA_UART_USART_REQUEST(__REQUEST__)
Functions
static void	DMA_SetConfig (DMA_HandleTypeDef *hdma, uint32_t SrcAddress, uint32_t DstAddress, uint32_t DataLength)
	Sets the DMA Transfer parameter.
static uint32_t	DMA_CalcBaseAndBitshift (DMA_HandleTypeDef *hdma)
	Returns the DMA Stream base address depending on stream number.
static HAL_StatusTypeDef	DMA_CheckFifoParam (DMA_HandleTypeDef *hdma)
	Check compatibility between FIFO threshold level and size of the memory burst.
static void	DMA_CalcDMAMUXChannelBaseAndMask (DMA_HandleTypeDef *hdma)
	Updates the DMA handle with the DMAMUX channel and status mask depending on stream number.
static void	DMA_CalcDMAMUXRequestGenBaseAndMask (DMA_HandleTypeDef *hdma)
	Updates the DMA handle with the DMAMUX request generator params.
HAL_StatusTypeDef	HAL_DMA_Init (DMA_HandleTypeDef *hdma)
	Initialize the DMA according to the specified parameters in the DMA_InitTypeDef and create the associated handle.
HAL_StatusTypeDef	HAL_DMA_DeInit (DMA_HandleTypeDef *hdma)
	DeInitializes the DMA peripheral.
HAL_StatusTypeDef	HAL_DMA_Start (DMA_HandleTypeDef *hdma, uint32_t SrcAddress, uint32_t DstAddress, uint32_t DataLength)
	Starts the DMA Transfer.
HAL_StatusTypeDef	HAL_DMA_Start_IT (DMA_HandleTypeDef *hdma, uint32_t SrcAddress, uint32_t DstAddress, uint32_t DataLength)
	Start the DMA Transfer with interrupt enabled.
HAL_StatusTypeDef	HAL_DMA_Abort (DMA_HandleTypeDef *hdma)
	Aborts the DMA Transfer.
HAL_StatusTypeDef	HAL_DMA_Abort_IT (DMA_HandleTypeDef *hdma)
	Aborts the DMA Transfer in Interrupt mode.
HAL_StatusTypeDef	HAL_DMA_PollForTransfer (DMA_HandleTypeDef *hdma, HAL_DMA_LevelCompleteTypeDef CompleteLevel, uint32_t Timeout)
	Polling for transfer complete.
void	HAL_DMA_IRQHandler (DMA_HandleTypeDef *hdma)
	Handles DMA interrupt request.
HAL_StatusTypeDef	HAL_DMA_RegisterCallback (DMA_HandleTypeDef hdma, HAL_DMA_CallbackIDTypeDef CallbackID, void(pCallback)(DMA_HandleTypeDef *_hdma))
	Register callbacks.
HAL_StatusTypeDef	HAL_DMA_UnRegisterCallback (DMA_HandleTypeDef *hdma, HAL_DMA_CallbackIDTypeDef CallbackID)
	UnRegister callbacks.
HAL_DMA_StateTypeDef	HAL_DMA_GetState (DMA_HandleTypeDef *hdma)
	Returns the DMA state.
uint32_t	HAL_DMA_GetError (DMA_HandleTypeDef *hdma)
	Return the DMA error code.

Detailed Description

Author:: MCD Application Team

Attention:

This software is licensed under terms that can be found in the LICENSE file in the root directory of this software component. If no LICENSE file comes with this software, it is provided AS-IS.

  ==============================================================================
                        ##### How to use this driver #####
  ==============================================================================
  [..]
   (#) Enable and configure the peripheral to be connected to the DMA Stream
       (except for internal SRAM/FLASH memories: no initialization is
       necessary) please refer to Reference manual for connection between peripherals
       and DMA requests .

   (#) For a given Stream, program the required configuration through the following parameters:
       Transfer Direction, Source and Destination data formats,
       Circular, Normal or peripheral flow control mode, Stream Priority level,
       Source and Destination Increment mode, FIFO mode and its Threshold (if needed),
       Burst mode for Source and/or Destination (if needed) using HAL_DMA_Init() function.

     *** Polling mode IO operation ***
     =================================
    [..]
          (+) Use HAL_DMA_Start() to start DMA transfer after the configuration of Source
              address and destination address and the Length of data to be transferred
          (+) Use HAL_DMA_PollForTransfer() to poll for the end of current transfer, in this
              case a fixed Timeout can be configured by User depending from his application.

     *** Interrupt mode IO operation ***
     ===================================
    [..]
          (+) Configure the DMA interrupt priority using HAL_NVIC_SetPriority()
          (+) Enable the DMA IRQ handler using HAL_NVIC_EnableIRQ()
          (+) Use HAL_DMA_Start_IT() to start DMA transfer after the configuration of
              Source address and destination address and the Length of data to be transferred. In this
              case the DMA interrupt is configured
          (+) Use HAL_DMA_IRQHandler() called under DMA_IRQHandler() Interrupt subroutine
          (+) At the end of data transfer HAL_DMA_IRQHandler() function is executed and user can
              add his own function by customization of function pointer XferCpltCallback and
              XferErrorCallback (i.e a member of DMA handle structure).
    [..]
     (#) Use HAL_DMA_GetState() function to return the DMA state and HAL_DMA_GetError() in case of error
         detection.

     (#) Use HAL_DMA_Abort() function to abort the current transfer

     -@-   In Memory-to-Memory transfer mode, Circular mode is not allowed.

     -@-   The FIFO is used mainly to reduce bus usage and to allow data packing/unpacking: it is
           possible to set different Data Sizes for the Peripheral and the Memory (ie. you can set
           Half-Word data size for the peripheral to access its data register and set Word data size
           for the Memory to gain in access time. Each two half words will be packed and written in
           a single access to a Word in the Memory).

     -@-   When FIFO is disabled, it is not allowed to configure different Data Sizes for Source
           and Destination. In this case the Peripheral Data Size will be applied to both Source
           and Destination.

     *** DMA HAL driver macros list ***
     =============================================
     [..]
       Below the list of most used macros in DMA HAL driver.

      (+) __HAL_DMA_ENABLE: Enable the specified DMA Stream.
      (+) __HAL_DMA_DISABLE: Disable the specified DMA Stream.
      (+) __HAL_DMA_GET_FS: Return the current DMA Stream FIFO filled level.
      (+) __HAL_DMA_ENABLE_IT: Enable the specified DMA Stream interrupts.
      (+) __HAL_DMA_DISABLE_IT: Disable the specified DMA Stream interrupts.
      (+) __HAL_DMA_GET_IT_SOURCE: Check whether the specified DMA Stream interrupt has occurred or not.

     [..]
      (@) You can refer to the DMA HAL driver header file for more useful macros.

Definition in file stm32h7xx_hal_dma.c.

Data Structures

Defines

Functions

Detailed Description