patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 7 Packages Projects Releases Wiki Activity

drivers: sensor: Document sensor trigger pointer storage in API

Browse source 
Updates the sensor driver API documentation to state that the driver
will store the user-supplied sensor trigger as a pointer rather than a
copy.

Signed-off-by: Maureen Helm <maureen.helm@intel.com>
This commit is contained in:
Maureen Helm 2023-03-07 15:52:21 -06:00 committed by Carles Cufí
parent 7a85983ebc
commit 2da26be77b
1 changed files with 5 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
include/zephyr/drivers/sensor.h
View file

@ -474,6 +474,11 @@ static inline int z_impl_sensor_attr_get(const struct device *dev,
* driver. It is currently up to the caller to ensure that the handler
* does not overflow the stack.
*
* The user-allocated trigger will be stored by the driver as a pointer, rather
* than a copy, and passed back to the handler. This enables the handler to use
* CONTAINER_OF to retrieve a context pointer when the trigger is embedded in a
* larger struct and requires that the trigger is not allocated on the stack.
*
* @funcprops \supervisor
*
* @param dev Pointer to the sensor device