summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJoel Challis <git@zvecr.com>2023-10-23 00:37:27 +0100
committerGitHub <noreply@github.com>2023-10-23 00:37:27 +0100
commitbf6f13a2b0a185e935b8554e41317ab471a4c0ec (patch)
tree23d1f65f68e4ae8c1b236ed8ac5daccfa8ead348 /docs
parent79094d3f72709be3c55bd8f22cc0a7e98f4b6564 (diff)
Consolidate some EEPROM Driver configuration (#22321)
Diffstat (limited to 'docs')
-rw-r--r--docs/eeprom_driver.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/eeprom_driver.md b/docs/eeprom_driver.md
index 34b6f51cbe..c77d18c68d 100644
--- a/docs/eeprom_driver.md
+++ b/docs/eeprom_driver.md
@@ -66,6 +66,14 @@ Currently QMK supports 25xx-series chips over SPI. As such, requires a working s
`#define EXTERNAL_EEPROM_PAGE_SIZE` | `32` | Page size of the EEPROM in bytes, as specified in the datasheet
`#define EXTERNAL_EEPROM_ADDRESS_SIZE` | `2` | The number of bytes to transmit for the memory location within the EEPROM
+Default values and extended descriptions can be found in `drivers/eeprom/eeprom_spi.h`.
+
+Alternatively, there are pre-defined hardware configurations for available chips/modules:
+
+Module | Equivalent `#define` | Source
+-----------------|---------------------------------|------------------------------------------
+MB85RS64V FRAM | `define EEPROM_SPI_MB85RS64V` | <https://www.adafruit.com/product/1897>
+
!> There's no way to determine if there is an SPI EEPROM actually responding. Generally, this will result in reads of nothing but zero.
## Transient Driver configuration :id=transient-eeprom-driver-configuration