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 Nov 25 13:21:40 2015 +0000
Revision:
110:165afa46840b
Release 110  of the mbed library

Changes:
- new platforms - STM32F410R, DISCO_F429ZI, DISCO_F469NI
- Nucleo L476 - gcc and uvision template
- k22,k64f targets - ADC channels A addition
- EFM32 - bugfixes in sleep, serial and spi
- Delta DFCM NNN40 - pinnames update

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Kojto 110:165afa46840b 1 /**
Kojto 110:165afa46840b 2 ******************************************************************************
Kojto 110:165afa46840b 3 * @file stm32f4xx_hal_qspi.h
Kojto 110:165afa46840b 4 * @author MCD Application Team
Kojto 110:165afa46840b 5 * @version V1.4.1
Kojto 110:165afa46840b 6 * @date 09-October-2015
Kojto 110:165afa46840b 7 * @brief Header file of QSPI HAL module.
Kojto 110:165afa46840b 8 ******************************************************************************
Kojto 110:165afa46840b 9 * @attention
Kojto 110:165afa46840b 10 *
Kojto 110:165afa46840b 11 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
Kojto 110:165afa46840b 12 *
Kojto 110:165afa46840b 13 * Redistribution and use in source and binary forms, with or without modification,
Kojto 110:165afa46840b 14 * are permitted provided that the following conditions are met:
Kojto 110:165afa46840b 15 * 1. Redistributions of source code must retain the above copyright notice,
Kojto 110:165afa46840b 16 * this list of conditions and the following disclaimer.
Kojto 110:165afa46840b 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
Kojto 110:165afa46840b 18 * this list of conditions and the following disclaimer in the documentation
Kojto 110:165afa46840b 19 * and/or other materials provided with the distribution.
Kojto 110:165afa46840b 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Kojto 110:165afa46840b 21 * may be used to endorse or promote products derived from this software
Kojto 110:165afa46840b 22 * without specific prior written permission.
Kojto 110:165afa46840b 23 *
Kojto 110:165afa46840b 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Kojto 110:165afa46840b 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Kojto 110:165afa46840b 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Kojto 110:165afa46840b 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Kojto 110:165afa46840b 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Kojto 110:165afa46840b 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Kojto 110:165afa46840b 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Kojto 110:165afa46840b 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Kojto 110:165afa46840b 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Kojto 110:165afa46840b 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Kojto 110:165afa46840b 34 *
Kojto 110:165afa46840b 35 ******************************************************************************
Kojto 110:165afa46840b 36 */
Kojto 110:165afa46840b 37
Kojto 110:165afa46840b 38 /* Define to prevent recursive inclusion -------------------------------------*/
Kojto 110:165afa46840b 39 #ifndef __STM32F4xx_HAL_QSPI_H
Kojto 110:165afa46840b 40 #define __STM32F4xx_HAL_QSPI_H
Kojto 110:165afa46840b 41
Kojto 110:165afa46840b 42 #ifdef __cplusplus
Kojto 110:165afa46840b 43 extern "C" {
Kojto 110:165afa46840b 44 #endif
Kojto 110:165afa46840b 45
Kojto 110:165afa46840b 46 #if defined(STM32F446xx) || defined(STM32F469xx) || defined(STM32F479xx)
Kojto 110:165afa46840b 47 /* Includes ------------------------------------------------------------------*/
Kojto 110:165afa46840b 48 #include "stm32f4xx_hal_def.h"
Kojto 110:165afa46840b 49
Kojto 110:165afa46840b 50 /** @addtogroup STM32F4xx_HAL_Driver
Kojto 110:165afa46840b 51 * @{
Kojto 110:165afa46840b 52 */
Kojto 110:165afa46840b 53
Kojto 110:165afa46840b 54 /** @addtogroup QSPI
Kojto 110:165afa46840b 55 * @{
Kojto 110:165afa46840b 56 */
Kojto 110:165afa46840b 57
Kojto 110:165afa46840b 58 /* Exported types ------------------------------------------------------------*/
Kojto 110:165afa46840b 59 /** @defgroup QSPI_Exported_Types QSPI Exported Types
Kojto 110:165afa46840b 60 * @{
Kojto 110:165afa46840b 61 */
Kojto 110:165afa46840b 62
Kojto 110:165afa46840b 63 /**
Kojto 110:165afa46840b 64 * @brief QSPI Init structure definition
Kojto 110:165afa46840b 65 */
Kojto 110:165afa46840b 66
Kojto 110:165afa46840b 67 typedef struct
Kojto 110:165afa46840b 68 {
Kojto 110:165afa46840b 69 uint32_t ClockPrescaler; /* Specifies the prescaler factor for generating clock based on the AHB clock.
Kojto 110:165afa46840b 70 This parameter can be a number between 0 and 255 */
Kojto 110:165afa46840b 71
Kojto 110:165afa46840b 72 uint32_t FifoThreshold; /* Specifies the threshold number of bytes in the FIFO (used only in indirect mode)
Kojto 110:165afa46840b 73 This parameter can be a value between 1 and 32 */
Kojto 110:165afa46840b 74
Kojto 110:165afa46840b 75 uint32_t SampleShifting; /* Specifies the Sample Shift. The data is sampled 1/2 clock cycle delay later to
Kojto 110:165afa46840b 76 take in account external signal delays. (It should be QSPI_SAMPLE_SHIFTING_NONE in DDR mode)
Kojto 110:165afa46840b 77 This parameter can be a value of @ref QSPI_SampleShifting */
Kojto 110:165afa46840b 78
Kojto 110:165afa46840b 79 uint32_t FlashSize; /* Specifies the Flash Size. FlashSize+1 is effectively the number of address bits
Kojto 110:165afa46840b 80 required to address the flash memory. The flash capacity can be up to 4GB
Kojto 110:165afa46840b 81 (addressed using 32 bits) in indirect mode, but the addressable space in
Kojto 110:165afa46840b 82 memory-mapped mode is limited to 256MB
Kojto 110:165afa46840b 83 This parameter can be a number between 0 and 31 */
Kojto 110:165afa46840b 84
Kojto 110:165afa46840b 85 uint32_t ChipSelectHighTime; /* Specifies the Chip Select High Time. ChipSelectHighTime+1 defines the minimum number
Kojto 110:165afa46840b 86 of clock cycles which the chip select must remain high between commands.
Kojto 110:165afa46840b 87 This parameter can be a value of @ref QSPI_ChipSelectHighTime */
Kojto 110:165afa46840b 88
Kojto 110:165afa46840b 89 uint32_t ClockMode; /* Specifies the Clock Mode. It indicates the level that clock takes between commands.
Kojto 110:165afa46840b 90 This parameter can be a value of @ref QSPI_ClockMode */
Kojto 110:165afa46840b 91
Kojto 110:165afa46840b 92 uint32_t FlashID; /* Specifies the Flash which will be used,
Kojto 110:165afa46840b 93 This parameter can be a value of @ref QSPI_Flash_Select */
Kojto 110:165afa46840b 94
Kojto 110:165afa46840b 95 uint32_t DualFlash; /* Specifies the Dual Flash Mode State
Kojto 110:165afa46840b 96 This parameter can be a value of @ref QSPI_DualFlash_Mode */
Kojto 110:165afa46840b 97 }QSPI_InitTypeDef;
Kojto 110:165afa46840b 98
Kojto 110:165afa46840b 99 /**
Kojto 110:165afa46840b 100 * @brief HAL QSPI State structures definition
Kojto 110:165afa46840b 101 */
Kojto 110:165afa46840b 102 typedef enum
Kojto 110:165afa46840b 103 {
Kojto 110:165afa46840b 104 HAL_QSPI_STATE_RESET = 0x00, /*!< Peripheral not initialized */
Kojto 110:165afa46840b 105 HAL_QSPI_STATE_READY = 0x01, /*!< Peripheral initialized and ready for use */
Kojto 110:165afa46840b 106 HAL_QSPI_STATE_BUSY = 0x02, /*!< Peripheral in indirect mode and busy */
Kojto 110:165afa46840b 107 HAL_QSPI_STATE_BUSY_INDIRECT_TX = 0x12, /*!< Peripheral in indirect mode with transmission ongoing */
Kojto 110:165afa46840b 108 HAL_QSPI_STATE_BUSY_INDIRECT_RX = 0x22, /*!< Peripheral in indirect mode with reception ongoing */
Kojto 110:165afa46840b 109 HAL_QSPI_STATE_BUSY_AUTO_POLLING = 0x42, /*!< Peripheral in auto polling mode ongoing */
Kojto 110:165afa46840b 110 HAL_QSPI_STATE_BUSY_MEM_MAPPED = 0x82, /*!< Peripheral in memory mapped mode ongoing */
Kojto 110:165afa46840b 111 HAL_QSPI_STATE_ERROR = 0x04 /*!< Peripheral in error */
Kojto 110:165afa46840b 112 }HAL_QSPI_StateTypeDef;
Kojto 110:165afa46840b 113
Kojto 110:165afa46840b 114 /**
Kojto 110:165afa46840b 115 * @brief QSPI Handle Structure definition
Kojto 110:165afa46840b 116 */
Kojto 110:165afa46840b 117 typedef struct
Kojto 110:165afa46840b 118 {
Kojto 110:165afa46840b 119 QUADSPI_TypeDef *Instance; /* QSPI registers base address */
Kojto 110:165afa46840b 120 QSPI_InitTypeDef Init; /* QSPI communication parameters */
Kojto 110:165afa46840b 121 uint8_t *pTxBuffPtr; /* Pointer to QSPI Tx transfer Buffer */
Kojto 110:165afa46840b 122 __IO uint16_t TxXferSize; /* QSPI Tx Transfer size */
Kojto 110:165afa46840b 123 __IO uint16_t TxXferCount; /* QSPI Tx Transfer Counter */
Kojto 110:165afa46840b 124 uint8_t *pRxBuffPtr; /* Pointer to QSPI Rx transfer Buffer */
Kojto 110:165afa46840b 125 __IO uint16_t RxXferSize; /* QSPI Rx Transfer size */
Kojto 110:165afa46840b 126 __IO uint16_t RxXferCount; /* QSPI Rx Transfer Counter */
Kojto 110:165afa46840b 127 DMA_HandleTypeDef *hdma; /* QSPI Rx/Tx DMA Handle parameters */
Kojto 110:165afa46840b 128 __IO HAL_LockTypeDef Lock; /* Locking object */
Kojto 110:165afa46840b 129 __IO HAL_QSPI_StateTypeDef State; /* QSPI communication state */
Kojto 110:165afa46840b 130 __IO uint32_t ErrorCode; /* QSPI Error code */
Kojto 110:165afa46840b 131 uint32_t Timeout; /* Timeout for the QSPI memory access */
Kojto 110:165afa46840b 132 }QSPI_HandleTypeDef;
Kojto 110:165afa46840b 133
Kojto 110:165afa46840b 134 /**
Kojto 110:165afa46840b 135 * @brief QSPI Command structure definition
Kojto 110:165afa46840b 136 */
Kojto 110:165afa46840b 137 typedef struct
Kojto 110:165afa46840b 138 {
Kojto 110:165afa46840b 139 uint32_t Instruction; /* Specifies the Instruction to be sent
Kojto 110:165afa46840b 140 This parameter can be a value (8-bit) between 0x00 and 0xFF */
Kojto 110:165afa46840b 141 uint32_t Address; /* Specifies the Address to be sent (Size from 1 to 4 bytes according AddressSize)
Kojto 110:165afa46840b 142 This parameter can be a value (32-bits) between 0x0 and 0xFFFFFFFF */
Kojto 110:165afa46840b 143 uint32_t AlternateBytes; /* Specifies the Alternate Bytes to be sent (Size from 1 to 4 bytes according AlternateBytesSize)
Kojto 110:165afa46840b 144 This parameter can be a value (32-bits) between 0x0 and 0xFFFFFFFF */
Kojto 110:165afa46840b 145 uint32_t AddressSize; /* Specifies the Address Size
Kojto 110:165afa46840b 146 This parameter can be a value of @ref QSPI_AddressSize */
Kojto 110:165afa46840b 147 uint32_t AlternateBytesSize; /* Specifies the Alternate Bytes Size
Kojto 110:165afa46840b 148 This parameter can be a value of @ref QSPI_AlternateBytesSize */
Kojto 110:165afa46840b 149 uint32_t DummyCycles; /* Specifies the Number of Dummy Cycles.
Kojto 110:165afa46840b 150 This parameter can be a number between 0 and 31 */
Kojto 110:165afa46840b 151 uint32_t InstructionMode; /* Specifies the Instruction Mode
Kojto 110:165afa46840b 152 This parameter can be a value of @ref QSPI_InstructionMode */
Kojto 110:165afa46840b 153 uint32_t AddressMode; /* Specifies the Address Mode
Kojto 110:165afa46840b 154 This parameter can be a value of @ref QSPI_AddressMode */
Kojto 110:165afa46840b 155 uint32_t AlternateByteMode; /* Specifies the Alternate Bytes Mode
Kojto 110:165afa46840b 156 This parameter can be a value of @ref QSPI_AlternateBytesMode */
Kojto 110:165afa46840b 157 uint32_t DataMode; /* Specifies the Data Mode (used for dummy cycles and data phases)
Kojto 110:165afa46840b 158 This parameter can be a value of @ref QSPI_DataMode */
Kojto 110:165afa46840b 159 uint32_t NbData; /* Specifies the number of data to transfer.
Kojto 110:165afa46840b 160 This parameter can be any value between 0 and 0xFFFFFFFF (0 means undefined length
Kojto 110:165afa46840b 161 until end of memory)*/
Kojto 110:165afa46840b 162 uint32_t DdrMode; /* Specifies the double data rate mode for address, alternate byte and data phase
Kojto 110:165afa46840b 163 This parameter can be a value of @ref QSPI_DdrMode */
Kojto 110:165afa46840b 164 uint32_t DdrHoldHalfCycle; /* Specifies the DDR hold half cycle. It delays the data output by one half of
Kojto 110:165afa46840b 165 system clock in DDR mode.
Kojto 110:165afa46840b 166 This parameter can be a value of @ref QSPI_DdrHoldHalfCycle */
Kojto 110:165afa46840b 167 uint32_t SIOOMode; /* Specifies the send instruction only once mode
Kojto 110:165afa46840b 168 This parameter can be a value of @ref QSPI_SIOOMode */
Kojto 110:165afa46840b 169 }QSPI_CommandTypeDef;
Kojto 110:165afa46840b 170
Kojto 110:165afa46840b 171 /**
Kojto 110:165afa46840b 172 * @brief QSPI Auto Polling mode configuration structure definition
Kojto 110:165afa46840b 173 */
Kojto 110:165afa46840b 174 typedef struct
Kojto 110:165afa46840b 175 {
Kojto 110:165afa46840b 176 uint32_t Match; /* Specifies the value to be compared with the masked status register to get a match.
Kojto 110:165afa46840b 177 This parameter can be any value between 0 and 0xFFFFFFFF */
Kojto 110:165afa46840b 178 uint32_t Mask; /* Specifies the mask to be applied to the status bytes received.
Kojto 110:165afa46840b 179 This parameter can be any value between 0 and 0xFFFFFFFF */
Kojto 110:165afa46840b 180 uint32_t Interval; /* Specifies the number of clock cycles between two read during automatic polling phases.
Kojto 110:165afa46840b 181 This parameter can be any value between 0 and 0xFFFF */
Kojto 110:165afa46840b 182 uint32_t StatusBytesSize; /* Specifies the size of the status bytes received.
Kojto 110:165afa46840b 183 This parameter can be any value between 1 and 4 */
Kojto 110:165afa46840b 184 uint32_t MatchMode; /* Specifies the method used for determining a match.
Kojto 110:165afa46840b 185 This parameter can be a value of @ref QSPI_MatchMode */
Kojto 110:165afa46840b 186 uint32_t AutomaticStop; /* Specifies if automatic polling is stopped after a match.
Kojto 110:165afa46840b 187 This parameter can be a value of @ref QSPI_AutomaticStop */
Kojto 110:165afa46840b 188 }QSPI_AutoPollingTypeDef;
Kojto 110:165afa46840b 189
Kojto 110:165afa46840b 190 /**
Kojto 110:165afa46840b 191 * @brief QSPI Memory Mapped mode configuration structure definition
Kojto 110:165afa46840b 192 */
Kojto 110:165afa46840b 193 typedef struct
Kojto 110:165afa46840b 194 {
Kojto 110:165afa46840b 195 uint32_t TimeOutPeriod; /* Specifies the number of clock to wait when the FIFO is full before to release the chip select.
Kojto 110:165afa46840b 196 This parameter can be any value between 0 and 0xFFFF */
Kojto 110:165afa46840b 197 uint32_t TimeOutActivation; /* Specifies if the time out counter is enabled to release the chip select.
Kojto 110:165afa46840b 198 This parameter can be a value of @ref QSPI_TimeOutActivation */
Kojto 110:165afa46840b 199 }QSPI_MemoryMappedTypeDef;
Kojto 110:165afa46840b 200 /**
Kojto 110:165afa46840b 201 * @}
Kojto 110:165afa46840b 202 */
Kojto 110:165afa46840b 203
Kojto 110:165afa46840b 204 /* Exported constants --------------------------------------------------------*/
Kojto 110:165afa46840b 205 /** @defgroup QSPI_Exported_Constants QSPI Exported Constants
Kojto 110:165afa46840b 206 * @{
Kojto 110:165afa46840b 207 */
Kojto 110:165afa46840b 208 /** @defgroup QSPI_ErrorCode QSPI Error Code
Kojto 110:165afa46840b 209 * @{
Kojto 110:165afa46840b 210 */
Kojto 110:165afa46840b 211 #define HAL_QSPI_ERROR_NONE ((uint32_t)0x00000000) /*!< No error */
Kojto 110:165afa46840b 212 #define HAL_QSPI_ERROR_TIMEOUT ((uint32_t)0x00000001) /*!< Timeout error */
Kojto 110:165afa46840b 213 #define HAL_QSPI_ERROR_TRANSFER ((uint32_t)0x00000002) /*!< Transfer error */
Kojto 110:165afa46840b 214 #define HAL_QSPI_ERROR_DMA ((uint32_t)0x00000004) /*!< DMA transfer error */
Kojto 110:165afa46840b 215 /**
Kojto 110:165afa46840b 216 * @}
Kojto 110:165afa46840b 217 */
Kojto 110:165afa46840b 218
Kojto 110:165afa46840b 219 /** @defgroup QSPI_SampleShifting QSPI Sample Shifting
Kojto 110:165afa46840b 220 * @{
Kojto 110:165afa46840b 221 */
Kojto 110:165afa46840b 222 #define QSPI_SAMPLE_SHIFTING_NONE ((uint32_t)0x00000000) /*!<No clock cycle shift to sample data*/
Kojto 110:165afa46840b 223 #define QSPI_SAMPLE_SHIFTING_HALFCYCLE ((uint32_t)QUADSPI_CR_SSHIFT) /*!<1/2 clock cycle shift to sample data*/
Kojto 110:165afa46840b 224 /**
Kojto 110:165afa46840b 225 * @}
Kojto 110:165afa46840b 226 */
Kojto 110:165afa46840b 227
Kojto 110:165afa46840b 228 /** @defgroup QSPI_ChipSelectHighTime QSPI Chip Select High Time
Kojto 110:165afa46840b 229 * @{
Kojto 110:165afa46840b 230 */
Kojto 110:165afa46840b 231 #define QSPI_CS_HIGH_TIME_1_CYCLE ((uint32_t)0x00000000) /*!<nCS stay high for at least 1 clock cycle between commands*/
Kojto 110:165afa46840b 232 #define QSPI_CS_HIGH_TIME_2_CYCLE ((uint32_t)QUADSPI_DCR_CSHT_0) /*!<nCS stay high for at least 2 clock cycles between commands*/
Kojto 110:165afa46840b 233 #define QSPI_CS_HIGH_TIME_3_CYCLE ((uint32_t)QUADSPI_DCR_CSHT_1) /*!<nCS stay high for at least 3 clock cycles between commands*/
Kojto 110:165afa46840b 234 #define QSPI_CS_HIGH_TIME_4_CYCLE ((uint32_t)QUADSPI_DCR_CSHT_0 | QUADSPI_DCR_CSHT_1) /*!<nCS stay high for at least 4 clock cycles between commands*/
Kojto 110:165afa46840b 235 #define QSPI_CS_HIGH_TIME_5_CYCLE ((uint32_t)QUADSPI_DCR_CSHT_2) /*!<nCS stay high for at least 5 clock cycles between commands*/
Kojto 110:165afa46840b 236 #define QSPI_CS_HIGH_TIME_6_CYCLE ((uint32_t)QUADSPI_DCR_CSHT_2 | QUADSPI_DCR_CSHT_0) /*!<nCS stay high for at least 6 clock cycles between commands*/
Kojto 110:165afa46840b 237 #define QSPI_CS_HIGH_TIME_7_CYCLE ((uint32_t)QUADSPI_DCR_CSHT_2 | QUADSPI_DCR_CSHT_1) /*!<nCS stay high for at least 7 clock cycles between commands*/
Kojto 110:165afa46840b 238 #define QSPI_CS_HIGH_TIME_8_CYCLE ((uint32_t)QUADSPI_DCR_CSHT) /*!<nCS stay high for at least 8 clock cycles between commands*/
Kojto 110:165afa46840b 239 /**
Kojto 110:165afa46840b 240 * @}
Kojto 110:165afa46840b 241 */
Kojto 110:165afa46840b 242
Kojto 110:165afa46840b 243 /** @defgroup QSPI_ClockMode QSPI Clock Mode
Kojto 110:165afa46840b 244 * @{
Kojto 110:165afa46840b 245 */
Kojto 110:165afa46840b 246 #define QSPI_CLOCK_MODE_0 ((uint32_t)0x00000000) /*!<Clk stays low while nCS is released*/
Kojto 110:165afa46840b 247 #define QSPI_CLOCK_MODE_3 ((uint32_t)QUADSPI_DCR_CKMODE) /*!<Clk goes high while nCS is released*/
Kojto 110:165afa46840b 248 /**
Kojto 110:165afa46840b 249 * @}
Kojto 110:165afa46840b 250 */
Kojto 110:165afa46840b 251
Kojto 110:165afa46840b 252 /** @defgroup QSPI_Flash_Select QSPI Flash Select
Kojto 110:165afa46840b 253 * @{
Kojto 110:165afa46840b 254 */
Kojto 110:165afa46840b 255 #define QSPI_FLASH_ID_1 ((uint32_t)0x00000000)
Kojto 110:165afa46840b 256 #define QSPI_FLASH_ID_2 ((uint32_t)QUADSPI_CR_FSEL)
Kojto 110:165afa46840b 257 /**
Kojto 110:165afa46840b 258 * @}
Kojto 110:165afa46840b 259 */
Kojto 110:165afa46840b 260
Kojto 110:165afa46840b 261 /** @defgroup QSPI_DualFlash_Mode QSPI Dual Flash Mode
Kojto 110:165afa46840b 262 * @{
Kojto 110:165afa46840b 263 */
Kojto 110:165afa46840b 264 #define QSPI_DUALFLASH_ENABLE ((uint32_t)QUADSPI_CR_DFM)
Kojto 110:165afa46840b 265 #define QSPI_DUALFLASH_DISABLE ((uint32_t)0x00000000)
Kojto 110:165afa46840b 266 /**
Kojto 110:165afa46840b 267 * @}
Kojto 110:165afa46840b 268 */
Kojto 110:165afa46840b 269
Kojto 110:165afa46840b 270 /** @defgroup QSPI_AddressSize QSPI Address Size
Kojto 110:165afa46840b 271 * @{
Kojto 110:165afa46840b 272 */
Kojto 110:165afa46840b 273 #define QSPI_ADDRESS_8_BITS ((uint32_t)0x00000000) /*!<8-bit address*/
Kojto 110:165afa46840b 274 #define QSPI_ADDRESS_16_BITS ((uint32_t)QUADSPI_CCR_ADSIZE_0) /*!<16-bit address*/
Kojto 110:165afa46840b 275 #define QSPI_ADDRESS_24_BITS ((uint32_t)QUADSPI_CCR_ADSIZE_1) /*!<24-bit address*/
Kojto 110:165afa46840b 276 #define QSPI_ADDRESS_32_BITS ((uint32_t)QUADSPI_CCR_ADSIZE) /*!<32-bit address*/
Kojto 110:165afa46840b 277 /**
Kojto 110:165afa46840b 278 * @}
Kojto 110:165afa46840b 279 */
Kojto 110:165afa46840b 280
Kojto 110:165afa46840b 281 /** @defgroup QSPI_AlternateBytesSize QSPI Alternate Bytes Size
Kojto 110:165afa46840b 282 * @{
Kojto 110:165afa46840b 283 */
Kojto 110:165afa46840b 284 #define QSPI_ALTERNATE_BYTES_8_BITS ((uint32_t)0x00000000) /*!<8-bit alternate bytes*/
Kojto 110:165afa46840b 285 #define QSPI_ALTERNATE_BYTES_16_BITS ((uint32_t)QUADSPI_CCR_ABSIZE_0) /*!<16-bit alternate bytes*/
Kojto 110:165afa46840b 286 #define QSPI_ALTERNATE_BYTES_24_BITS ((uint32_t)QUADSPI_CCR_ABSIZE_1) /*!<24-bit alternate bytes*/
Kojto 110:165afa46840b 287 #define QSPI_ALTERNATE_BYTES_32_BITS ((uint32_t)QUADSPI_CCR_ABSIZE) /*!<32-bit alternate bytes*/
Kojto 110:165afa46840b 288 /**
Kojto 110:165afa46840b 289 * @}
Kojto 110:165afa46840b 290 */
Kojto 110:165afa46840b 291
Kojto 110:165afa46840b 292 /** @defgroup QSPI_InstructionMode QSPI Instruction Mode
Kojto 110:165afa46840b 293 * @{
Kojto 110:165afa46840b 294 */
Kojto 110:165afa46840b 295 #define QSPI_INSTRUCTION_NONE ((uint32_t)0x00000000) /*!<No instruction*/
Kojto 110:165afa46840b 296 #define QSPI_INSTRUCTION_1_LINE ((uint32_t)QUADSPI_CCR_IMODE_0) /*!<Instruction on a single line*/
Kojto 110:165afa46840b 297 #define QSPI_INSTRUCTION_2_LINES ((uint32_t)QUADSPI_CCR_IMODE_1) /*!<Instruction on two lines*/
Kojto 110:165afa46840b 298 #define QSPI_INSTRUCTION_4_LINES ((uint32_t)QUADSPI_CCR_IMODE) /*!<Instruction on four lines*/
Kojto 110:165afa46840b 299 /**
Kojto 110:165afa46840b 300 * @}
Kojto 110:165afa46840b 301 */
Kojto 110:165afa46840b 302
Kojto 110:165afa46840b 303 /** @defgroup QSPI_AddressMode QSPI Address Mode
Kojto 110:165afa46840b 304 * @{
Kojto 110:165afa46840b 305 */
Kojto 110:165afa46840b 306 #define QSPI_ADDRESS_NONE ((uint32_t)0x00000000) /*!<No address*/
Kojto 110:165afa46840b 307 #define QSPI_ADDRESS_1_LINE ((uint32_t)QUADSPI_CCR_ADMODE_0) /*!<Address on a single line*/
Kojto 110:165afa46840b 308 #define QSPI_ADDRESS_2_LINES ((uint32_t)QUADSPI_CCR_ADMODE_1) /*!<Address on two lines*/
Kojto 110:165afa46840b 309 #define QSPI_ADDRESS_4_LINES ((uint32_t)QUADSPI_CCR_ADMODE) /*!<Address on four lines*/
Kojto 110:165afa46840b 310 /**
Kojto 110:165afa46840b 311 * @}
Kojto 110:165afa46840b 312 */
Kojto 110:165afa46840b 313
Kojto 110:165afa46840b 314 /** @defgroup QSPI_AlternateBytesMode QSPI Alternate Bytes Mode
Kojto 110:165afa46840b 315 * @{
Kojto 110:165afa46840b 316 */
Kojto 110:165afa46840b 317 #define QSPI_ALTERNATE_BYTES_NONE ((uint32_t)0x00000000) /*!<No alternate bytes*/
Kojto 110:165afa46840b 318 #define QSPI_ALTERNATE_BYTES_1_LINE ((uint32_t)QUADSPI_CCR_ABMODE_0) /*!<Alternate bytes on a single line*/
Kojto 110:165afa46840b 319 #define QSPI_ALTERNATE_BYTES_2_LINES ((uint32_t)QUADSPI_CCR_ABMODE_1) /*!<Alternate bytes on two lines*/
Kojto 110:165afa46840b 320 #define QSPI_ALTERNATE_BYTES_4_LINES ((uint32_t)QUADSPI_CCR_ABMODE) /*!<Alternate bytes on four lines*/
Kojto 110:165afa46840b 321 /**
Kojto 110:165afa46840b 322 * @}
Kojto 110:165afa46840b 323 */
Kojto 110:165afa46840b 324
Kojto 110:165afa46840b 325 /** @defgroup QSPI_DataMode QSPI Data Mode
Kojto 110:165afa46840b 326 * @{
Kojto 110:165afa46840b 327 */
Kojto 110:165afa46840b 328 #define QSPI_DATA_NONE ((uint32_t)0X00000000) /*!<No data*/
Kojto 110:165afa46840b 329 #define QSPI_DATA_1_LINE ((uint32_t)QUADSPI_CCR_DMODE_0) /*!<Data on a single line*/
Kojto 110:165afa46840b 330 #define QSPI_DATA_2_LINES ((uint32_t)QUADSPI_CCR_DMODE_1) /*!<Data on two lines*/
Kojto 110:165afa46840b 331 #define QSPI_DATA_4_LINES ((uint32_t)QUADSPI_CCR_DMODE) /*!<Data on four lines*/
Kojto 110:165afa46840b 332 /**
Kojto 110:165afa46840b 333 * @}
Kojto 110:165afa46840b 334 */
Kojto 110:165afa46840b 335
Kojto 110:165afa46840b 336 /** @defgroup QSPI_DdrMode QSPI Ddr Mode
Kojto 110:165afa46840b 337 * @{
Kojto 110:165afa46840b 338 */
Kojto 110:165afa46840b 339 #define QSPI_DDR_MODE_DISABLE ((uint32_t)0x00000000) /*!<Double data rate mode disabled*/
Kojto 110:165afa46840b 340 #define QSPI_DDR_MODE_ENABLE ((uint32_t)QUADSPI_CCR_DDRM) /*!<Double data rate mode enabled*/
Kojto 110:165afa46840b 341 /**
Kojto 110:165afa46840b 342 * @}
Kojto 110:165afa46840b 343 */
Kojto 110:165afa46840b 344
Kojto 110:165afa46840b 345 /** @defgroup QSPI_DdrHoldHalfCycle QSPI Ddr HoldHalfCycle
Kojto 110:165afa46840b 346 * @{
Kojto 110:165afa46840b 347 */
Kojto 110:165afa46840b 348 #define QSPI_DDR_HHC_ANALOG_DELAY ((uint32_t)0x00000000) /*!<Delay the data output using analog delay in DDR mode*/
Kojto 110:165afa46840b 349 #define QSPI_DDR_HHC_HALF_CLK_DELAY ((uint32_t)QUADSPI_CCR_DHHC) /*!<Delay the data output by 1/2 clock cycle in DDR mode*/
Kojto 110:165afa46840b 350 /**
Kojto 110:165afa46840b 351 * @}
Kojto 110:165afa46840b 352 */
Kojto 110:165afa46840b 353
Kojto 110:165afa46840b 354 /** @defgroup QSPI_SIOOMode QSPI SIOO Mode
Kojto 110:165afa46840b 355 * @{
Kojto 110:165afa46840b 356 */
Kojto 110:165afa46840b 357 #define QSPI_SIOO_INST_EVERY_CMD ((uint32_t)0x00000000) /*!<Send instruction on every transaction*/
Kojto 110:165afa46840b 358 #define QSPI_SIOO_INST_ONLY_FIRST_CMD ((uint32_t)QUADSPI_CCR_SIOO) /*!<Send instruction only for the first command*/
Kojto 110:165afa46840b 359 /**
Kojto 110:165afa46840b 360 * @}
Kojto 110:165afa46840b 361 */
Kojto 110:165afa46840b 362
Kojto 110:165afa46840b 363 /** @defgroup QSPI_MatchMode QSPI Match Mode
Kojto 110:165afa46840b 364 * @{
Kojto 110:165afa46840b 365 */
Kojto 110:165afa46840b 366 #define QSPI_MATCH_MODE_AND ((uint32_t)0x00000000) /*!<AND match mode between unmasked bits*/
Kojto 110:165afa46840b 367 #define QSPI_MATCH_MODE_OR ((uint32_t)QUADSPI_CR_PMM) /*!<OR match mode between unmasked bits*/
Kojto 110:165afa46840b 368 /**
Kojto 110:165afa46840b 369 * @}
Kojto 110:165afa46840b 370 */
Kojto 110:165afa46840b 371
Kojto 110:165afa46840b 372 /** @defgroup QSPI_AutomaticStop QSPI Automatic Stop
Kojto 110:165afa46840b 373 * @{
Kojto 110:165afa46840b 374 */
Kojto 110:165afa46840b 375 #define QSPI_AUTOMATIC_STOP_DISABLE ((uint32_t)0x00000000) /*!<AutoPolling stops only with abort or QSPI disabling*/
Kojto 110:165afa46840b 376 #define QSPI_AUTOMATIC_STOP_ENABLE ((uint32_t)QUADSPI_CR_APMS) /*!<AutoPolling stops as soon as there is a match*/
Kojto 110:165afa46840b 377 /**
Kojto 110:165afa46840b 378 * @}
Kojto 110:165afa46840b 379 */
Kojto 110:165afa46840b 380
Kojto 110:165afa46840b 381 /** @defgroup QSPI_TimeOutActivation QSPI TimeOut Activation
Kojto 110:165afa46840b 382 * @{
Kojto 110:165afa46840b 383 */
Kojto 110:165afa46840b 384 #define QSPI_TIMEOUT_COUNTER_DISABLE ((uint32_t)0x00000000) /*!<Timeout counter disabled, nCS remains active*/
Kojto 110:165afa46840b 385 #define QSPI_TIMEOUT_COUNTER_ENABLE ((uint32_t)QUADSPI_CR_TCEN) /*!<Timeout counter enabled, nCS released when timeout expires*/
Kojto 110:165afa46840b 386 /**
Kojto 110:165afa46840b 387 * @}
Kojto 110:165afa46840b 388 */
Kojto 110:165afa46840b 389
Kojto 110:165afa46840b 390 /** @defgroup QSPI_Flags QSPI Flags
Kojto 110:165afa46840b 391 * @{
Kojto 110:165afa46840b 392 */
Kojto 110:165afa46840b 393 #define QSPI_FLAG_BUSY QUADSPI_SR_BUSY /*!<Busy flag: operation is ongoing*/
Kojto 110:165afa46840b 394 #define QSPI_FLAG_TO QUADSPI_SR_TOF /*!<Timeout flag: timeout occurs in memory-mapped mode*/
Kojto 110:165afa46840b 395 #define QSPI_FLAG_SM QUADSPI_SR_SMF /*!<Status match flag: received data matches in autopolling mode*/
Kojto 110:165afa46840b 396 #define QSPI_FLAG_FT QUADSPI_SR_FTF /*!<Fifo threshold flag: Fifo threshold reached or data left after read from memory is complete*/
Kojto 110:165afa46840b 397 #define QSPI_FLAG_TC QUADSPI_SR_TCF /*!<Transfer complete flag: programmed number of data have been transferred or the transfer has been aborted*/
Kojto 110:165afa46840b 398 #define QSPI_FLAG_TE QUADSPI_SR_TEF /*!<Transfer error flag: invalid address is being accessed*/
Kojto 110:165afa46840b 399 /**
Kojto 110:165afa46840b 400 * @}
Kojto 110:165afa46840b 401 */
Kojto 110:165afa46840b 402
Kojto 110:165afa46840b 403 /** @defgroup QSPI_Interrupts QSPI Interrupts
Kojto 110:165afa46840b 404 * @{
Kojto 110:165afa46840b 405 */
Kojto 110:165afa46840b 406 #define QSPI_IT_TO QUADSPI_CR_TOIE /*!<Interrupt on the timeout flag*/
Kojto 110:165afa46840b 407 #define QSPI_IT_SM QUADSPI_CR_SMIE /*!<Interrupt on the status match flag*/
Kojto 110:165afa46840b 408 #define QSPI_IT_FT QUADSPI_CR_FTIE /*!<Interrupt on the fifo threshold flag*/
Kojto 110:165afa46840b 409 #define QSPI_IT_TC QUADSPI_CR_TCIE /*!<Interrupt on the transfer complete flag*/
Kojto 110:165afa46840b 410 #define QSPI_IT_TE QUADSPI_CR_TEIE /*!<Interrupt on the transfer error flag*/
Kojto 110:165afa46840b 411 /**
Kojto 110:165afa46840b 412 * @}
Kojto 110:165afa46840b 413 */
Kojto 110:165afa46840b 414
Kojto 110:165afa46840b 415 /** @defgroup QSPI_Timeout_definition QSPI Timeout definition
Kojto 110:165afa46840b 416 * @{
Kojto 110:165afa46840b 417 */
Kojto 110:165afa46840b 418 #define HAL_QPSI_TIMEOUT_DEFAULT_VALUE ((uint32_t)5000)/* 5 s */
Kojto 110:165afa46840b 419 /**
Kojto 110:165afa46840b 420 * @}
Kojto 110:165afa46840b 421 */
Kojto 110:165afa46840b 422
Kojto 110:165afa46840b 423 /**
Kojto 110:165afa46840b 424 * @}
Kojto 110:165afa46840b 425 */
Kojto 110:165afa46840b 426
Kojto 110:165afa46840b 427 /* Exported macros -----------------------------------------------------------*/
Kojto 110:165afa46840b 428 /** @defgroup QSPI_Exported_Macros QSPI Exported Macros
Kojto 110:165afa46840b 429 * @{
Kojto 110:165afa46840b 430 */
Kojto 110:165afa46840b 431
Kojto 110:165afa46840b 432 /** @brief Reset QSPI handle state
Kojto 110:165afa46840b 433 * @param __HANDLE__: QSPI handle.
Kojto 110:165afa46840b 434 * @retval None
Kojto 110:165afa46840b 435 */
Kojto 110:165afa46840b 436 #define __HAL_QSPI_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_QSPI_STATE_RESET)
Kojto 110:165afa46840b 437
Kojto 110:165afa46840b 438 /** @brief Enable QSPI
Kojto 110:165afa46840b 439 * @param __HANDLE__: specifies the QSPI Handle.
Kojto 110:165afa46840b 440 * @retval None
Kojto 110:165afa46840b 441 */
Kojto 110:165afa46840b 442 #define __HAL_QSPI_ENABLE(__HANDLE__) SET_BIT((__HANDLE__)->Instance->CR, QUADSPI_CR_EN)
Kojto 110:165afa46840b 443
Kojto 110:165afa46840b 444 /** @brief Disable QSPI
Kojto 110:165afa46840b 445 * @param __HANDLE__: specifies the QSPI Handle.
Kojto 110:165afa46840b 446 * @retval None
Kojto 110:165afa46840b 447 */
Kojto 110:165afa46840b 448 #define __HAL_QSPI_DISABLE(__HANDLE__) CLEAR_BIT((__HANDLE__)->Instance->CR, QUADSPI_CR_EN)
Kojto 110:165afa46840b 449
Kojto 110:165afa46840b 450 /** @brief Enables the specified QSPI interrupt.
Kojto 110:165afa46840b 451 * @param __HANDLE__: specifies the QSPI Handle.
Kojto 110:165afa46840b 452 * @param __INTERRUPT__: specifies the QSPI interrupt source to enable.
Kojto 110:165afa46840b 453 * This parameter can be one of the following values:
Kojto 110:165afa46840b 454 * @arg QSPI_IT_TO: QSPI Time out interrupt
Kojto 110:165afa46840b 455 * @arg QSPI_IT_SM: QSPI Status match interrupt
Kojto 110:165afa46840b 456 * @arg QSPI_IT_FT: QSPI FIFO threshold interrupt
Kojto 110:165afa46840b 457 * @arg QSPI_IT_TC: QSPI Transfer complete interrupt
Kojto 110:165afa46840b 458 * @arg QSPI_IT_TE: QSPI Transfer error interrupt
Kojto 110:165afa46840b 459 * @retval None
Kojto 110:165afa46840b 460 */
Kojto 110:165afa46840b 461 #define __HAL_QSPI_ENABLE_IT(__HANDLE__, __INTERRUPT__) SET_BIT((__HANDLE__)->Instance->CR, (__INTERRUPT__))
Kojto 110:165afa46840b 462
Kojto 110:165afa46840b 463
Kojto 110:165afa46840b 464 /** @brief Disables the specified QSPI interrupt.
Kojto 110:165afa46840b 465 * @param __HANDLE__: specifies the QSPI Handle.
Kojto 110:165afa46840b 466 * @param __INTERRUPT__: specifies the QSPI interrupt source to disable.
Kojto 110:165afa46840b 467 * This parameter can be one of the following values:
Kojto 110:165afa46840b 468 * @arg QSPI_IT_TO: QSPI Timeout interrupt
Kojto 110:165afa46840b 469 * @arg QSPI_IT_SM: QSPI Status match interrupt
Kojto 110:165afa46840b 470 * @arg QSPI_IT_FT: QSPI FIFO threshold interrupt
Kojto 110:165afa46840b 471 * @arg QSPI_IT_TC: QSPI Transfer complete interrupt
Kojto 110:165afa46840b 472 * @arg QSPI_IT_TE: QSPI Transfer error interrupt
Kojto 110:165afa46840b 473 * @retval None
Kojto 110:165afa46840b 474 */
Kojto 110:165afa46840b 475 #define __HAL_QSPI_DISABLE_IT(__HANDLE__, __INTERRUPT__) CLEAR_BIT((__HANDLE__)->Instance->CR, (__INTERRUPT__))
Kojto 110:165afa46840b 476
Kojto 110:165afa46840b 477 /** @brief Checks whether the specified QSPI interrupt source is enabled.
Kojto 110:165afa46840b 478 * @param __HANDLE__: specifies the QSPI Handle.
Kojto 110:165afa46840b 479 * @param __INTERRUPT__: specifies the QSPI interrupt source to check.
Kojto 110:165afa46840b 480 * This parameter can be one of the following values:
Kojto 110:165afa46840b 481 * @arg QSPI_IT_TO: QSPI Time out interrupt
Kojto 110:165afa46840b 482 * @arg QSPI_IT_SM: QSPI Status match interrupt
Kojto 110:165afa46840b 483 * @arg QSPI_IT_FT: QSPI FIFO threshold interrupt
Kojto 110:165afa46840b 484 * @arg QSPI_IT_TC: QSPI Transfer complete interrupt
Kojto 110:165afa46840b 485 * @arg QSPI_IT_TE: QSPI Transfer error interrupt
Kojto 110:165afa46840b 486 * @retval The new state of __INTERRUPT__ (TRUE or FALSE).
Kojto 110:165afa46840b 487 */
Kojto 110:165afa46840b 488 #define __HAL_QSPI_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) (READ_BIT((__HANDLE__)->Instance->CR, (__INTERRUPT__)) == (__INTERRUPT__))
Kojto 110:165afa46840b 489
Kojto 110:165afa46840b 490 /**
Kojto 110:165afa46840b 491 * @brief Get the selected QSPI's flag status.
Kojto 110:165afa46840b 492 * @param __HANDLE__: specifies the QSPI Handle.
Kojto 110:165afa46840b 493 * @param __FLAG__: specifies the QSPI flag to check.
Kojto 110:165afa46840b 494 * This parameter can be one of the following values:
Kojto 110:165afa46840b 495 * @arg QSPI_FLAG_BUSY: QSPI Busy flag
Kojto 110:165afa46840b 496 * @arg QSPI_FLAG_TO: QSPI Time out flag
Kojto 110:165afa46840b 497 * @arg QSPI_FLAG_SM: QSPI Status match flag
Kojto 110:165afa46840b 498 * @arg QSPI_FLAG_FT: QSPI FIFO threshold flag
Kojto 110:165afa46840b 499 * @arg QSPI_FLAG_TC: QSPI Transfer complete flag
Kojto 110:165afa46840b 500 * @arg QSPI_FLAG_TE: QSPI Transfer error flag
Kojto 110:165afa46840b 501 * @retval None
Kojto 110:165afa46840b 502 */
Kojto 110:165afa46840b 503 #define __HAL_QSPI_GET_FLAG(__HANDLE__, __FLAG__) (READ_BIT((__HANDLE__)->Instance->SR, (__FLAG__)) != 0)
Kojto 110:165afa46840b 504
Kojto 110:165afa46840b 505 /** @brief Clears the specified QSPI's flag status.
Kojto 110:165afa46840b 506 * @param __HANDLE__: specifies the QSPI Handle.
Kojto 110:165afa46840b 507 * @param __FLAG__: specifies the QSPI clear register flag that needs to be set
Kojto 110:165afa46840b 508 * This parameter can be one of the following values:
Kojto 110:165afa46840b 509 * @arg QSPI_FLAG_TO: QSPI Time out flag
Kojto 110:165afa46840b 510 * @arg QSPI_FLAG_SM: QSPI Status match flag
Kojto 110:165afa46840b 511 * @arg QSPI_FLAG_TC: QSPI Transfer complete flag
Kojto 110:165afa46840b 512 * @arg QSPI_FLAG_TE: QSPI Transfer error flag
Kojto 110:165afa46840b 513 * @retval None
Kojto 110:165afa46840b 514 */
Kojto 110:165afa46840b 515 #define __HAL_QSPI_CLEAR_FLAG(__HANDLE__, __FLAG__) WRITE_REG((__HANDLE__)->Instance->FCR, (__FLAG__))
Kojto 110:165afa46840b 516 /**
Kojto 110:165afa46840b 517 * @}
Kojto 110:165afa46840b 518 */
Kojto 110:165afa46840b 519
Kojto 110:165afa46840b 520 /* Exported functions --------------------------------------------------------*/
Kojto 110:165afa46840b 521 /** @addtogroup QSPI_Exported_Functions
Kojto 110:165afa46840b 522 * @{
Kojto 110:165afa46840b 523 */
Kojto 110:165afa46840b 524
Kojto 110:165afa46840b 525 /** @addtogroup QSPI_Exported_Functions_Group1
Kojto 110:165afa46840b 526 * @{
Kojto 110:165afa46840b 527 */
Kojto 110:165afa46840b 528 /* Initialization/de-initialization functions ********************************/
Kojto 110:165afa46840b 529 HAL_StatusTypeDef HAL_QSPI_Init (QSPI_HandleTypeDef *hqspi);
Kojto 110:165afa46840b 530 HAL_StatusTypeDef HAL_QSPI_DeInit (QSPI_HandleTypeDef *hqspi);
Kojto 110:165afa46840b 531 void HAL_QSPI_MspInit (QSPI_HandleTypeDef *hqspi);
Kojto 110:165afa46840b 532 void HAL_QSPI_MspDeInit(QSPI_HandleTypeDef *hqspi);
Kojto 110:165afa46840b 533 /**
Kojto 110:165afa46840b 534 * @}
Kojto 110:165afa46840b 535 */
Kojto 110:165afa46840b 536
Kojto 110:165afa46840b 537 /** @addtogroup QSPI_Exported_Functions_Group2
Kojto 110:165afa46840b 538 * @{
Kojto 110:165afa46840b 539 */
Kojto 110:165afa46840b 540 /* IO operation functions *****************************************************/
Kojto 110:165afa46840b 541 /* QSPI IRQ handler method */
Kojto 110:165afa46840b 542 void HAL_QSPI_IRQHandler(QSPI_HandleTypeDef *hqspi);
Kojto 110:165afa46840b 543
Kojto 110:165afa46840b 544 /* QSPI indirect mode */
Kojto 110:165afa46840b 545 HAL_StatusTypeDef HAL_QSPI_Command (QSPI_HandleTypeDef *hqspi, QSPI_CommandTypeDef *cmd, uint32_t Timeout);
Kojto 110:165afa46840b 546 HAL_StatusTypeDef HAL_QSPI_Transmit (QSPI_HandleTypeDef *hqspi, uint8_t *pData, uint32_t Timeout);
Kojto 110:165afa46840b 547 HAL_StatusTypeDef HAL_QSPI_Receive (QSPI_HandleTypeDef *hqspi, uint8_t *pData, uint32_t Timeout);
Kojto 110:165afa46840b 548 HAL_StatusTypeDef HAL_QSPI_Command_IT (QSPI_HandleTypeDef *hqspi, QSPI_CommandTypeDef *cmd);
Kojto 110:165afa46840b 549 HAL_StatusTypeDef HAL_QSPI_Transmit_IT (QSPI_HandleTypeDef *hqspi, uint8_t *pData);
Kojto 110:165afa46840b 550 HAL_StatusTypeDef HAL_QSPI_Receive_IT (QSPI_HandleTypeDef *hqspi, uint8_t *pData);
Kojto 110:165afa46840b 551 HAL_StatusTypeDef HAL_QSPI_Transmit_DMA (QSPI_HandleTypeDef *hqspi, uint8_t *pData);
Kojto 110:165afa46840b 552 HAL_StatusTypeDef HAL_QSPI_Receive_DMA (QSPI_HandleTypeDef *hqspi, uint8_t *pData);
Kojto 110:165afa46840b 553
Kojto 110:165afa46840b 554 /* QSPI status flag polling mode */
Kojto 110:165afa46840b 555 HAL_StatusTypeDef HAL_QSPI_AutoPolling (QSPI_HandleTypeDef *hqspi, QSPI_CommandTypeDef *cmd, QSPI_AutoPollingTypeDef *cfg, uint32_t Timeout);
Kojto 110:165afa46840b 556 HAL_StatusTypeDef HAL_QSPI_AutoPolling_IT(QSPI_HandleTypeDef *hqspi, QSPI_CommandTypeDef *cmd, QSPI_AutoPollingTypeDef *cfg);
Kojto 110:165afa46840b 557
Kojto 110:165afa46840b 558 /* QSPI memory-mapped mode */
Kojto 110:165afa46840b 559 HAL_StatusTypeDef HAL_QSPI_MemoryMapped(QSPI_HandleTypeDef *hqspi, QSPI_CommandTypeDef *cmd, QSPI_MemoryMappedTypeDef *cfg);
Kojto 110:165afa46840b 560 /**
Kojto 110:165afa46840b 561 * @}
Kojto 110:165afa46840b 562 */
Kojto 110:165afa46840b 563
Kojto 110:165afa46840b 564 /** @addtogroup QSPI_Exported_Functions_Group3
Kojto 110:165afa46840b 565 * @{
Kojto 110:165afa46840b 566 */
Kojto 110:165afa46840b 567 /* Callback functions in non-blocking modes ***********************************/
Kojto 110:165afa46840b 568 void HAL_QSPI_ErrorCallback (QSPI_HandleTypeDef *hqspi);
Kojto 110:165afa46840b 569 void HAL_QSPI_FifoThresholdCallback(QSPI_HandleTypeDef *hqspi);
Kojto 110:165afa46840b 570
Kojto 110:165afa46840b 571 /* QSPI indirect mode */
Kojto 110:165afa46840b 572 void HAL_QSPI_CmdCpltCallback (QSPI_HandleTypeDef *hqspi);
Kojto 110:165afa46840b 573 void HAL_QSPI_RxCpltCallback (QSPI_HandleTypeDef *hqspi);
Kojto 110:165afa46840b 574 void HAL_QSPI_TxCpltCallback (QSPI_HandleTypeDef *hqspi);
Kojto 110:165afa46840b 575 void HAL_QSPI_RxHalfCpltCallback (QSPI_HandleTypeDef *hqspi);
Kojto 110:165afa46840b 576 void HAL_QSPI_TxHalfCpltCallback (QSPI_HandleTypeDef *hqspi);
Kojto 110:165afa46840b 577
Kojto 110:165afa46840b 578 /* QSPI status flag polling mode */
Kojto 110:165afa46840b 579 void HAL_QSPI_StatusMatchCallback (QSPI_HandleTypeDef *hqspi);
Kojto 110:165afa46840b 580
Kojto 110:165afa46840b 581 /* QSPI memory-mapped mode */
Kojto 110:165afa46840b 582 void HAL_QSPI_TimeOutCallback (QSPI_HandleTypeDef *hqspi);
Kojto 110:165afa46840b 583 /**
Kojto 110:165afa46840b 584 * @}
Kojto 110:165afa46840b 585 */
Kojto 110:165afa46840b 586
Kojto 110:165afa46840b 587 /** @addtogroup QSPI_Exported_Functions_Group4
Kojto 110:165afa46840b 588 * @{
Kojto 110:165afa46840b 589 */
Kojto 110:165afa46840b 590 /* Peripheral Control and State functions ************************************/
Kojto 110:165afa46840b 591 HAL_QSPI_StateTypeDef HAL_QSPI_GetState(QSPI_HandleTypeDef *hqspi);
Kojto 110:165afa46840b 592 uint32_t HAL_QSPI_GetError(QSPI_HandleTypeDef *hqspi);
Kojto 110:165afa46840b 593 HAL_StatusTypeDef HAL_QSPI_Abort (QSPI_HandleTypeDef *hqspi);
Kojto 110:165afa46840b 594 void HAL_QSPI_SetTimeout(QSPI_HandleTypeDef *hqspi, uint32_t Timeout);
Kojto 110:165afa46840b 595 /**
Kojto 110:165afa46840b 596 * @}
Kojto 110:165afa46840b 597 */
Kojto 110:165afa46840b 598
Kojto 110:165afa46840b 599 /**
Kojto 110:165afa46840b 600 * @}
Kojto 110:165afa46840b 601 */
Kojto 110:165afa46840b 602
Kojto 110:165afa46840b 603 /* Private types -------------------------------------------------------------*/
Kojto 110:165afa46840b 604 /* Private variables ---------------------------------------------------------*/
Kojto 110:165afa46840b 605 /* Private constants ---------------------------------------------------------*/
Kojto 110:165afa46840b 606 /** @defgroup QSPI_Private_Constants QSPI Private Constants
Kojto 110:165afa46840b 607 * @{
Kojto 110:165afa46840b 608 */
Kojto 110:165afa46840b 609
Kojto 110:165afa46840b 610 /**
Kojto 110:165afa46840b 611 * @}
Kojto 110:165afa46840b 612 */
Kojto 110:165afa46840b 613
Kojto 110:165afa46840b 614 /* Private macros ------------------------------------------------------------*/
Kojto 110:165afa46840b 615 /** @defgroup QSPI_Private_Macros QSPI Private Macros
Kojto 110:165afa46840b 616 * @{
Kojto 110:165afa46840b 617 */
Kojto 110:165afa46840b 618 /** @defgroup QSPI_ClockPrescaler QSPI Clock Prescaler
Kojto 110:165afa46840b 619 * @{
Kojto 110:165afa46840b 620 */
Kojto 110:165afa46840b 621 #define IS_QSPI_CLOCK_PRESCALER(PRESCALER) ((PRESCALER) <= 0xFF)
Kojto 110:165afa46840b 622 /**
Kojto 110:165afa46840b 623 * @}
Kojto 110:165afa46840b 624 */
Kojto 110:165afa46840b 625
Kojto 110:165afa46840b 626 /** @defgroup QSPI_FifoThreshold QSPI Fifo Threshold
Kojto 110:165afa46840b 627 * @{
Kojto 110:165afa46840b 628 */
Kojto 110:165afa46840b 629 #define IS_QSPI_FIFO_THRESHOLD(THR) (((THR) > 0) && ((THR) <= 32))
Kojto 110:165afa46840b 630 /**
Kojto 110:165afa46840b 631 * @}
Kojto 110:165afa46840b 632 */
Kojto 110:165afa46840b 633
Kojto 110:165afa46840b 634 #define IS_QSPI_SSHIFT(SSHIFT) (((SSHIFT) == QSPI_SAMPLE_SHIFTING_NONE) || \
Kojto 110:165afa46840b 635 ((SSHIFT) == QSPI_SAMPLE_SHIFTING_HALFCYCLE))
Kojto 110:165afa46840b 636
Kojto 110:165afa46840b 637 /** @defgroup QSPI_FlashSize QSPI Flash Size
Kojto 110:165afa46840b 638 * @{
Kojto 110:165afa46840b 639 */
Kojto 110:165afa46840b 640 #define IS_QSPI_FLASH_SIZE(FSIZE) (((FSIZE) <= 31))
Kojto 110:165afa46840b 641 /**
Kojto 110:165afa46840b 642 * @}
Kojto 110:165afa46840b 643 */
Kojto 110:165afa46840b 644
Kojto 110:165afa46840b 645 #define IS_QSPI_CS_HIGH_TIME(CSHTIME) (((CSHTIME) == QSPI_CS_HIGH_TIME_1_CYCLE) || \
Kojto 110:165afa46840b 646 ((CSHTIME) == QSPI_CS_HIGH_TIME_2_CYCLE) || \
Kojto 110:165afa46840b 647 ((CSHTIME) == QSPI_CS_HIGH_TIME_3_CYCLE) || \
Kojto 110:165afa46840b 648 ((CSHTIME) == QSPI_CS_HIGH_TIME_4_CYCLE) || \
Kojto 110:165afa46840b 649 ((CSHTIME) == QSPI_CS_HIGH_TIME_5_CYCLE) || \
Kojto 110:165afa46840b 650 ((CSHTIME) == QSPI_CS_HIGH_TIME_6_CYCLE) || \
Kojto 110:165afa46840b 651 ((CSHTIME) == QSPI_CS_HIGH_TIME_7_CYCLE) || \
Kojto 110:165afa46840b 652 ((CSHTIME) == QSPI_CS_HIGH_TIME_8_CYCLE))
Kojto 110:165afa46840b 653
Kojto 110:165afa46840b 654 #define IS_QSPI_CLOCK_MODE(CLKMODE) (((CLKMODE) == QSPI_CLOCK_MODE_0) || \
Kojto 110:165afa46840b 655 ((CLKMODE) == QSPI_CLOCK_MODE_3))
Kojto 110:165afa46840b 656
Kojto 110:165afa46840b 657 #define IS_QSPI_FLASH_ID(FLA) (((FLA) == QSPI_FLASH_ID_1) || \
Kojto 110:165afa46840b 658 ((FLA) == QSPI_FLASH_ID_2))
Kojto 110:165afa46840b 659
Kojto 110:165afa46840b 660 #define IS_QSPI_DUAL_FLASH_MODE(MODE) (((MODE) == QSPI_DUALFLASH_ENABLE) || \
Kojto 110:165afa46840b 661 ((MODE) == QSPI_DUALFLASH_DISABLE))
Kojto 110:165afa46840b 662
Kojto 110:165afa46840b 663
Kojto 110:165afa46840b 664 /** @defgroup QSPI_Instruction QSPI Instruction
Kojto 110:165afa46840b 665 * @{
Kojto 110:165afa46840b 666 */
Kojto 110:165afa46840b 667 #define IS_QSPI_INSTRUCTION(INSTRUCTION) ((INSTRUCTION) <= 0xFF)
Kojto 110:165afa46840b 668 /**
Kojto 110:165afa46840b 669 * @}
Kojto 110:165afa46840b 670 */
Kojto 110:165afa46840b 671
Kojto 110:165afa46840b 672 #define IS_QSPI_ADDRESS_SIZE(ADDR_SIZE) (((ADDR_SIZE) == QSPI_ADDRESS_8_BITS) || \
Kojto 110:165afa46840b 673 ((ADDR_SIZE) == QSPI_ADDRESS_16_BITS) || \
Kojto 110:165afa46840b 674 ((ADDR_SIZE) == QSPI_ADDRESS_24_BITS) || \
Kojto 110:165afa46840b 675 ((ADDR_SIZE) == QSPI_ADDRESS_32_BITS))
Kojto 110:165afa46840b 676
Kojto 110:165afa46840b 677 #define IS_QSPI_ALTERNATE_BYTES_SIZE(SIZE) (((SIZE) == QSPI_ALTERNATE_BYTES_8_BITS) || \
Kojto 110:165afa46840b 678 ((SIZE) == QSPI_ALTERNATE_BYTES_16_BITS) || \
Kojto 110:165afa46840b 679 ((SIZE) == QSPI_ALTERNATE_BYTES_24_BITS) || \
Kojto 110:165afa46840b 680 ((SIZE) == QSPI_ALTERNATE_BYTES_32_BITS))
Kojto 110:165afa46840b 681
Kojto 110:165afa46840b 682
Kojto 110:165afa46840b 683 /** @defgroup QSPI_DummyCycles QSPI Dummy Cycles
Kojto 110:165afa46840b 684 * @{
Kojto 110:165afa46840b 685 */
Kojto 110:165afa46840b 686 #define IS_QSPI_DUMMY_CYCLES(DCY) ((DCY) <= 31)
Kojto 110:165afa46840b 687 /**
Kojto 110:165afa46840b 688 * @}
Kojto 110:165afa46840b 689 */
Kojto 110:165afa46840b 690
Kojto 110:165afa46840b 691 #define IS_QSPI_INSTRUCTION_MODE(MODE) (((MODE) == QSPI_INSTRUCTION_NONE) || \
Kojto 110:165afa46840b 692 ((MODE) == QSPI_INSTRUCTION_1_LINE) || \
Kojto 110:165afa46840b 693 ((MODE) == QSPI_INSTRUCTION_2_LINES) || \
Kojto 110:165afa46840b 694 ((MODE) == QSPI_INSTRUCTION_4_LINES))
Kojto 110:165afa46840b 695
Kojto 110:165afa46840b 696 #define IS_QSPI_ADDRESS_MODE(MODE) (((MODE) == QSPI_ADDRESS_NONE) || \
Kojto 110:165afa46840b 697 ((MODE) == QSPI_ADDRESS_1_LINE) || \
Kojto 110:165afa46840b 698 ((MODE) == QSPI_ADDRESS_2_LINES) || \
Kojto 110:165afa46840b 699 ((MODE) == QSPI_ADDRESS_4_LINES))
Kojto 110:165afa46840b 700
Kojto 110:165afa46840b 701 #define IS_QSPI_ALTERNATE_BYTES_MODE(MODE) (((MODE) == QSPI_ALTERNATE_BYTES_NONE) || \
Kojto 110:165afa46840b 702 ((MODE) == QSPI_ALTERNATE_BYTES_1_LINE) || \
Kojto 110:165afa46840b 703 ((MODE) == QSPI_ALTERNATE_BYTES_2_LINES) || \
Kojto 110:165afa46840b 704 ((MODE) == QSPI_ALTERNATE_BYTES_4_LINES))
Kojto 110:165afa46840b 705
Kojto 110:165afa46840b 706 #define IS_QSPI_DATA_MODE(MODE) (((MODE) == QSPI_DATA_NONE) || \
Kojto 110:165afa46840b 707 ((MODE) == QSPI_DATA_1_LINE) || \
Kojto 110:165afa46840b 708 ((MODE) == QSPI_DATA_2_LINES) || \
Kojto 110:165afa46840b 709 ((MODE) == QSPI_DATA_4_LINES))
Kojto 110:165afa46840b 710
Kojto 110:165afa46840b 711 #define IS_QSPI_DDR_MODE(DDR_MODE) (((DDR_MODE) == QSPI_DDR_MODE_DISABLE) || \
Kojto 110:165afa46840b 712 ((DDR_MODE) == QSPI_DDR_MODE_ENABLE))
Kojto 110:165afa46840b 713
Kojto 110:165afa46840b 714 #define IS_QSPI_DDR_HHC(DDR_HHC) (((DDR_HHC) == QSPI_DDR_HHC_ANALOG_DELAY) || \
Kojto 110:165afa46840b 715 ((DDR_HHC) == QSPI_DDR_HHC_HALF_CLK_DELAY))
Kojto 110:165afa46840b 716
Kojto 110:165afa46840b 717 #define IS_QSPI_SIOO_MODE(SIOO_MODE) (((SIOO_MODE) == QSPI_SIOO_INST_EVERY_CMD) || \
Kojto 110:165afa46840b 718 ((SIOO_MODE) == QSPI_SIOO_INST_ONLY_FIRST_CMD))
Kojto 110:165afa46840b 719
Kojto 110:165afa46840b 720 /** @defgroup QSPI_Interval QSPI Interval
Kojto 110:165afa46840b 721 * @{
Kojto 110:165afa46840b 722 */
Kojto 110:165afa46840b 723 #define IS_QSPI_INTERVAL(INTERVAL) ((INTERVAL) <= QUADSPI_PIR_INTERVAL)
Kojto 110:165afa46840b 724 /**
Kojto 110:165afa46840b 725 * @}
Kojto 110:165afa46840b 726 */
Kojto 110:165afa46840b 727
Kojto 110:165afa46840b 728 /** @defgroup QSPI_StatusBytesSize QSPI Status Bytes Size
Kojto 110:165afa46840b 729 * @{
Kojto 110:165afa46840b 730 */
Kojto 110:165afa46840b 731 #define IS_QSPI_STATUS_BYTES_SIZE(SIZE) (((SIZE) >= 1) && ((SIZE) <= 4))
Kojto 110:165afa46840b 732 /**
Kojto 110:165afa46840b 733 * @}
Kojto 110:165afa46840b 734 */
Kojto 110:165afa46840b 735 #define IS_QSPI_MATCH_MODE(MODE) (((MODE) == QSPI_MATCH_MODE_AND) || \
Kojto 110:165afa46840b 736 ((MODE) == QSPI_MATCH_MODE_OR))
Kojto 110:165afa46840b 737
Kojto 110:165afa46840b 738 #define IS_QSPI_AUTOMATIC_STOP(APMS) (((APMS) == QSPI_AUTOMATIC_STOP_DISABLE) || \
Kojto 110:165afa46840b 739 ((APMS) == QSPI_AUTOMATIC_STOP_ENABLE))
Kojto 110:165afa46840b 740
Kojto 110:165afa46840b 741 #define IS_QSPI_TIMEOUT_ACTIVATION(TCEN) (((TCEN) == QSPI_TIMEOUT_COUNTER_DISABLE) || \
Kojto 110:165afa46840b 742 ((TCEN) == QSPI_TIMEOUT_COUNTER_ENABLE))
Kojto 110:165afa46840b 743
Kojto 110:165afa46840b 744 /** @defgroup QSPI_TimeOutPeriod QSPI TimeOut Period
Kojto 110:165afa46840b 745 * @{
Kojto 110:165afa46840b 746 */
Kojto 110:165afa46840b 747 #define IS_QSPI_TIMEOUT_PERIOD(PERIOD) ((PERIOD) <= 0xFFFF)
Kojto 110:165afa46840b 748 /**
Kojto 110:165afa46840b 749 * @}
Kojto 110:165afa46840b 750 */
Kojto 110:165afa46840b 751
Kojto 110:165afa46840b 752 #define IS_QSPI_GET_FLAG(FLAG) (((FLAG) == QSPI_FLAG_BUSY) || \
Kojto 110:165afa46840b 753 ((FLAG) == QSPI_FLAG_TO) || \
Kojto 110:165afa46840b 754 ((FLAG) == QSPI_FLAG_SM) || \
Kojto 110:165afa46840b 755 ((FLAG) == QSPI_FLAG_FT) || \
Kojto 110:165afa46840b 756 ((FLAG) == QSPI_FLAG_TC) || \
Kojto 110:165afa46840b 757 ((FLAG) == QSPI_FLAG_TE))
Kojto 110:165afa46840b 758
Kojto 110:165afa46840b 759 #define IS_QSPI_IT(IT) ((((IT) & (uint32_t)0xFFE0FFFF) == 0x00000000) && ((IT) != 0x00000000))
Kojto 110:165afa46840b 760 /**
Kojto 110:165afa46840b 761 * @}
Kojto 110:165afa46840b 762 */
Kojto 110:165afa46840b 763
Kojto 110:165afa46840b 764 /* Private functions ---------------------------------------------------------*/
Kojto 110:165afa46840b 765 /** @defgroup QSPI_Private_Functions QSPI Private Functions
Kojto 110:165afa46840b 766 * @{
Kojto 110:165afa46840b 767 */
Kojto 110:165afa46840b 768
Kojto 110:165afa46840b 769 /**
Kojto 110:165afa46840b 770 * @}
Kojto 110:165afa46840b 771 */
Kojto 110:165afa46840b 772
Kojto 110:165afa46840b 773 /**
Kojto 110:165afa46840b 774 * @}
Kojto 110:165afa46840b 775 */
Kojto 110:165afa46840b 776
Kojto 110:165afa46840b 777 /**
Kojto 110:165afa46840b 778 * @}
Kojto 110:165afa46840b 779 */
Kojto 110:165afa46840b 780 #endif /* STM32F446xx || STM32F469xx || STM32F479xx */
Kojto 110:165afa46840b 781
Kojto 110:165afa46840b 782 #ifdef __cplusplus
Kojto 110:165afa46840b 783 }
Kojto 110:165afa46840b 784 #endif
Kojto 110:165afa46840b 785
Kojto 110:165afa46840b 786 #endif /* __STM32F4xx_HAL_QSPI_H */
Kojto 110:165afa46840b 787
Kojto 110:165afa46840b 788 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/