Keuronde/LogEtComUSB
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
e2d49bac4f
LogEtComUSB/lib/sd_driver/SPI/sd_card_spi.c

1732 lines
65 KiB
C
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/**
* @file sd_card_spi.c
* @brief SD Card SPI Driver
*
* @section License
*
* Copyright 2021 Carl John Kugler III
*
* Licensed under the Apache License, Version 2.0 (the License); you may not use
* this file except in compliance with the License. You may obtain a copy of the
* License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed
* under the License is distributed on an AS IS BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
*/
/*
* This code borrows heavily from the Mbed SDBlockDevice:
* https://os.mbed.com/docs/mbed-os/v5.15/apis/sdblockdevice.html
* mbed-os/components/storage/blockdevice/COMPONENT_SD/SDBlockDevice.cpp
*
* Editor: Carl Kugler (carlk3@gmail.com)
*
* Remember your ABCs: "Always Be Cobbling!"
*/
/* mbed Microcontroller Library
* Copyright (c) 2006-2013 ARM Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/* Introduction
* ------------
* SD and MMC cards support a number of interfaces, but common to them all
* is one based on SPI. Since we already have the mbed SPI Interface, it will
* be used for SD cards.
*
* The main reference I'm using is Chapter 7, "SPI Mode" of:
* http://www.sdcard.org/developers/tech/sdcard/pls/Simplified_Physical_Layer_Spec.pdf
*
* SPI Startup
* -----------
* The SD card powers up in SD mode. The start-up procedure is complicated
* by the requirement to support older SDCards in a backwards compatible
* way with the new higher capacity variants SDHC and SDHC.
*
* The following figures from the specification with associated text describe
* the SPI mode initialisation process:
* - Figure 7-1: SD Memory Card State Diagram (SPI mode)
* - Figure 7-2: SPI Mode Initialization Flow
*
* Firstly, a low initial clock should be selected (in the range of 100-
* 400kHZ). After initialisation has been completed, the switch to a
* higher clock speed can be made (e.g. 1MHz). Newer cards will support
* higher speeds than the default _transfer_sck defined here.
*
* Next, note the following from the SDCard specification (note to
* Figure 7-1):
*
* In any of the cases CMD1 is not recommended because it may be difficult for
* the host to distinguish between MultiMediaCard and SD Memory Card
*
* Hence CMD1 is not used for the initialisation sequence.
*
* The SPI interface mode is selected by asserting CS low and sending the
* reset command (CMD0). The card will respond with a (R1) response.
* In practice many cards initially respond with 0xff or invalid data
* which is ignored. Data is read until a valid response is received
* or the number of re-reads has exceeded a maximim count. If a valid
* response is not received then the CMD0 can be retried. This
* has been found to successfully initialise cards where the SPI master
* (on MCU) has been reset but the SDCard has not, so the first
* CMD0 may be lost.
*
* CMD8 is optionally sent to determine the voltage range supported, and
* indirectly determine whether it is a version 1.x SD/non-SD card or
* version 2.x. I'll just ignore this for now.
*
* ACMD41 is repeatedly issued to initialise the card, until "in idle"
* (bit 0) of the R1 response goes to '0', indicating it is initialised.
*
* You should also indicate whether the host supports High Capicity cards,
* and check whether the card is high capacity - i'll also ignore this.
*
* SPI Protocol
* ------------
* The SD SPI protocol is based on transactions made up of 8-bit words, with
* the host starting every bus transaction by asserting the CS signal low. The
* card always responds to commands, data blocks and errors.
*
* The protocol supports a CRC, but by default it is off (except for the
* first reset CMD0, where the CRC can just be pre-calculated, and CMD8)
* I'll leave the CRC off I think!
*
* Standard capacity cards have variable data block sizes, whereas High
* Capacity cards fix the size of data block to 512 bytes. I'll therefore
* just always use the Standard Capacity cards with a block size of 512 bytes.
* This is set with CMD16.
*
* You can read and write single blocks (CMD17, CMD25) or multiple blocks
* (CMD18, CMD25). For simplicity, I'll just use single block accesses. When
* the card gets a read command, it responds with a response token, and then
* a data token or an error.
*
* SPI Command Format
* ------------------
* Commands are 6-bytes long, containing the command, 32-bit argument, and CRC.
*
* +---------------+------------+------------+-----------+----------+--------------+
* | 01 | cmd[5:0] | arg[31:24] | arg[23:16] | arg[15:8] | arg[7:0] | crc[6:0] |
* 1 |
* +---------------+------------+------------+-----------+----------+--------------+
*
* As I'm not using CRC, I can fix that byte to what is needed for CMD0 (0x95)
*
* All Application Specific commands shall be preceded with APP_CMD (CMD55).
*
* SPI Response Format
* -------------------
* The main response format (R1) is a status byte (normally zero). Key flags:
* idle - 1 if the card is in an idle state/initialising
* cmd - 1 if an illegal command code was detected
*
* +-------------------------------------------------+
* R1 | 0 | arg | addr | seq | crc | cmd | erase | idle |
* +-------------------------------------------------+
*
* R1b is the same, except it is followed by a busy signal (zeros) until
* the first non-zero byte when it is ready again.
*
* Data Response Token
* -------------------
* Every data block written to the card is acknowledged by a byte
* response token
*
* +----------------------+
* | xxx | 0 | status | 1 |
* +----------------------+
* 010 - OK!
* 101 - CRC Error
* 110 - Write Error
*
* Single Block Read and Write
* ---------------------------
*
* Block transfers have a byte header, followed by the data, followed
* by a 16-bit CRC. In our case, the data will always be 512 bytes.
*
* +------+---------+---------+- - - -+---------+-----------+----------+
* | 0xFE | data[0] | data[1] | | data[n] | crc[15:8] | crc[7:0] |
* +------+---------+---------+- - - -+---------+-----------+----------+
*/
/* Standard includes. */
#include <inttypes.h>
#include <stdio.h>
#include <string.h>
#include <stdarg.h>
//
#include "crc.h"
#include "diskio.h" /* Declarations of disk functions */ // Needed for STA_NOINIT, ...
#include "hw_config.h" // Hardware Configuration of the SPI and SD Card "objects"
#include "my_debug.h"
#include "delays.h"
#include "sd_card.h"
#include "sd_card_constants.h"
#include "sd_spi.h"
#include "sd_timeouts.h"
#include "util.h"
//
#include "sd_card_spi.h"
#if defined(NDEBUG) || !USE_DBG_PRINTF
# pragma GCC diagnostic ignored "-Wunused-function"
# pragma GCC diagnostic ignored "-Wunused-variable"
# pragma GCC diagnostic ignored "-Wunused-parameter"
#endif
#ifndef TRACE
# define TRACE 0
#endif
#ifndef SD_CRC_ENABLED
#define SD_CRC_ENABLED 1
#endif
#if SD_CRC_ENABLED
static bool crc_on = true;
#else
static bool crc_on = false;
#endif
#define TRACE_PRINTF(fmt, args...)
//#define TRACE_PRINTF DBG_PRINTF
/**
* @brief Control Tokens
*/
typedef enum {
SPI_DATA_RESPONSE_MASK = 0x1F,
SPI_DATA_ACCEPTED = 0x05,
SPI_DATA_CRC_ERROR = 0x0B,
SPI_DATA_WRITE_ERROR = 0x0D,
SPI_START_BLOCK = 0xFE,
SPI_START_BLK_MUL_WRITE = 0xFC,
SPI_STOP_TRAN = 0xFD,
} spi_control_t;
/**
* @brief Data Error Token Mask
*/
typedef enum {
SPI_DATA_READ_ERROR_MASK = 0xF,
} spi_data_read_error_mask_t;
/**
* @brief Data Error Token Flags
*/
typedef enum {
SPI_READ_ERROR = 0x1 << 0,
SPI_READ_ERROR_CC = 0x1 << 1,
SPI_READ_ERROR_ECC_C = 0x1 << 2,
SPI_READ_ERROR_OFR = 0x1 << 3,
} spi_data_read_error_t;
/**
* @brief R1 Response Format
*/
typedef enum {
R1_NO_RESPONSE = 0xFF,
R1_RESPONSE_RECV = 0x80,
R1_IDLE_STATE = 1 << 0,
R1_ERASE_RESET = 1 << 1,
R1_ILLEGAL_COMMAND = 1 << 2,
R1_COM_CRC_ERROR = 1 << 3,
R1_ERASE_SEQUENCE_ERROR = 1 << 4,
R1_ADDRESS_ERROR = 1 << 5,
R1_PARAMETER_ERROR = 1 << 6,
} spi_r1_response_t;
/* SIZE in Bytes */
#define PACKET_SIZE 6 /*!< SD Packet size CMD+ARG+CRC */
/**
* @brief OCR Register Flags
*/
typedef enum {
OCR_HCS_CCS = 0x1 << 30,
OCR_LOW_VOLTAGE = 0x01 << 24,
OCR_3_3V = 0x1 << 20,
} spi_ocr_register_t;
/**
* @brief Control Command
*
* @param x Command
*/
#define SPI_CMD(x) (0x40 | (x & 0x3f))
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wswitch-enum"
/**
* @brief Send a command over SPI interface
*
* @param sd_card_p Pointer to the sd card structure
* @param cmd Command to send
* @param arg Argument to send with the command
*
* @return The response from the card
*
* @details
* This function sends a command over the SPI interface and waits for the
* response. The command is prepared by setting the correct bits in the packet
* and calculating the CRC if necessary. The command is then sent and the
* response is received and returned.
*
* @note
* For CMD12_STOP_TRANSMISSION, the first byte received is a stuff byte and
* should be discarded.
*/
static uint8_t sd_cmd_spi(sd_card_t *sd_card_p, cmdSupported cmd, uint32_t arg) {
uint8_t cmd_packet[PACKET_SIZE] = {
SPI_CMD(cmd),
(arg >> 24),
(arg >> 16),
(arg >> 8),
(arg >> 0),
};
if (crc_on) {
cmd_packet[5] = (crc7(cmd_packet, 5) << 1) | 0x01;
} else {
// CMD0 is executed in SD mode, hence should have correct CRC
// CMD8 CRC verification is always enabled
switch (cmd) {
case CMD0_GO_IDLE_STATE:
cmd_packet[5] = 0x95;
break;
case CMD8_SEND_IF_COND:
cmd_packet[5] = 0x87;
break;
default:
// Make sure bit 0-End bit is high
cmd_packet[5] = 0xFF;
break;
}
}
// send a command
for (size_t i = 0; i < PACKET_SIZE; i++) {
sd_spi_write(sd_card_p, cmd_packet[i]);
}
// The received byte immediately following CMD12 is a stuff byte,
// it should be discarded before receive the response of the CMD12.
if (CMD12_STOP_TRANSMISSION == cmd) {
sd_spi_write(sd_card_p, SPI_FILL_CHAR);
}
// Loop for response: Response is sent back within command response time
// (NCR), 0 to 8 bytes for SDC
uint8_t response;
for (size_t i = 0; i < 0x10; i++) {
response = sd_spi_read(sd_card_p);
// Got the response
if (!(response & R1_RESPONSE_RECV)) {
break;
}
}
return response;
}
#pragma GCC diagnostic pop
/**
* @brief Wait for the SD card to be ready for the next command.
*
* Sends dummy clocks with DI held high until the card releases the DO line.
*
* @param sd_card_p Pointer to the sd_card_t struct.
* @param timeout The maximum time to wait for the card to become ready.
*
* @return true if the card is ready, false otherwise.
*/
static bool sd_wait_ready(sd_card_t *sd_card_p, uint32_t timeout) {
char resp;
// Keep sending dummy clocks with DI held high until the card releases the
// DO line
uint32_t start = millis();
do {
resp = sd_spi_write_read(sd_card_p, 0xFF);
} while (resp != 0xFF && millis() - start < timeout);
/* Checking for 0xFF provides a little extra margin to
make sure that DO has gone high and stayed there.
(the alternative is to accept the first non-zero byte) */
if (resp != 0xFF) DBG_PRINTF("%s failed\n", __FUNCTION__);
// Return success/failure
return (0xFF == resp);
}
/* Locks the SD card and acquires its SPI
Potential optimization: the SPI could be locked separately,
so if there are multiple SD cards on one SPI,
another SD card could use the SPI during any gaps
in the first SD card's utilization.
However, these gaps are generally small.
*/
static void sd_acquire(sd_card_t *sd_card_p) {
sd_lock(sd_card_p);
sd_spi_acquire(sd_card_p);
}
static void sd_release(sd_card_t *sd_card_p) {
sd_spi_release(sd_card_p);
sd_unlock(sd_card_p);
}
#if TRACE
static const char *cmd2str(const cmdSupported cmd) {
switch (cmd) {
default:
return "CMD_NOT_SUPPORTED";
case CMD0_GO_IDLE_STATE:
return "CMD0_GO_IDLE_STATE";
case CMD1_SEND_OP_COND:
return "CMD1_SEND_OP_COND";
case CMD6_SWITCH_FUNC:
return "CMD6_SWITCH_FUNC";
case CMD8_SEND_IF_COND:
return "CMD8_SEND_IF_COND";
case CMD9_SEND_CSD:
return "CMD9_SEND_CSD";
case CMD10_SEND_CID:
return "CMD10_SEND_CID";
case CMD12_STOP_TRANSMISSION:
return "CMD12_STOP_TRANSMISSION";
case CMD13_SEND_STATUS:
return "CMD13_SEND_STATUS or ACMD6_SET_BUS_WIDTH or "
"ACMD13_SD_STATUS";
case CMD16_SET_BLOCKLEN:
return "CMD16_SET_BLOCKLEN";
case CMD17_READ_SINGLE_BLOCK:
return "CMD17_READ_SINGLE_BLOCK";
case CMD18_READ_MULTIPLE_BLOCK:
return "CMD18_READ_MULTIPLE_BLOCK";
case CMD24_WRITE_BLOCK:
return "CMD24_WRITE_BLOCK";
case CMD25_WRITE_MULTIPLE_BLOCK:
return "CMD25_WRITE_MULTIPLE_BLOCK";
case CMD27_PROGRAM_CSD:
return "CMD27_PROGRAM_CSD";
case CMD32_ERASE_WR_BLK_START_ADDR:
return "CMD32_ERASE_WR_BLK_START_ADDR";
case CMD33_ERASE_WR_BLK_END_ADDR:
return "CMD33_ERASE_WR_BLK_END_ADDR";
case CMD38_ERASE:
return "CMD38_ERASE";
case CMD55_APP_CMD:
return "CMD55_APP_CMD";
case CMD56_GEN_CMD:
return "CMD56_GEN_CMD";
case CMD58_READ_OCR:
return "CMD58_READ_OCR";
case CMD59_CRC_ON_OFF:
return "CMD59_CRC_ON_OFF";
// case ACMD6_SET_BUS_WIDTH:
// case ACMD13_SD_STATUS:
case ACMD22_SEND_NUM_WR_BLOCKS:
return "ACMD22_SEND_NUM_WR_BLOCKS";
case ACMD23_SET_WR_BLK_ERASE_COUNT:
return "ACMD23_SET_WR_BLK_ERASE_COUNT";
case ACMD41_SD_SEND_OP_COND:
return "ACMD41_SD_SEND_OP_COND";
case ACMD42_SET_CLR_CARD_DETECT:
return "ACMD42_SET_CLR_CARD_DETECT";
case ACMD51_SEND_SCR:
return "ACMD51_SEND_SCR";
}
}
#endif
/**
* @brief Check the response of the card status command (CMD13) and set
* the status bit accordingly.
*
* @param response The response of the card status command (CMD13).
*
* @return The status of the SD card.
*/
static int chk_CMD13_response(uint32_t response) {
int32_t status = 0;
DBG_PRINTF("Card Status: R2: 0x%" PRIx32 "\n", response);
if (response & 0x01 << 0) {
DBG_PRINTF("Card is Locked\n");
status |= SD_BLOCK_DEVICE_ERROR_WRITE;
}
if (response & 0x01 << 1) {
DBG_PRINTF("WP Erase Skip, Lock/Unlock Cmd Failed\n");
status |= SD_BLOCK_DEVICE_ERROR_WRITE_PROTECTED;
}
if (response & 0x01 << 2) {
DBG_PRINTF("Error\n");
status |= SD_BLOCK_DEVICE_ERROR_WRITE;
}
if (response & 0x01 << 3) {
DBG_PRINTF("CC Error\n");
status |= SD_BLOCK_DEVICE_ERROR_WRITE;
}
if (response & 0x01 << 4) {
DBG_PRINTF("Card ECC Failed\n");
status |= SD_BLOCK_DEVICE_ERROR_WRITE;
}
if (response & 0x01 << 5) {
DBG_PRINTF("WP Violation\n");
status |= SD_BLOCK_DEVICE_ERROR_WRITE_PROTECTED;
}
if (response & 0x01 << 6) {
DBG_PRINTF("Erase Param\n");
status |= SD_BLOCK_DEVICE_ERROR_ERASE;
}
if (response & 0x01 << 7) {
DBG_PRINTF("Out of Range, CSD_Overwrite\n");
status |= SD_BLOCK_DEVICE_ERROR_PARAMETER;
}
if (response & 0x01 << 8) {
DBG_PRINTF("In Idle State\n");
status |= SD_BLOCK_DEVICE_ERROR_NONE;
}
if (response & 0x01 << 9) {
DBG_PRINTF("Erase Reset\n");
status |= SD_BLOCK_DEVICE_ERROR_ERASE;
}
if (response & 0x01 << 10) {
DBG_PRINTF("Illegal Command\n");
status |= SD_BLOCK_DEVICE_ERROR_UNSUPPORTED;
}
if (response & 0x01 << 11) {
DBG_PRINTF("Com CRC Error\n");
status |= SD_BLOCK_DEVICE_ERROR_CRC;
}
if (response & 0x01 << 12) {
DBG_PRINTF("Erase Sequence Error\n");
status |= SD_BLOCK_DEVICE_ERROR_ERASE;
}
if (response & 0x01 << 13) {
DBG_PRINTF("Address Error\n");
status |= SD_BLOCK_DEVICE_ERROR_PARAMETER;
}
if (response & 0x01 << 14) {
DBG_PRINTF("Parameter Error\n");
status |= SD_BLOCK_DEVICE_ERROR_PARAMETER;
}
return status;
}
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wswitch-enum"
/**
* @brief Send a command to the SD card.
* @param sd_card_p pointer to sd_card_t structure
* @param cmd command to send
* @param arg argument for the command
* @param isAcmd true if this is an application command
* @param resp pointer to a uint32_t to save the response
* @return error code
*
* This function sends a command to the SD card and waits for the response.
* It will retry the command up to sd_timeouts.sd_command_retries times if there is no response.
* The response is stored in the @p resp variable if it is not NULL.
* The function will return SD_BLOCK_DEVICE_ERROR_NONE if the command was successful,
* SD_BLOCK_DEVICE_ERROR_NO_RESPONSE if there was no response,
* SD_BLOCK_DEVICE_ERROR_CRC if there was a CRC error,
* SD_BLOCK_DEVICE_ERROR_UNSUPPORTED if the command was not supported,
* SD_BLOCK_DEVICE_ERROR_PARAMETER if there was a parameter error,
* SD_BLOCK_DEVICE_ERROR_ERASE if there was an erase error.
*/
static block_dev_err_t sd_cmd(sd_card_t *sd_card_p, const cmdSupported cmd, uint32_t arg,
bool isAcmd, uint32_t *resp) {
// TRACE_PRINTF("%s(%s(0x%08lx)): ", __FUNCTION__, cmd2str(cmd), arg);
myASSERT(sd_is_locked(sd_card_p));
myASSERT(0 == gpio_get(sd_card_p->spi_if_p->ss_gpio));
int32_t status = SD_BLOCK_DEVICE_ERROR_NONE;
uint32_t response = 0;
// No need to wait for card to be ready when sending the stop command
if (CMD12_STOP_TRANSMISSION != cmd && CMD0_GO_IDLE_STATE != cmd) {
if (false == sd_wait_ready(sd_card_p, sd_timeouts.sd_command)) {
DBG_PRINTF("Card not ready yet\n");
return SD_BLOCK_DEVICE_ERROR_NO_RESPONSE;
}
}
for (unsigned i = 0; i < sd_timeouts.sd_command_retries; i++) {
// Send CMD55 for APP command first
if (isAcmd) {
response = sd_cmd_spi(sd_card_p, CMD55_APP_CMD, 0x0);
// Wait for card to be ready after CMD55
if (false == sd_wait_ready(sd_card_p, sd_timeouts.sd_command)) {
DBG_PRINTF("Card not ready yet\n");
}
}
// Send command over SPI interface
response = sd_cmd_spi(sd_card_p, cmd, arg);
if (R1_NO_RESPONSE == response) {
DBG_PRINTF("No response CMD:%d\n", cmd);
// Re-try command
continue;
}
break;
}
// Pass the response to the command call if required
if (NULL != resp) {
*resp = response;
}
// Process the response R1 : Exit on CRC/Illegal command error/No response
if (R1_NO_RESPONSE == response) {
DBG_PRINTF("No response CMD:%d response: 0x%" PRIx32 "\n", cmd, response);
return SD_BLOCK_DEVICE_ERROR_NO_RESPONSE;
}
if (response & R1_COM_CRC_ERROR && ACMD23_SET_WR_BLK_ERASE_COUNT != cmd) {
DBG_PRINTF("CRC error CMD:%d response 0x%" PRIx32 "\n", cmd, response);
return SD_BLOCK_DEVICE_ERROR_CRC; // CRC error
}
if (response & R1_ILLEGAL_COMMAND) {
if (ACMD23_SET_WR_BLK_ERASE_COUNT != cmd)
DBG_PRINTF("Illegal command CMD:%d response 0x%" PRIx32 "\n", cmd, response);
if (CMD8_SEND_IF_COND == cmd) {
// Illegal command is for Ver1 or not SD Card
sd_card_p->state.card_type = CARD_UNKNOWN;
}
return SD_BLOCK_DEVICE_ERROR_UNSUPPORTED; // Command not supported
}
// DBG_PRINTF("CMD:%d \t arg:0x%" PRIx32 " \t Response:0x%" PRIx32 "\n",
// cmd, arg, response);
// Set status for other errors
if ((response & R1_ERASE_RESET) || (response & R1_ERASE_SEQUENCE_ERROR)) {
status = SD_BLOCK_DEVICE_ERROR_ERASE; // Erase error
} else if ((response & R1_ADDRESS_ERROR) || (response & R1_PARAMETER_ERROR)) {
// Misaligned address / invalid address block length
status = SD_BLOCK_DEVICE_ERROR_PARAMETER;
}
// Get rest of the response part for other commands
switch (cmd) {
case CMD8_SEND_IF_COND: // Response R7
DBG_PRINTF("V2-Version Card\n");
sd_card_p->state.card_type = SDCARD_V2; // fallthrough
// Note: No break here, need to read rest of the response
case CMD58_READ_OCR: // Response R3
response = (sd_spi_read(sd_card_p) << 24);
response |= (sd_spi_read(sd_card_p) << 16);
response |= (sd_spi_read(sd_card_p) << 8);
response |= sd_spi_read(sd_card_p);
DBG_PRINTF("R3/R7: 0x%" PRIx32 "\n", response);
break;
case CMD12_STOP_TRANSMISSION: // Response R1b
case CMD38_ERASE:
sd_wait_ready(sd_card_p, sd_timeouts.sd_command);
break;
case CMD13_SEND_STATUS: // Response R2
response <<= 8;
response |= sd_spi_read(sd_card_p);
if (response) status = chk_CMD13_response(response);
default:;
}
// Pass the updated response to the command
if (NULL != resp) {
*resp = response;
}
return status;
}
#pragma GCC diagnostic pop
/* R7 response pattern for CMD8 */
#define CMD8_PATTERN (0xAA)
/**
* @brief Send CMD8 to check if the card supports version 2.0 of the SD spec.
*
* @param sd_card_p Pointer to the SD card information structure.
* @return sd_block_dev_err_t Returns SD_BLOCK_DEVICE_ERROR_NONE if the card
* supports version 2.0 of the SD spec, SD_BLOCK_DEVICE_ERROR_UNSUPPORTED if the
* card does not support version 2.0 of the SD spec, or other error codes as
* defined in sd_block_dev_err_t.
*
* @details CMD8 is sent to check if the card supports version 2.0 of the SD
* spec. The response from the card is checked to see if the card supports
* version 2.0 of the SD spec. If the card does not support version 2.0 of the SD
* spec, the card type is set to CARD_UNKNOWN and the card is considered
* unreadable.
*/
static block_dev_err_t sd_cmd8(sd_card_t *sd_card_p) {
uint32_t arg = (CMD8_PATTERN << 0); // [7:0]check pattern
uint32_t response = 0;
int32_t status = SD_BLOCK_DEVICE_ERROR_NONE;
arg |= (0x1 << 8); // 2.7-3.6V // [11:8]supply voltage(VHS)
status = sd_cmd(sd_card_p, CMD8_SEND_IF_COND, arg, false, &response);
// Verify voltage and pattern for V2 version of card
if ((SD_BLOCK_DEVICE_ERROR_NONE == status) && (SDCARD_V2 == sd_card_p->state.card_type)) {
// If check pattern is not matched, CMD8 communication is not valid
if ((response & 0xFFF) != arg) {
DBG_PRINTF("CMD8 Pattern mismatch 0x%" PRIx32 " : 0x%" PRIx32 "\n", arg, response);
sd_card_p->state.card_type = CARD_UNKNOWN;
status = SD_BLOCK_DEVICE_ERROR_UNUSABLE;
}
}
return status;
}
static block_dev_err_t read_bytes(sd_card_t *sd_card_p, uint8_t *buffer, uint32_t length);
/**
* @brief Get the number of sectors on an SD card.
*
* @param sd_card_p A pointer to the sd_card_t structure for the card.
*
* @return The number of sectors on the card, or 0 if an error occurred.
*
* @details This function sends a CMD9 command to the card to get the Card Specific
* Data (CSD) and then extracts the number of sectors from the CSD.
*/
static uint32_t in_sd_spi_sectors(sd_card_t *sd_card_p) {
// CMD9, Response R2 (R1 byte + 16-byte block read)
if (sd_cmd(sd_card_p, CMD9_SEND_CSD, 0x0, false, 0) != 0x0) {
DBG_PRINTF("Didn't get a response from the disk\n");
return 0;
}
if (read_bytes(sd_card_p, sd_card_p->state.CSD, 16) != 0) {
DBG_PRINTF("Couldn't read CSD response from disk\n");
return 0;
}
return CSD_sectors(sd_card_p->state.CSD);
}
/**
* @brief Get the number of sectors on an SD card.
*
* @param sd_card_p A pointer to the sd_card_t structure for the card.
*
* @return The number of sectors on the card, or 0 if an error occurred.
*
* @details This function gets the number of sectors by first acquiring the card,
* then calling in_sd_spi_sectors to get the number of sectors, and finally
* releasing the card.
*/
uint32_t sd_spi_sectors(sd_card_t *sd_card_p) {
sd_acquire(sd_card_p);
uint32_t sectors = in_sd_spi_sectors(sd_card_p);
sd_release(sd_card_p);
return sectors;
}
/**
* @brief Wait for the card to become ready and send a given token.
*
* @param sd_card_p A pointer to the sd_card_t structure for the card.
* @param token The token to be sent once the card is ready.
*
* @return True if the card became ready and the token was sent, false otherwise.
*
* @details The function waits until the card is ready and then sends the given
* token. If the card doesn't become ready within the timeout period,
* the function returns false.
*/
static bool sd_wait_token(sd_card_t *sd_card_p, uint8_t token) {
//TRACE_PRINTF("%s(0x%02x)\n", __FUNCTION__, token);
uint32_t start = millis();
do {
if (token == sd_spi_read(sd_card_p)) {
return true;
}
} while (millis() - start < sd_timeouts.sd_command);
DBG_PRINTF("sd_wait_token: timeout\n");
return false;
}
static bool chk_crc16(uint8_t *buffer, size_t length, uint16_t crc) {
if (crc_on) {
uint16_t crc_result;
// Compute and verify checksum
crc_result = crc16(buffer, length);
if (crc_result != crc)
DBG_PRINTF("%s: Invalid CRC received: 0x%" PRIx16 " computed: 0x%" PRIx16 "\n",
__func__, crc, crc_result);
return (crc_result == crc);
}
return true;
}
#define SPI_START_BLOCK (0xFE) /* For Single Block Read/Write and Multiple Block Read */
static block_dev_err_t stop_wr_tran(sd_card_t *sd_card_p);
static block_dev_err_t read_bytes(sd_card_t *sd_card_p, uint8_t *buffer, uint32_t length) {
uint16_t crc;
// read until start byte (0xFE)
if (false == sd_wait_token(sd_card_p, SPI_START_BLOCK)) {
DBG_PRINTF("%s:%d Read timeout\n", __func__, __LINE__);
return SD_BLOCK_DEVICE_ERROR_NO_RESPONSE;
}
bool ok = sd_spi_transfer(sd_card_p, NULL, buffer, length);
if (!ok) return SD_BLOCK_DEVICE_ERROR_NO_RESPONSE;
// Read the CRC16 checksum for the data block
crc = (sd_spi_read(sd_card_p) << 8);
crc |= sd_spi_read(sd_card_p);
if (!chk_crc16(buffer, length, crc)) {
DBG_PRINTF("%s: Invalid CRC received: 0x%" PRIx16 "\n", __func__, crc);
return SD_BLOCK_DEVICE_ERROR_CRC;
}
return 0;
}
/**
* @brief Read a block of data from the SD card.
*
* @param sd_card_p pointer to sd_card_t structure
* @param buffer pointer to the buffer to store the data
* @param data_address the address of the block to read
* @param num_rd_blks the number of blocks to read
*
* @return error code
*
* @details
* This function checks if the SD card is initialized and has a valid disk,
* and if the number of blocks to read is not zero and is within the range of
* the card's sectors. If not, it returns SD_BLOCK_DEVICE_ERROR_PARAMETER.
* If there is an ongoing write transmission, it stops it.
* It then sends a command to receive data based on
* the number of blocks to read. It reads the data from the SD card and checks
* the CRC16 checksum for each block. If the two match, the function continues
* to the next block. If the number of blocks to read is greater than 1, it
* sends CMD12 to stop the transmission after all blocks have been
* read. It then checks the CRC16 checksum for the last block and returns the
* error code.
*/
static block_dev_err_t in_sd_read_blocks(sd_card_t *sd_card_p, uint8_t *buffer,
const uint32_t data_address,
const uint32_t num_rd_blks) {
if (sd_card_p->state.m_Status & (STA_NOINIT | STA_NODISK))
return SD_BLOCK_DEVICE_ERROR_PARAMETER;
if (!num_rd_blks) return SD_BLOCK_DEVICE_ERROR_PARAMETER;
if (data_address + num_rd_blks > sd_card_p->state.sectors)
return SD_BLOCK_DEVICE_ERROR_PARAMETER;
block_dev_err_t status = SD_BLOCK_DEVICE_ERROR_NONE;
// Stop any ongoing write transmission
if (sd_card_p->spi_if_p->state.ongoing_mlt_blk_wrt) {
status = stop_wr_tran(sd_card_p);
if (SD_BLOCK_DEVICE_ERROR_NONE != status) return status;
}
// Send command to receive data
if (num_rd_blks == 1)
status = sd_cmd(sd_card_p, CMD17_READ_SINGLE_BLOCK, data_address, false, 0);
else
status = sd_cmd(sd_card_p, CMD18_READ_MULTIPLE_BLOCK, data_address, false, 0);
if (SD_BLOCK_DEVICE_ERROR_NONE != status) return status;
/* Optimization:
While the DMA is busy transfering the block data,
use the some of the wait time to check the CRC
for the previous block.
*/
uint16_t prev_block_crc = 0;
uint8_t *prev_buffer_addr = 0;
uint32_t blk_cnt = num_rd_blks;
// receive the data : one block at a time
while (blk_cnt) {
// read until start byte (0xFE)
if (!sd_wait_token(sd_card_p, SPI_START_BLOCK)) {
DBG_PRINTF("%s:%d Read timeout\n", __func__, __LINE__);
return SD_BLOCK_DEVICE_ERROR_NO_RESPONSE;
}
// read data
sd_spi_transfer_start(sd_card_p, NULL, buffer, sd_block_size);
// Check the CRC16 checksum for the previous data block
if (prev_buffer_addr) {
// Check previous block's CRC:
if (!chk_crc16(prev_buffer_addr, sd_block_size, prev_block_crc)) {
DBG_PRINTF("%s: Invalid CRC received: 0x%" PRIx16 "\n", __func__,
prev_block_crc);
return SD_BLOCK_DEVICE_ERROR_CRC;
}
}
uint32_t timeout = calculate_transfer_time_ms(sd_card_p->spi_if_p->spi, sd_block_size);
bool ok = sd_spi_transfer_wait_complete(sd_card_p, timeout);
if (!ok) return SD_BLOCK_DEVICE_ERROR_NO_RESPONSE;
// Read the CRC16 checksum for the data block
prev_block_crc = sd_spi_read(sd_card_p) << 8;
prev_block_crc |= sd_spi_read(sd_card_p);
prev_buffer_addr = buffer;
buffer += sd_block_size;
--blk_cnt;
}
if (num_rd_blks > 1) {
// Send CMD12(0x00000000) to stop the transmission for multi-block transfer
status = sd_cmd(sd_card_p, CMD12_STOP_TRANSMISSION, 0x0, false, 0);
if (SD_BLOCK_DEVICE_ERROR_NONE != status) return status;
}
// Check final block's CRC:
if (!chk_crc16(prev_buffer_addr, sd_block_size, prev_block_crc)) {
DBG_PRINTF("%s: Invalid CRC received: 0x%" PRIx16 "\n", __func__, prev_block_crc);
return SD_BLOCK_DEVICE_ERROR_CRC;
}
return status;
}
static block_dev_err_t sd_read_blocks(sd_card_t *sd_card_p, uint8_t *buffer,
uint32_t data_address, uint32_t num_rd_blks) {
TRACE_PRINTF("sd_read_blocks(0x%p, 0x%lx, 0x%lx)\n", buffer, data_address, num_rd_blks);
sd_acquire(sd_card_p);
unsigned retries = sd_timeouts.sd_command_retries;
block_dev_err_t status;
do {
status = in_sd_read_blocks(sd_card_p, buffer, data_address, num_rd_blks);
if (status != SD_BLOCK_DEVICE_ERROR_NONE) {
if (SD_BLOCK_DEVICE_ERROR_NONE !=
sd_cmd(sd_card_p, CMD12_STOP_TRANSMISSION, 0x0, false, 0))
break;
}
} while (--retries && status != SD_BLOCK_DEVICE_ERROR_NONE);
sd_release(sd_card_p);
return status;
}
/**
* @brief Send the numbers of the well written (without errors) blocks.
*
* This function sends the ACMD22 command to the SD card to get the number of
* blocks that were successfully written without errors. It then reads the
* response from the SD card and returns it.
*
* @param sd_card_p Pointer to the SD card object.
* @param num_p Pointer to a variable to store the number of blocks.
*
* @return Block device error code. Returns SD_BLOCK_DEVICE_ERROR_NONE on success,
* SD_BLOCK_DEVICE_ERROR_NO_DEVICE if the SD card is not responding,
* SD_BLOCK_DEVICE_ERROR_CRC if there was a CRC error reading the response,
* SD_BLOCK_DEVICE_ERROR_PARAMETER if an invalid parameter was passed.
*/
static block_dev_err_t get_num_wr_blocks(sd_card_t *sd_card_p, uint32_t *num_p) {
// Send the ACMD22 command to get the number of written blocks
block_dev_err_t err = sd_cmd(sd_card_p, ACMD22_SEND_NUM_WR_BLOCKS, 0, true, NULL);
// If the command was not successful, return the error code
if (SD_BLOCK_DEVICE_ERROR_NONE != err) {
DBG_PRINTF("Didn't get a response from the disk\n");
return err;
}
// Read the response from the SD card and store it in the num_p variable
err = read_bytes(sd_card_p, (uint8_t *)num_p, sizeof(uint32_t));
*num_p = __builtin_bswap32(*num_p);
// If there was an error reading the response, return the error code
if (SD_BLOCK_DEVICE_ERROR_NONE != err) {
DBG_PRINTF("Couldn't read NUM_WR_BLOCKS response from disk\n");
return err;
}
// Return success
return SD_BLOCK_DEVICE_ERROR_NONE;
}
/**
* @brief Send a single block of data to the SD card.
*
* @param sd_card_p Pointer to the SD card object.
* @param buffer Pointer to the buffer containing the data to be sent.
* @param token The token to be sent before the data.
* @param length The length of the data to be sent.
*
* @return Block device error code.
*
* @details
* The function sends a single block of data to the SD card. It starts by sending the start block
* token, then writes the data using the SPI transfer function. While the SPI transfer is ongoing,
* the function computes the CRC16 checksum of the data if CRC checking is enabled. After the SPI
* transfer is complete, the function writes the CRC16 checksum to the SD card. Finally, the function
* checks the response token and returns an error code if the data was not accepted.
*/
static block_dev_err_t send_block(sd_card_t *sd_card_p, const uint8_t *buffer, uint8_t token,
uint32_t length)
{
uint8_t response;
/* Indicate start of block - Start Block Token */
response = sd_spi_write_read(sd_card_p, token);
if (!response) {
DBG_PRINTF("Start Block Token not accepted. Response: 0x%x\n", response);
return SD_BLOCK_DEVICE_ERROR_WRITE;
}
// Write the data
sd_spi_transfer_start(sd_card_p, buffer, NULL, length);
/* Optimization:
While the DMA is busy transfering the block data,
use the some of the wait time to calculate the CRC.
Typically, DMA transfer of the block data takes about 244 us,
but the CRC16 calculation takes only about 66 us.
*/
uint16_t crc = (~0);
// While DMA transfers the block, compute CRC:
if (crc_on) {
// Compute CRC
crc = crc16((void *)buffer, length);
}
uint32_t timeout = calculate_transfer_time_ms(sd_card_p->spi_if_p->spi, length);
bool ok = sd_spi_transfer_wait_complete(sd_card_p, timeout);
if (!ok) return SD_BLOCK_DEVICE_ERROR_WRITE;
// Write the checksum CRC16
sd_spi_write(sd_card_p, crc >> 8);
sd_spi_write(sd_card_p, crc);
block_dev_err_t rc = SD_BLOCK_DEVICE_ERROR_NONE;
// Check the response token
response = sd_spi_read(sd_card_p);
// Only CRC and general write error are communicated via response token
if ((response & SPI_DATA_RESPONSE_MASK) != SPI_DATA_ACCEPTED) {
EMSG_PRINTF("%s: Block Write not accepted. Response token: 0x%x, "
"status bits: %d%d%d\n",
sd_get_drive_prefix(sd_card_p),
response,
response & 0b1000 ? 1 : 0,
response & 0b0100 ? 1 : 0,
response & 0b0010 ? 1 : 0
);
/*
* The meaning of the status bits (bits 3, 2 & 1)
* is defined as follows:
* '010' - Data accepted.
* '101' - Data rejected due to a CRC error.
* '110' - Data Rejected due to a Write Error
* In case of any error (CRC or Write Error) during Write Multiple Block operation, the
* host shall stop the data transmission using CMD12. In case of a Write Error (response
* '110'), the host may send CMD13 (SEND_STATUS) in order to get the cause of the write
* problem. ACMD22 can be used to find the number of well written write blocks.
*/
rc = SD_BLOCK_DEVICE_ERROR_WRITE;
}
// Wait while card is busy programming
if (false == sd_wait_ready(sd_card_p, sd_timeouts.sd_command)) {
DBG_PRINTF("%s:%d: Card not ready yet\n", __func__, __LINE__);
rc = SD_BLOCK_DEVICE_ERROR_WRITE;
}
return rc;
}
/**
* @brief Send all blocks of data, one block at a time.
*
* The function performs the following steps:
* - Sends each block of data using the send_block() function
* - Checks the status of each send operation and stop if there is an error
* - Updates the buffer pointer and data address after each send operation
* - Sets the ongoing_mlt_blk_wrt flag to true if all blocks are sent successfully
* - Otherwise, stops the ongoing multiblock write and resets the number of
* blocks requested
*
* @param sd_card_p Pointer to the SD card object.
* @param buffer_p Pointer to the array of const uint8_t pointers. Each pointer
* points to the start of the block of data to be written.
* @param data_address_p Pointer to the address of the first block of data to be
* written.
* @param num_wrt_blks_p Pointer to the number of blocks to be written.
*
* @return SD_BLOCK_DEVICE_ERROR_NONE if all blocks are sent successfully,
* otherwise an error code.
*/
static block_dev_err_t send_all_blocks(sd_card_t *sd_card_p, const uint8_t *buffer_p[],
uint32_t * const data_address_p,
uint32_t * const num_wrt_blks_p)
{
block_dev_err_t status;
do {
status = send_block(sd_card_p, *buffer_p, SPI_START_BLK_MUL_WRITE, sd_block_size);
if (SD_BLOCK_DEVICE_ERROR_NONE != status) break;
*buffer_p += sd_block_size;
++*data_address_p;
} while (--*num_wrt_blks_p);
if (SD_BLOCK_DEVICE_ERROR_NONE == status) {
myASSERT(!*num_wrt_blks_p);
sd_card_p->spi_if_p->state.cont_sector_wrt = *data_address_p;
sd_card_p->spi_if_p->state.ongoing_mlt_blk_wrt = true;
} else {
// sd_card_p->spi_if_p->state.n_wrt_blks_reqd cleared in stop_wr_tran
uint32_t n_wrt_blks_reqd = sd_card_p->spi_if_p->state.n_wrt_blks_reqd;
stop_wr_tran(sd_card_p); // Ignore return value
uint32_t nw;
block_dev_err_t err = get_num_wr_blocks(sd_card_p, &nw);
if (SD_BLOCK_DEVICE_ERROR_NONE == err) {
DBG_PRINTF("blocks_requested: %lu, NUM_WR_BLOCKS: %lu\n",
n_wrt_blks_reqd, nw);
*num_wrt_blks_p = n_wrt_blks_reqd - nw;
}
}
return status;
}
/**
* @brief Write multiple blocks of data to the SD card.
*
* If there is an ongoing multiblock write and the next write is contiguous,
* this function will continue the write operation without stopping the
* transmission. Otherwise, it will stop any ongoing write transmission
* and send the command to perform the write operation.
*
* @param sd_card_p Pointer to the SD card object.
* @param buffer_p Pointer to the array of const uint8_t pointers. Each pointer
* points to the data buffer for a block.
* @param data_address_p Pointer to the integer storing the data address.
* @param num_wrt_blks_p Pointer to the integer storing the number of blocks to
* write.
* @return block_dev_err_t Error code indicating the status of the write operation.
*/
static block_dev_err_t in_sd_write_blocks(sd_card_t *sd_card_p,
const uint8_t *buffer_p[],
uint32_t * const data_address_p,
uint32_t * const num_wrt_blks_p)
{
block_dev_err_t status = SD_BLOCK_DEVICE_ERROR_NONE;
/* Continue a multiblock write */
if (sd_card_p->spi_if_p->state.ongoing_mlt_blk_wrt &&
sd_card_p->spi_if_p->state.cont_sector_wrt == *data_address_p) {
// Update the number of blocks requested for write
sd_card_p->spi_if_p->state.n_wrt_blks_reqd += *num_wrt_blks_p;
// Send all blocks of data
return send_all_blocks(sd_card_p, buffer_p, data_address_p, num_wrt_blks_p);
}
// Stop any ongoing write transmission
if (sd_card_p->spi_if_p->state.ongoing_mlt_blk_wrt) {
status = stop_wr_tran(sd_card_p);
if (SD_BLOCK_DEVICE_ERROR_NONE != status) return status;
}
// Send command to perform write operation
status = sd_cmd(sd_card_p, CMD25_WRITE_MULTIPLE_BLOCK, *data_address_p, false, 0);
if (SD_BLOCK_DEVICE_ERROR_NONE != status) return status;
// Update the number of blocks requested for write
sd_card_p->spi_if_p->state.n_wrt_blks_reqd = *num_wrt_blks_p;
// Send all blocks of data
return send_all_blocks(sd_card_p, buffer_p, data_address_p, num_wrt_blks_p);
/* Optimization:
To optimize large contiguous writes,
postpone stopping transmission until it is
clear that the next operation is not a continuation.
Any transactions other than a `sd_write_blocks`
continuation must stop any ongoing transmission
before proceeding.
*/
}
static block_dev_err_t stop_wr_tran(sd_card_t *sd_card_p) {
sd_card_p->spi_if_p->state.ongoing_mlt_blk_wrt = false;
/* In a Multiple Block write operation, the stop transmission will be
* done by sending 'Stop Tran' token instead of 'Start Block' token at
* the beginning of the next block
*/
sd_spi_write(sd_card_p, SPI_STOP_TRAN);
/*
Once the programming operation is completed, the
host must check the results of the programming
using the SEND_STATUS command (CMD13).
Some errors (e.g. address out of range, write
protect violation, etc.) are detected during
programming only. The only validation check
performed on the data block and communicated to
the host via the data-response token is CRC.
*/
if (false == sd_wait_ready(sd_card_p, sd_timeouts.sd_command)) {
DBG_PRINTF("Card not ready yet\n");
}
uint32_t stat = 0;
sd_card_p->spi_if_p->state.n_wrt_blks_reqd = 0;
return sd_cmd(sd_card_p, CMD13_SEND_STATUS, 0, false, &stat);
}
/**
* @brief Writes a single block to the SD card
*
* @param[in] sd_card_p Pointer to the SD card
* @param[in] buffer Buffer of data to write to the block
* @param[in] address Logical Address of the block to write to (LBA)
*
* @return
* - SD_BLOCK_DEVICE_ERROR_NONE on success
* - error code on failure
*/
static block_dev_err_t write_block(sd_card_t *sd_card_p, const uint8_t *buffer,
uint32_t const address)
{
// Stop any ongoing multiple block write transmission
block_dev_err_t status = SD_BLOCK_DEVICE_ERROR_NONE;
if (sd_card_p->spi_if_p->state.ongoing_mlt_blk_wrt) {
status = stop_wr_tran(sd_card_p);
if (SD_BLOCK_DEVICE_ERROR_NONE != status) return status;
}
// Send command to perform the write operation
status = sd_cmd(sd_card_p, CMD24_WRITE_BLOCK, address, false, 0);
if (SD_BLOCK_DEVICE_ERROR_NONE != status) return status;
// Write data
send_block(sd_card_p, buffer, SPI_START_BLOCK, sd_block_size);
/*
Once the programming operation is completed, the
host must check the results of the programming
using the SEND_STATUS command (CMD13).
Some errors (e.g. address out of range, write
protect violation, etc.) are detected during
programming only. The only validation check
performed on the data block and communicated to
the host via the data-response token is CRC.
*/
// Send command to get the status of the card
uint32_t stat = 0;
status = sd_cmd(sd_card_p, CMD13_SEND_STATUS, 0, false, &stat);
return status;
}
/**
* @brief Programs blocks to a block device
*
* @param[in] sd_card_p Pointer to the SD card
* @param[in] buffer Buffer of data to write to blocks
* @param[in] data_address Logical Address of block to begin writing to (LBA)
* @param[in] num_wrt_blks Size to write in blocks
*
* @return
* - SD_BLOCK_DEVICE_ERROR_NONE on success
* - SD_BLOCK_DEVICE_ERROR_NO_DEVICE if the device (SD card) is missing or not connected
* - SD_BLOCK_DEVICE_ERROR_CRC if there was a CRC error
* - SD_BLOCK_DEVICE_ERROR_PARAMETER if an invalid parameter was passed
* - SD_BLOCK_DEVICE_ERROR_UNSUPPORTED if the command is unsupported
* - SD_BLOCK_DEVICE_ERROR_NO_INIT if the device is not initialized
* - SD_BLOCK_DEVICE_ERROR_WRITE if there was an SPI write error
* - SD_BLOCK_DEVICE_ERROR_ERASE if there was an erase error
*/
static block_dev_err_t sd_write_blocks(sd_card_t *sd_card_p, uint8_t const buffer[],
uint32_t data_address, uint32_t num_wrt_blks)
{
TRACE_PRINTF("%s(0x%p, 0x%lx, 0x%lx)\n", __func__, buffer, data_address, num_wrt_blks);
// Check if the SD card pointer is valid
if (NULL == sd_card_p)
return SD_BLOCK_DEVICE_ERROR_PARAMETER;
// Check if the device is initialized and not missing
if (sd_card_p->state.m_Status & (STA_NOINIT | STA_NODISK))
return SD_BLOCK_DEVICE_ERROR_PARAMETER;
// Check if the number of blocks to write is valid
if (!num_wrt_blks) return SD_BLOCK_DEVICE_ERROR_PARAMETER;
// Calculate the end address
uint32_t end_address = data_address + num_wrt_blks;
// Check if the end address is within the device's boundaries
if (end_address >= sd_card_p->state.sectors)
return SD_BLOCK_DEVICE_ERROR_PARAMETER;
// Acquire the SD card
sd_acquire(sd_card_p);
block_dev_err_t status;
// If writing only one block, use the optimized function
if (1 == num_wrt_blks) {
status = write_block(sd_card_p, buffer, data_address);
} else {
// If writing multiple blocks, retry the operation until it succeeds or reaches the maximum number of retries
unsigned retries = sd_timeouts.sd_command_retries;
do {
if (retries < sd_timeouts.sd_command_retries) DBG_PRINTF("Retrying\n");
status = in_sd_write_blocks(sd_card_p, &buffer, &data_address, &num_wrt_blks);
if (SD_BLOCK_DEVICE_ERROR_WRITE == status)
DBG_PRINTF("%s status=0x%x data_address=%lu num_wrt_blks=%lu\n", sd_get_drive_prefix(sd_card_p), status, data_address, num_wrt_blks);
} while (SD_BLOCK_DEVICE_ERROR_WRITE == status && --retries && num_wrt_blks);
}
// Release the SD card
sd_release(sd_card_p);
return status;
}
/**
* @brief Synchronize the SD card
*
* This function is used to ensure that any ongoing write operations are
* completed before the SD card is released. This is necessary to ensure
* that the SD card is not released while it is still busy with a write
* operation.
*
* @param sd_card_p Pointer to the SD card object.
*
* @return
* - SD_BLOCK_DEVICE_ERROR_NONE on success
* - SD_BLOCK_DEVICE_ERROR_WRITE if there was a write error
* - SD_BLOCK_DEVICE_ERROR_UNSUPPORTED if the command is unsupported
* - SD_BLOCK_DEVICE_ERROR_NO_INIT if the device is not initialized
* - SD_BLOCK_DEVICE_ERROR_NO_DEVICE if the device (SD card) is missing or not connected
*/
static block_dev_err_t sd_sync(sd_card_t *sd_card_p) {
block_dev_err_t status = SD_BLOCK_DEVICE_ERROR_NONE;
sd_acquire(sd_card_p);
// Stop any ongoing transmission
if (sd_card_p->spi_if_p->state.ongoing_mlt_blk_wrt) status = stop_wr_tran(sd_card_p);
sd_release(sd_card_p);
return status;
}
/*!< Number of retries for sending CMDO */
#define SD_CMD0_GO_IDLE_STATE_RETRIES 10
/**
* @brief Resets the SD card to the idle state.
*
* This function sends the initializing sequence to the SD card and waits for it to enter the idle state.
*
* @param sd_card_p Pointer to the SD card object.
* @return The response from the SD card.
* @retval R1_IDLE_STATE if the SD card successfully entered the idle state.
* @retval R1_NO_RESPONSE if the SD card did not respond.
*/
static uint32_t in_sd_go_idle_state(sd_card_t *sd_card_p) {
/*
Power ON or card insertion
After supply voltage reached above 2.2 volts,
wait for one millisecond at least.
Set SPI clock rate between 100 kHz and 400 kHz.
Set DI and CS high and apply 74 or more clock pulses to SCLK.
The card will enter its native operating mode and go ready to accept native
command.
*/
sd_spi_go_low_frequency(sd_card_p);
uint32_t response = R1_NO_RESPONSE;
/* Resetting the MCU SPI master may not reset the on-board SDCard, in which
* case when MCU power-on occurs the SDCard will resume operations as
* though there was no reset. In this scenario the first CMD0 will
* not be interpreted as a command and get lost. For some cards retrying
* the command overcomes this situation. */
for (int i = 0; i < SD_CMD0_GO_IDLE_STATE_RETRIES; i++) {
/*
After power up, the host starts the clock and sends the initializing sequence on the CMD line.
This sequence is a contiguous stream of logical ‘1’s. The sequence length is the maximum of 1msec,
74 clocks or the supply-ramp-uptime; the additional 10 clocks
(over the 64 clocks after what the card should be ready for communication) is
provided to eliminate power-up synchronization problems.
*/
// Set DI and CS high and apply 74 or more clock pulses to SCLK:
sd_spi_deselect(sd_card_p);
uint8_t ones[10];
memset(ones, 0xFF, sizeof ones);
uint32_t start = millis();
do {
spi_transfer(sd_card_p->spi_if_p->spi, ones, NULL, sizeof ones);
} while (millis() - start < 1);
sd_spi_select(sd_card_p);
sd_cmd(sd_card_p, CMD0_GO_IDLE_STATE, 0x0, false, &response);
if (R1_IDLE_STATE == response) {
break;
}
}
return response;
}
/**
* @brief Resets the SD card to the idle state.
*
* This function sends the initializing sequence to the SD card and waits for it to enter the idle state.
*
* @param sd_card_p Pointer to the SD card object.
* @return The response from the SD card.
* @retval R1_IDLE_STATE if the SD card successfully entered the idle state.
* @retval R1_NO_RESPONSE if the SD card did not respond.
*/
uint32_t sd_go_idle_state(sd_card_t *sd_card_p) {
sd_spi_lock(sd_card_p);
uint32_t response = in_sd_go_idle_state(sd_card_p);
sd_spi_release(sd_card_p);
return response;
}
/**
* @brief Initializes the SD card medium.
*
* This function initializes the SD card medium by following the SD card initialization sequence.
* It transitions the card from SD card mode to SPI mode by sending the CMD0 command and applying
* the initializing sequence. It then sends the CMD8 command to check if the card supports the
* SD version 2.0 specification. If the card rejects the command, it assumes the card is using the
* legacy protocol or is a MMC card. It then enables or disables CRC based on the crc_on flag.
* It reads the OCR (Operating Conditions Register) using the CMD58 command and checks if the card
* supports the voltage range of 3.3V. If not, it sets the card type to CARD_UNKNOWN and returns
* SD_BLOCK_DEVICE_ERROR_UNUSABLE. It sets the card type based on the response of the ACMD41 command.
* If the initialization is successful, it disables or enables CRC and sets the card type based on
* the response of the CMD58 command. It then disconnects the 50 KOhm pull-up resistor on CS (pin 1)
* of the card using the ACMD42_SET_CLR_CARD_DETECT command.
*
* @param sd_card_p Pointer to the SD card object.
* @return The block device error status.
* @retval SD_BLOCK_DEVICE_ERROR_NONE if the initialization is successful.
* @retval SD_BLOCK_DEVICE_ERROR_NO_DEVICE if the card did not respond.
* @retval SD_BLOCK_DEVICE_ERROR_UNUSABLE if the card does not support the voltage range.
*/
static block_dev_err_t sd_init_medium(sd_card_t *sd_card_p) {
int32_t status = SD_BLOCK_DEVICE_ERROR_NONE;
uint32_t response, arg;
// The card is transitioned from SDCard mode to SPI mode by sending the CMD0
// + CS Asserted("0")
if (in_sd_go_idle_state(sd_card_p) != R1_IDLE_STATE) {
EMSG_PRINTF("No disk, or could not put SD card in to SPI idle state\n");
return SD_BLOCK_DEVICE_ERROR_NO_DEVICE;
}
// Send CMD8, if the card rejects the command then it's probably using the
// legacy protocol, or is a MMC, or just flat-out broken
status = sd_cmd8(sd_card_p);
if (SD_BLOCK_DEVICE_ERROR_NONE != status && SD_BLOCK_DEVICE_ERROR_UNSUPPORTED != status) {
return status;
}
if (crc_on) {
size_t retries = 3;
do {
// Enable CRC
status = sd_cmd(sd_card_p, CMD59_CRC_ON_OFF, 1, false, 0);
} while (--retries && (SD_BLOCK_DEVICE_ERROR_NONE != status));
}
// Read OCR - CMD58 Response contains OCR register
if (SD_BLOCK_DEVICE_ERROR_NONE !=
(status = sd_cmd(sd_card_p, CMD58_READ_OCR, 0x0, false, &response))) {
return status;
}
// Check if card supports voltage range: 3.3V
if (!(response & OCR_3_3V)) {
sd_card_p->state.card_type = CARD_UNKNOWN;
status = SD_BLOCK_DEVICE_ERROR_UNUSABLE;
return status;
}
// HCS is set 1 for HC/XC capacity cards for ACMD41, if supported
arg = 0x0;
if (SDCARD_V2 == sd_card_p->state.card_type) {
arg |= OCR_HCS_CCS;
}
/* Idle state bit in the R1 response of ACMD41 is used by the card to inform
* the host if initialization of ACMD41 is completed. "1" indicates that the
* card is still initializing. "0" indicates completion of initialization.
* The host repeatedly issues ACMD41 until this bit is set to "0".
*/
uint32_t start = millis();
do {
status = sd_cmd(sd_card_p, ACMD41_SD_SEND_OP_COND, arg, true, &response);
} while (response & R1_IDLE_STATE && millis() - start < sd_timeouts.sd_command);
// Initialization complete: ACMD41 successful
if ((SD_BLOCK_DEVICE_ERROR_NONE != status) || (0x00 != response)) {
sd_card_p->state.card_type = CARD_UNKNOWN;
EMSG_PRINTF("Timeout waiting for card\n");
return status;
}
if (SDCARD_V2 == sd_card_p->state.card_type) {
// Get the card capacity CCS: CMD58
if (SD_BLOCK_DEVICE_ERROR_NONE ==
(status = sd_cmd(sd_card_p, CMD58_READ_OCR, 0x0, false, &response))) {
// High Capacity card
if (response & OCR_HCS_CCS) {
sd_card_p->state.card_type = SDCARD_V2HC;
DBG_PRINTF("Card Initialized: High Capacity Card\n");
} else {
DBG_PRINTF("Card Initialized: Standard Capacity Card: Version 2.x\n");
}
}
} else {
sd_card_p->state.card_type = SDCARD_V1;
DBG_PRINTF("Card Initialized: Version 1.x Card\n");
}
if (!crc_on) {
// Disable CRC
status = sd_cmd(sd_card_p, CMD59_CRC_ON_OFF, 0, false, 0);
}
/* Disconnect the 50 KOhm pull-up resistor on CS (pin 1) of the card.
The pull-up may be used for card detection.
At power up this line has a 50KOhm pull up enabled in the card.
This resistor serves two functions Card detection and Mode Selection.
For Mode Selection, the host can drive the line high or let it be pulled high to select SD
mode. If the host wants to select SPI mode it should drive the line low. For Card detection,
the host detects that the line is pulled high. This pull-up should be disconnected by the
user, during regular data transfer, with SET_CLR_CARD_DETECT (ACMD42) command. */
status = sd_cmd(sd_card_p, ACMD42_SET_CLR_CARD_DETECT, 0, true, NULL);
return status;
}
/**
* @brief Tests the communication with the SD card.
*
* This function is used to test the communication with the SD card. It first checks if the
* SD card is already initialized, and if so, it sends a command to get the card status. If the
* card status is not received, it assumes that the card is no longer present and sets the
* `STA_NOINIT` flag in the card status. If the card is not initialized, it performs a light
* version of the initialization to test the communication. It sends the initializing sequence
* and waits for the card to go idle. If the card responds with a response status, it assumes
* that the communication is successful and returns `true`. If the card does not respond, it
* assumes that something is holding the DO line and returns `false`.
*
* @param sd_card_p Pointer to the SD card object.
* @return `true` if the communication with the SD card is successful, `false` otherwise.
*/
static bool sd_spi_test_com(sd_card_t *sd_card_p) {
// This is allowed to be called before initialization, so ensure mutex is created
if (!mutex_is_initialized(&sd_card_p->state.mutex)) mutex_init(&sd_card_p->state.mutex);
sd_acquire(sd_card_p);
bool success = false;
if (!(sd_card_p->state.m_Status & STA_NOINIT)) {
// SD card is currently initialized
// Timeout of 0 means only check once
if (sd_wait_ready(sd_card_p, 0)) {
// DO has been released, try to get status
uint32_t response;
for (unsigned i = 0; i < sd_timeouts.sd_command_retries; i++) {
// Send command over SPI interface
response = sd_cmd_spi(sd_card_p, CMD13_SEND_STATUS, 0);
if (R1_NO_RESPONSE != response) {
// Got a response!
success = true;
break;
}
}
if (!success) {
// Card no longer sensed - ensure card is initialized once re-attached
sd_card_p->state.m_Status |= STA_NOINIT;
}
} else {
// SD card is currently holding DO which is sufficient enough to know it's still
// there
success = true;
}
} else {
// Do a "light" version of init, just enough to test com
// Initialize the member variables
sd_card_p->state.card_type = SDCARD_NONE;
sd_spi_go_low_frequency(sd_card_p);
sd_spi_send_initializing_sequence(sd_card_p);
if (sd_wait_ready(sd_card_p, 0)) {
// DO has been released, try to make SD card go idle
uint32_t response;
for (unsigned i = 0; i < sd_timeouts.sd_command_retries; i++) {
// Send command over SPI interface
response = sd_cmd_spi(sd_card_p, CMD0_GO_IDLE_STATE, 0);
if (R1_NO_RESPONSE != response) {
// Got a response!
success = true;
break;
}
}
} else {
// Something is holding DO - better to return false and allow user to try again
// later
success = false;
}
}
sd_release(sd_card_p);
return success;
}
/**
* @brief Initializes the SD card over SPI.
*
* This function initializes the SD card over SPI. It first checks if the SD card is already
* initialized, and if so, it returns the current status. If the card is not initialized, it
* performs the initialization sequence and returns the status of the card. The card is
* initialized by sending the initializing sequence, checking the card type, setting the SCK
* for data transfer, and setting the block length to 512. The card is now considered initialized
* and its status is returned.
*
* @param sd_card_p Pointer to the SD card object.
* @return The status of the SD card:
* STA_NOINIT = 0x01, // Drive not initialized
* STA_NODISK = 0x02, // No medium in the drive
* STA_PROTECT = 0x04 // Write protected
*/
DSTATUS sd_card_spi_init(sd_card_t *sd_card_p) {
TRACE_PRINTF("> %s\n", __FUNCTION__);
// Acquire the lock
sd_lock(sd_card_p);
// Check if there's a card in the socket before proceeding
sd_card_detect(sd_card_p);
if (sd_card_p->state.m_Status & STA_NODISK) {
// Release the lock and return the current status
sd_unlock(sd_card_p);
return sd_card_p->state.m_Status;
}
// Check if we're not already initialized before proceeding
if (!(sd_card_p->state.m_Status & STA_NOINIT)) {
// Release the lock and return the current status
sd_unlock(sd_card_p);
return sd_card_p->state.m_Status;
}
// Initialize the member variables
sd_card_p->state.card_type = SDCARD_NONE;
// Acquire the SD card
sd_spi_acquire(sd_card_p);
// Initialize the medium
int err = sd_init_medium(sd_card_p);
if (SD_BLOCK_DEVICE_ERROR_NONE != err) {
EMSG_PRINTF("Failed to initialize card\n");
sd_release(sd_card_p);
return sd_card_p->state.m_Status;
}
// No support for SDSC Card (CCS=0) with byte unit address
if (SDCARD_V2HC != sd_card_p->state.card_type) {
EMSG_PRINTF("SD Standard Capacity Memory Card unsupported\n");
sd_release(sd_card_p);
return sd_card_p->state.m_Status;
}
DBG_PRINTF("SD card initialized\n");
// Set SCK for data transfer
sd_spi_go_high_frequency(sd_card_p);
// Get the number of sectors on the card
sd_card_p->state.sectors = in_sd_spi_sectors(sd_card_p);
if (0 == sd_card_p->state.sectors) {
// CMD9 failed
sd_release(sd_card_p);
return sd_card_p->state.m_Status;
}
// Get the CID of the card
if (SD_BLOCK_DEVICE_ERROR_NONE != sd_cmd(sd_card_p, CMD10_SEND_CID, 0x0, false, 0)) {
DBG_PRINTF("Didn't get a response from the disk\n");
sd_release(sd_card_p);
return sd_card_p->state.m_Status;
}
if (read_bytes(sd_card_p, (uint8_t *)&sd_card_p->state.CID, sizeof(CID_t)) != 0) {
DBG_PRINTF("Couldn't read CID response from disk\n");
sd_release(sd_card_p);
return sd_card_p->state.m_Status;
}
// Set the block length to 512 (CMD16)
if (SD_BLOCK_DEVICE_ERROR_NONE !=
sd_cmd(sd_card_p, CMD16_SET_BLOCKLEN, sd_block_size, false, 0)) {
DBG_PRINTF("Set %u-byte block timed out\n", sd_block_size);
sd_release(sd_card_p);
return sd_card_p->state.m_Status;
}
// The card is now initialized
sd_card_p->state.m_Status &= ~STA_NOINIT;
// Release the SD card
sd_release(sd_card_p);
// Return the disk status
return sd_card_p->state.m_Status;
}
/**
* @brief Deinitializes the SD card.
*
* This function deinitializes the SD card by setting the STA_NOINIT bit in the
* status field and setting the card type to SDCARD_NONE. It also deinitializes
* the chip select GPIO.
*
* @param sd_card_p Pointer to the sd_card_t structure to be deinitialized.
*/
static void sd_deinit(sd_card_t *sd_card_p) {
sd_card_p->state.m_Status |= STA_NOINIT;
sd_card_p->state.card_type = SDCARD_NONE;
if ((uint)-1 != sd_card_p->spi_if_p->ss_gpio) {
gpio_deinit(sd_card_p->spi_if_p->ss_gpio);
gpio_set_dir(sd_card_p->spi_if_p->ss_gpio, GPIO_IN);
}
}
/**
* @brief Initializes the sd_card_t structure.
*
* This function initializes the sd_card_t structure with pointers to the
* respective functions for reading and writing blocks, syncing the card,
* initializing the card, deinitializing the card, getting the number of
* sectors, and testing the card's communication. It also initializes the chip
* select GPIO pin.
*
* @param sd_card_p Pointer to the sd_card_t structure to be initialized.
*/
void sd_spi_ctor(sd_card_t *sd_card_p) {
sd_card_p->write_blocks = sd_write_blocks;
sd_card_p->read_blocks = sd_read_blocks;
sd_card_p->sync = sd_sync;
sd_card_p->init = sd_card_spi_init;
sd_card_p->deinit = sd_deinit;
sd_card_p->get_num_sectors = sd_spi_sectors;
sd_card_p->sd_test_com = sd_spi_test_com;
// Chip select is active-low, so we'll initialise it to a
// driven-high state.
if ((uint)-1 == sd_card_p->spi_if_p->ss_gpio) return;
gpio_init(sd_card_p->spi_if_p->ss_gpio);
gpio_put(sd_card_p->spi_if_p->ss_gpio, 1); // Avoid any glitches when enabling output
gpio_set_dir(sd_card_p->spi_if_p->ss_gpio, GPIO_OUT);
gpio_put(sd_card_p->spi_if_p->ss_gpio, 1); // In case set_dir does anything
if (sd_card_p->spi_if_p->set_drive_strength) {
gpio_set_drive_strength(sd_card_p->spi_if_p->ss_gpio,
sd_card_p->spi_if_p->ss_gpio_drive_strength);
}
}
/* [] END OF FILE */
Reference in New Issue View Git Blame Copy Permalink