269486ca4d
Previously SDSPI host driver would rely on retry count when waiting for the card to read or write data. This caused different timeout times depending on CPU frequency and card clock frequency. In practice, card performance does not depend on these two factors. This change uses timeout_ms field of sdmmc_command_t introduced previously for SDMMC host. Fixes https://esp32.com/viewtopic.php?f=2&t=3440&p=16037 and similar issues related to SDSPI timeouts.
99 lines
3.9 KiB
C
99 lines
3.9 KiB
C
// Copyright 2015-2017 Espressif Systems (Shanghai) PTE LTD
|
|
//
|
|
// 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.
|
|
|
|
#pragma once
|
|
|
|
#include <stdint.h>
|
|
#include <stddef.h>
|
|
#include "esp_err.h"
|
|
#include "freertos/FreeRTOS.h"
|
|
#include "freertos/queue.h"
|
|
|
|
|
|
/// Control tokens used to frame data transfers
|
|
/// (see section 7.3.3 of SD simplified spec)
|
|
|
|
/// Token sent before single/multi block reads and single block writes
|
|
#define TOKEN_BLOCK_START 0b11111110
|
|
/// Token sent before multi block writes
|
|
#define TOKEN_BLOCK_START_WRITE_MULTI 0b11111100
|
|
/// Token used to stop multi block write (for reads, CMD12 is used instead)
|
|
#define TOKEN_BLOCK_STOP_WRITE_MULTI 0b11111101
|
|
|
|
/// Data response tokens
|
|
|
|
/// Mask (high 3 bits are undefined for data response tokens)
|
|
#define TOKEN_RSP_MASK 0b11111
|
|
/// Data accepted
|
|
#define TOKEN_RSP_OK 0b00101
|
|
/// Data rejected due to CRC error
|
|
#define TOKEN_RSP_CRC_ERR 0b01011
|
|
/// Data rejected due to write error
|
|
#define TOKEN_RSP_WRITE_ERR 0b01101
|
|
|
|
|
|
/// Data error tokens have format 0b0000xyzw where xyzw are signle bit flags.
|
|
/// MASK and VAL are used to check if a token is an error token
|
|
#define TOKEN_ERR_MASK 0b11110000
|
|
#define TOKEN_ERR_VAL 0b00000000
|
|
|
|
/// Argument is out of range
|
|
#define TOKEN_ERR_RANGE BIT(3)
|
|
/// Card internal ECC error
|
|
#define TOKEN_ERR_CARD_ECC BIT(2)
|
|
/// Card controller error
|
|
#define TOKEN_ERR_INTERNAL BIT(1)
|
|
/// Card is locked
|
|
#define TOKEN_ERR_LOCKED BIT(0)
|
|
|
|
|
|
/// Transfer format in SPI mode. See section 7.3.1.1 of SD simplified spec.
|
|
typedef struct {
|
|
// These fields form the command sent from host to the card (6 bytes)
|
|
uint8_t cmd_index : 6;
|
|
uint8_t transmission_bit : 1;
|
|
uint8_t start_bit : 1;
|
|
uint8_t arguments[4];
|
|
uint8_t stop_bit : 1;
|
|
uint8_t crc7 : 7;
|
|
/// Ncr is the dead time between command and response; should be 0xff
|
|
uint8_t ncr;
|
|
/// Response data, should be set by host to 0xff for read operations
|
|
uint8_t r1;
|
|
/// Up to 16 bytes of response. Luckily, this is aligned on 4 byte boundary.
|
|
uint32_t response[4];
|
|
/// response timeout, in milliseconds
|
|
int timeout_ms;
|
|
} sdspi_hw_cmd_t;
|
|
|
|
#define SDSPI_CMD_NORESP_SIZE 6 //!< Size of the command without any response
|
|
#define SDSPI_CMD_R1_SIZE 8 //!< Size of the command with R1 response
|
|
#define SDSPI_CMD_R2_SIZE 9 //!< Size of the command with R1b response
|
|
#define SDSPI_CMD_R3_SIZE 12 //!< Size of the command with R3 response
|
|
#define SDSPI_CMD_R7_SIZE 12 //!< Size of the command with R7 response
|
|
|
|
#define SDSPI_CMD_FLAG_DATA BIT(0) //!< Command has data transfer
|
|
#define SDSPI_CMD_FLAG_WRITE BIT(1) //!< Data is written to the card
|
|
#define SDSPI_CMD_FLAG_RSP_R1 BIT(2) //!< Response format R1 (1 byte)
|
|
#define SDSPI_CMD_FLAG_RSP_R2 BIT(3) //!< Response format R2 (2 bytes)
|
|
#define SDSPI_CMD_FLAG_RSP_R3 BIT(4) //!< Response format R3 (5 bytes)
|
|
#define SDSPI_CMD_FLAG_RSP_R7 BIT(5) //!< Response format R7 (5 bytes)
|
|
|
|
#define SDSPI_MAX_DATA_LEN 512 //!< Max size of single block transfer
|
|
|
|
void make_hw_cmd(uint32_t opcode, uint32_t arg, int timeout_ms, sdspi_hw_cmd_t *hw_cmd);
|
|
|
|
esp_err_t sdspi_host_start_command(int slot, sdspi_hw_cmd_t *cmd,
|
|
void *data, uint32_t data_size, int flags);
|