Esp32/Components/spi_flash/include/esp_spi_flash.h

Go to the documentation of this file.

/****
 * Sming Framework Project - Open Source framework for high efficiency native ESP8266 development.
 * Created 2015 by Skurydin Alexey
 * http://github.com/SmingHub/Sming
 * All files of the Sming Core are provided under the LGPL v3 license.
 *
 * Based on NodeMCU platform_flash
 * https://github.com/nodemcu/nodemcu-firmware
 *
 ****/

#pragma once

#include <esp_idf_version.h>
#if ESP_IDF_VERSION_MAJOR < 5
#include_next <esp_spi_flash.h>
#else
#include <spi_flash_mmap.h>
#endif
#include <rom/spi_flash.h>
#include <esp_app_format.h>

#ifdef __cplusplus
extern "C" {
#endif

#define INTERNAL_FLASH_WRITE_UNIT_SIZE 4
#define INTERNAL_FLASH_READ_UNIT_SIZE 4

#define FLASH_TOTAL_SEC_COUNT (flashmem_get_size_sectors())

#define SYS_PARAM_SEC_COUNT 4
#define FLASH_WORK_SEC_COUNT (FLASH_TOTAL_SEC_COUNT - SYS_PARAM_SEC_COUNT)

#define INTERNAL_FLASH_SECTOR_SIZE SPI_FLASH_SEC_SIZE
#define INTERNAL_FLASH_SIZE ((FLASH_WORK_SEC_COUNT)*INTERNAL_FLASH_SECTOR_SIZE)

typedef enum {
    MODE_QIO = ESP_IMAGE_SPI_MODE_QIO,
    MODE_QOUT = ESP_IMAGE_SPI_MODE_QOUT,
    MODE_DIO = ESP_IMAGE_SPI_MODE_DIO,
    MODE_DOUT = ESP_IMAGE_SPI_MODE_DOUT,
    MODE_FAST_READ = ESP_IMAGE_SPI_MODE_FAST_READ,
    MODE_SLOW_READ = ESP_IMAGE_SPI_MODE_SLOW_READ,
} SPIFlashMode;

typedef enum {
    SPEED_40MHZ = 0,    // ESP_IMAGE_SPI_SPEED_40M
    SPEED_26MHZ = 1,    // ESP_IMAGE_SPI_SPEED_26M
    SPEED_20MHZ = 2,    // ESP_IMAGE_SPI_SPEED_20M
    SPEED_80MHZ = 0x0f, // ESP_IMAGE_SPI_SPEED_80M
} SPIFlashSpeed;

typedef enum {
    SIZE_1MBIT = ESP_IMAGE_FLASH_SIZE_1MB,
    SIZE_2MBIT = ESP_IMAGE_FLASH_SIZE_2MB,
    SIZE_4MBIT = ESP_IMAGE_FLASH_SIZE_4MB,
    SIZE_8MBIT = ESP_IMAGE_FLASH_SIZE_8MB,
    SIZE_16MBIT = ESP_IMAGE_FLASH_SIZE_16MB,
    SIZE_32MBIT = 0xFF, 
} SPIFlashSize;

typedef struct {
    SPIFlashMode mode;
    SPIFlashSpeed speed;
    SPIFlashSize size;
} SPIFlashInfo;

static inline uint32_t flashmem_get_address(const void* memptr)
{
    auto phys = spi_flash_cache2phys(memptr);
    return (phys == SPI_FLASH_CACHE2PHYS_FAIL) ? 0 : phys;
}

uint32_t flashmem_write(const void* from, uint32_t toaddr, uint32_t size);

uint32_t flashmem_read(void* to, uint32_t fromaddr, uint32_t size);

bool flashmem_erase_sector(uint32_t sector_id);

SPIFlashInfo flashmem_get_info();

uint8_t flashmem_get_size_type();

uint32_t flashmem_get_size_bytes();

uint16_t flashmem_get_size_sectors();

uint32_t flashmem_find_sector(uint32_t address, uint32_t* pstart, uint32_t* pend);

uint32_t flashmem_get_sector_of_address(uint32_t addr);

/*
 * @brief Get unique 32-bit flash identification code
 */
uint32_t spi_flash_get_id(void);

#ifdef __cplusplus
}
#endif