From 55bcab889d3f987799201dd5aaef599ab469e36a Mon Sep 17 00:00:00 2001 From: Alexander Apostolu Date: Fri, 17 Oct 2025 16:15:46 -0400 Subject: [PATCH] include: zephyr: drivers: sensor.h: updated doxygen for get_frame_count Updated Doxygen for sensor_decoder_api.get_frame_count(). * Reworded grammar * Changed channel to chan_spec to reflect data type * Changed return value from ENOTSUP to EINVAL to be consistent with sensor_decoder_api.decode() Signed-off-by: Alexander Apostolu --- include/zephyr/drivers/sensor.h | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/include/zephyr/drivers/sensor.h b/include/zephyr/drivers/sensor.h index f6ef9b48ef3d1..0546543c5e2b0 100644 --- a/include/zephyr/drivers/sensor.h +++ b/include/zephyr/drivers/sensor.h @@ -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); /**