aboutsummaryrefslogtreecommitdiff
path: root/docs/flash_driver.md
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2024-05-30 02:01:09 +0000
committerQMK Bot <hello@qmk.fm>2024-05-30 02:01:09 +0000
commit47356b220101b4f5b8ca71b2e1aa4f04256dd60f (patch)
tree7cf20bd01edf0285053cd9548944fd4133a27567 /docs/flash_driver.md
parentb36c7b99ae57e8d848373f44755510308c4eefa3 (diff)
parent6ef97172889ccd5db376b2a9f8825489e24fdac4 (diff)
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'docs/flash_driver.md')
-rw-r--r--docs/flash_driver.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/docs/flash_driver.md b/docs/flash_driver.md
index fa7fed5171..4160721350 100644
--- a/docs/flash_driver.md
+++ b/docs/flash_driver.md
@@ -1,4 +1,4 @@
-# FLASH Driver Configuration :id=flash-driver-configuration
+# FLASH Driver Configuration {#flash-driver-configuration}
The FLASH driver can be swapped out depending on the needs of the keyboard, or whether extra hardware is present.
@@ -7,7 +7,7 @@ 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
+## SPI FLASH Driver Configuration {#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:
@@ -21,4 +21,6 @@ Currently QMK supports almost all NOR Flash chips over SPI. As such, requires a
`#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.
+::: warning
+All the above default configurations are based on MX25L4006E NOR Flash.
+:::