RZ/A Flexible Software Package Documentation  Release v3.3.0

 
SD/MMC Host Interface (r_sdhi)

Functions

fsp_err_t R_SDHI_Open (sdmmc_ctrl_t *const p_api_ctrl, sdmmc_cfg_t const *const p_cfg)
 
fsp_err_t R_SDHI_MediaInit (sdmmc_ctrl_t *const p_api_ctrl, sdmmc_device_t *const p_device)
 
fsp_err_t R_SDHI_Read (sdmmc_ctrl_t *const p_api_ctrl, uint8_t *const p_dest, uint32_t const start_sector, uint32_t const sector_count)
 
fsp_err_t R_SDHI_Write (sdmmc_ctrl_t *const p_api_ctrl, uint8_t const *const p_source, uint32_t const start_sector, uint32_t const sector_count)
 
fsp_err_t R_SDHI_ReadIo (sdmmc_ctrl_t *const p_api_ctrl, uint8_t *const p_data, uint32_t const function, uint32_t const address)
 
fsp_err_t R_SDHI_WriteIo (sdmmc_ctrl_t *const p_api_ctrl, uint8_t *const p_data, uint32_t const function, uint32_t const address, sdmmc_io_write_mode_t const read_after_write)
 
fsp_err_t R_SDHI_ReadIoExt (sdmmc_ctrl_t *const p_api_ctrl, uint8_t *const p_dest, uint32_t const function, uint32_t const address, uint32_t *const count, sdmmc_io_transfer_mode_t transfer_mode, sdmmc_io_address_mode_t address_mode)
 
fsp_err_t R_SDHI_WriteIoExt (sdmmc_ctrl_t *const p_api_ctrl, uint8_t const *const p_source, uint32_t const function, uint32_t const address, uint32_t const count, sdmmc_io_transfer_mode_t transfer_mode, sdmmc_io_address_mode_t address_mode)
 
fsp_err_t R_SDHI_IoIntEnable (sdmmc_ctrl_t *const p_api_ctrl, bool enable)
 
fsp_err_t R_SDHI_StatusGet (sdmmc_ctrl_t *const p_api_ctrl, sdmmc_status_t *const p_status)
 
fsp_err_t R_SDHI_Erase (sdmmc_ctrl_t *const p_api_ctrl, uint32_t const start_sector, uint32_t const sector_count)
 
fsp_err_t R_SDHI_CallbackSet (sdmmc_ctrl_t *const p_api_ctrl, void(*p_callback)(sdmmc_callback_args_t *), void const *const p_context, sdmmc_callback_args_t *const p_callback_memory)
 
fsp_err_t R_SDHI_Close (sdmmc_ctrl_t *const p_api_ctrl)
 

Detailed Description

Driver for the SD/MMC Host Interface (SDHI) peripheral on RZ MPUs. This module implements the SD/MMC Interface.

Overview

NOTE: This document includes instructions for eMMC, but they are not supported in this version. NOTE: SD and SDIO support can only be used exclusively.

Features

Configuration

Build Time Configurations for r_sdhi

The following build time configurations are defined in fsp_cfg/r_sdhi_cfg.h:

ConfigurationOptionsDefaultDescription
Parameter Checking
  • Default (BSP)
  • Enabled
  • Disabled
Default (BSP) If selected code for parameter checking is included in the build.
Unaligned Access Support
  • Disabled
  • Enabled
Enabled If enabled, code for supporting buffers that are not aligned on a 4-byte boundary is included in the build. Only disable this if all buffers passed to the driver are 4-byte aligned.
SD Support
  • Disabled
  • Enabled
Enabled If selected code for SD card support is included in the build.
SDIO Support
  • Disabled
  • Enabled
Disabled If selected code for SDIO card support is included in the build.

Configurations for Storage > SD/MMC (r_sdhi)

This module can be added to the Stacks tab via New Stack > Storage > SD/MMC (r_sdhi).

