reference/machine: added eeprom reference and machine docs #317
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
These aren't necessary anymore with LLD support for Xtensa.
These are not necessary anymore.
Also update the text a bit.
SoleimanyBen
force-pushed
the
eeprom-doc
branch
from
736a42f to
4ec3e72
Compare
aykevl
reviewed
Jan 19, 2023
Comment on lines
+10
to
+12
| The EEPROM is a form of non-volatile memory that is uusually integrated along side an MCU. EEPROMs allows you to store a relatively small amount of data by allowing bytes to be erased and reprogrammed. For the most part, EEPROMs are not integrated directly onto a board, but in some cases they are provided as a standard peripheral. | ||
|
|
||
| Although it may seem useful to have some type of data storage for your applications, the EEPROM is often limited in the amount of write cycles that it contains. This means that after a certain amount of writes, the EEPROM will not writeable, but you may still read data from it. |
There was a problem hiding this comment.
EEPROMs are almost always included directly on the chip, I think?
Also, here is a suggestion for the text:
Suggested change
| The EEPROM is a form of non-volatile memory that is uusually integrated along side an MCU. EEPROMs allows you to store a relatively small amount of data by allowing bytes to be erased and reprogrammed. For the most part, EEPROMs are not integrated directly onto a board, but in some cases they are provided as a standard peripheral. | |
| Although it may seem useful to have some type of data storage for your applications, the EEPROM is often limited in the amount of write cycles that it contains. This means that after a certain amount of writes, the EEPROM will not writeable, but you may still read data from it. | |
| An EEPROM is a form of non-volatile memory that is usually integrated in an MCU. EEPROMs allow you to store relatively small amounts of data by allowing bytes to be erased and reprogrammed. | |
| EEPROMs, like flash, can only be written a limited number of times but are not limited in how often they can be read. Therefore, they are mainly useful to store configuration values that do not change very often. The difference with flash is that individual bytes can be erased and that they usually have a longer lifespan. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
relates to tinygo-org/tinygo#3306
Added machine API, reference, and peripheral concept docs for the
EEPROM.I used the other docs as examples on where I should be placing things, so if something is not in the correct location, just let me know!
The peripheral concept page that I wrote feels a little lackluster, so please let me know if I should change it or add something to it.