SD/MMC Memory

Collaboration diagram for SD/MMC Memory:

Modules
	Implementation of SD/MMC Memory

Control Interface
Ctrl_status	sd_mmc_test_unit_ready (uint8_t slot)
	Tests the memory state and initializes the memory if required. More...
Ctrl_status	sd_mmc_test_unit_ready_0 (void)
	Instance Declaration for sd_mmc_test_unit_ready Slot O. More...
Ctrl_status	sd_mmc_test_unit_ready_1 (void)
	Instance Declaration for sd_mmc_test_unit_ready Slot 1. More...
Ctrl_status	sd_mmc_read_capacity (uint8_t slot, uint32_t *u32_nb_sector)
	Returns the address of the last valid sector in the memory. More...
Ctrl_status	sd_mmc_read_capacity_0 (uint32_t *u32_nb_sector)
	Instance Declaration for sd_mmc_read_capacity Slot O. More...
Ctrl_status	sd_mmc_read_capacity_1 (uint32_t *u32_nb_sector)
	Instance Declaration for sd_mmc_read_capacity Slot 1. More...
bool	sd_mmc_unload (uint8_t slot, bool unload)
	Unload/Load the SD/MMC card selected. More...
bool	sd_mmc_unload_0 (bool unload)
	Instance Declaration for sd_mmc_unload Slot O. More...
bool	sd_mmc_unload_1 (bool unload)
	Instance Declaration for sd_mmc_unload Slot 1. More...
bool	sd_mmc_wr_protect (uint8_t slot)
	Returns the write-protection state of the memory. More...
bool	sd_mmc_wr_protect_0 (void)
	Instance Declaration for sd_mmc_wr_protect Slot O. More...
bool	sd_mmc_wr_protect_1 (void)
	Instance Declaration for sd_mmc_wr_protect Slot 1. More...
bool	sd_mmc_removal (uint8_t slot)
	Tells whether the memory is removable. More...
bool	sd_mmc_removal_0 (void)
	Instance Declaration for sd_mmc_removal Slot O. More...
bool	sd_mmc_removal_1 (void)
	Instance Declaration for sd_mmc_removal Slot 1. More...

MEM <-> USB Interface
Ctrl_status	sd_mmc_usb_read_10 (uint8_t slot, uint32_t addr, uint16_t nb_sector)
	Transfers data from the memory to USB. More...
Ctrl_status	sd_mmc_usb_read_10_0 (uint32_t addr, uint16_t nb_sector)
	Instance Declaration for sd_mmc_usb_read_10 Slot O. More...
Ctrl_status	sd_mmc_usb_read_10_1 (uint32_t addr, uint16_t nb_sector)
	Instance Declaration for sd_mmc_usb_read_10 Slot 1. More...
Ctrl_status	sd_mmc_usb_write_10 (uint8_t slot, uint32_t addr, uint16_t nb_sector)
	Transfers data from USB to the memory. More...
Ctrl_status	sd_mmc_usb_write_10_0 (uint32_t addr, uint16_t nb_sector)
	Instance Declaration for sd_mmc_usb_write_10 Slot O. More...
Ctrl_status	sd_mmc_usb_write_10_1 (uint32_t addr, uint16_t nb_sector)
	Instance Declaration for sd_mmc_usb_write_10 Slot 1. More...

MEM <-> RAM Interface
Ctrl_status	sd_mmc_mem_2_ram (uint8_t slot, uint32_t addr, void *ram)
	Copies 1 data sector from the memory to RAM. More...
Ctrl_status	sd_mmc_mem_2_ram_0 (uint32_t addr, void *ram)
	Instance Declaration for sd_mmc_mem_2_ram Slot O. More...
Ctrl_status	sd_mmc_mem_2_ram_1 (uint32_t addr, void *ram)
	Instance Declaration for sd_mmc_mem_2_ram Slot 1. More...
Ctrl_status	sd_mmc_ram_2_mem (uint8_t slot, uint32_t addr, const void *ram)
	Copies 1 data sector from RAM to the memory. More...
Ctrl_status	sd_mmc_ram_2_mem_0 (uint32_t addr, const void *ram)
	Instance Declaration for sd_mmc_mem_2_ram Slot O. More...
Ctrl_status	sd_mmc_ram_2_mem_1 (uint32_t addr, const void *ram)
	Instance Declaration for sd_mmc_mem_2_ram Slot 1. More...

