acassis commented on code in PR #17264: URL: https://github.com/apache/nuttx/pull/17264#discussion_r2514022151
########## Documentation/components/drivers/special/mtd.rst: ########## @@ -127,17 +127,17 @@ FTL behavior: EEPROM ====== -EEPROMs are a form of Memory Technology Device (MTD). EEPROMs are non- -volatile memory like FLASH, but differ in underlying memory technology and -differ in usage in many respects: They may not be organized into blocks -(at least from the standpoint of the user) and it is not necessary to -erase the EEPROM memory before re-writing it. In addition, EEPROMs tend -to be much smaller than FLASH parts, usually only a few kilobytes vs -megabytes for FLASH. EEPROM tends to be used to retain a small amount of -device configuration information; FLASH tends to be used for program or -massive data storage. For these reasons, it may not be convenient to use -the more complex MTD interface but instead use the simple character -interface provided by the EEPROM drivers. See drivers/eeprom. +SPI EEPROMs using the same commands as the Microchip 25xxxx family, and I2C +EEPROMs using the same commands as the Microchip 24xxxx family can be +interfaced using the `drivers/mtd/at25ee.c` and `drivers/mtd/at24xx.c` driver +respectively. + +Refer to the :doc:` EEPROM character driver reference <../character/eeprom>` +for + +- the differences between EEPROM and FLASH memory; +- the list of supported EEPROM variants; +- interfacing EEPROM using a character driver. Review Comment: Please include an explanation when to use MTD or character driver: i.e. "if you want to have directly control over the eeprom (opening the /dev/at24 and reading/writing to it) without relying on MTD you can consider using the character driver instead. It could be the case when you just want to save some parameter of an application directly to EEPROM without mounting the EEPROM with a filesystem." ########## Documentation/components/drivers/special/mtd.rst: ########## @@ -127,17 +127,17 @@ FTL behavior: EEPROM ====== -EEPROMs are a form of Memory Technology Device (MTD). EEPROMs are non- -volatile memory like FLASH, but differ in underlying memory technology and -differ in usage in many respects: They may not be organized into blocks -(at least from the standpoint of the user) and it is not necessary to -erase the EEPROM memory before re-writing it. In addition, EEPROMs tend -to be much smaller than FLASH parts, usually only a few kilobytes vs -megabytes for FLASH. EEPROM tends to be used to retain a small amount of -device configuration information; FLASH tends to be used for program or -massive data storage. For these reasons, it may not be convenient to use -the more complex MTD interface but instead use the simple character -interface provided by the EEPROM drivers. See drivers/eeprom. +SPI EEPROMs using the same commands as the Microchip 25xxxx family, and I2C +EEPROMs using the same commands as the Microchip 24xxxx family can be +interfaced using the `drivers/mtd/at25ee.c` and `drivers/mtd/at24xx.c` driver +respectively. + +Refer to the :doc:` EEPROM character driver reference <../character/eeprom>` +for + +- the differences between EEPROM and FLASH memory; +- the list of supported EEPROM variants; +- interfacing EEPROM using a character driver. Review Comment: Please include an explanation when to use MTD or character driver: i.e. "if you want to have directly control over the eeprom (opening the /dev/at24 and reading/writing to it) without relying on MTD you can consider using the character driver instead. It could be the case when you just want to save some parameters of an application directly to EEPROM without mounting the EEPROM with a filesystem." -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
