mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_NUCLEO_H743ZI/TOOLCHAIN_GCC_ARM/stm32h7xx_hal_swpmi.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 172:65be27845400 1 /**
AnnaBridge 172:65be27845400 2 ******************************************************************************
AnnaBridge 172:65be27845400 3 * @file stm32h7xx_hal_swpmi.h
AnnaBridge 172:65be27845400 4 * @author MCD Application Team
AnnaBridge 172:65be27845400 5 * @brief Header file of SWPMI HAL module.
AnnaBridge 172:65be27845400 6 ******************************************************************************
AnnaBridge 172:65be27845400 7 * @attention
AnnaBridge 172:65be27845400 8 *
AnnaBridge 172:65be27845400 9 * <h2><center>&copy; Copyright (c) 2017 STMicroelectronics.
AnnaBridge 172:65be27845400 10 * All rights reserved.</center></h2>
AnnaBridge 172:65be27845400 11 *
AnnaBridge 172:65be27845400 12 * This software component is licensed by ST under BSD 3-Clause license,
AnnaBridge 172:65be27845400 13 * the "License"; You may not use this file except in compliance with the
AnnaBridge 172:65be27845400 14 * License. You may obtain a copy of the License at:
AnnaBridge 172:65be27845400 15 * opensource.org/licenses/BSD-3-Clause
AnnaBridge 172:65be27845400 16 *
AnnaBridge 172:65be27845400 17 ******************************************************************************
AnnaBridge 172:65be27845400 18 */
AnnaBridge 172:65be27845400 19
AnnaBridge 172:65be27845400 20 /* Define to prevent recursive inclusion -------------------------------------*/
AnnaBridge 172:65be27845400 21 #ifndef STM32H7xx_HAL_SWPMI_H
AnnaBridge 172:65be27845400 22 #define STM32H7xx_HAL_SWPMI_H
AnnaBridge 172:65be27845400 23
AnnaBridge 172:65be27845400 24 #ifdef __cplusplus
AnnaBridge 172:65be27845400 25 extern "C" {
AnnaBridge 172:65be27845400 26 #endif
AnnaBridge 172:65be27845400 27
AnnaBridge 172:65be27845400 28 /* Includes ------------------------------------------------------------------*/
AnnaBridge 172:65be27845400 29 #include "stm32h7xx_hal_def.h"
AnnaBridge 172:65be27845400 30
AnnaBridge 172:65be27845400 31 /** @addtogroup STM32H7xx_HAL_Driver
AnnaBridge 172:65be27845400 32 * @{
AnnaBridge 172:65be27845400 33 */
AnnaBridge 172:65be27845400 34
AnnaBridge 172:65be27845400 35
AnnaBridge 172:65be27845400 36 /** @addtogroup SWPMI
AnnaBridge 172:65be27845400 37 * @{
AnnaBridge 172:65be27845400 38 */
AnnaBridge 172:65be27845400 39
AnnaBridge 172:65be27845400 40 /* Exported types ------------------------------------------------------------*/
AnnaBridge 172:65be27845400 41 /** @defgroup SWPMI_Exported_Types SWPMI Exported Types
AnnaBridge 172:65be27845400 42 * @{
AnnaBridge 172:65be27845400 43 */
AnnaBridge 172:65be27845400 44
AnnaBridge 172:65be27845400 45 /**
AnnaBridge 172:65be27845400 46 * @brief SWPMI Init Structure definition
AnnaBridge 172:65be27845400 47 */
AnnaBridge 172:65be27845400 48 typedef struct
AnnaBridge 172:65be27845400 49 {
AnnaBridge 172:65be27845400 50 uint32_t VoltageClass; /*!< Specifies the SWP Voltage Class.
AnnaBridge 172:65be27845400 51 This parameter can be a value of @ref SWPMI_Voltage_Class */
AnnaBridge 172:65be27845400 52
AnnaBridge 172:65be27845400 53 uint32_t BitRate; /*!< Specifies the SWPMI Bitrate.
AnnaBridge 172:65be27845400 54 This parameter must be a number between 0 and 255U.
AnnaBridge 172:65be27845400 55 The Bitrate is computed using the following formula:
AnnaBridge 172:65be27845400 56 SWPMI_freq = SWPMI_clk / (((BitRate) + 1) * 4)
AnnaBridge 172:65be27845400 57 */
AnnaBridge 172:65be27845400 58
AnnaBridge 172:65be27845400 59 uint32_t TxBufferingMode; /*!< Specifies the transmission buffering mode.
AnnaBridge 172:65be27845400 60 This parameter can be a value of @ref SWPMI_Tx_Buffering_Mode */
AnnaBridge 172:65be27845400 61
AnnaBridge 172:65be27845400 62 uint32_t RxBufferingMode; /*!< Specifies the reception buffering mode.
AnnaBridge 172:65be27845400 63 This parameter can be a value of @ref SWPMI_Rx_Buffering_Mode */
AnnaBridge 172:65be27845400 64
AnnaBridge 172:65be27845400 65 }SWPMI_InitTypeDef;
AnnaBridge 172:65be27845400 66
AnnaBridge 172:65be27845400 67
AnnaBridge 172:65be27845400 68 /**
AnnaBridge 172:65be27845400 69 * @brief HAL SWPMI State structures definition
AnnaBridge 172:65be27845400 70 */
AnnaBridge 172:65be27845400 71 typedef enum
AnnaBridge 172:65be27845400 72 {
AnnaBridge 172:65be27845400 73 HAL_SWPMI_STATE_RESET = 0x00, /*!< Peripheral Reset state */
AnnaBridge 172:65be27845400 74 HAL_SWPMI_STATE_READY = 0x01, /*!< Peripheral Initialized and ready for use */
AnnaBridge 172:65be27845400 75 HAL_SWPMI_STATE_BUSY = 0x02, /*!< an internal process is ongoing */
AnnaBridge 172:65be27845400 76 HAL_SWPMI_STATE_BUSY_TX = 0x12, /*!< Data Transmission process is ongoing */
AnnaBridge 172:65be27845400 77 HAL_SWPMI_STATE_BUSY_RX = 0x22, /*!< Data Reception process is ongoing */
AnnaBridge 172:65be27845400 78 HAL_SWPMI_STATE_BUSY_TX_RX = 0x32, /*!< Data Transmission and Reception process is ongoing */
AnnaBridge 172:65be27845400 79 HAL_SWPMI_STATE_TIMEOUT = 0x03, /*!< Timeout state */
AnnaBridge 172:65be27845400 80 HAL_SWPMI_STATE_ERROR = 0x04 /*!< Error */
AnnaBridge 172:65be27845400 81 }HAL_SWPMI_StateTypeDef;
AnnaBridge 172:65be27845400 82
AnnaBridge 172:65be27845400 83 /**
AnnaBridge 172:65be27845400 84 * @brief SWPMI handle Structure definition
AnnaBridge 172:65be27845400 85 */
AnnaBridge 172:65be27845400 86 #if (USE_HAL_SWPMI_REGISTER_CALLBACKS == 1)
AnnaBridge 172:65be27845400 87 typedef struct __SWPMI_HandleTypeDef
AnnaBridge 172:65be27845400 88 #else
AnnaBridge 172:65be27845400 89 typedef struct
AnnaBridge 172:65be27845400 90 #endif /* USE_HAL_SWPMI_REGISTER_CALLBACKS */
AnnaBridge 172:65be27845400 91 {
AnnaBridge 172:65be27845400 92 SWPMI_TypeDef *Instance; /*!< SWPMI registers base address */
AnnaBridge 172:65be27845400 93
AnnaBridge 172:65be27845400 94 SWPMI_InitTypeDef Init; /*!< SWPMI communication parameters */
AnnaBridge 172:65be27845400 95
AnnaBridge 172:65be27845400 96 uint32_t *pTxBuffPtr; /*!< Pointer to SWPMI Tx transfer Buffer */
AnnaBridge 172:65be27845400 97
AnnaBridge 172:65be27845400 98 uint32_t TxXferSize; /*!< SWPMI Tx Transfer size */
AnnaBridge 172:65be27845400 99
AnnaBridge 172:65be27845400 100 uint32_t TxXferCount; /*!< SWPMI Tx Transfer Counter */
AnnaBridge 172:65be27845400 101
AnnaBridge 172:65be27845400 102 uint32_t *pRxBuffPtr; /*!< Pointer to SWPMI Rx transfer Buffer */
AnnaBridge 172:65be27845400 103
AnnaBridge 172:65be27845400 104 uint32_t RxXferSize; /*!< SWPMI Rx Transfer size */
AnnaBridge 172:65be27845400 105
AnnaBridge 172:65be27845400 106 uint32_t RxXferCount; /*!< SWPMI Rx Transfer Counter */
AnnaBridge 172:65be27845400 107
AnnaBridge 172:65be27845400 108 DMA_HandleTypeDef *hdmatx; /*!< SWPMI Tx DMA Handle parameters */
AnnaBridge 172:65be27845400 109
AnnaBridge 172:65be27845400 110 DMA_HandleTypeDef *hdmarx; /*!< SWPMI Rx DMA Handle parameters */
AnnaBridge 172:65be27845400 111
AnnaBridge 172:65be27845400 112 HAL_LockTypeDef Lock; /*!< SWPMI object */
AnnaBridge 172:65be27845400 113
AnnaBridge 172:65be27845400 114 __IO HAL_SWPMI_StateTypeDef State; /*!< SWPMI communication state */
AnnaBridge 172:65be27845400 115
AnnaBridge 172:65be27845400 116 __IO uint32_t ErrorCode; /*!< SWPMI Error code */
AnnaBridge 172:65be27845400 117
AnnaBridge 172:65be27845400 118 #if (USE_HAL_SWPMI_REGISTER_CALLBACKS == 1)
AnnaBridge 172:65be27845400 119 void (*RxCpltCallback) (struct __SWPMI_HandleTypeDef *hswpmi); /*!< SWPMI receive complete callback */
AnnaBridge 172:65be27845400 120 void (*RxHalfCpltCallback) (struct __SWPMI_HandleTypeDef *hswpmi); /*!< SWPMI receive half complete callback */
AnnaBridge 172:65be27845400 121 void (*TxCpltCallback) (struct __SWPMI_HandleTypeDef *hswpmi); /*!< SWPMI transmit complete callback */
AnnaBridge 172:65be27845400 122 void (*TxHalfCpltCallback) (struct __SWPMI_HandleTypeDef *hswpmi); /*!< SWPMI transmit half complete callback */
AnnaBridge 172:65be27845400 123 void (*ErrorCallback) (struct __SWPMI_HandleTypeDef *hswpmi); /*!< SWPMI error callback */
AnnaBridge 172:65be27845400 124 void (*MspInitCallback) (struct __SWPMI_HandleTypeDef *hswpmi); /*!< SWPMI MSP init callback */
AnnaBridge 172:65be27845400 125 void (*MspDeInitCallback) (struct __SWPMI_HandleTypeDef *hswpmi); /*!< SWPMI MSP de-init callback */
AnnaBridge 172:65be27845400 126 #endif
AnnaBridge 172:65be27845400 127
AnnaBridge 172:65be27845400 128 }SWPMI_HandleTypeDef;
AnnaBridge 172:65be27845400 129
AnnaBridge 172:65be27845400 130 #if (USE_HAL_SWPMI_REGISTER_CALLBACKS == 1)
AnnaBridge 172:65be27845400 131 /**
AnnaBridge 172:65be27845400 132 * @brief SWPMI callback ID enumeration definition
AnnaBridge 172:65be27845400 133 */
AnnaBridge 172:65be27845400 134 typedef enum
AnnaBridge 172:65be27845400 135 {
AnnaBridge 172:65be27845400 136 HAL_SWPMI_RX_COMPLETE_CB_ID = 0x00U, /*!< SWPMI receive complete callback ID */
AnnaBridge 172:65be27845400 137 HAL_SWPMI_RX_HALFCOMPLETE_CB_ID = 0x01U, /*!< SWPMI receive half complete callback ID */
AnnaBridge 172:65be27845400 138 HAL_SWPMI_TX_COMPLETE_CB_ID = 0x02U, /*!< SWPMI transmit complete callback ID */
AnnaBridge 172:65be27845400 139 HAL_SWPMI_TX_HALFCOMPLETE_CB_ID = 0x03U, /*!< SWPMI transmit half complete callback ID */
AnnaBridge 172:65be27845400 140 HAL_SWPMI_ERROR_CB_ID = 0x04U, /*!< SWPMI error callback ID */
AnnaBridge 172:65be27845400 141 HAL_SWPMI_MSPINIT_CB_ID = 0x05U, /*!< SWPMI MSP init callback ID */
AnnaBridge 172:65be27845400 142 HAL_SWPMI_MSPDEINIT_CB_ID = 0x06U /*!< SWPMI MSP de-init callback ID */
AnnaBridge 172:65be27845400 143 }HAL_SWPMI_CallbackIDTypeDef;
AnnaBridge 172:65be27845400 144
AnnaBridge 172:65be27845400 145 /**
AnnaBridge 172:65be27845400 146 * @brief SWPMI callback pointer definition
AnnaBridge 172:65be27845400 147 */
AnnaBridge 172:65be27845400 148 typedef void (*pSWPMI_CallbackTypeDef)(SWPMI_HandleTypeDef *hswpmi);
AnnaBridge 172:65be27845400 149 #endif
AnnaBridge 172:65be27845400 150
AnnaBridge 172:65be27845400 151 /**
AnnaBridge 172:65be27845400 152 * @}
AnnaBridge 172:65be27845400 153 */
AnnaBridge 172:65be27845400 154
AnnaBridge 172:65be27845400 155 /* Exported constants --------------------------------------------------------*/
AnnaBridge 172:65be27845400 156 /** @defgroup SWPMI_Exported_Constants SWPMI Exported Constants
AnnaBridge 172:65be27845400 157 * @{
AnnaBridge 172:65be27845400 158 */
AnnaBridge 172:65be27845400 159
AnnaBridge 172:65be27845400 160 /**
AnnaBridge 172:65be27845400 161 * @defgroup SWPMI_Error_Code SWPMI Error Code Bitmap
AnnaBridge 172:65be27845400 162 * @{
AnnaBridge 172:65be27845400 163 */
AnnaBridge 172:65be27845400 164 #define HAL_SWPMI_ERROR_NONE ((uint32_t)0x00000000) /*!< No error */
AnnaBridge 172:65be27845400 165 #define HAL_SWPMI_ERROR_CRC ((uint32_t)0x00000004) /*!< frame error */
AnnaBridge 172:65be27845400 166 #define HAL_SWPMI_ERROR_OVR ((uint32_t)0x00000008) /*!< Overrun error */
AnnaBridge 172:65be27845400 167 #define HAL_SWPMI_ERROR_UDR ((uint32_t)0x0000000C) /*!< Underrun error */
AnnaBridge 172:65be27845400 168 #define HAL_SWPMI_ERROR_DMA ((uint32_t)0x00000010) /*!< DMA transfer error */
AnnaBridge 172:65be27845400 169 #define HAL_SWPMI_ERROR_TIMEOUT ((uint32_t)0x00000020) /*!< Transfer timeout */
AnnaBridge 172:65be27845400 170 #define HAL_SWPMI_ERROR_TXBEF_TIMEOUT ((uint32_t)0x00000040) /*!< End Tx buffer timeout */
AnnaBridge 172:65be27845400 171 #define HAL_SWPMI_ERROR_TRANSCEIVER_NOT_READY ((uint32_t)0x00000080) /*!< Transceiver not ready */
AnnaBridge 172:65be27845400 172 #if (USE_HAL_SWPMI_REGISTER_CALLBACKS == 1)
AnnaBridge 172:65be27845400 173 #define HAL_SWPMI_ERROR_INVALID_CALLBACK ((uint32_t)0x00000100) /*!< Invalid callback error */
AnnaBridge 172:65be27845400 174 #endif
AnnaBridge 172:65be27845400 175 /**
AnnaBridge 172:65be27845400 176 * @}
AnnaBridge 172:65be27845400 177 */
AnnaBridge 172:65be27845400 178
AnnaBridge 172:65be27845400 179 /** @defgroup SWPMI_Voltage_Class SWPMI Voltage Class
AnnaBridge 172:65be27845400 180 * @{
AnnaBridge 172:65be27845400 181 */
AnnaBridge 172:65be27845400 182 #define SWPMI_VOLTAGE_CLASS_C ((uint32_t)0x00000000)
AnnaBridge 172:65be27845400 183 #define SWPMI_VOLTAGE_CLASS_B SWPMI_OR_CLASS
AnnaBridge 172:65be27845400 184 /**
AnnaBridge 172:65be27845400 185 * @}
AnnaBridge 172:65be27845400 186 */
AnnaBridge 172:65be27845400 187
AnnaBridge 172:65be27845400 188 /** @defgroup SWPMI_Tx_Buffering_Mode SWPMI Tx Buffering Mode
AnnaBridge 172:65be27845400 189 * @{
AnnaBridge 172:65be27845400 190 */
AnnaBridge 172:65be27845400 191 #define SWPMI_TX_NO_SOFTWAREBUFFER ((uint32_t)0x00000000)
AnnaBridge 172:65be27845400 192 #define SWPMI_TX_SINGLE_SOFTWAREBUFFER ((uint32_t)0x00000000)
AnnaBridge 172:65be27845400 193 #define SWPMI_TX_MULTI_SOFTWAREBUFFER SWPMI_CR_TXMODE
AnnaBridge 172:65be27845400 194 /**
AnnaBridge 172:65be27845400 195 * @}
AnnaBridge 172:65be27845400 196 */
AnnaBridge 172:65be27845400 197
AnnaBridge 172:65be27845400 198 /** @defgroup SWPMI_Rx_Buffering_Mode SWPMI Rx Buffering Mode
AnnaBridge 172:65be27845400 199 * @{
AnnaBridge 172:65be27845400 200 */
AnnaBridge 172:65be27845400 201 #define SWPMI_RX_NO_SOFTWAREBUFFER ((uint32_t)0x00000000)
AnnaBridge 172:65be27845400 202 #define SWPMI_RX_SINGLE_SOFTWAREBUFFER ((uint32_t)0x00000000)
AnnaBridge 172:65be27845400 203 #define SWPMI_RX_MULTI_SOFTWAREBUFFER SWPMI_CR_RXMODE
AnnaBridge 172:65be27845400 204 /**
AnnaBridge 172:65be27845400 205 * @}
AnnaBridge 172:65be27845400 206 */
AnnaBridge 172:65be27845400 207
AnnaBridge 172:65be27845400 208 /** @defgroup SWPMI_Flags SWPMI Status Flags
AnnaBridge 172:65be27845400 209 * Elements values convention: 0xXXXXXXXX
AnnaBridge 172:65be27845400 210 * - 0xXXXXXXXX : Flag mask in the ISR register
AnnaBridge 172:65be27845400 211 * @{
AnnaBridge 172:65be27845400 212 */
AnnaBridge 172:65be27845400 213 #define SWPMI_FLAG_RXBFF SWPMI_ISR_RXBFF
AnnaBridge 172:65be27845400 214 #define SWPMI_FLAG_TXBEF SWPMI_ISR_TXBEF
AnnaBridge 172:65be27845400 215 #define SWPMI_FLAG_RXBERF SWPMI_ISR_RXBERF
AnnaBridge 172:65be27845400 216 #define SWPMI_FLAG_RXOVRF SWPMI_ISR_RXOVRF
AnnaBridge 172:65be27845400 217 #define SWPMI_FLAG_TXUNRF SWPMI_ISR_TXUNRF
AnnaBridge 172:65be27845400 218 #define SWPMI_FLAG_RXNE SWPMI_ISR_RXNE
AnnaBridge 172:65be27845400 219 #define SWPMI_FLAG_TXE SWPMI_ISR_TXE
AnnaBridge 172:65be27845400 220 #define SWPMI_FLAG_TCF SWPMI_ISR_TCF
AnnaBridge 172:65be27845400 221 #define SWPMI_FLAG_SRF SWPMI_ISR_SRF
AnnaBridge 172:65be27845400 222 #define SWPMI_FLAG_SUSP SWPMI_ISR_SUSP
AnnaBridge 172:65be27845400 223 #define SWPMI_FLAG_DEACTF SWPMI_ISR_DEACTF
AnnaBridge 172:65be27845400 224 #define SWPMI_FLAG_RDYF SWPMI_ISR_RDYF
AnnaBridge 172:65be27845400 225 /**
AnnaBridge 172:65be27845400 226 * @}
AnnaBridge 172:65be27845400 227 */
AnnaBridge 172:65be27845400 228
AnnaBridge 172:65be27845400 229 /** @defgroup SWPMI_Interrupt_definition SWPMI Interrupts Definition
AnnaBridge 172:65be27845400 230 * Elements values convention: 0xXXXX
AnnaBridge 172:65be27845400 231 * - 0xXXXX : Flag mask in the IER register
AnnaBridge 172:65be27845400 232 * @{
AnnaBridge 172:65be27845400 233 */
AnnaBridge 172:65be27845400 234 #define SWPMI_IT_RDYIE SWPMI_IER_RDYIE
AnnaBridge 172:65be27845400 235 #define SWPMI_IT_SRIE SWPMI_IER_SRIE
AnnaBridge 172:65be27845400 236 #define SWPMI_IT_TCIE SWPMI_IER_TCIE
AnnaBridge 172:65be27845400 237 #define SWPMI_IT_TIE SWPMI_IER_TIE
AnnaBridge 172:65be27845400 238 #define SWPMI_IT_RIE SWPMI_IER_RIE
AnnaBridge 172:65be27845400 239 #define SWPMI_IT_TXUNRIE SWPMI_IER_TXUNRIE
AnnaBridge 172:65be27845400 240 #define SWPMI_IT_RXOVRIE SWPMI_IER_RXOVRIE
AnnaBridge 172:65be27845400 241 #define SWPMI_IT_RXBERIE SWPMI_IER_RXBERIE
AnnaBridge 172:65be27845400 242 #define SWPMI_IT_TXBEIE SWPMI_IER_TXBEIE
AnnaBridge 172:65be27845400 243 #define SWPMI_IT_RXBFIE SWPMI_IER_RXBFIE
AnnaBridge 172:65be27845400 244 /**
AnnaBridge 172:65be27845400 245 * @}
AnnaBridge 172:65be27845400 246 */
AnnaBridge 172:65be27845400 247
AnnaBridge 172:65be27845400 248 /**
AnnaBridge 172:65be27845400 249 * @}
AnnaBridge 172:65be27845400 250 */
AnnaBridge 172:65be27845400 251
AnnaBridge 172:65be27845400 252 /* Exported macros -----------------------------------------------------------*/
AnnaBridge 172:65be27845400 253 /** @defgroup SWPMI_Exported_Macros SWPMI Exported Macros
AnnaBridge 172:65be27845400 254 * @{
AnnaBridge 172:65be27845400 255 */
AnnaBridge 172:65be27845400 256
AnnaBridge 172:65be27845400 257 /** @brief Reset SWPMI handle state.
AnnaBridge 172:65be27845400 258 * @param __HANDLE__ specifies the SWPMI Handle.
AnnaBridge 172:65be27845400 259 * @retval None
AnnaBridge 172:65be27845400 260 */
AnnaBridge 172:65be27845400 261 #if (USE_HAL_SWPMI_REGISTER_CALLBACKS == 1)
AnnaBridge 172:65be27845400 262 #define __HAL_SWPMI_RESET_HANDLE_STATE(__HANDLE__) do{ \
AnnaBridge 172:65be27845400 263 (__HANDLE__)->State = HAL_SWPMI_STATE_RESET; \
AnnaBridge 172:65be27845400 264 (__HANDLE__)->MspInitCallback = NULL; \
AnnaBridge 172:65be27845400 265 (__HANDLE__)->MspDeInitCallback = NULL; \
AnnaBridge 172:65be27845400 266 } while(0)
AnnaBridge 172:65be27845400 267 #else
AnnaBridge 172:65be27845400 268 #define __HAL_SWPMI_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_SWPMI_STATE_RESET)
AnnaBridge 172:65be27845400 269 #endif
AnnaBridge 172:65be27845400 270
AnnaBridge 172:65be27845400 271 /**
AnnaBridge 172:65be27845400 272 * @brief Enable the SWPMI peripheral.
AnnaBridge 172:65be27845400 273 * @param __HANDLE__ SWPMI handle
AnnaBridge 172:65be27845400 274 * @retval None
AnnaBridge 172:65be27845400 275 */
AnnaBridge 172:65be27845400 276 #define __HAL_SWPMI_ENABLE(__HANDLE__) SET_BIT((__HANDLE__)->Instance->CR, SWPMI_CR_SWPACT)
AnnaBridge 172:65be27845400 277
AnnaBridge 172:65be27845400 278 /**
AnnaBridge 172:65be27845400 279 * @brief Disable the SWPMI peripheral.
AnnaBridge 172:65be27845400 280 * @param __HANDLE__ SWPMI handle
AnnaBridge 172:65be27845400 281 * @retval None
AnnaBridge 172:65be27845400 282 */
AnnaBridge 172:65be27845400 283 #define __HAL_SWPMI_DISABLE(__HANDLE__) CLEAR_BIT((__HANDLE__)->Instance->CR, SWPMI_CR_SWPACT)
AnnaBridge 172:65be27845400 284
AnnaBridge 172:65be27845400 285 /**
AnnaBridge 172:65be27845400 286 * @brief Enable the SWPMI transceiver.
AnnaBridge 172:65be27845400 287 * @param __HANDLE__ SWPMI handle
AnnaBridge 172:65be27845400 288 * @retval None
AnnaBridge 172:65be27845400 289 */
AnnaBridge 172:65be27845400 290 #define __HAL_SWPMI_TRANSCEIVER_ENABLE(__HANDLE__) SET_BIT((__HANDLE__)->Instance->CR, SWPMI_CR_SWPEN)
AnnaBridge 172:65be27845400 291
AnnaBridge 172:65be27845400 292 /**
AnnaBridge 172:65be27845400 293 * @brief Disable the SWPMI transceiver.
AnnaBridge 172:65be27845400 294 * @param __HANDLE__ SWPMI handle
AnnaBridge 172:65be27845400 295 * @retval None
AnnaBridge 172:65be27845400 296 */
AnnaBridge 172:65be27845400 297 #define __HAL_SWPMI_TRANSCEIVER_DISABLE(__HANDLE__) CLEAR_BIT((__HANDLE__)->Instance->CR, SWPMI_CR_SWPEN)
AnnaBridge 172:65be27845400 298
AnnaBridge 172:65be27845400 299 /** @brief Check whether the specified SWPMI flag is set or not.
AnnaBridge 172:65be27845400 300 * @param __HANDLE__ specifies the SWPMI Handle.
AnnaBridge 172:65be27845400 301 * @param __FLAG__: specifies the flag to check.
AnnaBridge 172:65be27845400 302 * This parameter can be one of the following values:
AnnaBridge 172:65be27845400 303 * @arg SWPMI_FLAG_RXBFF Receive buffer full flag.
AnnaBridge 172:65be27845400 304 * @arg SWPMI_FLAG_TXBEF Transmit buffer empty flag.
AnnaBridge 172:65be27845400 305 * @arg SWPMI_FLAG_RXBERF Receive CRC error flag.
AnnaBridge 172:65be27845400 306 * @arg SWPMI_FLAG_RXOVRF Receive overrun error flag.
AnnaBridge 172:65be27845400 307 * @arg SWPMI_FLAG_TXUNRF Transmit underrun error flag.
AnnaBridge 172:65be27845400 308 * @arg SWPMI_FLAG_RXNE Receive data register not empty.
AnnaBridge 172:65be27845400 309 * @arg SWPMI_FLAG_TXE Transmit data register empty.
AnnaBridge 172:65be27845400 310 * @arg SWPMI_FLAG_TCF Transfer complete flag.
AnnaBridge 172:65be27845400 311 * @arg SWPMI_FLAG_SRF Slave resume flag.
AnnaBridge 172:65be27845400 312 * @arg SWPMI_FLAG_SUSP SUSPEND flag.
AnnaBridge 172:65be27845400 313 * @arg SWPMI_FLAG_DEACTF DEACTIVATED flag.
AnnaBridge 172:65be27845400 314 * @arg SWPMI_FLAG_RDYF Transceiver ready flag.
AnnaBridge 172:65be27845400 315 * @retval The new state of __FLAG__ (TRUE or FALSE).
AnnaBridge 172:65be27845400 316 */
AnnaBridge 172:65be27845400 317 #define __HAL_SWPMI_GET_FLAG(__HANDLE__, __FLAG__) (READ_BIT((__HANDLE__)->Instance->ISR, (__FLAG__)) == (__FLAG__))
AnnaBridge 172:65be27845400 318
AnnaBridge 172:65be27845400 319 /** @brief Clear the specified SWPMI ISR flag.
AnnaBridge 172:65be27845400 320 * @param __HANDLE__ specifies the SWPMI Handle.
AnnaBridge 172:65be27845400 321 * @param __FLAG__: specifies the flag to clear.
AnnaBridge 172:65be27845400 322 * This parameter can be one of the following values:
AnnaBridge 172:65be27845400 323 * @arg SWPMI_FLAG_RXBFF Receive buffer full flag.
AnnaBridge 172:65be27845400 324 * @arg SWPMI_FLAG_TXBEF Transmit buffer empty flag.
AnnaBridge 172:65be27845400 325 * @arg SWPMI_FLAG_RXBERF Receive CRC error flag.
AnnaBridge 172:65be27845400 326 * @arg SWPMI_FLAG_RXOVRF Receive overrun error flag.
AnnaBridge 172:65be27845400 327 * @arg SWPMI_FLAG_TXUNRF Transmit underrun error flag.
AnnaBridge 172:65be27845400 328 * @arg SWPMI_FLAG_TCF Transfer complete flag.
AnnaBridge 172:65be27845400 329 * @arg SWPMI_FLAG_SRF Slave resume flag.
AnnaBridge 172:65be27845400 330 * @arg SWPMI_FLAG_RDYF Transceiver ready flag.
AnnaBridge 172:65be27845400 331 * @retval None
AnnaBridge 172:65be27845400 332 */
AnnaBridge 172:65be27845400 333 #define __HAL_SWPMI_CLEAR_FLAG(__HANDLE__, __FLAG__) WRITE_REG((__HANDLE__)->Instance->ICR, (__FLAG__))
AnnaBridge 172:65be27845400 334
AnnaBridge 172:65be27845400 335 /** @brief Enable the specified SWPMI interrupt.
AnnaBridge 172:65be27845400 336 * @param __HANDLE__ specifies the SWPMI Handle.
AnnaBridge 172:65be27845400 337 * @param __INTERRUPT__ specifies the SWPMI interrupt source to enable.
AnnaBridge 172:65be27845400 338 * This parameter can be one of the following values:
AnnaBridge 172:65be27845400 339 * @arg SWPMI_IT_RDYIE Transceiver ready interrupt.
AnnaBridge 172:65be27845400 340 * @arg SWPMI_IT_SRIE Slave resume interrupt.
AnnaBridge 172:65be27845400 341 * @arg SWPMI_IT_TCIE Transmit complete interrupt.
AnnaBridge 172:65be27845400 342 * @arg SWPMI_IT_TIE Transmit interrupt.
AnnaBridge 172:65be27845400 343 * @arg SWPMI_IT_RIE Receive interrupt.
AnnaBridge 172:65be27845400 344 * @arg SWPMI_IT_TXUNRIE Transmit underrun error interrupt.
AnnaBridge 172:65be27845400 345 * @arg SWPMI_IT_RXOVRIE Receive overrun error interrupt.
AnnaBridge 172:65be27845400 346 * @arg SWPMI_IT_RXBEIE Receive CRC error interrupt.
AnnaBridge 172:65be27845400 347 * @arg SWPMI_IT_TXBEIE Transmit buffer empty interrupt.
AnnaBridge 172:65be27845400 348 * @arg SWPMI_IT_RXBFIE Receive buffer full interrupt.
AnnaBridge 172:65be27845400 349 * @retval None
AnnaBridge 172:65be27845400 350 */
AnnaBridge 172:65be27845400 351 #define __HAL_SWPMI_ENABLE_IT(__HANDLE__, __INTERRUPT__) SET_BIT((__HANDLE__)->Instance->IER, (__INTERRUPT__))
AnnaBridge 172:65be27845400 352
AnnaBridge 172:65be27845400 353 /** @brief Disable the specified SWPMI interrupt.
AnnaBridge 172:65be27845400 354 * @param __HANDLE__ specifies the SWPMI Handle.
AnnaBridge 172:65be27845400 355 * @param __INTERRUPT__ specifies the SWPMI interrupt source to disable.
AnnaBridge 172:65be27845400 356 * This parameter can be one of the following values:
AnnaBridge 172:65be27845400 357 * @arg SWPMI_IT_RDYIE Transceiver ready interrupt.
AnnaBridge 172:65be27845400 358 * @arg SWPMI_IT_SRIE Slave resume interrupt.
AnnaBridge 172:65be27845400 359 * @arg SWPMI_IT_TCIE Transmit complete interrupt.
AnnaBridge 172:65be27845400 360 * @arg SWPMI_IT_TIE Transmit interrupt.
AnnaBridge 172:65be27845400 361 * @arg SWPMI_IT_RIE Receive interrupt.
AnnaBridge 172:65be27845400 362 * @arg SWPMI_IT_TXUNRIE Transmit underrun error interrupt.
AnnaBridge 172:65be27845400 363 * @arg SWPMI_IT_RXOVRIE Receive overrun error interrupt.
AnnaBridge 172:65be27845400 364 * @arg SWPMI_IT_RXBEIE Receive CRC error interrupt.
AnnaBridge 172:65be27845400 365 * @arg SWPMI_IT_TXBEIE Transmit buffer empty interrupt.
AnnaBridge 172:65be27845400 366 * @arg SWPMI_IT_RXBFIE Receive buffer full interrupt.
AnnaBridge 172:65be27845400 367 * @retval None
AnnaBridge 172:65be27845400 368 */
AnnaBridge 172:65be27845400 369 #define __HAL_SWPMI_DISABLE_IT(__HANDLE__, __INTERRUPT__) CLEAR_BIT((__HANDLE__)->Instance->IER, (__INTERRUPT__))
AnnaBridge 172:65be27845400 370
AnnaBridge 172:65be27845400 371 /** @brief Check whether the specified SWPMI interrupt has occurred or not.
AnnaBridge 172:65be27845400 372 * @param __HANDLE__ specifies the SWPMI Handle.
AnnaBridge 172:65be27845400 373 * @param __IT__ specifies the SWPMI interrupt to check.
AnnaBridge 172:65be27845400 374 * This parameter can be one of the following values:
AnnaBridge 172:65be27845400 375 * @arg SWPMI_IT_RDYIE Transceiver ready interrupt.
AnnaBridge 172:65be27845400 376 * @arg SWPMI_IT_SRIE Slave resume interrupt.
AnnaBridge 172:65be27845400 377 * @arg SWPMI_IT_TCIE Transmit complete interrupt.
AnnaBridge 172:65be27845400 378 * @arg SWPMI_IT_TIE Transmit interrupt.
AnnaBridge 172:65be27845400 379 * @arg SWPMI_IT_RIE Receive interrupt.
AnnaBridge 172:65be27845400 380 * @arg SWPMI_IT_TXUNRIE Transmit underrun error interrupt.
AnnaBridge 172:65be27845400 381 * @arg SWPMI_IT_RXOVRIE Receive overrun error interrupt.
AnnaBridge 172:65be27845400 382 * @arg SWPMI_IT_RXBERIE Receive CRC error interrupt.
AnnaBridge 172:65be27845400 383 * @arg SWPMI_IT_TXBEIE Transmit buffer empty interrupt.
AnnaBridge 172:65be27845400 384 * @arg SWPMI_IT_RXBFIE Receive buffer full interrupt.
AnnaBridge 172:65be27845400 385 * @retval The new state of __IT__ (TRUE or FALSE).
AnnaBridge 172:65be27845400 386 */
AnnaBridge 172:65be27845400 387 #define __HAL_SWPMI_GET_IT(__HANDLE__, __IT__) (READ_BIT((__HANDLE__)->Instance->ISR,(__IT__)) == (__IT__))
AnnaBridge 172:65be27845400 388
AnnaBridge 172:65be27845400 389 /** @brief Check whether the specified SWPMI interrupt source is enabled or not.
AnnaBridge 172:65be27845400 390 * @param __HANDLE__ specifies the SWPMI Handle.
AnnaBridge 172:65be27845400 391 * @param __IT__ specifies the SWPMI interrupt source to check.
AnnaBridge 172:65be27845400 392 * This parameter can be one of the following values:
AnnaBridge 172:65be27845400 393 * @arg SWPMI_IT_RDYIE Transceiver ready interrupt.
AnnaBridge 172:65be27845400 394 * @arg SWPMI_IT_SRIE Slave resume interrupt.
AnnaBridge 172:65be27845400 395 * @arg SWPMI_IT_TCIE Transmit complete interrupt.
AnnaBridge 172:65be27845400 396 * @arg SWPMI_IT_TIE Transmit interrupt.
AnnaBridge 172:65be27845400 397 * @arg SWPMI_IT_RIE Receive interrupt.
AnnaBridge 172:65be27845400 398 * @arg SWPMI_IT_TXUNRIE Transmit underrun error interrupt.
AnnaBridge 172:65be27845400 399 * @arg SWPMI_IT_RXOVRIE Receive overrun error interrupt.
AnnaBridge 172:65be27845400 400 * @arg SWPMI_IT_RXBERIE Receive CRC error interrupt.
AnnaBridge 172:65be27845400 401 * @arg SWPMI_IT_TXBEIE Transmit buffer empty interrupt.
AnnaBridge 172:65be27845400 402 * @arg SWPMI_IT_RXBFIE Receive buffer full interrupt.
AnnaBridge 172:65be27845400 403 * @retval The new state of __IT__ (TRUE or FALSE).
AnnaBridge 172:65be27845400 404 */
AnnaBridge 172:65be27845400 405 #define __HAL_SWPMI_GET_IT_SOURCE(__HANDLE__, __IT__) ((READ_BIT((__HANDLE__)->Instance->IER, (__IT__)) == (__IT__)) ? SET : RESET)
AnnaBridge 172:65be27845400 406
AnnaBridge 172:65be27845400 407 /**
AnnaBridge 172:65be27845400 408 * @}
AnnaBridge 172:65be27845400 409 */
AnnaBridge 172:65be27845400 410
AnnaBridge 172:65be27845400 411 /* Exported functions --------------------------------------------------------*/
AnnaBridge 172:65be27845400 412 /** @defgroup SWPMI_Exported_Functions SWPMI Exported Functions
AnnaBridge 172:65be27845400 413 * @{
AnnaBridge 172:65be27845400 414 */
AnnaBridge 172:65be27845400 415 /* Initialization/de-initialization functions ********************************/
AnnaBridge 172:65be27845400 416 HAL_StatusTypeDef HAL_SWPMI_Init(SWPMI_HandleTypeDef *hswpmi);
AnnaBridge 172:65be27845400 417 HAL_StatusTypeDef HAL_SWPMI_DeInit(SWPMI_HandleTypeDef *hswpmi);
AnnaBridge 172:65be27845400 418 void HAL_SWPMI_MspInit(SWPMI_HandleTypeDef *hswpmi);
AnnaBridge 172:65be27845400 419 void HAL_SWPMI_MspDeInit(SWPMI_HandleTypeDef *hswpmi);
AnnaBridge 172:65be27845400 420
AnnaBridge 172:65be27845400 421 #if (USE_HAL_SWPMI_REGISTER_CALLBACKS == 1)
AnnaBridge 172:65be27845400 422 /* SWPMI callbacks register/unregister functions ********************************/
AnnaBridge 172:65be27845400 423 HAL_StatusTypeDef HAL_SWPMI_RegisterCallback(SWPMI_HandleTypeDef *hswpmi,
AnnaBridge 172:65be27845400 424 HAL_SWPMI_CallbackIDTypeDef CallbackID,
AnnaBridge 172:65be27845400 425 pSWPMI_CallbackTypeDef pCallback);
AnnaBridge 172:65be27845400 426 HAL_StatusTypeDef HAL_SWPMI_UnRegisterCallback(SWPMI_HandleTypeDef *hswpmi,
AnnaBridge 172:65be27845400 427 HAL_SWPMI_CallbackIDTypeDef CallbackID);
AnnaBridge 172:65be27845400 428 #endif
AnnaBridge 172:65be27845400 429
AnnaBridge 172:65be27845400 430 /* IO operation functions *****************************************************/
AnnaBridge 172:65be27845400 431 HAL_StatusTypeDef HAL_SWPMI_Transmit(SWPMI_HandleTypeDef *hswpmi, uint32_t *pData, uint16_t Size, uint32_t Timeout);
AnnaBridge 172:65be27845400 432 HAL_StatusTypeDef HAL_SWPMI_Receive(SWPMI_HandleTypeDef *hswpmi, uint32_t *pData, uint16_t Size, uint32_t Timeout);
AnnaBridge 172:65be27845400 433 HAL_StatusTypeDef HAL_SWPMI_Transmit_IT(SWPMI_HandleTypeDef *hswpmi, uint32_t *pData, uint16_t Size);
AnnaBridge 172:65be27845400 434 HAL_StatusTypeDef HAL_SWPMI_Receive_IT(SWPMI_HandleTypeDef *hswpmi, uint32_t *pData, uint16_t Size);
AnnaBridge 172:65be27845400 435 HAL_StatusTypeDef HAL_SWPMI_Transmit_DMA(SWPMI_HandleTypeDef *hswpmi, uint32_t *pData, uint16_t Size);
AnnaBridge 172:65be27845400 436 HAL_StatusTypeDef HAL_SWPMI_Receive_DMA(SWPMI_HandleTypeDef *hswpmi, uint32_t *pData, uint16_t Size);
AnnaBridge 172:65be27845400 437 HAL_StatusTypeDef HAL_SWPMI_DMAStop(SWPMI_HandleTypeDef *hswpmi);
AnnaBridge 172:65be27845400 438 HAL_StatusTypeDef HAL_SWPMI_EnableLoopback(SWPMI_HandleTypeDef *hswpmi);
AnnaBridge 172:65be27845400 439 HAL_StatusTypeDef HAL_SWPMI_DisableLoopback(SWPMI_HandleTypeDef *hswpmi);
AnnaBridge 172:65be27845400 440 void HAL_SWPMI_IRQHandler(SWPMI_HandleTypeDef *hswpmi);
AnnaBridge 172:65be27845400 441 void HAL_SWPMI_TxCpltCallback(SWPMI_HandleTypeDef *hswpmi);
AnnaBridge 172:65be27845400 442 void HAL_SWPMI_TxHalfCpltCallback(SWPMI_HandleTypeDef *hswpmi);
AnnaBridge 172:65be27845400 443 void HAL_SWPMI_RxCpltCallback(SWPMI_HandleTypeDef *hswpmi);
AnnaBridge 172:65be27845400 444 void HAL_SWPMI_RxHalfCpltCallback(SWPMI_HandleTypeDef *hswpmi);
AnnaBridge 172:65be27845400 445 void HAL_SWPMI_ErrorCallback(SWPMI_HandleTypeDef *hswpmi);
AnnaBridge 172:65be27845400 446
AnnaBridge 172:65be27845400 447 /* Peripheral Control and State functions ************************************/
AnnaBridge 172:65be27845400 448 HAL_SWPMI_StateTypeDef HAL_SWPMI_GetState(SWPMI_HandleTypeDef *hswpmi);
AnnaBridge 172:65be27845400 449 uint32_t HAL_SWPMI_GetError(SWPMI_HandleTypeDef *hswpmi);
AnnaBridge 172:65be27845400 450
AnnaBridge 172:65be27845400 451 /**
AnnaBridge 172:65be27845400 452 * @}
AnnaBridge 172:65be27845400 453 */
AnnaBridge 172:65be27845400 454
AnnaBridge 172:65be27845400 455 /* Private types -------------------------------------------------------------*/
AnnaBridge 172:65be27845400 456 /** @defgroup SWPMI_Private_Types SWPMI Private Types
AnnaBridge 172:65be27845400 457 * @{
AnnaBridge 172:65be27845400 458 */
AnnaBridge 172:65be27845400 459
AnnaBridge 172:65be27845400 460 /**
AnnaBridge 172:65be27845400 461 * @}
AnnaBridge 172:65be27845400 462 */
AnnaBridge 172:65be27845400 463
AnnaBridge 172:65be27845400 464 /* Private variables ---------------------------------------------------------*/
AnnaBridge 172:65be27845400 465 /** @defgroup SWPMI_Private_Variables SWPMI Private Variables
AnnaBridge 172:65be27845400 466 * @{
AnnaBridge 172:65be27845400 467 */
AnnaBridge 172:65be27845400 468
AnnaBridge 172:65be27845400 469 /**
AnnaBridge 172:65be27845400 470 * @}
AnnaBridge 172:65be27845400 471 */
AnnaBridge 172:65be27845400 472
AnnaBridge 172:65be27845400 473 /* Private constants ---------------------------------------------------------*/
AnnaBridge 172:65be27845400 474 /** @defgroup SWPMI_Private_Constants SWPMI Private Constants
AnnaBridge 172:65be27845400 475 * @{
AnnaBridge 172:65be27845400 476 */
AnnaBridge 172:65be27845400 477
AnnaBridge 172:65be27845400 478 /**
AnnaBridge 172:65be27845400 479 * @}
AnnaBridge 172:65be27845400 480 */
AnnaBridge 172:65be27845400 481
AnnaBridge 172:65be27845400 482 /* Private macros ------------------------------------------------------------*/
AnnaBridge 172:65be27845400 483 /** @defgroup SWPMI_Private_Macros SWPMI Private Macros
AnnaBridge 172:65be27845400 484 * @{
AnnaBridge 172:65be27845400 485 */
AnnaBridge 172:65be27845400 486
AnnaBridge 172:65be27845400 487
AnnaBridge 172:65be27845400 488 #define IS_SWPMI_VOLTAGE_CLASS(__CLASS__) (((__CLASS__) == SWPMI_VOLTAGE_CLASS_C) || \
AnnaBridge 172:65be27845400 489 ((__CLASS__) == SWPMI_VOLTAGE_CLASS_B))
AnnaBridge 172:65be27845400 490
AnnaBridge 172:65be27845400 491 #define IS_SWPMI_BITRATE_VALUE(__VALUE__) (((__VALUE__) <= 255U))
AnnaBridge 172:65be27845400 492
AnnaBridge 172:65be27845400 493
AnnaBridge 172:65be27845400 494 #define IS_SWPMI_TX_BUFFERING_MODE(__MODE__) (((__MODE__) == SWPMI_TX_NO_SOFTWAREBUFFER) || \
AnnaBridge 172:65be27845400 495 ((__MODE__) == SWPMI_TX_MULTI_SOFTWAREBUFFER))
AnnaBridge 172:65be27845400 496
AnnaBridge 172:65be27845400 497
AnnaBridge 172:65be27845400 498 #define IS_SWPMI_RX_BUFFERING_MODE(__MODE__) (((__MODE__) == SWPMI_RX_NO_SOFTWAREBUFFER) || \
AnnaBridge 172:65be27845400 499 ((__MODE__) == SWPMI_RX_MULTI_SOFTWAREBUFFER))
AnnaBridge 172:65be27845400 500
AnnaBridge 172:65be27845400 501 /**
AnnaBridge 172:65be27845400 502 * @}
AnnaBridge 172:65be27845400 503 */
AnnaBridge 172:65be27845400 504
AnnaBridge 172:65be27845400 505 /**
AnnaBridge 172:65be27845400 506 * @}
AnnaBridge 172:65be27845400 507 */
AnnaBridge 172:65be27845400 508
AnnaBridge 172:65be27845400 509
AnnaBridge 172:65be27845400 510 /**
AnnaBridge 172:65be27845400 511 * @}
AnnaBridge 172:65be27845400 512 */
AnnaBridge 172:65be27845400 513
AnnaBridge 172:65be27845400 514 #ifdef __cplusplus
AnnaBridge 172:65be27845400 515 }
AnnaBridge 172:65be27845400 516 #endif
AnnaBridge 172:65be27845400 517
AnnaBridge 172:65be27845400 518 #endif /* STM32H7xx_HAL_SWPMI_H */
AnnaBridge 172:65be27845400 519
AnnaBridge 172:65be27845400 520 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/