Detailed Description

SD/MMC memory APIs required by CTRL_ACCESS module (Memory Control Access).

For usual application which use the SD/MMC card in memory mode through a file system or a USB device MSC, only a call of sd_mmc_init() function is required in the startup.

Function Documentation

sd_mmc_mem_2_ram()

Ctrl_status sd_mmc_mem_2_ram	(	uint8_t	slot,
		uint32_t	addr,
		void *	ram
	)

Copies 1 data sector from the memory to RAM.

Parameters

slot	SD/MMC Slot Card Selected.
addr	Address of first memory sector to read.
ram	Pointer to RAM buffer to write.

Returns

Status.

Definition at line 297 of file sd_mmc_mem.c.

sd_mmc_mem_2_ram_0()

Ctrl_status sd_mmc_mem_2_ram_0	(	uint32_t	addr,
		void *	ram
	)

Instance Declaration for sd_mmc_mem_2_ram Slot O.

Definition at line 316 of file sd_mmc_mem.c.

sd_mmc_mem_2_ram_1()

Ctrl_status sd_mmc_mem_2_ram_1	(	uint32_t	addr,
		void *	ram
	)

Instance Declaration for sd_mmc_mem_2_ram Slot 1.

Definition at line 321 of file sd_mmc_mem.c.

sd_mmc_ram_2_mem()

Ctrl_status sd_mmc_ram_2_mem	(	uint8_t	slot,
		uint32_t	addr,
		const void *	ram
	)

Copies 1 data sector from RAM to the memory.

Parameters

slot	SD/MMC Slot Card Selected.
addr	Address of first memory sector to write.
ram	Pointer to RAM buffer to read.

Returns

Status.

Definition at line 326 of file sd_mmc_mem.c.

sd_mmc_ram_2_mem_0()

Ctrl_status sd_mmc_ram_2_mem_0	(	uint32_t	addr,
		const void *	ram
	)

Instance Declaration for sd_mmc_mem_2_ram Slot O.

Definition at line 345 of file sd_mmc_mem.c.

sd_mmc_ram_2_mem_1()

Ctrl_status sd_mmc_ram_2_mem_1	(	uint32_t	addr,
		const void *	ram
	)

Instance Declaration for sd_mmc_mem_2_ram Slot 1.

Definition at line 350 of file sd_mmc_mem.c.

sd_mmc_read_capacity()

Ctrl_status sd_mmc_read_capacity	(	uint8_t	slot,
		uint32_t *	u32_nb_sector
	)

Returns the address of the last valid sector in the memory.

Parameters

slot	SD/MMC Slot Card Selected.
u32_nb_sector	Pointer to the address of the last valid sector.

Returns

Status.

Definition at line 95 of file sd_mmc_mem.c.

sd_mmc_read_capacity_0()

Ctrl_status sd_mmc_read_capacity_0

(

uint32_t *

u32_nb_sector

)

Instance Declaration for sd_mmc_read_capacity Slot O.

Definition at line 102 of file sd_mmc_mem.c.

sd_mmc_read_capacity_1()

Ctrl_status sd_mmc_read_capacity_1

(

uint32_t *

u32_nb_sector

)

Instance Declaration for sd_mmc_read_capacity Slot 1.

Definition at line 107 of file sd_mmc_mem.c.

sd_mmc_removal()

bool sd_mmc_removal

(

uint8_t

slot

)

Tells whether the memory is removable.

Parameters

slot	SD/MMC Slot Card Selected.

Returns

true if the memory is removable, else false.

Definition at line 143 of file sd_mmc_mem.c.

sd_mmc_removal_0()

bool sd_mmc_removal_0

(

void

)

Instance Declaration for sd_mmc_removal Slot O.

Definition at line 149 of file sd_mmc_mem.c.

sd_mmc_removal_1()

bool sd_mmc_removal_1

(

void

)

Instance Declaration for sd_mmc_removal Slot 1.

Definition at line 154 of file sd_mmc_mem.c.

sd_mmc_test_unit_ready()

Ctrl_status sd_mmc_test_unit_ready

(

uint8_t

slot

)

Tests the memory state and initializes the memory if required.

The TEST UNIT READY SCSI primary command allows an application client to poll a LUN until it is ready without having to allocate memory for returned data.

This command may be used to check the media status of LUNs with removable media.

Parameters

slot	SD/MMC Slot Card Selected.

