Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

reference/machine: added eeprom reference and machine docs #317

Open
wants to merge 4 commits into
base: dev
Choose a base branch
from

Conversation

SoleimanyBen
Copy link

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.

Copy link
Member

@aykevl aykevl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants