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.

Sign up for GitHub

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

Jump to bottom

migrate document from doxygen to reStructuredText #6

Closed
hathach opened this issue Apr 20, 2018 · 4 comments
Closed

migrate document from doxygen to reStructuredText #6

hathach opened this issue Apr 20, 2018 · 4 comments
Labels
Feature 💡

Comments

@hathach
Copy link
Owner

hathach commented Apr 20, 2018

Info https://docs.readthedocs.io/en/latest/getting_started.html
@tannewt
Copy link
Collaborator

tannewt commented Apr 20, 2018

I do a good amount of rST with ReadTheDocs so feel free to ask any questions.

@hathach
Copy link
Owner Author

hathach commented Apr 20, 2018 •
edited
Loading

@tannewt thanks Scott, this is more like a reminder for myself. There is already too many code to write :( .

@hathach hathach added this to the 0.5.0 milestone May 20, 2019
@hathach hathach removed this from the 0.5.0 milestone Nov 24, 2019
@hathach hathach mentioned this issue Jul 17, 2021
Closed
@perigoso
Copy link
Collaborator

perigoso commented Aug 4, 2021

Is this technically done with #983 ?

@hathach
Copy link
Owner Author

hathach commented Aug 4, 2021

yeah, I think this can technically be closed. There is always more docs to write much like codes. Thanks again.

@hathach hathach closed this as completed Aug 4, 2021
jbtheou pushed a commit to jbtheou/tinyusb that referenced this issue Apr 28, 2023
cdc: fix line_coding aligment
8f47976 
While calling tud_cdc_n_get_line_coding, the structure is copied into
the destination.

Dump of assembler code for function tud_cdc_n_get_line_coding:
   0x000193f4 <+0>:	mov.w	r2, hathach#2112	@ 0x840
0x000193f8 <+4>:	ldr	r3, [pc, hathach#20]	@ (0x19410
<tud_cdc_n_get_line_coding+28>)
   0x000193fa <+6>:	mla	r0, r2, r0, r3
=> 0x000193fe <+10>:	ldr.w	r3, [r0, hathach#6]
   0x00019402 <+14>:	str	r3, [r1, #0]

On some platform (tested on LPC55S28), the address needs to be 4-bytes
aligned. Without this, the address is

(gdb) p &_cdcd_itf.line_coding
$3 = (cdc_line_coding_t *) 0x40100006 <_cdcd_itf+6>

which leads to a HardFault. With this fix

(gdb) p &_cdcd_itf.line_coding
$5 = (cdc_line_coding_t *) 0x40100008 <_cdcd_itf+8>

and the function can be called properly

Signed-off-by: Jean-Baptiste Theou <[email protected]>
@jbtheou jbtheou mentioned this issue Apr 28, 2023
Merged
@tannewt tannewt mentioned this issue Jul 22, 2023
Closed
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Feature 💡
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@tannewt @hathach @perigoso