mmcsd.h File Reference

Introduction

MMCSD Driver API/interface file.

Go to the source code of this file.

Data Structures
struct	MMCSD_Params
	MMCSD instance attributes - used during initialization. More...
struct	MMCSD_Attrs
	MMCSD instance attributes - used during init time. More...
struct	MMCSD_Object
	MMCSD driver object. More...
struct	MMCSD_Config
	MMCSD Global configuration. More...

Macros
MACROS used to select the transfer mode
MMCSD_MODE_BLOCKING block task execution while a Transfer is in progress MMCSD_MODE_CALLBACK does not block task execution; but calls a callback function when the MMCSD transfer has completed
#define	MMCSD_MODE_BLOCKING   ((uint32_t) 0U)
#define	MMCSD_MODE_CALLBACK   ((uint32_t) 1U)

Typedefs
typedef void *	MMCSD_Handle
typedef void(*	MMCSD_txnCallbackFxn) (MMCSD_Handle mmcsdHandle, int32_t transferStatus)
	MMCSD callback function. More...

Functions
void	MMCSD_init (void)
	This function initializes the MMCSD module. More...
void	MMCSD_deinit (void)
	This function de-initializes the MMCSD module. More...
void	MMCSD_Params_init (MMCSD_Params *mmcsdParams)
	Initialize data structure with defaults. More...
MMCSD_Handle	MMCSD_open (uint32_t index, const MMCSD_Params *openParams)
	This function opens a given MMCSD peripheral. More...
void	MMCSD_close (MMCSD_Handle handle)
	Function to close a MMCSD peripheral specified by the MMCSD handle. More...
MMCSD_Handle	MMCSD_getHandle (uint32_t index)
	This function returns the handle of an open MMCSD Instance from the instance index. More...
int32_t	MMCSD_read (MMCSD_Handle handle, uint8_t *buf, uint32_t startBlk, uint32_t numBlks)
	Function to perform block reads from the MMC/SD media. More...
int32_t	MMCSD_write (MMCSD_Handle handle, uint8_t *buf, uint32_t startBlk, uint32_t numBlks)
	Function to perform block writes to the MMC/SD media. More...
uint32_t	MMCSD_getBlockSize (MMCSD_Handle handle)
	This function returns the block size of the MMC/SD media connected to the MMCSD controller. More...
uint32_t	MMCSD_getBlockCount (MMCSD_Handle handle)
	This function returns the block count of User Data Area of the MMC/SD media connected to the MMCSD controller. More...

Variables
MMCSD_Config	gMmcsdConfig []
	Externally defined driver configuration array. More...
uint32_t	gMmcsdConfigNum
	Externally defined driver configuration array size. More...