CMSIS-Driver  Version 2.02
Peripheral Interface for Middleware and Application Code
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
MCI Interface

Driver API for Memory Card Interface using SD/MMC interface (Driver_MCI.h) More...

Content

 MCI Events
 The MCI driver generates call back events that are notified via the function ARM_MCI_SignalEvent.
 
 MCI Control Codes
 Configure and control the MCI using the ARM_MCI_Control.
 
 MCI Send Command Flags
 Specify various options for sending commands to the card and the expected response.
 
 MCI Transfer Controls
 Specify data transfer mode.
 
 MCI Card Power Controls
 Specify Memory Card Power supply voltage.
 

Data Structures

struct  ARM_DRIVER_MCI
 Access structure of the MCI Driver. More...
 
struct  ARM_MCI_CAPABILITIES
 MCI Driver Capabilities. More...
 
struct  ARM_MCI_STATUS
 MCI Status. More...
 

Typedefs

typedef void(* ARM_MCI_SignalEvent_t )(uint32_t event)
 Pointer to ARM_MCI_SignalEvent : Signal MCI Card Event.
 

Functions

ARM_DRIVER_VERSION ARM_MCI_GetVersion (void)
 Get driver version.
 
ARM_MCI_CAPABILITIES ARM_MCI_GetCapabilities (void)
 Get driver capabilities.
 
int32_t ARM_MCI_Initialize (ARM_MCI_SignalEvent_t cb_event)
 Initialize the Memory Card Interface.
 
int32_t ARM_MCI_Uninitialize (void)
 De-initialize Memory Card Interface.
 
int32_t ARM_MCI_PowerControl (ARM_POWER_STATE state)
 Control Memory Card Interface Power.
 
int32_t ARM_MCI_CardPower (uint32_t voltage)
 Set Memory Card Power supply voltage.
 
int32_t ARM_MCI_ReadCD (void)
 Read Card Detect (CD) state.
 
int32_t ARM_MCI_ReadWP (void)
 Read Write Protect (WP) state.
 
int32_t ARM_MCI_SendCommand (uint32_t cmd, uint32_t arg, uint32_t flags, uint32_t *response)
 Send Command to card and get the response.
 
int32_t ARM_MCI_SetupTransfer (uint8_t *data, uint32_t block_count, uint32_t block_size, uint32_t mode)
 Setup read or write transfer operation.
 
int32_t ARM_MCI_AbortTransfer (void)
 Abort current read/write data transfer.
 
int32_t ARM_MCI_Control (uint32_t control, uint32_t arg)
 Control MCI Interface.
 
ARM_MCI_STATUS ARM_MCI_GetStatus (void)
 Get MCI status.
 
void ARM_MCI_SignalEvent (uint32_t event)
 Callback function that signals a MCI Card Event.
 

Description

Driver API for Memory Card Interface using SD/MMC interface (Driver_MCI.h)

The Memory Card Interface (MCI) implements the hardware abstraction layer for Secure Digital (SD) and Multi Media Card (MMC) memory that is typically used as file storage. For embedded systems, SD/MMC devices are available as memory cards in several forms (SD, miniSD, microSD, MMC, MMCmicro) or as non-removable devices that are directly soldered to the PCB (eMMC).

References:

MCI Structure

The MCI driver allows you to exchange data of the SD/MMC memory via SD/MMC interface.

The following modes are supported by SD/MMC memory cards:

SPI_BusMode.png
SD memory connected via SPI interface

 

SD_1BitBusMode.png
SD memory connected via 1-bit SD Bus Mode

 

SD_4BitBusMode.png
SD memory connected via 4-bit SD Bus Mode

MCI API

The following header files define the Application Programming Interface (API) for the MCI interface:

The driver implementation is a typical part of the Device Family Pack (DFP) that supports the peripherals of the microcontroller family.

Driver Functions

The driver functions are published in the access struct as explained in Driver Functions


Data Structure Documentation

struct ARM_DRIVER_MCI

Access structure of the MCI Driver.

The functions of the MCI are accessed by function pointers exposed by this structure. Refer to Driver Functions for overview information.

