Overview

Data Structures
struct	sdmmchost_pwr_card_t
	card power control More...

struct	sdmmchost_t
	sdmmc host handler More...

Macros
#define	FSL_SDMMC_HOST_ADAPTER_VERSION (MAKE_VERSION(2U, 5U, 2U)) /2.5.2/
	Middleware adapter version. More...

#define	SDMMCHOST_SUPPORT_HIGH_SPEED (1U)
	sdmmc host misc capability

#define	SDMMCHOST_SUPPORT_DDR50 (SDMMCHOST_SUPPORT_DDR_MODE)
	sdmmc host sdcard DDR50 mode capability

#define	SDMMCHOST_SUPPORT_SDR104 (1U)
	sdmmc host sdcard SDR50 mode capability

#define	SDMMCHOST_SUPPORT_SDR50 (1U)
	sdmmc host sdcard SDR104/mmccard HS200 mode capability

#define	SDMMCHOST_SUPPORT_HS400 (1U)
	sdmmc host mmccard HS400 mode capability

#define	SDMMCHOST_INSTANCE_SUPPORT_8_BIT_WIDTH(host) FSL_FEATURE_USDHC_INSTANCE_SUPPORT_8_BIT_WIDTHn(host->hostController.base)
	sdmmc host instance capability

#define	SDMMCHOST_DMA_DESCRIPTOR_BUFFER_ALIGN_SIZE (4U)
	SDMMC host dma descriptor buffer address align size.

#define	SDMMCHOST_STANDARD_TUNING_START (10U)
	tuning configuration More...

#define	SDMMCHOST_TUINIG_STEP (2U)
	standard tuning stBep

Typedefs
typedef usdhc_transfer_t	sdmmchost_transfer_t
	sdmmc host transfer function

typedef void(*	sdmmchost_pwr_t )(void)
	card power control function pointer

Enumerations
enum	{ kSDMMCHOST_EndianModeBig = 0U, kSDMMCHOST_EndianModeHalfWordBig = 1U, kSDMMCHOST_EndianModeLittle = 2U }
	host Endian mode corresponding to driver define More...

enum	{ kSDMMCHOST_StandardTuning = 0U, kSDMMCHOST_ManualTuning = 1U }
	sdmmc host tuning type More...

enum	{ kSDMMCHOST_NoCacheControl = 0U, kSDMMCHOST_CacheControlRWBuffer = 1U }
	sdmmc host maintain cache flag More...

USDHC host controller function
void	SDMMCHOST_SetCardBusWidth (sdmmchost_t *host, uint32_t dataBusWidth)
	set data bus width. More...

static void	SDMMCHOST_SendCardActive (sdmmchost_t *host)
	Send initilization active 80 clocks to card. More...

static uint32_t	SDMMCHOST_SetCardClock (sdmmchost_t *host, uint32_t targetClock)
	Set card bus clock. More...

static bool	SDMMCHOST_IsCardBusy (sdmmchost_t *host)
	check card status by DATA0. More...

static uint32_t	SDMMCHOST_GetSignalLineStatus (sdmmchost_t *host, uint32_t signalLine)
	Get signal line status. More...

static void	SDMMCHOST_EnableCardInt (sdmmchost_t *host, bool enable)
	enable card interrupt. More...

static void	SDMMCHOST_EnableDDRMode (sdmmchost_t *host, bool enable, uint32_t nibblePos)
	enable DDR mode. More...

static void	SDMMCHOST_EnableHS400Mode (sdmmchost_t *host, bool enable)
	enable HS400 mode. More...

static void	SDMMCHOST_EnableStrobeDll (sdmmchost_t *host, bool enable)
	enable STROBE DLL. More...

status_t	SDMMCHOST_StartBoot (sdmmchost_t host, sdmmchost_boot_config_t hostConfig, sdmmchost_cmd_t cmd, uint8_t buffer)
	start read boot data. More...

