summaryrefslogtreecommitdiff
path: root/bsps/arm/stm32h7/include/stm32h7xx_hal_qspi.h
diff options
context:
space:
mode:
Diffstat (limited to 'bsps/arm/stm32h7/include/stm32h7xx_hal_qspi.h')
-rw-r--r--bsps/arm/stm32h7/include/stm32h7xx_hal_qspi.h25
1 files changed, 25 insertions, 0 deletions
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_qspi.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_qspi.h
index 39eb5faa49..f0d8d9c419 100644
--- a/bsps/arm/stm32h7/include/stm32h7xx_hal_qspi.h
+++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_qspi.h
@@ -39,6 +39,7 @@
/* Exported types ------------------------------------------------------------*/
/** @defgroup QSPI_Exported_Types QSPI Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
@@ -220,10 +221,12 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi);
/* Exported constants --------------------------------------------------------*/
/** @defgroup QSPI_Exported_Constants QSPI Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
/** @defgroup QSPI_ErrorCode QSPI Error Code
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define HAL_QSPI_ERROR_NONE 0x00000000U /*!< No error */
@@ -239,6 +242,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi);
*/
/** @defgroup QSPI_SampleShifting QSPI Sample Shifting
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define QSPI_SAMPLE_SHIFTING_NONE 0x00000000U /*!<No clock cycle shift to sample data*/
@@ -248,6 +252,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi);
*/
/** @defgroup QSPI_ChipSelectHighTime QSPI ChipSelect High Time
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define QSPI_CS_HIGH_TIME_1_CYCLE 0x00000000U /*!<nCS stay high for at least 1 clock cycle between commands*/
@@ -263,6 +268,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi);
*/
/** @defgroup QSPI_ClockMode QSPI Clock Mode
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define QSPI_CLOCK_MODE_0 0x00000000U /*!<Clk stays low while nCS is released*/
@@ -272,6 +278,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi);
*/
/** @defgroup QSPI_Flash_Select QSPI Flash Select
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define QSPI_FLASH_ID_1 0x00000000U /*!<FLASH 1 selected*/
@@ -281,6 +288,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi);
*/
/** @defgroup QSPI_DualFlash_Mode QSPI Dual Flash Mode
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define QSPI_DUALFLASH_ENABLE ((uint32_t)QUADSPI_CR_DFM) /*!<Dual-flash mode enabled*/
@@ -290,6 +298,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi);
*/
/** @defgroup QSPI_AddressSize QSPI Address Size
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define QSPI_ADDRESS_8_BITS 0x00000000U /*!<8-bit address*/
@@ -301,6 +310,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi);
*/
/** @defgroup QSPI_AlternateBytesSize QSPI Alternate Bytes Size
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define QSPI_ALTERNATE_BYTES_8_BITS 0x00000000U /*!<8-bit alternate bytes*/
@@ -312,6 +322,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi);
*/
/** @defgroup QSPI_InstructionMode QSPI Instruction Mode
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define QSPI_INSTRUCTION_NONE 0x00000000U /*!<No instruction*/
@@ -323,6 +334,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi);
*/
/** @defgroup QSPI_AddressMode QSPI Address Mode
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define QSPI_ADDRESS_NONE 0x00000000U /*!<No address*/
@@ -334,6 +346,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi);
*/
/** @defgroup QSPI_AlternateBytesMode QSPI Alternate Bytes Mode
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define QSPI_ALTERNATE_BYTES_NONE 0x00000000U /*!<No alternate bytes*/
@@ -345,6 +358,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi);
*/
/** @defgroup QSPI_DataMode QSPI Data Mode
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define QSPI_DATA_NONE 0x00000000U /*!<No data*/
@@ -356,6 +370,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi);
*/
/** @defgroup QSPI_DdrMode QSPI DDR Mode
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define QSPI_DDR_MODE_DISABLE 0x00000000U /*!<Double data rate mode disabled*/
@@ -365,6 +380,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi);
*/
/** @defgroup QSPI_DdrHoldHalfCycle QSPI DDR Data Output Delay
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define QSPI_DDR_HHC_ANALOG_DELAY 0x00000000U /*!<Delay the data output using analog delay in DDR mode*/
@@ -374,6 +390,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi);
*/
/** @defgroup QSPI_SIOOMode QSPI Send Instruction Mode
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define QSPI_SIOO_INST_EVERY_CMD 0x00000000U /*!<Send instruction on every transaction*/
@@ -383,6 +400,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi);
*/
/** @defgroup QSPI_MatchMode QSPI Match Mode
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define QSPI_MATCH_MODE_AND 0x00000000U /*!<AND match mode between unmasked bits*/
@@ -392,6 +410,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi);
*/
/** @defgroup QSPI_AutomaticStop QSPI Automatic Stop
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define QSPI_AUTOMATIC_STOP_DISABLE 0x00000000U /*!<AutoPolling stops only with abort or QSPI disabling*/
@@ -401,6 +420,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi);
*/
/** @defgroup QSPI_TimeOutActivation QSPI Timeout Activation
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define QSPI_TIMEOUT_COUNTER_DISABLE 0x00000000U /*!<Timeout counter disabled, nCS remains active*/
@@ -410,6 +430,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi);
*/
/** @defgroup QSPI_Flags QSPI Flags
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define QSPI_FLAG_BUSY QUADSPI_SR_BUSY /*!<Busy flag: operation is ongoing*/
@@ -423,6 +444,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi);
*/
/** @defgroup QSPI_Interrupts QSPI Interrupts
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define QSPI_IT_TO QUADSPI_CR_TOIE /*!<Interrupt on the timeout flag*/
@@ -435,6 +457,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi);
*/
/** @defgroup QSPI_Timeout_definition QSPI Timeout definition
+ * @ingroup RTEMSBSPsARMSTM32H7
* @brief QSPI Timeout definition
* @{
*/
@@ -449,6 +472,7 @@ typedef void (*pQSPI_CallbackTypeDef)(QSPI_HandleTypeDef *hqspi);
/* Exported macros -----------------------------------------------------------*/
/** @defgroup QSPI_Exported_Macros QSPI Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
/** @brief Reset QSPI handle state.
@@ -636,6 +660,7 @@ HAL_StatusTypeDef HAL_QSPI_SetFlashID (QSPI_HandleTypeDef *hqspi, uint3
/* Private macros ------------------------------------------------------------*/
/** @defgroup QSPI_Private_Macros QSPI Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define IS_QSPI_CLOCK_PRESCALER(PRESCALER) ((PRESCALER) <= 0xFFU)