drivers/periph: Add documentation on thread safety and initialization #19794
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
github-actions
bot
added
Area: doc
bergzand
reviewed
Jul 4, 2023
maribu
requested review from
chrysn,
haukepetersen,
benpicco,
aabadie and
kaspar030
chrysn
added
the
CI: ready for build
maribu
added
the
CI: skip compile test
chrysn
approved these changes
Jul 5, 2023
| @@ -16,6 +16,64 @@ | |||
| * defines a standardized interface to access MCU peripherals that is not tied | |||
| * to any specific vendor, platform or architecture. | |||
| * | |||
| * # Initialization and Thread Safety | |||
There was a problem hiding this comment.
Thread gets turned into a hyperlink thanks to automagic and mqtt paho.
Not sure whether there is anything we can do here -- escaping the word is probably a whack-a-mole...
| * | `periph_dac` | user / driver | Partial (no concurrent use of the same DAC line allowed) | | ||
| * | `periph_eeprom` | not needed | None (no concurrency whatsoever) | | ||
| * | `periph_flashpage` | not needed | None (no concurrency whatsoever) | | ||
| * | `periph_gpio` | not needed | Limited (reads are fine, concurrent writes to pins on distinct ports work) | |
There was a problem hiding this comment.
Suggested change
| * | `periph_gpio` | not needed | Limited (reads are fine, concurrent writes to pins on distinct ports work) | | |
| * | `periph_gpio` | not needed | Limited (reads are fine, concurrent writes to pins are allowed on distinct ports) | |
A lot of things work that are not allowed.
|
bors merge |
|
👎 Rejected by PR status |
|
Please squash! |
maribu
added
CI: ready for build
|
bors merge |
|
bors cancel |
|
Canceled. |
|
bors merge |
|
Build succeeded! The publicly hosted instance of bors-ng is deprecated and will go away soon. If you want to self-host your own instance, instructions are here. If you want to switch to GitHub's built-in merge queue, visit their help page. |
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.
Contribution description
As the title says.
Testing procedure
The CI will generate a doc preview that can be reviewed.
Issues/PRs references
None