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