HAL SDIO Overview

Introducing SDIO

group SDIO_Introduction

  • This introduction is under development.

Module and files

The following diagram illustrates the SDIO module and its associated files.

Module and files diagram

Component diagram

The following diagram illustrates the software components involved in the SDIO module. It shows the interactions between the user application, HAL drivers, low-level drivers, and the hardware components.



@startuml

<style>

componentDiagram {

   arrow {

      FontSize 8

   }

}

</style>



title SDIO Software Component Diagram



package "HAL" {

    [HAL_SDIO]

}



package "Low Layer" {

    [SDMMC_CORE]

    [CMSIS]

    [SDMMC Interrupt routine service]

}



package "HW" {

    [STM32_HW]

}



[Appli] --> [HAL_SDIO] : HAL SD API

[Appli] <-- [HAL_SDIO] : Status SD API 

[HAL_SDIO] <-- [SDMMC_CORE]

[SDMMC_CORE] --> [CMSIS]:SDMMC register def

[STM32_HW] <-u-- [SDMMC_CORE] : SDMMC registers R/W

[HAL_SDIO] <-- [SDMMC Interrupt routine service]

[STM32_HW] -u--> [SDMMC Interrupt routine service]: SDMMC Irq



@enduml

Configuration table

The following table lists the configuration defines for the HAL SDIO module, specifying their locations, default values, and descriptions:

group SDIO_Configuration_Table

Configuration inside the SDIO driver

Config defines

Description

Default value

Note

USE_ASSERT_DBG_PARAM

from the IDE

NONE

Allows to use the assert checks parameters.

USE_ASSERT_DBG_STATE

from the IDE

NONE

Allows to use the assert checks states.

USE_HAL_CHECK_PARAM

from hal_conf.h

0

Allows to use the run-time checks parameters.

USE_HAL_SDIO_REGISTER_CALLBACKS

from hal_conf.h

0

Allows to provide specific callback functions.

USE_HAL_SDIO_GET_LAST_ERRORS

from hal_conf.h

0

Allows to get last errors codes.

USE_HAL_SDIO_USER_DATA

from hal_conf.h

0

Allows to enable/disable user data.

USE_HAL_SDIO_CLK_ENABLE_MODEL

from hal_conf.h

HAL_CLK_ENABLE_NO

Allows to enable the clock model for the SDIO.