stats/enums/os/enums.proto - aosp/platform/frameworks/proto_logging - Git at Google

 /*
  * Copyright (C) 2018 The Android Open Source Project
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *      http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */

 syntax = "proto2";
 package android.os;

 option java_outer_classname = "OsProtoEnums";
 option java_multiple_files = true;

 // These constants are defined in hardware/interfaces/health/1.0/types.hal
 // They are primarily used by android/os/BatteryManager.java.
 enum BatteryHealthEnum {
     BATTERY_HEALTH_INVALID = 0;
     BATTERY_HEALTH_UNKNOWN = 1;
     BATTERY_HEALTH_GOOD = 2;
     BATTERY_HEALTH_OVERHEAT = 3;
     BATTERY_HEALTH_DEAD = 4;
     BATTERY_HEALTH_OVER_VOLTAGE = 5;
     BATTERY_HEALTH_UNSPECIFIED_FAILURE = 6;
     BATTERY_HEALTH_COLD = 7;
     BATTERY_HEALTH_FAIR = 8;
     BATTERY_HEALTH_NOT_AVAILABLE = 11;
     BATTERY_HEALTH_INCONSISTENT = 12;
 }

 // Plug states, primarily used by android/os/BatteryManager.java.
 enum BatteryPluggedStateEnum {
     // Note that NONE is not in BatteryManager.java's constants.
     BATTERY_PLUGGED_NONE = 0;
     // Power source is an AC charger.
     BATTERY_PLUGGED_AC = 1;
     // Power source is a USB port.
     BATTERY_PLUGGED_USB = 2;
     // Power source is wireless.
     BATTERY_PLUGGED_WIRELESS = 4;
     // Power source is dock.
     BATTERY_PLUGGED_DOCK = 8;
 }

 // These constants are defined in hardware/interfaces/health/1.0/types.hal
 // They are primarily used by android/os/BatteryManager.java.
 enum BatteryStatusEnum {
     BATTERY_STATUS_INVALID = 0;
     BATTERY_STATUS_UNKNOWN = 1;
     BATTERY_STATUS_CHARGING = 2;
     BATTERY_STATUS_DISCHARGING = 3;
     BATTERY_STATUS_NOT_CHARGING = 4;
     BATTERY_STATUS_FULL = 5;
 }

 enum PowerComponentEnum {
     POWER_COMPONENT_SCREEN = 0;
     POWER_COMPONENT_CPU = 1;
     POWER_COMPONENT_BLUETOOTH = 2;
     POWER_COMPONENT_CAMERA = 3;
     POWER_COMPONENT_AUDIO = 4;
     POWER_COMPONENT_VIDEO = 5;
     POWER_COMPONENT_FLASHLIGHT = 6;
     POWER_COMPONENT_SYSTEM_SERVICES = 7;
     POWER_COMPONENT_MOBILE_RADIO = 8;
     POWER_COMPONENT_SENSORS = 9;
     POWER_COMPONENT_GNSS = 10;
     POWER_COMPONENT_WIFI = 11;
     POWER_COMPONENT_WAKELOCK = 12;
     POWER_COMPONENT_MEMORY = 13;
     POWER_COMPONENT_PHONE = 14;
     POWER_COMPONENT_AMBIENT_DISPLAY = 15;
     POWER_COMPONENT_IDLE = 16;
     // Power that is re-attributed to other battery consumers. For example, for System Server
     // this represents the power attributed to apps requesting system services.
     // The value should be negative or zero.
     POWER_COMPONENT_REATTRIBUTED_TO_OTHER_CONSUMERS = 17;
 }

 // These constants are defined in hardware/interfaces/thermal/1.0/types.hal
 // and in hardware/interfaces/thermal/2.0/types.hal
 // They are primarily used by android/os/HardwarePropertiesManager.java.
 // Any change to the types in the thermal hal should be made here as well.
 enum TemperatureTypeEnum {
     TEMPERATURE_TYPE_UNKNOWN = -1;
     TEMPERATURE_TYPE_CPU = 0;
     TEMPERATURE_TYPE_GPU = 1;
     TEMPERATURE_TYPE_BATTERY = 2;
     TEMPERATURE_TYPE_SKIN = 3;
     TEMPERATURE_TYPE_USB_PORT = 4;
     TEMPERATURE_TYPE_POWER_AMPLIFIER = 5;

     // Battery Charge Limit - virtual thermal sensors.
     TEMPERATURE_TYPE_BCL_VOLTAGE = 6;
     TEMPERATURE_TYPE_BCL_CURRENT = 7;
     TEMPERATURE_TYPE_BCL_PERCENTAGE = 8;

     // Neural Processing Unit.
     TEMPERATURE_TYPE_NPU = 9;
     TEMPERATURE_TYPE_TPU = 10;
     TEMPERATURE_TYPE_DISPLAY = 11;
     TEMPERATURE_TYPE_MODEM = 12;
     TEMPERATURE_TYPE_SOC = 13;
     TEMPERATURE_TYPE_WIFI = 14;
     TEMPERATURE_TYPE_CAMERA = 15;
     TEMPERATURE_TYPE_FLASHLIGHT = 16;
     TEMPERATURE_TYPE_SPEAKER = 17;
     TEMPERATURE_TYPE_AMBIENT = 18;
     TEMPERATURE_TYPE_POGO = 19;
 }

 // Device throttling severity
 // These constants are defined in hardware/interfaces/thermal/2.0/types.hal.
 // Any change to the types in the thermal hal should be made here as well.
 enum ThrottlingSeverityEnum {
     // Not under throttling.
     NONE = 0;
     // Light throttling where UX is not impacted.
     LIGHT = 1;
     // Moderate throttling where UX is not largely impacted.
     MODERATE = 2;
     // Severe throttling where UX is largely impacted.
     // Similar to 1.0 throttlingThreshold.
     SEVERE = 3;
     // Platform has done everything to reduce power.
     CRITICAL = 4;
     // Key components in platform are shutting down due to thermal condition.
     // Device functionalities will be limited.
     EMERGENCY = 5;
     // Need shutdown immediately.
     SHUTDOWN = 6;
 };

 // Device cooling device types.
 // These constants are defined in hardware/interfaces/thermal/2.0/types.hal.
 // Any change to the types in the thermal hal should be made here as well.
 enum CoolingTypeEnum {
     FAN = 0;
     BATTERY = 1;
     CPU = 2;
     GPU = 3;
     MODEM = 4;
     NPU = 5;
     COMPONENT = 6;
     TPU = 7;
     POWER_AMPLIFIER = 8;
     DISPLAY = 9;
     SPEAKER = 10;
     WIFI = 11;
     CAMERA = 12;
     FLASHLIGHT = 13;
     USB_PORT = 14;
 };

 // Wakelock types, primarily used by android/os/PowerManager.java.
 enum WakeLockLevelEnum {
     // NOTE: Wake lock levels were previously defined as a bit field, except
     // that only a few combinations were actually supported so the bit field
     // was removed. This explains why the numbering scheme is so odd. If
     // adding a new wake lock level, any unused value can be used.

     // Ensures that the CPU is running; the screen and keyboard backlight
     // will be allowed to go off.
     PARTIAL_WAKE_LOCK = 1;

     // Ensures that the screen is on (but may be dimmed); the keyboard
     // backlight will be allowed to go off. If the user presses the power
     // button, then the SCREEN_DIM_WAKE_LOCK will be implicitly released by
     // the system, causing both the screen and the CPU to be turned off.
     SCREEN_DIM_WAKE_LOCK = 6 [deprecated = true];

     // Ensures that the screen is on at full brightness; the keyboard
     // backlight will be allowed to go off. If the user presses the power
     // button, then the SCREEN_BRIGHT_WAKE_LOCK will be implicitly released
     // by the system, causing both the screen and the CPU to be turned off.
     SCREEN_BRIGHT_WAKE_LOCK = 10 [deprecated = true];

     // Ensures that the screen and keyboard backlight are on at full
     // brightness. If the user presses the power button, then the
     // FULL_WAKE_LOCK will be implicitly released by the system, causing
     // both the screen and the CPU to be turned off.
     FULL_WAKE_LOCK = 26 [deprecated = true];

     // Turns the screen off when the proximity sensor activates. If the
     // proximity sensor detects that an object is nearby, the screen turns
     // off immediately. Shortly after the object moves away, the screen
     // turns on again.
     // A proximity wake lock does not prevent the device from falling asleep
     // unlike FULL_WAKE_LOCK, SCREEN_BRIGHT_WAKE_LOCK and
     // SCREEN_DIM_WAKE_LOCK. If there is no user activity and no other wake
     // locks are held, then the device will fall asleep (and lock) as usual.
     // However, the device will not fall asleep while the screen has been
     // turned off by the proximity sensor because it effectively counts as
     // ongoing user activity.
     PROXIMITY_SCREEN_OFF_WAKE_LOCK = 32;

     // Put the screen in a low power state and allow the CPU to suspend if
     // no other wake locks are held. This is used by the dream manager to
     // implement doze mode. It currently has no effect unless the power
     // manager is in the dozing state.
     DOZE_WAKE_LOCK = 64;

     // Keep the device awake enough to allow drawing to occur. This is used
     // by the window manager to allow applications to draw while the system
     // is dozing. It currently has no effect unless the power manager is in
     // the dozing state.
     DRAW_WAKE_LOCK = 128;
 }

 // They are primarily used by android/os/BatteryManager.java.
 enum BatteryChargingStatusEnum {
     BATTERY_STATUS_NORMAL = 1;
     BATTERY_STATUS_TOO_COLD = 2;
     BATTERY_STATUS_TOO_HOT = 3;
     BATTERY_STATUS_LONG_LIFE = 4;
     BATTERY_STATUS_ADAPTIVE = 5;
 }


 // They are primarily used by android/os/BatteryManager.java.
 enum BatteryChargingPolicyEnum {
     CHARGING_POLICY_DEFAULT = 1;
     CHARGING_POLICY_ADAPTIVE_AON = 2;
     CHARGING_POLICY_ADAPTIVE_AC = 3;
     CHARGING_POLICY_ADAPTIVE_LONGLIFE = 4;
 }
	/*
	* Copyright (C) 2018 The Android Open Source Project
	*
	* Licensed under the Apache License, Version 2.0 (the "License");
	* you may not use this file except in compliance with the License.
	* You may obtain a copy of the License at
	*
	* http://www.apache.org/licenses/LICENSE-2.0
	*
	* Unless required by applicable law or agreed to in writing, software
	* distributed under the License is distributed on an "AS IS" BASIS,
	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	* See the License for the specific language governing permissions and
	* limitations under the License.
	*/

	syntax = "proto2";
	package android.os;

	option java_outer_classname = "OsProtoEnums";
	option java_multiple_files = true;

	// These constants are defined in hardware/interfaces/health/1.0/types.hal
	// They are primarily used by android/os/BatteryManager.java.
	enum BatteryHealthEnum {
	BATTERY_HEALTH_INVALID = 0;
	BATTERY_HEALTH_UNKNOWN = 1;
	BATTERY_HEALTH_GOOD = 2;
	BATTERY_HEALTH_OVERHEAT = 3;
	BATTERY_HEALTH_DEAD = 4;
	BATTERY_HEALTH_OVER_VOLTAGE = 5;
	BATTERY_HEALTH_UNSPECIFIED_FAILURE = 6;
	BATTERY_HEALTH_COLD = 7;
	BATTERY_HEALTH_FAIR = 8;
	BATTERY_HEALTH_NOT_AVAILABLE = 11;
	BATTERY_HEALTH_INCONSISTENT = 12;
	}

	// Plug states, primarily used by android/os/BatteryManager.java.
	enum BatteryPluggedStateEnum {
	// Note that NONE is not in BatteryManager.java's constants.
	BATTERY_PLUGGED_NONE = 0;
	// Power source is an AC charger.
	BATTERY_PLUGGED_AC = 1;
	// Power source is a USB port.
	BATTERY_PLUGGED_USB = 2;
	// Power source is wireless.
	BATTERY_PLUGGED_WIRELESS = 4;
	// Power source is dock.
	BATTERY_PLUGGED_DOCK = 8;
	}

	// These constants are defined in hardware/interfaces/health/1.0/types.hal
	// They are primarily used by android/os/BatteryManager.java.
	enum BatteryStatusEnum {
	BATTERY_STATUS_INVALID = 0;
	BATTERY_STATUS_UNKNOWN = 1;
	BATTERY_STATUS_CHARGING = 2;
	BATTERY_STATUS_DISCHARGING = 3;
	BATTERY_STATUS_NOT_CHARGING = 4;
	BATTERY_STATUS_FULL = 5;
	}

	enum PowerComponentEnum {
	POWER_COMPONENT_SCREEN = 0;
	POWER_COMPONENT_CPU = 1;
	POWER_COMPONENT_BLUETOOTH = 2;
	POWER_COMPONENT_CAMERA = 3;
	POWER_COMPONENT_AUDIO = 4;
	POWER_COMPONENT_VIDEO = 5;
	POWER_COMPONENT_FLASHLIGHT = 6;
	POWER_COMPONENT_SYSTEM_SERVICES = 7;
	POWER_COMPONENT_MOBILE_RADIO = 8;
	POWER_COMPONENT_SENSORS = 9;
	POWER_COMPONENT_GNSS = 10;
	POWER_COMPONENT_WIFI = 11;
	POWER_COMPONENT_WAKELOCK = 12;
	POWER_COMPONENT_MEMORY = 13;
	POWER_COMPONENT_PHONE = 14;
	POWER_COMPONENT_AMBIENT_DISPLAY = 15;
	POWER_COMPONENT_IDLE = 16;
	// Power that is re-attributed to other battery consumers. For example, for System Server
	// this represents the power attributed to apps requesting system services.
	// The value should be negative or zero.
	POWER_COMPONENT_REATTRIBUTED_TO_OTHER_CONSUMERS = 17;
	}

	// These constants are defined in hardware/interfaces/thermal/1.0/types.hal
	// and in hardware/interfaces/thermal/2.0/types.hal
	// They are primarily used by android/os/HardwarePropertiesManager.java.
	// Any change to the types in the thermal hal should be made here as well.
	enum TemperatureTypeEnum {
	TEMPERATURE_TYPE_UNKNOWN = -1;
	TEMPERATURE_TYPE_CPU = 0;
	TEMPERATURE_TYPE_GPU = 1;
	TEMPERATURE_TYPE_BATTERY = 2;
	TEMPERATURE_TYPE_SKIN = 3;
	TEMPERATURE_TYPE_USB_PORT = 4;
	TEMPERATURE_TYPE_POWER_AMPLIFIER = 5;

	// Battery Charge Limit - virtual thermal sensors.
	TEMPERATURE_TYPE_BCL_VOLTAGE = 6;
	TEMPERATURE_TYPE_BCL_CURRENT = 7;
	TEMPERATURE_TYPE_BCL_PERCENTAGE = 8;

	// Neural Processing Unit.
	TEMPERATURE_TYPE_NPU = 9;
	TEMPERATURE_TYPE_TPU = 10;
	TEMPERATURE_TYPE_DISPLAY = 11;
	TEMPERATURE_TYPE_MODEM = 12;
	TEMPERATURE_TYPE_SOC = 13;
	TEMPERATURE_TYPE_WIFI = 14;
	TEMPERATURE_TYPE_CAMERA = 15;
	TEMPERATURE_TYPE_FLASHLIGHT = 16;
	TEMPERATURE_TYPE_SPEAKER = 17;
	TEMPERATURE_TYPE_AMBIENT = 18;
	TEMPERATURE_TYPE_POGO = 19;
	}

	// Device throttling severity
	// These constants are defined in hardware/interfaces/thermal/2.0/types.hal.
	// Any change to the types in the thermal hal should be made here as well.
	enum ThrottlingSeverityEnum {
	// Not under throttling.
	NONE = 0;
	// Light throttling where UX is not impacted.
	LIGHT = 1;
	// Moderate throttling where UX is not largely impacted.
	MODERATE = 2;
	// Severe throttling where UX is largely impacted.
	// Similar to 1.0 throttlingThreshold.
	SEVERE = 3;
	// Platform has done everything to reduce power.
	CRITICAL = 4;
	// Key components in platform are shutting down due to thermal condition.
	// Device functionalities will be limited.
	EMERGENCY = 5;
	// Need shutdown immediately.
	SHUTDOWN = 6;
	};

	// Device cooling device types.
	// These constants are defined in hardware/interfaces/thermal/2.0/types.hal.
	// Any change to the types in the thermal hal should be made here as well.
	enum CoolingTypeEnum {
	FAN = 0;
	BATTERY = 1;
	CPU = 2;
	GPU = 3;
	MODEM = 4;
	NPU = 5;
	COMPONENT = 6;
	TPU = 7;
	POWER_AMPLIFIER = 8;
	DISPLAY = 9;
	SPEAKER = 10;
	WIFI = 11;
	CAMERA = 12;
	FLASHLIGHT = 13;
	USB_PORT = 14;
	};

	// Wakelock types, primarily used by android/os/PowerManager.java.
	enum WakeLockLevelEnum {
	// NOTE: Wake lock levels were previously defined as a bit field, except
	// that only a few combinations were actually supported so the bit field
	// was removed. This explains why the numbering scheme is so odd. If
	// adding a new wake lock level, any unused value can be used.

	// Ensures that the CPU is running; the screen and keyboard backlight
	// will be allowed to go off.
	PARTIAL_WAKE_LOCK = 1;

	// Ensures that the screen is on (but may be dimmed); the keyboard
	// backlight will be allowed to go off. If the user presses the power
	// button, then the SCREEN_DIM_WAKE_LOCK will be implicitly released by
	// the system, causing both the screen and the CPU to be turned off.
	SCREEN_DIM_WAKE_LOCK = 6 [deprecated = true];

	// Ensures that the screen is on at full brightness; the keyboard
	// backlight will be allowed to go off. If the user presses the power
	// button, then the SCREEN_BRIGHT_WAKE_LOCK will be implicitly released
	// by the system, causing both the screen and the CPU to be turned off.
	SCREEN_BRIGHT_WAKE_LOCK = 10 [deprecated = true];

	// Ensures that the screen and keyboard backlight are on at full
	// brightness. If the user presses the power button, then the
	// FULL_WAKE_LOCK will be implicitly released by the system, causing
	// both the screen and the CPU to be turned off.
	FULL_WAKE_LOCK = 26 [deprecated = true];

	// Turns the screen off when the proximity sensor activates. If the
	// proximity sensor detects that an object is nearby, the screen turns
	// off immediately. Shortly after the object moves away, the screen
	// turns on again.
	// A proximity wake lock does not prevent the device from falling asleep
	// unlike FULL_WAKE_LOCK, SCREEN_BRIGHT_WAKE_LOCK and
	// SCREEN_DIM_WAKE_LOCK. If there is no user activity and no other wake
	// locks are held, then the device will fall asleep (and lock) as usual.
	// However, the device will not fall asleep while the screen has been
	// turned off by the proximity sensor because it effectively counts as
	// ongoing user activity.
	PROXIMITY_SCREEN_OFF_WAKE_LOCK = 32;

	// Put the screen in a low power state and allow the CPU to suspend if
	// no other wake locks are held. This is used by the dream manager to
	// implement doze mode. It currently has no effect unless the power
	// manager is in the dozing state.
	DOZE_WAKE_LOCK = 64;

	// Keep the device awake enough to allow drawing to occur. This is used
	// by the window manager to allow applications to draw while the system
	// is dozing. It currently has no effect unless the power manager is in
	// the dozing state.
	DRAW_WAKE_LOCK = 128;
	}

	// They are primarily used by android/os/BatteryManager.java.
	enum BatteryChargingStatusEnum {
	BATTERY_STATUS_NORMAL = 1;
	BATTERY_STATUS_TOO_COLD = 2;
	BATTERY_STATUS_TOO_HOT = 3;
	BATTERY_STATUS_LONG_LIFE = 4;
	BATTERY_STATUS_ADAPTIVE = 5;
	}


	// They are primarily used by android/os/BatteryManager.java.
	enum BatteryChargingPolicyEnum {
	CHARGING_POLICY_DEFAULT = 1;
	CHARGING_POLICY_ADAPTIVE_AON = 2;
	CHARGING_POLICY_ADAPTIVE_AC = 3;
	CHARGING_POLICY_ADAPTIVE_LONGLIFE = 4;
	}