fix(PeriphDrivers): Fix UART RevB Driver not cleaning up Async Transactions #1334
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.
Description
Currently, the private AsyncTxRequests and AsyncRxRequests arrays are used to track transactions in progress for uart_revb.c. The Tx/Rx Async Callbacks check for a callback function before clearing the Requests:
This means that if the user does not supply an explicit callback function, a transaction never gets cleared, causing problems after just one transaction.
This commit resolves this by moving the cleanup of this important struct outside of the conditional check for a callback function.
Testing
This was tested as part of development for UART functionality in the CircuitPython BUSIO.UART module:
https://github.com/Brandon-Hurst/circuitpython/blob/ports/analog/add-busio/ports/analog/common-hal/busio/UART.c
I found that it was necessary to submit a callback function for the Async API to work correctly. This fix is to correct this, so the user doesn't have to supply a callback to have the Async Requests cleaned up.
Checklist Before Requesting Review