STM32L4xx_HAL_Driver  1.14.0
stm32l4xx_hal_swpmi.h File Reference

Header file of SWPMI HAL module. More...

Go to the source code of this file.

Data Structures

struct  endif
 ADC handle Structure definition. More...
 

Typedefs

typedef struct __SWPMI_HandleTypeDef else typedef struct endif SWPMI_HandleTypeDef
 SWPMI handle Structure definition. More...
 
typedef void(* pSWPMI_CallbackTypeDef) (SWPMI_HandleTypeDef *hswpmi)
 SWPMI callback pointer definition. More...
 

Enumerations

enum  HAL_SWPMI_StateTypeDef {
  HAL_SWPMI_STATE_RESET = 0x00, HAL_SWPMI_STATE_READY = 0x01, HAL_SWPMI_STATE_BUSY = 0x02, HAL_SWPMI_STATE_BUSY_TX = 0x12,
  HAL_SWPMI_STATE_BUSY_RX = 0x22, HAL_SWPMI_STATE_BUSY_TX_RX = 0x32, HAL_SWPMI_STATE_TIMEOUT = 0x03, HAL_SWPMI_STATE_ERROR = 0x04
}
 HAL SWPMI State structures definition. More...
 
enum  HAL_SWPMI_CallbackIDTypeDef {
  HAL_SWPMI_RX_COMPLETE_CB_ID = 0x00U, HAL_SWPMI_RX_HALFCOMPLETE_CB_ID = 0x01U, HAL_SWPMI_TX_COMPLETE_CB_ID = 0x02U, HAL_SWPMI_TX_HALFCOMPLETE_CB_ID = 0x03U,
  HAL_SWPMI_ERROR_CB_ID = 0x04U, HAL_SWPMI_MSPINIT_CB_ID = 0x05U, HAL_SWPMI_MSPDEINIT_CB_ID = 0x06U
}
 SWPMI callback ID enumeration definition. More...
 

Functions

HAL_StatusTypeDef HAL_SWPMI_Init (SWPMI_HandleTypeDef *hswpmi)
 Initialize the SWPMI peripheral according to the specified parameters in the SWPMI_InitTypeDef. More...
 
HAL_StatusTypeDef HAL_SWPMI_DeInit (SWPMI_HandleTypeDef *hswpmi)
 De-initialize the SWPMI peripheral. More...
 
void HAL_SWPMI_MspInit (SWPMI_HandleTypeDef *hswpmi)
 Initialize the SWPMI MSP. More...
 
void HAL_SWPMI_MspDeInit (SWPMI_HandleTypeDef *hswpmi)
 DeInitialize the SWPMI MSP. More...
 
HAL_StatusTypeDef HAL_SWPMI_RegisterCallback (SWPMI_HandleTypeDef *hswpmi, HAL_SWPMI_CallbackIDTypeDef CallbackID, pSWPMI_CallbackTypeDef pCallback)
 Register a user SWPMI callback to be used instead of the weak predefined callback. More...
 
HAL_StatusTypeDef HAL_SWPMI_UnRegisterCallback (SWPMI_HandleTypeDef *hswpmi, HAL_SWPMI_CallbackIDTypeDef CallbackID)
 Unregister a user SWPMI callback. SWPMI callback is redirected to the weak predefined callback. More...
 
HAL_StatusTypeDef HAL_SWPMI_Transmit (SWPMI_HandleTypeDef *hswpmi, uint32_t *pData, uint16_t Size, uint32_t Timeout)
 Transmit an amount of data in blocking mode. More...
 
HAL_StatusTypeDef HAL_SWPMI_Receive (SWPMI_HandleTypeDef *hswpmi, uint32_t *pData, uint16_t Size, uint32_t Timeout)
 Receive an amount of data in blocking mode. More...
 
HAL_StatusTypeDef HAL_SWPMI_Transmit_IT (SWPMI_HandleTypeDef *hswpmi, uint32_t *pData, uint16_t Size)
 Transmit an amount of data in non-blocking mode with interrupt. More...
 
HAL_StatusTypeDef HAL_SWPMI_Receive_IT (SWPMI_HandleTypeDef *hswpmi, uint32_t *pData, uint16_t Size)
 Receive an amount of data in non-blocking mode with interrupt. More...
 
HAL_StatusTypeDef HAL_SWPMI_Transmit_DMA (SWPMI_HandleTypeDef *hswpmi, uint32_t *pData, uint16_t Size)
 Transmit an amount of data in non-blocking mode with DMA interrupt. More...
 
HAL_StatusTypeDef HAL_SWPMI_Receive_DMA (SWPMI_HandleTypeDef *hswpmi, uint32_t *pData, uint16_t Size)
 Receive an amount of data in non-blocking mode with DMA interrupt. More...
 
