TUKS MCU Introductory course / TUKS-COURSE-2-LED
Embed: (wiki syntax)

« Back to documentation index

Input and Output operation functions

Input and Output operation functions
[DMA Exported Functions]

Input and Output operation functions. More...

Functions

HAL_StatusTypeDef HAL_DMA_Start (DMA_HandleTypeDef *hdma, uint32_t SrcAddress, uint32_t DstAddress, uint32_t DataLength)
 Start 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)
 Abort 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, uint32_t CompleteLevel, uint32_t Timeout)
 Polling for transfer complete.
void HAL_DMA_IRQHandler (DMA_HandleTypeDef *hdma)
 Handle 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.

Detailed Description

Input and Output operation functions.

 ===============================================================================
                      #####  IO operation functions  #####
 ===============================================================================
    [..]  This section provides functions allowing to:
      (+) Configure the source, destination address and data length and Start DMA transfer
      (+) Configure the source, destination address and data length and
          Start DMA transfer with interrupt
      (+) Abort DMA transfer
      (+) Poll for transfer complete
      (+) Handle DMA interrupt request


Function Documentation

HAL_StatusTypeDef HAL_DMA_Abort ( DMA_HandleTypeDef *  hdma )

Abort the DMA Transfer.

Parameters:
hdma,:pointer to a DMA_HandleTypeDef structure that contains the configuration information for the specified DMA Channel.
Return values:
HALstatus

Definition at line 453 of file stm32l4xx_hal_dma.c.

HAL_StatusTypeDef HAL_DMA_Abort_IT ( DMA_HandleTypeDef *  hdma )

Aborts the DMA Transfer in Interrupt mode.

Parameters:
hdma: pointer to a DMA_HandleTypeDef structure that contains the configuration information for the specified DMA Stream.
Return values:
HALstatus

Definition at line 490 of file stm32l4xx_hal_dma.c.

void HAL_DMA_IRQHandler ( DMA_HandleTypeDef *  hdma )

Handle DMA interrupt request.

Parameters:
hdma,:pointer to a DMA_HandleTypeDef structure that contains the configuration information for the specified DMA Channel.
Return values:
None

Definition at line 636 of file stm32l4xx_hal_dma.c.

HAL_StatusTypeDef HAL_DMA_PollForTransfer ( DMA_HandleTypeDef *  hdma,
uint32_t  CompleteLevel,
uint32_t  Timeout 
)

Polling for transfer complete.

Parameters:
hdma,:pointer to a DMA_HandleTypeDef structure that contains the configuration information for the specified DMA Channel.
CompleteLevel,:Specifies the DMA level complete.
Timeout,:Timeout duration.
Return values:
HALstatus

Definition at line 535 of file stm32l4xx_hal_dma.c.

HAL_StatusTypeDef HAL_DMA_RegisterCallback ( DMA_HandleTypeDef *  hdma,
HAL_DMA_CallbackIDTypeDef  CallbackID,
void(*)(DMA_HandleTypeDef *_hdma)  pCallback 
)

Register callbacks.

Parameters:
hdma,:pointer to a DMA_HandleTypeDef structure that contains the configuration information for the specified DMA Stream.
CallbackID,:User Callback identifer a HAL_DMA_CallbackIDTypeDef ENUM as parameter.
pCallback,:pointer to private callbacsk function which has pointer to a DMA_HandleTypeDef structure as parameter.
Return values:
HALstatus

Definition at line 726 of file stm32l4xx_hal_dma.c.

HAL_StatusTypeDef HAL_DMA_Start ( DMA_HandleTypeDef *  hdma,
uint32_t  SrcAddress,
uint32_t  DstAddress,
uint32_t  DataLength 
)

Start the DMA Transfer.

Parameters:
hdma,:pointer to a DMA_HandleTypeDef structure that contains the configuration information for the specified DMA Channel.
SrcAddress,:The source memory Buffer address
DstAddress,:The destination memory Buffer address
DataLength,:The length of data to be transferred from source to destination
Return values:
HALstatus

Definition at line 356 of file stm32l4xx_hal_dma.c.

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.

Parameters:
hdma,:pointer to a DMA_HandleTypeDef structure that contains the configuration information for the specified DMA Channel.
SrcAddress,:The source memory Buffer address
DstAddress,:The destination memory Buffer address
DataLength,:The length of data to be transferred from source to destination
Return values:
HALstatus

Definition at line 399 of file stm32l4xx_hal_dma.c.

HAL_StatusTypeDef HAL_DMA_UnRegisterCallback ( DMA_HandleTypeDef *  hdma,
HAL_DMA_CallbackIDTypeDef  CallbackID 
)

UnRegister callbacks.

Parameters:
hdma,:pointer to a DMA_HandleTypeDef structure that contains the configuration information for the specified DMA Stream.
CallbackID,:User Callback identifer a HAL_DMA_CallbackIDTypeDef ENUM as parameter.
Return values:
HALstatus

Definition at line 777 of file stm32l4xx_hal_dma.c.