Added FLASH_DRIVER configuration

qmk · Dec 7, 2021 · d6f89b7 · d6f89b7
1 parent d8dd74d
commit d6f89b7
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 1 deletion.
diff --git a/common_features.mk b/common_features.mk
@@ -201,6 +201,18 @@ else
   endif
 endif
 
+VALID_FLASH_DRIVER_TYPES := spi
+ifeq ($(filter $(FLASH_DRIVER),$(VALID_FLASH_DRIVER_TYPES)),)
+  $(error FLASH_DRIVER="$(FLASH_DRIVER)" is not a valid FLASH driver)
+else
+  OPT_DEFS += -DFLASH_ENABLE
+  ifeq ($(strip $(EEPROM_DRIVER)), spi)
+    OPT_DEFS += -DFLASH_DRIVER -DFLASH_SPI
+    COMMON_VPATH += $(DRIVER_PATH)/flash
+    SRC += flash_spi.c
+  endif
+endif
+
 RGBLIGHT_ENABLE ?= no
 VALID_RGBLIGHT_TYPES := WS2812 APA102 custom
 

diff --git a/docs/flash_driver.md b/docs/flash_driver.md
@@ -1,4 +1,13 @@
-# SPI FLASH Driver Configuration :id=spi-flash-driver-configuration
+# 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: