sensors.h revision 2bedac69dc3b9fb93f7bfd3ef334224fc5b7f4c3
1f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project/* 2f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * Copyright (C) 2008 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 27f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project__BEGIN_DECLS 28f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 29f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project/** 30f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * The id of this module 31f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project */ 32f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#define SENSORS_HARDWARE_MODULE_ID "sensors" 33f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 34f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project/** 35f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * Name of the sensors device to open 36f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project */ 37f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#define SENSORS_HARDWARE_CONTROL "control" 38f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#define SENSORS_HARDWARE_DATA "data" 39f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 40f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project/** 41f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * Handles must be higher than SENSORS_HANDLE_BASE and must be unique. 42f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * A Handle identifies a given sensors. The handle is used to activate 43f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * and/or deactivate sensors. 44f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * In this version of the API there can only be 256 handles. 45f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project */ 46f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#define SENSORS_HANDLE_BASE 0 47f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#define SENSORS_HANDLE_BITS 8 48f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#define SENSORS_HANDLE_COUNT (1<<SENSORS_HANDLE_BITS) 49f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 50f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 51f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project/** 52f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * Sensor types 53f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project */ 54f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#define SENSOR_TYPE_ACCELEROMETER 1 55f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#define SENSOR_TYPE_MAGNETIC_FIELD 2 56f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#define SENSOR_TYPE_ORIENTATION 3 57f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#define SENSOR_TYPE_GYROSCOPE 4 58f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#define SENSOR_TYPE_LIGHT 5 59f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#define SENSOR_TYPE_PRESSURE 6 60f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#define SENSOR_TYPE_TEMPERATURE 7 61f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#define SENSOR_TYPE_PROXIMITY 8 62f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 63f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project/** 64f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * Values returned by the accelerometer in various locations in the universe. 65f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * all values are in SI units (m/s^2) 66f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project */ 67f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 68f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#define GRAVITY_SUN (275.0f) 69f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#define GRAVITY_MERCURY (3.70f) 70f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#define GRAVITY_VENUS (8.87f) 71f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#define GRAVITY_EARTH (9.80665f) 72f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#define GRAVITY_MOON (1.6f) 73f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#define GRAVITY_MARS (3.71f) 74f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#define GRAVITY_JUPITER (23.12f) 75f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#define GRAVITY_SATURN (8.96f) 76f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#define GRAVITY_URANUS (8.69f) 77f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#define GRAVITY_NEPTUNE (11.0f) 78f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#define GRAVITY_PLUTO (0.6f) 79f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#define GRAVITY_DEATH_STAR_I (0.000000353036145f) 80f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#define GRAVITY_THE_ISLAND (4.815162342f) 81f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 82f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project/** Maximum magnetic field on Earth's surface */ 83f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#define MAGNETIC_FIELD_EARTH_MAX (60.0f) 84f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 85f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project/** Minimum magnetic field on Earth's surface */ 86f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#define MAGNETIC_FIELD_EARTH_MIN (30.0f) 87f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 88f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 89f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project/** 90f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * status of each sensor 91f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project */ 92f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 93f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#define SENSOR_STATUS_UNRELIABLE 0 94f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#define SENSOR_STATUS_ACCURACY_LOW 1 95f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#define SENSOR_STATUS_ACCURACY_MEDIUM 2 96f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#define SENSOR_STATUS_ACCURACY_HIGH 3 97f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 98f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project/** 99f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * Definition of the axis 100f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * ---------------------- 101f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * 102f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * This API is relative to the screen of the device in its default orientation, 103f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * that is, if the device can be used in portrait or landscape, this API 104f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * is only relative to the NATURAL orientation of the screen. In other words, 105f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * the axis are not swapped when the device's screen orientation changes. 106f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * Higher level services /may/ perform this transformation. 107f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * 108f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * x<0 x>0 109f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * ^ 110f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * | 111f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * +-----------+--> y>0 112f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * | | 113f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * | | 114f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * | | 115f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * | | / z<0 116f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * | | / 117f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * | | / 118f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * O-----------+/ 119f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * |[] [ ] []/ 120f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * +----------/+ y<0 121f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * / 122f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * / 123f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * |/ z>0 (toward the sky) 124f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * 125f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * O: Origin (x=0,y=0,z=0) 126f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * 127f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * 128f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * Orientation 129f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * ----------- 130f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * 131f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * All values are angles in degrees. 132f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * 133f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * azimuth: angle between the magnetic north direction and the Y axis, around 134f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * the Z axis (0<=azimuth<360). 135f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * 0=North, 90=East, 180=South, 270=West 136f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * 137f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * pitch: Rotation around X axis (-180<=pitch<=180), with positive values when 138f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * the z-axis moves toward the y-axis. 139f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * 140f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * roll: Rotation around Y axis (-90<=roll<=90), with positive values when 141465cf474beaf67c3d8b7fe6889ad74c1cfc572e1Mathias Agopian * the x-axis moves AWAY from the z-axis. 142f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * 143f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * Note: This definition is different from yaw, pitch and roll used in aviation 144f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * where the X axis is along the long side of the plane (tail to nose). 145f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * 146f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * 147f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * Acceleration 148f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * ------------ 149f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * 150f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * All values are in SI units (m/s^2) and measure the acceleration of the 151f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * device minus the force of gravity. 152f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * 153f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * x: Acceleration minus Gx on the x-axis 154f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * y: Acceleration minus Gy on the y-axis 155f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * z: Acceleration minus Gz on the z-axis 156f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * 157f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * Examples: 158f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * When the device lies flat on a table and is pushed on its left side 159f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * toward the right, the x acceleration value is positive. 160f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * 161f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * When the device lies flat on a table, the acceleration value is +9.81, 162f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * which correspond to the acceleration of the device (0 m/s^2) minus the 163f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * force of gravity (-9.81 m/s^2). 164f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * 165f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * When the device lies flat on a table and is pushed toward the sky, the 166f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * acceleration value is greater than +9.81, which correspond to the 167f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * acceleration of the device (+A m/s^2) minus the force of 168f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * gravity (-9.81 m/s^2). 169f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * 170f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * 171f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * Magnetic Field 172f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * -------------- 173f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * 174f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * All values are in micro-Tesla (uT) and measure the ambient magnetic 175f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * field in the X, Y and Z axis. 176f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * 177f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project */ 178f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Projecttypedef struct { 179f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project union { 180f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project float v[3]; 181f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project struct { 182f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project float x; 183f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project float y; 184f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project float z; 185f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project }; 186f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project struct { 187f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project float azimuth; 188f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project float pitch; 189f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project float roll; 190f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project }; 191f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project }; 192f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project int8_t status; 193f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project uint8_t reserved[3]; 194f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project} sensors_vec_t; 195f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 196f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project/** 197f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * Union of the various types of sensor data 198f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * that can be returned. 199f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project */ 200f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Projecttypedef struct { 201f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project /* sensor identifier */ 202f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project int sensor; 203f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 204f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project union { 205f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project /* x,y,z values of the given sensor */ 206f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project sensors_vec_t vector; 207f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 208f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project /* orientation values are in degrees */ 209f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project sensors_vec_t orientation; 210f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 211f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project /* acceleration values are in meter per second per second (m/s^2) */ 212f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project sensors_vec_t acceleration; 213f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 214f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project /* magnetic vector values are in micro-Tesla (uT) */ 215f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project sensors_vec_t magnetic; 216f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 217f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project /* temperature is in degrees centigrade (Celsius) */ 218f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project float temperature; 219f5a22bcfa64f4f33b5877cd44761363af952b768Iliyan Malchev 220f5a22bcfa64f4f33b5877cd44761363af952b768Iliyan Malchev /* distance in centimeters */ 221f5a22bcfa64f4f33b5877cd44761363af952b768Iliyan Malchev float distance; 22261fee89f2d50cc01c34930cda8f65f70aa23acc4Iliyan Malchev 2232bedac69dc3b9fb93f7bfd3ef334224fc5b7f4c3Mike Lockwood /* light in lux */ 2242bedac69dc3b9fb93f7bfd3ef334224fc5b7f4c3Mike Lockwood float light; 225f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project }; 226f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 227f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project /* time is in nanosecond */ 228f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project int64_t time; 229f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 230f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project uint32_t reserved; 231f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project} sensors_data_t; 232f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 233f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 234f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Projectstruct sensor_t; 235f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 236f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project/** 237f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * Every hardware module must have a data structure named HAL_MODULE_INFO_SYM 238f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * and the fields of this data structure must begin with hw_module_t 239f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * followed by module specific information. 240f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project */ 241f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Projectstruct sensors_module_t { 242f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project struct hw_module_t common; 243f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 244f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project /** 245f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * Enumerate all available sensors. The list is returned in "list". 246f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * @return number of sensors in the list 247f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project */ 248f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project int (*get_sensors_list)(struct sensors_module_t* module, 249f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project struct sensor_t const** list); 250f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project}; 251f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 252f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Projectstruct sensor_t { 253f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project /* name of this sensors */ 254f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project const char* name; 255f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project /* vendor of the hardware part */ 256f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project const char* vendor; 257f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project /* version of the hardware part + driver. The value of this field is 258f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * left to the implementation and doesn't have to be monotonicaly 259f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * increasing. 260f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project */ 261f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project int version; 262f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project /* handle that identifies this sensors. This handle is used to activate 263f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * and deactivate this sensor. The value of the handle must be 8 bits 264f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * in this version of the API. 265f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project */ 266f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project int handle; 267f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project /* this sensor's type. */ 268f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project int type; 269f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project /* maximaum range of this sensor's value in SI units */ 270f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project float maxRange; 271f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project /* smallest difference between two values reported by this sensor */ 272f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project float resolution; 273f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project /* rough estimate of this sensor's power consumption in mA */ 274f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project float power; 275f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project /* reserved fields, must be zero */ 276f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project void* reserved[9]; 277f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project}; 278f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 279f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 280f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project/** 281f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * Every device data structure must begin with hw_device_t 282f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * followed by module specific public methods and attributes. 283f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project */ 284f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Projectstruct sensors_control_device_t { 285f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project struct hw_device_t common; 286f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 287f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project /** 28821b652f933b21aa37bd73364b486347fcc333d5cMike Lockwood * Returns a native_handle_t, which will be the parameter to 289f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * sensors_data_device_t::open_data(). 29021b652f933b21aa37bd73364b486347fcc333d5cMike Lockwood * The caller takes ownership of this handle. This is intended to be 291f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * passed cross processes. 292f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * 2938d567480b45a801a1955e4743c5eeae431d58f56Bill Napier * @return a native_handle_t if successful, NULL on error 294f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project */ 29521b652f933b21aa37bd73364b486347fcc333d5cMike Lockwood native_handle_t* (*open_data_source)(struct sensors_control_device_t *dev); 296fbbb347f17942ac3436938501912ab066857b251Mike Lockwood 297fbbb347f17942ac3436938501912ab066857b251Mike Lockwood /** 298fbbb347f17942ac3436938501912ab066857b251Mike Lockwood * Releases any resources that were created by open_data_source. 299fbbb347f17942ac3436938501912ab066857b251Mike Lockwood * This call is optional and can be NULL if not implemented 300fbbb347f17942ac3436938501912ab066857b251Mike Lockwood * by the sensor HAL. 301fbbb347f17942ac3436938501912ab066857b251Mike Lockwood * 302fbbb347f17942ac3436938501912ab066857b251Mike Lockwood * @return 0 if successful, < 0 on error 303fbbb347f17942ac3436938501912ab066857b251Mike Lockwood */ 304fbbb347f17942ac3436938501912ab066857b251Mike Lockwood int (*close_data_source)(struct sensors_control_device_t *dev); 305fbbb347f17942ac3436938501912ab066857b251Mike Lockwood 306f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project /** Activate/deactivate one sensor. 307f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * 308f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * @param handle is the handle of the sensor to change. 309f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * @param enabled set to 1 to enable, or 0 to disable the sensor. 310f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * 311f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * @return 0 on success, negative errno code otherwise 312f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project */ 313f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project int (*activate)(struct sensors_control_device_t *dev, 314f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project int handle, int enabled); 315f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 316f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project /** 317f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * Set the delay between sensor events in ms 318f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * 319f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * @return 0 if successful, < 0 on error 320f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project */ 321f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project int (*set_delay)(struct sensors_control_device_t *dev, int32_t ms); 322f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 323f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project /** 324f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * Causes sensors_data_device_t.poll() to return -EWOULDBLOCK immediately. 325f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project */ 326f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project int (*wake)(struct sensors_control_device_t *dev); 327f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project}; 328f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 329f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Projectstruct sensors_data_device_t { 330f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project struct hw_device_t common; 331f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 332f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project /** 333f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * Prepare to read sensor data. 334f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * 33521b652f933b21aa37bd73364b486347fcc333d5cMike Lockwood * This routine does NOT take ownership of the handle 336f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * and must not close it. Typically this routine would 33721b652f933b21aa37bd73364b486347fcc333d5cMike Lockwood * use a duplicate of the nh parameter. 338f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * 33921b652f933b21aa37bd73364b486347fcc333d5cMike Lockwood * @param nh from sensors_control_open. 340f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * 341f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * @return 0 if successful, < 0 on error 342f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project */ 34321b652f933b21aa37bd73364b486347fcc333d5cMike Lockwood int (*data_open)(struct sensors_data_device_t *dev, native_handle_t* nh); 344f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 345f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project /** 346f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * Caller has completed using the sensor data. 347f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * The caller will not be blocked in sensors_data_poll 348f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * when this routine is called. 349f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * 350f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * @return 0 if successful, < 0 on error 351f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project */ 352f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project int (*data_close)(struct sensors_data_device_t *dev); 353f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 354f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project /** 355f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * Return sensor data for one of the enabled sensors. 356f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * 357f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * @return sensor handle for the returned data, 0x7FFFFFFF when 358f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * sensors_control_device_t.wake() is called and -errno on error 359f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project * 360f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project */ 361f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project int (*poll)(struct sensors_data_device_t *dev, 362f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project sensors_data_t* data); 363f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project}; 364f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 365f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 366f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project/** convenience API for opening and closing a device */ 367f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 368f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Projectstatic inline int sensors_control_open(const struct hw_module_t* module, 369f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project struct sensors_control_device_t** device) { 370f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project return module->methods->open(module, 371f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project SENSORS_HARDWARE_CONTROL, (struct hw_device_t**)device); 372f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project} 373f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 374f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Projectstatic inline int sensors_control_close(struct sensors_control_device_t* device) { 375f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project return device->common.close(&device->common); 376f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project} 377f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 378f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Projectstatic inline int sensors_data_open(const struct hw_module_t* module, 379f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project struct sensors_data_device_t** device) { 380f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project return module->methods->open(module, 381f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project SENSORS_HARDWARE_DATA, (struct hw_device_t**)device); 382f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project} 383f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 384f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Projectstatic inline int sensors_data_close(struct sensors_data_device_t* device) { 385f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project return device->common.close(&device->common); 386f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project} 387f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 388f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 389f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project__END_DECLS 390f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project 391f53ebec38718ff5d6b2aff2fa62b92a75d007ca5The Android Open Source Project#endif // ANDROID_SENSORS_INTERFACE_H 392