esp_flash.h File Reference

#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>
#include "esp_err.h"

Go to the source code of this file.

Data Structures
struct	esp_flash_t

Macros
#define	ESP_ERR_FLASH_NOT_INITIALISED   (ESP_ERR_FLASH_BASE + 1)
#define	ESP_ERR_FLASH_UNSUPPORTED_HOST   (ESP_ERR_FLASH_BASE + 2)
#define	ESP_ERR_FLASH_UNSUPPORTED_CHIP   (ESP_ERR_FLASH_BASE + 3)
#define	ESP_ERR_FLASH_PROTECTED   (ESP_ERR_FLASH_BASE + 4)

Typedefs
typedef struct esp_flash_t	esp_flash_t

Enumerations
enum	esp_flash_io_mode_t {   SPI_FLASH_SLOWRD = 0 ,   SPI_FLASH_FASTRD ,   SPI_FLASH_DOUT ,   SPI_FLASH_DIO ,   SPI_FLASH_QOUT ,   SPI_FLASH_QIO ,   SPI_FLASH_OPI_STR ,   SPI_FLASH_OPI_DTR ,   SPI_FLASH_READ_MODE_MAX }

Functions
esp_err_t	esp_flash_init (esp_flash_t *chip)
esp_err_t	esp_flash_init_os_functions (esp_flash_t *chip, int host_id, int *out_attached_id)
esp_err_t	esp_flash_deinit_os_functions (esp_flash_t *chip)
esp_err_t	esp_flash_read_id (esp_flash_t *chip, uint32_t *out_id)
esp_err_t	esp_flash_get_size (esp_flash_t *chip, uint32_t *out_size)
esp_err_t	esp_flash_get_physical_size (esp_flash_t *chip, uint32_t *out_size)
esp_err_t	esp_flash_read (esp_flash_t *chip, void *buffer, uint32_t address, uint32_t length)
esp_err_t	esp_flash_write (esp_flash_t *chip, const void *buffer, uint32_t address, uint32_t length)
esp_err_t	esp_flash_erase_region (esp_flash_t *chip, uint32_t start, uint32_t len)
esp_err_t	esp_flash_erase_chip (esp_flash_t *chip)
esp_err_t	esp_flash_read_encrypted (esp_flash_t *chip, uint32_t address, void *out_buffer, uint32_t length)
esp_err_t	esp_flash_write_encrypted (esp_flash_t *chip, uint32_t address, const void *buffer, uint32_t length)

Variables
esp_flash_t *	esp_flash_default_chip

Macro Definition Documentation

ESP_ERR_FLASH_NOT_INITIALISED

#define ESP_ERR_FLASH_NOT_INITIALISED   (ESP_ERR_FLASH_BASE + 1)

ESP_ERR_FLASH_UNSUPPORTED_HOST

#define ESP_ERR_FLASH_UNSUPPORTED_HOST   (ESP_ERR_FLASH_BASE + 2)

ESP_ERR_FLASH_UNSUPPORTED_CHIP

#define ESP_ERR_FLASH_UNSUPPORTED_CHIP   (ESP_ERR_FLASH_BASE + 3)

ESP_ERR_FLASH_PROTECTED

#define ESP_ERR_FLASH_PROTECTED   (ESP_ERR_FLASH_BASE + 4)

Typedef Documentation

esp_flash_t

typedef struct esp_flash_t esp_flash_t

Enumeration Type Documentation

esp_flash_io_mode_t

enum esp_flash_io_mode_t

Enumerator
SPI_FLASH_SLOWRD
SPI_FLASH_FASTRD
SPI_FLASH_DOUT
SPI_FLASH_DIO
SPI_FLASH_QOUT
SPI_FLASH_QIO
SPI_FLASH_OPI_STR
SPI_FLASH_OPI_DTR
SPI_FLASH_READ_MODE_MAX

Function Documentation

esp_flash_init()

esp_err_t esp_flash_init ( esp_flash_t *  chip )

extern

esp_flash_init_os_functions()

esp_err_t esp_flash_init_os_functions ( esp_flash_t *  chip, int  host_id, int *  out_attached_id  )

extern

esp_flash_deinit_os_functions()

esp_err_t esp_flash_deinit_os_functions ( esp_flash_t *  chip )

extern

esp_flash_read_id()

esp_err_t esp_flash_read_id ( esp_flash_t *  chip, uint32_t *  out_id  )

extern

esp_flash_get_size()

esp_err_t esp_flash_get_size ( esp_flash_t *  chip, uint32_t *  out_size  )

extern

esp_flash_get_physical_size()

esp_err_t esp_flash_get_physical_size ( esp_flash_t *  chip, uint32_t *  out_size  )

extern

esp_flash_read()

esp_err_t esp_flash_read ( esp_flash_t *  chip, void *  buffer, uint32_t  address, uint32_t  length  )

extern

esp_flash_write()

esp_err_t esp_flash_write ( esp_flash_t *  chip, const void *  buffer, uint32_t  address, uint32_t  length  )

extern

esp_flash_erase_region()

esp_err_t esp_flash_erase_region ( esp_flash_t *  chip, uint32_t  start, uint32_t  len  )

extern

esp_flash_erase_chip()

esp_err_t esp_flash_erase_chip ( esp_flash_t *  chip )

extern

esp_flash_read_encrypted()

esp_err_t esp_flash_read_encrypted ( esp_flash_t *  chip, uint32_t  address, void *  out_buffer, uint32_t  length  )

extern

esp_flash_write_encrypted()

esp_err_t esp_flash_write_encrypted ( esp_flash_t *  chip, uint32_t  address, const void *  buffer, uint32_t  length  )

extern

Variable Documentation

esp_flash_default_chip

esp_flash_t* esp_flash_default_chip

extern