-
-
Notifications
You must be signed in to change notification settings - Fork 7.5k
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
docs/spi: add information for data size #2210
Conversation
@@ -66,6 +66,7 @@ Methods | |||
use of ``prescaler`` overrides ``baudrate``. | |||
- ``polarity`` can be 0 or 1, and is the level the idle clock line sits at. | |||
- ``phase`` can be 0 or 1 to sample data on the first or second clock edge | |||
- ``bits`` can be 8 or 16, and is the data size. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would find "and is the data size" part a bit confusing, why I don't merge this and leave for further review/discussion.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
how about:
"bits can be 8 or 16, stands for the data bytes"
or
" bits can be 8 or 16, and is the word size"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it usually called the word size
bits
word size - can be 8 or 16.
Which port are you using that supports 16 bits wide SPI words? |
I use v1.8.1. |
I see, then the stmhal code works by accident, that's nice to know! Regarding the docs, how about: "can be 8 or 16, and is the number of bits in each transferred word" |
Applied with @dpgeorge's wording. |
Hi,
think that was forgotten: data size description of bits in the class SPI. I added the information that the data size can also be 16.