Each instance of a MCI provides such an access structure. The instance is identified by a postfix number in the symbol name of the access structure, for example:

  • Driver_MCI0 is the name of the access struct of the first instance (no. 0).
  • Driver_MCI1 is the name of the access struct of the second instance (no. 1).

A configuration setting in the middleware allows connecting the middleware to a specific driver instance Driver_MCIn. The default is 0, which connects a middleware to the first instance of a driver.

Data Fields

ARM_DRIVER_VERSION(* GetVersion )(void)
 Pointer to ARM_MCI_GetVersion : Get driver version.
 
ARM_MCI_CAPABILITIES(* GetCapabilities )(void)
 Pointer to ARM_MCI_GetCapabilities : Get driver capabilities.
 
int32_t(* Initialize )(ARM_MCI_SignalEvent_t cb_event)
 Pointer to ARM_MCI_Initialize : Initialize MCI Interface.
 
int32_t(* Uninitialize )(void)
 Pointer to ARM_MCI_Uninitialize : De-initialize MCI Interface.
 
int32_t(* PowerControl )(ARM_POWER_STATE state)
 Pointer to ARM_MCI_PowerControl : Control MCI Interface Power.
 
int32_t(* CardPower )(uint32_t voltage)
 Pointer to ARM_MCI_CardPower : Set card power supply voltage.
 
int32_t(* ReadCD )(void)
 Pointer to ARM_MCI_ReadCD : Read Card Detect (CD) state.
 
int32_t(* ReadWP )(void)
 Pointer to ARM_MCI_ReadWP : Read Write Protect (WP) state.
 
int32_t(* SendCommand )(uint32_t cmd, uint32_t arg, uint32_t flags, uint32_t *response)
 Pointer to ARM_MCI_SendCommand : Send Command to card and get the response.
 
int32_t(* SetupTransfer )(uint8_t *data, uint32_t block_count, uint32_t block_size, uint32_t mode)
 Pointer to ARM_MCI_SetupTransfer : Setup data transfer operation.
 
int32_t(* AbortTransfer )(void)
 Pointer to ARM_MCI_AbortTransfer : Abort current data transfer.
 
int32_t(* Control )(uint32_t control, uint32_t arg)
 Pointer to ARM_MCI_Control : Control MCI Interface.
 
ARM_MCI_STATUS(* GetStatus )(void)
 Pointer to ARM_MCI_GetStatus : Get MCI status.
 

Field Documentation

int32_t(* AbortTransfer)(void)

Pointer to ARM_MCI_AbortTransfer : Abort current data transfer.

int32_t(* CardPower)(uint32_t voltage)

Pointer to ARM_MCI_CardPower : Set card power supply voltage.

int32_t(* Control)(uint32_t control, uint32_t arg)

Pointer to ARM_MCI_Control : Control MCI Interface.

ARM_MCI_CAPABILITIES(* GetCapabilities)(void)

Pointer to ARM_MCI_GetCapabilities : Get driver capabilities.

ARM_MCI_STATUS(* GetStatus)(void)

Pointer to ARM_MCI_GetStatus : Get MCI status.

ARM_DRIVER_VERSION(* GetVersion)(void)

Pointer to ARM_MCI_GetVersion : Get driver version.

int32_t(* Initialize)(ARM_MCI_SignalEvent_t cb_event)

Pointer to ARM_MCI_Initialize : Initialize MCI Interface.

int32_t(* PowerControl)(ARM_POWER_STATE state)

Pointer to ARM_MCI_PowerControl : Control MCI Interface Power.

int32_t(* ReadCD)(void)

Pointer to ARM_MCI_ReadCD : Read Card Detect (CD) state.

int32_t(* ReadWP)(void)

Pointer to ARM_MCI_ReadWP : Read Write Protect (WP) state.

int32_t(* SendCommand)(uint32_t cmd, uint32_t arg, uint32_t flags, uint32_t *response)

Pointer to ARM_MCI_SendCommand : Send Command to card and get the response.

int32_t(* SetupTransfer)(uint8_t *data, uint32_t block_count, uint32_t block_size, uint32_t mode)

