API Guide Home (Online version only) |

# HsPhoneTypes.h File Reference

## Detailed Description

Telephony data types that are common between ARM and 68K.

Definition in file HsPhoneTypes.h.

Include dependency graph for HsPhoneTypes.h:

Go to the source code of this file.

## Defines

- #define isValidPhoneServiceClassType(s) ((s & phnServiceAll) != 0)
- #define isValidPhnAddressField(a) ((a >= phnAddrFldPhone) && (a <= phnAddrFldLastName))
- #define isValidGSMDialCLIRMode(d) ((d >= gsmDialCLIRDefault) && (d <= gsmDialCLIRTemporarySuppression))
- #define isValidPhnPowerType(p) (p <= phnPowerSave)
- #define isValidPhnLockMode(m) ((m >= autoLockMode) && (m <= immediateLockMode))

Type and creator of CDMA and GSM phone libraries.

- #define phnLibDbType 'libr'
- #define phnLibCDMADbCreator 'PIL!'
- #define phnLibCDMAName "Phone Library"
- #define phnLibOldCDMADbCreator hsFileCCDMAPhoneLib
- #define phnLibOldCDMAName "PhoneLib.prc"
- #define phnLibGSMDbCreator hsFileCGSMPhoneLib
- #define phnLibGSMDbName "Phone Library"
- #define phnLibGSMName "GSMLibrary.lib"
- #define phnVoiceCall1Active 0x0001
- #define phnVoiceCall2Active 0x0002
- #define phnCSDCallActive 0x0004
- #define phnGPRSCallActive 0x0008
- #define phnPacketDataCallActive 0x0008
- #define phnPacketDataCallDormant 0x0010
- #define phnCall1StatusActive 0x0020
- #define phnCall2StatusActive 0x0040
- #define phnCall1StatusDialing 0x0080
- #define phnCall2StatusDialing 0x0100
- #define phnCall1StatusIncoming 0x0200
- #define phnCall2StatusIncoming 0x0400
- #define phnCall1StatusAlerting 0x0800
- #define phnCall2StatusAlerting 0x1000

CDMA Threshold level for signal bar (based on Generic Handset requirement)

- #define maxDBm4signalLevel0 105
- #define maxDBm4signalLevel1 95
- #define maxDBm4signalLevel2 85
- #define maxDBm4signalLevel3 75

- #define maxDB4ecioLevel0 15
- #define maxDB4ecioLevel1 13
- #define maxDB4ecioLevel2 11
- #define maxDB4ecioLevel3 9

Volume

- #define phnVolumeMin 0
- #define phnVolumeMax 7

Enumerations and Typedefs

- #define phnLibUnknownID 0xff000000
- #define phnLibNoLookupNeededID 0xff000001
- #define phnLibFtrNumResetFlag 10
- #define phnLibFtrNumBottomBRate 11
- #define phnLibFtrNumBlockATCmd 12
- #define phnLibFtrValBlockATCmd 'noAT'

## Typedefs

- typedef UInt16 PhnConnectionID
- typedef UInt32 PhnDatabaseID
- typedef VoidHand PhnAddressHandle
- typedef VoidHand PhnAddressList
- typedef UInt32 PhnOperatorID
- typedef UInt16 PhoneServiceClassType
- typedef UInt8 PhnAddressField
- typedef UInt8 GSMDialCLIRMode
- typedef UInt8 PhnPowerType
- typedef UInt8 GSMSIMStatus
- typedef UInt8 PhnLifeTimer
- typedef UInt8 PhnLockMode

## Enumerations

- enum _PhoneServiceClassType {
  phnServiceVoice = 1,
  phnServiceSMS = 2,
  phnServiceActivation = 4,
  phnServiceData = 8,
  phnServiceIOTA = 16,
  phnServiceSIMToolkit = 32,
  phnServiceAFLT = 64,
  phnServiceMisc = 128,
  phnServiceEssentials = 256,
  phnServiceMMS = 512,
  phnServiceWAP = 1024,
  phnServiceAll,
  phnServiceMax = 0xFFFF
  }
- enum _PhnAddressField {
  phnAddrFldPhone,
  phnAddrFldFirstName,
  phnAddrFldLastName
  }
- enum _GSMDialCLIRMode {
  gsmDialCLIRDefault,
  gsmDialCLIRTemporaryInvocation,
  gsmDialCLIRTemporarySuppression
  }
- enum _PhnPowerType {
  phnPowerOff,
  phnPowerOn,
  phnPowerStartCharging,
  phnPowerStopCharging,
  phnPowerLow,
  phnPowerSave
  }
- enum _GSMSIMStatus {
  simMissing,
  simFailure,
  simWrong,
  simNotReady,
  simReady,
  simUnknown,
  simPresent
  }
- enum {
  lifeTimeVoice,
  lifeTimeData
  }
- enum PhnLockModeEnum {
  autoLockMode,
  immediateLockMode
  }

## Define Documentation

#define isValidGSMDialCLIRMode | ( | d |  | ) | ((d >= gsmDialCLIRDefault) && (d <= gsmDialCLIRTemporarySuppression))

Definition at line 173 of file HsPhoneTypes.h.

#define isValidPhnAddressField | ( | a |  | ) | ((a >= phnAddrFldPhone) && (a <= phnAddrFldLastName))

Definition at line 159 of file HsPhoneTypes.h.

#define isValidPhnLockMode | ( | m |  | ) | ((m >= autoLockMode) && (m <= immediateLockMode))

Definition at line 246 of file HsPhoneTypes.h.

#define isValidPhnPowerType | ( | p |  | ) | (p <= phnPowerSave)

Definition at line 194 of file HsPhoneTypes.h.

#define isValidPhoneServiceClassType | ( | s |  | ) | ((s & phnServiceAll) != 0)

Definition at line 148 of file HsPhoneTypes.h.

#define maxDB4ecioLevel0 15

if below maxDBm4signalLevel3 then display 4 bars, mid percent = 90 Threshold ecio level for signal bar (based on Generic Handset requirement) will display no bar

Definition at line 85 of file HsPhoneTypes.h.

#define maxDB4ecioLevel1 13

will display 1 bar

Definition at line 86 of file HsPhoneTypes.h.

#define maxDB4ecioLevel2 11

will display 2 bars

Definition at line 87 of file HsPhoneTypes.h.

#define maxDB4ecioLevel3 9

will display 3 bars

Definition at line 88 of file HsPhoneTypes.h.

#define maxDBm4signalLevel0 105

will display no bar, mid percent = 10

Definition at line 73 of file HsPhoneTypes.h.

#define maxDBm4signalLevel1 95

will display 1 bar, mid percent = 30

Definition at line 74 of file HsPhoneTypes.h.

#define maxDBm4signalLevel2 85

will display 2 bars, mid percent = 50

Definition at line 75 of file HsPhoneTypes.h.

#define maxDBm4signalLevel3 75

will display 3 bars, mid percent = 70

Definition at line 76 of file HsPhoneTypes.h.

#define phnCall1StatusActive 0x0020

The first call's status is phnConnectionActive

Definition at line 58 of file HsPhoneTypes.h.

#define phnCall1StatusAlerting 0x0800

The first call's status is phnConnectionIncoming

Definition at line 64 of file HsPhoneTypes.h.

#define phnCall1StatusDialing 0x0080

The first call's status is phnConnectionDialing

Definition at line 60 of file HsPhoneTypes.h.

#define phnCall1StatusIncoming 0x0200

The first call's status is phnConnectionIncoming

Definition at line 62 of file HsPhoneTypes.h.

#define phnCall2StatusActive 0x0040

The second call's status is phnConnectionActive

Definition at line 59 of file HsPhoneTypes.h.

#define phnCall2StatusAlerting 0x1000

The second call's status is phnConnectionIncoming

Definition at line 65 of file HsPhoneTypes.h.

#define phnCall2StatusDialing 0x0100

The second call's status is phnConnectionDialing

Definition at line 61 of file HsPhoneTypes.h.

#define phnCall2StatusIncoming 0x0400

The second call's status is phnConnectionIncoming

Definition at line 63 of file HsPhoneTypes.h.

#define phnCSDCallActive 0x0004

There is a data call currently active

Definition at line 50 of file HsPhoneTypes.h.

#define phnGPRSCallActive 0x0008

There is a GPRS (GSM) session active

Definition at line 54 of file HsPhoneTypes.h.

#define phnLibCDMADbCreator 'PIL!'

CDMA Library creator

Definition at line 36 of file HsPhoneTypes.h.

#define phnLibCDMAName "Phone Library"

CDMA Library name

