Unit MMC

Return to Unit Reference

Description

---

This unit implements the standards based part of the SD/MMC specification including the standard SDHCI interfaces.

For each platform a SDHCI module needs to be provided that implements the platform specific parts of the SDHCI interface.

This is similar in model to USB and other interfaces in Ultibo, where the generic interface unit requires a platform specific module to register with it in order to communicate with platform specific devices.

The SD/MMC interfaces are 2 tier (ie Host and Device) whereas the USB interface is 3 tier (Host, Device and Driver).

Constants

---

To be documented

Type definitions

---

To be documented

Public variables

---

To be documented

Function declarations

---

Initialization functions

[Expand]

procedure MMCInit;

Description: To be documented

Note	None documented

[Expand]

function MMCStart:LongWord;

Description: To be documented

Note	None documented

[Expand]

function MMCStop:LongWord;

Description: To be documented

Note	None documented

[Expand]

procedure MMCAsyncStart(SDHCI:PSDHCIHost);

Description: To be documented

Note	None documented

MMC functions

[Expand]

function MMCDeviceReadBlocks(MMC:PMMCDevice; const Start,Count:Int64; Buffer:Pointer):LongWord;

Description: To be documented

Note	None documented

[Expand]

function MMCDeviceWriteBlocks(MMC:PMMCDevice; const Start,Count:Int64; Buffer:Pointer):LongWord;

Description: To be documented

Note	None documented

[Expand]

function MMCDeviceEraseBlocks(MMC:PMMCDevice; const Start,Count:Int64):LongWord;

Description: To be documented

Note	None documented

[Expand]

function MMCDeviceGoIdle(MMC:PMMCDevice):LongWord;

Description: To be documented

Note	None documented

[Expand]

function MMCDeviceSetClock(MMC:PMMCDevice; Clock:LongWord):LongWord;

Description: To be documented

Note	None documented

[Expand]

function MMCDeviceSetBusWidth(MMC:PMMCDevice; Width:LongWord):LongWord;

Description: To be documented

Reference	Section 3.4 of SD Host Controller Simplified Specification V3.0 partA2_300.pdf

[Expand]

function MMCDeviceSetBlockLength(MMC:PMMCDevice; Length:LongWord):LongWord;

Description: To be documented

Note	None documented

[Expand]

function MMCDeviceSetBlockCount(MMC:PMMCDevice; Count:LongWord; Relative:Boolean):LongWord;

Description: To be documented

Note	None documented

[Expand]

function MMCDeviceSetDriverStage(MMC:PMMCDevice; DriverStage:LongWord):LongWord;

Description: To be documented

Note	None documented

[Expand]

function MMCDeviceSelectCard(MMC:PMMCDevice):LongWord;

Description: To be documented

Note	None documented

[Expand]

function MMCDeviceDeselectCard(MMC:PMMCDevice):LongWord;

Description: To be documented

Note	None documented

[Expand]

function MMCDeviceSwitch(MMC:PMMCDevice; Setting,Index,Value:Byte):LongWord;

Description: To be documented

Note	None documented

[Expand]

function MMCDeviceSendCardStatus(MMC:PMMCDevice):LongWord;

Description: To be documented

Note	None documented

[Expand]

function MMCDeviceSendOperationCondition(MMC:PMMCDevice; Probe:Boolean):LongWord;

Description: To be documented

Note	None documented

[Expand]

function MMCDeviceSendCardSpecific(MMC:PMMCDevice):LongWord;

Description: To be documented

Note	None documented

[Expand]

function MMCDeviceDecodeCardSpecific(MMC:PMMCDevice):LongWord;

Description: Given a 128-bit response, decode to our card CSD structure

Note	None documented

[Expand]

function MMCDeviceSendCardIdentification(MMC:PMMCDevice):LongWord;

Description: To be documented

Note	None documented

[Expand]

function MMCDeviceSendAllCardIdentification(MMC:PMMCDevice):LongWord;

Description: To be documented

Note	None documented

[Expand]

function MMCDeviceDecodeCardIdentification(MMC:PMMCDevice):LongWord;

Description: Given a 128-bit response, decode to our card CID structure

Note	None documented

[Expand]

function MMCDeviceGetExtendedCardSpecific(MMC:PMMCDevice):LongWord;