Pointer to ARM_MCI_SetupTransfer : Setup data transfer operation.

int32_t(* Uninitialize)(void)

Pointer to ARM_MCI_Uninitialize : De-initialize MCI Interface.

struct ARM_MCI_CAPABILITIES

MCI Driver Capabilities.

A MCI driver can be implemented with different capabilities. The bitfield members of this struct encode the capabilities implemented by this driver.

Returned by:

Data Fields
uint32_t ccs: 1 Supports Command Completion Signal (CCS) for CE-ATA.
uint32_t ccs_timeout: 1 Supports Command Completion Signal (CCS) timeout for CE-ATA.
uint32_t cd_event: 1 Signal Card Detect change event.
uint32_t cd_state: 1 Card Detect State available.
uint32_t data_width_4: 1 Supports 4-bit data.
uint32_t data_width_4_ddr: 1 Supports 4-bit data, DDR (Dual Data Rate) - MMC only.
uint32_t data_width_8: 1 Supports 8-bit data.
uint32_t data_width_8_ddr: 1 Supports 8-bit data, DDR (Dual Data Rate) - MMC only.
uint32_t high_speed: 1 Supports SD/MMC High Speed Mode.
uint32_t mmc_boot: 1 Supports MMC Boot.
uint32_t mmc_interrupt: 1 Supports MMC Interrupt.
uint32_t read_wait: 1 Supports Read Wait (SD I/O)
uint32_t rst_n: 1 Supports RST_n Pin Control (eMMC)
uint32_t sdio_interrupt: 1 Supports SD I/O Interrupt.
uint32_t suspend_resume: 1 Supports Suspend/Resume (SD I/O)
uint32_t uhs_ddr50: 1 Supports SD UHS-I DDR50 (Dual Data Rate) up to 50MB/s.
uint32_t uhs_driver_type_a: 1 Supports SD UHS-I Driver Type A.
uint32_t uhs_driver_type_c: 1 Supports SD UHS-I Driver Type C.
uint32_t uhs_driver_type_d: 1 Supports SD UHS-I Driver Type D.
uint32_t uhs_sdr104: 1 Supports SD UHS-I SDR104 (Single Data Rate) up to 104MB/s.
uint32_t uhs_sdr50: 1 Supports SD UHS-I SDR50 (Single Data Rate) up to 50MB/s.
uint32_t uhs_signaling: 1 Supports SD UHS-I (Ultra High Speed) 1.8V signaling.
uint32_t uhs_tuning: 1 Supports SD UHS-I tuning.
uint32_t vccq: 1 Supports VCCQ Card Power Supply Control (eMMC)
uint32_t vccq_1v2: 1 Supports 1.2 VCCQ Card Power Supply (eMMC)
uint32_t vccq_1v8: 1 Supports 1.8 VCCQ Card Power Supply (eMMC)
uint32_t vdd: 1 Supports VDD Card Power Supply Control.
uint32_t vdd_1v8: 1 Supports 1.8 VDD Card Power Supply.
uint32_t wp_state: 1 Write Protect State available.
struct ARM_MCI_STATUS

MCI Status.

Structure with information about the status of the MCI.

Returned by:

Data Fields
uint32_t ccs: 1 CCS flag (cleared on start of next command)
uint32_t command_active: 1 Command active flag.
uint32_t command_error: 1 Command error flag (cleared on start of next command)
uint32_t command_timeout: 1 Command timeout flag (cleared on start of next command)
uint32_t sdio_interrupt: 1 SD I/O Interrupt flag (cleared on start of monitoring)
uint32_t transfer_active: 1 Transfer active flag.
uint32_t transfer_error: 1 Transfer error flag (cleared on start of next command)
uint32_t transfer_timeout: 1 Transfer timeout flag (cleared on start of next command)

Typedef Documentation

ARM_MCI_SignalEvent_t

Pointer to ARM_MCI_SignalEvent : Signal MCI Card Event.

Provides the typedef for the callback function ARM_MCI_SignalEvent.

Parameter for:

Function Documentation

