Rp2040/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

#ifdef __cplusplus
extern "C" {
#endif

#include <esp_system.h>
#include <sys/pgmspace.h>

#define SPI_FLASH_SEC_SIZE 4096

#define FLASH_TOTAL_SEC_COUNT PICO_FLASH_SIZE_BYTES

/*
 * TODO: Revise layout to use custom 2nd-stage bootloader with partition
 * table support.
 */
#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)
#define INTERNAL_FLASH_START_ADDRESS FLASH_BASE

typedef enum {
    MODE_QIO = 0,
    MODE_QOUT = 1,
    MODE_DIO = 2,
    MODE_DOUT = 15,
    MODE_SLOW_READ = 0xFE, 
    MODE_FAST_READ = 0xFF, 
} SPIFlashMode;

typedef enum {
    SPEED_40MHZ = 0,
    SPEED_26MHZ = 1,
    SPEED_20MHZ = 2,
    SPEED_80MHZ = 15,
} SPIFlashSpeed;

typedef enum {
    SIZE_4MBIT = 0,
    SIZE_2MBIT = 1,
    SIZE_8MBIT = 2,
    SIZE_16MBIT = 3,
    SIZE_32MBIT = 4,
    SIZE_1MBIT = 0xFF, 
} SPIFlashSize;

typedef struct {
    uint8_t mode : 8;  
    uint8_t speed : 4; 
    uint8_t size : 4;  
} SPIFlashInfo;

static inline uint32_t flashmem_get_address(const void* memptr)
{
    auto addr = uint32_t(memptr);
    if(addr < XIP_BASE || addr >= XIP_NOALLOC_BASE) {
        return 0;
    }
    return addr - XIP_BASE;
}

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 Returns the address of the first free block on flash
 * @retval  uint32_t The actual address on flash
 */
uint32_t flashmem_get_first_free_block_address();

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

/*
 * @brief Read flash SFDP device information (standard for Serial Flash Discoverable Parameters)
 * @param addr First memory location to read
 * @param buffer Buffer for data
 * @param count Number of bytes to read
 */
void flashmem_sfdp_read(uint32_t addr, void* buffer, size_t count);

#ifdef __cplusplus
}
#endif