Symbols

loading (4/5)...

Files

loading (4/5)...

Summary Syntax Examples References Instances

SourceVuESP-IDF Framework and ExamplesESP-IDFspi_flash_chip_t

spi_flash_chip_t struct

SPI flash chip driver definition structure. The chip driver structure contains chip-specific pointers to functions to perform SPI flash operations, and some chip-specific numeric values. Do not call chip driver functions directly in other contexts. A generic driver for generic chips and its related operations are defined in spi_flash_chip_generic.h which can be used as building blocks for written new/specific SPI flash chip drivers.

Syntax

Show:

Summary

Declaration

Definition

from esp_flash.h:18

struct spi_flash_chip_t;

Implemented in spi_flash_chip_driver.h:52

Fields

Field

Declared as

Description

spi_flash_chip_t::name

const char *

spi_flash_chip_t::timeout

const flash_chip_op_timeout_t *

spi_flash_chip_t::probe

esp_err_t (*)(esp_flash_t *chip, uint32_t flash_id)

spi_flash_chip_t::reset

esp_err_t (*)(esp_flash_t *chip)

spi_flash_chip_t::detect_size

esp_err_t (*)(esp_flash_t *chip, uint32_t *size)

spi_flash_chip_t::erase_chip

esp_err_t (*)(esp_flash_t *chip)

spi_flash_chip_t::erase_sector

esp_err_t (*)(esp_flash_t *chip, uint32_t sector_address)

spi_flash_chip_t::erase_block

esp_err_t (*)(esp_flash_t *chip, uint32_t block_address)

spi_flash_chip_t::sector_size

uint32_t

spi_flash_chip_t::block_erase_size

uint32_t

spi_flash_chip_t::write

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

spi_flash_chip_t::program_page

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

spi_flash_chip_t::page_size

uint32_t

spi_flash_chip_t::write_encrypted

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

spi_flash_chip_t::wait_idle

esp_err_t (*)(esp_flash_t *chip, uint32_t timeout_us)

spi_flash_chip_t::set_io_mode

esp_err_t (*)(esp_flash_t *chip)

spi_flash_chip_t::get_io_mode

esp_err_t (*)(esp_flash_t *chip, esp_flash_io_mode_t* out_io_mode)

spi_flash_chip_t::read_id

esp_err_t (*)(esp_flash_t *chip, uint32_t* out_chip_id)

spi_flash_chip_t::get_chip_write_protect

esp_err_t (*)(esp_flash_t *chip, bool *out_write_protected)

spi_flash_chip_t::set_chip_write_protect

esp_err_t (*)(esp_flash_t *chip, bool chip_write_protect)

spi_flash_chip_t::num_protectable_regions

uint8_t

spi_flash_chip_t::protectable_regions

const esp_flash_region_t *

spi_flash_chip_t::get_protected_regions

esp_err_t (*)(esp_flash_t *chip, uint64_t *regions)

spi_flash_chip_t::set_protected_regions

esp_err_t (*)(esp_flash_t *chip, uint64_t regions)

spi_flash_chip_t::read

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

spi_flash_chip_t::read_reg

esp_err_t (*)(esp_flash_t *chip, spi_flash_register_t reg_id, uint32_t* out_reg)

spi_flash_chip_t::yield

esp_err_t (*)(esp_flash_t *chip, uint32_t wip)

Yield to other tasks. Called during erase operations.

spi_flash_chip_t::sus_setup

esp_err_t (*)(esp_flash_t *chip)

Setup flash suspend configuration.

spi_flash_chip_t::read_unique_id

esp_err_t (*)(esp_flash_t *chip, uint64_t* flash_unique_id)

Read the chip unique ID.

spi_flash_chip_t::get_chip_caps

spi_flash_caps_t (*)(esp_flash_t *chip)

Get the capabilities of the flash chip. See SPI_FLASH_CHIP_CAP_* macros as reference.

spi_flash_chip_t::config_host_io_mode

esp_err_t (*)(esp_flash_t *chip, uint32_t flags)

Configure the host registers to use the specified read mode set in the ``chip->read_mode``.

Examples

spi_flash_chip_t is referenced by 1 libraries and example projects:

custom_flash_driver sample

References

from 0/1 examples

Code

Location

Scope

Referrer

typedef struct spi_flash_chip_t spi_flash_chip_t;

typedef struct spi_flash_chip_t spi_flash_chip_t;

spi_flash_chip_driver.h:14

