Mark BBBuffer as #[repr(C)] to support alignment #93
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some DMA engines and peripherals require that buffers are precisely aligned. This commit marks BBBuffer as #[repr(C)] so that the buffer is the first member of the struct. With this guarantee, we can align the BBBuffer for our hardware-assisted transfers. Updated documentation shows one way to align the buffer. Tested on an i.MX RT processor, where the DMA engine requires circular buffers that are power-of-two sized and aligned. If I can't align my BBBuffer, I'll treat the BBBuffer as linear memory and schedule multiple transfers to handle split_read wraparound. I'm happy to go this route if this commit isn't appropriate for bbqueue.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Some DMA engines and peripherals require that buffers are precisely
aligned. This commit marks BBBuffer as #[repr(C)] so that the buffer is
the first member of the struct. With this guarantee, we can align the
BBBuffer for our hardware-assisted transfers. Updated documentation
shows one way to align the buffer.
Tested on an i.MX RT processor, where the DMA engine requires circular
buffers that are power-of-two sized and aligned. If I can't align my
BBBuffer, I'll treat the BBBuffer as linear memory and schedule multiple
transfers to handle split_read wraparound. I'm happy to go this route if
this commit isn't appropriate for bbqueue.