hal/HalTypes.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
   4  * You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #ifndef mozilla_hal_Types_h
   7 #define mozilla_hal_Types_h
   8
   9 #include "IPCMessageUtils.h"
  10
  11 namespace mozilla {
  12 namespace hal {
  13
  14 /**
  15  * These are defined by libhardware, specifically, hardware/libhardware/include/hardware/lights.h
  16  * in the gonk subsystem.
  17  * If these change and are exposed to JS, make sure nsIHal.idl is updated as well.
  18  */
  19 enum LightType {
  20   eHalLightID_Backlight     = 0,
  21   eHalLightID_Keyboard      = 1,
  22   eHalLightID_Buttons       = 2,
  23   eHalLightID_Battery       = 3,
  24   eHalLightID_Notifications = 4,
  25   eHalLightID_Attention     = 5,
  26   eHalLightID_Bluetooth     = 6,
  27   eHalLightID_Wifi          = 7,
  28   eHalLightID_Count         = 8  // This should stay at the end
  29 };
  30 enum LightMode {
  31   eHalLightMode_User   = 0,  // brightness is managed by user setting
  32   eHalLightMode_Sensor = 1,  // brightness is managed by a light sensor
  33   eHalLightMode_Count
  34 };
  35 enum FlashMode {
  36   eHalLightFlash_None     = 0,
  37   eHalLightFlash_Timed    = 1,  // timed flashing.  Use flashOnMS and flashOffMS for timing
  38   eHalLightFlash_Hardware = 2,  // hardware assisted flashing
  39   eHalLightFlash_Count
  40 };
  41
  42 enum ShutdownMode {
  43   eHalShutdownMode_Unknown  = -1,
  44   eHalShutdownMode_PowerOff = 0,
  45   eHalShutdownMode_Reboot   = 1,
  46   eHalShutdownMode_Restart  = 2,
  47   eHalShutdownMode_Count    = 3
  48 };
  49
  50 class SwitchEvent;
  51
  52 enum SwitchDevice {
  53   SWITCH_DEVICE_UNKNOWN = -1,
  54   SWITCH_HEADPHONES,
  55   SWITCH_USB,
  56   NUM_SWITCH_DEVICE
  57 };
  58
  59 enum SwitchState {
  60   SWITCH_STATE_UNKNOWN = -1,
  61   SWITCH_STATE_ON,
  62   SWITCH_STATE_OFF,
  63   SWITCH_STATE_HEADSET,          // Headphone with microphone
  64   SWITCH_STATE_HEADPHONE,        // without microphone
  65   NUM_SWITCH_STATE
  66 };
  67
  68 typedef Observer<SwitchEvent> SwitchObserver;
  69
  70 enum ProcessPriority {
  71   PROCESS_PRIORITY_BACKGROUND,
  72   PROCESS_PRIORITY_BACKGROUND_HOMESCREEN,
  73   PROCESS_PRIORITY_BACKGROUND_PERCEIVABLE,
  74   // Any priority greater than or equal to FOREGROUND is considered
  75   // "foreground" for the purposes of priority testing, for example
  76   // CurrentProcessIsForeground().
  77   PROCESS_PRIORITY_FOREGROUND,
  78   PROCESS_PRIORITY_MASTER,
  79   NUM_PROCESS_PRIORITY
  80 };
  81
  82 /**
  83  * Used by ModifyWakeLock
  84  */
  85 enum WakeLockControl {
  86   WAKE_LOCK_REMOVE_ONE = -1,
  87   WAKE_LOCK_NO_CHANGE  = 0,
  88   WAKE_LOCK_ADD_ONE    = 1,
  89   NUM_WAKE_LOCK
  90 };
  91
  92 class FMRadioOperationInformation;
  93
  94 enum FMRadioOperation {
  95   FM_RADIO_OPERATION_UNKNOWN = -1,
  96   FM_RADIO_OPERATION_ENABLE,
  97   FM_RADIO_OPERATION_DISABLE,
  98   FM_RADIO_OPERATION_SEEK,
  99   NUM_FM_RADIO_OPERATION
 100 };
 101
 102 enum FMRadioOperationStatus {
 103   FM_RADIO_OPERATION_STATUS_UNKNOWN = -1,
 104   FM_RADIO_OPERATION_STATUS_SUCCESS,
 105   FM_RADIO_OPERATION_STATUS_FAIL,
 106   NUM_FM_RADIO_OPERATION_STATUS
 107 };
 108
 109 enum FMRadioSeekDirection {
 110   FM_RADIO_SEEK_DIRECTION_UNKNOWN = -1,
 111   FM_RADIO_SEEK_DIRECTION_UP,
 112   FM_RADIO_SEEK_DIRECTION_DOWN,
 113   NUM_FM_RADIO_SEEK_DIRECTION
 114 };
 115
 116 enum FMRadioCountry {
 117   FM_RADIO_COUNTRY_UNKNOWN = -1,
 118   FM_RADIO_COUNTRY_US,  //USA
 119   FM_RADIO_COUNTRY_EU,
 120   FM_RADIO_COUNTRY_JP_STANDARD,
 121   FM_RADIO_COUNTRY_JP_WIDE,
 122   FM_RADIO_COUNTRY_DE,  //Germany
 123   FM_RADIO_COUNTRY_AW,  //Aruba
 124   FM_RADIO_COUNTRY_AU,  //Australlia
 125   FM_RADIO_COUNTRY_BS,  //Bahamas
 126   FM_RADIO_COUNTRY_BD,  //Bangladesh
 127   FM_RADIO_COUNTRY_CY,  //Cyprus
 128   FM_RADIO_COUNTRY_VA,  //Vatican
 129   FM_RADIO_COUNTRY_CO,  //Colombia
 130   FM_RADIO_COUNTRY_KR,  //Korea
 131   FM_RADIO_COUNTRY_DK,  //Denmark
 132   FM_RADIO_COUNTRY_EC,  //Ecuador
 133   FM_RADIO_COUNTRY_ES,  //Spain
 134   FM_RADIO_COUNTRY_FI,  //Finland
 135   FM_RADIO_COUNTRY_FR,  //France
 136   FM_RADIO_COUNTRY_GM,  //Gambia
 137   FM_RADIO_COUNTRY_HU,  //Hungary
 138   FM_RADIO_COUNTRY_IN,  //India
 139   FM_RADIO_COUNTRY_IR,  //Iran
 140   FM_RADIO_COUNTRY_IT,  //Italy
 141   FM_RADIO_COUNTRY_KW,  //Kuwait
 142   FM_RADIO_COUNTRY_LT,  //Lithuania
 143   FM_RADIO_COUNTRY_ML,  //Mali
 144   FM_RADIO_COUNTRY_MA,  //Morocco
 145   FM_RADIO_COUNTRY_NO,  //Norway
 146   FM_RADIO_COUNTRY_NZ,  //New Zealand
 147   FM_RADIO_COUNTRY_OM,  //Oman
 148   FM_RADIO_COUNTRY_PG,  //Papua New Guinea
 149   FM_RADIO_COUNTRY_NL,  //Netherlands
 150   FM_RADIO_COUNTRY_QA,  //Qatar
 151   FM_RADIO_COUNTRY_CZ,  //Czech Republic
 152   FM_RADIO_COUNTRY_UK,  //United Kingdom of Great Britain and Northern Ireland
 153   FM_RADIO_COUNTRY_RW,  //Rwandese Republic
 154   FM_RADIO_COUNTRY_SN,  //Senegal
 155   FM_RADIO_COUNTRY_SG,  //Singapore
 156   FM_RADIO_COUNTRY_SI,  //Slovenia
 157   FM_RADIO_COUNTRY_ZA,  //South Africa
 158   FM_RADIO_COUNTRY_SE,  //Sweden
 159   FM_RADIO_COUNTRY_CH,  //Switzerland
 160   FM_RADIO_COUNTRY_TW,  //Taiwan
 161   FM_RADIO_COUNTRY_TR,  //Turkey
 162   FM_RADIO_COUNTRY_UA,  //Ukraine
 163   FM_RADIO_COUNTRY_USER_DEFINED,
 164   NUM_FM_RADIO_COUNTRY
 165 };
 166
 167 typedef Observer<FMRadioOperationInformation> FMRadioObserver;
 168 } // namespace hal
 169 } // namespace mozilla
 170
 171 namespace IPC {
 172
 173 /**
 174  * Light type serializer.
 175  */
 176 template <>
 177 struct ParamTraits<mozilla::hal::LightType>
 178   : public EnumSerializer<mozilla::hal::LightType,
 179                           mozilla::hal::eHalLightID_Backlight,
 180                           mozilla::hal::eHalLightID_Count>
 181 {};
 182
 183 /**
 184  * Light mode serializer.
 185  */
 186 template <>
 187 struct ParamTraits<mozilla::hal::LightMode>
 188   : public EnumSerializer<mozilla::hal::LightMode,
 189                           mozilla::hal::eHalLightMode_User,
 190                           mozilla::hal::eHalLightMode_Count>
 191 {};
 192
 193 /**
 194  * Flash mode serializer.
 195  */
 196 template <>
 197 struct ParamTraits<mozilla::hal::FlashMode>
 198   : public EnumSerializer<mozilla::hal::FlashMode,
 199                           mozilla::hal::eHalLightFlash_None,
 200                           mozilla::hal::eHalLightFlash_Count>
 201 {};
 202
 203 /**
 204  * Serializer for ShutdownMode.
 205  */
 206 template <>
 207 struct ParamTraits<mozilla::hal::ShutdownMode>
 208   : public EnumSerializer<mozilla::hal::ShutdownMode,
 209                           mozilla::hal::eHalShutdownMode_Unknown,
 210                           mozilla::hal::eHalShutdownMode_Count>
 211 {};
 212
 213 /**
 214  * WakeLockControl serializer.
 215  */
 216 template <>
 217 struct ParamTraits<mozilla::hal::WakeLockControl>
 218   : public EnumSerializer<mozilla::hal::WakeLockControl,
 219                           mozilla::hal::WAKE_LOCK_REMOVE_ONE,
 220                           mozilla::hal::NUM_WAKE_LOCK>
 221 {};
 222
 223 /**
 224  * Serializer for SwitchState
 225  */
 226 template <>
 227 struct ParamTraits<mozilla::hal::SwitchState>:
 228   public EnumSerializer<mozilla::hal::SwitchState,
 229                         mozilla::hal::SWITCH_STATE_UNKNOWN,
 230                         mozilla::hal::NUM_SWITCH_STATE> {
 231 };
 232
 233 /**
 234  * Serializer for SwitchDevice
 235  */
 236 template <>
 237 struct ParamTraits<mozilla::hal::SwitchDevice>:
 238   public EnumSerializer<mozilla::hal::SwitchDevice,
 239                         mozilla::hal::SWITCH_DEVICE_UNKNOWN,
 240                         mozilla::hal::NUM_SWITCH_DEVICE> {
 241 };
 242
 243 template <>
 244 struct ParamTraits<mozilla::hal::ProcessPriority>:
 245   public EnumSerializer<mozilla::hal::ProcessPriority,
 246                         mozilla::hal::PROCESS_PRIORITY_BACKGROUND,
 247                         mozilla::hal::NUM_PROCESS_PRIORITY> {
 248 };
 249
 250 /**
 251  * Serializer for FMRadioOperation
 252  */
 253 template <>
 254 struct ParamTraits<mozilla::hal::FMRadioOperation>:
 255   public EnumSerializer<mozilla::hal::FMRadioOperation,
 256                         mozilla::hal::FM_RADIO_OPERATION_UNKNOWN,
 257                         mozilla::hal::NUM_FM_RADIO_OPERATION>
 258 {};
 259
 260 /**
 261  * Serializer for FMRadioOperationStatus
 262  */
 263 template <>
 264 struct ParamTraits<mozilla::hal::FMRadioOperationStatus>:
 265   public EnumSerializer<mozilla::hal::FMRadioOperationStatus,
 266                         mozilla::hal::FM_RADIO_OPERATION_STATUS_UNKNOWN,
 267                         mozilla::hal::NUM_FM_RADIO_OPERATION_STATUS>
 268 {};
 269
 270 /**
 271  * Serializer for FMRadioSeekDirection
 272  */
 273 template <>
 274 struct ParamTraits<mozilla::hal::FMRadioSeekDirection>:
 275   public EnumSerializer<mozilla::hal::FMRadioSeekDirection,
 276                         mozilla::hal::FM_RADIO_SEEK_DIRECTION_UNKNOWN,
 277                         mozilla::hal::NUM_FM_RADIO_SEEK_DIRECTION>
 278 {};
 279
 280 /**
 281  * Serializer for FMRadioCountry
 282  **/
 283 template <>
 284 struct ParamTraits<mozilla::hal::FMRadioCountry>:
 285   public EnumSerializer<mozilla::hal::FMRadioCountry,
 286                         mozilla::hal::FM_RADIO_COUNTRY_UNKNOWN,
 287                         mozilla::hal::NUM_FM_RADIO_COUNTRY>
 288 {};
 289 } // namespace IPC
 290
 291 #endif // mozilla_hal_Types_h