Modules
	Common SPI interface for SD/MMC stack
	implementation

Typedefs
typedef uint8_t	sd_mmc_spi_errno_t
	Type of return error code. More...

Functions
bool	sd_mmc_spi_adtc_start (sdmmc_cmd_def_t cmd, uint32_t arg, uint16_t block_size, uint16_t nb_block, bool access_block)
	Send a adtc command on the selected slot A adtc command is used for read/write access. More...

bool	sd_mmc_spi_adtc_stop (sdmmc_cmd_def_t cmd, uint32_t arg)
	Send a command to stop a adtc command on the selected slot. More...

void	sd_mmc_spi_deselect_device (uint8_t slot)
	Deselect a slot. More...

static __inline__ uint8_t	sd_mmc_spi_get_bus_width (uint8_t slot)
	Return the maximum bus width of a slot. More...

sd_mmc_spi_errno_t	sd_mmc_spi_get_errno (void)
	Return the error code of last function. More...

uint32_t	sd_mmc_spi_get_response (void)
	Return the 32 bits response of the last command. More...

static __inline__ void	sd_mmc_spi_get_response_128 (uint8_t *resp)

void	sd_mmc_spi_init (void)
	Initializes the low level driver. More...

static __inline__ bool	sd_mmc_spi_is_high_speed_capable (void)
	Return the high speed capability of the driver. More...

bool	sd_mmc_spi_read_word (uint32_t *value)
	Read a word on the line. More...

void	sd_mmc_spi_select_device (uint8_t slot, uint32_t clock, uint8_t bus_width, bool high_speed)
	Select a slot and initialize it. More...

void	sd_mmc_spi_send_clock (void)
	Send 74 clock cycles on the line of selected slot Note: It is required after card plug and before card install. More...

bool	sd_mmc_spi_send_cmd (sdmmc_cmd_def_t cmd, uint32_t arg)
	Send a command on the selected slot. More...

bool	sd_mmc_spi_start_read_blocks (void *dest, uint16_t nb_block)
	Start a read blocks transfer on the line Note: The driver will use the DMA available to speed up the transfer. More...

bool	sd_mmc_spi_start_write_blocks (const void *src, uint16_t nb_block)
	Start a write blocks transfer on the line Note: The driver will use the DMA available to speed up the transfer. More...

bool	sd_mmc_spi_wait_end_of_read_blocks (void)
	Wait the end of transfer initiated by mci_start_read_blocks() More...

bool	sd_mmc_spi_wait_end_of_write_blocks (void)
	Wait the end of transfer initiated by mci_start_write_blocks() More...

bool	sd_mmc_spi_write_word (uint32_t value)
	Write a word on the line. More...

Return error codes
#define	SD_MMC_SPI_NO_ERR 0

#define	SD_MMC_SPI_ERR 1

#define	SD_MMC_SPI_ERR_RESP_TIMEOUT 2

#define	SD_MMC_SPI_ERR_RESP_BUSY_TIMEOUT 3

#define	SD_MMC_SPI_ERR_READ_TIMEOUT 4

#define	SD_MMC_SPI_ERR_WRITE_TIMEOUT 5

#define	SD_MMC_SPI_ERR_RESP_CRC 6

#define	SD_MMC_SPI_ERR_READ_CRC 7

#define	SD_MMC_SPI_ERR_WRITE_CRC 8

#define	SD_MMC_SPI_ERR_ILLEGAL_COMMAND 9

#define	SD_MMC_SPI_ERR_WRITE 10

#define	SD_MMC_SPI_ERR_OUT_OF_RANGE 11

#define SD_MMC_SPI_ERR 1

Referenced by sd_mmc_spi_adtc_start(), and sd_mmc_spi_stop_write_block().

#define SD_MMC_SPI_ERR_ILLEGAL_COMMAND 9

Referenced by sd_mmc_spi_adtc_start().

#define SD_MMC_SPI_ERR_OUT_OF_RANGE 11

Referenced by sd_mmc_spi_start_read_block().

#define SD_MMC_SPI_ERR_READ_CRC 7

Referenced by sd_mmc_spi_start_read_block().

#define SD_MMC_SPI_ERR_READ_TIMEOUT 4

Referenced by sd_mmc_spi_start_read_block().

#define SD_MMC_SPI_ERR_RESP_BUSY_TIMEOUT 3

Referenced by sd_mmc_spi_adtc_start().

#define SD_MMC_SPI_ERR_RESP_CRC 6

Referenced by sd_mmc_spi_adtc_start().

#define SD_MMC_SPI_ERR_RESP_TIMEOUT 2

Referenced by sd_mmc_spi_adtc_start().

#define SD_MMC_SPI_ERR_WRITE 10

Referenced by sd_mmc_spi_stop_write_block().

#define SD_MMC_SPI_ERR_WRITE_CRC 8

Referenced by sd_mmc_spi_stop_write_block().

#define SD_MMC_SPI_ERR_WRITE_TIMEOUT 5