Definition at line 37 of file HsPhoneTypes.h.

#define phnLibDbType 'libr'

Phone Library type

Definition at line 34 of file HsPhoneTypes.h.

#define phnLibFtrNumBlockATCmd 12

Definition at line 110 of file HsPhoneTypes.h.

#define phnLibFtrNumBottomBRate 11

Definition at line 109 of file HsPhoneTypes.h.

#define phnLibFtrNumResetFlag 10

Definition at line 108 of file HsPhoneTypes.h.

#define phnLibFtrValBlockATCmd 'noAT'

Definition at line 111 of file HsPhoneTypes.h.

#define phnLibGSMDbCreator hsFileCGSMPhoneLib

GSM Library creator

Definition at line 43 of file HsPhoneTypes.h.

#define phnLibGSMDbName "Phone Library"

GSM Library database name

Definition at line 44 of file HsPhoneTypes.h.

#define phnLibGSMName "GSMLibrary.lib"

GSM Library name

Definition at line 45 of file HsPhoneTypes.h.

#define phnLibNoLookupNeededID 0xff000001

Definition at line 107 of file HsPhoneTypes.h.

#define phnLibOldCDMADbCreator hsFileCCDMAPhoneLib

Old CDMA Library creator

Definition at line 39 of file HsPhoneTypes.h.

#define phnLibOldCDMAName "PhoneLib.prc"

Old CDMA Library name

Definition at line 40 of file HsPhoneTypes.h.

#define phnLibUnknownID 0xff000000

Definition at line 106 of file HsPhoneTypes.h.

#define phnPacketDataCallActive 0x0008

There is an active 1X (CDMA) call

Definition at line 55 of file HsPhoneTypes.h.

#define phnPacketDataCallDormant 0x0010

There is a dormany 1X (CDMA) call

Definition at line 56 of file HsPhoneTypes.h.

#define phnVoiceCall1Active 0x0001

There is a voice call active on line1

Definition at line 48 of file HsPhoneTypes.h.

#define phnVoiceCall2Active 0x0002

There is a voice call active on line2

Definition at line 49 of file HsPhoneTypes.h.

#define phnVolumeMax 7

Maximum volume level

Definition at line 97 of file HsPhoneTypes.h.

#define phnVolumeMin 0

Minimum volume level

Definition at line 96 of file HsPhoneTypes.h.

## Typedef Documentation

typedef UInt8 GSMDialCLIRMode

Definition at line 176 of file HsPhoneTypes.h.

typedef UInt8 GSMSIMStatus

Definition at line 211 of file HsPhoneTypes.h.

typedef UInt8 PhnAddressField

Definition at line 162 of file HsPhoneTypes.h.

typedef VoidHand PhnAddressHandle

Definition at line 116 of file HsPhoneTypes.h.

typedef VoidHand PhnAddressList

Definition at line 117 of file HsPhoneTypes.h.

typedef UInt16 PhnConnectionID

Connection ID

Definition at line 114 of file HsPhoneTypes.h.

typedef UInt32 PhnDatabaseID

Database ID

Definition at line 115 of file HsPhoneTypes.h.

typedef UInt8 PhnLifeTimer

Definition at line 223 of file HsPhoneTypes.h.

typedef UInt8 PhnLockMode

Definition at line 245 of file HsPhoneTypes.h.

typedef UInt32 PhnOperatorID

Definition at line 118 of file HsPhoneTypes.h.

typedef UInt8 PhnPowerType

Definition at line 192 of file HsPhoneTypes.h.

typedef UInt16 PhoneServiceClassType

Definition at line 146 of file HsPhoneTypes.h.

## Enumeration Type Documentation

anonymous enum

LifeTimer Enums

Enumerator:

  lifeTimeVoice |
  lifeTimeData |

Definition at line 217 of file HsPhoneTypes.h.

    00218 {
    00219   lifeTimeVoice,    /**<        */
    00220   lifeTimeData      /**<        */
    00221 };

enum _GSMDialCLIRMode

GSM CLIR Mode

Enumerator:

  gsmDialCLIRDefault |
  gsmDialCLIRTemporaryInvocation |
  gsmDialCLIRTemporarySuppression |

Definition at line 167 of file HsPhoneTypes.h.

    00167               {
    00168     gsmDialCLIRDefault,             /**<        */
    00169     gsmDialCLIRTemporaryInvocation,     /**<        */
    00170     gsmDialCLIRTemporarySuppression     /**<        */
    00171 } _GSMDialCLIRMode;

