Introduced ringbuf_init to perform static buffer initialisation #5813
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.
In some use cases like debugging over UART, if DEBUG_TX/DEBUG_RX are defined, the static buffer is provided by
serial_early_init
with the call ofcommon_hal_busio_uart_construct
.Mircopython originally recommended to use list of initialisers instead of calling
ringbuf_alloc
in case the buffer cannot be allocated from heap internally and static buffer must be provided by user code.In the meantime the ring buffer interface has been modified in micropython project.
This approach can be error prone because the user code relies on certain order of structure members.
Initialising the structure with designators addresses this issue but then the names of structure members are exposed.
Using dedicated function is cleaner and more portable way of initialisation.
The overhead is single
bool
structure member.Appending this member to the structure preserves the backward compatibility with initialiser list approach.