esp-idf-w25q64

SPI Flash Memory W25Q64 Access Library for esp-idf.
I ported from here.

Software requirements

esp-idf v4.4 or later.
This is because this version supports ESP32-C3.

Installation for ESP32

git clone https://github.com/nopnop2002/esp-idf-w25q64
cd esp-idf-w25q64
idf.py set-target esp32
idf.py menuconfig
idf.py flash

Installation for ESP32-S2

git clone https://github.com/nopnop2002/esp-idf-w25q64
cd esp-idf-w25q64
idf.py set-target esp32s2
idf.py menuconfig
idf.py flash

Installation for ESP32-C3

git clone https://github.com/nopnop2002/esp-idf-w25q64
cd esp-idf-w25q64
idf.py set-target esp32c3
idf.py menuconfig
idf.py flash

Note
For some reason, there are development boards that cannot use GPIO06, GPIO08, GPIO09, GPIO19 for SPI clock pins.
According to the ESP32C3 specifications, these pins can also be used as SPI clocks.
I used a raw ESP-C3-13 to verify that these pins could be used as SPI clocks.

Configuration

You have to set this config value with menuconfig.

• CONFIG_MISO_GPIO
  GPIO number(IOxx) to MISO.
• CONFIG_MOSI_GPIO
  GPIO number(IOxx) to MOSI.
• CONFIG_SCLK_GPIO
  GPIO number(IOxx) to SCLK.
• CONFIG_CS_GPIO
  GPIO number(IOxx) to CS.

Wireing

You can change it to any pin using menuconfig.
But it may not work with other GPIOs.

API

// Start Flash
void spi_master_init(W25Q64_t * dev, int GPIO_CS);

// Get status register1
esp_err_t W25Q64_readStatusReg1(W25Q64_t * dev, uint8_t * reg1);

// Get status register2(Winbond only)
esp_err_t W25Q64_readStatusReg2(W25Q64_t * dev, uint8_t * reg2);

// Get Unique ID(Winbond only)
esp_err_t W25Q64_readUniqieID(W25Q64_t * dev, uint8_t * id);

// Get JEDEC ID(Manufacture, Memory Type,Capacity)
esp_err_t W25Q64_readManufacturer(W25Q64_t * dev, uint8_t * id);

// Check busy
bool W25Q64_IsBusy(W25Q64_t * dev);

// Set power down mode
esp_err_t W25Q64_powerDown(W25Q64_t * dev);;

// Set write enable
esp_err_t W25Q64_WriteEnable(W25Q64_t * dev);

// Set write disable
esp_err_t W25Q64_WriteDisable(W25Q64_t * dev);

// Read data from memory
uint16_t W25Q64_read(W25Q64_t * dev, uint32_t addr, uint8_t *buf, uint16_t n);

// First read data from memory
uint16_t W25Q64_fastread(W25Q64_t * dev, uint32_t addr, uint8_t *buf, uint16_t n);

// Erase data by Sector
bool W25Q64_eraseSector(W25Q64_t * dev, uint16_t sect_no, bool flgwait);

// Erase data by block(64KB)
bool W25Q64_erase64Block(W25Q64_t * dev, uint16_t blk_no, bool flgwait);

// Erase data by Block(32KB)
bool W25Q64_erase32Block(W25Q64_t * dev, uint16_t blk_no, bool flgwait);

// Erase all data
bool W25Q64_eraseAll(W25Q64_t * dev, bool flgwait);

// Write data to memory
int16_t W25Q64_pageWrite(W25Q64_t * dev, uint16_t sect_no, uint16_t inaddr, uint8_t* buf, int16_t n);

Winbond

W25Q80

• Manufacturer:
  Byte1 : ManufacturerID(0xef=Winbond)
  Byte2 : MemoryType(0x40=SPI/0x60=QPI)
  Byte3 : Capacity(2^0x14=2^20=0x100000=1M Byte=8M Bit)
• First 10Byte : ASCII 0-9
• Next 32Byte : ASCII A-Z

W25Q16

W25Q32

W24Q64

W25Q128

MACRONIX

MX25L3206E

• Manufacturer:
  Byte1 : ManufacturerID(0xc2=Macronix)
  Byte2 : MemoryType(0x20)
  Byte3 : Capacity(2^0x16=2^22=0x400000=4M Byte=32M Bit)

MX25L6473E

MX25L12835F

Note

I tested these.
But I couldn't get it working.

• GD25Q64
• SST25VF016B
• SST25VF032B

Note

There is a example to build a FAT file system on External SPI FLSAH Memory is available here.
The ESP32's onboard FLASH is 4MByte, and you can reserve up to about 3MByte of storage on the onboard FLASH.
With the large capacity SPI FLSAH Memory, you can add a large amount of storage.