SWI_STRUCT_RadioPower Struct Reference

#include <SwiApiCmBasic.h>

Data Fields
swi_uint32	sizeStruct
enum SWI_TYPE_RadioPowerMode	eMode
swi_uint32	nLowPowerReason
swi_bool	bModuleReqPowerDown
enum SWI_TYPE_ModuleReqReason	eRequestReason

Detailed Description

This structure contains the radio power information.

Certain host platforms may be driving the power rail of the module and thus if the module tries to power itself down, it will just be powered back up. Therefore, when bModuleReqPowerDown is returned as true, the host must remove power from the power rail to the module.

This structure is valid for MiniCards only. Both GSM and CDMA MiniCards are supported.

See Also

SWI_NOTIFY_RadioPower

SwiGetRadioPower

SwiSetRadioPower

Field Documentation

swi_bool SWI_STRUCT_RadioPower::bModuleReqPowerDown

Reason enumeration stating why the modem has requested to be powered down. Only valid when returned in a notification.

enum SWI_TYPE_RadioPowerMode SWI_STRUCT_RadioPower::eMode

Bit mask indicating reason for entering the radio power mode. See SWI_TYPE_RadioPowerReason for mask definitions. This value is ignored when setting the radio power state.

enum SWI_TYPE_ModuleReqReason SWI_STRUCT_RadioPower::eRequestReason

swi_uint32 SWI_STRUCT_RadioPower::nLowPowerReason

Set to true if the module has requested to be powered down. Only valid when returned in a notification. This field only applies to CDMA MiniCards.

swi_uint32 SWI_STRUCT_RadioPower::sizeStruct

< The size, in bytes, of this structure. This value must always be populated by the calling application when calling SwiGetRadioPower or SwiSetRadioPower. Radio power mode enumeration. See SWI_TYPE_RadioPowerMode more details.

---

The documentation for this struct was generated from the following file:

• SwiApiCmBasic.h