Elijah Orr / mbed-renbed

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

TARGET_MOTE_L152RC/stm32l1xx_hal_spi.h@121:672067c3ada4, 2016-04-14 (annotated)

Committer:
elijahorr
Date:
Thu Apr 14 07:28:54 2016 +0000
Revision:
121:672067c3ada4
Parent:
112:6f327212ef96 
.

Who changed what in which revision?

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