2 * Copyright (C) 2008 The Android Open Source Project
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 #ifndef ANDROID_LIGHTS_INTERFACE_H
18 #define ANDROID_LIGHTS_INTERFACE_H
21 #include <sys/cdefs.h>
22 #include <sys/types.h>
24 #include <hardware/hardware.h>
29 * The id of this module
31 #define LIGHTS_HARDWARE_MODULE_ID "lights"
34 * These light IDs correspond to logical lights, not physical.
35 * So for example, if your INDICATOR light is in line with your
36 * BUTTONS, it might make sense to also light the INDICATOR
37 * light to a reasonable color when the BUTTONS are lit.
39 #define LIGHT_ID_BACKLIGHT "backlight"
40 #define LIGHT_ID_KEYBOARD "keyboard"
41 #define LIGHT_ID_BUTTONS "buttons"
42 #define LIGHT_ID_BATTERY "battery"
43 #define LIGHT_ID_NOTIFICATIONS "notifications"
44 #define LIGHT_ID_ATTENTION "attention"
47 * These lights aren't currently supported by the higher
48 * layers, but could be someday, so we have the constants
51 #define LIGHT_ID_BLUETOOTH "bluetooth"
52 #define LIGHT_ID_WIFI "wifi"
55 * Additional hardware-specific lights
57 #define LIGHT_ID_CAPS "caps"
58 #define LIGHT_ID_FUNC "func"
59 #define LIGHT_ID_WIMAX "wimax"
60 #define LIGHT_ID_FLASHLIGHT "flashlight"
62 /* ************************************************************************
63 * Flash modes for the flashMode field of light_state_t.
66 #define LIGHT_FLASH_NONE 0
69 * To flash the light at a given rate, set flashMode to LIGHT_FLASH_TIMED,
70 * and then flashOnMS should be set to the number of milliseconds to turn
71 * the light on, followed by the number of milliseconds to turn the light
74 #define LIGHT_FLASH_TIMED 1
77 * To flash the light using hardware assist, set flashMode to
80 #define LIGHT_FLASH_HARDWARE 2
83 * Light brightness is managed by a user setting.
85 #define BRIGHTNESS_MODE_USER 0
88 * Light brightness is managed by a light sensor.
90 #define BRIGHTNESS_MODE_SENSOR 1
93 * The parameters that can be set for a given light.
95 * Not all lights must support all parameters. If you
96 * can do something backward-compatible, you should.
98 struct light_state_t
{
100 * The color of the LED in ARGB.
103 * - If your light can only do red or green, if they ask for blue,
104 * you should do green.
105 * - If you can only do a brightness ramp, then use this formula:
106 * unsigned char brightness = ((77*((color>>16)&0x00ff))
107 * + (150*((color>>8)&0x00ff)) + (29*(color&0x00ff))) >> 8;
108 * - If you can only do on or off, 0 is off, anything else is on.
110 * The high byte should be ignored. Callers will set it to 0xff (which
111 * would correspond to 255 alpha).
116 * See the LIGHT_FLASH_* constants
123 * Policy used by the framework to manage the light's brightness.
124 * Currently the values are BRIGHTNESS_MODE_USER and BRIGHTNESS_MODE_SENSOR.
129 struct light_device_t
{
130 struct hw_device_t common
;
133 * Set the provided lights to the provided values.
135 * Returns: 0 on succes, error code on failure.
137 int (*set_light
)(struct light_device_t
* dev
,
138 struct light_state_t
const* state
);
144 #endif // ANDROID_LIGHTS_INTERFACE_H