enum _GSMSIMStatus

Status of the SIM on GSM radio only

Enumerator:

  simMissing |
  simFailure |
  simWrong |
  simNotReady |
  simReady |
  simUnknown |
  simPresent |

Definition at line 200 of file HsPhoneTypes.h.

    00200                    {
    00201     simMissing,         /**<        */
    00202     simFailure,         /**<        */
    00203     simWrong,       /**<        */
    00204     simNotReady,        /**<        */
    00205     simReady,       /**<        */
    00206     simUnknown,         /**<        */
    00207     simPresent      /**<        */
    00208     // <chg 05-05-2002 TRS> bug # 13072
    00209 };

enum _PhnAddressField

Phone address fields

Enumerator:

  phnAddrFldPhone |
  phnAddrFldFirstName |
  phnAddrFldLastName |

Definition at line 153 of file HsPhoneTypes.h.

    00153              {
    00154     phnAddrFldPhone,        /**<        */
    00155     phnAddrFldFirstName,        /**<        */
    00156     phnAddrFldLastName      /**<        */
    00157 } _PhnAddressField;

enum _PhnPowerType

Power state of the radio

Enumerator:

  phnPowerOff |
  phnPowerOn |
  phnPowerStartCharging |
  phnPowerStopCharging |
  phnPowerLow |
  phnPowerSave | Modem goes to deep sleep after failing to search for service

Definition at line 182 of file HsPhoneTypes.h.

    00183   {
    00184     phnPowerOff,        /**<        */
    00185     phnPowerOn,         /**<        */
    00186     phnPowerStartCharging,  /**<        */
    00187     phnPowerStopCharging,   /**<        */
    00188     phnPowerLow,        /**<        */
    00189     phnPowerSave                /**< Modem goes to deep sleep after failing to search for service */
    00190   };

enum _PhoneServiceClassType

Classes of service for which applications can register

Enumerator:

  phnServiceVoice | 0x0001
  phnServiceSMS | 0x0002
  phnServiceActivation | 0x0004
  phnServiceData | 0x0008
  phnServiceIOTA | 0x0010
  phnServiceSIMToolkit | 0x0020
  phnServiceAFLT | 0x0040
  phnServiceMisc | 0x0080
  phnServiceEssentials | 0x0100
  phnServiceMMS | 0x200
  phnServiceWAP | 0x400
  phnServiceAll |
  phnServiceMax | Reserved.

Definition at line 127 of file HsPhoneTypes.h.

    00128   {
    00129     phnServiceVoice = 1,        /**< 0x0001 */
    00130     phnServiceSMS = 2,          /**< 0x0002 */
    00131     phnServiceActivation = 4,       /**< 0x0004 */
    00132     phnServiceData = 8,         /**< 0x0008 */
    00133     phnServiceIOTA = 16,        /**< 0x0010 */
    00134     phnServiceSIMToolkit = 32,  /**< 0x0020 */
    00135     phnServiceAFLT = 64,        /**< 0x0040 */
    00136     phnServiceMisc = 128,       /**< 0x0080 */
    00137     phnServiceEssentials = 256, /**< 0x0100 */
    00138     phnServiceMMS = 512,            /**< 0x200 */
    00139     phnServiceWAP = 1024,           /**< 0x400 */
    00140     phnServiceAll = phnServiceVoice | phnServiceSMS | phnServiceAFLT |
    00141                     phnServiceData | phnServiceActivation | phnServiceMisc | phnServiceIOTA |
    00142                     phnServiceEssentials | phnServiceSIMToolkit | phnServiceMMS | phnServiceWAP,
    00143     phnServiceMax = 0xFFFF          /**< Reserved. */
    00144   };

enum PhnLockModeEnum

Enumerator:

  autoLockMode | option Lock Phone on Power Down is chosen
  immediateLockMode | option Lock Phone immediately is chosen

Definition at line 239 of file HsPhoneTypes.h.

    00240   {
    00241     autoLockMode,               /**< option Lock Phone on Power Down is chosen */
    00242     immediateLockMode           /**< option Lock Phone immediately is chosen */
    00243   }

Top | Palm Developer Network © 2004-2008, Palm, Inc. All rights reserved. Generated on Fri Jun 13 10:07:31 2008 for Palm API Guide