1/* 2 * Copyright (C) 2018 The Android Open Source Project 3 * 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 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 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. 15 */ 16 17syntax = "proto2"; 18package android.os; 19 20option java_outer_classname = "OsProtoEnums"; 21option java_multiple_files = true; 22 23// These constants are defined in hardware/interfaces/health/1.0/types.hal 24// They are primarily used by android/os/BatteryManager.java. 25enum BatteryHealthEnum { 26 BATTERY_HEALTH_INVALID = 0; 27 BATTERY_HEALTH_UNKNOWN = 1; 28 BATTERY_HEALTH_GOOD = 2; 29 BATTERY_HEALTH_OVERHEAT = 3; 30 BATTERY_HEALTH_DEAD = 4; 31 BATTERY_HEALTH_OVER_VOLTAGE = 5; 32 BATTERY_HEALTH_UNSPECIFIED_FAILURE = 6; 33 BATTERY_HEALTH_COLD = 7; 34} 35 36// Plug states, primarily used by android/os/BatteryManager.java. 37enum BatteryPluggedStateEnum { 38 // Note that NONE is not in BatteryManager.java's constants. 39 BATTERY_PLUGGED_NONE = 0; 40 // Power source is an AC charger. 41 BATTERY_PLUGGED_AC = 1; 42 // Power source is a USB port. 43 BATTERY_PLUGGED_USB = 2; 44 // Power source is wireless. 45 BATTERY_PLUGGED_WIRELESS = 4; 46} 47 48// These constants are defined in hardware/interfaces/health/1.0/types.hal 49// They are primarily used by android/os/BatteryManager.java. 50enum BatteryStatusEnum { 51 BATTERY_STATUS_INVALID = 0; 52 BATTERY_STATUS_UNKNOWN = 1; 53 BATTERY_STATUS_CHARGING = 2; 54 BATTERY_STATUS_DISCHARGING = 3; 55 BATTERY_STATUS_NOT_CHARGING = 4; 56 BATTERY_STATUS_FULL = 5; 57} 58 59enum PowerComponentEnum { 60 POWER_COMPONENT_SCREEN = 0; 61 POWER_COMPONENT_CPU = 1; 62 POWER_COMPONENT_BLUETOOTH = 2; 63 POWER_COMPONENT_CAMERA = 3; 64 POWER_COMPONENT_AUDIO = 4; 65 POWER_COMPONENT_VIDEO = 5; 66 POWER_COMPONENT_FLASHLIGHT = 6; 67 POWER_COMPONENT_SYSTEM_SERVICES = 7; 68 POWER_COMPONENT_MOBILE_RADIO = 8; 69 POWER_COMPONENT_SENSORS = 9; 70 POWER_COMPONENT_GNSS = 10; 71 POWER_COMPONENT_WIFI = 11; 72 POWER_COMPONENT_WAKELOCK = 12; 73 POWER_COMPONENT_MEMORY = 13; 74 POWER_COMPONENT_PHONE = 14; 75 POWER_COMPONENT_AMBIENT_DISPLAY = 15; 76 POWER_COMPONENT_IDLE = 16; 77 // Power that is re-attributed to other battery consumers. For example, for System Server 78 // this represents the power attributed to apps requesting system services. 79 // The value should be negative or zero. 80 POWER_COMPONENT_REATTRIBUTED_TO_OTHER_CONSUMERS = 17; 81} 82 83// These constants are defined in hardware/interfaces/thermal/1.0/types.hal 84// and in hardware/interfaces/thermal/2.0/types.hal 85// They are primarily used by android/os/HardwarePropertiesManager.java. 86// Any change to the types in the thermal hal should be made here as well. 87enum TemperatureTypeEnum { 88 TEMPERATURE_TYPE_UNKNOWN = -1; 89 TEMPERATURE_TYPE_CPU = 0; 90 TEMPERATURE_TYPE_GPU = 1; 91 TEMPERATURE_TYPE_BATTERY = 2; 92 TEMPERATURE_TYPE_SKIN = 3; 93 TEMPERATURE_TYPE_USB_PORT = 4; 94 TEMPERATURE_TYPE_POWER_AMPLIFIER = 5; 95 96 // Battery Charge Limit - virtual thermal sensors. 97 TEMPERATURE_TYPE_BCL_VOLTAGE = 6; 98 TEMPERATURE_TYPE_BCL_CURRENT = 7; 99 TEMPERATURE_TYPE_BCL_PERCENTAGE = 8; 100 101 // Neural Processing Unit. 102 TEMPERATURE_TYPE_NPU = 9; 103} 104 105// Device throttling severity 106// These constants are defined in hardware/interfaces/thermal/2.0/types.hal. 107// Any change to the types in the thermal hal should be made here as well. 108enum ThrottlingSeverityEnum { 109 // Not under throttling. 110 NONE = 0; 111 // Light throttling where UX is not impacted. 112 LIGHT = 1; 113 // Moderate throttling where UX is not largely impacted. 114 MODERATE = 2; 115 // Severe throttling where UX is largely impacted. 116 // Similar to 1.0 throttlingThreshold. 117 SEVERE = 3; 118 // Platform has done everything to reduce power. 119 CRITICAL = 4; 120 // Key components in platform are shutting down due to thermal condition. 121 // Device functionalities will be limited. 122 EMERGENCY = 5; 123 // Need shutdown immediately. 124 SHUTDOWN = 6; 125}; 126 127// Device cooling device types. 128// These constants are defined in hardware/interfaces/thermal/2.0/types.hal. 129// Any change to the types in the thermal hal should be made here as well. 130enum CoolingTypeEnum { 131 FAN = 0; 132 BATTERY = 1; 133 CPU = 2; 134 GPU = 3; 135 MODEM = 4; 136 NPU = 5; 137 COMPONENT = 6; 138}; 139 140// Wakelock types, primarily used by android/os/PowerManager.java. 141enum WakeLockLevelEnum { 142 // NOTE: Wake lock levels were previously defined as a bit field, except 143 // that only a few combinations were actually supported so the bit field 144 // was removed. This explains why the numbering scheme is so odd. If 145 // adding a new wake lock level, any unused value can be used. 146 147 // Ensures that the CPU is running; the screen and keyboard backlight 148 // will be allowed to go off. 149 PARTIAL_WAKE_LOCK = 1; 150 151 // Ensures that the screen is on (but may be dimmed); the keyboard 152 // backlight will be allowed to go off. If the user presses the power 153 // button, then the SCREEN_DIM_WAKE_LOCK will be implicitly released by 154 // the system, causing both the screen and the CPU to be turned off. 155 SCREEN_DIM_WAKE_LOCK = 6 [deprecated = true]; 156 157 // Ensures that the screen is on at full brightness; the keyboard 158 // backlight will be allowed to go off. If the user presses the power 159 // button, then the SCREEN_BRIGHT_WAKE_LOCK will be implicitly released 160 // by the system, causing both the screen and the CPU to be turned off. 161 SCREEN_BRIGHT_WAKE_LOCK = 10 [deprecated = true]; 162 163 // Ensures that the screen and keyboard backlight are on at full 164 // brightness. If the user presses the power button, then the 165 // FULL_WAKE_LOCK will be implicitly released by the system, causing 166 // both the screen and the CPU to be turned off. 167 FULL_WAKE_LOCK = 26 [deprecated = true]; 168 169 // Turns the screen off when the proximity sensor activates. If the 170 // proximity sensor detects that an object is nearby, the screen turns 171 // off immediately. Shortly after the object moves away, the screen 172 // turns on again. 173 // A proximity wake lock does not prevent the device from falling asleep 174 // unlike FULL_WAKE_LOCK, SCREEN_BRIGHT_WAKE_LOCK and 175 // SCREEN_DIM_WAKE_LOCK. If there is no user activity and no other wake 176 // locks are held, then the device will fall asleep (and lock) as usual. 177 // However, the device will not fall asleep while the screen has been 178 // turned off by the proximity sensor because it effectively counts as 179 // ongoing user activity. 180 PROXIMITY_SCREEN_OFF_WAKE_LOCK = 32; 181 182 // Put the screen in a low power state and allow the CPU to suspend if 183 // no other wake locks are held. This is used by the dream manager to 184 // implement doze mode. It currently has no effect unless the power 185 // manager is in the dozing state. 186 DOZE_WAKE_LOCK = 64; 187 188 // Keep the device awake enough to allow drawing to occur. This is used 189 // by the window manager to allow applications to draw while the system 190 // is dozing. It currently has no effect unless the power manager is in 191 // the dozing state. 192 DRAW_WAKE_LOCK = 128; 193} 194