int23_t ARM_MCI_AbortTransfer ( void  )

Abort current read/write data transfer.

Returns
Status Error Codes

Aborts the active data transfer operation initiated with ARM_MCI_SendCommand.

int32_t ARM_MCI_CardPower ( uint32_t  voltage)

Set Memory Card Power supply voltage.

Parameters
[in]voltageMemory Card Power supply voltage
Returns
Status Error Codes

Switch the memory card power supply voltage. The following predefined codes can be used for the parameter voltage.

Voltage Control Description
ARM_MCI_POWER_VDD_OFF VDD (VCC) turned off
ARM_MCI_POWER_VDD_3V3 VDD (VCC) = 3.3V
ARM_MCI_POWER_VDD_1V8 VDD (VCC) = 1.8V
ARM_MCI_POWER_VCCQ_OFF eMMC VCCQ turned off
ARM_MCI_POWER_VCCQ_3V3 eMMC VCCQ = 3.3V
ARM_MCI_POWER_VCCQ_1V8 eMMC VCCQ = 1.8V
ARM_MCI_POWER_VCCQ_1V2 eMMC VCCQ = 1.2V
int32_t ARM_MCI_Control ( uint32_t  control,
uint32_t  arg 
)

Control MCI Interface.

Parameters
[in]controlOperation
[in]argArgument of operation (optional)
Returns
Status Error Codes

Controls the MCI interface settings and execute various operations.

The parameter control specifies various parameters with the ARM_MCI_xxx values (see tables below). Depending on the control value, the parameter arg provides additional information or sets values.

ARM_MCI_xxx controls configure the MCI interface or execute various operations.

Controls Description
ARM_MCI_BUS_SPEED Set the Bus Speed. The parameter arg specifies the speed in bits/s; The function returns the bus speed configured in bits/s.
ARM_MCI_BUS_SPEED_MODE Set the Bus Speed Mode. The parameter arg specifies the speed. Predefined Bus Speed Modes are encoded in MCI Bus Speed Mode.
ARM_MCI_BUS_CMD_MODE Set the CMD Line Mode. The parameter arg specifies the CMD Line Mode. Predefined values are encoded in MCI CMD Line Mode.
ARM_MCI_BUS_DATA_WIDTH Set data bus width. The parameter arg specifies the width. Predefined values are encoded in MCI Bus Data Width.
ARM_MCI_DRIVER_STRENGTH Set driver strength. The parameter arg specifies the type. Predefined values are encoded in MCI Driver Strength
ARM_MCI_CONTROL_RESET Control optional RST_n Pin (eMMC). The parameter arg = [0:inactive; 1:active]
ARM_MCI_CONTROL_CLOCK_IDLE Control clock generation on CLK Pin when idle. The parameter arg = [0:disabled; 1:enabled]
ARM_MCI_UHS_TUNING_OPERATION Sampling clock Tuning operation (SD UHS-I). The parameter arg = [0:reset; 1:execute]
ARM_MCI_UHS_TUNING_RESULT Sampling clock Tuning result (SD UHS-I). Returns [0:done; 1:in progress; -1:error]
ARM_MCI_DATA_TIMEOUT Set Data timeout; The parameter arg = timeout in bus cycles.
ARM_MCI_CSS_TIMEOUT Set Command Completion Signal (CCS) timeout. The parameter arg = timeout in bus cycles.
ARM_MCI_MONITOR_SDIO_INTERRUPT Monitor SD I/O interrupt. The parameter arg = [0:disabled; 1:enabled]. Monitoring is automatically disabled when interrupt is recognized.
ARM_MCI_CONTROL_READ_WAIT Control Read/Wait states for SD I/O. The parameter arg = [0:disabled; 1:enabled].
ARM_MCI_SUSPEND_TRANSFER Suspend Data transfer (SD I/O). Returns number of remaining bytes to transfer.
ARM_MCI_RESUME_TRANSFER Resume Data transfer (SD I/O).

For control = ARM_MCI_BUS_SPEED_MODE the parameter arg specifies the bus speed mode using the following ARM_MCI_BUS_xxx values.

