246 lines
8 KiB
C
246 lines
8 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 "sdmmc_types.h"
|
|
#include "driver/gpio.h"
|
|
#include "driver/spi_master.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/// Handle representing an SD SPI device
|
|
typedef int sdspi_dev_handle_t;
|
|
|
|
/**
|
|
* @brief Default sdmmc_host_t structure initializer for SD over SPI driver
|
|
*
|
|
* Uses SPI mode and max frequency set to 20MHz
|
|
*
|
|
* 'slot' should be set to an sdspi device initialized by `sdspi_host_init_device()`.
|
|
*/
|
|
#define SDSPI_HOST_DEFAULT() {\
|
|
.flags = SDMMC_HOST_FLAG_SPI | SDMMC_HOST_FLAG_DEINIT_ARG, \
|
|
.slot = HSPI_HOST, \
|
|
.max_freq_khz = SDMMC_FREQ_DEFAULT, \
|
|
.io_voltage = 3.3f, \
|
|
.init = &sdspi_host_init, \
|
|
.set_bus_width = NULL, \
|
|
.get_bus_width = NULL, \
|
|
.set_bus_ddr_mode = NULL, \
|
|
.set_card_clk = &sdspi_host_set_card_clk, \
|
|
.do_transaction = &sdspi_host_do_transaction, \
|
|
.deinit_p = &sdspi_host_remove_device, \
|
|
.io_int_enable = &sdspi_host_io_int_enable, \
|
|
.io_int_wait = &sdspi_host_io_int_wait, \
|
|
.command_timeout_ms = 0, \
|
|
}
|
|
|
|
/**
|
|
* Extra configuration for SD SPI device.
|
|
*/
|
|
typedef struct {
|
|
spi_host_device_t host_id; ///< SPI host to use, SPIx_HOST (see spi_types.h).
|
|
gpio_num_t gpio_cs; ///< GPIO number of CS signal
|
|
gpio_num_t gpio_cd; ///< GPIO number of card detect signal
|
|
gpio_num_t gpio_wp; ///< GPIO number of write protect signal
|
|
gpio_num_t gpio_int; ///< GPIO number of interrupt line (input) for SDIO card.
|
|
} sdspi_device_config_t;
|
|
|
|
#define SDSPI_SLOT_NO_CD GPIO_NUM_NC ///< indicates that card detect line is not used
|
|
#define SDSPI_SLOT_NO_WP GPIO_NUM_NC ///< indicates that write protect line is not used
|
|
#define SDSPI_SLOT_NO_INT GPIO_NUM_NC ///< indicates that interrupt line is not used
|
|
|
|
/**
|
|
* Macro defining default configuration of SD SPI device.
|
|
*/
|
|
#define SDSPI_DEVICE_CONFIG_DEFAULT() {\
|
|
.host_id = HSPI_HOST, \
|
|
.gpio_cs = GPIO_NUM_13, \
|
|
.gpio_cd = SDSPI_SLOT_NO_CD, \
|
|
.gpio_wp = SDSPI_SLOT_NO_WP, \
|
|
.gpio_int = GPIO_NUM_NC, \
|
|
}
|
|
|
|
/**
|
|
* @brief Initialize SD SPI driver
|
|
*
|
|
* @note This function is not thread safe
|
|
*
|
|
* @return
|
|
* - ESP_OK on success
|
|
* - other error codes may be returned in future versions
|
|
*/
|
|
esp_err_t sdspi_host_init(void);
|
|
|
|
/**
|
|
* @brief Attach and initialize an SD SPI device on the specific SPI bus
|
|
*
|
|
* @note This function is not thread safe
|
|
*
|
|
* @note Initialize the SPI bus by `spi_bus_initialize()` before calling this function.
|
|
*
|
|
* @note The SDIO over sdspi needs an extra interrupt line. Call ``gpio_install_isr_service()`` before this function.
|
|
*
|
|
* @param dev_config pointer to device configuration structure
|
|
* @param out_handle Output of the handle to the sdspi device.
|
|
|
|
* @return
|
|
* - ESP_OK on success
|
|
* - ESP_ERR_INVALID_ARG if sdspi_host_init_device has invalid arguments
|
|
* - ESP_ERR_NO_MEM if memory can not be allocated
|
|
* - other errors from the underlying spi_master and gpio drivers
|
|
*/
|
|
esp_err_t sdspi_host_init_device(const sdspi_device_config_t* dev_config, sdspi_dev_handle_t* out_handle);
|
|
|
|
/**
|
|
* @brief Remove an SD SPI device
|
|
*
|
|
* @param handle Handle of the SD SPI device
|
|
* @return Always ESP_OK
|
|
*/
|
|
esp_err_t sdspi_host_remove_device(sdspi_dev_handle_t handle);
|
|
|
|
/**
|
|
* @brief Send command to the card and get response
|
|
*
|
|
* This function returns when command is sent and response is received,
|
|
* or data is transferred, or timeout occurs.
|
|
*
|
|
* @note This function is not thread safe w.r.t. init/deinit functions,
|
|
* and bus width/clock speed configuration functions. Multiple tasks
|
|
* can call sdspi_host_do_transaction as long as other sdspi_host_*
|
|
* functions are not called.
|
|
*
|
|
* @param handle Handle of the sdspi device
|
|
* @param cmdinfo pointer to structure describing command and data to transfer
|
|
* @return
|
|
* - ESP_OK on success
|
|
* - ESP_ERR_TIMEOUT if response or data transfer has timed out
|
|
* - ESP_ERR_INVALID_CRC if response or data transfer CRC check has failed
|
|
* - ESP_ERR_INVALID_RESPONSE if the card has sent an invalid response
|
|
*/
|
|
esp_err_t sdspi_host_do_transaction(sdspi_dev_handle_t handle, sdmmc_command_t *cmdinfo);
|
|
|
|
/**
|
|
* @brief Set card clock frequency
|
|
*
|
|
* Currently only integer fractions of 40MHz clock can be used.
|
|
* For High Speed cards, 40MHz can be used.
|
|
* For Default Speed cards, 20MHz can be used.
|
|
*
|
|
* @note This function is not thread safe
|
|
*
|
|
* @param host Handle of the sdspi device
|
|
* @param freq_khz card clock frequency, in kHz
|
|
* @return
|
|
* - ESP_OK on success
|
|
* - other error codes may be returned in the future
|
|
*/
|
|
esp_err_t sdspi_host_set_card_clk(sdspi_dev_handle_t host, uint32_t freq_khz);
|
|
|
|
/**
|
|
* @brief Release resources allocated using sdspi_host_init
|
|
*
|
|
* @note This function is not thread safe
|
|
*
|
|
* @return
|
|
* - ESP_OK on success
|
|
* - ESP_ERR_INVALID_STATE if sdspi_host_init function has not been called
|
|
*/
|
|
esp_err_t sdspi_host_deinit(void);
|
|
|
|
/**
|
|
* @brief Enable SDIO interrupt.
|
|
*
|
|
* @param handle Handle of the sdspi device
|
|
*
|
|
* @return
|
|
* - ESP_OK on success
|
|
*/
|
|
esp_err_t sdspi_host_io_int_enable(sdspi_dev_handle_t handle);
|
|
|
|
/**
|
|
* @brief Wait for SDIO interrupt until timeout.
|
|
*
|
|
* @param handle Handle of the sdspi device
|
|
* @param timeout_ticks Ticks to wait before timeout.
|
|
*
|
|
* @return
|
|
* - ESP_OK on success
|
|
*/
|
|
esp_err_t sdspi_host_io_int_wait(sdspi_dev_handle_t handle, TickType_t timeout_ticks);
|
|
|
|
/*******************************************************************************
|
|
* Deprecated APIs
|
|
******************************************************************************/
|
|
|
|
/**
|
|
* Extra configuration for SPI host.
|
|
*
|
|
* @deprecated Use `sdspi_device_config_t` and corresponding `sdspi_host_init_device()` instead.
|
|
*/
|
|
typedef struct {
|
|
gpio_num_t gpio_cs; ///< GPIO number of CS signal
|
|
gpio_num_t gpio_cd; ///< GPIO number of card detect signal
|
|
gpio_num_t gpio_wp; ///< GPIO number of write protect signal
|
|
gpio_num_t gpio_int; ///< GPIO number of interrupt line (input) for SDIO card.
|
|
gpio_num_t gpio_miso; ///< GPIO number of MISO signal.
|
|
gpio_num_t gpio_mosi; ///< GPIO number of MOSI signal.
|
|
gpio_num_t gpio_sck; ///< GPIO number of SCK signal.
|
|
int dma_channel; ///< DMA channel to be used by SPI driver (1 or 2).
|
|
} sdspi_slot_config_t;
|
|
|
|
/**
|
|
* Macro defining default configuration of SPI host
|
|
*/
|
|
#define SDSPI_SLOT_CONFIG_DEFAULT() {\
|
|
.gpio_cs = GPIO_NUM_13, \
|
|
.gpio_cd = SDSPI_SLOT_NO_CD, \
|
|
.gpio_wp = SDSPI_SLOT_NO_WP, \
|
|
.gpio_int = GPIO_NUM_NC, \
|
|
.gpio_miso = GPIO_NUM_2, \
|
|
.gpio_mosi = GPIO_NUM_15, \
|
|
.gpio_sck = GPIO_NUM_14, \
|
|
.dma_channel = 1, \
|
|
}
|
|
|
|
/**
|
|
* @brief Initialize SD SPI driver for the specific SPI controller
|
|
*
|
|
* @note This function is not thread safe
|
|
*
|
|
* @note The SDIO over sdspi needs an extra interrupt line. Call ``gpio_install_isr_service()`` before this function.
|
|
*
|
|
* @param slot SPI controller to use (HSPI_HOST or VSPI_HOST)
|
|
* @param slot_config pointer to slot configuration structure
|
|
|
|
* @deprecated Use `sdspi_host_init_device` instead.
|
|
*
|
|
* @return
|
|
* - ESP_OK on success
|
|
* - ESP_ERR_INVALID_ARG if sdspi_init_slot has invalid arguments
|
|
* - ESP_ERR_NO_MEM if memory can not be allocated
|
|
* - other errors from the underlying spi_master and gpio drivers
|
|
*/
|
|
esp_err_t sdspi_host_init_slot(int slot, const sdspi_slot_config_t* slot_config);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|