diff options
author | Ruchi Kandoi <kandoiruchi@google.com> | 2016-08-24 13:35:06 -0700 |
---|---|---|
committer | Ruchi Kandoi <kandoiruchi@google.com> | 2016-10-11 09:39:09 -0700 |
commit | 3becdbb84d5eb88fc17624fbd71b0435d5abbf12 (patch) | |
tree | 0b7b87f88be8344d3c77fd55a86f0f532ee0d6b6 | |
parent | 091183962102c15b2228aaf0027798808ded1e76 (diff) | |
download | platform_hardware_interfaces-3becdbb84d5eb88fc17624fbd71b0435d5abbf12.tar.gz platform_hardware_interfaces-3becdbb84d5eb88fc17624fbd71b0435d5abbf12.tar.bz2 platform_hardware_interfaces-3becdbb84d5eb88fc17624fbd71b0435d5abbf12.zip |
power: Add Power interface 1.0
Bug: 31177288
Change-Id: I9c243166515b565ac73e5f47ff86cfacf59d46d3
Signed-off-by: Ruchi Kandoi <kandoiruchi@google.com>
-rw-r--r-- | Android.bp | 1 | ||||
-rw-r--r-- | power/1.0/Android.bp | 46 | ||||
-rw-r--r-- | power/1.0/Android.mk | 238 | ||||
-rw-r--r-- | power/1.0/IPower.hal | 89 | ||||
-rw-r--r-- | power/1.0/types.hal | 168 |
5 files changed, 542 insertions, 0 deletions
diff --git a/Android.bp b/Android.bp index 3ab20708ef..417ce5d573 100644 --- a/Android.bp +++ b/Android.bp @@ -6,6 +6,7 @@ subdirs = [ "nfc/1.0", "nfc/1.0/default", "radio/1.0", + "power/1.0", "tests/bar/1.0", "tests/baz/1.0", "tests/expression/1.0", diff --git a/power/1.0/Android.bp b/power/1.0/Android.bp new file mode 100644 index 0000000000..9b4d81e7ae --- /dev/null +++ b/power/1.0/Android.bp @@ -0,0 +1,46 @@ +// This file is autogenerated by hidl-gen. Do not edit manually. + +genrule { + name: "android.hardware.power@1.0_genc++", + tool: "hidl-gen", + cmd: "$tool -o $genDir -Lc++ -randroid.hardware:hardware/interfaces android.hardware.power@1.0", + srcs: [ + "types.hal", + "IPower.hal", + ], + out: [ + "android/hardware/power/1.0/types.cpp", + "android/hardware/power/1.0/PowerAll.cpp", + ], +} + +genrule { + name: "android.hardware.power@1.0_genc++_headers", + tool: "hidl-gen", + cmd: "$tool -o $genDir -Lc++ -randroid.hardware:hardware/interfaces android.hardware.power@1.0", + srcs: [ + "types.hal", + "IPower.hal", + ], + out: [ + "android/hardware/power/1.0/types.h", + "android/hardware/power/1.0/IPower.h", + "android/hardware/power/1.0/IHwPower.h", + "android/hardware/power/1.0/BnPower.h", + "android/hardware/power/1.0/BpPower.h", + "android/hardware/power/1.0/BsPower.h", + ], +} + +cc_library_shared { + name: "android.hardware.power@1.0", + generated_sources: ["android.hardware.power@1.0_genc++"], + generated_headers: ["android.hardware.power@1.0_genc++_headers"], + export_generated_headers: ["android.hardware.power@1.0_genc++_headers"], + shared_libs: [ + "libhidl", + "libhwbinder", + "libutils", + "libcutils", + ], +} diff --git a/power/1.0/Android.mk b/power/1.0/Android.mk new file mode 100644 index 0000000000..5f1260b95f --- /dev/null +++ b/power/1.0/Android.mk @@ -0,0 +1,238 @@ +# This file is autogenerated by hidl-gen. Do not edit manually. + +LOCAL_PATH := $(call my-dir) + +################################################################################ + +include $(CLEAR_VARS) +LOCAL_MODULE := android.hardware.power@1.0-java +LOCAL_MODULE_CLASS := JAVA_LIBRARIES + +intermediates := $(local-generated-sources-dir) + +HIDL := $(HOST_OUT_EXECUTABLES)/hidl-gen$(HOST_EXECUTABLE_SUFFIX) + +# +# Build types.hal (Feature) +# +GEN := $(intermediates)/android/hardware/power/1.0/Feature.java +$(GEN): $(HIDL) +$(GEN): PRIVATE_HIDL := $(HIDL) +$(GEN): PRIVATE_DEPS := $(LOCAL_PATH)/types.hal +$(GEN): PRIVATE_OUTPUT_DIR := $(intermediates) +$(GEN): PRIVATE_CUSTOM_TOOL = \ + $(PRIVATE_HIDL) -o $(PRIVATE_OUTPUT_DIR) \ + -Ljava -randroid.hardware:hardware/interfaces \ + android.hardware.power@1.0::types.Feature + +$(GEN): $(LOCAL_PATH)/types.hal + $(transform-generated-source) +LOCAL_GENERATED_SOURCES += $(GEN) + +# +# Build types.hal (PowerHint) +# +GEN := $(intermediates)/android/hardware/power/1.0/PowerHint.java +$(GEN): $(HIDL) +$(GEN): PRIVATE_HIDL := $(HIDL) +$(GEN): PRIVATE_DEPS := $(LOCAL_PATH)/types.hal +$(GEN): PRIVATE_OUTPUT_DIR := $(intermediates) +$(GEN): PRIVATE_CUSTOM_TOOL = \ + $(PRIVATE_HIDL) -o $(PRIVATE_OUTPUT_DIR) \ + -Ljava -randroid.hardware:hardware/interfaces \ + android.hardware.power@1.0::types.PowerHint + +$(GEN): $(LOCAL_PATH)/types.hal + $(transform-generated-source) +LOCAL_GENERATED_SOURCES += $(GEN) + +# +# Build types.hal (PowerStatePlatformSleepState) +# +GEN := $(intermediates)/android/hardware/power/1.0/PowerStatePlatformSleepState.java +$(GEN): $(HIDL) +$(GEN): PRIVATE_HIDL := $(HIDL) +$(GEN): PRIVATE_DEPS := $(LOCAL_PATH)/types.hal +$(GEN): PRIVATE_OUTPUT_DIR := $(intermediates) +$(GEN): PRIVATE_CUSTOM_TOOL = \ + $(PRIVATE_HIDL) -o $(PRIVATE_OUTPUT_DIR) \ + -Ljava -randroid.hardware:hardware/interfaces \ + android.hardware.power@1.0::types.PowerStatePlatformSleepState + +$(GEN): $(LOCAL_PATH)/types.hal + $(transform-generated-source) +LOCAL_GENERATED_SOURCES += $(GEN) + +# +# Build types.hal (PowerStateVoter) +# +GEN := $(intermediates)/android/hardware/power/1.0/PowerStateVoter.java +$(GEN): $(HIDL) +$(GEN): PRIVATE_HIDL := $(HIDL) +$(GEN): PRIVATE_DEPS := $(LOCAL_PATH)/types.hal +$(GEN): PRIVATE_OUTPUT_DIR := $(intermediates) +$(GEN): PRIVATE_CUSTOM_TOOL = \ + $(PRIVATE_HIDL) -o $(PRIVATE_OUTPUT_DIR) \ + -Ljava -randroid.hardware:hardware/interfaces \ + android.hardware.power@1.0::types.PowerStateVoter + +$(GEN): $(LOCAL_PATH)/types.hal + $(transform-generated-source) +LOCAL_GENERATED_SOURCES += $(GEN) + +# +# Build types.hal (Status) +# +GEN := $(intermediates)/android/hardware/power/1.0/Status.java +$(GEN): $(HIDL) +$(GEN): PRIVATE_HIDL := $(HIDL) +$(GEN): PRIVATE_DEPS := $(LOCAL_PATH)/types.hal +$(GEN): PRIVATE_OUTPUT_DIR := $(intermediates) +$(GEN): PRIVATE_CUSTOM_TOOL = \ + $(PRIVATE_HIDL) -o $(PRIVATE_OUTPUT_DIR) \ + -Ljava -randroid.hardware:hardware/interfaces \ + android.hardware.power@1.0::types.Status + +$(GEN): $(LOCAL_PATH)/types.hal + $(transform-generated-source) +LOCAL_GENERATED_SOURCES += $(GEN) + +# +# Build IPower.hal +# +GEN := $(intermediates)/android/hardware/power/1.0/IPower.java +$(GEN): $(HIDL) +$(GEN): PRIVATE_HIDL := $(HIDL) +$(GEN): PRIVATE_DEPS := $(LOCAL_PATH)/IPower.hal +$(GEN): PRIVATE_DEPS += $(LOCAL_PATH)/types.hal +$(GEN): $(LOCAL_PATH)/types.hal +$(GEN): PRIVATE_OUTPUT_DIR := $(intermediates) +$(GEN): PRIVATE_CUSTOM_TOOL = \ + $(PRIVATE_HIDL) -o $(PRIVATE_OUTPUT_DIR) \ + -Ljava -randroid.hardware:hardware/interfaces \ + android.hardware.power@1.0::IPower + +$(GEN): $(LOCAL_PATH)/IPower.hal + $(transform-generated-source) +LOCAL_GENERATED_SOURCES += $(GEN) +include $(BUILD_JAVA_LIBRARY) + + +################################################################################ + +include $(CLEAR_VARS) +LOCAL_MODULE := android.hardware.power@1.0-java-static +LOCAL_MODULE_CLASS := JAVA_LIBRARIES + +intermediates := $(local-generated-sources-dir) + +HIDL := $(HOST_OUT_EXECUTABLES)/hidl-gen$(HOST_EXECUTABLE_SUFFIX) + +# +# Build types.hal (Feature) +# +GEN := $(intermediates)/android/hardware/power/1.0/Feature.java +$(GEN): $(HIDL) +$(GEN): PRIVATE_HIDL := $(HIDL) +$(GEN): PRIVATE_DEPS := $(LOCAL_PATH)/types.hal +$(GEN): PRIVATE_OUTPUT_DIR := $(intermediates) +$(GEN): PRIVATE_CUSTOM_TOOL = \ + $(PRIVATE_HIDL) -o $(PRIVATE_OUTPUT_DIR) \ + -Ljava -randroid.hardware:hardware/interfaces \ + android.hardware.power@1.0::types.Feature + +$(GEN): $(LOCAL_PATH)/types.hal + $(transform-generated-source) +LOCAL_GENERATED_SOURCES += $(GEN) + +# +# Build types.hal (PowerHint) +# +GEN := $(intermediates)/android/hardware/power/1.0/PowerHint.java +$(GEN): $(HIDL) +$(GEN): PRIVATE_HIDL := $(HIDL) +$(GEN): PRIVATE_DEPS := $(LOCAL_PATH)/types.hal +$(GEN): PRIVATE_OUTPUT_DIR := $(intermediates) +$(GEN): PRIVATE_CUSTOM_TOOL = \ + $(PRIVATE_HIDL) -o $(PRIVATE_OUTPUT_DIR) \ + -Ljava -randroid.hardware:hardware/interfaces \ + android.hardware.power@1.0::types.PowerHint + +$(GEN): $(LOCAL_PATH)/types.hal + $(transform-generated-source) +LOCAL_GENERATED_SOURCES += $(GEN) + +# +# Build types.hal (PowerStatePlatformSleepState) +# +GEN := $(intermediates)/android/hardware/power/1.0/PowerStatePlatformSleepState.java +$(GEN): $(HIDL) +$(GEN): PRIVATE_HIDL := $(HIDL) +$(GEN): PRIVATE_DEPS := $(LOCAL_PATH)/types.hal +$(GEN): PRIVATE_OUTPUT_DIR := $(intermediates) +$(GEN): PRIVATE_CUSTOM_TOOL = \ + $(PRIVATE_HIDL) -o $(PRIVATE_OUTPUT_DIR) \ + -Ljava -randroid.hardware:hardware/interfaces \ + android.hardware.power@1.0::types.PowerStatePlatformSleepState + +$(GEN): $(LOCAL_PATH)/types.hal + $(transform-generated-source) +LOCAL_GENERATED_SOURCES += $(GEN) + +# +# Build types.hal (PowerStateVoter) +# +GEN := $(intermediates)/android/hardware/power/1.0/PowerStateVoter.java +$(GEN): $(HIDL) +$(GEN): PRIVATE_HIDL := $(HIDL) +$(GEN): PRIVATE_DEPS := $(LOCAL_PATH)/types.hal +$(GEN): PRIVATE_OUTPUT_DIR := $(intermediates) +$(GEN): PRIVATE_CUSTOM_TOOL = \ + $(PRIVATE_HIDL) -o $(PRIVATE_OUTPUT_DIR) \ + -Ljava -randroid.hardware:hardware/interfaces \ + android.hardware.power@1.0::types.PowerStateVoter + +$(GEN): $(LOCAL_PATH)/types.hal + $(transform-generated-source) +LOCAL_GENERATED_SOURCES += $(GEN) + +# +# Build types.hal (Status) +# +GEN := $(intermediates)/android/hardware/power/1.0/Status.java +$(GEN): $(HIDL) +$(GEN): PRIVATE_HIDL := $(HIDL) +$(GEN): PRIVATE_DEPS := $(LOCAL_PATH)/types.hal +$(GEN): PRIVATE_OUTPUT_DIR := $(intermediates) +$(GEN): PRIVATE_CUSTOM_TOOL = \ + $(PRIVATE_HIDL) -o $(PRIVATE_OUTPUT_DIR) \ + -Ljava -randroid.hardware:hardware/interfaces \ + android.hardware.power@1.0::types.Status + +$(GEN): $(LOCAL_PATH)/types.hal + $(transform-generated-source) +LOCAL_GENERATED_SOURCES += $(GEN) + +# +# Build IPower.hal +# +GEN := $(intermediates)/android/hardware/power/1.0/IPower.java +$(GEN): $(HIDL) +$(GEN): PRIVATE_HIDL := $(HIDL) +$(GEN): PRIVATE_DEPS := $(LOCAL_PATH)/IPower.hal +$(GEN): PRIVATE_DEPS += $(LOCAL_PATH)/types.hal +$(GEN): $(LOCAL_PATH)/types.hal +$(GEN): PRIVATE_OUTPUT_DIR := $(intermediates) +$(GEN): PRIVATE_CUSTOM_TOOL = \ + $(PRIVATE_HIDL) -o $(PRIVATE_OUTPUT_DIR) \ + -Ljava -randroid.hardware:hardware/interfaces \ + android.hardware.power@1.0::IPower + +$(GEN): $(LOCAL_PATH)/IPower.hal + $(transform-generated-source) +LOCAL_GENERATED_SOURCES += $(GEN) +include $(BUILD_STATIC_JAVA_LIBRARY) + + + +include $(call all-makefiles-under,$(LOCAL_PATH)) diff --git a/power/1.0/IPower.hal b/power/1.0/IPower.hal new file mode 100644 index 0000000000..6cba42a6ff --- /dev/null +++ b/power/1.0/IPower.hal @@ -0,0 +1,89 @@ +/* + * Copyright (C) 2016 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. + */ +package android.hardware.power@1.0; + +/* + * Constructor for the interface performs power management setup actions at + * runtime startup, such as to set default cpufreq parameters. + */ +interface IPower { + /* + * setInteractive() performs power management actions upon the + * system entering interactive state (that is, the system is awake + * and ready for interaction, often with UI devices such as + * display and touchscreen enabled) or non-interactive state (the + * system appears asleep, display usually turned off). The + * non-interactive state may be entered after a period of + * inactivity in order to conserve battery power during + * such inactive periods. + * + * Typical actions are to turn on or off devices and adjust + * cpufreq parameters. This function may also call the + * appropriate interfaces to allow the kernel to suspend the + * system to low-power sleep state when entering non-interactive + * state, and to disallow low-power suspend when the system is in + * interactive state. When low-power suspend state is allowed, the + * kernel may suspend the system whenever no wakelocks are held. + * + * For example, + * This function can be called to enter non-interactive state after + * turning off the screen (if present) and called to enter + * interactive state prior to turning on the screen. + * + * @param interactive is true when the system is transitioning to an + * interactive state and false when transitioning to a + * non-interactive state. + */ + setInteractive(bool interactive); + + /* + * powerHint() is called to pass hints on power requirements which + * may result in adjustment of power/performance parameters of the + * cpufreq governor and other controls. + * + * A particular platform may choose to ignore any hint. + * + * @param hint PowerHint which is passed + * @param data contains additional information about the hint + * and is described along with the comments for each of the hints. + */ + powerHint(PowerHint hint, int32_t data); + + /* + * setFeature() is called to turn on or off a particular feature + * depending on the state parameter. + * + * @param feature Feature which needs to be set + * @param activate true/false to enable/disable the feature + */ + setFeature(Feature feature, bool activate); + + /* + * Platform-level sleep state stats: + * Report cumulative info on the statistics on platform-level sleep states + * since boot. + * + * Higher the index in the returned <states> vector deeper the state is + * i.e. lesser steady-state power is consumed by the platform to be + * resident in that state. + * + * @return states of power states the device supports + * @return retval SUCCESS on success or FILESYSTEM_ERROR on filesystem + * nodes access error. + */ + getPlatformLowPowerStats() + generates (vec<PowerStatePlatformSleepState> states, Status retval); +}; diff --git a/power/1.0/types.hal b/power/1.0/types.hal new file mode 100644 index 0000000000..c27242ec1b --- /dev/null +++ b/power/1.0/types.hal @@ -0,0 +1,168 @@ +/* + * Copyright (C) 2016 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. + */ +package android.hardware.power@1.0; + +/* Power hint identifiers passed to powerHint() */ +enum PowerHint : uint32_t { + /* + * Foreground app has started or stopped requesting a VSYNC pulse + * from SurfaceFlinger. If the app has started requesting VSYNC + * then CPU and GPU load is expected soon, and it may be appropriate + * to raise speeds of CPU, memory bus, etc. The data parameter is + * non-zero to indicate VSYNC pulse is now requested, or zero for + * VSYNC pulse no longer requested. + */ + VSYNC = 0x00000001, + + + /* + * User is interacting with the device, for example, touchscreen + * events are incoming. CPU and GPU load may be expected soon, + * and it may be appropriate to raise speeds of CPU, memory bus, + * etc. The data parameter is the estimated length of the interaction + * in milliseconds, or 0 if unknown. + */ + INTERACTION = 0x00000002, + + + /* DO NOT USE VIDEO_ENCODE/_DECODE! They will be removed in + * KLP. + */ + VIDEO_ENCODE = 0x00000003, + VIDEO_DECODE = 0x00000004, + + /* + * Low power mode is activated or deactivated. Low power mode + * is intended to save battery at the cost of performance. The data + * parameter is non-zero when low power mode is activated, and zero + * when deactivated. + */ + LOW_POWER = 0x00000005, + + /* + * Sustained Performance mode is actived or deactivated. Sustained + * performance mode is intended to provide a consistent level of + * performance for a prolonged amount of time. The data parameter is + * non-zero when sustained performance mode is activated, and zero + * when deactivated. + */ + SUSTAINED_PERFORMANCE = 0x00000006, + + /* + * VR Mode is activated or deactivated. VR mode is intended to + * provide minimum guarantee for performance for the amount of time the + * device can sustain it. The data parameter is non-zero when the mode + * is activated and zero when deactivated. + */ + VR_MODE = 0x00000007, + + /* + * This hint indicates that an application has been launched. Can be used + * for device specific optimizations during application launch. The data + * parameter is non-zero when the application starts to launch and zero when + * it has been launched. + */ + LAUNCH = 0x00000008, + + /* + * When device enters some special modes, e.g. theater mode in Android + * Wear, there is no touch interaction expected between device and user. + * Touch controller could be disabled in those modes to save power. + * The data parameter is non-zero when touch could be disabled, and zero + * when touch needs to be re-enabled. + */ + DISABLE_TOUCH = 0x00000009 +}; + +enum Feature : uint32_t { + /* + * Enabling/Disabling this feature will allow/disallow the system + * to wake up by tapping the screen twice. + */ + POWER_FEATURE_DOUBLE_TAP_TO_WAKE = 0x00000001 +}; + +enum Status : uint32_t { + SUCCESS = 0, + FILESYSTEM_ERROR = 1 +}; +/* + * Platform-level sleep state stats: + * PowerStateVoter struct is useful for describing the individual voters + * when a Platform-level sleep state is chosen by aggregation of votes from + * multiple clients/system conditions. + * + * This helps in attirbuting what in the device is blocking the device from + * entering the lowest Platform-level sleep state. + */ +struct PowerStateVoter { + /* + * Name of the voter. + */ + string name; + + /* + * Total time in msec the voter voted for the platform sleep state since + * boot. + */ + uint64_t totalTimeInMsecVotedForSinceBoot; + + /* + * Number of times the voter voted for the platform sleep state since boot. + */ + uint64_t totalNumberOfTimesVotedSinceBoot; +}; + +/* + * Platform-level sleep state stats: + * PowerStatePlatformSleepState represents the Platform-level sleep state + * the device is capable of getting into. + * + * SoCs usually have more than one Platform-level sleep state. + */ +struct PowerStatePlatformSleepState { + /* + * Platform-level Sleep state name. + */ + string name; + + /* + * Time spent in msec at this platform-level sleep state since boot. + */ + uint64_t residencyInMsecSinceBoot; + + /* + * Total number of times system entered this state. + */ + uint64_t totalTransitions; + + /* + * This platform-level sleep state can only be reached during system suspend + */ + bool supportedOnlyInSuspend; + + /* + * voters is useful if the Platform-level sleep state + * is chosen by aggregation votes from multiple clients/system conditions. + * All the voters have to say yes or all the system conditions need to be + * met to enter a platform-level sleep state. + * + * Vector of size zero implies either the info is not available + * or the system does not follow a voting mechanism to choose this + * Platform-level sleep state. + */ + vec<PowerStateVoter> voters; +}; |