Bus Speed Mode Description
ARM_MCI_BUS_DEFAULT_SPEED Set the bus speed for SD/MMC cards: Default Speed mode up to [25;26]MHz (default)
ARM_MCI_BUS_HIGH_SPEED Set the bus speed for SD/MMC: High Speed mode up to [50;52]MHz
ARM_MCI_BUS_UHS_SDR12 Set the bus speed for SD: SDR12 (Single Data Rate) up to 25MHz, 12.5MB/s: UHS-I (Ultra High Speed) 1.8V signalling
ARM_MCI_BUS_UHS_SDR25 Set the bus speed for SD: SDR25 (Single Data Rate) up to 50MHz, 25 MB/s: UHS-I (Ultra High Speed) 1.8V signalling
ARM_MCI_BUS_UHS_SDR50 Set the bus speed for SD: SDR50 (Single Data Rate) up to 100MHz, 50 MB/s: UHS-I (Ultra High Speed) 1.8V signalling
ARM_MCI_BUS_UHS_SDR104 Set the bus speed for SD: SDR104 (Single Data Rate) up to 208MHz, 104 MB/s: UHS-I (Ultra High Speed) 1.8V signalling
ARM_MCI_BUS_UHS_DDR50 Set the bus speed for SD: DDR50 (Dual Data Rate) up to 50MHz, 50 MB/s: UHS-I (Ultra High Speed) 1.8V signalling

For control = ARM_MCI_BUS_CMD_MODE the parameter arg specifies the CMD Line Mode using the following ARM_MCI_BUS_CMD_xxx values.

CMD Line Mode Description
ARM_MCI_BUS_CMD_PUSH_PULL Set the Push-Pull CMD line (default).
ARM_MCI_BUS_CMD_OPEN_DRAIN Set the Open Drain CMD line (MMC only).

For control = ARM_MCI_BUS_DATA_WIDTH the parameter arg specifies the Bus Data Width using the following ARM_MCI_BUS_DATA_WIDTH_xxx values.

Bus Data Width Description
ARM_MCI_BUS_DATA_WIDTH_1 Set the Bus data width to 1 bit (default)
ARM_MCI_BUS_DATA_WIDTH_4 Set the Bus data width to 4 bits
ARM_MCI_BUS_DATA_WIDTH_8 Set the Bus data width to 8 bits
ARM_MCI_BUS_DATA_WIDTH_4_DDR Set the Bus data width to 4 bits, DDR (Dual Data Rate) - MMC only
ARM_MCI_BUS_DATA_WIDTH_8_DDR Set the Bus data width to 8 bits, DDR (Dual Data Rate) - MMC only

For control = ARM_MCI_DRIVER_STRENGTH the parameter arg specifies the Driver Type using the following ARM_MCI_DRIVER_TYPE_x values.

Driver Type Description
ARM_MCI_DRIVER_TYPE_A Set the interface to SD UHS-I Driver Type A
ARM_MCI_DRIVER_TYPE_B Set the interface to SD UHS-I Driver Type B (default)
ARM_MCI_DRIVER_TYPE_C Set the interface to SD UHS-I Driver Type C
ARM_MCI_DRIVER_TYPE_D Set the interface to SD UHS-I Driver Type D
ARM_MCI_CAPABILITIES ARM_MCI_GetCapabilities ( void  )

Get driver capabilities.

Returns
ARM_MCI_CAPABILITIES

Retrieves information about capabilities in this driver implementation. The bitfield members of the struct ARM_MCI_CAPABILITIES encode various capabilities, for example supported bus modes ...

Example:

extern ARM_DRIVER_MCI Driver_MCI0;
ARM_DRIVER_MCI *drv_info;
void read_capabilities (void) {
ARM_MCI_CAPABILITIES drv_capabilities;
drv_info = &Driver_MCI0;
drv_capabilities = drv_info->GetCapabilities ();
// interrogate capabilities
}
ARM_MCI_STATUS ARM_MCI_GetStatus ( void  )

Get MCI status.

Returns
MCI status ARM_MCI_STATUS

Retrieves current MCI interface status.

