wifi/1.1/IWifiChip.hal

   1 /*
   2  * Copyright 2016 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
  17 package android.hardware.wifi@1.1;
  18
  19 import @1.0::IWifiChip;
  20 import @1.0::WifiStatus;
  21
  22 /**
  23  * Interface that represents a chip that must be configured as a single unit.
  24  * The HAL/driver/firmware will be responsible for determining which phy is used
  25  * to perform operations like NAN, RTT, etc.
  26  */
  27 interface IWifiChip extends @1.0::IWifiChip {
  28   /**
  29    * Capabilities exposed by this chip.
  30    */
  31   enum ChipCapabilityMask : @1.0::IWifiChip.ChipCapabilityMask {
  32     /**
  33      * Set/Reset Tx Power limits.
  34      */
  35     SET_TX_POWER_LIMIT = 1 << 8
  36   };
  37
  38   /**
  39    * API to set TX power limit.
  40    * This is used for meeting SAR requirements while making VOIP calls for
  41    * example.
  42    *
  43    * @param powerInDbm Power level in dBm.
  44    * @return status WifiStatus of the operation.
  45    *         Possible status codes:
  46    *         |WifiStatusCode.SUCCESS|,
  47    *         |WifiStatusCode.ERROR_WIFI_CHIP_INVALID|,
  48    *         |WifiStatusCode.ERROR_NOT_SUPPORTED|,
  49    *         |WifiStatusCode.NOT_AVAILABLE|,
  50    *         |WifiStatusCode.UNKNOWN|
  51    */
  52   setTxPowerLimit(int32_t powerInDbm) generates (WifiStatus status);
  53
  54   /**
  55    * API to reset TX power limit.
  56    * This is used to set the power back to default values.
  57    *
  58    * @return status WifiStatus of the operation.
  59    *         Possible status codes:
  60    *         |WifiStatusCode.SUCCESS|,
  61    *         |WifiStatusCode.ERROR_WIFI_CHIP_INVALID|,
  62    *         |WifiStatusCode.ERROR_NOT_SUPPORTED|,
  63    *         |WifiStatusCode.NOT_AVAILABLE|,
  64    *         |WifiStatusCode.UNKNOWN|
  65    */
  66   resetTxPowerLimit() generates (WifiStatus status);
  67 };