diff options
| author | Purdea Andrei <andrei@purdea.ro> | 2021-06-22 05:34:28 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-06-21 19:34:28 -0700 |
| commit | dd16d3cc7e427c5256f5d2089d0cc2b6bbc776e1 (patch) | |
| tree | 7be0f07db5a88c4939354d717e8e600fab6f1ab4 /docs/eeprom_driver.md | |
| parent | 0e3ae2cde033969507355abcb85f5f7aba2ae978 (diff) | |
eeprom_i2c driver: added EXTERNAL_EEPROM_WP_PIN configuration option. (#12617)
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 e2c262546d..6dcf10c04d 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 `#define EXTERNAL_EEPROM_PAGE_SIZE` | Page size of the EEPROM in bytes, as specified in the datasheet | 32 `#define EXTERNAL_EEPROM_ADDRESS_SIZE` | The number of bytes to transmit for the memory location within the EEPROM | 2 `#define EXTERNAL_EEPROM_WRITE_TIME` | Write cycle time of the EEPROM, as specified in the datasheet | 5 +`#define EXTERNAL_EEPROM_WP_PIN` | If defined the WP pin will be toggled appropriately when writing to the EEPROM. | _none_ + +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. Default values and extended descriptions can be found in `drivers/eeprom/eeprom_i2c.h`. |