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 */
16package android.hardware.fastboot@1.0;
17
18/**
19 * IFastboot interface implements vendor specific fastboot commands.
20 */
21interface IFastboot {
22    /**
23     * Returns the file system type of the partition. This is only required for
24     * physical partitions that need to be wiped and reformatted.
25     *
26     * @return type Can be ext4, f2fs or raw.
27     * @return result SUCCESS if the operation is successful,
28     *     FAILURE_UNKNOWN if the partition is invalid or does not require
29     *     reformatting.
30     */
31    getPartitionType(string partitionName) generates (FileSystemType type, Result result);
32
33    /**
34     * Executes a fastboot OEM command.
35     *
36     * @param oemCmdArgs The oem command that is passed to the fastboot HAL.
37     * @return result Returns the status SUCCESS if the operation is successful,
38     *     INVALID_ARGUMENT for bad arguments,
39     *     FAILURE_UNKNOWN for an invalid/unsupported command.
40     */
41    doOemCommand(string oemCmd) generates (Result result);
42
43    /**
44     * Returns an OEM-defined string indicating the variant of the device, for
45     * example, US and ROW.
46     *
47     * @return variant Indicates the device variant.
48     * @return result Returns the status SUCCESS if the operation is successful,
49     *     FAILURE_UNKNOWN otherwise.
50     */
51    getVariant() generates (string variant, Result result);
52
53    /**
54     * Returns whether off-mode-charging is enabled. If enabled, the device
55     * autoboots into a special mode when power is applied.
56     *
57     * @return state Returns whether off mode charging is enabled.
58     * @return result Returns the status SUCCESS if the operation is successful,
59     *     FAILURE_UNKNOWN otherwise.
60     */
61    getOffModeChargeState() generates (bool state, Result result);
62
63    /**
64     * Returns the minimum battery voltage required for flashing in mV.
65     *
66     * @return batteryVoltage Minimum batterery voltage (in mV) required for
67     *     flashing to be successful.
68     * @return result Returns the status SUCCESS if the operation is successful,
69     *     FAILURE_UNKNOWN otherwise.
70     */
71    getBatteryVoltageFlashingThreshold() generates (int32_t batteryVoltage, Result result);
72};
73