summaryrefslogtreecommitdiffstats
path: root/docs/flash_driver.md
diff options
context:
space:
mode:
authorJoy Lee <chang.li@westberrytech.com>2022-02-12 04:26:16 +0800
committerGitHub <noreply@github.com>2022-02-11 20:26:16 +0000
commit71c0b97bced7722abaa0adefd57066cc065538b5 (patch)
tree6f50c8a53fb7a7faae949154351be658ce5144e8 /docs/flash_driver.md
parent00cc64638c7ffa90b1acc10c420daaa3795a87ba (diff)
Added external spi flash driver. (#15419)
Diffstat (limited to 'docs/flash_driver.md')
-rw-r--r--docs/flash_driver.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/flash_driver.md b/docs/flash_driver.md
new file mode 100644
index 0000000000..fa7fed5171
--- /dev/null
+++ b/docs/flash_driver.md
@@ -0,0 +1,24 @@
+# FLASH Driver Configuration :id=flash-driver-configuration
+
+The FLASH driver can be swapped out depending on the needs of the keyboard, or whether extra hardware is present.
+
+Driver | Description
+-----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+`FLASH_DRIVER = spi` | Supports writing to almost all NOR Flash chips. See the driver section below.
+
+
+## SPI FLASH Driver Configuration :id=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` override | Description | Default Value
+-----------------------------------------------|--------------------------------------------------------------------------------------|-----------------
+`#define EXTERNAL_FLASH_SPI_SLAVE_SELECT_PIN` | SPI Slave select pin in order to inform that the FLASH is currently being addressed | _none_
+`#define EXTERNAL_FLASH_SPI_CLOCK_DIVISOR` | Clock divisor used to divide the peripheral clock to derive the SPI frequency | `8`
+`#define EXTERNAL_FLASH_PAGE_SIZE` | The Page size of the FLASH in bytes, as specified in the datasheet | `256`
+`#define EXTERNAL_FLASH_SECTOR_SIZE` | The sector size of the FLASH in bytes, as specified in the datasheet | `(4 * 1024)`
+`#define EXTERNAL_FLASH_BLOCK_SIZE` | The block size of the FLASH in bytes, as specified in the datasheet | `(64 * 1024)`
+`#define EXTERNAL_FLASH_SIZE` | The total size of the FLASH in bytes, as specified in the datasheet | `(512 * 1024)`
+`#define EXTERNAL_FLASH_ADDRESS_SIZE` | The Flash address size in bytes, as specified in datasheet | `3`
+
+!> All the above default configurations are based on MX25L4006E NOR Flash.