stm32h7xx_hal_swpmi.h File Reference

Header file of SWPMI HAL module. More...

#include "stm32h7xx_hal_def.h"

Go to the source code of this file.

Data Structures
struct	SWPMI_InitTypeDef
	SWPMI Init Structure definition. More...
struct	SWPMI_HandleTypeDef
	SWPMI handle Structure definition. More...

Macros
#define	HAL_SWPMI_ERROR_NONE   ((uint32_t)0x00000000)
#define	HAL_SWPMI_ERROR_CRC   ((uint32_t)0x00000004)
#define	HAL_SWPMI_ERROR_OVR   ((uint32_t)0x00000008)
#define	HAL_SWPMI_ERROR_UDR   ((uint32_t)0x0000000C)
#define	HAL_SWPMI_ERROR_DMA   ((uint32_t)0x00000010)
#define	HAL_SWPMI_ERROR_TIMEOUT   ((uint32_t)0x00000020)
#define	HAL_SWPMI_ERROR_TXBEF_TIMEOUT   ((uint32_t)0x00000040)
#define	HAL_SWPMI_ERROR_TRANSCEIVER_NOT_READY   ((uint32_t)0x00000080)
#define	SWPMI_VOLTAGE_CLASS_C   ((uint32_t)0x00000000)
#define	SWPMI_VOLTAGE_CLASS_B   SWPMI_OR_CLASS
#define	SWPMI_TX_NO_SOFTWAREBUFFER   ((uint32_t)0x00000000)
#define	SWPMI_TX_SINGLE_SOFTWAREBUFFER   ((uint32_t)0x00000000)
#define	SWPMI_TX_MULTI_SOFTWAREBUFFER   SWPMI_CR_TXMODE
#define	SWPMI_RX_NO_SOFTWAREBUFFER   ((uint32_t)0x00000000)
#define	SWPMI_RX_SINGLE_SOFTWAREBUFFER   ((uint32_t)0x00000000)
#define	SWPMI_RX_MULTI_SOFTWAREBUFFER   SWPMI_CR_RXMODE
#define	SWPMI_FLAG_RXBFF   SWPMI_ISR_RXBFF
#define	SWPMI_FLAG_TXBEF   SWPMI_ISR_TXBEF
#define	SWPMI_FLAG_RXBERF   SWPMI_ISR_RXBERF
#define	SWPMI_FLAG_RXOVRF   SWPMI_ISR_RXOVRF
#define	SWPMI_FLAG_TXUNRF   SWPMI_ISR_TXUNRF
#define	SWPMI_FLAG_RXNE   SWPMI_ISR_RXNE
#define	SWPMI_FLAG_TXE   SWPMI_ISR_TXE
#define	SWPMI_FLAG_TCF   SWPMI_ISR_TCF
#define	SWPMI_FLAG_SRF   SWPMI_ISR_SRF
#define	SWPMI_FLAG_SUSP   SWPMI_ISR_SUSP
#define	SWPMI_FLAG_DEACTF   SWPMI_ISR_DEACTF
#define	SWPMI_FLAG_RDYF   SWPMI_ISR_RDYF
#define	SWPMI_IT_RDYIE   SWPMI_IER_RDYIE
#define	SWPMI_IT_SRIE   SWPMI_IER_SRIE
#define	SWPMI_IT_TCIE   SWPMI_IER_TCIE
#define	SWPMI_IT_TIE   SWPMI_IER_TIE
#define	SWPMI_IT_RIE   SWPMI_IER_RIE
#define	SWPMI_IT_TXUNRIE   SWPMI_IER_TXUNRIE
#define	SWPMI_IT_RXOVRIE   SWPMI_IER_RXOVRIE
#define	SWPMI_IT_RXBERIE   SWPMI_IER_RXBERIE
#define	SWPMI_IT_TXBEIE   SWPMI_IER_TXBEIE
#define	SWPMI_IT_RXBFIE   SWPMI_IER_RXBFIE
#define	__HAL_SWPMI_RESET_HANDLE_STATE(__HANDLE__)   ((__HANDLE__)->State = HAL_SWPMI_STATE_RESET)
	Reset SWPMI handle state.
#define	__HAL_SWPMI_ENABLE(__HANDLE__)   SET_BIT((__HANDLE__)->Instance->CR, SWPMI_CR_SWPACT)
	Enable the SWPMI peripheral.
#define	__HAL_SWPMI_DISABLE(__HANDLE__)   CLEAR_BIT((__HANDLE__)->Instance->CR, SWPMI_CR_SWPACT)
	Disable the SWPMI peripheral.
#define	__HAL_SWPMI_TRANSCEIVER_ENABLE(__HANDLE__)   SET_BIT((__HANDLE__)->Instance->CR, SWPMI_CR_SWPEN)
	Enable the SWPMI transceiver.
#define	__HAL_SWPMI_TRANSCEIVER_DISABLE(__HANDLE__)   CLEAR_BIT((__HANDLE__)->Instance->CR, SWPMI_CR_SWPEN)
	Disable the SWPMI transceiver.