Returns

Status.

Definition at line 58 of file sd_mmc_mem.c.

sd_mmc_test_unit_ready_0()

Ctrl_status sd_mmc_test_unit_ready_0

(

void

)

Instance Declaration for sd_mmc_test_unit_ready Slot O.

Definition at line 84 of file sd_mmc_mem.c.

sd_mmc_test_unit_ready_1()

Ctrl_status sd_mmc_test_unit_ready_1

(

void

)

Instance Declaration for sd_mmc_test_unit_ready Slot 1.

Definition at line 90 of file sd_mmc_mem.c.

sd_mmc_unload()

bool sd_mmc_unload	(	uint8_t	slot,
		bool	unload
	)

Unload/Load the SD/MMC card selected.

The START STOP UNIT SCSI optional command allows an application client to eject the removable medium on a LUN.

Parameters

slot	SD/MMC Slot Card Selected.
unload	true to unload the medium, false to load the medium.

Returns

true if unload/load done success.

Definition at line 112 of file sd_mmc_mem.c.

sd_mmc_unload_0()

bool sd_mmc_unload_0

(

bool

unload

)

Instance Declaration for sd_mmc_unload Slot O.

Definition at line 118 of file sd_mmc_mem.c.

sd_mmc_unload_1()

bool sd_mmc_unload_1

(

bool

unload

)

Instance Declaration for sd_mmc_unload Slot 1.

Definition at line 123 of file sd_mmc_mem.c.

sd_mmc_usb_read_10()

Ctrl_status sd_mmc_usb_read_10	(	uint8_t	slot,
		uint32_t	addr,
		uint16_t	nb_sector
	)

Transfers data from the memory to USB.

Parameters

slot	SD/MMC Slot Card Selected.
addr	Address of first memory sector to read.
nb_sector	Number of sectors to transfer.

Returns

Status.

Definition at line 174 of file sd_mmc_mem.c.

sd_mmc_usb_read_10_0()

Ctrl_status sd_mmc_usb_read_10_0	(	uint32_t	addr,
		uint16_t	nb_sector
	)

Instance Declaration for sd_mmc_usb_read_10 Slot O.

Definition at line 222 of file sd_mmc_mem.c.

sd_mmc_usb_read_10_1()

Ctrl_status sd_mmc_usb_read_10_1	(	uint32_t	addr,
		uint16_t	nb_sector
	)

Instance Declaration for sd_mmc_usb_read_10 Slot 1.

Definition at line 227 of file sd_mmc_mem.c.

sd_mmc_usb_write_10()

Ctrl_status sd_mmc_usb_write_10	(	uint8_t	slot,
		uint32_t	addr,
		uint16_t	nb_sector
	)

Transfers data from USB to the memory.

Parameters

slot	SD/MMC Slot Card Selected.
addr	Address of first memory sector to write.
nb_sector	Number of sectors to transfer.

Returns

Status.

Definition at line 232 of file sd_mmc_mem.c.

sd_mmc_usb_write_10_0()

Ctrl_status sd_mmc_usb_write_10_0	(	uint32_t	addr,
		uint16_t	nb_sector
	)

Instance Declaration for sd_mmc_usb_write_10 Slot O.

Definition at line 279 of file sd_mmc_mem.c.

sd_mmc_usb_write_10_1()

Ctrl_status sd_mmc_usb_write_10_1	(	uint32_t	addr,
		uint16_t	nb_sector
	)

Instance Declaration for sd_mmc_usb_write_10 Slot 1.

Definition at line 284 of file sd_mmc_mem.c.

sd_mmc_wr_protect()

bool sd_mmc_wr_protect

(

uint8_t

slot

)

Returns the write-protection state of the memory.

Parameters

slot	SD/MMC Slot Card Selected.

Returns

true if the memory is write-protected, else false.

Note

Only used by removable memories with hardware-specific write protection.

Definition at line 128 of file sd_mmc_mem.c.

sd_mmc_wr_protect_0()

bool sd_mmc_wr_protect_0

(

void

)

Instance Declaration for sd_mmc_wr_protect Slot O.

Definition at line 133 of file sd_mmc_mem.c.

sd_mmc_wr_protect_1()

bool sd_mmc_wr_protect_1

(

void

)

Instance Declaration for sd_mmc_wr_protect Slot 1.

Definition at line 138 of file sd_mmc_mem.c.