Implement Rx/Tx reunification for Serial #390
Open
Conversation
This file contains 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
There are many possible pin combinations for a Serial peripheral. Many support at least one alternative pin group to be used, and in addition to that, each pin can also be configured differently. For instance, instead of the common Output<PushPull> with an Input<Floating>, one could also use Output<OpenDrain> and Input<PullUp>, e.g. when interfacing with a 1-Wire bus. This pin information is already lost when splitting the Serial object into Rx/Tx. In order to allow a reunification into a Serial object which represents ownership of both Tx and Rx, we need a Serial variant which has that pin information erased.
This becomes relevant as more functions like reconfigure are added to the Serial structs. We use the Tx to stash away the usart instance used by the (Erased-)Serial struct, but this choice is arbitrary and irrelevant because it is zero-sized anyway. Fixes stm32-rs#386.
|
Note that this answers some of the design questions in #386 in code. I am using this successfully in my async/await experiments on the STM32VLDISCOVERY board, but I'm open for changing things if you disagree about anything. |
|
Possibly if Tx contain tx_pin and Rx contain rx_pin we will not need ErasedSerial |
|
See #392 |
|
cc @TheZoq2 |
|
Is reconfigure the main goal of reunification for you? |
In this case I can propose easier solution: #393 |
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.
There are many possible pin combinations for a Serial peripheral. Many support at least one alternative pin group to be used, and in addition to that, each pin can also be configured differently. For instance, instead of the common
Output<PushPull>with anInput<Floating>, one could also useOutput<OpenDrain>andInput<PullUp>, e.g. wheninterfacing with a 1-Wire bus.
This pin information is already lost when splitting the Serial object into
Rx/Tx. In order to allow a reunification into a Serial object which represents ownership of bothTxandRx, we need a Serial variant which has that pin information erased.This PR introduces
ErasedSerial, which serves exactly that purpose. In addition,TxandRxboth gain a consumingreunitefunction which restores the originalSerial. To facilitate that and provide the original contents of theErasedSerialstruct, we use theTxto stash away the USART instance -- this choice is arbitrary. As the USART is zero-sized anyway and we get both parts (Rx and Tx) when reuniting, it shouldn't matter where we stash it away.Fixes #386.