ConfigurationOptionsDefaultDescription
NameName must be a valid C symbolg_sdmmc0 Module name.
ChannelValue must be a non-negative integer0 Select the channel.
Bus WidthMCU Specific OptionsSelect the bus width.
Block SizeValue must be an integer between 1 and 512512 Select the media block size. Must be 512 for SD cards or eMMC devices. Must be 1-512 for SDIO.
Card Detection
  • Not Used
  • CD Pin
CD Pin Select the card detection method.
Write Protection
  • Not Used
  • WP Pin
WP Pin Select whether or not to use the write protect pin. Select Not Used if the MPU or device does not have a write protect pin.
CallbackName must be a valid C symbolNULL A user callback function can be provided. If this callback function is provided, it will be called from the interrupt service routine (ISR).
OXMN Interrupt PriorityIllegal interrupt priority level24 OXMN interrupt priority(0-31). Note: If you specify the lowest priority (i.e.,31), no interrupt will occur.
OXASIO Interrupt PriorityIllegal interrupt priority level24 OXASIO interrupt priority(0-31). Note: If you specify the lowest priority (i.e.,31), no interrupt will occur.

Interrupt Configurations:

The following interrupts are required to use the r_sdhi module:

Using SD/MMC with internal DMAC:

The Card interrupt is optional and only available on MPU packages that have the SDnCD pin (n = channel number).

Clock Configuration

The SDMMC MPU peripheral (SDHI) uses the SDnΦ for its clock source. The SDMMC driver selects the optimal built-in divider based on the SDnΦ frequency and the maximum clock rate allowed by the device obtained at media initialization. (n = channel number)

Pin Configuration

The SDMMC driver supports the following pins (n = channel number):

The drive capacity for each pin should be set to "Medium" or "High" for most hardware designs. This can be configured in the Pins tab of the RZ Configuration editor by selecting the pin under Pin Selection -> Ports.

Usage Notes

Card Detection

When Card Detection is configured to "CD Pin" in the RZ Configuration editor, interrupt flags are cleared and card detection is enabled during R_SDHI_Open().

R_SDHI_StatusGet() can be called to retrieve the current status of the card (including whether a card is present). If the Card Interrupt Priority is enabled, a callback is called when a card is inserted or removed.

If a card is removed and reinserted, R_SDHI_MediaInit() must be called before reading from the card or writing to the card.

Note
R_SDHI_StatusGet() should be used to initially determine the card state after opening the interface.

Timing Notes for R_SDHI_MediaInit

The R_SDHI_MediaInit() API completes the entire device identification and configuration process. This involves several command-response cycles at a bus width of 1 bit and a bus speed of 400 kHz or less.

Limitations

Developers should be aware of the following limitations when using the SDHI: The second argument of R_SDHI_Read and R_SDHI_Write has the following limitations:

Blocking Calls

The following functions block execution until the response is received for at least one command:

Once the function returns the status of the operation can be determined via R_SDHI_StatusGet or through receipt of a callback.

Note
Due to the variability in clocking configurations it is recommended to determine blocking delays experimentally on the target system.

Examples

Basic Example

This is a basic example of minimal use of the r_sdhi in an application.

