WWAN_DEVICE_CAPS structure (wwan.h)

The WWAN_DEVICE_CAPS structure represents the capabilities of the MB device.

Syntax

typedef struct _WWAN_DEVICE_CAPS {
  WWAN_DEVICE_TYPE    WwanDeviceType;
  WWAN_CELLULAR_CLASS WwanCellularClass;
  WWAN_VOICE_CLASS    WwanVoiceClass;
  WWAN_SIM_CLASS      WwanSimClass;
  ULONG               WwanDataClass;
  WCHAR               CustomDataClass[WWAN_CUSTOM_DATA_CLASS_LEN];
  ULONG               WwanGsmBandClass;
  ULONG               WwanCdmaBandClass;
  WCHAR               CustomBandClass[WWAN_CUSTOM_BAND_CLASS_LEN];
  ULONG               WwanSmsCaps;
  ULONG               WwanControlCaps;
  WCHAR               DeviceId[WWAN_DEVICEID_LEN];
  WCHAR               Manufacturer[WWAN_MANUFACTURER_LEN];
  WCHAR               Model[WWAN_MODEL_LEN];
  WCHAR               FirmwareInfo[WWAN_FIRMWARE_LEN];
  ULONG               MaxActivatedContexts;
  ULONG               WwanAuthAlgoCaps;
  WWAN_LIST_HEADER    CellularClassListHeader;
} WWAN_DEVICE_CAPS, *PWWAN_DEVICE_CAPS;

Members

WwanDeviceType

The type of the device. Miniport drivers must set the device type to be a value other than WwanDeviceTypeUnknown.

WwanCellularClass

The cellular class of the device. Miniport drivers must set the cellular class to be a value other than WwanCellularClassUnknown. The values in this member control features that are specific to cellular technology, such as network provider registration modes.

Miniport drivers that support multi-mode should set this to WwanCellularClassGsm.

WwanVoiceClass

The voice class of the device. This member informs the MB Service about the presence of circuit voice service, and how such service interacts with data service. Be aware that the MB Service does not support circuit-switched voice natively, nor does it preclude it. It is up to the miniport driver to determine how to support circuit voice. This WwanVoiceClass member allows the MB Service to support this feature in the future.

WwanSimClass

The class of the Subscriber Identity Module (SIM card). Miniport drivers must set the SIM class to be a value other than WwanSimClassUnknown.

WwanDataClass

A bitmap that represents the data-class(es) that the device supports. The following table shows the possible values for this member.

CustomDataClass[WWAN_CUSTOM_DATA_CLASS_LEN]

A NULL-terminated string that represents the name of the custom data-class. This member is valid only when the miniport driver sets the WWAN_DATA_CLASS_CUSTOM bit in the WwanDataClass member.

WwanGsmBandClass

A bitmap that represents the frequency bands GSM-based devices support. The following table shows the possible values for this member.

If the miniport driver specifies WWAN_BAND_CLASS_CUSTOM, it should also provide the name of the data-class in CustomBandClass .

For more information about these values, see OID_WWAN_DEVICE_CAPS.

WwanCdmaBandClass

A bitmap that represents the frequency bands CDMA-based devices support. The following table shows the possible values for this member.

If the miniport driver specifies WWAN_BAND_CLASS_CUSTOM, it should also provide the name of the data-class in CustomBandClass .

For more information about these values, see OID_WWAN_DEVICE_CAPS.

CustomBandClass[WWAN_CUSTOM_BAND_CLASS_LEN]

A NULL-terminated string that represents the name of the custom band class. This member is valid only when the miniport driver sets the WWAN_BAND_CLASS_CUSTOM bit in either the WwanGsmBandClass or WwanCdmaBandClass members, as appropriate.

WwanSmsCaps

A bitmap that represents the type of SMS messages and directional flow that the device supports. The following table shows the valid SMS capabilities settings.

Miniport drivers should set this member to reflect support for only GSM PDU format for receiving and sending SMS when the current home provider is multi-mode capable. Therefore, if the miniport driver receives a SMS in the cellular class native format, for example CDMA TEXT or CDMA PDU, then the miniport driver is required to do the translation to GSM PDU and indicate it to the MB Service. Similarly if the miniport driver receives a send request in GSM PDU format then it is required to do the translation to its native cellular class format.

WwanControlCaps

A bitmap that represents the control capabilities that the device supports. The following table shows the valid WwanControlCaps settings for GSM-based and CDMA-based devices.

Miniport drivers of CDMA-based devices must specify WWAN_CTRL_CAPS_CDMA_MOBILE_IP, or WWAN_CTRL_CAPS_CDMA_SIMPLE_IP, or both flags to inform the MB Service about the type of IP that the device supports.

DeviceId[WWAN_DEVICEID_LEN]

A NULL-terminated string that represents the device ID.

For GSM-based devices, the string must conform to the International Mobile Equipment Identity (IMEI) format (up to 15 digits).

For CDMA-based devices, the string must conform to both the Electronic Serial Number (ESN, 11 digits) and Mobile Equipment Identifier (MEID, 17 digits) formats.

For multi-mode capable miniport drivers, for example those that set the WWAN_CTRL_CAPS_MULTI_MODE flag in WwanControlCaps, only the GSM-based DeviceId must be reported.

This value should be stored in the device's memory and must be available even when the MB device/SIM requires a PIN to unlock.

Manufacturer[WWAN_MANUFACTURER_LEN]

A NULL-terminated string that represents the manufacturer of the device. This member is optional.

Model[WWAN_MODEL_LEN]

A NULL-terminated string that represents the model of the device. This member is optional.

FirmwareInfo[WWAN_FIRMWARE_LEN]

A NULL-terminated string that represents the firmware specific information about the device. This member is optional.

MaxActivatedContexts

The maximum number of activated contexts that are supported by the device. Miniport drivers should enforce this limit by failing any activation attempts that exceed MaxActivatedContexts.

WwanAuthAlgoCaps

A bitmap that represents the types of authentication methods the MB device supports.

CellularClassListHeader

A formatted WWAN_LIST_HEADER object that represents a list of cellular classes that a multi-mode capable device supports. The ElementType member in WWAN_LIST_HEADER should always be set to WwanStructCellularClass. The ElementCount member in WWAN_LIST_HEADER is set to the number of cellular classes that follow the WWAN_LIST_HEADER structure. MB devices that are not multi-mode capable should set ElementCount to 0.

Remarks

Miniport drivers should specify WWAN_DATA_CLASS_CUSTOM if the data service supported by the device does not belong to any of the other values defined in the table for the WwanDataClass member. If a miniport driver sets the WWAN_DATA_CLASS_CUSTOM flag, the miniport driver should also provide the name of the data-class in the CustomDataClass member.

For GSM-based devices, only GSM-based data-classes must be specified. For example, GPRS, EDGE, UMTS, HSDPA, LTE, and TD-SCDMA. If your miniport driver supports TD-SCDMA, then it should specify WWAN_DATA_CLASS_CUSTOM in the WwanDataClass member and the string "TD-SCDMA" in the CustomDataClass member.

For CDMA-based devices, only CDMA-related data services must be specified. For example, 1xRTT, 1xEV-DO, 1xEV-DO RevA, and UMB. 1xEV-DO RevB is defined for future use. 1xEV-DV and 3xRTT are also defined for completeness.

Requirements

See also

NDIS_WWAN_DEVICE_CAPS

WWAN_CELLULAR_CLASS

WWAN_DEVICE_TYPE

WWAN_SIM_CLASS

WWAN_VOICE_CLASS