Elijah Orr / mbed-renbed

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   1-RenBuggyTimed RenBED_RGB RenBED_RGB_PWM RenBED_RGB

Fork of mbed by mbed official

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