[sensor] Clarification of sensor HAL behavior at deactivation

Sensor HAL should abandon stale data at deactivation.

Test: documentation change, spell checked.
Bug: 28443809

Change-Id: I29b1d324fc96d0448cdefbf2130161f71c3d3310
This commit is contained in:
Peng Xu
2016-10-05 14:56:54 -07:00
parent 4074ce1408
commit aaeeaa41bd

View File

@@ -1308,11 +1308,16 @@ typedef struct sensors_poll_device_1 {
struct {
struct hw_device_t common;
/* Activate/de-activate one sensor. Return 0 on success, negative
/* Activate/de-activate one sensor.
*
* sensor_handle is the handle of the sensor to change.
* enabled set to 1 to enable, or 0 to disable the sensor.
*
* After sensor de-activation, existing sensor events that have not
* been picked up by poll() should be abandoned immediately so that
* subsequent activation will not get stale sensor events (events
* that is generated prior to the latter activation).
*
* Return 0 on success, negative errno code otherwise.
*/
int (*activate)(struct sensors_poll_device_t *dev,