Fork of the official mbed C/C SDK provides the software platform and libraries to build your applications for RenBED.

Dependents:   1-RenBuggyTimed RenBED_RGB RenBED_RGB_PWM RenBED_RGB

Fork of mbed by mbed official

Committer:
Kojto
Date:
Wed May 13 08:08:21 2015 +0200
Revision:
99:dbbf35b96557
Parent:
90:cb3d968589d8
Child:
106:ba1f97679dad
Release 99 of the mbed library

Changes:
- new targets - MAXWSNENV, DISCO_L053C8
- STM32F4xx - ST Cube driver
- KSDK mcu - SPI timing fix
- Nordic - update to softdevice s130

Who changed what in which revision?

UserRevisionLine numberNew contents of line
emilmont 77:869cf507173a 1 /**
emilmont 77:869cf507173a 2 ******************************************************************************
emilmont 77:869cf507173a 3 * @file stm32f4xx_hal_spi.h
emilmont 77:869cf507173a 4 * @author MCD Application Team
Kojto 99:dbbf35b96557 5 * @version V1.3.0
Kojto 99:dbbf35b96557 6 * @date 09-March-2015
emilmont 77:869cf507173a 7 * @brief Header file of SPI HAL module.
emilmont 77:869cf507173a 8 ******************************************************************************
emilmont 77:869cf507173a 9 * @attention
emilmont 77:869cf507173a 10 *
Kojto 99:dbbf35b96557 11 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
emilmont 77:869cf507173a 12 *
emilmont 77:869cf507173a 13 * Redistribution and use in source and binary forms, with or without modification,
emilmont 77:869cf507173a 14 * are permitted provided that the following conditions are met:
emilmont 77:869cf507173a 15 * 1. Redistributions of source code must retain the above copyright notice,
emilmont 77:869cf507173a 16 * this list of conditions and the following disclaimer.
emilmont 77:869cf507173a 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
emilmont 77:869cf507173a 18 * this list of conditions and the following disclaimer in the documentation
emilmont 77:869cf507173a 19 * and/or other materials provided with the distribution.
emilmont 77:869cf507173a 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
emilmont 77:869cf507173a 21 * may be used to endorse or promote products derived from this software
emilmont 77:869cf507173a 22 * without specific prior written permission.
emilmont 77:869cf507173a 23 *
emilmont 77:869cf507173a 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
emilmont 77:869cf507173a 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
emilmont 77:869cf507173a 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
emilmont 77:869cf507173a 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
emilmont 77:869cf507173a 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
emilmont 77:869cf507173a 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
emilmont 77:869cf507173a 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
emilmont 77:869cf507173a 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
emilmont 77:869cf507173a 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
emilmont 77:869cf507173a 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
emilmont 77:869cf507173a 34 *
emilmont 77:869cf507173a 35 ******************************************************************************
emilmont 77:869cf507173a 36 */
emilmont 77:869cf507173a 37
emilmont 77:869cf507173a 38 /* Define to prevent recursive inclusion -------------------------------------*/
emilmont 77:869cf507173a 39 #ifndef __STM32F4xx_HAL_SPI_H
emilmont 77:869cf507173a 40 #define __STM32F4xx_HAL_SPI_H
emilmont 77:869cf507173a 41
emilmont 77:869cf507173a 42 #ifdef __cplusplus
emilmont 77:869cf507173a 43 extern "C" {
emilmont 77:869cf507173a 44 #endif
emilmont 77:869cf507173a 45
emilmont 77:869cf507173a 46 /* Includes ------------------------------------------------------------------*/
emilmont 77:869cf507173a 47 #include "stm32f4xx_hal_def.h"
emilmont 77:869cf507173a 48
emilmont 77:869cf507173a 49 /** @addtogroup STM32F4xx_HAL_Driver
emilmont 77:869cf507173a 50 * @{
emilmont 77:869cf507173a 51 */
emilmont 77:869cf507173a 52
emilmont 77:869cf507173a 53 /** @addtogroup SPI
emilmont 77:869cf507173a 54 * @{
emilmont 77:869cf507173a 55 */
emilmont 77:869cf507173a 56
emilmont 77:869cf507173a 57 /* Exported types ------------------------------------------------------------*/
Kojto 99:dbbf35b96557 58 /** @defgroup SPI_Exported_Types SPI Exported Types
Kojto 99:dbbf35b96557 59 * @{
Kojto 99:dbbf35b96557 60 */
Kojto 99:dbbf35b96557 61
emilmont 77:869cf507173a 62 /**
emilmont 77:869cf507173a 63 * @brief SPI Configuration Structure definition
emilmont 77:869cf507173a 64 */
emilmont 77:869cf507173a 65 typedef struct
emilmont 77:869cf507173a 66 {
emilmont 77:869cf507173a 67 uint32_t Mode; /*!< Specifies the SPI operating mode.
emilmont 77:869cf507173a 68 This parameter can be a value of @ref SPI_mode */
emilmont 77:869cf507173a 69
emilmont 77:869cf507173a 70 uint32_t Direction; /*!< Specifies the SPI Directional mode state.
emilmont 77:869cf507173a 71 This parameter can be a value of @ref SPI_Direction_mode */
emilmont 77:869cf507173a 72
emilmont 77:869cf507173a 73 uint32_t DataSize; /*!< Specifies the SPI data size.
emilmont 77:869cf507173a 74 This parameter can be a value of @ref SPI_data_size */
emilmont 77:869cf507173a 75
emilmont 77:869cf507173a 76 uint32_t CLKPolarity; /*!< Specifies the serial clock steady state.
emilmont 77:869cf507173a 77 This parameter can be a value of @ref SPI_Clock_Polarity */
emilmont 77:869cf507173a 78
emilmont 77:869cf507173a 79 uint32_t CLKPhase; /*!< Specifies the clock active edge for the bit capture.
emilmont 77:869cf507173a 80 This parameter can be a value of @ref SPI_Clock_Phase */
emilmont 77:869cf507173a 81
emilmont 77:869cf507173a 82 uint32_t NSS; /*!< Specifies whether the NSS signal is managed by
emilmont 77:869cf507173a 83 hardware (NSS pin) or by software using the SSI bit.
emilmont 77:869cf507173a 84 This parameter can be a value of @ref SPI_Slave_Select_management */
emilmont 77:869cf507173a 85
emilmont 77:869cf507173a 86 uint32_t BaudRatePrescaler; /*!< Specifies the Baud Rate prescaler value which will be
emilmont 77:869cf507173a 87 used to configure the transmit and receive SCK clock.
emilmont 77:869cf507173a 88 This parameter can be a value of @ref SPI_BaudRate_Prescaler
emilmont 77:869cf507173a 89 @note The communication clock is derived from the master
emilmont 77:869cf507173a 90 clock. The slave clock does not need to be set */
emilmont 77:869cf507173a 91
emilmont 77:869cf507173a 92 uint32_t FirstBit; /*!< Specifies whether data transfers start from MSB or LSB bit.
emilmont 77:869cf507173a 93 This parameter can be a value of @ref SPI_MSB_LSB_transmission */
emilmont 77:869cf507173a 94
emilmont 77:869cf507173a 95 uint32_t TIMode; /*!< Specifies if the TI mode is enabled or not.
emilmont 77:869cf507173a 96 This parameter can be a value of @ref SPI_TI_mode */
emilmont 77:869cf507173a 97
emilmont 77:869cf507173a 98 uint32_t CRCCalculation; /*!< Specifies if the CRC calculation is enabled or not.
emilmont 77:869cf507173a 99 This parameter can be a value of @ref SPI_CRC_Calculation */
emilmont 77:869cf507173a 100
emilmont 77:869cf507173a 101 uint32_t CRCPolynomial; /*!< Specifies the polynomial used for the CRC calculation.
emilmont 77:869cf507173a 102 This parameter must be a number between Min_Data = 0 and Max_Data = 65535 */
emilmont 77:869cf507173a 103
emilmont 77:869cf507173a 104 }SPI_InitTypeDef;
emilmont 77:869cf507173a 105
emilmont 77:869cf507173a 106 /**
emilmont 77:869cf507173a 107 * @brief HAL SPI State structure definition
emilmont 77:869cf507173a 108 */
emilmont 77:869cf507173a 109 typedef enum
emilmont 77:869cf507173a 110 {
emilmont 77:869cf507173a 111 HAL_SPI_STATE_RESET = 0x00, /*!< SPI not yet initialized or disabled */
emilmont 77:869cf507173a 112 HAL_SPI_STATE_READY = 0x01, /*!< SPI initialized and ready for use */
emilmont 77:869cf507173a 113 HAL_SPI_STATE_BUSY = 0x02, /*!< SPI process is ongoing */
emilmont 77:869cf507173a 114 HAL_SPI_STATE_BUSY_TX = 0x12, /*!< Data Transmission process is ongoing */
emilmont 77:869cf507173a 115 HAL_SPI_STATE_BUSY_RX = 0x22, /*!< Data Reception process is ongoing */
emilmont 77:869cf507173a 116 HAL_SPI_STATE_BUSY_TX_RX = 0x32, /*!< Data Transmission and Reception process is ongoing */
emilmont 77:869cf507173a 117 HAL_SPI_STATE_ERROR = 0x03 /*!< SPI error state */
emilmont 77:869cf507173a 118
emilmont 77:869cf507173a 119 }HAL_SPI_StateTypeDef;
emilmont 77:869cf507173a 120
emilmont 77:869cf507173a 121 /**
emilmont 77:869cf507173a 122 * @brief SPI handle Structure definition
emilmont 77:869cf507173a 123 */
emilmont 77:869cf507173a 124 typedef struct __SPI_HandleTypeDef
emilmont 77:869cf507173a 125 {
emilmont 77:869cf507173a 126 SPI_TypeDef *Instance; /* SPI registers base address */
emilmont 77:869cf507173a 127
emilmont 77:869cf507173a 128 SPI_InitTypeDef Init; /* SPI communication parameters */
emilmont 77:869cf507173a 129
emilmont 77:869cf507173a 130 uint8_t *pTxBuffPtr; /* Pointer to SPI Tx transfer Buffer */
emilmont 77:869cf507173a 131
emilmont 77:869cf507173a 132 uint16_t TxXferSize; /* SPI Tx transfer size */
emilmont 77:869cf507173a 133
emilmont 77:869cf507173a 134 uint16_t TxXferCount; /* SPI Tx Transfer Counter */
emilmont 77:869cf507173a 135
emilmont 77:869cf507173a 136 uint8_t *pRxBuffPtr; /* Pointer to SPI Rx transfer Buffer */
emilmont 77:869cf507173a 137
emilmont 77:869cf507173a 138 uint16_t RxXferSize; /* SPI Rx transfer size */
emilmont 77:869cf507173a 139
emilmont 77:869cf507173a 140 uint16_t RxXferCount; /* SPI Rx Transfer Counter */
emilmont 77:869cf507173a 141
emilmont 77:869cf507173a 142 DMA_HandleTypeDef *hdmatx; /* SPI Tx DMA handle parameters */
emilmont 77:869cf507173a 143
emilmont 77:869cf507173a 144 DMA_HandleTypeDef *hdmarx; /* SPI Rx DMA handle parameters */
emilmont 77:869cf507173a 145
emilmont 77:869cf507173a 146 void (*RxISR)(struct __SPI_HandleTypeDef * hspi); /* function pointer on Rx ISR */
emilmont 77:869cf507173a 147
emilmont 77:869cf507173a 148 void (*TxISR)(struct __SPI_HandleTypeDef * hspi); /* function pointer on Tx ISR */
emilmont 77:869cf507173a 149
emilmont 77:869cf507173a 150 HAL_LockTypeDef Lock; /* SPI locking object */
emilmont 77:869cf507173a 151
emilmont 77:869cf507173a 152 __IO HAL_SPI_StateTypeDef State; /* SPI communication state */
emilmont 77:869cf507173a 153
Kojto 99:dbbf35b96557 154 __IO uint32_t ErrorCode; /* SPI Error code */
emilmont 77:869cf507173a 155
emilmont 77:869cf507173a 156 }SPI_HandleTypeDef;
Kojto 99:dbbf35b96557 157 /**
Kojto 99:dbbf35b96557 158 * @}
Kojto 99:dbbf35b96557 159 */
emilmont 77:869cf507173a 160
emilmont 77:869cf507173a 161 /* Exported constants --------------------------------------------------------*/
Kojto 99:dbbf35b96557 162 /** @defgroup SPI_Exported_Constants SPI Exported Constants
emilmont 77:869cf507173a 163 * @{
emilmont 77:869cf507173a 164 */
emilmont 77:869cf507173a 165
Kojto 99:dbbf35b96557 166 /** @defgroup SPI_Error_Code SPI Error Code
Kojto 99:dbbf35b96557 167 * @brief SPI Error Code
Kojto 99:dbbf35b96557 168 * @{
Kojto 99:dbbf35b96557 169 */
Kojto 99:dbbf35b96557 170 #define HAL_SPI_ERROR_NONE ((uint32_t)0x00000000) /*!< No error */
Kojto 99:dbbf35b96557 171 #define HAL_SPI_ERROR_MODF ((uint32_t)0x00000001) /*!< MODF error */
Kojto 99:dbbf35b96557 172 #define HAL_SPI_ERROR_CRC ((uint32_t)0x00000002) /*!< CRC error */
Kojto 99:dbbf35b96557 173 #define HAL_SPI_ERROR_OVR ((uint32_t)0x00000004) /*!< OVR error */
Kojto 99:dbbf35b96557 174 #define HAL_SPI_ERROR_FRE ((uint32_t)0x00000008) /*!< FRE error */
Kojto 99:dbbf35b96557 175 #define HAL_SPI_ERROR_DMA ((uint32_t)0x00000010) /*!< DMA transfer error */
Kojto 99:dbbf35b96557 176 #define HAL_SPI_ERROR_FLAG ((uint32_t)0x00000010) /*!< Flag: RXNE,TXE, BSY */
Kojto 99:dbbf35b96557 177 /**
Kojto 99:dbbf35b96557 178 * @}
Kojto 99:dbbf35b96557 179 */
Kojto 99:dbbf35b96557 180
Kojto 99:dbbf35b96557 181 /** @defgroup SPI_mode SPI Mode
emilmont 77:869cf507173a 182 * @{
emilmont 77:869cf507173a 183 */
emilmont 77:869cf507173a 184 #define SPI_MODE_SLAVE ((uint32_t)0x00000000)
emilmont 77:869cf507173a 185 #define SPI_MODE_MASTER (SPI_CR1_MSTR | SPI_CR1_SSI)
emilmont 77:869cf507173a 186 /**
emilmont 77:869cf507173a 187 * @}
emilmont 77:869cf507173a 188 */
emilmont 77:869cf507173a 189
Kojto 99:dbbf35b96557 190 /** @defgroup SPI_Direction_mode SPI Direction Mode
emilmont 77:869cf507173a 191 * @{
emilmont 77:869cf507173a 192 */
emilmont 77:869cf507173a 193 #define SPI_DIRECTION_2LINES ((uint32_t)0x00000000)
emilmont 77:869cf507173a 194 #define SPI_DIRECTION_2LINES_RXONLY SPI_CR1_RXONLY
emilmont 77:869cf507173a 195 #define SPI_DIRECTION_1LINE SPI_CR1_BIDIMODE
emilmont 77:869cf507173a 196 /**
emilmont 77:869cf507173a 197 * @}
emilmont 77:869cf507173a 198 */
emilmont 77:869cf507173a 199
Kojto 99:dbbf35b96557 200 /** @defgroup SPI_data_size SPI Data Size
emilmont 77:869cf507173a 201 * @{
emilmont 77:869cf507173a 202 */
emilmont 77:869cf507173a 203 #define SPI_DATASIZE_8BIT ((uint32_t)0x00000000)
emilmont 77:869cf507173a 204 #define SPI_DATASIZE_16BIT SPI_CR1_DFF
emilmont 77:869cf507173a 205 /**
emilmont 77:869cf507173a 206 * @}
emilmont 77:869cf507173a 207 */
emilmont 77:869cf507173a 208
Kojto 99:dbbf35b96557 209 /** @defgroup SPI_Clock_Polarity SPI Clock Polarity
emilmont 77:869cf507173a 210 * @{
emilmont 77:869cf507173a 211 */
emilmont 77:869cf507173a 212 #define SPI_POLARITY_LOW ((uint32_t)0x00000000)
emilmont 77:869cf507173a 213 #define SPI_POLARITY_HIGH SPI_CR1_CPOL
emilmont 77:869cf507173a 214 /**
emilmont 77:869cf507173a 215 * @}
emilmont 77:869cf507173a 216 */
emilmont 77:869cf507173a 217
Kojto 99:dbbf35b96557 218 /** @defgroup SPI_Clock_Phase SPI Clock Phase
emilmont 77:869cf507173a 219 * @{
emilmont 77:869cf507173a 220 */
emilmont 77:869cf507173a 221 #define SPI_PHASE_1EDGE ((uint32_t)0x00000000)
emilmont 77:869cf507173a 222 #define SPI_PHASE_2EDGE SPI_CR1_CPHA
emilmont 77:869cf507173a 223 /**
emilmont 77:869cf507173a 224 * @}
emilmont 77:869cf507173a 225 */
emilmont 77:869cf507173a 226
Kojto 99:dbbf35b96557 227 /** @defgroup SPI_Slave_Select_management SPI Slave Select Management
emilmont 77:869cf507173a 228 * @{
emilmont 77:869cf507173a 229 */
emilmont 77:869cf507173a 230 #define SPI_NSS_SOFT SPI_CR1_SSM
emilmont 77:869cf507173a 231 #define SPI_NSS_HARD_INPUT ((uint32_t)0x00000000)
emilmont 77:869cf507173a 232 #define SPI_NSS_HARD_OUTPUT ((uint32_t)0x00040000)
emilmont 77:869cf507173a 233 /**
emilmont 77:869cf507173a 234 * @}
emilmont 77:869cf507173a 235 */
emilmont 77:869cf507173a 236
Kojto 99:dbbf35b96557 237 /** @defgroup SPI_BaudRate_Prescaler SPI BaudRate Prescaler
emilmont 77:869cf507173a 238 * @{
emilmont 77:869cf507173a 239 */
emilmont 77:869cf507173a 240 #define SPI_BAUDRATEPRESCALER_2 ((uint32_t)0x00000000)
emilmont 77:869cf507173a 241 #define SPI_BAUDRATEPRESCALER_4 ((uint32_t)0x00000008)
emilmont 77:869cf507173a 242 #define SPI_BAUDRATEPRESCALER_8 ((uint32_t)0x00000010)
emilmont 77:869cf507173a 243 #define SPI_BAUDRATEPRESCALER_16 ((uint32_t)0x00000018)
emilmont 77:869cf507173a 244 #define SPI_BAUDRATEPRESCALER_32 ((uint32_t)0x00000020)
emilmont 77:869cf507173a 245 #define SPI_BAUDRATEPRESCALER_64 ((uint32_t)0x00000028)
emilmont 77:869cf507173a 246 #define SPI_BAUDRATEPRESCALER_128 ((uint32_t)0x00000030)
emilmont 77:869cf507173a 247 #define SPI_BAUDRATEPRESCALER_256 ((uint32_t)0x00000038)
emilmont 77:869cf507173a 248 /**
emilmont 77:869cf507173a 249 * @}
emilmont 77:869cf507173a 250 */
emilmont 77:869cf507173a 251
Kojto 99:dbbf35b96557 252 /** @defgroup SPI_MSB_LSB_transmission SPI MSB LSB Transsmission
emilmont 77:869cf507173a 253 * @{
emilmont 77:869cf507173a 254 */
emilmont 77:869cf507173a 255 #define SPI_FIRSTBIT_MSB ((uint32_t)0x00000000)
emilmont 77:869cf507173a 256 #define SPI_FIRSTBIT_LSB SPI_CR1_LSBFIRST
emilmont 77:869cf507173a 257 /**
emilmont 77:869cf507173a 258 * @}
emilmont 77:869cf507173a 259 */
emilmont 77:869cf507173a 260
Kojto 99:dbbf35b96557 261 /** @defgroup SPI_TI_mode SPI TI Mode
emilmont 77:869cf507173a 262 * @{
emilmont 77:869cf507173a 263 */
Kojto 99:dbbf35b96557 264 #define SPI_TIMODE_DISABLE ((uint32_t)0x00000000)
Kojto 99:dbbf35b96557 265 #define SPI_TIMODE_ENABLE SPI_CR2_FRF
emilmont 77:869cf507173a 266 /**
emilmont 77:869cf507173a 267 * @}
emilmont 77:869cf507173a 268 */
emilmont 77:869cf507173a 269
Kojto 99:dbbf35b96557 270 /** @defgroup SPI_CRC_Calculation SPI CRC Calculation
emilmont 77:869cf507173a 271 * @{
emilmont 77:869cf507173a 272 */
Kojto 99:dbbf35b96557 273 #define SPI_CRCCALCULATION_DISABLE ((uint32_t)0x00000000)
Kojto 99:dbbf35b96557 274 #define SPI_CRCCALCULATION_ENABLE SPI_CR1_CRCEN
emilmont 77:869cf507173a 275 /**
emilmont 77:869cf507173a 276 * @}
emilmont 77:869cf507173a 277 */
emilmont 77:869cf507173a 278
Kojto 99:dbbf35b96557 279 /** @defgroup SPI_Interrupt_definition SPI Interrupt Definition
emilmont 77:869cf507173a 280 * @{
emilmont 77:869cf507173a 281 */
emilmont 77:869cf507173a 282 #define SPI_IT_TXE SPI_CR2_TXEIE
emilmont 77:869cf507173a 283 #define SPI_IT_RXNE SPI_CR2_RXNEIE
emilmont 77:869cf507173a 284 #define SPI_IT_ERR SPI_CR2_ERRIE
emilmont 77:869cf507173a 285 /**
emilmont 77:869cf507173a 286 * @}
emilmont 77:869cf507173a 287 */
emilmont 77:869cf507173a 288
Kojto 99:dbbf35b96557 289 /** @defgroup SPI_Flags_definition SPI Flags Definition
emilmont 77:869cf507173a 290 * @{
emilmont 77:869cf507173a 291 */
emilmont 77:869cf507173a 292 #define SPI_FLAG_RXNE SPI_SR_RXNE
emilmont 77:869cf507173a 293 #define SPI_FLAG_TXE SPI_SR_TXE
emilmont 77:869cf507173a 294 #define SPI_FLAG_CRCERR SPI_SR_CRCERR
emilmont 77:869cf507173a 295 #define SPI_FLAG_MODF SPI_SR_MODF
emilmont 77:869cf507173a 296 #define SPI_FLAG_OVR SPI_SR_OVR
emilmont 77:869cf507173a 297 #define SPI_FLAG_BSY SPI_SR_BSY
emilmont 77:869cf507173a 298 #define SPI_FLAG_FRE SPI_SR_FRE
emilmont 77:869cf507173a 299 /**
emilmont 77:869cf507173a 300 * @}
emilmont 77:869cf507173a 301 */
emilmont 77:869cf507173a 302
emilmont 77:869cf507173a 303 /**
emilmont 77:869cf507173a 304 * @}
emilmont 77:869cf507173a 305 */
emilmont 77:869cf507173a 306
emilmont 77:869cf507173a 307 /* Exported macro ------------------------------------------------------------*/
Kojto 99:dbbf35b96557 308 /** @defgroup SPI_Exported_Macros SPI Exported Macros
Kojto 99:dbbf35b96557 309 * @{
Kojto 99:dbbf35b96557 310 */
bogdanm 85:024bf7f99721 311 /** @brief Reset SPI handle state
bogdanm 85:024bf7f99721 312 * @param __HANDLE__: specifies the SPI handle.
bogdanm 85:024bf7f99721 313 * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
bogdanm 85:024bf7f99721 314 * @retval None
bogdanm 85:024bf7f99721 315 */
bogdanm 85:024bf7f99721 316 #define __HAL_SPI_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_SPI_STATE_RESET)
bogdanm 85:024bf7f99721 317
emilmont 77:869cf507173a 318 /** @brief Enable or disable the specified SPI interrupts.
emilmont 77:869cf507173a 319 * @param __HANDLE__: specifies the SPI handle.
emilmont 77:869cf507173a 320 * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
emilmont 77:869cf507173a 321 * @param __INTERRUPT__: specifies the interrupt source to enable or disable.
emilmont 77:869cf507173a 322 * This parameter can be one of the following values:
emilmont 77:869cf507173a 323 * @arg SPI_IT_TXE: Tx buffer empty interrupt enable
emilmont 77:869cf507173a 324 * @arg SPI_IT_RXNE: RX buffer not empty interrupt enable
emilmont 77:869cf507173a 325 * @arg SPI_IT_ERR: Error interrupt enable
emilmont 77:869cf507173a 326 * @retval None
emilmont 77:869cf507173a 327 */
emilmont 77:869cf507173a 328 #define __HAL_SPI_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR2 |= (__INTERRUPT__))
emilmont 77:869cf507173a 329 #define __HAL_SPI_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR2 &= (~(__INTERRUPT__)))
emilmont 77:869cf507173a 330
emilmont 77:869cf507173a 331 /** @brief Check if the specified SPI interrupt source is enabled or disabled.
emilmont 77:869cf507173a 332 * @param __HANDLE__: specifies the SPI handle.
emilmont 77:869cf507173a 333 * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
emilmont 77:869cf507173a 334 * @param __INTERRUPT__: specifies the SPI interrupt source to check.
emilmont 77:869cf507173a 335 * This parameter can be one of the following values:
emilmont 77:869cf507173a 336 * @arg SPI_IT_TXE: Tx buffer empty interrupt enable
emilmont 77:869cf507173a 337 * @arg SPI_IT_RXNE: RX buffer not empty interrupt enable
emilmont 77:869cf507173a 338 * @arg SPI_IT_ERR: Error interrupt enable
emilmont 77:869cf507173a 339 * @retval The new state of __IT__ (TRUE or FALSE).
emilmont 77:869cf507173a 340 */
emilmont 77:869cf507173a 341 #define __HAL_SPI_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->CR2 & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
emilmont 77:869cf507173a 342
emilmont 77:869cf507173a 343 /** @brief Check whether the specified SPI flag is set or not.
emilmont 77:869cf507173a 344 * @param __HANDLE__: specifies the SPI handle.
emilmont 77:869cf507173a 345 * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
emilmont 77:869cf507173a 346 * @param __FLAG__: specifies the flag to check.
emilmont 77:869cf507173a 347 * This parameter can be one of the following values:
emilmont 77:869cf507173a 348 * @arg SPI_FLAG_RXNE: Receive buffer not empty flag
emilmont 77:869cf507173a 349 * @arg SPI_FLAG_TXE: Transmit buffer empty flag
emilmont 77:869cf507173a 350 * @arg SPI_FLAG_CRCERR: CRC error flag
emilmont 77:869cf507173a 351 * @arg SPI_FLAG_MODF: Mode fault flag
emilmont 77:869cf507173a 352 * @arg SPI_FLAG_OVR: Overrun flag
emilmont 77:869cf507173a 353 * @arg SPI_FLAG_BSY: Busy flag
emilmont 77:869cf507173a 354 * @arg SPI_FLAG_FRE: Frame format error flag
emilmont 77:869cf507173a 355 * @retval The new state of __FLAG__ (TRUE or FALSE).
emilmont 77:869cf507173a 356 */
emilmont 77:869cf507173a 357 #define __HAL_SPI_GET_FLAG(__HANDLE__, __FLAG__) ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
emilmont 77:869cf507173a 358
emilmont 77:869cf507173a 359 /** @brief Clear the SPI CRCERR pending flag.
emilmont 77:869cf507173a 360 * @param __HANDLE__: specifies the SPI handle.
emilmont 77:869cf507173a 361 * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
emilmont 77:869cf507173a 362 * @retval None
emilmont 77:869cf507173a 363 */
Kojto 90:cb3d968589d8 364 #define __HAL_SPI_CLEAR_CRCERRFLAG(__HANDLE__) ((__HANDLE__)->Instance->SR = ~(SPI_FLAG_CRCERR))
emilmont 77:869cf507173a 365
emilmont 77:869cf507173a 366 /** @brief Clear the SPI MODF pending flag.
emilmont 77:869cf507173a 367 * @param __HANDLE__: specifies the SPI handle.
emilmont 77:869cf507173a 368 * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
emilmont 77:869cf507173a 369 * @retval None
emilmont 77:869cf507173a 370 */
Kojto 99:dbbf35b96557 371 #define __HAL_SPI_CLEAR_MODFFLAG(__HANDLE__) \
Kojto 99:dbbf35b96557 372 do{ \
Kojto 99:dbbf35b96557 373 __IO uint32_t tmpreg; \
Kojto 99:dbbf35b96557 374 tmpreg = (__HANDLE__)->Instance->SR; \
Kojto 99:dbbf35b96557 375 (__HANDLE__)->Instance->CR1 &= (~SPI_CR1_SPE); \
Kojto 99:dbbf35b96557 376 UNUSED(tmpreg); \
Kojto 99:dbbf35b96557 377 } while(0)
emilmont 77:869cf507173a 378
emilmont 77:869cf507173a 379 /** @brief Clear the SPI OVR pending flag.
emilmont 77:869cf507173a 380 * @param __HANDLE__: specifies the SPI handle.
emilmont 77:869cf507173a 381 * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
emilmont 77:869cf507173a 382 * @retval None
emilmont 77:869cf507173a 383 */
Kojto 99:dbbf35b96557 384 #define __HAL_SPI_CLEAR_OVRFLAG(__HANDLE__) \
Kojto 99:dbbf35b96557 385 do{ \
Kojto 99:dbbf35b96557 386 __IO uint32_t tmpreg; \
Kojto 99:dbbf35b96557 387 tmpreg = (__HANDLE__)->Instance->DR; \
Kojto 99:dbbf35b96557 388 tmpreg = (__HANDLE__)->Instance->SR; \
Kojto 99:dbbf35b96557 389 UNUSED(tmpreg); \
Kojto 99:dbbf35b96557 390 } while(0)
emilmont 77:869cf507173a 391
emilmont 77:869cf507173a 392 /** @brief Clear the SPI FRE pending flag.
emilmont 77:869cf507173a 393 * @param __HANDLE__: specifies the SPI handle.
emilmont 77:869cf507173a 394 * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
emilmont 77:869cf507173a 395 * @retval None
Kojto 99:dbbf35b96557 396 */
Kojto 99:dbbf35b96557 397 #define __HAL_SPI_CLEAR_FREFLAG(__HANDLE__) \
Kojto 99:dbbf35b96557 398 do{ \
Kojto 99:dbbf35b96557 399 __IO uint32_t tmpreg; \
Kojto 99:dbbf35b96557 400 tmpreg = (__HANDLE__)->Instance->SR; \
Kojto 99:dbbf35b96557 401 UNUSED(tmpreg); \
Kojto 99:dbbf35b96557 402 }while(0)
Kojto 99:dbbf35b96557 403
Kojto 99:dbbf35b96557 404 /** @brief Enable SPI
Kojto 99:dbbf35b96557 405 * @param __HANDLE__: specifies the SPI Handle.
Kojto 99:dbbf35b96557 406 * @retval None
emilmont 77:869cf507173a 407 */
emilmont 77:869cf507173a 408 #define __HAL_SPI_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= SPI_CR1_SPE)
emilmont 77:869cf507173a 409
Kojto 99:dbbf35b96557 410 /** @brief Disable SPI
Kojto 99:dbbf35b96557 411 * @param __HANDLE__: specifies the SPI Handle.
Kojto 99:dbbf35b96557 412 * @retval None
Kojto 99:dbbf35b96557 413 */
Kojto 99:dbbf35b96557 414 #define __HAL_SPI_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~SPI_CR1_SPE)
Kojto 99:dbbf35b96557 415 /**
Kojto 99:dbbf35b96557 416 * @}
Kojto 99:dbbf35b96557 417 */
Kojto 99:dbbf35b96557 418
Kojto 99:dbbf35b96557 419 /* Exported functions --------------------------------------------------------*/
Kojto 99:dbbf35b96557 420 /** @addtogroup SPI_Exported_Functions
Kojto 99:dbbf35b96557 421 * @{
Kojto 99:dbbf35b96557 422 */
emilmont 77:869cf507173a 423
Kojto 99:dbbf35b96557 424 /** @addtogroup SPI_Exported_Functions_Group1
Kojto 99:dbbf35b96557 425 * @{
Kojto 99:dbbf35b96557 426 */
emilmont 77:869cf507173a 427 /* Initialization/de-initialization functions **********************************/
emilmont 77:869cf507173a 428 HAL_StatusTypeDef HAL_SPI_Init(SPI_HandleTypeDef *hspi);
emilmont 77:869cf507173a 429 HAL_StatusTypeDef HAL_SPI_DeInit (SPI_HandleTypeDef *hspi);
emilmont 77:869cf507173a 430 void HAL_SPI_MspInit(SPI_HandleTypeDef *hspi);
emilmont 77:869cf507173a 431 void HAL_SPI_MspDeInit(SPI_HandleTypeDef *hspi);
Kojto 99:dbbf35b96557 432 /**
Kojto 99:dbbf35b96557 433 * @}
Kojto 99:dbbf35b96557 434 */
emilmont 77:869cf507173a 435
Kojto 99:dbbf35b96557 436 /** @addtogroup SPI_Exported_Functions_Group2
Kojto 99:dbbf35b96557 437 * @{
Kojto 99:dbbf35b96557 438 */
emilmont 77:869cf507173a 439 /* I/O operation functions *****************************************************/
emilmont 77:869cf507173a 440 HAL_StatusTypeDef HAL_SPI_Transmit(SPI_HandleTypeDef *hspi, uint8_t *pData, uint16_t Size, uint32_t Timeout);
emilmont 77:869cf507173a 441 HAL_StatusTypeDef HAL_SPI_Receive(SPI_HandleTypeDef *hspi, uint8_t *pData, uint16_t Size, uint32_t Timeout);
emilmont 77:869cf507173a 442 HAL_StatusTypeDef HAL_SPI_TransmitReceive(SPI_HandleTypeDef *hspi, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size, uint32_t Timeout);
emilmont 77:869cf507173a 443 HAL_StatusTypeDef HAL_SPI_Transmit_IT(SPI_HandleTypeDef *hspi, uint8_t *pData, uint16_t Size);
emilmont 77:869cf507173a 444 HAL_StatusTypeDef HAL_SPI_Receive_IT(SPI_HandleTypeDef *hspi, uint8_t *pData, uint16_t Size);
emilmont 77:869cf507173a 445 HAL_StatusTypeDef HAL_SPI_TransmitReceive_IT(SPI_HandleTypeDef *hspi, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size);
emilmont 77:869cf507173a 446 HAL_StatusTypeDef HAL_SPI_Transmit_DMA(SPI_HandleTypeDef *hspi, uint8_t *pData, uint16_t Size);
emilmont 77:869cf507173a 447 HAL_StatusTypeDef HAL_SPI_Receive_DMA(SPI_HandleTypeDef *hspi, uint8_t *pData, uint16_t Size);
emilmont 77:869cf507173a 448 HAL_StatusTypeDef HAL_SPI_TransmitReceive_DMA(SPI_HandleTypeDef *hspi, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size);
Kojto 90:cb3d968589d8 449 HAL_StatusTypeDef HAL_SPI_DMAPause(SPI_HandleTypeDef *hspi);
Kojto 90:cb3d968589d8 450 HAL_StatusTypeDef HAL_SPI_DMAResume(SPI_HandleTypeDef *hspi);
Kojto 90:cb3d968589d8 451 HAL_StatusTypeDef HAL_SPI_DMAStop(SPI_HandleTypeDef *hspi);
Kojto 90:cb3d968589d8 452
emilmont 77:869cf507173a 453 void HAL_SPI_IRQHandler(SPI_HandleTypeDef *hspi);
bogdanm 81:7d30d6019079 454 void HAL_SPI_TxCpltCallback(SPI_HandleTypeDef *hspi);
bogdanm 81:7d30d6019079 455 void HAL_SPI_RxCpltCallback(SPI_HandleTypeDef *hspi);
bogdanm 81:7d30d6019079 456 void HAL_SPI_TxRxCpltCallback(SPI_HandleTypeDef *hspi);
bogdanm 81:7d30d6019079 457 void HAL_SPI_ErrorCallback(SPI_HandleTypeDef *hspi);
Kojto 90:cb3d968589d8 458 void HAL_SPI_TxHalfCpltCallback(SPI_HandleTypeDef *hspi);
Kojto 90:cb3d968589d8 459 void HAL_SPI_RxHalfCpltCallback(SPI_HandleTypeDef *hspi);
Kojto 90:cb3d968589d8 460 void HAL_SPI_TxRxHalfCpltCallback(SPI_HandleTypeDef *hspi);
Kojto 99:dbbf35b96557 461 /**
Kojto 99:dbbf35b96557 462 * @}
Kojto 99:dbbf35b96557 463 */
Kojto 99:dbbf35b96557 464
Kojto 99:dbbf35b96557 465 /** @addtogroup SPI_Exported_Functions_Group3
Kojto 99:dbbf35b96557 466 * @{
Kojto 99:dbbf35b96557 467 */
emilmont 77:869cf507173a 468 /* Peripheral State and Control functions **************************************/
emilmont 77:869cf507173a 469 HAL_SPI_StateTypeDef HAL_SPI_GetState(SPI_HandleTypeDef *hspi);
Kojto 99:dbbf35b96557 470 uint32_t HAL_SPI_GetError(SPI_HandleTypeDef *hspi);
emilmont 77:869cf507173a 471
emilmont 77:869cf507173a 472 /**
emilmont 77:869cf507173a 473 * @}
emilmont 77:869cf507173a 474 */
emilmont 77:869cf507173a 475
emilmont 77:869cf507173a 476 /**
emilmont 77:869cf507173a 477 * @}
emilmont 77:869cf507173a 478 */
emilmont 77:869cf507173a 479
Kojto 99:dbbf35b96557 480 /* Private types -------------------------------------------------------------*/
Kojto 99:dbbf35b96557 481 /* Private variables ---------------------------------------------------------*/
Kojto 99:dbbf35b96557 482 /* Private constants ---------------------------------------------------------*/
Kojto 99:dbbf35b96557 483 /** @defgroup SPI_Private_Constants SPI Private Constants
Kojto 99:dbbf35b96557 484 * @{
Kojto 99:dbbf35b96557 485 */
Kojto 99:dbbf35b96557 486 /**
Kojto 99:dbbf35b96557 487 * @}
Kojto 99:dbbf35b96557 488 */
Kojto 99:dbbf35b96557 489
Kojto 99:dbbf35b96557 490 /* Private macros ------------------------------------------------------------*/
Kojto 99:dbbf35b96557 491 /** @defgroup SPI_Private_Macros SPI Private Macros
Kojto 99:dbbf35b96557 492 * @{
Kojto 99:dbbf35b96557 493 */
Kojto 99:dbbf35b96557 494
Kojto 99:dbbf35b96557 495 #define IS_SPI_MODE(MODE) (((MODE) == SPI_MODE_SLAVE) || \
Kojto 99:dbbf35b96557 496 ((MODE) == SPI_MODE_MASTER))
Kojto 99:dbbf35b96557 497
Kojto 99:dbbf35b96557 498
Kojto 99:dbbf35b96557 499 #define IS_SPI_DIRECTION_MODE(MODE) (((MODE) == SPI_DIRECTION_2LINES) || \
Kojto 99:dbbf35b96557 500 ((MODE) == SPI_DIRECTION_2LINES_RXONLY) || \
Kojto 99:dbbf35b96557 501 ((MODE) == SPI_DIRECTION_1LINE))
Kojto 99:dbbf35b96557 502
Kojto 99:dbbf35b96557 503 #define IS_SPI_DIRECTION_2LINES_OR_1LINE(MODE) (((MODE) == SPI_DIRECTION_2LINES) || \
Kojto 99:dbbf35b96557 504 ((MODE) == SPI_DIRECTION_1LINE))
Kojto 99:dbbf35b96557 505
Kojto 99:dbbf35b96557 506 #define IS_SPI_DIRECTION_2LINES(MODE) ((MODE) == SPI_DIRECTION_2LINES)
Kojto 99:dbbf35b96557 507
Kojto 99:dbbf35b96557 508 #define IS_SPI_DATASIZE(DATASIZE) (((DATASIZE) == SPI_DATASIZE_16BIT) || \
Kojto 99:dbbf35b96557 509 ((DATASIZE) == SPI_DATASIZE_8BIT))
Kojto 99:dbbf35b96557 510
Kojto 99:dbbf35b96557 511 #define IS_SPI_CPOL(CPOL) (((CPOL) == SPI_POLARITY_LOW) || \
Kojto 99:dbbf35b96557 512 ((CPOL) == SPI_POLARITY_HIGH))
Kojto 99:dbbf35b96557 513
Kojto 99:dbbf35b96557 514 #define IS_SPI_CPHA(CPHA) (((CPHA) == SPI_PHASE_1EDGE) || \
Kojto 99:dbbf35b96557 515 ((CPHA) == SPI_PHASE_2EDGE))
Kojto 99:dbbf35b96557 516
Kojto 99:dbbf35b96557 517 #define IS_SPI_NSS(NSS) (((NSS) == SPI_NSS_SOFT) || \
Kojto 99:dbbf35b96557 518 ((NSS) == SPI_NSS_HARD_INPUT) || \
Kojto 99:dbbf35b96557 519 ((NSS) == SPI_NSS_HARD_OUTPUT))
Kojto 99:dbbf35b96557 520
Kojto 99:dbbf35b96557 521 #define IS_SPI_BAUDRATE_PRESCALER(PRESCALER) (((PRESCALER) == SPI_BAUDRATEPRESCALER_2) || \
Kojto 99:dbbf35b96557 522 ((PRESCALER) == SPI_BAUDRATEPRESCALER_4) || \
Kojto 99:dbbf35b96557 523 ((PRESCALER) == SPI_BAUDRATEPRESCALER_8) || \
Kojto 99:dbbf35b96557 524 ((PRESCALER) == SPI_BAUDRATEPRESCALER_16) || \
Kojto 99:dbbf35b96557 525 ((PRESCALER) == SPI_BAUDRATEPRESCALER_32) || \
Kojto 99:dbbf35b96557 526 ((PRESCALER) == SPI_BAUDRATEPRESCALER_64) || \
Kojto 99:dbbf35b96557 527 ((PRESCALER) == SPI_BAUDRATEPRESCALER_128) || \
Kojto 99:dbbf35b96557 528 ((PRESCALER) == SPI_BAUDRATEPRESCALER_256))
Kojto 99:dbbf35b96557 529
Kojto 99:dbbf35b96557 530 #define IS_SPI_FIRST_BIT(BIT) (((BIT) == SPI_FIRSTBIT_MSB) || \
Kojto 99:dbbf35b96557 531 ((BIT) == SPI_FIRSTBIT_LSB))
Kojto 99:dbbf35b96557 532
Kojto 99:dbbf35b96557 533 #define IS_SPI_TIMODE(MODE) (((MODE) == SPI_TIMODE_DISABLE) || \
Kojto 99:dbbf35b96557 534 ((MODE) == SPI_TIMODE_ENABLE))
Kojto 99:dbbf35b96557 535
Kojto 99:dbbf35b96557 536 #define IS_SPI_CRC_CALCULATION(CALCULATION) (((CALCULATION) == SPI_CRCCALCULATION_DISABLE) || \
Kojto 99:dbbf35b96557 537 ((CALCULATION) == SPI_CRCCALCULATION_ENABLE))
Kojto 99:dbbf35b96557 538
Kojto 99:dbbf35b96557 539 #define IS_SPI_CRC_POLYNOMIAL(POLYNOMIAL) (((POLYNOMIAL) >= 0x1) && ((POLYNOMIAL) <= 0xFFFF))
Kojto 99:dbbf35b96557 540
Kojto 99:dbbf35b96557 541 #define SPI_1LINE_TX(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= SPI_CR1_BIDIOE)
Kojto 99:dbbf35b96557 542
Kojto 99:dbbf35b96557 543 #define SPI_1LINE_RX(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~SPI_CR1_BIDIOE)
Kojto 99:dbbf35b96557 544
Kojto 99:dbbf35b96557 545 #define SPI_RESET_CRC(__HANDLE__) do{(__HANDLE__)->Instance->CR1 &= (~SPI_CR1_CRCEN);\
Kojto 99:dbbf35b96557 546 (__HANDLE__)->Instance->CR1 |= SPI_CR1_CRCEN;}while(0)
Kojto 99:dbbf35b96557 547 /**
Kojto 99:dbbf35b96557 548 * @}
Kojto 99:dbbf35b96557 549 */
Kojto 99:dbbf35b96557 550
Kojto 99:dbbf35b96557 551 /* Private functions ---------------------------------------------------------*/
Kojto 99:dbbf35b96557 552 /** @defgroup SPI_Private_Functions SPI Private Functions
Kojto 99:dbbf35b96557 553 * @{
Kojto 99:dbbf35b96557 554 */
Kojto 99:dbbf35b96557 555
Kojto 99:dbbf35b96557 556 /**
Kojto 99:dbbf35b96557 557 * @}
Kojto 99:dbbf35b96557 558 */
Kojto 99:dbbf35b96557 559
Kojto 99:dbbf35b96557 560 /**
Kojto 99:dbbf35b96557 561 * @}
Kojto 99:dbbf35b96557 562 */
Kojto 99:dbbf35b96557 563
Kojto 99:dbbf35b96557 564 /**
Kojto 99:dbbf35b96557 565 * @}
Kojto 99:dbbf35b96557 566 */
Kojto 99:dbbf35b96557 567
Kojto 99:dbbf35b96557 568
emilmont 77:869cf507173a 569 #ifdef __cplusplus
emilmont 77:869cf507173a 570 }
emilmont 77:869cf507173a 571 #endif
emilmont 77:869cf507173a 572
emilmont 77:869cf507173a 573 #endif /* __STM32F4xx_HAL_SPI_H */
emilmont 77:869cf507173a 574
emilmont 77:869cf507173a 575 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/