Skip to content

include: zephyr: drivers: sensor.h: updated doxygen for get_frame_count #97830

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 22, 2025
+8 −7
Merged

include: zephyr: drivers: sensor.h: updated doxygen for get_frame_count #97830

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions include/zephyr/drivers/sensor.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -484,15 +484,16 @@ static inline bool sensor_chan_spec_eq(struct sensor_chan_spec chan_spec0,
*/
struct sensor_decoder_api {
/**
* @brief Get the number of frames in the current buffer.
* @brief Get the @p frame_count for a specified @p chan_spec from the @p buffer
*
* @param[in] buffer The buffer provided on the @ref rtio context.
* @param[in] channel The channel to get the count for
* @param[out] frame_count The number of frames on the buffer (at least 1)
* @return 0 on success
* @return -ENOTSUP if the channel/channel_idx aren't found
* @param[in] buffer The buffer provided via the @ref rtio context
* @param[in] chan_spec The channel specification to count
* @param[out] frame_count The frame count for a specified @p chan_spec
*
* @retval 0 On success
* @retval -EINVAL Invalid channel specification
*/
int (*get_frame_count)(const uint8_t *buffer, struct sensor_chan_spec channel,
int (*get_frame_count)(const uint8_t *buffer, struct sensor_chan_spec chan_spec,
uint16_t *frame_count);

/**
Expand Down