flashmem.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_attr.h>
#include <sming_attr.h>
#include <stdint.h>
 
// Platform-safe typedefs for flash access, including emulation
typedef uintptr_t flash_addr_t;
typedef uint32_t flash_sector_t;
 
#ifdef __cplusplus
extern "C" {
#endif
 
// Flash memory access must be aligned and in multiples of 4-byte words
#define INTERNAL_FLASH_WRITE_UNIT_SIZE 4
#define INTERNAL_FLASH_READ_UNIT_SIZE 4
 
#define FLASH_TOTAL_SEC_COUNT (flashmem_get_size_sectors())
 
/*
// Defined in 'flashmem.h' above
 
#define INTERNAL_FLASH_SECTOR_SIZE 4096
#define INTERNAL_FLASH_START_ADDRESS 0x40200000
 
typedef enum {
    MODE_QIO = 0,
    MODE_QOUT = 1,
    MODE_DIO = 2,
    MODE_DOUT = 15,
    MODE_SLOW_READ = 0xFE, ///< Not supported
    MODE_FAST_READ = 0xFF, ///< Not supported
} 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, ///< Not supported
} SPIFlashSize;
 
*/
 
typedef struct {
    SPIFlashMode mode;
    SPIFlashSpeed speed;
    SPIFlashSize size;
} SPIFlashInfo;
 
flash_addr_t flashmem_get_address(const void* memptr);
 
uint32_t flashmem_write(const void* from, flash_addr_t toaddr, uint32_t size);
 
uint32_t flashmem_read(void* to, flash_addr_t fromaddr, uint32_t size);
 
bool flashmem_erase_sector(flash_sector_t sector_id);
 
SPIFlashInfo flashmem_get_info(void);
 
SPIFlashSize flashmem_get_size_type(void);
 
flash_addr_t flashmem_get_size_bytes(void);
 
flash_sector_t flashmem_get_size_sectors(void);
 
flash_sector_t flashmem_find_sector(flash_addr_t address, flash_addr_t* pstart, flash_addr_t* pend);
 
flash_sector_t flashmem_get_sector_of_address(flash_addr_t addr);
 
/*
 * @brief Returns the address of the first free block on flash
 * @retval  uint32_t The actual address on flash
 * @deprecated Partition tables make this function obsolete.
 */
inline uint32_t SMING_DEPRECATED flashmem_get_first_free_block_address(void)
{
    return 0;
}
 
/*
 * @brief Get unique 32-bit flash identification code
 */
uint32_t spi_flash_get_id(void);
 
#ifdef __cplusplus
}
#endif