#if 1 /* SDRAM or Internal SRAM */
uint8_t g_dest[SDHI_MAX_BLOCK_SIZE] BSP_ALIGN_VARIABLE(8) BSP_PLACE_IN_SECTION("UNCACHED_BSS");
uint8_t g_src[SDHI_MAX_BLOCK_SIZE] BSP_ALIGN_VARIABLE(8) BSP_PLACE_IN_SECTION("UNCACHED_BSS");
#else /* OctaRAM */
uint8_t g_dest[SDHI_MAX_BLOCK_SIZE] BSP_ALIGN_VARIABLE(64) BSP_PLACE_IN_SECTION("UNCACHED_BSS");
uint8_t g_src[SDHI_MAX_BLOCK_SIZE] BSP_ALIGN_VARIABLE(64) BSP_PLACE_IN_SECTION("UNCACHED_BSS");
#endif
uint32_t g_transfer_complete = 0;
void r_sdhi_basic_example (void)
{
/* Initialize g_src to known data */
for (uint32_t i = 0; i < SDHI_MAX_BLOCK_SIZE; i++)
{
g_src[i] = (uint8_t) ('A' + (i % 26));
}
/* Open the SDHI driver. */
fsp_err_t err = R_SDHI_Open(&g_sdmmc0_ctrl, &g_sdmmc0_cfg);
assert(FSP_SUCCESS == err);
/* A device shall be ready to accept the first command within 1ms from detecting VDD min. Reference section 6.4.1.1
* "Power Up Time of Card" in the SD Physical Layer Simplified Specification Version 6.00. */
/* Initialize the SD card. This should not be done until the card is plugged in for SD devices. */
err = R_SDHI_MediaInit(&g_sdmmc0_ctrl, NULL);
assert(FSP_SUCCESS == err);
err = R_SDHI_Write(&g_sdmmc0_ctrl, g_src, 3, 1);
assert(FSP_SUCCESS == err);
while (!g_transfer_complete)
{
/* Wait for transfer. */
}
err = R_SDHI_Read(&g_sdmmc0_ctrl, g_dest, 3, 1);
assert(FSP_SUCCESS == err);
while (!g_transfer_complete)
{
/* Wait for transfer. */
}
}
/* The callback is called when a transfer completes. */
void r_sdhi_example_callback (sdmmc_callback_args_t * p_args)
{
{
g_transfer_complete = 1;
}
}

Card Detection Example

This is an example of using SDHI when the card may not be plugged in. The card detection interrupt must be enabled to use this example.

bool g_card_inserted = false;
void r_sdhi_card_detect_example (void)
{
/* Open the SDHI driver. This enables the card detection interrupt. */
fsp_err_t err = R_SDHI_Open(&g_sdmmc0_ctrl, &g_sdmmc0_cfg);
/* Handle any errors. This function should be defined by the user. */
assert(FSP_SUCCESS == err);
/* Check if card is inserted. */
err = R_SDHI_StatusGet(&g_sdmmc0_ctrl, &status);
assert(FSP_SUCCESS == err);
if (!status.card_inserted)
{
while (!g_card_inserted)
{
/* Wait for a card insertion interrupt. */
}
}
/* A device shall be ready to accept the first command within 1ms from detecting VDD min. Reference section 6.4.1.1
* "Power Up Time of Card" in the SD Physical Layer Simplified Specification Version 6.00. */
/* Initialize the SD card after card insertion is detected. */
err = R_SDHI_MediaInit(&g_sdmmc0_ctrl, NULL);
assert(FSP_SUCCESS == err);
}
/* The callback is called when a card detection event occurs if the card detection interrupt is enabled. */
void r_sdhi_card_detect_example_callback (sdmmc_callback_args_t * p_args)
{
{
g_card_inserted = true;
}
{
g_card_inserted = false;
}
}

Function Documentation

◆ R_SDHI_Open()

fsp_err_t R_SDHI_Open ( sdmmc_ctrl_t *const  p_api_ctrl,
sdmmc_cfg_t const *const  p_cfg 
)

Opens the driver. Resets SDHI, and enables card detection interrupts if card detection is enabled. R_SDHI_MediaInit must be called after this function before any other functions can be used.

Implements sdmmc_api_t::open().

Example:

/* Open the SDHI driver. */
fsp_err_t err = R_SDHI_Open(&g_sdmmc0_ctrl, &g_sdmmc0_cfg);
Return values
FSP_SUCCESSModule is now open.
FSP_ERR_ASSERTIONNull Pointer or block size is not in the valid range of 1-512. Block size must be 512 bytes for SD cards and eMMC devices. It is configurable for SDIO only.
FSP_ERR_ALREADY_OPENDriver has already been opened with this instance of the control structure.
FSP_ERR_IRQ_BSP_DISABLEDAccess interrupt is not enabled.
FSP_ERR_IP_CHANNEL_NOT_PRESENTRequested channel does not exist on this MCU.

◆ R_SDHI_MediaInit()

fsp_err_t R_SDHI_MediaInit ( sdmmc_ctrl_t *const  p_api_ctrl,
sdmmc_device_t *const  p_device 
)

Initializes the SDHI hardware and completes identification and configuration for the SD or eMMC device. This procedure requires several sequential commands. This function blocks until all identification and configuration commands are complete.

Implements sdmmc_api_t::mediaInit().

Example:

/* A device shall be ready to accept the first command within 1ms from detecting VDD min. Reference section 6.4.1.1
* "Power Up Time of Card" in the SD Physical Layer Simplified Specification Version 6.00. */
/* Initialize the SD card. This should not be done until the card is plugged in for SD devices. */
err = R_SDHI_MediaInit(&g_sdmmc0_ctrl, NULL);
Return values
FSP_SUCCESSModule is now ready for read/write access.
FSP_ERR_ASSERTIONNull Pointer or block size is not in the valid range of 1-512. Block size must be 512 bytes for SD cards and eMMC devices. It is configurable for SDIO only.
FSP_ERR_NOT_OPENDriver has not been initialized.
FSP_ERR_CARD_INIT_FAILEDDevice was not identified as an SD card, eMMC device, or SDIO card.
FSP_ERR_RESPONSEDevice responded with an error.
FSP_ERR_TIMEOUTDevice did not respond.
FSP_ERR_DEVICE_BUSYDevice is holding DAT0 low (device is busy) or another operation is ongoing.

◆ R_SDHI_Read()

fsp_err_t R_SDHI_Read ( sdmmc_ctrl_t *const  p_api_ctrl,
uint8_t *const  p_dest,
uint32_t const  start_sector,
uint32_t const  sector_count 
)

Reads data from an SD or eMMC device. Up to 0x10000 sectors can be read at a time. Implements sdmmc_api_t::read().

A callback with the event SDMMC_EVENT_TRANSFER_COMPLETE is called when the read data is available.

Example:

err = R_SDHI_Read(&g_sdmmc0_ctrl, g_dest, 3, 1);
Return values
FSP_SUCCESSData read successfully.
FSP_ERR_ASSERTIONNULL pointer.
FSP_ERR_NOT_OPENDriver has not been initialized.
FSP_ERR_CARD_NOT_INITIALIZEDCard was unplugged.
FSP_ERR_RESPONSEDevice responded with an error.
FSP_ERR_TIMEOUTDevice did not respond.
FSP_ERR_DEVICE_BUSYDriver is busy with a previous operation.

◆ R_SDHI_Write()

fsp_err_t R_SDHI_Write ( sdmmc_ctrl_t *const  p_api_ctrl,
uint8_t const *const  p_source,
uint32_t const  start_sector,
uint32_t const  sector_count 
)

Writes data to an SD or eMMC device. Up to 0x10000 sectors can be written at a time. Implements sdmmc_api_t::write().

A callback with the event SDMMC_EVENT_TRANSFER_COMPLETE is called when the all data has been written and the device is no longer holding DAT0 low to indicate it is busy.

Example:

err = R_SDHI_Write(&g_sdmmc0_ctrl, g_src, 3, 1);
Return values
FSP_SUCCESSCard write finished successfully.
FSP_ERR_ASSERTIONHandle or Source address is NULL.
FSP_ERR_NOT_OPENDriver has not been initialized.
FSP_ERR_CARD_NOT_INITIALIZEDCard was unplugged.
FSP_ERR_DEVICE_BUSYDriver is busy with a previous operation.
FSP_ERR_CARD_WRITE_PROTECTEDSD card is Write Protected.
FSP_ERR_RESPONSEDevice responded with an error.
FSP_ERR_TIMEOUTDevice did not respond.

◆ R_SDHI_ReadIo()

fsp_err_t R_SDHI_ReadIo ( sdmmc_ctrl_t *const  p_api_ctrl,
uint8_t *const  p_data,
uint32_t const  function,
uint32_t const  address 
)