#define	__HAL_SWPMI_GET_FLAG(__HANDLE__, __FLAG__)   (READ_BIT((__HANDLE__)->Instance->ISR, (__FLAG__)) == (__FLAG__))
	Check whether the specified SWPMI flag is set or not.
#define	__HAL_SWPMI_CLEAR_FLAG(__HANDLE__, __FLAG__)   WRITE_REG((__HANDLE__)->Instance->ICR, (__FLAG__))
	Clear the specified SWPMI ISR flag.
#define	__HAL_SWPMI_ENABLE_IT(__HANDLE__, __INTERRUPT__)   SET_BIT((__HANDLE__)->Instance->IER, (__INTERRUPT__))
	Enable the specified SWPMI interrupt.
#define	__HAL_SWPMI_DISABLE_IT(__HANDLE__, __INTERRUPT__)   CLEAR_BIT((__HANDLE__)->Instance->IER, (__INTERRUPT__))
	Disable the specified SWPMI interrupt.
#define	__HAL_SWPMI_GET_IT(__HANDLE__, __IT__)   (READ_BIT((__HANDLE__)->Instance->ISR,(__IT__)) == (__IT__))
	Check whether the specified SWPMI interrupt has occurred or not.
#define	__HAL_SWPMI_GET_IT_SOURCE(__HANDLE__, __IT__)   ((READ_BIT((__HANDLE__)->Instance->IER, (__IT__)) == (__IT__)) ? SET : RESET)
	Check whether the specified SWPMI interrupt source is enabled or not.
#define	IS_SWPMI_VOLTAGE_CLASS(__CLASS__)
#define	IS_SWPMI_BITRATE_VALUE(__VALUE__)   (((__VALUE__) <= 255U))
#define	IS_SWPMI_TX_BUFFERING_MODE(__MODE__)
#define	IS_SWPMI_RX_BUFFERING_MODE(__MODE__)

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...

Functions
HAL_StatusTypeDef	HAL_SWPMI_Init (SWPMI_HandleTypeDef *hswpmi)
HAL_StatusTypeDef	HAL_SWPMI_DeInit (SWPMI_HandleTypeDef *hswpmi)
void	HAL_SWPMI_MspInit (SWPMI_HandleTypeDef *hswpmi)
void	HAL_SWPMI_MspDeInit (SWPMI_HandleTypeDef *hswpmi)
HAL_StatusTypeDef	HAL_SWPMI_Transmit (SWPMI_HandleTypeDef *hswpmi, uint32_t *pData, uint16_t Size, uint32_t Timeout)
HAL_StatusTypeDef	HAL_SWPMI_Receive (SWPMI_HandleTypeDef *hswpmi, uint32_t *pData, uint16_t Size, uint32_t Timeout)
HAL_StatusTypeDef	HAL_SWPMI_Transmit_IT (SWPMI_HandleTypeDef *hswpmi, uint32_t *pData, uint16_t Size)
HAL_StatusTypeDef	HAL_SWPMI_Receive_IT (SWPMI_HandleTypeDef *hswpmi, uint32_t *pData, uint16_t Size)
HAL_StatusTypeDef	HAL_SWPMI_Transmit_DMA (SWPMI_HandleTypeDef *hswpmi, uint32_t *pData, uint16_t Size)
HAL_StatusTypeDef	HAL_SWPMI_Receive_DMA (SWPMI_HandleTypeDef *hswpmi, uint32_t *pData, uint16_t Size)
HAL_StatusTypeDef	HAL_SWPMI_DMAStop (SWPMI_HandleTypeDef *hswpmi)
HAL_StatusTypeDef	HAL_SWPMI_EnableLoopback (SWPMI_HandleTypeDef *hswpmi)
HAL_StatusTypeDef	HAL_SWPMI_DisableLoopback (SWPMI_HandleTypeDef *hswpmi)
void	HAL_SWPMI_IRQHandler (SWPMI_HandleTypeDef *hswpmi)
void	HAL_SWPMI_TxCpltCallback (SWPMI_HandleTypeDef *hswpmi)
void	HAL_SWPMI_TxHalfCpltCallback (SWPMI_HandleTypeDef *hswpmi)
void	HAL_SWPMI_RxCpltCallback (SWPMI_HandleTypeDef *hswpmi)
void	HAL_SWPMI_RxHalfCpltCallback (SWPMI_HandleTypeDef *hswpmi)
void	HAL_SWPMI_ErrorCallback (SWPMI_HandleTypeDef *hswpmi)
HAL_SWPMI_StateTypeDef	HAL_SWPMI_GetState (SWPMI_HandleTypeDef *hswpmi)
uint32_t	HAL_SWPMI_GetError (SWPMI_HandleTypeDef *hswpmi)

Detailed Description

Header file of SWPMI HAL module.

Author

MCD Application Team

Attention

Copyright (c) 2017 STMicroelectronics. All rights reserved.

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.