flashmem.h File Reference
#include <esp_attr.h>
#include <sming_attr.h>
#include <stdint.h>
Include dependency graph for flashmem.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  SPIFlashInfo
 SPI Flash memory information block. More...
 

Macros

#define INTERNAL_FLASH_WRITE_UNIT_SIZE   4
 
#define INTERNAL_FLASH_READ_UNIT_SIZE   4
 
#define FLASH_TOTAL_SEC_COUNT   (flashmem_get_size_sectors())
 

Typedefs

typedef uintptr_t flash_addr_t
 
typedef uint32_t flash_sector_t
 

Functions

flash_addr_t flashmem_get_address (const void *memptr)
 Obtain the flash memory address for a memory pointer. More...
 
uint32_t flashmem_write (const void *from, flash_addr_t toaddr, uint32_t size)
 Write a block of data to flash. More...
 
uint32_t flashmem_read (void *to, flash_addr_t fromaddr, uint32_t size)
 Read a block of data from flash. More...
 
bool flashmem_erase_sector (flash_sector_t sector_id)
 Erase a single flash sector. More...
 
SPIFlashInfo flashmem_get_info (void)
 Get flash memory information block. More...
 
SPIFlashSize flashmem_get_size_type (void)
 Returns a number indicating the size of flash memory chip. More...
 
flash_addr_t flashmem_get_size_bytes (void)
 get the total flash memory size More...
 
flash_sector_t flashmem_get_size_sectors (void)
 Get the total number of flash sectors. More...
 
flash_sector_t flashmem_find_sector (flash_addr_t address, flash_addr_t *pstart, flash_addr_t *pend)
 Helper function: find the flash sector in which an address resides. More...
 
flash_sector_t flashmem_get_sector_of_address (flash_addr_t addr)
 Get sector number containing the given address. More...
 
uint32_t flashmem_get_first_free_block_address (void)
 
uint32_t spi_flash_get_id (void)
 

Typedef Documentation

◆ flash_addr_t

typedef uintptr_t flash_addr_t

◆ flash_sector_t

typedef uint32_t flash_sector_t