diff options
Diffstat (limited to 'bsps/arm/stm32h7/include/stm32h7xx_hal_ospi.h')
| -rw-r--r-- | bsps/arm/stm32h7/include/stm32h7xx_hal_ospi.h | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_ospi.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_ospi.h index 78e991aadd..7467897d8a 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_ospi.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_ospi.h @@ -39,6 +39,7 @@ /* Exported types ------------------------------------------------------------*/ /** @defgroup OSPI_Exported_Types OSPI Exported Types + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ @@ -292,10 +293,12 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); /* Exported constants --------------------------------------------------------*/ /** @defgroup OSPI_Exported_Constants OSPI Exported Constants + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ /** @defgroup OSPI_State OSPI State + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_OSPI_STATE_RESET ((uint32_t)0x00000000U) /*!< Initial state */ @@ -316,6 +319,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */ /** @defgroup OSPI_ErrorCode OSPI Error Code + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_OSPI_ERROR_NONE ((uint32_t)0x00000000U) /*!< No error */ @@ -332,6 +336,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */ /** @defgroup OSPI_DualQuad OSPI Dual-Quad + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_OSPI_DUALQUAD_DISABLE ((uint32_t)0x00000000U) /*!< Dual-Quad mode disabled */ @@ -341,6 +346,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */ /** @defgroup OSPI_MemoryType OSPI Memory Type + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_OSPI_MEMTYPE_MICRON ((uint32_t)0x00000000U) /*!< Micron mode */ @@ -353,6 +359,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */ /** @defgroup OSPI_FreeRunningClock OSPI Free Running Clock + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_OSPI_FREERUNCLK_DISABLE ((uint32_t)0x00000000U) /*!< CLK is not free running */ @@ -362,6 +369,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */ /** @defgroup OSPI_ClockMode OSPI Clock Mode + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_OSPI_CLOCK_MODE_0 ((uint32_t)0x00000000U) /*!< CLK must stay low while nCS is high */ @@ -371,6 +379,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */ /** @defgroup OSPI_WrapSize OSPI Wrap-Size + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_OSPI_WRAP_NOT_SUPPORTED ((uint32_t)0x00000000U) /*!< wrapped reads are not supported by the memory */ @@ -383,6 +392,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */ /** @defgroup OSPI_SampleShifting OSPI Sample Shifting + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_OSPI_SAMPLE_SHIFTING_NONE ((uint32_t)0x00000000U) /*!< No shift */ @@ -392,6 +402,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */ /** @defgroup OSPI_DelayHoldQuarterCycle OSPI Delay Hold Quarter Cycle + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_OSPI_DHQC_DISABLE ((uint32_t)0x00000000U) /*!< No Delay */ @@ -401,6 +412,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */ /** @defgroup OSPI_DelayBlockBypass OSPI Delay Block Bypaas + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_OSPI_DELAY_BLOCK_USED ((uint32_t)0x00000000U) /*!< Sampling clock is delayed by the delay block */ @@ -410,6 +422,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */ /** @defgroup OSPI_OperationType OSPI Operation Type + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_OSPI_OPTYPE_COMMON_CFG ((uint32_t)0x00000000U) /*!< Common configuration (indirect or auto-polling mode) */ @@ -421,6 +434,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */ /** @defgroup OSPI_FlashID OSPI Flash Id + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_OSPI_FLASH_ID_1 ((uint32_t)0x00000000U) /*!< FLASH 1 selected */ @@ -430,6 +444,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */ /** @defgroup OSPI_InstructionMode OSPI Instruction Mode + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_OSPI_INSTRUCTION_NONE ((uint32_t)0x00000000U) /*!< No instruction */ @@ -442,6 +457,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */ /** @defgroup OSPI_InstructionSize OSPI Instruction Size + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_OSPI_INSTRUCTION_8_BITS ((uint32_t)0x00000000U) /*!< 8-bit instruction */ @@ -453,6 +469,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */ /** @defgroup OSPI_InstructionDtrMode OSPI Instruction DTR Mode + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_OSPI_INSTRUCTION_DTR_DISABLE ((uint32_t)0x00000000U) /*!< DTR mode disabled for instruction phase */ @@ -462,6 +479,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */ /** @defgroup OSPI_AddressMode OSPI Address Mode + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_OSPI_ADDRESS_NONE ((uint32_t)0x00000000U) /*!< No address */ @@ -474,6 +492,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */ /** @defgroup OSPI_AddressSize OSPI Address Size + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_OSPI_ADDRESS_8_BITS ((uint32_t)0x00000000U) /*!< 8-bit address */ @@ -485,6 +504,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */ /** @defgroup OSPI_AddressDtrMode OSPI Address DTR Mode + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_OSPI_ADDRESS_DTR_DISABLE ((uint32_t)0x00000000U) /*!< DTR mode disabled for address phase */ @@ -494,6 +514,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */ /** @defgroup OSPI_AlternateBytesMode OSPI Alternate Bytes Mode + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_OSPI_ALTERNATE_BYTES_NONE ((uint32_t)0x00000000U) /*!< No alternate bytes */ @@ -506,6 +527,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */ /** @defgroup OSPI_AlternateBytesSize OSPI Alternate Bytes Size + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_OSPI_ALTERNATE_BYTES_8_BITS ((uint32_t)0x00000000U) /*!< 8-bit alternate bytes */ @@ -517,6 +539,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */ /** @defgroup OSPI_AlternateBytesDtrMode OSPI Alternate Bytes DTR Mode + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_OSPI_ALTERNATE_BYTES_DTR_DISABLE ((uint32_t)0x00000000U) /*!< DTR mode disabled for alternate bytes phase */ @@ -526,6 +549,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */ /** @defgroup OSPI_DataMode OSPI Data Mode + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_OSPI_DATA_NONE ((uint32_t)0x00000000U) /*!< No data */ @@ -538,6 +562,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */ /** @defgroup OSPI_DataDtrMode OSPI Data DTR Mode + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_OSPI_DATA_DTR_DISABLE ((uint32_t)0x00000000U) /*!< DTR mode disabled for data phase */ @@ -547,6 +572,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */ /** @defgroup OSPI_DQSMode OSPI DQS Mode + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_OSPI_DQS_DISABLE ((uint32_t)0x00000000U) /*!< DQS disabled */ @@ -556,6 +582,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */ /** @defgroup OSPI_SIOOMode OSPI SIOO Mode + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_OSPI_SIOO_INST_EVERY_CMD ((uint32_t)0x00000000U) /*!< Send instruction on every transaction */ @@ -565,6 +592,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */ /** @defgroup OSPI_WriteZeroLatency OSPI Hyperbus Write Zero Latency Activation + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_OSPI_LATENCY_ON_WRITE ((uint32_t)0x00000000U) /*!< Latency on write accesses */ @@ -574,6 +602,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */ /** @defgroup OSPI_LatencyMode OSPI Hyperbus Latency Mode + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_OSPI_VARIABLE_LATENCY ((uint32_t)0x00000000U) /*!< Variable initial latency */ @@ -583,6 +612,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */ /** @defgroup OSPI_AddressSpace OSPI Hyperbus Address Space + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_OSPI_MEMORY_ADDRESS_SPACE ((uint32_t)0x00000000U) /*!< HyperBus memory mode */ @@ -592,6 +622,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */ /** @defgroup OSPI_MatchMode OSPI Match Mode + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_OSPI_MATCH_MODE_AND ((uint32_t)0x00000000U) /*!< AND match mode between unmasked bits */ @@ -601,6 +632,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */ /** @defgroup OSPI_AutomaticStop OSPI Automatic Stop + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_OSPI_AUTOMATIC_STOP_DISABLE ((uint32_t)0x00000000U) /*!< AutoPolling stops only with abort or OSPI disabling */ @@ -610,6 +642,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */ /** @defgroup OSPI_TimeOutActivation OSPI Timeout Activation + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_OSPI_TIMEOUT_COUNTER_DISABLE ((uint32_t)0x00000000U) /*!< Timeout counter disabled, nCS remains active */ @@ -619,6 +652,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */ /** @defgroup OSPI_Flags OSPI Flags + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_OSPI_FLAG_BUSY OCTOSPI_SR_BUSY /*!< Busy flag: operation is ongoing */ @@ -632,6 +666,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */ /** @defgroup OSPI_Interrupts OSPI Interrupts + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_OSPI_IT_TO OCTOSPI_CR_TOIE /*!< Interrupt on the timeout flag */ @@ -644,6 +679,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */ /** @defgroup OSPI_Timeout_definition OSPI Timeout definition + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_OSPI_TIMEOUT_DEFAULT_VALUE ((uint32_t)5000U) /* 5 s */ @@ -652,6 +688,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); */ /** @defgroup OSPIM_IOPort OSPI IO Manager IO Port + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ #define HAL_OSPIM_IOPORT_NONE ((uint32_t)0x00000000U) /*!< IOs not used */ @@ -680,6 +717,7 @@ typedef void (*pOSPI_CallbackTypeDef)(OSPI_HandleTypeDef *hospi); /* Exported macros -----------------------------------------------------------*/ /** @defgroup OSPI_Exported_Macros OSPI Exported Macros + * @ingroup RTEMSBSPsARMSTM32H7 * @{ */ /** @brief Reset OSPI handle state. |