Skip to content

FLASH Driver Configuration

The FLASH driver can be swapped out depending on the needs of the keyboard, or whether extra hardware is present.

DriverDescription
FLASH_DRIVER = spiSupports writing to almost all NOR Flash chips. See the driver section below.

SPI FLASH Driver Configuration

Currently QMK supports almost all NOR Flash chips over SPI. As such, requires a working spi_master driver configuration. You can override the driver configuration via your config.h:

config.h overrideDescriptionDefault Value
#define EXTERNAL_FLASH_SPI_SLAVE_SELECT_PINSPI Slave select pin in order to inform that the FLASH is currently being addressednone
#define EXTERNAL_FLASH_SPI_CLOCK_DIVISORClock divisor used to divide the peripheral clock to derive the SPI frequency8
#define EXTERNAL_FLASH_PAGE_SIZEThe Page size of the FLASH in bytes, as specified in the datasheet256
#define EXTERNAL_FLASH_SECTOR_SIZEThe sector size of the FLASH in bytes, as specified in the datasheet(4 * 1024)
#define EXTERNAL_FLASH_BLOCK_SIZEThe block size of the FLASH in bytes, as specified in the datasheet(64 * 1024)
#define EXTERNAL_FLASH_SIZEThe total size of the FLASH in bytes, as specified in the datasheet(512 * 1024)
#define EXTERNAL_FLASH_ADDRESS_SIZEThe Flash address size in bytes, as specified in datasheet3

WARNING

All the above default configurations are based on MX25L4006E NOR Flash.