Referenced by sd_mmc_spi_start_write_blocks(), sd_mmc_spi_stop_multiwrite_block(), sd_mmc_spi_wait_end_of_write_blocks(), and sd_mmc_spi_write_word().

#define SD_MMC_SPI_NO_ERR 0

Referenced by sd_mmc_spi_adtc_start(), sd_mmc_spi_deselect_device(), sd_mmc_spi_init(), sd_mmc_spi_read_word(), sd_mmc_spi_select_device(), sd_mmc_spi_send_clock(), sd_mmc_spi_start_read_blocks(), sd_mmc_spi_start_write_blocks(), and sd_mmc_spi_write_word().

typedef uint8_t sd_mmc_spi_errno_t

Type of return error code.

bool sd_mmc_spi_adtc_start	(	sdmmc_cmd_def_t	cmd,
		uint32_t	arg,
		uint16_t	block_size,
		uint16_t	nb_block,
		bool	access_block
	)

Send a adtc command on the selected slot A adtc command is used for read/write access.

Parameters

cmd	Command definition
arg	Argument of the command
block_size	Block size used for the transfer
nb_block	Total number of block for this transfer
access_block	if true, the x_read_blocks() and x_write_blocks() functions must be used after this function. If false, the mci_read_word() and mci_write_word() functions must be used after this function.

Returns: true if success, otherwise false

R1 response

References Assert, be32_to_cpu, le32_to_cpu, R1_SPI_COM_CRC, R1_SPI_ERROR, R1_SPI_IDLE, R1_SPI_ILLEGAL_COMMAND, sd_mmc_master, sd_mmc_spi_block_size, sd_mmc_spi_crc7(), sd_mmc_spi_debug, SD_MMC_SPI_ERR, sd_mmc_spi_err, SD_MMC_SPI_ERR_ILLEGAL_COMMAND, SD_MMC_SPI_ERR_RESP_BUSY_TIMEOUT, SD_MMC_SPI_ERR_RESP_CRC, SD_MMC_SPI_ERR_RESP_TIMEOUT, sd_mmc_spi_nb_block, SD_MMC_SPI_NO_ERR, sd_mmc_spi_response_32, sd_mmc_spi_transfert_pos, sd_mmc_spi_wait_busy(), SDMMC_CMD_GET_INDEX, SDMMC_RESP_32, SDMMC_RESP_8, SDMMC_RESP_BUSY, SDMMC_RESP_PRESENT, SPI_CMD_ENCODE, spi_read_buffer_wait(), spi_write_buffer_wait(), and UNUSED.

Referenced by sd_mmc_spi_send_cmd().

bool sd_mmc_spi_adtc_stop	(	sdmmc_cmd_def_t	cmd,
		uint32_t	arg
	)

Send a command to stop a adtc command on the selected slot.

Parameters

cmd	Command definition
arg	Argument of the command

Returns: true if success, otherwise false

void sd_mmc_spi_deselect_device ( uint8_t slot )

Deselect a slot.

Parameters

slot	Selected slot

References sd_mmc_master, sd_mmc_spi_devices, sd_mmc_spi_err, SD_MMC_SPI_NO_ERR, and spi_select_slave().

static __inline__ uint8_t sd_mmc_spi_get_bus_width ( uint8_t slot )

static

Return the maximum bus width of a slot.

Parameters

slot	Selected slot

Returns: 1, 4 or 8 lines.

References UNUSED.

sd_mmc_spi_errno_t sd_mmc_spi_get_errno ( void )

Return the error code of last function.

Returns: error code

References sd_mmc_spi_err.

uint32_t sd_mmc_spi_get_response ( void )

Return the 32 bits response of the last command.

Returns: 32 bits response

References sd_mmc_spi_response_32.

static __inline__ void sd_mmc_spi_get_response_128 ( uint8_t * resp )

static

References UNUSED.

void sd_mmc_spi_init ( void )

Initializes the low level driver.

This enable the clock required and the hardware interface.

References spi_master_config::baudrate, port_config::direction, spi_config::generator_source, port_config::input_pull, spi_config::master, spi_config::mode_specific, spi_config::mux_setting, spi_config::pinmux_pad0, spi_config::pinmux_pad1, spi_config::pinmux_pad2, spi_config::pinmux_pad3, port_get_config_defaults(), PORT_PIN_DIR_INPUT, PORT_PIN_PULL_UP, port_pin_set_config(), SD_MMC_0_CD_GPIO, sd_mmc_master, SD_MMC_SPI, sd_mmc_spi_devices, sd_mmc_spi_err, SD_MMC_SPI_NO_ERR, SD_MMC_SPI_PINMUX_PAD0, SD_MMC_SPI_PINMUX_PAD1, SD_MMC_SPI_PINMUX_PAD2, SD_MMC_SPI_PINMUX_PAD3, SD_MMC_SPI_PINMUX_SETTING, SD_MMC_SPI_SOURCE_CLOCK, SDMMC_CLOCK_INIT, slave_configs, spi_attach_slave(), spi_enable(), spi_get_config_defaults(), spi_init(), spi_slave_inst_get_config_defaults(), spi_slave_inst_config::ss_pin, and ss_pins.

