include: drivers: haptics: add Doxygen docs for drv2605 #93740
+164
−32
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
kartben
force-pushed
the
drv2605_docs
branch
2 times, most recently
from
041a88d to
8ed2bb5
Compare
Aim for full coverage for the drv2605 device-specific haptics API. Signed-off-by: Benjamin Cabé <[email protected]>
Add a macro to simplify the creation of wait/delay values for the waveform sequencer. Signed-off-by: Benjamin Cabé <[email protected]>
|
| * 10 to 1270. | ||
| * @return A byte literal representing the wait time for the sequencer. | ||
| */ | ||
| #define DRV2605_WAVEFORM_SEQUENCER_WAIT_MS(ms) (0x80 | ((ms) / 10)) |
There was a problem hiding this comment.
would it be a good idea to add a CLAMP so ms stays in range?
bjarki-andreasen
approved these changes
Jul 26, 2025
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.
Aim for full coverage for the drv2605 device-specific haptics API.
Also added a macro for generating delay values in the sequencer (and yeah, not in love with its long name but I wanted to be consistent with the other macro)
https://builds.zephyrproject.io/zephyr/pr/93740/docs/doxygen/html/group__drv2605__interface.html