diff options
Diffstat (limited to 'bsps/arm/stm32h7/include/stm32h7xx_hal_sd.h')
| -rw-r--r-- | bsps/arm/stm32h7/include/stm32h7xx_hal_sd.h | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_sd.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_sd.h index b69533120f..caeff95153 100644 --- a/bsps/arm/stm32h7/include/stm32h7xx_hal_sd.h +++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_sd.h @@ -36,16 +36,19 @@ */
/** @defgroup SD SD
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief SD HAL module driver
* @{
*/
/* Exported types ------------------------------------------------------------*/
/** @defgroup SD_Exported_Types SD Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup SD_Exported_Types_Group1 SD State enumeration structure
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
typedef enum
@@ -64,6 +67,7 @@ typedef enum */
/** @defgroup SD_Exported_Types_Group2 SD Card State enumeration structure
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
typedef uint32_t HAL_SD_CardStateTypeDef;
@@ -82,6 +86,7 @@ typedef uint32_t HAL_SD_CardStateTypeDef; */
/** @defgroup SD_Exported_Types_Group3 SD Handle Structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SD_InitTypeDef SDMMC_InitTypeDef
@@ -171,6 +176,7 @@ typedef struct */
/** @defgroup SD_Exported_Types_Group4 Card Specific Data: CSD Register
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
typedef struct
@@ -218,6 +224,7 @@ typedef struct */
/** @defgroup SD_Exported_Types_Group5 Card Identification Data: CID Register
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
typedef struct
@@ -239,6 +246,7 @@ typedef struct */
/** @defgroup SD_Exported_Types_Group6 SD Card Status returned by ACMD13
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
typedef struct
@@ -263,6 +271,7 @@ typedef struct #if defined (USE_HAL_SD_REGISTER_CALLBACKS) && (USE_HAL_SD_REGISTER_CALLBACKS == 1U)
/** @defgroup SD_Exported_Types_Group7 SD Callback ID enumeration definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
typedef enum
@@ -284,6 +293,7 @@ typedef enum */
/** @defgroup SD_Exported_Types_Group8 SD Callback pointer definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
typedef void (*pSD_CallbackTypeDef) (SD_HandleTypeDef *hsd);
@@ -300,12 +310,14 @@ typedef void (*pSD_TransceiverCallbackTypeDef)(FlagStatus status); /* Exported constants --------------------------------------------------------*/
/** @defgroup SD_Exported_Constants Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define BLOCKSIZE ((uint32_t)512U) /*!< Block size is 512 bytes */
/** @defgroup SD_Exported_Constansts_Group1 SD Error status enumeration Structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define HAL_SD_ERROR_NONE SDMMC_ERROR_NONE /*!< No error */
@@ -353,6 +365,7 @@ typedef void (*pSD_TransceiverCallbackTypeDef)(FlagStatus status); */
/** @defgroup SD_Exported_Constansts_Group2 SD context enumeration
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define SD_CONTEXT_NONE ((uint32_t)0x00000000U) /*!< None */
@@ -368,6 +381,7 @@ typedef void (*pSD_TransceiverCallbackTypeDef)(FlagStatus status); */
/** @defgroup SD_Exported_Constansts_Group3 SD Supported Memory Cards
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define CARD_NORMAL_SPEED ((uint32_t)0x00000000U) /*!< Normal Speed Card <12.5Mo/s , Spec Version 1.01 */
@@ -384,6 +398,7 @@ typedef void (*pSD_TransceiverCallbackTypeDef)(FlagStatus status); */
/** @defgroup SD_Exported_Constansts_Group4 SD Supported Version
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
#define CARD_V1_X ((uint32_t)0x00000000U)
@@ -398,6 +413,7 @@ typedef void (*pSD_TransceiverCallbackTypeDef)(FlagStatus status); /* Exported macro ------------------------------------------------------------*/
/** @defgroup SD_Exported_macros SD Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @brief macros to handle interrupts and specific clock configurations
* @{
*/
@@ -615,10 +631,12 @@ typedef void (*pSD_TransceiverCallbackTypeDef)(FlagStatus status); /* Exported functions --------------------------------------------------------*/
/** @defgroup SD_Exported_Functions SD Exported Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/** @defgroup SD_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_StatusTypeDef HAL_SD_Init (SD_HandleTypeDef *hsd);
@@ -631,6 +649,7 @@ void HAL_SD_MspDeInit(SD_HandleTypeDef *hsd); */
/** @defgroup SD_Exported_Functions_Group2 Input and Output operation functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
/* Blocking mode: Polling */
@@ -673,6 +692,7 @@ HAL_StatusTypeDef HAL_SD_UnRegisterTransceiverCallback(SD_HandleTypeDef *hsd); */
/** @defgroup SD_Exported_Functions_Group3 Peripheral Control functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_StatusTypeDef HAL_SD_ConfigWideBusOperation(SD_HandleTypeDef *hsd, uint32_t WideMode);
@@ -682,6 +702,7 @@ HAL_StatusTypeDef HAL_SD_ConfigSpeedBusOperation(SD_HandleTypeDef *hsd, uint32_t */
/** @defgroup SD_Exported_Functions_Group4 SD card related functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_SD_CardStateTypeDef HAL_SD_GetCardState(SD_HandleTypeDef *hsd);
@@ -694,6 +715,7 @@ HAL_StatusTypeDef HAL_SD_GetCardInfo (SD_HandleTypeDef *hsd, HAL_SD_CardI */
/** @defgroup SD_Exported_Functions_Group5 Peripheral State and Errors functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_SD_StateTypeDef HAL_SD_GetState(SD_HandleTypeDef *hsd);
@@ -703,6 +725,7 @@ uint32_t HAL_SD_GetError(SD_HandleTypeDef *hsd); */
/** @defgroup SD_Exported_Functions_Group6 Perioheral Abort management
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
HAL_StatusTypeDef HAL_SD_Abort (SD_HandleTypeDef *hsd);
@@ -713,6 +736,7 @@ HAL_StatusTypeDef HAL_SD_Abort_IT(SD_HandleTypeDef *hsd); /* Private types -------------------------------------------------------------*/
/** @defgroup SD_Private_Types SD Private Types
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -722,6 +746,7 @@ HAL_StatusTypeDef HAL_SD_Abort_IT(SD_HandleTypeDef *hsd); /* Private defines -----------------------------------------------------------*/
/** @defgroup SD_Private_Defines SD Private Defines
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -731,6 +756,7 @@ HAL_StatusTypeDef HAL_SD_Abort_IT(SD_HandleTypeDef *hsd); /* Private variables ---------------------------------------------------------*/
/** @defgroup SD_Private_Variables SD Private Variables
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -740,6 +766,7 @@ HAL_StatusTypeDef HAL_SD_Abort_IT(SD_HandleTypeDef *hsd); /* Private constants ---------------------------------------------------------*/
/** @defgroup SD_Private_Constants SD Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -749,6 +776,7 @@ HAL_StatusTypeDef HAL_SD_Abort_IT(SD_HandleTypeDef *hsd); /* Private macros ------------------------------------------------------------*/
/** @defgroup SD_Private_Macros SD Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -758,6 +786,7 @@ HAL_StatusTypeDef HAL_SD_Abort_IT(SD_HandleTypeDef *hsd); /* Private functions prototypes ----------------------------------------------*/
/** @defgroup SD_Private_Functions_Prototypes SD Private Functions Prototypes
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
@@ -767,6 +796,7 @@ HAL_StatusTypeDef HAL_SD_Abort_IT(SD_HandleTypeDef *hsd); /* Private functions ---------------------------------------------------------*/
/** @defgroup SD_Private_Functions SD Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7 * @{
*/
|