Tactility/Boards/LilygoTdeck/sdcard.cpp

#include "hal/sdcard/Sdcard.h"
#include "Check.h"
#include "Log.h"
#include "config.h"

#include "esp_vfs_fat.h"
#include "sdmmc_cmd.h"
#include "ui/LvglSync.h"

#define TAG "tdeck_sdcard"

typedef struct {
    const char* mount_point;
    sdmmc_card_t* card;
} MountData;

/**
 * Before we can initialize the sdcard's SPI communications, we have to set all
 * other SPI pins on the board high.
 * See https://github.com/espressif/esp-idf/issues/1597
 * See https://github.com/Xinyuan-LilyGO/T-Deck/blob/master/examples/UnitTest/UnitTest.ino
 * @return success result
 */
static bool sdcard_init() {
    TT_LOG_D(TAG, "init");

    gpio_config_t config = {
        .pin_bit_mask = BIT64(TDECK_SDCARD_PIN_CS) | BIT64(TDECK_RADIO_PIN_CS) | BIT64(TDECK_LCD_PIN_CS),
        .mode = GPIO_MODE_OUTPUT,
        .pull_up_en = GPIO_PULLUP_DISABLE,
        .pull_down_en = GPIO_PULLDOWN_DISABLE,
        .intr_type = GPIO_INTR_DISABLE,
    };

    if (gpio_config(&config) != ESP_OK) {
        TT_LOG_E(TAG, "GPIO init failed");
        return false;
    }

    if (gpio_set_level(TDECK_SDCARD_PIN_CS, 1) != ESP_OK) {
        TT_LOG_E(TAG, "Failed to set board CS pin high");
        return false;
    }

    if (gpio_set_level(TDECK_RADIO_PIN_CS, 1) != ESP_OK) {
        TT_LOG_E(TAG, "Failed to set radio CS pin high");
        return false;
    }

    if (gpio_set_level(TDECK_LCD_PIN_CS, 1) != ESP_OK) {
        TT_LOG_E(TAG, "Failed to set TFT CS pin high");
        return false;
    }

    return true;
}

static void* _Nullable sdcard_mount(const char* mount_point) {
    TT_LOG_I(TAG, "Mounting %s", mount_point);

    esp_vfs_fat_sdmmc_mount_config_t mount_config = {
        .format_if_mount_failed = TDECK_SDCARD_FORMAT_ON_MOUNT_FAILED,
        .max_files = TDECK_SDCARD_MAX_OPEN_FILES,
        .allocation_unit_size = TDECK_SDCARD_ALLOC_UNIT_SIZE,
        .disk_status_check_enable = TDECK_SDCARD_STATUS_CHECK_ENABLED
    };

    // Init without card detect (CD) and write protect (WD)
    sdspi_device_config_t slot_config = SDSPI_DEVICE_CONFIG_DEFAULT();
    slot_config.gpio_cs = TDECK_SDCARD_PIN_CS;
    slot_config.host_id = TDECK_SDCARD_SPI_HOST;

    sdmmc_host_t host = SDSPI_HOST_DEFAULT();
    // The following value is from T-Deck repo's UnitTest.ino project:
    // https://github.com/Xinyuan-LilyGO/T-Deck/blob/master/examples/UnitTest/UnitTest.ino
    // Observation: Using this automatically sets the bus to 20MHz
    host.max_freq_khz = TDECK_SDCARD_SPI_FREQUENCY;

    sdmmc_card_t* card;
    esp_err_t ret = esp_vfs_fat_sdspi_mount(mount_point, &host, &slot_config, &mount_config, &card);

    if (ret != ESP_OK) {
        if (ret == ESP_FAIL) {
            TT_LOG_E(TAG, "Mounting failed. Ensure the card is formatted with FAT.");
        } else {
            TT_LOG_E(TAG, "Mounting failed (%s)", esp_err_to_name(ret));
        }
        return NULL;
    }

    auto* data = static_cast<MountData*>(malloc(sizeof(MountData)));
    *data = (MountData) {
        .mount_point = mount_point,
        .card = card,
    };

    return data;
}

static void* sdcard_init_and_mount(const char* mount_point) {
    if (!sdcard_init()) {
        TT_LOG_E(TAG, "Failed to set SPI CS pins high. This is a pre-requisite for mounting.");
        return NULL;
    }
    auto* data = static_cast<MountData*>(sdcard_mount(mount_point));
    if (data == nullptr) {
        TT_LOG_E(TAG, "Mount failed for %s", mount_point);
        return nullptr;
    }

    sdmmc_card_print_info(stdout, data->card);

    return data;
}

static void sdcard_unmount(void* context) {
    auto* data = static_cast<MountData*>(context);
    TT_LOG_I(TAG, "Unmounting %s", data->mount_point);

    tt_assert(data != nullptr);
    if (esp_vfs_fat_sdcard_unmount(data->mount_point, data->card) != ESP_OK) {
        TT_LOG_E(TAG, "Unmount failed for %s", data->mount_point);
    }

    free(data);
}

static bool sdcard_is_mounted(void* context) {
    auto* data = static_cast<MountData*>(context);
    /**
     * The SD card and the screen are on the same SPI bus.
     * Writing and reading to the bus from 2 devices at the same time causes crashes.
     * This work-around ensures that this check is only happening when LVGL isn't rendering.
     */
    if (tt::lvgl::lock(100)) {
        bool result = (data != nullptr) && (sdmmc_get_status(data->card) == ESP_OK);
        tt::lvgl::unlock();
        return result;
    } else {
        return false;
    }
}

extern const tt::hal::sdcard::SdCard tdeck_sdcard = {
    .mount = &sdcard_init_and_mount,
    .unmount = &sdcard_unmount,
    .is_mounted = &sdcard_is_mounted,
    .mount_behaviour = tt::hal::sdcard::MountBehaviourAtBoot
};