HAL_StatusTypeDef HAL_SWPMI_DMAStop (SWPMI_HandleTypeDef *hswpmi)
 Stop all DMA transfers. More...
 
HAL_StatusTypeDef HAL_SWPMI_EnableLoopback (SWPMI_HandleTypeDef *hswpmi)
 Enable the Loopback mode. More...
 
HAL_StatusTypeDef HAL_SWPMI_DisableLoopback (SWPMI_HandleTypeDef *hswpmi)
 Disable the Loopback mode. More...
 
void HAL_SWPMI_IRQHandler (SWPMI_HandleTypeDef *hswpmi)
 Handle SWPMI interrupt request. More...
 
void HAL_SWPMI_TxCpltCallback (SWPMI_HandleTypeDef *hswpmi)
 Tx Transfer completed callback. More...
 
void HAL_SWPMI_TxHalfCpltCallback (SWPMI_HandleTypeDef *hswpmi)
 Tx Half Transfer completed callback. More...
 
void HAL_SWPMI_RxCpltCallback (SWPMI_HandleTypeDef *hswpmi)
 Rx Transfer completed callback. More...
 
void HAL_SWPMI_RxHalfCpltCallback (SWPMI_HandleTypeDef *hswpmi)
 Rx Half Transfer completed callback. More...
 
void HAL_SWPMI_ErrorCallback (SWPMI_HandleTypeDef *hswpmi)
 SWPMI error callback. More...
 
HAL_SWPMI_StateTypeDef HAL_SWPMI_GetState (SWPMI_HandleTypeDef *hswpmi)
 Return the SWPMI handle state. More...
 
uint32_t HAL_SWPMI_GetError (SWPMI_HandleTypeDef *hswpmi)
 Return the SWPMI error code. More...
 

Variables

 C
 

Detailed Description

Header file of SWPMI HAL module.

Author
MCD Application Team
Attention

© Copyright (c) 2017 STMicroelectronics. All rights reserved.

This software component is licensed by ST under BSD 3-Clause license, the "License"; You may not use this file except in compliance with the License. You may obtain a copy of the License at: opensource.org/licenses/BSD-3-Clause

Definition in file stm32l4xx_hal_swpmi.h.

Typedef Documentation

◆ pSWPMI_CallbackTypeDef

typedef void(* pSWPMI_CallbackTypeDef) (SWPMI_HandleTypeDef *hswpmi)

SWPMI callback pointer definition.

Definition at line 149 of file stm32l4xx_hal_swpmi.h.

◆ SWPMI_HandleTypeDef

typedef struct __SWPMI_HandleTypeDef else typedef struct endif SWPMI_HandleTypeDef

SWPMI handle Structure definition.

Enumeration Type Documentation

◆ HAL_SWPMI_CallbackIDTypeDef

SWPMI callback ID enumeration definition.

Enumerator
HAL_SWPMI_RX_COMPLETE_CB_ID 

SWPMI receive complete callback ID

HAL_SWPMI_RX_HALFCOMPLETE_CB_ID 

SWPMI receive half complete callback ID

HAL_SWPMI_TX_COMPLETE_CB_ID 

SWPMI transmit complete callback ID

HAL_SWPMI_TX_HALFCOMPLETE_CB_ID 

SWPMI transmit half complete callback ID

HAL_SWPMI_ERROR_CB_ID 

SWPMI error callback ID

HAL_SWPMI_MSPINIT_CB_ID 

SWPMI MSP init callback ID

HAL_SWPMI_MSPDEINIT_CB_ID 

SWPMI MSP de-init callback ID

Definition at line 135 of file stm32l4xx_hal_swpmi.h.

◆ HAL_SWPMI_StateTypeDef

HAL SWPMI State structures definition.

Enumerator
HAL_SWPMI_STATE_RESET 

Peripheral Reset state

HAL_SWPMI_STATE_READY 

Peripheral Initialized and ready for use

HAL_SWPMI_STATE_BUSY 

an internal process is ongoing

HAL_SWPMI_STATE_BUSY_TX 

Data Transmission process is ongoing

HAL_SWPMI_STATE_BUSY_RX 

Data Reception process is ongoing

HAL_SWPMI_STATE_BUSY_TX_RX 

Data Transmission and Reception process is ongoing

HAL_SWPMI_STATE_TIMEOUT 

Timeout state

HAL_SWPMI_STATE_ERROR 

Error

Definition at line 72 of file stm32l4xx_hal_swpmi.h.

Variable Documentation

◆ C

C
Initial value:
{
#endif
#if defined(SWPMI1)
typedef struct
{
uint32_t VoltageClass;
uint32_t BitRate;
uint32_t TxBufferingMode;
uint32_t RxBufferingMode;
}SWPMI_InitTypeDef
This file contains HAL common defines, enumeration, macros and structures definitions.