static __inline__ bool sd_mmc_spi_is_high_speed_capable ( void )

static

Return the high speed capability of the driver.

Returns: true, if the high speed is supported

bool sd_mmc_spi_read_word ( uint32_t * value )

Read a word on the line.

Parameters

value Pointer on a word to fill

Returns: true if success, otherwise false

References Assert, le32_to_cpu, sd_mmc_master, sd_mmc_spi_block_size, sd_mmc_spi_err, sd_mmc_spi_nb_block, SD_MMC_SPI_NO_ERR, sd_mmc_spi_start_read_block(), sd_mmc_spi_stop_read_block(), sd_mmc_spi_transfert_pos, and spi_read_buffer_wait().

void sd_mmc_spi_select_device	(	uint8_t	slot,
		uint32_t	clock,
		uint8_t	bus_width,
		bool	high_speed
	)

Select a slot and initialize it.

Parameters

slot	Selected slot
clock	Maximum clock to use (Hz)
bus_width	Bus width to use (1, 4 or 8)
high_speed	true, to enable high speed mode

References sd_mmc_master, sd_mmc_spi_devices, sd_mmc_spi_err, SD_MMC_SPI_MAX_CLOCK, SD_MMC_SPI_NO_ERR, spi_select_slave(), spi_set_baudrate(), STATUS_ERR_INVALID_ARG, and UNUSED.

void sd_mmc_spi_send_clock ( void )

Send 74 clock cycles on the line of selected slot Note: It is required after card plug and before card install.

Send 80 cycles

References sd_mmc_master, sd_mmc_spi_err, SD_MMC_SPI_NO_ERR, and spi_write_buffer_wait().

bool sd_mmc_spi_send_cmd	(	sdmmc_cmd_def_t	cmd,
		uint32_t	arg
	)

Send a command on the selected slot.

Parameters

cmd	Command definition
arg	Argument of the command

Returns: true if success, otherwise false

References sd_mmc_spi_adtc_start().

bool sd_mmc_spi_start_read_blocks	(	void *	dest,
		uint16_t	nb_block
	)

Start a read blocks transfer on the line Note: The driver will use the DMA available to speed up the transfer.

Parameters

dest	Pointer on the buffer to fill
nb_block	Number of block to transfer

Returns: true if started, otherwise false

References Assert, sd_mmc_master, sd_mmc_spi_block_size, sd_mmc_spi_err, sd_mmc_spi_nb_block, SD_MMC_SPI_NO_ERR, sd_mmc_spi_start_read_block(), sd_mmc_spi_stop_read_block(), sd_mmc_spi_transfert_pos, and spi_read_buffer_wait().

bool sd_mmc_spi_start_write_blocks	(	const void *	src,
		uint16_t	nb_block
	)

Start a write blocks transfer on the line Note: The driver will use the DMA available to speed up the transfer.

Parameters

src	Pointer on the buffer to send
nb_block	Number of block to transfer

Returns: true if started, otherwise false

References Assert, sd_mmc_master, sd_mmc_spi_block_size, sd_mmc_spi_debug, sd_mmc_spi_err, SD_MMC_SPI_ERR_WRITE_TIMEOUT, sd_mmc_spi_nb_block, SD_MMC_SPI_NO_ERR, sd_mmc_spi_start_write_block(), sd_mmc_spi_stop_write_block(), sd_mmc_spi_transfert_pos, sd_mmc_spi_wait_busy(), and spi_write_buffer_wait().

bool sd_mmc_spi_wait_end_of_read_blocks ( void )

Wait the end of transfer initiated by mci_start_read_blocks()

Returns: true if success, otherwise false

bool sd_mmc_spi_wait_end_of_write_blocks ( void )

Wait the end of transfer initiated by mci_start_write_blocks()

Returns: true if success, otherwise false

References sd_mmc_spi_debug, sd_mmc_spi_err, SD_MMC_SPI_ERR_WRITE_TIMEOUT, sd_mmc_spi_stop_multiwrite_block(), and sd_mmc_spi_wait_busy().

bool sd_mmc_spi_write_word ( uint32_t value )

Write a word on the line.

Parameters

value Word to send

Returns: true if success, otherwise false

References Assert, cpu_to_le32, sd_mmc_master, sd_mmc_spi_block_size, sd_mmc_spi_debug, sd_mmc_spi_err, SD_MMC_SPI_ERR_WRITE_TIMEOUT, sd_mmc_spi_nb_block, SD_MMC_SPI_NO_ERR, sd_mmc_spi_start_write_block(), sd_mmc_spi_stop_multiwrite_block(), sd_mmc_spi_stop_write_block(), sd_mmc_spi_transfert_pos, sd_mmc_spi_wait_busy(), and spi_write_buffer_wait().

Microchip® Advanced Software Framework

Modules

Typedefs

Functions

Return error codes