OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity

drivers: sensor: Document blocking behavior of sample fetch functions 

Updates the sensor driver API documentation to explicitly state that
sample fetch functions block until the fetch operation is complete.

Fixes #53728

Signed-off-by: Maureen Helm <maureen.helm@intel.com>
This commit is contained in:
Maureen Helm 2023-03-01 16:09:51 -06:00 committed by Anas Nashif
parent 1eb0452fcb
commit a87e4c254b
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
include/zephyr/drivers/sensor.h
View File

@ -506,6 +506,8 @@ static inline int sensor_trigger_set(const struct device *dev,
* may then get individual channel values by calling @ref
* sensor_channel_get.
*
* The function blocks until the fetch operation is complete.
*
* Since the function communicates with the sensor device, it is unsafe
* to call it in an ISR if the device is connected via I2C or SPI.
*
@ -534,6 +536,8 @@ static inline int z_impl_sensor_sample_fetch(const struct device *dev)
* This is mostly implemented by multi function devices enabling reading at
* different sampling rates.
*
* The function blocks until the fetch operation is complete.
*
* Since the function communicates with the sensor device, it is unsafe
* to call it in an ISR if the device is connected via I2C or SPI.
*