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

Documentation: RP2040 Datasheet - IC_SDA_HOLD Register #129

Closed
fivdi opened this issue Mar 22, 2021 · 3 comments
Closed

Documentation: RP2040 Datasheet - IC_SDA_HOLD Register #129

fivdi opened this issue Mar 22, 2021 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation question Further information is requested rp2040 Concerning the RP2040 chip

Comments

@fivdi
Copy link

fivdi commented Mar 22, 2021

The following sentence is the last sentence on page 511 of release 1.3.1 of the RP2040 Datasheet and is part of the description of the IC_SDA_HOLD Register.

The value programmed in IC_SDA_TX_HOLD must be greater than the minimum hold time in each mode one cycle in master mode, seven cycles in slave mode for the value to be implemented.

There is something wrong with the punctuation and/or structure of this sentence making it difficult to understand.

@lurch
Copy link
Contributor

lurch commented Mar 22, 2021

The part you're referring to is documentation automatically extracted from the IPXACT file that comes with the Synopsys I2C controller. As it notes at the start of section 4.3:

Synopsys Documentation
Synopsys Proprietary. Used with permission.

I wonder if it might have lost some brackets? 🤷 "The value programmed in IC_SDA_TX_HOLD must be greater than the minimum hold time in each mode (one cycle in master mode, seven cycles in slave mode) for the value to be implemented."

I'll double-check tomorrow to check that it's not an error in the document-processing that we do on "our side".

@lurch lurch added documentation Improvements or additions to documentation question Further information is requested rp2040 Concerning the RP2040 chip labels Mar 22, 2021
@lurch lurch self-assigned this Mar 22, 2021
@fivdi
Copy link
Author

fivdi commented Mar 23, 2021

I wonder if it might have lost some brackets? shrug "The value programmed in IC_SDA_TX_HOLD must be greater than the minimum hold time in each mode (one cycle in master mode, seven cycles in slave mode) for the value to be implemented."

Yes, those brackets would fix it.

@lurch
Copy link
Contributor

lurch commented Apr 9, 2021

I checked last week, and even the Synopsys databook says "The value programmed in IC_SDA_TX_HOLD must be greater than the minimum hold time in each mode one cycle in master mode, seven cycles in slave mode for the value to be implemented" 😕

But one of the hardware engineers agrees that the sentence makes more sense with the brackets inserted, so that's what will be appearing in the next version of our PDF documentation 😃

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation question Further information is requested rp2040 Concerning the RP2040 chip
Projects
None yet
Development

No branches or pull requests

2 participants