The Read function reads a one byte register from an SDIO card. Implements sdmmc_api_t::readIo().

This function blocks until the command is sent and the response is received. p_data contains the register value read when this function returns.

Return values
FSP_SUCCESSData read successfully.
FSP_ERR_ASSERTIONNULL pointer.
FSP_ERR_NOT_OPENDriver has not been initialized.
FSP_ERR_CARD_NOT_INITIALIZEDCard was unplugged.
FSP_ERR_UNSUPPORTEDSDIO support disabled in SDHI_CFG_SDIO_SUPPORT_ENABLE.
FSP_ERR_RESPONSEDevice responded with an error.
FSP_ERR_TIMEOUTDevice did not respond.
FSP_ERR_DEVICE_BUSYDevice is holding DAT0 low (device is busy) or another operation is ongoing.

◆ R_SDHI_WriteIo()

fsp_err_t R_SDHI_WriteIo ( sdmmc_ctrl_t *const  p_api_ctrl,
uint8_t *const  p_data,
uint32_t const  function,
uint32_t const  address,
sdmmc_io_write_mode_t const  read_after_write 
)

Writes a one byte register to an SDIO card. Implements sdmmc_api_t::writeIo().

This function blocks until the command is sent and the response is received. The register has been written when this function returns. If read_after_write is true, p_data contains the register value read when this function returns.

Return values
FSP_SUCCESSCard write finished successfully.
FSP_ERR_ASSERTIONHandle or Source address is NULL.
FSP_ERR_NOT_OPENDriver has not been initialized.
FSP_ERR_CARD_NOT_INITIALIZEDCard was unplugged.
FSP_ERR_WRITE_FAILEDWrite operation failed.
FSP_ERR_UNSUPPORTEDSDIO support disabled in SDHI_CFG_SDIO_SUPPORT_ENABLE.
FSP_ERR_RESPONSEDevice responded with an error.
FSP_ERR_TIMEOUTDevice did not respond.
FSP_ERR_DEVICE_BUSYDevice is holding DAT0 low (device is busy) or another operation is ongoing.

◆ R_SDHI_ReadIoExt()

fsp_err_t R_SDHI_ReadIoExt ( sdmmc_ctrl_t *const  p_api_ctrl,
uint8_t *const  p_dest,
uint32_t const  function,
uint32_t const  address,
uint32_t *const  count,
sdmmc_io_transfer_mode_t  transfer_mode,
sdmmc_io_address_mode_t  address_mode 
)

Reads data from an SDIO card function. Implements sdmmc_api_t::readIoExt().

This function blocks until the command is sent and the response is received. A callback with the event SDMMC_EVENT_TRANSFER_COMPLETE is called when the read data is available.

Return values
FSP_SUCCESSData read successfully.
FSP_ERR_ASSERTIONNULL pointer, or count is not in the valid range of 1-512 for byte mode or 1-511 for block mode.
FSP_ERR_NOT_OPENDriver has not been initialized.
FSP_ERR_CARD_NOT_INITIALIZEDCard was unplugged.
FSP_ERR_RESPONSEDevice responded with an error.
FSP_ERR_TIMEOUTDevice did not respond.
FSP_ERR_DEVICE_BUSYDriver is busy with a previous operation.
FSP_ERR_UNSUPPORTEDSDIO support disabled in SDHI_CFG_SDIO_SUPPORT_ENABLE.

◆ R_SDHI_WriteIoExt()

fsp_err_t R_SDHI_WriteIoExt ( sdmmc_ctrl_t *const  p_api_ctrl,
uint8_t const *const  p_source,
uint32_t const  function,
uint32_t const  address,
uint32_t const  count,
sdmmc_io_transfer_mode_t  transfer_mode,
sdmmc_io_address_mode_t  address_mode 
)

Writes data to an SDIO card function. Implements sdmmc_api_t::writeIoExt().

This function blocks until the command is sent and the response is received. A callback with the event SDMMC_EVENT_TRANSFER_COMPLETE is called when the all data has been written.

Return values
FSP_SUCCESSCard write finished successfully.
FSP_ERR_ASSERTIONNULL pointer, or count is not in the valid range of 1-512 for byte mode or 1-511 for block mode.
FSP_ERR_NOT_OPENDriver has not been initialized.
FSP_ERR_CARD_NOT_INITIALIZEDCard was unplugged.
FSP_ERR_RESPONSEDevice responded with an error.
FSP_ERR_TIMEOUTDevice did not respond.
FSP_ERR_DEVICE_BUSYDriver is busy with a previous operation.
FSP_ERR_UNSUPPORTEDSDIO support disabled in SDHI_CFG_SDIO_SUPPORT_ENABLE.

◆ R_SDHI_IoIntEnable()

fsp_err_t R_SDHI_IoIntEnable ( sdmmc_ctrl_t *const  p_api_ctrl,
bool  enable 
)

Enables or disables the SDIO Interrupt. Implements sdmmc_api_t::ioIntEnable().

Return values
FSP_SUCCESSCard enabled or disabled SDIO interrupts successfully.
FSP_ERR_NOT_OPENDriver has not been initialized.
FSP_ERR_ASSERTIONNULL pointer.
FSP_ERR_DEVICE_BUSYDriver is busy with a previous operation.
FSP_ERR_UNSUPPORTEDSDIO support disabled in SDHI_CFG_SDIO_SUPPORT_ENABLE.

◆ R_SDHI_StatusGet()

fsp_err_t R_SDHI_StatusGet ( sdmmc_ctrl_t *const  p_api_ctrl,
sdmmc_status_t *const  p_status 
)

Provides driver status. Implements sdmmc_api_t::statusGet().

Return values
FSP_SUCCESSStatus stored in p_status.
FSP_ERR_ASSERTIONNULL pointer.
FSP_ERR_NOT_OPENDriver has not been initialized.

◆ R_SDHI_Erase()

fsp_err_t R_SDHI_Erase ( sdmmc_ctrl_t *const  p_api_ctrl,
uint32_t const  start_sector,
uint32_t const  sector_count 
)

Erases sectors of an SD card or eMMC device. Implements sdmmc_api_t::erase().

This function blocks until the erase command is sent. Poll the status to determine when erase is complete.

Return values
FSP_SUCCESSErase operation requested.
FSP_ERR_ASSERTIONA required pointer is NULL or an argument is invalid.
FSP_ERR_NOT_OPENDriver has not been initialized.
FSP_ERR_CARD_NOT_INITIALIZEDCard was unplugged.
FSP_ERR_CARD_WRITE_PROTECTEDSD card is Write Protected.
FSP_ERR_RESPONSEDevice responded with an error.
FSP_ERR_TIMEOUTDevice did not respond.
FSP_ERR_DEVICE_BUSYDevice is holding DAT0 low (device is busy) or another operation is ongoing.

◆ R_SDHI_CallbackSet()

fsp_err_t R_SDHI_CallbackSet ( sdmmc_ctrl_t *const  p_api_ctrl,
void(*)(sdmmc_callback_args_t *)  p_callback,
void const *const  p_context,
sdmmc_callback_args_t *const  p_callback_memory 
)

Updates the user callback with the option to provide memory for the callback argument structure. Implements sdmmc_api_t::callbackSet.

Return values
FSP_SUCCESSCallback updated successfully.
FSP_ERR_ASSERTIONA required pointer is NULL.
FSP_ERR_NOT_OPENThe control block has not been opened.
FSP_ERR_NO_CALLBACK_MEMORYp_callback is non-secure and p_callback_memory is either secure or NULL.

◆ R_SDHI_Close()

fsp_err_t R_SDHI_Close ( sdmmc_ctrl_t *const  p_api_ctrl)

Closes an open SD/MMC device. Implements sdmmc_api_t::close().

Return values
FSP_SUCCESSSuccessful close.
FSP_ERR_ASSERTIONThe parameter p_ctrl is NULL.
FSP_ERR_NOT_OPENDriver has not been initialized.