status_t	SDMMCHOST_ReadBootData (sdmmchost_t host, sdmmchost_boot_config_t hostConfig, uint8_t *buffer)
	read boot data. More...

static void	SDMMCHOST_EnableBoot (sdmmchost_t *host, bool enable)
	enable boot mode. More...

status_t	SDMMCHOST_CardIntInit (sdmmchost_t host, void sdioInt)
	card interrupt function. More...

static void	SDMMCHOST_ForceClockOn (sdmmchost_t *host, bool enable)
	force card clock on. More...

void	SDMMCHOST_SwitchToVoltage (sdmmchost_t *host, uint32_t voltage)
	switch to voltage. More...

status_t	SDMMCHOST_CardDetectInit (sdmmchost_t host, void cd)
	card detect init function. More...

status_t	SDMMCHOST_PollingCardDetectStatus (sdmmchost_t *host, uint32_t waitCardStatus, uint32_t timeout)
	Detect card insert, only need for SD cases. More...

uint32_t	SDMMCHOST_CardDetectStatus (sdmmchost_t *host)
	card detect status. More...

status_t	SDMMCHOST_Init (sdmmchost_t *host)
	Init host controller. More...

void	SDMMCHOST_Deinit (sdmmchost_t *host)
	Deinit host controller. More...

void	SDMMCHOST_SetCardPower (sdmmchost_t *host, bool enable)
	host power off card function. More...

status_t	SDMMCHOST_TransferFunction (sdmmchost_t host, sdmmchost_transfer_t content)
	host transfer function. More...

status_t	SDMMCHOST_ExecuteTuning (sdmmchost_t host, uint32_t tuningCmd, uint32_t revBuf, uint32_t blockSize)
	sdmmc host excute tuning. More...

void	SDMMCHOST_Reset (sdmmchost_t *host)
	host reset function. More...

status_t	SDMMCHOST_WaitCardDetectStatus (SDMMCHOST_TYPE hostBase, const sdmmchost_detect_card_t cd, bool waitCardStatus)
	wait card detect status More...

void	SDMMCHOST_PowerOffCard (SDMMCHOST_TYPE base, const sdmmchost_pwr_card_t pwr)
	host power off card function. More...

void	SDMMCHOST_PowerOnCard (SDMMCHOST_TYPE base, const sdmmchost_pwr_card_t pwr)
	host power on card function. More...

Data Structure Documentation

struct sdmmchost_pwr_card_t

Deprecated:: Do not use this structure anymore.

Data Fields
sdmmchost_pwr_t	powerOn
	power on function pointer

uint32_t	powerOnDelay_ms
	power on delay

sdmmchost_pwr_t	powerOff
	power off function pointer

uint32_t	powerOffDelay_ms
	power off delay

struct sdmmchost_t

Data Fields
usdhc_host_t	hostController
	host configuration

void *	dmaDesBuffer
	DMA descriptor buffer address.

uint32_t	dmaDesBufferWordsNum
	DMA descriptor buffer size in byte.

usdhc_handle_t	handle
	host controller handler

uint8_t	tuningType
	host tuning type

sdmmc_osa_event_t	hostEvent
	host event handler

void *	cd
	card detect

void *	cardInt
	call back function for card interrupt

uint8_t	enableCacheControl
	Cache maintain flag in host driver. More...

Field Documentation

uint8_t sdmmchost_t::enableCacheControl

Host driver only maintain cache when FSL_SDK_ENABLE_DRIVER_CACHE_CONTROL is not defined and enableCacheControl = kSDMMCHOST_CacheControlRWBuffer. While FSL_SDK_ENABLE_DRIVER_CACHE_CONTROL is defined, host driver will not maintain cache and peripheral driver will do it.

Macro Definition Documentation

#define FSL_SDMMC_HOST_ADAPTER_VERSION (MAKE_VERSION(2U, 5U, 2U)) /*2.5.2*/

#define SDMMCHOST_STANDARD_TUNING_START (10U)

standard tuning start point

Enumeration Type Documentation

