fastboot/1.0/IFastboot.hal

   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 package android.hardware.fastboot@1.0;
  17
  18 /**
  19  * IFastboot interface implements vendor specific fastboot commands.
  20  */
  21 interface 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      * @response 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      * @response variant Indicates the device variant.
  48      * @response result Returns the status SUCCESS if the operation is successful,
  49      *     FAILURE_UNKNOWN otherwise.
  50      */
  51     getVariant() generates (string variant, Result result);
  52
  53 };