The MMCSD header file should be included in an application as follows:
This module contains APIs to program and use the MMCSD module. The APIs can be used by other drivers to get access to MMCSD and also by application to initiate data transfer operation.
Files | |
file | mmcsd.h |
MMCSD Driver API/interface 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... | |
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... | |
uint32_t | MMCSD_isHC (MMCSD_Handle handle) |
This function returns if the media connected is High Capacity (> 2GB in size) or not. More... | |
int32_t | MMCSD_change_Bus_Config (MMCSD_Handle handle, uint32_t busSpeed, uint32_t busWidth) |
This function reconfigures the bus Configuration. More... | |
int32_t | MMCSD_change_Tuning_Type (MMCSD_Handle handle, uint32_t tuningType) |
This function reconfigures the bus Configuration. More... | |
int32_t | MMCSD_enableBootPartition (MMCSD_Handle handle, uint32_t partitionNum) |
This function enables the boot partition if the connected media is eMMC. More... | |
int32_t | MMCSD_disableBootPartition (MMCSD_Handle handle) |
This function disables the boot partition if the connected media is eMMC. More... | |
Typedefs | |
typedef void * | MMCSD_Handle |
typedef void(* | MMCSD_txnCallbackFxn) (MMCSD_Handle mmcsdHandle, int32_t transferStatus) |
MMCSD callback function. More... | |
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) |
#define MMCSD_MODE_BLOCKING ((uint32_t) 0U) |
#define MMCSD_MODE_CALLBACK ((uint32_t) 1U) |
typedef void* MMCSD_Handle |
typedef void(* MMCSD_txnCallbackFxn) (MMCSD_Handle mmcsdHandle, int32_t transferStatus) |
MMCSD callback function.
User definable callback function prototype. The MMCSD driver will call the defined function and pass in the MMCSD driver's handle, the pointer to the MMCSD transaction that just completed, and the status of Transaction.
mmcsdHandle | MMCSD_Handle |
transferStatus | Results of the MMCSD transaction |
void MMCSD_init | ( | void | ) |
This function initializes the MMCSD module.
void MMCSD_deinit | ( | void | ) |
This function de-initializes the MMCSD module.
void MMCSD_Params_init | ( | MMCSD_Params * | mmcsdParams | ) |
Initialize data structure with defaults.
mmcsdParams | [out] Initialized parameters |
MMCSD_Handle MMCSD_open | ( | uint32_t | index, |
const MMCSD_Params * | openParams | ||
) |
This function opens a given MMCSD peripheral.
index | Index of config to use in the MMCSD_Config array |
openParams | Pointer to parameters to open the driver with |
void MMCSD_close | ( | MMCSD_Handle | handle | ) |
Function to close a MMCSD peripheral specified by the MMCSD handle.
handle | MMCSD_Handle returned from MMCSD_open() |
MMCSD_Handle MMCSD_getHandle | ( | uint32_t | index | ) |
This function returns the handle of an open MMCSD Instance from the instance index.
index | Index of config to use in the MMCSD_Config array |
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.
handle | MMCSD_Handle returned from MMCSD_open() |
buf | Pointer to a buffer to which the data is to be read into |
startBlk | Block to start reading data from |
numBlks | Number of blocks to read |
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.
handle | MMCSD_Handle returned from MMCSD_open() |
buf | Pointer to a buffer to which the data is to be read into |
startBlk | Block to start reading data from |
numBlks | Number of blocks to read |
uint32_t MMCSD_getBlockSize | ( | MMCSD_Handle | handle | ) |
This function returns the block size of the MMC/SD media connected to the MMCSD controller.
handle | MMCSD_Handle returned from MMCSD_open() |
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.
handle | MMCSD_Handle returned from MMCSD_open() |
uint32_t MMCSD_isHC | ( | MMCSD_Handle | handle | ) |
This function returns if the media connected is High Capacity (> 2GB in size) or not.
handle | MMCSD_Handle returned from MMCSD_open() |
int32_t MMCSD_change_Bus_Config | ( | MMCSD_Handle | handle, |
uint32_t | busSpeed, | ||
uint32_t | busWidth | ||
) |
This function reconfigures the bus Configuration.
handle | MMCSD_Handle returned from MMCSD_open() |
busSpeed | Bus Speed to be Set. |
busWidth | Bus Width to be Set. |
int32_t MMCSD_change_Tuning_Type | ( | MMCSD_Handle | handle, |
uint32_t | tuningType | ||
) |
This function reconfigures the bus Configuration.
handle | MMCSD_Handle returned from MMCSD_open() |
tuningType | Tuning Type to be Set. |
int32_t MMCSD_enableBootPartition | ( | MMCSD_Handle | handle, |
uint32_t | partitionNum | ||
) |
This function enables the boot partition if the connected media is eMMC.
handle | MMCSD_Handle returned from MMCSD_open() |
partitionNum | Boot partition to be enabled. |
int32_t MMCSD_disableBootPartition | ( | MMCSD_Handle | handle | ) |
This function disables the boot partition if the connected media is eMMC.
handle | MMCSD_Handle returned from MMCSD_open() |
|
extern |
Externally defined driver configuration array.
|
extern |
Externally defined driver configuration array size.