anonymous enum

Enumerator
kSDMMCHOST_EndianModeBig	Big endian mode.
kSDMMCHOST_EndianModeHalfWordBig	Half word big endian mode.
kSDMMCHOST_EndianModeLittle	Little endian mode.

anonymous enum

Enumerator
kSDMMCHOST_StandardTuning	standard tuning type
kSDMMCHOST_ManualTuning	manual tuning type

anonymous enum

Enumerator
kSDMMCHOST_NoCacheControl	sdmmc host cache control disabled
kSDMMCHOST_CacheControlRWBuffer	sdmmc host cache control read/write buffer

Function Documentation

void SDMMCHOST_SetCardBusWidth	(	sdmmchost_t *	host,
		uint32_t	dataBusWidth
	)

Parameters

host	host handler
dataBusWidth	data bus width

static void SDMMCHOST_SendCardActive ( sdmmchost_t * host )

inlinestatic

Parameters

host	host handler

static uint32_t SDMMCHOST_SetCardClock	(	sdmmchost_t *	host,
		uint32_t	targetClock
	)

inlinestatic

Parameters

host	host handler
targetClock	target clock frequency

Return values

actual clock frequency can be reach.

static bool SDMMCHOST_IsCardBusy ( sdmmchost_t * host )

inlinestatic

Parameters

host	host handler

Return values

true	is busy, false is idle.

static uint32_t SDMMCHOST_GetSignalLineStatus	(	sdmmchost_t *	host,
		uint32_t	signalLine
	)

inlinestatic

Parameters

host	host handler
signalLine	signal line type, reference _sdmmc_signal_line

static void SDMMCHOST_EnableCardInt	(	sdmmchost_t *	host,
		bool	enable
	)

inlinestatic

Parameters

host	host handler
enable	true is enable, false is disable.

static void SDMMCHOST_EnableDDRMode	(	sdmmchost_t *	host,
		bool	enable,
		uint32_t	nibblePos
	)

inlinestatic

Parameters

host	host handler
enable	true is enable, false is disable.
nibblePos	nibble position indictation. 0- the sequence is 'odd high nibble -> even high nibble -> odd low nibble -> even low nibble'; 1- the sequence is 'odd high nibble -> odd low nibble -> even high nibble -> even low nibble'.

static void SDMMCHOST_EnableHS400Mode	(	sdmmchost_t *	host,
		bool	enable
	)

inlinestatic

Parameters

host	host handler
enable	true is enable, false is disable.

static void SDMMCHOST_EnableStrobeDll	(	sdmmchost_t *	host,
		bool	enable
	)

inlinestatic

Parameters

host	host handler
enable	true is enable, false is disable.

status_t SDMMCHOST_StartBoot	(	sdmmchost_t *	host,
		sdmmchost_boot_config_t *	hostConfig,
		sdmmchost_cmd_t *	cmd,
		uint8_t *	buffer
	)

Parameters

host	host handler
hostConfig	boot configuration
cmd	boot command
buffer	buffer address

status_t SDMMCHOST_ReadBootData	(	sdmmchost_t *	host,
		sdmmchost_boot_config_t *	hostConfig,
		uint8_t *	buffer
	)

Parameters

host	host handler
hostConfig	boot configuration
buffer	buffer address

static void SDMMCHOST_EnableBoot	(	sdmmchost_t *	host,
		bool	enable
	)

inlinestatic

Parameters

host	host handler
enable	true is enable, false is disable

status_t SDMMCHOST_CardIntInit	(	sdmmchost_t *	host,
		void *	sdioInt
	)

Parameters

host	host handler
sdioInt	card interrupt configuration

static void SDMMCHOST_ForceClockOn	(	sdmmchost_t *	host,
		bool	enable
	)

inlinestatic

Parameters

host	host handler
enable	true is enable, false is disable.

void SDMMCHOST_SwitchToVoltage	(	sdmmchost_t *	host,
		uint32_t	voltage
	)

Parameters

