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

Fixed documentation for 8 bit parameters in stm32/f0 usart routines. #651

Closed
wants to merge 1 commit into from

Conversation

ha-ko
Copy link

@ha-ko ha-ko commented Apr 11, 2016

No description provided.

@karlp
Copy link
Member

karlp commented Apr 11, 2016

I'd actually rather see these simply dropped. The type information is already available from the functon signature, adding it in the comments in this cases provides no additional value, and only serves to be out of date.

Further, commits headlines should be something like, "module: summary" so a good rewording of this commit would be "stm32f0: usart: drop incorrect/confusing documentation"

@ha-ko
Copy link
Author

ha-ko commented Apr 11, 2016

Ah, good point, I just stumbled across the conflicting doc for the usart and thought I make a quick fix.
So all unnecessary type descriptions in the stm32f0 documentation should be removed?

Thanks for the feedback and the commit msg style heads up!

@fenugrec
Copy link
Contributor

Problem : the F0 USART can use 9 bits of the USARTx_RDR and _TDR registers ( the extra bit being parity), I assume this is why the other API functions use uint16_t arguments... there are two conflicting declarations of the usart_send(), usart_recv, (+ blocking variants) functions, one in "usart_common_all.h" having uint16_t, , and one for v2 usarts with uint8_t ...

@ha-ko
Copy link
Author

ha-ko commented Apr 12, 2016

This caught my eye yesterday as well.
Is there a reason why the F0 functions are the only ones using 8 instead of 16 bit?

@karlp
Copy link
Member

karlp commented Jan 12, 2017

Going to fix both issues. Dropping all the redundant type info from doxygen, and also fixing all the definitions for the f0 usarts.

@karlp karlp self-assigned this Jan 12, 2017
@karlp karlp mentioned this pull request Jan 12, 2017
karlp added a commit to karlp/libopencm3 that referenced this pull request Jan 12, 2017
Make them 16bit regs, like on other periphs.  This allows proper access
to the "8th" bit.  (0..8 is 9 bits, not 8)

Found and reported in libopencm3#651
karlp added a commit to karlp/libopencm3 that referenced this pull request Jan 12, 2017
Make them 16bit regs, like on other periphs.  This allows proper access
to the "8th" bit.  (0..8 is 9 bits, not 8)

Found and reported in libopencm3#651
karlp added a commit to karlp/libopencm3 that referenced this pull request Mar 6, 2017
Make them 16bit regs, like on other periphs.  This allows proper access
to the "8th" bit.  (0..8 is 9 bits, not 8)

Found and reported in libopencm3#651
karlp added a commit that referenced this pull request Mar 30, 2017
Make them 16bit regs, like on other periphs.  This allows proper access
to the "8th" bit.  (0..8 is 9 bits, not 8)

Found and reported in #651
@karlp
Copy link
Member

karlp commented Mar 30, 2017

this has now landed in 6dd7b3e and 7ee1d94 thanks!

@karlp karlp closed this Mar 30, 2017
BOJIT pushed a commit to BOJIT/PlatformIO-libopencm3 that referenced this pull request Jan 30, 2021
Make them 16bit regs, like on other periphs.  This allows proper access
to the "8th" bit.  (0..8 is 9 bits, not 8)

Found and reported in libopencm3#651
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants