Jump to main content

##

# 3.26.24 SD/MMC Host Controller (SDHC)

The SDHC PLIB provides low level APIs to configure and transfer data using the SD host controller. The SDHC PLIB supports default and high speed data transfer, 1-bit and 4-bit data bus configurations. The PLIB performs the transfers in non-blocking mode. Transfers involving a data stage are performed using ADMA.

## Using The Library

The example code demonstrates sending a SD command to read a single block of data from the SD card. This example assumes that the SD card is already initialized by the application and is ready to accept read and write requests. The example application does not show the larger SD protocol required in order to communicate with the SD card.

    uint16_t cmd_error;
    uint16_t data_error;
    bool isCommandCompleted = false;
    bool isDataCompleted = false;
    uint8_t readBuffer[512];

    static void SDHC_TransferEventHandler(
            SDHC_XFER_STATUS xferStatus,
            uintptr_t contextHandle
    )
    {
        if (xferStatus & SDHC_XFER_STATUS_CMD_COMPLETED)
        {
            // Command transfer complete, read the command error status.
            cmd_error = SDHC_CommandErrorGet();
            isCommandCompleted = true;
        }
        if (xferStatus & SDHC_XFER_STATUS_DATA_COMPLETED)
        {
            // Data transfer complete, read the data error status.
            data_error = SDHC_DataErrorGet();
            isDataCompleted = true;
        }
    }

    int main(void)
    {
    	/* Initialize all modules */
        SYS_Initialize ( NULL );

        // Register event handler with the SDHC PLIB. This is usually done once.
        SDHC_CallbackRegister(SDHC_TransferEventHandler, (uintptr_t) 0);

        SDHC_DataTransferFlags transferFlags;

        transferFlags.isDataPresent  = true;
        transferFlags.transferDir = SDHC_DATA_TRANSFER_DIR_READ;
        transferFlags.transferType = SDHC_DATA_TRANSFER_TYPE_SINGLE;

        // Set the block size to 512 bytes
        SDHC_BlockSizeSet(512);

        // Set the block count to 1
        SDHC_BlockCountSet(1);

        // Set up the DMA to read 512 btyes of data
        SDHC_DmaSetup(readBuffer, 512, SDHC_DATA_TRANSFER_DIR_READ);

        // Send command to read one block of data from SD card starting at block address 100
        SDHC_CommandSend(17, 100, SDHC_CMD_RESP_R1, transferFlags);

        // Check the status of isCommandCompleted and isDataCompleted

        // Other tasks ...
    }

## Library Interface

SDHC peripheral library provides the following interfaces:

Functions

Name | Description
--- | ---
SDHCx_BusWidthSet | Configures the width of the data bus
SDHCx_SpeedModeSet | Sets the bus speed
SDHCx_BlockSizeSet | Sets the size of the one data block of transfer
SDHCx_BlockCountSet | Sets the number of blocks to transfer
SDHCx_IsCmdLineBusy | Returns the status of the command line
SDHCx_IsDatLineBusy | Returns the status of the data line
SDHCx_IsWriteProtected | Returns the write protect switch pin level
SDHCx_IsCardAttached | Indicates if the card is attached or detached
SDHCx_ClockSet | Sets the SDHC clock frequency
SDHCx_ClockEnable | Enable SDHC clock
SDHCx_ClockDisable | Disable SDHC clock
SDHCx_CommandErrorGet | Returns the errors associated with a command transfer
SDHCx_DataErrorGet | Returns the errors associated with a data transfer
SDHCx_ErrorReset | Resets errors as specified by the resetType
SDHCx_ResponseRead | Reads the response to a given command
SDHCx_ModuleInit | Initializes the SDHC peripheral
SDHCx_Initialize | Initializes the SDHC peripheral and the internal data structures used by the peripheral library
SDHCx_CallbackRegister | This function allows a SDHC PLIB client to set an event handler
SDHCx_CommandSend | This function allows the client to send a SD command on the SDHC interface
SDHCx_DmaSetup | Sets up the DMA for data transfers
SDHC_CardDetectEnable | Enables the use of SD Card Detect Pin
SDHC_CardDetectDisable | Disables the use of SD Card Detect Pin
SDHC_WriteProtectEnable | Enables the use of SD Card Write Protect Pin
SDHC_WriteProtectDisable | Disables the use of SD Card Write Protect Pin

Data types and constants

Name | Type | Description
--- | --- | ---
SDHC_BUS_WIDTH | Enum | The enumeration lists the bus widths for the SDHC bus
SDHC_SPEED_MODE | Enum | The enumeration lists the bus widths for the SDHC bus
SDHC_CMD_RESP_TYPE | Enum | The enumeration lists the supported response types
SDHC_READ_RESPONSE_REG | Enum | The enumeration lists the response registers that can be read for a given command
SDHC_RESET_TYPE | Enum | The enumeration lists error type to reset
SDHC_CLK_MODE | Enum | The enumeration lists the clock modes
SDHC_XFER_STATUS | Enum | The enumeration lists the status of the transfer
SDHC_DATA_TRANSFER_TYPE | Enum | The enumeration lists single or multi block data transfer type
SDHC_DATA_TRANSFER_DIR | Enum | The enumeration lists the direction of the data transfer
SDHC_DataTransferFlags | Struct | The data structure is used by the client to provide information about the data transfer to the SDHC PLIB
SDHC_CALLBACK | Typedef | The prototype of the SDHC callback function