| /* |
| * Copyright (C) 2020 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; |
| |
| import android.hardware.power.Boost; |
| import android.hardware.power.IPowerHintSession; |
| import android.hardware.power.Mode; |
| |
| @VintfStability |
| interface IPower { |
| /** |
| * setMode() is called to enable/disable specific hint mode, which |
| * may result in adjustment of power/performance parameters of the |
| * cpufreq governor and other controls on device side. |
| * |
| * A particular platform may choose to ignore any mode hint. |
| * |
| * @param type Mode which is to be enable/disable. |
| * @param enabled true to enable, false to disable the mode. |
| */ |
| oneway void setMode(in Mode type, in boolean enabled); |
| |
| /** |
| * isModeSupported() is called to query if the given mode hint is |
| * supported by vendor. |
| * |
| * @return true if the hint passed is supported on this platform. |
| * If false, setting the mode will have no effect. |
| * @param type Mode to be queried |
| */ |
| boolean isModeSupported(in Mode type); |
| |
| /** |
| * setBoost() indicates the device may need to boost some resources, as the |
| * the load is likely to increase before the kernel governors can react. |
| * Depending on the boost, it may be appropriate to raise the frequencies of |
| * CPU, GPU, memory subsystem, or stop CPU from going into deep sleep state. |
| * A particular platform may choose to ignore this hint. |
| * |
| * @param type Boost type which is to be set with a timeout. |
| * @param durationMs The expected duration of the user's interaction, if |
| * known, or 0 if the expected duration is unknown. |
| * a negative value indicates canceling previous boost. |
| * A given platform can choose to boost some time based on durationMs, |
| * and may also pick an appropriate timeout for 0 case. |
| */ |
| oneway void setBoost(in Boost type, in int durationMs); |
| |
| /** |
| * isBoostSupported() is called to query if the given boost hint is |
| * supported by vendor. When returns false, set the boost will have |
| * no effect on the platform. |
| * |
| * @return true if the hint passed is supported on this platform. |
| * If false, setting the boost will have no effect. |
| * @param type Boost to be queried |
| */ |
| boolean isBoostSupported(in Boost type); |
| |
| /** |
| * A Session represents a group of threads with an inter-related workload such that hints for |
| * their performance should be considered as a unit. The threads in a given session should be |
| * long-life and not created or destroyed dynamically. |
| * |
| * Each session is expected to have a periodic workload with a target duration for each |
| * cycle. The cycle duration is likely greater than the target work duration to allow other |
| * parts of the pipeline to run within the available budget. For example, a renderer thread may |
| * work at 60hz in order to produce frames at the display's frame but have a target work |
| * duration of only 6ms. |
| * |
| * Creates a session for the given set of threads and sets their initial target work |
| * duration. |
| * |
| * @return the new session if it is supported on this device, otherwise return with |
| * EX_UNSUPPORTED_OPERATION error if hint session is not supported on this device. |
| * @param tgid The TGID to be associated with this session. |
| * @param uid The UID to be associated with this session. |
| * @param threadIds The list of threads to be associated with this session. |
| * @param durationNanos The desired duration in nanoseconds for this session. |
| */ |
| IPowerHintSession createHintSession( |
| in int tgid, in int uid, in int[] threadIds, in long durationNanos); |
| |
| /** |
| * Get preferred update rate (interval) information for this device. Framework must communicate |
| * this rate to Apps, and also ensure the session hint sent no faster than the update rate. |
| * |
| * @return the preferred update rate in nanoseconds supported by device software. Return with |
| * EX_UNSUPPORTED_OPERATION if hint session is not supported. |
| */ |
| long getHintSessionPreferredRate(); |
| } |