summaryrefslogtreecommitdiff
path: root/bsps/arm/stm32h7/include/stm32h7xx_hal_mmc.h
diff options
context:
space:
mode:
Diffstat (limited to 'bsps/arm/stm32h7/include/stm32h7xx_hal_mmc.h')
-rw-r--r--bsps/arm/stm32h7/include/stm32h7xx_hal_mmc.h32
1 files changed, 32 insertions, 0 deletions
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_mmc.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_mmc.h
index ed4e5e5ade..98e5c1a5bb 100644
--- a/bsps/arm/stm32h7/include/stm32h7xx_hal_mmc.h
+++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_mmc.h
@@ -37,10 +37,12 @@ extern "C" {
/* Exported types ------------------------------------------------------------*/
/** @defgroup MMC_Exported_Types MMC Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
/** @defgroup MMC_Exported_Types_Group1 MMC State enumeration structure
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
typedef enum
@@ -59,6 +61,7 @@ typedef enum
*/
/** @defgroup MMC_Exported_Types_Group2 MMC Card State enumeration structure
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
typedef uint32_t HAL_MMC_CardStateTypeDef;
@@ -80,6 +83,7 @@ typedef uint32_t HAL_MMC_CardStateTypeDef;
*/
/** @defgroup MMC_Exported_Types_Group3 MMC Handle Structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define MMC_InitTypeDef SDMMC_InitTypeDef
@@ -164,6 +168,7 @@ typedef struct
*/
/** @defgroup MMC_Exported_Types_Group4 Card Specific Data: CSD Register
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
typedef struct
@@ -212,6 +217,7 @@ typedef struct
*/
/** @defgroup MMC_Exported_Types_Group5 Card Identification Data: CID Register
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
typedef struct
@@ -234,6 +240,7 @@ typedef struct
#if defined (USE_HAL_MMC_REGISTER_CALLBACKS) && (USE_HAL_MMC_REGISTER_CALLBACKS == 1U)
/** @defgroup MMC_Exported_Types_Group6 MMC Callback ID enumeration definition
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
typedef enum
@@ -255,6 +262,7 @@ typedef enum
*/
/** @defgroup MMC_Exported_Types_Group7 MMC Callback pointer definition
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
typedef void (*pMMC_CallbackTypeDef)(MMC_HandleTypeDef *hmmc);
@@ -268,12 +276,14 @@ typedef void (*pMMC_CallbackTypeDef)(MMC_HandleTypeDef *hmmc);
/* Exported constants --------------------------------------------------------*/
/** @defgroup MMC_Exported_Constants Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define MMC_BLOCKSIZE ((uint32_t)512U) /*!< Block size is 512 bytes */
/** @defgroup MMC_Exported_Constansts_Group1 MMC Error status enumeration Structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define HAL_MMC_ERROR_NONE SDMMC_ERROR_NONE /*!< No error */
@@ -321,6 +331,7 @@ typedef void (*pMMC_CallbackTypeDef)(MMC_HandleTypeDef *hmmc);
*/
/** @defgroup MMC_Exported_Constansts_Group2 MMC context enumeration
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define MMC_CONTEXT_NONE ((uint32_t)0x00000000U) /*!< None */
@@ -336,6 +347,7 @@ typedef void (*pMMC_CallbackTypeDef)(MMC_HandleTypeDef *hmmc);
*/
/** @defgroup MMC_Exported_Constansts_Group3 MMC Voltage mode
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
/**
@@ -353,6 +365,7 @@ typedef void (*pMMC_CallbackTypeDef)(MMC_HandleTypeDef *hmmc);
*/
/** @defgroup MMC_Exported_Constansts_Group4 MMC Memory Cards
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define MMC_LOW_CAPACITY_CARD ((uint32_t)0x00000000U) /*!< MMC Card Capacity <=2Gbytes */
@@ -363,6 +376,7 @@ typedef void (*pMMC_CallbackTypeDef)(MMC_HandleTypeDef *hmmc);
*/
/** @defgroup MMC_Exported_Constansts_Group5 MMC Erase Type
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define HAL_MMC_ERASE 0x00000000U /*!< Erase the erase groups identified by CMD35 & 36 */
@@ -383,6 +397,7 @@ typedef void (*pMMC_CallbackTypeDef)(MMC_HandleTypeDef *hmmc);
*/
/** @defgroup MMC_Exported_Constansts_Group6 MMC Secure Removal Type
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define HAL_MMC_SRT_ERASE 0x00000001U /*!< Information removed by an erase */
@@ -405,6 +420,7 @@ typedef void (*pMMC_CallbackTypeDef)(MMC_HandleTypeDef *hmmc);
/* Exported macro ------------------------------------------------------------*/
/** @defgroup MMC_Exported_macros MMC Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7
* @brief macros to handle interrupts and specific clock configurations
* @{
*/
@@ -626,10 +642,12 @@ typedef void (*pMMC_CallbackTypeDef)(MMC_HandleTypeDef *hmmc);
/* Exported functions --------------------------------------------------------*/
/** @defgroup MMC_Exported_Functions MMC Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
/** @defgroup MMC_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
HAL_StatusTypeDef HAL_MMC_Init(MMC_HandleTypeDef *hmmc);
@@ -643,6 +661,7 @@ void HAL_MMC_MspDeInit(MMC_HandleTypeDef *hmmc);
*/
/** @defgroup MMC_Exported_Functions_Group2 Input and Output operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
/* Blocking mode: Polling */
@@ -682,6 +701,7 @@ HAL_StatusTypeDef HAL_MMC_UnRegisterCallback(MMC_HandleTypeDef *hmmc, HAL_MMC_Ca
*/
/** @defgroup MMC_Exported_Functions_Group3 Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
HAL_StatusTypeDef HAL_MMC_ConfigWideBusOperation(MMC_HandleTypeDef *hmmc, uint32_t WideMode);
@@ -691,6 +711,7 @@ HAL_StatusTypeDef HAL_MMC_ConfigSpeedBusOperation(MMC_HandleTypeDef *hmmc, uint3
*/
/** @defgroup MMC_Exported_Functions_Group4 MMC card related functions
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
HAL_MMC_CardStateTypeDef HAL_MMC_GetCardState(MMC_HandleTypeDef *hmmc);
@@ -703,6 +724,7 @@ HAL_StatusTypeDef HAL_MMC_GetCardExtCSD(MMC_HandleTypeDef *hmmc, uint32_t *pExtC
*/
/** @defgroup MMC_Exported_Functions_Group5 Peripheral State and Errors functions
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
HAL_MMC_StateTypeDef HAL_MMC_GetState(MMC_HandleTypeDef *hmmc);
@@ -712,6 +734,7 @@ uint32_t HAL_MMC_GetError(MMC_HandleTypeDef *hmmc);
*/
/** @defgroup MMC_Exported_Functions_Group6 Peripheral Abort management
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
HAL_StatusTypeDef HAL_MMC_Abort(MMC_HandleTypeDef *hmmc);
@@ -721,6 +744,7 @@ HAL_StatusTypeDef HAL_MMC_Abort_IT(MMC_HandleTypeDef *hmmc);
*/
/** @defgroup MMC_Exported_Functions_Group7 Peripheral Erase management
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
HAL_StatusTypeDef HAL_MMC_EraseSequence(MMC_HandleTypeDef *hmmc, uint32_t EraseType, uint32_t BlockStartAdd,
@@ -733,6 +757,7 @@ HAL_StatusTypeDef HAL_MMC_GetSupportedSecRemovalType(MMC_HandleTypeDef *hmmc, ui
*/
/** @defgroup MMC_Exported_Functions_Group8 Peripheral Sleep management
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
HAL_StatusTypeDef HAL_MMC_SleepDevice(MMC_HandleTypeDef *hmmc);
@@ -742,6 +767,7 @@ HAL_StatusTypeDef HAL_MMC_AwakeDevice(MMC_HandleTypeDef *hmmc);
*/
/* Private types -------------------------------------------------------------*/
/** @defgroup MMC_Private_Types MMC Private Types
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
@@ -751,6 +777,7 @@ HAL_StatusTypeDef HAL_MMC_AwakeDevice(MMC_HandleTypeDef *hmmc);
/* Private defines -----------------------------------------------------------*/
/** @defgroup MMC_Private_Defines MMC Private Defines
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define MMC_EXT_CSD_DATA_SEC_SIZE_INDEX 61
@@ -761,6 +788,7 @@ HAL_StatusTypeDef HAL_MMC_AwakeDevice(MMC_HandleTypeDef *hmmc);
/* Private variables ---------------------------------------------------------*/
/** @defgroup MMC_Private_Variables MMC Private Variables
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
@@ -770,6 +798,7 @@ HAL_StatusTypeDef HAL_MMC_AwakeDevice(MMC_HandleTypeDef *hmmc);
/* Private constants ---------------------------------------------------------*/
/** @defgroup MMC_Private_Constants MMC Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
@@ -779,6 +808,7 @@ HAL_StatusTypeDef HAL_MMC_AwakeDevice(MMC_HandleTypeDef *hmmc);
/* Private macros ------------------------------------------------------------*/
/** @defgroup MMC_Private_Macros MMC Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
@@ -788,6 +818,7 @@ HAL_StatusTypeDef HAL_MMC_AwakeDevice(MMC_HandleTypeDef *hmmc);
/* Private functions prototypes ----------------------------------------------*/
/** @defgroup MMC_Private_Functions_Prototypes MMC Private Functions Prototypes
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
@@ -797,6 +828,7 @@ HAL_StatusTypeDef HAL_MMC_AwakeDevice(MMC_HandleTypeDef *hmmc);
/* Private functions ---------------------------------------------------------*/
/** @defgroup MMC_Private_Functions MMC Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-20 16:46:10 +0000