Description: To be documented

Note	None documented

[Expand]

function MMCDeviceSendExtendedCardSpecific(MMC:PMMCDevice):LongWord;

Description: To be documented

Note	None documented

[Expand]

function MMCDeviceDecodeExtendedCardSpecific(MMC:PMMCDevice):LongWord;

Description: To be documented

Note	None documented

[Expand]

function MMCDeviceSetRelativeAddress(MMC:PMMCDevice):LongWord;

Description: To be documented

Note	None documented

[Expand]

function MMCDeviceSPISetCRC(MMC:PMMCDevice; Enable:Boolean):LongWord;

Description: To be documented

Note	None documented

[Expand]

function MMCDeviceSPIReadOperationCondition(MMC:PMMCDevice; HighCapacity:Boolean):LongWord;

Description: To be documented

Note	None documented

[Expand]

function MMCDeviceInsert(MMC:PMMCDevice):LongWord;

Description: To be documented

Note	None documented

[Expand]

function MMCDeviceRemove(MMC:PMMCDevice):LongWord;

Description: To be documented

Note	None documented

[Expand]

function MMCDeviceInitialize(MMC:PMMCDevice):LongWord;

Description: To be documented

Reference	Section 3.6 of SD Host Controller Simplified Specification V3.0 partA2_300.pdf

[Expand]

function MMCDeviceDeinitialize(MMC:PMMCDevice):LongWord;

Description: To be documented

Note	None documented

[Expand]

function MMCDeviceGetCardDetect(MMC:PMMCDevice):LongWord;

Description: To be documented

Note	None documented

[Expand]

function MMCDeviceGetWriteProtect(MMC:PMMCDevice):LongWord;

Description: To be documented

Note	None documented

[Expand]

function MMCDeviceSendCommand(MMC:PMMCDevice; Command:PMMCCommand):LongWord;

Description: To be documented

Note	None documented

[Expand]

function MMCDeviceSetIOS(MMC:PMMCDevice):LongWord;

Description: To be documented

Note	None documented

[Expand]

function MMCDeviceCreate:PMMCDevice;

Description: Create a new MMC entry

Return	Pointer to new MMC entry or nil if MMC could not be created

[Expand]

function MMCDeviceCreateEx(Size:LongWord):PMMCDevice;

Description: Create a new MMC entry

Size	Size in bytes to allocate for new MMC (Including the MMC entry)
Return	Pointer to new MMC entry or nil if MMC could not be created

[Expand]

function MMCDeviceDestroy(MMC:PMMCDevice):LongWord;

Description: Destroy an existing MMC entry

Note	None documented

[Expand]

function MMCDeviceRegister(MMC:PMMCDevice):LongWord;

Description: Register a new MMC in the MMC table

Note	None documented

[Expand]

function MMCDeviceDeregister(MMC:PMMCDevice):LongWord;

Description: Deregister a MMC ?rom the MMC table

Note	None documented

[Expand]

function MMCDeviceFind(MMCId:LongWord):PMMCDevice;

Description: To be documented

Note	None documented

[Expand]

function MMCDeviceFindByName(const Name:String):PMMCDevice; inline;

Description: To be documented

Note	None documented

[Expand]

function MMCDeviceFindByDescription(const Description:String):PMMCDevice; inline;

Description: To be documented

Note	None documented

[Expand]

function MMCDeviceEnumerate(Callback:TMMCEnumerate; Data:Pointer):LongWord;

Description: To be documented

Note	None documented

[Expand]

function MMCDeviceNotification(MMC:PMMCDevice; Callback:TMMCNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;

Description: To be documented

Note	None documented

SD functions

[Expand]

function SDDeviceSwitch(MMC:PMMCDevice; Mode,Group:Integer; Value:Byte; Buffer:Pointer):LongWord;

Description: To be documented

Buffer	Buffer must point to a 64 byte buffer for Switch Status information
Note	See 4.3.10 of SD Physical Layer Simplified Specification V4.10

[Expand]

function SDDeviceSwitchHighspeed(MMC:PMMCDevice):LongWord;

Description: To be documented

Note	None documented

[Expand]

function SDDeviceSetBusSpeed(MMC:PMMCDevice; Speed:LongWord):LongWord;

Description: To be documented

Note	None documented

[Expand]

function SDDeviceSetBusWidth(MMC:PMMCDevice; Width:LongWord):LongWord;

Description: To be documented

Note	See Table 4-30 in Section 4.7.4 of SD Physical Layer Simplified Specification V4.10

[Expand]

function SDDeviceSendInterfaceCondition(MMC:PMMCDevice):LongWord;

Description: To be documented

Note	See 4.3.13 of SD Physical Layer Simplified Specification V4.10. CMD8 (SEND_IF_COND) must be invoked to support SD 2.0 cards. The card must be in Idle State before issuing this command. This command will fail harmlessly for SD 1.0 cards.

[Expand]

function SDDeviceSendOperationCondition(MMC:PMMCDevice; Probe:Boolean):LongWord;

Description: To be documented

Note	See 4.2.3.1 of SD Physical Layer Simplified Specification V4.10

[Expand]

function SDDeviceGetCardSpecific(MMC:PMMCDevice):LongWord;

Description: To be documented

Note	None documented

[Expand]

function SDDeviceDecodeCardSpecific(MMC:PMMCDevice):LongWord;

Description: Given a 128-bit response, decode to our card CSD structure

Note	None documented

[Expand]

function SDDeviceGetCardIdentification(MMC:PMMCDevice):LongWord;

Description: To be documented

Note	None documented

[Expand]

function SDDeviceDecodeCardIdentification(MMC:PMMCDevice):LongWord;

Description: Given a 128-bit response, decode to our card CID structure

Note	None documented

[Expand]

function SDDeviceSendSDStatus(MMC:PMMCDevice):LongWord;

Description: To be documented

Note	None documented

[Expand]

function SDDeviceDecodeSDStatus(MMC:PMMCDevice):LongWord;

Description: To be documented

Note	None documented

[Expand]

function SDDeviceSendSDSwitch(MMC:PMMCDevice):LongWord;

Description: To be documented

Note	None documented

[Expand]

function SDDeviceDecodeSDSwitch(MMC:PMMCDevice):LongWord;

Description: To be documented

Note	None documented

[Expand]

function SDDeviceSendSDConfiguration(MMC:PMMCDevice):LongWord;

Description: To be documented

Note	None documented

[Expand]

function SDDeviceDecodeSDConfiguration(MMC:PMMCDevice):LongWord;

Description: Given a 64-bit response, decode to our card SCR structure

Note	None documented

[Expand]

function SDDeviceSendRelativeAddress(MMC:PMMCDevice):LongWord;

Description: To be documented

Note	None documented

[Expand]

function SDDeviceSendApplicationCommand(MMC:PMMCDevice; Command:PMMCCommand):LongWord;

Description: To be documented

Note	None documented

SDIO functions

[Expand]

function SDIODeviceReset(MMC:PMMCDevice):LongWord;

Description: To be documented

Note	See SDIO Simplified Specification V2.0, 4.4 Reset for SDIO

[Expand]

function SDIODeviceSendOperationCondition(MMC:PMMCDevice; Probe:Boolean):LongWord;

Description: To be documented

Note	None documented

[Expand]

function SDIODeviceReadWriteDirect(MMC:PMMCDevice; Write:Boolean; Operation,Address:LongWord; Input:Byte; Output:PByte):LongWord;

Description: To be documented

Note	None documented

[Expand]

function SDIODeviceReadWriteExtended(MMC:PMMCDevice; Write:Boolean; Operation,Address:LongWord; Increment:Boolean; Buffer:Pointer; BlockCount,BlockSize:LongWord):LongWord;

Description: To be documented

Note	None documented

SDHCI functions

[Expand]

function SDHCIHostReset(SDHCI:PSDHCIHost; Mask:Byte):LongWord;

Description: To be documented

Reference	Section 3.3 of SD Host Controller Simplified Specification V3.0 partA2_300.pdf

[Expand]

function SDHCIHostSetPower(SDHCI:PSDHCIHost; Power:Word):LongWord;

Description: To be documented

Reference	Section 3.3 of SD Host Controller Simplified Specification V3.0 partA2_300.pdf

[Expand]

function SDHCIHostSetClock(SDHCI:PSDHCIHost; Clock:LongWord):LongWord;

Description: To be documented

Reference	Section 3.2 of SD Host Controller Simplified Specification V3.0 partA2_300.pdf

[Expand]

function SDHCIHostTransferPIO(SDHCI:PSDHCIHost):LongWord;

Description: To be documented

Note	None documented

[Expand]

function SDHCIHostTransferDMA(SDHCI:PSDHCIHost):LongWord;

Description: To be documented

Note	None documented

[Expand]

function SDHCIHostFinishCommand(SDHCI:PSDHCIHost):LongWord;

Description: Called by Interrupt Command handler when an SDHCI_INT_RESPONSE is received

Note	None documented

[Expand]

function SDHCIHostFinishData(SDHCI:PSDHCIHost):LongWord;

Description: Called by Interrupt Data handler when data is received

Note	None documented

[Expand]

function SDHCIHostCommandInterrupt(SDHCI:PSDHCIHost; InterruptMask:LongWord; var ReturnMask:LongWord):LongWord;

Description: To be documented

Note	None documented

[Expand]

function SDHCIHostDataInterrupt(SDHCI:PSDHCIHost; InterruptMask:LongWord):LongWord;

Description: To be documented

Note	None documented

[Expand]

function SDHCIHostStart(SDHCI:PSDHCIHost):LongWord;

Description: To be documented

Note	None documented

[Expand]

function SDHCIHostStop(SDHCI:PSDHCIHost):LongWord;

Description: To be documented

Note	None documented

[Expand]

function SDHCIHostReadByte(SDHCI:PSDHCIHost; Reg:LongWord):Byte; inline;

Description: To be documented

Note	None documented

[Expand]

function SDHCIHostReadWord(SDHCI:PSDHCIHost; Reg:LongWord):Word; inline;

Description: To be documented

Note	None documented

[Expand]

function SDHCIHostReadLong(SDHCI:PSDHCIHost; Reg:LongWord):LongWord; inline;

Description: To be documented

Note	None documented

[Expand]

procedure SDHCIHostWriteByte(SDHCI:PSDHCIHost; Reg:LongWord; Value:Byte); inline;

Description: To be documented

Note	None documented

[Expand]

procedure SDHCIHostWriteWord(SDHCI:PSDHCIHost; Reg:LongWord; Value:Word); inline;

Description: To be documented

Note	None documented

[Expand]

procedure SDHCIHostWriteLong(SDHCI:PSDHCIHost; Reg:LongWord; Value:LongWord); inline;

Description: To be documented

Note	None documented

[Expand]

function SDHCIHostSetClockDivider(SDHCI:PSDHCIHost; Index:Integer; Divider:LongWord):LongWord;

Description: To be documented

Note	None documented

[Expand]

function SDHCIHostSetControlRegister(SDHCI:PSDHCIHost):LongWord;

Description: To be documented

Note	None documented

[Expand]

function SDHCIHostCreate:PSDHCIHost;

Description: Create a new SDHCI entry

Return	Pointer to new SDHCI entry or nil if SDHCI could not be created

[Expand]

function SDHCIHostCreateEx(Size:LongWord):PSDHCIHost;

Description: Create a new SDHCI entry

Size	Size in bytes to allocate for new SDHCI (Including the SDHCI entry)
Return	Pointer to new SDHCI entry or nil if SDHCI could not be created

[Expand]

function SDHCIHostDestroy(SDHCI:PSDHCIHost):LongWord;

Description: Destroy an existing SDHCI entry

Note	None documented

[Expand]

function SDHCIHostRegister(SDHCI:PSDHCIHost):LongWord;

Description: Register a new SDHCI in the SDHCI table

Note	None documented

[Expand]

function SDHCIHostDeregister(SDHCI:PSDHCIHost):LongWord;

Description: Deregister a SDHCI ?rom the SDHCI table

Note	None documented

[Expand]

function SDHCIHostFind(SDHCIId:LongWord):PSDHCIHost;

Description: To be documented

Note	None documented

[Expand]

function SDHCIHostEnumerate(Callback:TSDHCIEnumerate; Data:Pointer):LongWord;

Description: To be documented

Note	None documented

[Expand]

function SDHCIHostNotification(SDHCI:PSDHCIHost; Callback:TSDHCINotification; Data:Pointer; Notification,Flags:LongWord):LongWord;

Description: To be documented

Note	None documented

Return to Unit Reference