ARM_DRIVER_VERSION ARM_MCI_GetVersion ( void  )

Get driver version.

Returns
ARM_DRIVER_VERSION

Returns version information of the driver implementation in ARM_DRIVER_VERSION

  • API version is the version of the CMSIS-Driver specification used to implement this driver.
  • Driver version is source code version of the actual driver implementation.

Example:

extern ARM_DRIVER_MCI Driver_MCI0;
ARM_DRIVER_MCI *drv_info;
void setup_mci (void) {
drv_info = &Driver_MCI0;
version = drv_info->GetVersion ();
if (version.api < 0x10A) { // requires at minimum API version 1.10 or higher
// error handling
return;
}
}
int32_t ARM_MCI_Initialize ( ARM_MCI_SignalEvent_t  cb_event)

Initialize the Memory Card Interface.

Parameters
[in]cb_eventPointer to ARM_MCI_SignalEvent
Returns
Status Error Codes

The function initializes the MCI interface. It is called when the middleware component starts operation.

The function performs the following operations:

  • Initializes the resources needed for the MCI interface.
  • Registers the ARM_MCI_SignalEvent callback function.

The parameter cb_event is a pointer to the ARM_MCI_SignalEvent callback function; use a NULL pointer when no callback signals are required.

Example:

int32_t ARM_MCI_PowerControl ( ARM_POWER_STATE  state)

Control Memory Card Interface Power.

Parameters
[in]statePower state ARM_POWER_STATE
Returns
Status Error Codes

Allows you to control the power modes of the MCI interface.

int32_t ARM_MCI_ReadCD ( void  )

Read Card Detect (CD) state.

Returns
1:card detected, 0:card not detected, or error

Read the status of the Card Detect (CD) pin.

int32_t ARM_MCI_ReadWP ( void  )

Read Write Protect (WP) state.

Returns
1:write protected, 0:not write protected, or error

Read the status of the Write Protect (WP) pin.

int32_t ARM_MCI_SendCommand ( uint32_t  cmd,
uint32_t  arg,
uint32_t  flags,
uint32_t *  response 
)

Send Command to card and get the response.

Parameters
[in]cmdMemory Card command
[in]argCommand argument
[in]flagsCommand flags
[out]responsePointer to buffer for response
Returns
Status Error Codes

This function is used to send commands to the memory card and to retrieve the response from the card and optionally start the data transfer.

The function parameters specify the command with the argument that is sent to the card and the flags that control the behavior of the operation.

The following codes can be used for the parameter flags:

Send Command Flag Description
ARM_MCI_RESPONSE_NONE No response expected (default)
ARM_MCI_RESPONSE_SHORT Short response (48-bit) expected
ARM_MCI_RESPONSE_SHORT_BUSY Short response with busy signal (48-bit) expected
ARM_MCI_RESPONSE_LONG Long response (136-bit) expected
ARM_MCI_RESPONSE_INDEX Check command index in response
ARM_MCI_RESPONSE_CRC Check CRC in response
ARM_MCI_WAIT_BUSY Wait until busy before sending the command
ARM_MCI_TRANSFER_DATA Activate Data transfer
ARM_MCI_CARD_INITIALIZE Execute Memory Card initialization sequence
ARM_MCI_INTERRUPT_COMMAND Send Interrupt command (CMD40 - MMC only)
ARM_MCI_INTERRUPT_RESPONSE Send Interrupt response (CMD40 - MMC only)
ARM_MCI_BOOT_OPERATION Execute Boot operation (MMC only)
ARM_MCI_BOOT_ALTERNATIVE Execute Alternative Boot operation (MMC only)
ARM_MCI_BOOT_ACK Expect Boot Acknowledge (MMC only)
ARM_MCI_CCSD Send Command Completion Signal Disable (CCSD) for CE-ATA device
ARM_MCI_CCS Expect Command Completion Signal (CCS) for CE-ATA device

Calling the function ARM_MCI_SendCommand only starts the operation. The function is non-blocking and returns as soon as the driver has started the operation. It is not allowed to call this function again until the operation is in progress.

