1f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project/* 2a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian * Copyright (C) 2012 The Android Open Source Project 3f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * 4f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 5f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * you may not use this file except in compliance with the License. 6f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * You may obtain a copy of the License at 7f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * 8f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 9f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * 10f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 11f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 12f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * See the License for the specific language governing permissions and 14f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * limitations under the License. 15f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project */ 16f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 17f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#ifndef ANDROID_SENSORS_INTERFACE_H 18f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#define ANDROID_SENSORS_INTERFACE_H 19f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 20f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#include <stdint.h> 21f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#include <sys/cdefs.h> 22f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#include <sys/types.h> 23f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 24f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#include <hardware/hardware.h> 2521b652f933b21aa37bd73364b486347fcc333d5cMike Lockwood#include <cutils/native_handle.h> 26f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 27921901725138ed57f5d68f3db0fdababb7e85874Andreas Huber#include "sensors-base.h" 28921901725138ed57f5d68f3db0fdababb7e85874Andreas Huber 29f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project__BEGIN_DECLS 30f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 3156f66ccfb4915b03da4b470916bb2c59bed97216Mathias Agopian/*****************************************************************************/ 3256f66ccfb4915b03da4b470916bb2c59bed97216Mathias Agopian 3356f66ccfb4915b03da4b470916bb2c59bed97216Mathias Agopian#define SENSORS_HEADER_VERSION 1 3456f66ccfb4915b03da4b470916bb2c59bed97216Mathias Agopian#define SENSORS_MODULE_API_VERSION_0_1 HARDWARE_MODULE_API_VERSION(0, 1) 3556f66ccfb4915b03da4b470916bb2c59bed97216Mathias Agopian#define SENSORS_DEVICE_API_VERSION_0_1 HARDWARE_DEVICE_API_VERSION_2(0, 1, SENSORS_HEADER_VERSION) 36a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian#define SENSORS_DEVICE_API_VERSION_1_0 HARDWARE_DEVICE_API_VERSION_2(1, 0, SENSORS_HEADER_VERSION) 3716671c5519003d3be0eab34a8a78fecac9e941a3Mathias Agopian#define SENSORS_DEVICE_API_VERSION_1_1 HARDWARE_DEVICE_API_VERSION_2(1, 1, SENSORS_HEADER_VERSION) 38477fbd5c7d99c54456ceebbe3d9efd33ed5e7747Aravind Akella#define SENSORS_DEVICE_API_VERSION_1_2 HARDWARE_DEVICE_API_VERSION_2(1, 2, SENSORS_HEADER_VERSION) 396242f32a22c42c81d8a9a12885c794d85bf3cf63Aravind Akella#define SENSORS_DEVICE_API_VERSION_1_3 HARDWARE_DEVICE_API_VERSION_2(1, 3, SENSORS_HEADER_VERSION) 406507f5080bc3fdc8d4b23cfa2d73d3602cc60a6aAshutosh Joshi#define SENSORS_DEVICE_API_VERSION_1_4 HARDWARE_DEVICE_API_VERSION_2(1, 4, SENSORS_HEADER_VERSION) 4156f66ccfb4915b03da4b470916bb2c59bed97216Mathias Agopian 42f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project/** 438db1fb408c63f6e57241e68f671b4f0647f1cba9Clay Murphy * Please see the Sensors section of source.android.com for an 448db1fb408c63f6e57241e68f671b4f0647f1cba9Clay Murphy * introduction to and detailed descriptions of Android sensor types: 458db1fb408c63f6e57241e68f671b4f0647f1cba9Clay Murphy * http://source.android.com/devices/sensors/index.html 468db1fb408c63f6e57241e68f671b4f0647f1cba9Clay Murphy */ 478db1fb408c63f6e57241e68f671b4f0647f1cba9Clay Murphy 488db1fb408c63f6e57241e68f671b4f0647f1cba9Clay Murphy/** 49f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * The id of this module 50f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project */ 51f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#define SENSORS_HARDWARE_MODULE_ID "sensors" 52f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 53f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project/** 54f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * Name of the sensors device to open 55f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project */ 56b1e212e7b6fce2bc5c743b05853129e19760d7a4Mathias Agopian#define SENSORS_HARDWARE_POLL "poll" 57f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 58f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project/** 59f144435ef4d42012e9fda01823d4915fb752a7a6Peng Xu * Sensor handle is greater than 0 and less than INT32_MAX. 60f144435ef4d42012e9fda01823d4915fb752a7a6Peng Xu * 61f144435ef4d42012e9fda01823d4915fb752a7a6Peng Xu * **** Deprecated **** 62f144435ef4d42012e9fda01823d4915fb752a7a6Peng Xu * Defined values below are kept for code compatibility. Note sensor handle can be as large as 63f144435ef4d42012e9fda01823d4915fb752a7a6Peng Xu * INT32_MAX. 64f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project */ 65f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#define SENSORS_HANDLE_BASE 0 66f144435ef4d42012e9fda01823d4915fb752a7a6Peng Xu#define SENSORS_HANDLE_BITS 31 6795f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define SENSORS_HANDLE_COUNT (1ull<<SENSORS_HANDLE_BITS) 68f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 69f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 70a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian/* 716242f32a22c42c81d8a9a12885c794d85bf3cf63Aravind Akella * **** Deprecated ***** 72a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian * flags for (*batch)() 73a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian * Availability: SENSORS_DEVICE_API_VERSION_1_0 746242f32a22c42c81d8a9a12885c794d85bf3cf63Aravind Akella * see (*batch)() documentation for details. 756242f32a22c42c81d8a9a12885c794d85bf3cf63Aravind Akella * Deprecated as of SENSORS_DEVICE_API_VERSION_1_3. 766242f32a22c42c81d8a9a12885c794d85bf3cf63Aravind Akella * WAKE_UP_* sensors replace WAKE_UPON_FIFO_FULL concept. 77a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian */ 78a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopianenum { 79a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian SENSORS_BATCH_DRY_RUN = 0x00000001, 80a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian SENSORS_BATCH_WAKE_UPON_FIFO_FULL = 0x00000002 81a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian}; 82a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian 8316671c5519003d3be0eab34a8a78fecac9e941a3Mathias Agopian/* 8416671c5519003d3be0eab34a8a78fecac9e941a3Mathias Agopian * what field for meta_data_event_t 8516671c5519003d3be0eab34a8a78fecac9e941a3Mathias Agopian */ 8616671c5519003d3be0eab34a8a78fecac9e941a3Mathias Agopianenum { 8716671c5519003d3be0eab34a8a78fecac9e941a3Mathias Agopian /* a previous flush operation has completed */ 88921901725138ed57f5d68f3db0fdababb7e85874Andreas Huber // META_DATA_FLUSH_COMPLETE = 1, 89af32a8d59463ddf67154cb432da232cfb185e6bcMathias Agopian META_DATA_VERSION /* always last, leave auto-assigned */ 9016671c5519003d3be0eab34a8a78fecac9e941a3Mathias Agopian}; 9116671c5519003d3be0eab34a8a78fecac9e941a3Mathias Agopian 92a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian/* 93477fbd5c7d99c54456ceebbe3d9efd33ed5e7747Aravind Akella * The permission to use for body sensors (like heart rate monitors). 94477fbd5c7d99c54456ceebbe3d9efd33ed5e7747Aravind Akella * See sensor types for more details on what sensors should require this 95477fbd5c7d99c54456ceebbe3d9efd33ed5e7747Aravind Akella * permission. 96477fbd5c7d99c54456ceebbe3d9efd33ed5e7747Aravind Akella */ 97477fbd5c7d99c54456ceebbe3d9efd33ed5e7747Aravind Akella#define SENSOR_PERMISSION_BODY_SENSORS "android.permission.BODY_SENSORS" 98477fbd5c7d99c54456ceebbe3d9efd33ed5e7747Aravind Akella 99477fbd5c7d99c54456ceebbe3d9efd33ed5e7747Aravind Akella/* 10095f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu * sensor flags legacy names 10195f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu * 10295f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu * please use SENSOR_FLAG_* directly for new implementation. 10395f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu * @see sensor_t 1046507f5080bc3fdc8d4b23cfa2d73d3602cc60a6aAshutosh Joshi */ 1056507f5080bc3fdc8d4b23cfa2d73d3602cc60a6aAshutosh Joshi 106d1562996862712411833171afbb7dcae6fddd1bcPeng Xu#define SENSOR_FLAG_MASK(nbit, shift) (((1<<(nbit))-1)<<(shift)) 107d1562996862712411833171afbb7dcae6fddd1bcPeng Xu#define SENSOR_FLAG_MASK_1(shift) SENSOR_FLAG_MASK(1, shift) 108d1562996862712411833171afbb7dcae6fddd1bcPeng Xu 109d1562996862712411833171afbb7dcae6fddd1bcPeng Xu/* 110d1562996862712411833171afbb7dcae6fddd1bcPeng Xu * Mask and shift for reporting mode sensor flags defined above. 111d1562996862712411833171afbb7dcae6fddd1bcPeng Xu */ 11295f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define REPORTING_MODE_SHIFT SENSOR_FLAG_SHIFT_REPORTING_MODE 113d1562996862712411833171afbb7dcae6fddd1bcPeng Xu#define REPORTING_MODE_NBIT (3) 11495f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define REPORTING_MODE_MASK SENSOR_FLAG_MASK_REPORTING_MODE 115d1562996862712411833171afbb7dcae6fddd1bcPeng Xu 116d1562996862712411833171afbb7dcae6fddd1bcPeng Xu/* 117d1562996862712411833171afbb7dcae6fddd1bcPeng Xu * Mask and shift for data_injection mode sensor flags defined above. 118d1562996862712411833171afbb7dcae6fddd1bcPeng Xu */ 11995f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define DATA_INJECTION_SHIFT SENSOR_FLAG_SHIFT_DATA_INJECTION 12095f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define DATA_INJECTION_MASK SENSOR_FLAG_DATA_INJECTION 121d1562996862712411833171afbb7dcae6fddd1bcPeng Xu 122d1562996862712411833171afbb7dcae6fddd1bcPeng Xu/* 123d1562996862712411833171afbb7dcae6fddd1bcPeng Xu * Mask and shift for dynamic sensor flag. 124d1562996862712411833171afbb7dcae6fddd1bcPeng Xu */ 12595f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define DYNAMIC_SENSOR_SHIFT SENSOR_FLAG_SHIFT_DYNAMIC_SENSOR 12695f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define DYNAMIC_SENSOR_MASK SENSOR_FLAG_DYNAMIC_SENSOR 127d1562996862712411833171afbb7dcae6fddd1bcPeng Xu 128d1562996862712411833171afbb7dcae6fddd1bcPeng Xu/* 129d1562996862712411833171afbb7dcae6fddd1bcPeng Xu * Mask and shift for sensor additional information support. 130d1562996862712411833171afbb7dcae6fddd1bcPeng Xu */ 13195f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define ADDITIONAL_INFO_SHIFT SENSOR_FLAG_SHIFT_ADDITIONAL_INFO 13295f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define ADDITIONAL_INFO_MASK SENSOR_FLAG_ADDITIONAL_INFO 133d1562996862712411833171afbb7dcae6fddd1bcPeng Xu 13408a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu/* 13595f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu * Legacy alias of SENSOR_TYPE_MAGNETIC_FIELD. 13695f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu * 13795f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu * Previously, the type of a sensor measuring local magnetic field is named 13895f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu * SENSOR_TYPE_GEOMAGNETIC_FIELD and SENSOR_TYPE_MAGNETIC_FIELD is its alias. 13995f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu * SENSOR_TYPE_MAGNETIC_FIELD is redefined as primary name to avoid confusion. 14095f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu * SENSOR_TYPE_GEOMAGNETIC_FIELD is the alias and is deprecating. New implementation must not use 14195f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu * SENSOR_TYPE_GEOMAGNETIC_FIELD. 14208a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu */ 14395f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define SENSOR_TYPE_GEOMAGNETIC_FIELD SENSOR_TYPE_MAGNETIC_FIELD 14495f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu 14508a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu/* 14695f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu * Sensor string types for Android defined sensor types. 14795f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu * 14895f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu * For Android defined sensor types, string type will be override in sensor service and thus no 14995f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu * longer needed to be added to sensor_t data structure. 15095f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu * 15195f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu * These definitions are going to be removed soon. 15208a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu */ 15395f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define SENSOR_STRING_TYPE_ACCELEROMETER "android.sensor.accelerometer" 15495f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define SENSOR_STRING_TYPE_MAGNETIC_FIELD "android.sensor.magnetic_field" 15595f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define SENSOR_STRING_TYPE_ORIENTATION "android.sensor.orientation" 15695f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define SENSOR_STRING_TYPE_GYROSCOPE "android.sensor.gyroscope" 15795f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define SENSOR_STRING_TYPE_LIGHT "android.sensor.light" 15895f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define SENSOR_STRING_TYPE_PRESSURE "android.sensor.pressure" 15995f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define SENSOR_STRING_TYPE_TEMPERATURE "android.sensor.temperature" 16095f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define SENSOR_STRING_TYPE_PROXIMITY "android.sensor.proximity" 16195f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define SENSOR_STRING_TYPE_GRAVITY "android.sensor.gravity" 16295f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define SENSOR_STRING_TYPE_LINEAR_ACCELERATION "android.sensor.linear_acceleration" 16395f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define SENSOR_STRING_TYPE_ROTATION_VECTOR "android.sensor.rotation_vector" 16495f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define SENSOR_STRING_TYPE_RELATIVE_HUMIDITY "android.sensor.relative_humidity" 16595f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define SENSOR_STRING_TYPE_AMBIENT_TEMPERATURE "android.sensor.ambient_temperature" 16695f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define SENSOR_STRING_TYPE_MAGNETIC_FIELD_UNCALIBRATED "android.sensor.magnetic_field_uncalibrated" 16795f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define SENSOR_STRING_TYPE_GAME_ROTATION_VECTOR "android.sensor.game_rotation_vector" 16895f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define SENSOR_STRING_TYPE_GYROSCOPE_UNCALIBRATED "android.sensor.gyroscope_uncalibrated" 16995f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define SENSOR_STRING_TYPE_SIGNIFICANT_MOTION "android.sensor.significant_motion" 17095f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define SENSOR_STRING_TYPE_STEP_DETECTOR "android.sensor.step_detector" 17195f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define SENSOR_STRING_TYPE_STEP_COUNTER "android.sensor.step_counter" 17295f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define SENSOR_STRING_TYPE_GEOMAGNETIC_ROTATION_VECTOR "android.sensor.geomagnetic_rotation_vector" 17395f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define SENSOR_STRING_TYPE_HEART_RATE "android.sensor.heart_rate" 17495f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define SENSOR_STRING_TYPE_TILT_DETECTOR "android.sensor.tilt_detector" 17595f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define SENSOR_STRING_TYPE_WAKE_GESTURE "android.sensor.wake_gesture" 17695f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define SENSOR_STRING_TYPE_GLANCE_GESTURE "android.sensor.glance_gesture" 17795f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define SENSOR_STRING_TYPE_PICK_UP_GESTURE "android.sensor.pick_up_gesture" 17895f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define SENSOR_STRING_TYPE_WRIST_TILT_GESTURE "android.sensor.wrist_tilt_gesture" 17995f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define SENSOR_STRING_TYPE_DEVICE_ORIENTATION "android.sensor.device_orientation" 18095f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define SENSOR_STRING_TYPE_POSE_6DOF "android.sensor.pose_6dof" 181cb96331ac31494a77394b3b72acf2fb22a7fcf4fAshutosh Joshi#define SENSOR_STRING_TYPE_STATIONARY_DETECT "android.sensor.stationary_detect" 182cb96331ac31494a77394b3b72acf2fb22a7fcf4fAshutosh Joshi#define SENSOR_STRING_TYPE_MOTION_DETECT "android.sensor.motion_detect" 183cb96331ac31494a77394b3b72acf2fb22a7fcf4fAshutosh Joshi#define SENSOR_STRING_TYPE_HEART_BEAT "android.sensor.heart_beat" 18495f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define SENSOR_STRING_TYPE_DYNAMIC_SENSOR_META "android.sensor.dynamic_sensor_meta" 18595f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define SENSOR_STRING_TYPE_ADDITIONAL_INFO "android.sensor.additional_info" 186d14335b8a668644177a1f3ac6b40ee6e99845b3dAshutosh Joshi#define SENSOR_STRING_TYPE_LOW_LATENCY_OFFBODY_DETECT "android.sensor.low_latency_offbody_detect" 18795f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu#define SENSOR_STRING_TYPE_ACCELEROMETER_UNCALIBRATED "android.sensor.accelerometer_uncalibrated" 1880743a5ceeb0a0f9d0c403abe9cbb4bcf7d6f3d87Peng Xu 1890743a5ceeb0a0f9d0c403abe9cbb4bcf7d6f3d87Peng Xu/** 19056f66ccfb4915b03da4b470916bb2c59bed97216Mathias Agopian * Values returned by the accelerometer in various locations in the universe. 19156f66ccfb4915b03da4b470916bb2c59bed97216Mathias Agopian * all values are in SI units (m/s^2) 19256f66ccfb4915b03da4b470916bb2c59bed97216Mathias Agopian */ 19356f66ccfb4915b03da4b470916bb2c59bed97216Mathias Agopian#define GRAVITY_SUN (275.0f) 19456f66ccfb4915b03da4b470916bb2c59bed97216Mathias Agopian#define GRAVITY_EARTH (9.80665f) 19556f66ccfb4915b03da4b470916bb2c59bed97216Mathias Agopian 19656f66ccfb4915b03da4b470916bb2c59bed97216Mathias Agopian/** Maximum magnetic field on Earth's surface */ 19756f66ccfb4915b03da4b470916bb2c59bed97216Mathias Agopian#define MAGNETIC_FIELD_EARTH_MAX (60.0f) 19856f66ccfb4915b03da4b470916bb2c59bed97216Mathias Agopian 19956f66ccfb4915b03da4b470916bb2c59bed97216Mathias Agopian/** Minimum magnetic field on Earth's surface */ 20056f66ccfb4915b03da4b470916bb2c59bed97216Mathias Agopian#define MAGNETIC_FIELD_EARTH_MIN (30.0f) 20156f66ccfb4915b03da4b470916bb2c59bed97216Mathias Agopian 202e641ba987af43b8b63a9da40741a6d4d37c5ea60Peng Xustruct sensor_t; 203e641ba987af43b8b63a9da40741a6d4d37c5ea60Peng Xu 20456f66ccfb4915b03da4b470916bb2c59bed97216Mathias Agopian/** 20556f66ccfb4915b03da4b470916bb2c59bed97216Mathias Agopian * sensor event data 20656f66ccfb4915b03da4b470916bb2c59bed97216Mathias Agopian */ 207f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Projecttypedef struct { 208f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project union { 209f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project float v[3]; 210f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project struct { 211f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project float x; 212f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project float y; 213f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project float z; 214f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project }; 215f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project struct { 216f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project float azimuth; 217f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project float pitch; 218f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project float roll; 219f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project }; 220f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project }; 221f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project int8_t status; 222f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project uint8_t reserved[3]; 223f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project} sensors_vec_t; 224f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 225f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project/** 226d1e2562a798004cdf495fa7168ef1f6950301a07Ashutosh Joshi * uncalibrated accelerometer, gyroscope and magnetometer event data 227ca8581433b778c60b074839baa6c3f2233c09614Etienne Le Grand */ 228ca8581433b778c60b074839baa6c3f2233c09614Etienne Le Grandtypedef struct { 22928f04113f56a05560fc6074579ab5a4fcd424a0fEtienne Le Grand union { 23028f04113f56a05560fc6074579ab5a4fcd424a0fEtienne Le Grand float uncalib[3]; 23128f04113f56a05560fc6074579ab5a4fcd424a0fEtienne Le Grand struct { 23228f04113f56a05560fc6074579ab5a4fcd424a0fEtienne Le Grand float x_uncalib; 23328f04113f56a05560fc6074579ab5a4fcd424a0fEtienne Le Grand float y_uncalib; 23428f04113f56a05560fc6074579ab5a4fcd424a0fEtienne Le Grand float z_uncalib; 23528f04113f56a05560fc6074579ab5a4fcd424a0fEtienne Le Grand }; 23628f04113f56a05560fc6074579ab5a4fcd424a0fEtienne Le Grand }; 23728f04113f56a05560fc6074579ab5a4fcd424a0fEtienne Le Grand union { 23828f04113f56a05560fc6074579ab5a4fcd424a0fEtienne Le Grand float bias[3]; 23928f04113f56a05560fc6074579ab5a4fcd424a0fEtienne Le Grand struct { 24028f04113f56a05560fc6074579ab5a4fcd424a0fEtienne Le Grand float x_bias; 24128f04113f56a05560fc6074579ab5a4fcd424a0fEtienne Le Grand float y_bias; 24228f04113f56a05560fc6074579ab5a4fcd424a0fEtienne Le Grand float z_bias; 24328f04113f56a05560fc6074579ab5a4fcd424a0fEtienne Le Grand }; 24428f04113f56a05560fc6074579ab5a4fcd424a0fEtienne Le Grand }; 245ca8581433b778c60b074839baa6c3f2233c09614Etienne Le Grand} uncalibrated_event_t; 246ca8581433b778c60b074839baa6c3f2233c09614Etienne Le Grand 247772d85ad350f9a4b8844c72206b6e20b91332b62Etienne Le Grand/** 248772d85ad350f9a4b8844c72206b6e20b91332b62Etienne Le Grand * Meta data event data 249772d85ad350f9a4b8844c72206b6e20b91332b62Etienne Le Grand */ 25016671c5519003d3be0eab34a8a78fecac9e941a3Mathias Agopiantypedef struct meta_data_event { 25116671c5519003d3be0eab34a8a78fecac9e941a3Mathias Agopian int32_t what; 25216671c5519003d3be0eab34a8a78fecac9e941a3Mathias Agopian int32_t sensor; 25316671c5519003d3be0eab34a8a78fecac9e941a3Mathias Agopian} meta_data_event_t; 25416671c5519003d3be0eab34a8a78fecac9e941a3Mathias Agopian 255ca8581433b778c60b074839baa6c3f2233c09614Etienne Le Grand/** 256e641ba987af43b8b63a9da40741a6d4d37c5ea60Peng Xu * Dynamic sensor meta event. See the description of SENSOR_TYPE_DYNAMIC_SENSOR_META type for 257e641ba987af43b8b63a9da40741a6d4d37c5ea60Peng Xu * details. 258e641ba987af43b8b63a9da40741a6d4d37c5ea60Peng Xu */ 259e641ba987af43b8b63a9da40741a6d4d37c5ea60Peng Xutypedef struct dynamic_sensor_meta_event { 260e20707ad87c6c0e049596680e8185343b50f6feePeng Xu int32_t connected; 261e20707ad87c6c0e049596680e8185343b50f6feePeng Xu int32_t handle; 262e641ba987af43b8b63a9da40741a6d4d37c5ea60Peng Xu const struct sensor_t * sensor; // should be NULL if connected == false 26369b5dba69cfbf8f101f78f0a0f3ff60868fd5c25Peng Xu uint8_t uuid[16]; // UUID of a dynamic sensor (using RFC 4122 byte order) 26469b5dba69cfbf8f101f78f0a0f3ff60868fd5c25Peng Xu // For UUID 12345678-90AB-CDEF-1122-334455667788 the uuid field 26569b5dba69cfbf8f101f78f0a0f3ff60868fd5c25Peng Xu // should be initialized as: 26669b5dba69cfbf8f101f78f0a0f3ff60868fd5c25Peng Xu // {0x12, 0x34, 0x56, 0x78, 0x90, 0xAB, 0xCD, 0xEF, 0x11, ...} 267e641ba987af43b8b63a9da40741a6d4d37c5ea60Peng Xu} dynamic_sensor_meta_event_t; 268e641ba987af43b8b63a9da40741a6d4d37c5ea60Peng Xu 269e641ba987af43b8b63a9da40741a6d4d37c5ea60Peng Xu/** 2707b36158da7d87d4b87be24c13c7607f6460bc3bbEtienne Le Grand * Heart rate event data 2717b36158da7d87d4b87be24c13c7607f6460bc3bbEtienne Le Grand */ 2727b36158da7d87d4b87be24c13c7607f6460bc3bbEtienne Le Grandtypedef struct { 2737b36158da7d87d4b87be24c13c7607f6460bc3bbEtienne Le Grand // Heart rate in beats per minute. 2747b36158da7d87d4b87be24c13c7607f6460bc3bbEtienne Le Grand // Set to 0 when status is SENSOR_STATUS_UNRELIABLE or ..._NO_CONTACT 2757b36158da7d87d4b87be24c13c7607f6460bc3bbEtienne Le Grand float bpm; 2767b36158da7d87d4b87be24c13c7607f6460bc3bbEtienne Le Grand // Status of the sensor for this reading. Set to one SENSOR_STATUS_... 277772d85ad350f9a4b8844c72206b6e20b91332b62Etienne Le Grand // Note that this value should only be set for sensors that explicitly define 278772d85ad350f9a4b8844c72206b6e20b91332b62Etienne Le Grand // the meaning of this field. This field is not piped through the framework 279772d85ad350f9a4b8844c72206b6e20b91332b62Etienne Le Grand // for other sensors. 2807b36158da7d87d4b87be24c13c7607f6460bc3bbEtienne Le Grand int8_t status; 2817b36158da7d87d4b87be24c13c7607f6460bc3bbEtienne Le Grand} heart_rate_event_t; 2827b36158da7d87d4b87be24c13c7607f6460bc3bbEtienne Le Grand 2830743a5ceeb0a0f9d0c403abe9cbb4bcf7d6f3d87Peng Xutypedef struct { 2840743a5ceeb0a0f9d0c403abe9cbb4bcf7d6f3d87Peng Xu int32_t type; // type of payload data, see additional_info_type_t 2850743a5ceeb0a0f9d0c403abe9cbb4bcf7d6f3d87Peng Xu int32_t serial; // sequence number of this frame for this type 2860743a5ceeb0a0f9d0c403abe9cbb4bcf7d6f3d87Peng Xu union { 2870743a5ceeb0a0f9d0c403abe9cbb4bcf7d6f3d87Peng Xu // for each frame, a single data type, either int32_t or float, should be used. 2880743a5ceeb0a0f9d0c403abe9cbb4bcf7d6f3d87Peng Xu int32_t data_int32[14]; 2890743a5ceeb0a0f9d0c403abe9cbb4bcf7d6f3d87Peng Xu float data_float[14]; 2900743a5ceeb0a0f9d0c403abe9cbb4bcf7d6f3d87Peng Xu }; 2910743a5ceeb0a0f9d0c403abe9cbb4bcf7d6f3d87Peng Xu} additional_info_event_t; 2920743a5ceeb0a0f9d0c403abe9cbb4bcf7d6f3d87Peng Xu 2937b36158da7d87d4b87be24c13c7607f6460bc3bbEtienne Le Grand/** 294f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * Union of the various types of sensor data 295f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * that can be returned. 296f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project */ 297cdefccdba52337df41f577d9ebfcfd67c05708cfMathias Agopiantypedef struct sensors_event_t { 298cdefccdba52337df41f577d9ebfcfd67c05708cfMathias Agopian /* must be sizeof(struct sensors_event_t) */ 299cdefccdba52337df41f577d9ebfcfd67c05708cfMathias Agopian int32_t version; 300cdefccdba52337df41f577d9ebfcfd67c05708cfMathias Agopian 301cdefccdba52337df41f577d9ebfcfd67c05708cfMathias Agopian /* sensor identifier */ 302cdefccdba52337df41f577d9ebfcfd67c05708cfMathias Agopian int32_t sensor; 303cdefccdba52337df41f577d9ebfcfd67c05708cfMathias Agopian 304cdefccdba52337df41f577d9ebfcfd67c05708cfMathias Agopian /* sensor type */ 305cdefccdba52337df41f577d9ebfcfd67c05708cfMathias Agopian int32_t type; 306cdefccdba52337df41f577d9ebfcfd67c05708cfMathias Agopian 307cdefccdba52337df41f577d9ebfcfd67c05708cfMathias Agopian /* reserved */ 308cdefccdba52337df41f577d9ebfcfd67c05708cfMathias Agopian int32_t reserved0; 309cdefccdba52337df41f577d9ebfcfd67c05708cfMathias Agopian 310cdefccdba52337df41f577d9ebfcfd67c05708cfMathias Agopian /* time is in nanosecond */ 311cdefccdba52337df41f577d9ebfcfd67c05708cfMathias Agopian int64_t timestamp; 312cdefccdba52337df41f577d9ebfcfd67c05708cfMathias Agopian 313cdefccdba52337df41f577d9ebfcfd67c05708cfMathias Agopian union { 31427e16688ec7496e72304d093a24d9c1d4fd37be5Mathias Agopian union { 31527e16688ec7496e72304d093a24d9c1d4fd37be5Mathias Agopian float data[16]; 316cdefccdba52337df41f577d9ebfcfd67c05708cfMathias Agopian 31727e16688ec7496e72304d093a24d9c1d4fd37be5Mathias Agopian /* acceleration values are in meter per second per second (m/s^2) */ 31827e16688ec7496e72304d093a24d9c1d4fd37be5Mathias Agopian sensors_vec_t acceleration; 319cdefccdba52337df41f577d9ebfcfd67c05708cfMathias Agopian 32027e16688ec7496e72304d093a24d9c1d4fd37be5Mathias Agopian /* magnetic vector values are in micro-Tesla (uT) */ 32127e16688ec7496e72304d093a24d9c1d4fd37be5Mathias Agopian sensors_vec_t magnetic; 322cdefccdba52337df41f577d9ebfcfd67c05708cfMathias Agopian 32327e16688ec7496e72304d093a24d9c1d4fd37be5Mathias Agopian /* orientation values are in degrees */ 32427e16688ec7496e72304d093a24d9c1d4fd37be5Mathias Agopian sensors_vec_t orientation; 325cdefccdba52337df41f577d9ebfcfd67c05708cfMathias Agopian 32627e16688ec7496e72304d093a24d9c1d4fd37be5Mathias Agopian /* gyroscope values are in rad/s */ 32727e16688ec7496e72304d093a24d9c1d4fd37be5Mathias Agopian sensors_vec_t gyro; 3283120b58768ff6aad5ad169b9c18f962ef6abb3c5Makarand Karvekar 32927e16688ec7496e72304d093a24d9c1d4fd37be5Mathias Agopian /* temperature is in degrees centigrade (Celsius) */ 33027e16688ec7496e72304d093a24d9c1d4fd37be5Mathias Agopian float temperature; 331cdefccdba52337df41f577d9ebfcfd67c05708cfMathias Agopian 33227e16688ec7496e72304d093a24d9c1d4fd37be5Mathias Agopian /* distance in centimeters */ 33327e16688ec7496e72304d093a24d9c1d4fd37be5Mathias Agopian float distance; 334cdefccdba52337df41f577d9ebfcfd67c05708cfMathias Agopian 33527e16688ec7496e72304d093a24d9c1d4fd37be5Mathias Agopian /* light in SI lux units */ 33627e16688ec7496e72304d093a24d9c1d4fd37be5Mathias Agopian float light; 3371832f55760fff86d00b5d808b3da8f1e55a889e5Mathias Agopian 33827e16688ec7496e72304d093a24d9c1d4fd37be5Mathias Agopian /* pressure in hectopascal (hPa) */ 33927e16688ec7496e72304d093a24d9c1d4fd37be5Mathias Agopian float pressure; 340d2ed15a6b81a9a2fd95c1a565f72796869545115Urs Fleisch 34127e16688ec7496e72304d093a24d9c1d4fd37be5Mathias Agopian /* relative humidity in percent */ 34227e16688ec7496e72304d093a24d9c1d4fd37be5Mathias Agopian float relative_humidity; 343a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian 34427e16688ec7496e72304d093a24d9c1d4fd37be5Mathias Agopian /* uncalibrated gyroscope values are in rad/s */ 34527e16688ec7496e72304d093a24d9c1d4fd37be5Mathias Agopian uncalibrated_event_t uncalibrated_gyro; 346ca8581433b778c60b074839baa6c3f2233c09614Etienne Le Grand 34727e16688ec7496e72304d093a24d9c1d4fd37be5Mathias Agopian /* uncalibrated magnetometer values are in micro-Teslas */ 34827e16688ec7496e72304d093a24d9c1d4fd37be5Mathias Agopian uncalibrated_event_t uncalibrated_magnetic; 34916671c5519003d3be0eab34a8a78fecac9e941a3Mathias Agopian 350d1e2562a798004cdf495fa7168ef1f6950301a07Ashutosh Joshi /* uncalibrated accelerometer values are in meter per second per second (m/s^2) */ 351d1e2562a798004cdf495fa7168ef1f6950301a07Ashutosh Joshi uncalibrated_event_t uncalibrated_accelerometer; 352d1e2562a798004cdf495fa7168ef1f6950301a07Ashutosh Joshi 3537b36158da7d87d4b87be24c13c7607f6460bc3bbEtienne Le Grand /* heart rate data containing value in bpm and status */ 3547b36158da7d87d4b87be24c13c7607f6460bc3bbEtienne Le Grand heart_rate_event_t heart_rate; 355477fbd5c7d99c54456ceebbe3d9efd33ed5e7747Aravind Akella 35616671c5519003d3be0eab34a8a78fecac9e941a3Mathias Agopian /* this is a special event. see SENSOR_TYPE_META_DATA above. 35716671c5519003d3be0eab34a8a78fecac9e941a3Mathias Agopian * sensors_meta_data_event_t events are all reported with a type of 35816671c5519003d3be0eab34a8a78fecac9e941a3Mathias Agopian * SENSOR_TYPE_META_DATA. The handle is ignored and must be zero. 35916671c5519003d3be0eab34a8a78fecac9e941a3Mathias Agopian */ 36016671c5519003d3be0eab34a8a78fecac9e941a3Mathias Agopian meta_data_event_t meta_data; 361e641ba987af43b8b63a9da40741a6d4d37c5ea60Peng Xu 362e641ba987af43b8b63a9da40741a6d4d37c5ea60Peng Xu /* dynamic sensor meta event. See SENSOR_TYPE_DYNAMIC_SENSOR_META type for details */ 363e641ba987af43b8b63a9da40741a6d4d37c5ea60Peng Xu dynamic_sensor_meta_event_t dynamic_sensor_meta; 3640743a5ceeb0a0f9d0c403abe9cbb4bcf7d6f3d87Peng Xu 3650743a5ceeb0a0f9d0c403abe9cbb4bcf7d6f3d87Peng Xu /* 3660743a5ceeb0a0f9d0c403abe9cbb4bcf7d6f3d87Peng Xu * special additional sensor information frame, see 3670743a5ceeb0a0f9d0c403abe9cbb4bcf7d6f3d87Peng Xu * SENSOR_TYPE_ADDITIONAL_INFO for details. 3680743a5ceeb0a0f9d0c403abe9cbb4bcf7d6f3d87Peng Xu */ 3690743a5ceeb0a0f9d0c403abe9cbb4bcf7d6f3d87Peng Xu additional_info_event_t additional_info; 37027e16688ec7496e72304d093a24d9c1d4fd37be5Mathias Agopian }; 37127e16688ec7496e72304d093a24d9c1d4fd37be5Mathias Agopian 37227e16688ec7496e72304d093a24d9c1d4fd37be5Mathias Agopian union { 37327e16688ec7496e72304d093a24d9c1d4fd37be5Mathias Agopian uint64_t data[8]; 374ca8581433b778c60b074839baa6c3f2233c09614Etienne Le Grand 37527e16688ec7496e72304d093a24d9c1d4fd37be5Mathias Agopian /* step-counter */ 37627e16688ec7496e72304d093a24d9c1d4fd37be5Mathias Agopian uint64_t step_counter; 37727e16688ec7496e72304d093a24d9c1d4fd37be5Mathias Agopian } u64; 378cdefccdba52337df41f577d9ebfcfd67c05708cfMathias Agopian }; 3796242f32a22c42c81d8a9a12885c794d85bf3cf63Aravind Akella 3806242f32a22c42c81d8a9a12885c794d85bf3cf63Aravind Akella /* Reserved flags for internal use. Set to zero. */ 3816242f32a22c42c81d8a9a12885c794d85bf3cf63Aravind Akella uint32_t flags; 3826242f32a22c42c81d8a9a12885c794d85bf3cf63Aravind Akella 3836242f32a22c42c81d8a9a12885c794d85bf3cf63Aravind Akella uint32_t reserved1[3]; 384cdefccdba52337df41f577d9ebfcfd67c05708cfMathias Agopian} sensors_event_t; 385cdefccdba52337df41f577d9ebfcfd67c05708cfMathias Agopian 386cdefccdba52337df41f577d9ebfcfd67c05708cfMathias Agopian 38716671c5519003d3be0eab34a8a78fecac9e941a3Mathias Agopian/* see SENSOR_TYPE_META_DATA */ 38816671c5519003d3be0eab34a8a78fecac9e941a3Mathias Agopiantypedef sensors_event_t sensors_meta_data_event_t; 38916671c5519003d3be0eab34a8a78fecac9e941a3Mathias Agopian 390cdefccdba52337df41f577d9ebfcfd67c05708cfMathias Agopian 391f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project/** 392f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * Every hardware module must have a data structure named HAL_MODULE_INFO_SYM 393f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * and the fields of this data structure must begin with hw_module_t 394f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * followed by module specific information. 395f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project */ 396f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Projectstruct sensors_module_t { 397f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project struct hw_module_t common; 398f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 399f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project /** 400f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * Enumerate all available sensors. The list is returned in "list". 401867e1e3043c230d7a19027bcad5bd66114f06a4dColin Cross * return number of sensors in the list 402f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project */ 403f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project int (*get_sensors_list)(struct sensors_module_t* module, 404f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project struct sensor_t const** list); 4056507f5080bc3fdc8d4b23cfa2d73d3602cc60a6aAshutosh Joshi 4066507f5080bc3fdc8d4b23cfa2d73d3602cc60a6aAshutosh Joshi /** 4076507f5080bc3fdc8d4b23cfa2d73d3602cc60a6aAshutosh Joshi * Place the module in a specific mode. The following modes are defined 4086507f5080bc3fdc8d4b23cfa2d73d3602cc60a6aAshutosh Joshi * 409050f2e45a042638bc2f6c1a51a805847edd9332fAshutosh Joshi * 0 - Normal operation. Default state of the module. 4100743a5ceeb0a0f9d0c403abe9cbb4bcf7d6f3d87Peng Xu * 1 - Loopback mode. Data is injected for the supported 411050f2e45a042638bc2f6c1a51a805847edd9332fAshutosh Joshi * sensors by the sensor service in this mode. 412867e1e3043c230d7a19027bcad5bd66114f06a4dColin Cross * return 0 on success 413050f2e45a042638bc2f6c1a51a805847edd9332fAshutosh Joshi * -EINVAL if requested mode is not supported 414c7f54134ca255810bea017c4c20ffe8cb86fe10eAravind Akella * -EPERM if operation is not allowed 4156507f5080bc3fdc8d4b23cfa2d73d3602cc60a6aAshutosh Joshi */ 4166507f5080bc3fdc8d4b23cfa2d73d3602cc60a6aAshutosh Joshi int (*set_operation_mode)(unsigned int mode); 417f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project}; 418f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 419f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Projectstruct sensor_t { 4201144bea332fb24789712062bb35fe762f2f17505Mathias Agopian 4211144bea332fb24789712062bb35fe762f2f17505Mathias Agopian /* Name of this sensor. 4221144bea332fb24789712062bb35fe762f2f17505Mathias Agopian * All sensors of the same "type" must have a different "name". 4231144bea332fb24789712062bb35fe762f2f17505Mathias Agopian */ 424f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project const char* name; 425a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian 426f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project /* vendor of the hardware part */ 427f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project const char* vendor; 428a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian 429e9eaf3721dd715901d669df6488b1ecd63b1e634Mathias Agopian /* version of the hardware part + driver. The value of this field 430e9eaf3721dd715901d669df6488b1ecd63b1e634Mathias Agopian * must increase when the driver is updated in a way that changes the 431e9eaf3721dd715901d669df6488b1ecd63b1e634Mathias Agopian * output of this sensor. This is important for fused sensors when the 432e9eaf3721dd715901d669df6488b1ecd63b1e634Mathias Agopian * fusion algorithm is updated. 4336242f32a22c42c81d8a9a12885c794d85bf3cf63Aravind Akella */ 434f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project int version; 435a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian 436a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian /* handle that identifies this sensors. This handle is used to reference 437a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian * this sensor throughout the HAL API. 438f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project */ 439f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project int handle; 440a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian 441f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project /* this sensor's type. */ 442f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project int type; 443a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian 444a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian /* maximum range of this sensor's value in SI units */ 445f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project float maxRange; 446a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian 447f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project /* smallest difference between two values reported by this sensor */ 448f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project float resolution; 449a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian 450f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project /* rough estimate of this sensor's power consumption in mA */ 451f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project float power; 452a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian 453c841efdc3632bd72961eb215699c5a4c6793bff0Aravind Akella /* this value depends on the reporting mode: 454a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian * 455a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian * continuous: minimum sample period allowed in microseconds 456a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian * on-change : 0 457a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian * one-shot :-1 458a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian * special : 0, unless otherwise noted 459a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian */ 4601511e20fbbdfe7bf30b9de73f06fc981eb494f09Mathias Agopian int32_t minDelay; 461a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian 46216671c5519003d3be0eab34a8a78fecac9e941a3Mathias Agopian /* number of events reserved for this sensor in the batch mode FIFO. 46316671c5519003d3be0eab34a8a78fecac9e941a3Mathias Agopian * If there is a dedicated FIFO for this sensor, then this is the 46416671c5519003d3be0eab34a8a78fecac9e941a3Mathias Agopian * size of this FIFO. If the FIFO is shared with other sensors, 46516671c5519003d3be0eab34a8a78fecac9e941a3Mathias Agopian * this is the size reserved for that sensor and it can be zero. 46616671c5519003d3be0eab34a8a78fecac9e941a3Mathias Agopian */ 46716671c5519003d3be0eab34a8a78fecac9e941a3Mathias Agopian uint32_t fifoReservedEventCount; 46816671c5519003d3be0eab34a8a78fecac9e941a3Mathias Agopian 46916671c5519003d3be0eab34a8a78fecac9e941a3Mathias Agopian /* maximum number of events of this sensor that could be batched. 47016671c5519003d3be0eab34a8a78fecac9e941a3Mathias Agopian * This is especially relevant when the FIFO is shared between 47116671c5519003d3be0eab34a8a78fecac9e941a3Mathias Agopian * several sensors; this value is then set to the size of that FIFO. 47216671c5519003d3be0eab34a8a78fecac9e941a3Mathias Agopian */ 47316671c5519003d3be0eab34a8a78fecac9e941a3Mathias Agopian uint32_t fifoMaxEventCount; 47416671c5519003d3be0eab34a8a78fecac9e941a3Mathias Agopian 47595f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu /* type of this sensor as a string. 47695f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu * 47795f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu * If type is OEM specific or sensor manufacturer specific type 47895f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu * (>=SENSOR_TYPE_DEVICE_PRIVATE_BASE), this string must be defined with reserved domain of 47995f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu * vendor/OEM as a prefix, e.g. com.google.glass.onheaddetector 48095f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu * 48195f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu * For sensors of Android defined types, Android framework will override this value. It is ok to 48295f79b1879c52d72751cfa1d710f2fcf086f3811Peng Xu * leave it pointing to an empty string. 483477fbd5c7d99c54456ceebbe3d9efd33ed5e7747Aravind Akella */ 484477fbd5c7d99c54456ceebbe3d9efd33ed5e7747Aravind Akella const char* stringType; 485477fbd5c7d99c54456ceebbe3d9efd33ed5e7747Aravind Akella 486477fbd5c7d99c54456ceebbe3d9efd33ed5e7747Aravind Akella /* permission required to see this sensor, register to it and receive data. 487477fbd5c7d99c54456ceebbe3d9efd33ed5e7747Aravind Akella * Set to "" if no permission is required. Some sensor types like the 488477fbd5c7d99c54456ceebbe3d9efd33ed5e7747Aravind Akella * heart rate monitor have a mandatory require_permission. 489477fbd5c7d99c54456ceebbe3d9efd33ed5e7747Aravind Akella * For sensors that always require a specific permission, like the heart 490477fbd5c7d99c54456ceebbe3d9efd33ed5e7747Aravind Akella * rate monitor, the android framework might overwrite this string 491477fbd5c7d99c54456ceebbe3d9efd33ed5e7747Aravind Akella * automatically. 492477fbd5c7d99c54456ceebbe3d9efd33ed5e7747Aravind Akella */ 493477fbd5c7d99c54456ceebbe3d9efd33ed5e7747Aravind Akella const char* requiredPermission; 494477fbd5c7d99c54456ceebbe3d9efd33ed5e7747Aravind Akella 495110d2f2713490c8c8ae5ce3d66ac7364eb2002a4Aravind Akella /* This value is defined only for continuous mode and on-change sensors. It is the delay between 496110d2f2713490c8c8ae5ce3d66ac7364eb2002a4Aravind Akella * two sensor events corresponding to the lowest frequency that this sensor supports. When lower 497110d2f2713490c8c8ae5ce3d66ac7364eb2002a4Aravind Akella * frequencies are requested through batch()/setDelay() the events will be generated at this 498110d2f2713490c8c8ae5ce3d66ac7364eb2002a4Aravind Akella * frequency instead. It can be used by the framework or applications to estimate when the batch 499110d2f2713490c8c8ae5ce3d66ac7364eb2002a4Aravind Akella * FIFO may be full. 500c841efdc3632bd72961eb215699c5a4c6793bff0Aravind Akella * 501c841efdc3632bd72961eb215699c5a4c6793bff0Aravind Akella * NOTE: 1) period_ns is in nanoseconds where as maxDelay/minDelay are in microseconds. 502110d2f2713490c8c8ae5ce3d66ac7364eb2002a4Aravind Akella * continuous, on-change: maximum sampling period allowed in microseconds. 503110d2f2713490c8c8ae5ce3d66ac7364eb2002a4Aravind Akella * one-shot, special : 0 504c841efdc3632bd72961eb215699c5a4c6793bff0Aravind Akella * 2) maxDelay should always fit within a 32 bit signed integer. It is declared as 64 bit 505c841efdc3632bd72961eb215699c5a4c6793bff0Aravind Akella * on 64 bit architectures only for binary compatibility reasons. 5066242f32a22c42c81d8a9a12885c794d85bf3cf63Aravind Akella * Availability: SENSORS_DEVICE_API_VERSION_1_3 5076242f32a22c42c81d8a9a12885c794d85bf3cf63Aravind Akella */ 5086242f32a22c42c81d8a9a12885c794d85bf3cf63Aravind Akella #ifdef __LP64__ 5096242f32a22c42c81d8a9a12885c794d85bf3cf63Aravind Akella int64_t maxDelay; 5106242f32a22c42c81d8a9a12885c794d85bf3cf63Aravind Akella #else 5116242f32a22c42c81d8a9a12885c794d85bf3cf63Aravind Akella int32_t maxDelay; 5126242f32a22c42c81d8a9a12885c794d85bf3cf63Aravind Akella #endif 5136242f32a22c42c81d8a9a12885c794d85bf3cf63Aravind Akella 514c841efdc3632bd72961eb215699c5a4c6793bff0Aravind Akella /* Flags for sensor. See SENSOR_FLAG_* above. Only the least significant 32 bits are used here. 515c841efdc3632bd72961eb215699c5a4c6793bff0Aravind Akella * It is declared as 64 bit on 64 bit architectures only for binary compatibility reasons. 516c841efdc3632bd72961eb215699c5a4c6793bff0Aravind Akella * Availability: SENSORS_DEVICE_API_VERSION_1_3 517c841efdc3632bd72961eb215699c5a4c6793bff0Aravind Akella */ 5186242f32a22c42c81d8a9a12885c794d85bf3cf63Aravind Akella #ifdef __LP64__ 5196242f32a22c42c81d8a9a12885c794d85bf3cf63Aravind Akella uint64_t flags; 5206242f32a22c42c81d8a9a12885c794d85bf3cf63Aravind Akella #else 5216242f32a22c42c81d8a9a12885c794d85bf3cf63Aravind Akella uint32_t flags; 5226242f32a22c42c81d8a9a12885c794d85bf3cf63Aravind Akella #endif 5236242f32a22c42c81d8a9a12885c794d85bf3cf63Aravind Akella 524f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project /* reserved fields, must be zero */ 5256242f32a22c42c81d8a9a12885c794d85bf3cf63Aravind Akella void* reserved[2]; 526f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project}; 527f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 52808a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu/** 52908a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * Shared memory information for a direct channel 53008a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu */ 53108a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xustruct sensors_direct_mem_t { 53208a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu int type; // enum SENSOR_DIRECT_MEM_... 53308a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu int format; // enum SENSOR_DIRECT_FMT_... 53408a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu size_t size; // size of the memory region, in bytes 53508a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu const struct native_handle *handle; // shared memory handle, which is interpreted differently 53608a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu // depending on type 53708a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu}; 53808a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu 53908a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu/** 54008a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * Direct channel report configuration 54108a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu */ 54208a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xustruct sensors_direct_cfg_t { 54308a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu int rate_level; // enum SENSOR_DIRECT_RATE_... 54408a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu}; 545f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 546a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian/* 547a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian * sensors_poll_device_t is used with SENSORS_DEVICE_API_VERSION_0_1 548a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian * and is present for backward binary and source compatibility. 5498db1fb408c63f6e57241e68f671b4f0647f1cba9Clay Murphy * See the Sensors HAL interface section for complete descriptions of the 5508db1fb408c63f6e57241e68f671b4f0647f1cba9Clay Murphy * following functions: 5518db1fb408c63f6e57241e68f671b4f0647f1cba9Clay Murphy * http://source.android.com/devices/sensors/index.html#hal 552f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project */ 553b1e212e7b6fce2bc5c743b05853129e19760d7a4Mathias Agopianstruct sensors_poll_device_t { 554b1e212e7b6fce2bc5c743b05853129e19760d7a4Mathias Agopian struct hw_device_t common; 555b1e212e7b6fce2bc5c743b05853129e19760d7a4Mathias Agopian int (*activate)(struct sensors_poll_device_t *dev, 556772d85ad350f9a4b8844c72206b6e20b91332b62Etienne Le Grand int sensor_handle, int enabled); 557a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian int (*setDelay)(struct sensors_poll_device_t *dev, 558772d85ad350f9a4b8844c72206b6e20b91332b62Etienne Le Grand int sensor_handle, int64_t sampling_period_ns); 559a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian int (*poll)(struct sensors_poll_device_t *dev, 560a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian sensors_event_t* data, int count); 561a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian}; 562b1e212e7b6fce2bc5c743b05853129e19760d7a4Mathias Agopian 563a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian/* 564772d85ad350f9a4b8844c72206b6e20b91332b62Etienne Le Grand * struct sensors_poll_device_1 is used in HAL versions >= SENSORS_DEVICE_API_VERSION_1_0 565a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian */ 566a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopiantypedef struct sensors_poll_device_1 { 567a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian union { 568a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian /* sensors_poll_device_1 is compatible with sensors_poll_device_t, 569a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian * and can be down-cast to it 570a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian */ 5711082c0b54c21c220e975f1c714e41f9183b366d1Andrew Hsieh struct sensors_poll_device_t v0; 572a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian 573a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian struct { 574a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian struct hw_device_t common; 575a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian 576aaeeaa41bde52220fc63dab266b9ae9e2287595fPeng Xu /* Activate/de-activate one sensor. 577a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian * 578772d85ad350f9a4b8844c72206b6e20b91332b62Etienne Le Grand * sensor_handle is the handle of the sensor to change. 579a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian * enabled set to 1 to enable, or 0 to disable the sensor. 580a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian * 581aaeeaa41bde52220fc63dab266b9ae9e2287595fPeng Xu * After sensor de-activation, existing sensor events that have not 582aaeeaa41bde52220fc63dab266b9ae9e2287595fPeng Xu * been picked up by poll() should be abandoned immediately so that 583aaeeaa41bde52220fc63dab266b9ae9e2287595fPeng Xu * subsequent activation will not get stale sensor events (events 584aaeeaa41bde52220fc63dab266b9ae9e2287595fPeng Xu * that is generated prior to the latter activation). 585aaeeaa41bde52220fc63dab266b9ae9e2287595fPeng Xu * 5868db1fb408c63f6e57241e68f671b4f0647f1cba9Clay Murphy * Return 0 on success, negative errno code otherwise. 587a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian */ 588a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian int (*activate)(struct sensors_poll_device_t *dev, 589772d85ad350f9a4b8844c72206b6e20b91332b62Etienne Le Grand int sensor_handle, int enabled); 590a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian 591a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian /** 592772d85ad350f9a4b8844c72206b6e20b91332b62Etienne Le Grand * Set the events's period in nanoseconds for a given sensor. 593772d85ad350f9a4b8844c72206b6e20b91332b62Etienne Le Grand * If sampling_period_ns > max_delay it will be truncated to 594772d85ad350f9a4b8844c72206b6e20b91332b62Etienne Le Grand * max_delay and if sampling_period_ns < min_delay it will be 595772d85ad350f9a4b8844c72206b6e20b91332b62Etienne Le Grand * replaced by min_delay. 596a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian */ 597a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian int (*setDelay)(struct sensors_poll_device_t *dev, 598772d85ad350f9a4b8844c72206b6e20b91332b62Etienne Le Grand int sensor_handle, int64_t sampling_period_ns); 599a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian 600a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian /** 601355e3f606a7193c6822a39b4e139d0beea580db1Peng Xu * Write an array of sensor_event_t to data. The size of the 602355e3f606a7193c6822a39b4e139d0beea580db1Peng Xu * available buffer is specified by count. Returns number of 603355e3f606a7193c6822a39b4e139d0beea580db1Peng Xu * valid sensor_event_t. 604355e3f606a7193c6822a39b4e139d0beea580db1Peng Xu * 605355e3f606a7193c6822a39b4e139d0beea580db1Peng Xu * This function should block if there is no sensor event 606355e3f606a7193c6822a39b4e139d0beea580db1Peng Xu * available when being called. Thus, return value should always be 607355e3f606a7193c6822a39b4e139d0beea580db1Peng Xu * positive. 608a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian */ 609a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian int (*poll)(struct sensors_poll_device_t *dev, 610a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian sensors_event_t* data, int count); 611a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian }; 612a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian }; 613a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian 614a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian 615a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian /* 616772d85ad350f9a4b8844c72206b6e20b91332b62Etienne Le Grand * Sets a sensor’s parameters, including sampling frequency and maximum 617772d85ad350f9a4b8844c72206b6e20b91332b62Etienne Le Grand * report latency. This function can be called while the sensor is 618772d85ad350f9a4b8844c72206b6e20b91332b62Etienne Le Grand * activated, in which case it must not cause any sensor measurements to 619772d85ad350f9a4b8844c72206b6e20b91332b62Etienne Le Grand * be lost: transitioning from one sampling rate to the other cannot cause 620772d85ad350f9a4b8844c72206b6e20b91332b62Etienne Le Grand * lost events, nor can transitioning from a high maximum report latency to 621772d85ad350f9a4b8844c72206b6e20b91332b62Etienne Le Grand * a low maximum report latency. 6228db1fb408c63f6e57241e68f671b4f0647f1cba9Clay Murphy * See the Batching sensor results page for details: 6238db1fb408c63f6e57241e68f671b4f0647f1cba9Clay Murphy * http://source.android.com/devices/sensors/batching.html 624b1e212e7b6fce2bc5c743b05853129e19760d7a4Mathias Agopian */ 625a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian int (*batch)(struct sensors_poll_device_1* dev, 626772d85ad350f9a4b8844c72206b6e20b91332b62Etienne Le Grand int sensor_handle, int flags, int64_t sampling_period_ns, 627772d85ad350f9a4b8844c72206b6e20b91332b62Etienne Le Grand int64_t max_report_latency_ns); 628a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian 62916671c5519003d3be0eab34a8a78fecac9e941a3Mathias Agopian /* 63016671c5519003d3be0eab34a8a78fecac9e941a3Mathias Agopian * Flush adds a META_DATA_FLUSH_COMPLETE event (sensors_event_meta_data_t) 63116671c5519003d3be0eab34a8a78fecac9e941a3Mathias Agopian * to the end of the "batch mode" FIFO for the specified sensor and flushes 632772d85ad350f9a4b8844c72206b6e20b91332b62Etienne Le Grand * the FIFO. 633772d85ad350f9a4b8844c72206b6e20b91332b62Etienne Le Grand * If the FIFO is empty or if the sensor doesn't support batching (FIFO size zero), 634c841efdc3632bd72961eb215699c5a4c6793bff0Aravind Akella * it should return SUCCESS along with a trivial META_DATA_FLUSH_COMPLETE event added to the 635772d85ad350f9a4b8844c72206b6e20b91332b62Etienne Le Grand * event stream. This applies to all sensors other than one-shot sensors. 636772d85ad350f9a4b8844c72206b6e20b91332b62Etienne Le Grand * If the sensor is a one-shot sensor, flush must return -EINVAL and not generate 637772d85ad350f9a4b8844c72206b6e20b91332b62Etienne Le Grand * any flush complete metadata. 638a7f2cda848c2f057921109f03b843a761ad5d563Aravind Akella * If the sensor is not active at the time flush() is called, flush() should return 639a7f2cda848c2f057921109f03b843a761ad5d563Aravind Akella * -EINVAL. 64016671c5519003d3be0eab34a8a78fecac9e941a3Mathias Agopian */ 641772d85ad350f9a4b8844c72206b6e20b91332b62Etienne Le Grand int (*flush)(struct sensors_poll_device_1* dev, int sensor_handle); 64216671c5519003d3be0eab34a8a78fecac9e941a3Mathias Agopian 6436507f5080bc3fdc8d4b23cfa2d73d3602cc60a6aAshutosh Joshi /* 644050f2e45a042638bc2f6c1a51a805847edd9332fAshutosh Joshi * Inject a single sensor sample to be to this device. 645050f2e45a042638bc2f6c1a51a805847edd9332fAshutosh Joshi * data points to the sensor event to be injected 646867e1e3043c230d7a19027bcad5bd66114f06a4dColin Cross * return 0 on success 647c7f54134ca255810bea017c4c20ffe8cb86fe10eAravind Akella * -EPERM if operation is not allowed 648050f2e45a042638bc2f6c1a51a805847edd9332fAshutosh Joshi * -EINVAL if sensor event cannot be injected 6496507f5080bc3fdc8d4b23cfa2d73d3602cc60a6aAshutosh Joshi */ 6506507f5080bc3fdc8d4b23cfa2d73d3602cc60a6aAshutosh Joshi int (*inject_sensor_data)(struct sensors_poll_device_1 *dev, const sensors_event_t *data); 6516507f5080bc3fdc8d4b23cfa2d73d3602cc60a6aAshutosh Joshi 65208a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu /* 65308a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * Register/unregister direct report channel. 65408a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * 65508a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * A HAL declares support for direct report by setting non-NULL values for both 65608a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * register_direct_channel and config_direct_report. 65708a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * 65808a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * This function has two operation modes: 65908a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * 66008a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * Register: mem != NULL, register a channel using supplied shared memory information. By the 66108a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * time this function returns, sensors must finish initializing shared memory content 66208a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * (format dependent, see SENSOR_DIRECT_FMT_*). 66308a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * Parameters: 66408a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * mem points to a valid struct sensors_direct_mem_t. 66508a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * channel_handle is ignored. 66608a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * Return value: 667f144435ef4d42012e9fda01823d4915fb752a7a6Peng Xu * A handle of channel (>0, <INT32_MAX) when success, which later can be referred in 668f144435ef4d42012e9fda01823d4915fb752a7a6Peng Xu * unregister or config_direct_report call, or error code (<0) when failed 66908a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * Unregister: mem == NULL, unregister a previously registered channel. 67008a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * Parameters: 67108a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * mem set to NULL 67208a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * channel_handle contains handle of channel to be unregistered 67308a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * Return value: 67408a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * 0, even if the channel_handle is invalid, in which case it will be a no-op. 67508a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu */ 67608a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu int (*register_direct_channel)(struct sensors_poll_device_1 *dev, 67708a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu const struct sensors_direct_mem_t* mem, int channel_handle); 67808a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu 67908a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu /* 68008a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * Configure direct sensor event report in direct channel. 68108a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * 68208a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * Start, modify rate or stop direct report of a sensor in a certain direct channel. A special 68308a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * case is setting sensor handle -1 to stop means to stop all active sensor report on the 68408a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * channel specified. 68508a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * 68608a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * A HAL declares support for direct report by setting non-NULL values for both 68708a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * register_direct_channel and config_direct_report. 68808a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * 68908a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * Parameters: 69008a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * sensor_handle sensor to be configured. The sensor has to support direct report 69108a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * mode by setting flags of sensor_t. Also, direct report mode is only 69208a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * defined for continuous reporting mode sensors. 69308a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * channel_handle channel handle to be configured. 69408a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * config direct report parameters, see sensor_direct_cfg_t. 69508a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * Return value: 69608a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * - when sensor is started or sensor rate level is changed: return positive identifier of 69708a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * sensor in specified channel if successful, otherwise return negative error code. 69808a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu * - when sensor is stopped: return 0 for success or negative error code for failure. 69908a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu */ 70008a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu int (*config_direct_report)(struct sensors_poll_device_1 *dev, 70108a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu int sensor_handle, int channel_handle, const struct sensors_direct_cfg_t *config); 70208a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu 70308a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu /* 704bed42d4c2b581fee76ebf601560cdfd7976a02a9Peng Xu * Reserved for future use, must be zero. 70508a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu */ 70608a4dd9e890d0560c049a044c72e8202aa6f413aPeng Xu void (*reserved_procs[5])(void); 707a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian 708a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian} sensors_poll_device_1_t; 709a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian 710a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian 711f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project/** convenience API for opening and closing a device */ 712f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 713b1e212e7b6fce2bc5c743b05853129e19760d7a4Mathias Agopianstatic inline int sensors_open(const struct hw_module_t* module, 714b1e212e7b6fce2bc5c743b05853129e19760d7a4Mathias Agopian struct sensors_poll_device_t** device) { 715b1e212e7b6fce2bc5c743b05853129e19760d7a4Mathias Agopian return module->methods->open(module, 716cc8d9f9fcbc170dedba609a15705e838cf09218bColin Cross SENSORS_HARDWARE_POLL, TO_HW_DEVICE_T_OPEN(device)); 717b1e212e7b6fce2bc5c743b05853129e19760d7a4Mathias Agopian} 718b1e212e7b6fce2bc5c743b05853129e19760d7a4Mathias Agopian 719b1e212e7b6fce2bc5c743b05853129e19760d7a4Mathias Agopianstatic inline int sensors_close(struct sensors_poll_device_t* device) { 720b1e212e7b6fce2bc5c743b05853129e19760d7a4Mathias Agopian return device->common.close(&device->common); 721b1e212e7b6fce2bc5c743b05853129e19760d7a4Mathias Agopian} 722b1e212e7b6fce2bc5c743b05853129e19760d7a4Mathias Agopian 723a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopianstatic inline int sensors_open_1(const struct hw_module_t* module, 7241082c0b54c21c220e975f1c714e41f9183b366d1Andrew Hsieh sensors_poll_device_1_t** device) { 725a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian return module->methods->open(module, 726cc8d9f9fcbc170dedba609a15705e838cf09218bColin Cross SENSORS_HARDWARE_POLL, TO_HW_DEVICE_T_OPEN(device)); 727a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian} 728a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian 7291082c0b54c21c220e975f1c714e41f9183b366d1Andrew Hsiehstatic inline int sensors_close_1(sensors_poll_device_1_t* device) { 730a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian return device->common.close(&device->common); 731a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian} 732a455772cb30cb8fed26b12f61a6d78c9b689e640Mathias Agopian 733f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project__END_DECLS 734f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 735f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#endif // ANDROID_SENSORS_INTERFACE_H 736