struct spi_flash_chip_t {

spi_flash_chip_driver.h:52

struct spi_flash_chip_t;

typedef struct spi_flash_chip_t spi_flash_chip_t;

spi_flash_chip_t

const spi_flash_chip_t *chip_drv; ///< Pointer to chip-model-specific "adapter" structure. If NULL, will be detected during initialisation.

esp_flash_t::chip_drv

const spi_flash_chip_t **drivers = esp_flash_registered_chips;

esp_flash_api.c:498

detect_spi_flash_chip()

const spi_flash_chip_t esp_flash_chip_boya = {

spi_flash_chip_boya.c:51

extern const spi_flash_chip_t esp_flash_chip_boya;

spi_flash_chip_boya.h:21

typedef struct spi_flash_chip_t spi_flash_chip_t;

spi_flash_chip_driver.h:14

spi_flash_chip_t

extern const spi_flash_chip_t **esp_flash_registered_chips;

spi_flash_chip_driver.h:214

static const spi_flash_chip_t *default_registered_chips[] = {

spi_flash_chip_drivers.c:28

extern const spi_flash_chip_t *default_registered_chips[];

spi_flash_chip_drivers.c:57

const spi_flash_chip_t **esp_flash_registered_chips = default_registered_chips;

spi_flash_chip_drivers.c:60

const spi_flash_chip_t esp_flash_chip_gd = {

spi_flash_chip_gd.c:144

extern const spi_flash_chip_t esp_flash_chip_gd;

spi_flash_chip_gd.h:36

const spi_flash_chip_t esp_flash_chip_generic = {

spi_flash_chip_generic.c:649

extern const spi_flash_chip_t esp_flash_chip_generic;

spi_flash_chip_generic.h:264

const spi_flash_chip_t esp_flash_chip_issi = {

spi_flash_chip_issi.c:75

extern const spi_flash_chip_t esp_flash_chip_issi;

spi_flash_chip_issi.h:31

const spi_flash_chip_t esp_flash_chip_mxic = {

spi_flash_chip_mxic.c:71

extern const spi_flash_chip_t esp_flash_chip_mxic;

spi_flash_chip_mxic.h:27

extern const spi_flash_chip_t esp_flash_chip_mxic_opi;

spi_flash_chip_mxic.h:34

const spi_flash_chip_t esp_flash_chip_mxic_opi = {

spi_flash_chip_mxic_opi.c:389

const spi_flash_chip_t esp_flash_chip_th = {

spi_flash_chip_th.c:42

extern const spi_flash_chip_t esp_flash_chip_th;

spi_flash_chip_th.h:13

const spi_flash_chip_t esp_flash_chip_winbond = {

spi_flash_chip_winbond.c:156

extern const spi_flash_chip_t esp_flash_chip_winbond;

spi_flash_chip_winbond.h:27

Call Tree

from 0/1 examples

All items filtered out

All items filtered out

Data Use

from 0/1 examples

All items filtered out

All items filtered out

Class Tree

from 0/1 examples

All items filtered out

All items filtered out

Override Tree

from 0/1 examples

All items filtered out

All items filtered out

Implementations

from 0/1 examples

All items filtered out

All items filtered out

Instances

from 0/1 examples

Instance

Scope

Location

Project

esp_flash_t::chip_drv

esp_flash_registered_chips

spi_flash_chip_driver.h:214

default_registered_chips

spi_flash_chip_drivers.c:28

esp_flash_registered_chips

spi_flash_chip_drivers.c:60

esp_flash_chip_generic

spi_flash_chip_generic.h:264

esp_flash_chip_issi

spi_flash_chip_issi.h:31

esp_flash_chip_mxic

spi_flash_chip_mxic.h:27

esp_flash_chip_mxic_opi

spi_flash_chip_mxic.h:34

esp_flash_chip_gd

spi_flash_chip_gd.h:36

esp_flash_chip_winbond

spi_flash_chip_winbond.h:27

esp_flash_chip_boya

spi_flash_chip_boya.h:21

esp_flash_chip_th

spi_flash_chip_th.h:13

esp_flash_chip_generic

spi_flash_chip_generic.c:649

esp_flash_chip_issi

spi_flash_chip_issi.c:75

esp_flash_chip_mxic

spi_flash_chip_mxic.c:71

esp_flash_chip_gd

spi_flash_chip_gd.c:144

esp_flash_chip_winbond

spi_flash_chip_winbond.c:156

esp_flash_chip_boya

spi_flash_chip_boya.c:51

esp_flash_chip_mxic_opi

spi_flash_chip_mxic_opi.c:389

esp_flash_chip_th

spi_flash_chip_th.c:42

Lifecycle

from 0/1 examples

All items filtered out

All items filtered out