diff options
Diffstat (limited to 'docs/eeprom_driver.md')
-rw-r--r-- | docs/eeprom_driver.md | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/eeprom_driver.md b/docs/eeprom_driver.md index e2c262546..6dcf10c04 100644 --- a/docs/eeprom_driver.md +++ b/docs/eeprom_driver.md | |||
@@ -31,6 +31,9 @@ Currently QMK supports 24xx-series chips over I2C. As such, requires a working i | |||
31 | `#define EXTERNAL_EEPROM_PAGE_SIZE` | Page size of the EEPROM in bytes, as specified in the datasheet | 32 | 31 | `#define EXTERNAL_EEPROM_PAGE_SIZE` | Page size of the EEPROM in bytes, as specified in the datasheet | 32 |
32 | `#define EXTERNAL_EEPROM_ADDRESS_SIZE` | The number of bytes to transmit for the memory location within the EEPROM | 2 | 32 | `#define EXTERNAL_EEPROM_ADDRESS_SIZE` | The number of bytes to transmit for the memory location within the EEPROM | 2 |
33 | `#define EXTERNAL_EEPROM_WRITE_TIME` | Write cycle time of the EEPROM, as specified in the datasheet | 5 | 33 | `#define EXTERNAL_EEPROM_WRITE_TIME` | Write cycle time of the EEPROM, as specified in the datasheet | 5 |
34 | `#define EXTERNAL_EEPROM_WP_PIN` | If defined the WP pin will be toggled appropriately when writing to the EEPROM. | _none_ | ||
35 | |||
36 | Some I2C EEPROM manufacturers explicitly recommend against hardcoding the WP pin to ground. This is in order to protect the eeprom memory content during power-up/power-down/brown-out conditions at low voltage where the eeprom is still operational, but the i2c master output might be unpredictable. If a WP pin is configured, then having an external pull-up on the WP pin is recommended. | ||
34 | 37 | ||
35 | Default values and extended descriptions can be found in `drivers/eeprom/eeprom_i2c.h`. | 38 | Default values and extended descriptions can be found in `drivers/eeprom/eeprom_i2c.h`. |
36 | 39 | ||