After the command is sent the response is retrieved if specified with ARM_MCI_RESPONSE_xxx flags. When the command completes successfully (requested response is received without errors) the ARM_MCI_EVENT_COMMAND_COMPLETE event is generated. In case that response is requested but not received the ARM_MCI_EVENT_COMMAND_TIMEOUT event is generated instead. In case of invalid response (or CRC error) the ARM_MCI_EVENT_COMMAND_ERROR event is generated instead. Progress of command operation can be monitored by calling the ARM_MCI_GetStatus and checking the command_active flag.

After the command operation the data transfer operation is started if specified with ARM_MCI_TRANSFER_DATA flag. The data transfer needs to be configured before that by calling the ARM_MCI_SetupTransfer. When the data transfer completes successfully the ARM_MCI_EVENT_TRANSFER_COMPLETE event is generated. In case that data transfer is not completed in-time (specified by ARM_MCI_DATA_TIMEOUT) the ARM_MCI_EVENT_TRANSFER_TIMEOUT event is generated instead. In case of CRC errors the ARM_MCI_EVENT_TRANSFER_ERROR event is generated instead. Progress of data transfer operation can be monitored by calling the ARM_MCI_GetStatus and checking the transfer_active flag.

int32_t ARM_MCI_SetupTransfer ( uint8_t *  data,
uint32_t  block_count,
uint32_t  block_size,
uint32_t  mode 
)

Setup read or write transfer operation.

Parameters
[in,out]dataPointer to data block(s) to be written or read
[in]block_countNumber of blocks
[in]block_sizeSize of a block in bytes
[in]modeTransfer mode
Returns
Status Error Codes

This function is used to setup data transfer operation that is initiated by calling ARM_MCI_SendCommand with ARM_MCI_TRANSFER_DATA flag.

The parameter mode can have the following codes to configure the transfer mode.

Transfer Directions Description
ARM_MCI_TRANSFER_READ Read data from MCI
ARM_MCI_TRANSFER_WRITE Write data to MCI
ARM_MCI_TRANSFER_BLOCK Block Data transfer (default)
ARM_MCI_TRANSFER_STREAM Stream Data transfer (MMC only)
void ARM_MCI_SignalEvent ( uint32_t  event)

Callback function that signals a MCI Card Event.

Parameters
[in]eventMCI Events
Returns
none

The optional call back function ARM_MCI_SignalEvent notifies the application about MCI Events and is registered by the function ARM_MCI_Initialize. The function ARM_MCI_GetCapabilities returns information about the implemented events in a driver.

The argument event represents the notification mask of the events. One or more events may be notified with the same callback, because each event is coded in a separate bit. The following call back notifications are generated:

BitEvent Description
0 ARM_MCI_EVENT_CARD_INSERTED Occurs after Memory Card inserted
1 ARM_MCI_EVENT_CARD_REMOVED Occurs after Memory Card removal
2 ARM_MCI_EVENT_COMMAND_COMPLETE Occurs after command completed successfully
3 ARM_MCI_EVENT_COMMAND_TIMEOUT Occurs after command timeout
4 ARM_MCI_EVENT_COMMAND_ERROR Occurs after command response error (CRC error or invalid response)
5 ARM_MCI_EVENT_TRANSFER_COMPLETE Occurs after data transfer completed successfully
6 ARM_MCI_EVENT_TRANSFER_TIMEOUT Occurs after data transfer timeout
7 ARM_MCI_EVENT_TRANSFER_ERROR Occurs after data transfer error (CRC failed)
8 ARM_MCI_EVENT_SDIO_INTERRUPT Indicates SD I/O Interrupt
9 ARM_MCI_EVENT_CCS Indicates a Command Completion Signal (CCS)
10 ARM_MCI_EVENT_CCS_TIMEOUT Indicates a Command Completion Signal (CCS) Timeout
int32_t ARM_MCI_Uninitialize ( void  )

De-initialize Memory Card Interface.

Returns
Status Error Codes

The function ARM_MCI_Uninitialize de-initializes the resources of I2C interface.

It is called when the middleware component stops operation and releases the software resources used by the interface.