host	host handler
voltage	switch to voltage level.

status_t SDMMCHOST_CardDetectInit	(	sdmmchost_t *	host,
		void *	cd
	)

Parameters

host	host handler
cd	card detect configuration

status_t SDMMCHOST_PollingCardDetectStatus	(	sdmmchost_t *	host,
		uint32_t	waitCardStatus,
		uint32_t	timeout
	)

Parameters

host	host handler
waitCardStatus	status which user want to wait
timeout	wait time out.

Return values

kStatus_Success	detect card insert
kStatus_Fail	card insert event fail

uint32_t SDMMCHOST_CardDetectStatus ( sdmmchost_t * host )

Parameters

host	host handler

Return values

kSD_Inserted,kSD_Removed

status_t SDMMCHOST_Init ( sdmmchost_t * host )

Parameters

host	host handler

Return values

kStatus_Success	host init success
kStatus_Fail	event fail

void SDMMCHOST_Deinit ( sdmmchost_t * host )

Parameters

host	host handler

void SDMMCHOST_SetCardPower	(	sdmmchost_t *	host,
		bool	enable
	)

Parameters

host	host handler
enable	true is power on, false is power down.

status_t SDMMCHOST_TransferFunction	(	sdmmchost_t *	host,
		sdmmchost_transfer_t *	content
	)

Note

the host transfer function support below functionality,

Non-cache line size alignment check on the data buffer, it is means that no matter the data buffer used for data transfer is align with cache line size or not, sdmmc host driver will use the address directly.
Cache line size alignment check on the data buffer, sdmmc host driver will check the data buffer address, if the buffer is not align with cache line size, sdmmc host driver will convert it to cache line size align buffer, the functionality is enabled by #define SDMMCHOST_ENABLE_CACHE_LINE_ALIGN_TRANSFER 1 #define FSL_USDHC_ENABLE_SCATTER_GATHER_TRANSFER 1U If application would like to enable the cache line size align functionality, please make sure the SDMMCHOST_InstallCacheAlignBuffer is called before submit data transfer request and make sure the installing buffer size is not smaller than 2 * cache line size.

Parameters

host	host handler
content	transfer content.

status_t SDMMCHOST_ExecuteTuning	(	sdmmchost_t *	host,
		uint32_t	tuningCmd,
		uint32_t *	revBuf,
		uint32_t	blockSize
	)

Parameters

host	host handler
tuningCmd	tuning command.
revBuf	receive buffer pointer
blockSize	tuning data block size.

void SDMMCHOST_Reset ( sdmmchost_t * host )

Deprecated:: Do not use this function. Application should not call this function, driver is responsible for the host reset..

Parameters

host	host handler

status_t SDMMCHOST_WaitCardDetectStatus	(	SDMMCHOST_TYPE *	hostBase,
		const sdmmchost_detect_card_t *	cd,
		bool	waitCardStatus
	)

Deprecated:: Do not use this function.It has been superceded by SDMMCHOST_PollingCardDetectStatus..

Parameters

hostBase	host handler
cd	card detect configuration.
waitCardStatus	status to wait.

void SDMMCHOST_PowerOffCard	(	SDMMCHOST_TYPE *	base,
		const sdmmchost_pwr_card_t *	pwr
	)

Deprecated:: Do not use this function.It has been superceded by SDMMCHOST_SetCardPower..

Parameters

base	host base address.
pwr	depend on user define power configuration.

void SDMMCHOST_PowerOnCard	(	SDMMCHOST_TYPE *	base,
		const sdmmchost_pwr_card_t *	pwr
	)

Deprecated:: Do not use this function.It has been superceded by SDMMCHOST_SetCardPower..

Parameters

base	host base address.
pwr	depend on user define power configuration.

Overview

Data Structures

Macros

Typedefs

Enumerations

USDHC host controller function

Data Structure Documentation

Data Fields

Data Fields

Field Documentation

Macro Definition Documentation

Enumeration Type Documentation

Function Documentation