NDIS_STATUS_WWAN_PIN_INFO

Miniport drivers use the NDIS_STATUS_WWAN_PIN_INFO notification to respond to OID query and set requests of OID_WWAN_PIN.

Miniport drivers cannot use this notification to send unsolicited events.

This notification uses the NDIS_WWAN_PIN_INFO structure.

Remarks

Miniport drivers should return information about the Personal Identity Number (PIN) that the MB device currently expects in response to a query request. Miniport drivers should return the status notification filled in as described in sections below in response to a set request.

Responding to WwanPinOperationEnter Requests

When miniport drivers use the NDIS_STATUS_WWAN_PIN_INFO notification to respond to WwanPinOperationEnter requests, they should implement these procedures:

• For successful WwanPinOperationEnter query requests, when the MB device no longer requires a PIN, miniport drivers must set uStatus to WWAN_STATUS_SUCCESS and PinType to WwanPinTypeNone.

• For failed WwanPinOperationEnter requests, miniport drivers must set uStatus to WWAN_STATUS_FAILURE and include applicable data as per the following details:

  • PIN Disabled or PIN Not Expected: For WwanPinOperationEnter set requests, when the corresponding PIN is either disabled or currently not expected by the MB device, miniport drivers must set PinType to WwanPinTypeNone. All other members are ignored.

  • PIN Not Supported: If the given PIN is not supported by the MB device, miniport drivers must set uStatus to WWAN_STATUS_NO_DEVICE_SUPPORT.

  • PIN Retrial: In this mode, the MB device requires the PIN to be re-entered as the AttemptsRemaining value is still non-zero for this particular type of PIN. Miniport drivers must set PinType to the same value as that of PinType in NDIS_WWAN_SET_PIN.

  • PIN Blocking: The PIN is blocked when AttemptsRemaining is zero. If the PIN unblock operation is not available, miniport drivers must set uStatus to WWAN_STATUS_FAILURE and PinType to WwanPinTypeNone. All the other members are ignored.

    Note  If the MB device supports PIN unblock operations, miniport drivers should follow the PIN Unblocking step to respond to the request.

  • PIN Unblocking: The PIN is blocked when AttemptsRemaining is zero. To unblock the PIN, the MB device may request a corresponding PIN Unlock Key (PUK), if applicable. In this case, miniport drivers must set PinType to the corresponding WwanPinTypeXxxPUK with the relevant details.

  • Blocked PUK: If the number of failed trials exceeds the preset value for entering the WwanPinTypeXxxPUK, then the PUK becomes blocked. Miniport drivers must signal this by setting uStatus to WWAN_STATUS_FAILURE and PinType to WwanPinTypeNone. In case PUK1 is blocked, miniport drivers must send an NDIS_STATUS_WWAN_READY_INFO with ReadyState set to WwanReadyStateBadSim.

Responding to WwanPinOperationEnable, WwanPinOperationDisable, or WwanPinOperationChange Requests

When miniport drivers use the NDIS_STATUS_WWAN_PIN_INFO notification to respond to WwanPinOperationEnable, WwanPinOperationDisable, and WwanPinOperationChange, they should implement the following operations:

• For successful requests, miniport drivers must set uStatus to WWAN_STATUS_SUCCESS. For other members in WWAN_PIN_INFO, see the following circumstances.

• Miniport drivers must set uStatus to WWAN_STATUS_SUCCESS for PIN-enable and PIN-disable operations when the PIN is already in the requested state. Miniport drivers must set PinType to WwanPinTypeNone. Other members are ignored.

• When a PIN mode is changed from disabled to enabled, the PIN state should be WwanPinStateNone.

• If PIN1 is enabled, the PIN state shall become WwanPinStateEnter when power is cycled to the MB device.

• For all other PINs, the PIN state can change from WwanPinStateNone to WwanPinStateEnter depending on MB device specific conditions.

• PIN Not Supported: If a PIN operation is not supported by the MB device, miniport drivers must set uStatus to WWAN_STATUS_NO_DEVICE_SUPPORT. For example, enabling and disabling PIN2 is not typically supported by MB devices so the above error code must be returned. All other members are ignored.

• PIN Must be Entered: If a PIN operation requires a PIN to be entered, miniport drivers must set uStatus to WWAN_STATUS_PIN_REQUIRED and PinType to WwanPinTypeXxx. Other members are ignored.

• PIN Change Operation: If the MB device restricts the change of PIN value only when it is in enabled state, a request to change in disabled state must be returned with WWAN_STATUS_PIN_DISABLED.

• PIN Retrial: On failure, miniport drivers must set uStatus to WWAN_STATUS_FAILURE, and PinType to the same value as specified in NDIS_WWAN_SET_PIN. Other members are ignored except for AttemptsRemaining. This may occur when an incorrect PIN is entered.

• PIN Blocking: The PIN is blocked when the number of AttemptsRemaining is zero. If the PIN unblock operation is not available, miniport drivers must set uStatus to WWAN_STATUS_FAILURE and PinType to WwanPinTypeNone. AttemptsRemaining should be set to 0 and all the other members are ignored.

  Note  If the MB device supports PIN unblock operations, miniport drivers should follow the PIN Unblocking step to respond to the request.

• Unblocking PIN: The PIN is blocked when AttemptsRemaining is zero. To unblock the PIN, the MB device may request a corresponding PUK, if applicable. In this case, miniport drivers must set uStatus to WWAN_STATUS_FAILURE, PinType to the corresponding WwanPinTypeXxxPUK, PinState to WwanPinStateEnter, and AttemptsRemaining should have the number of attempts allowed to enter a valid PUK.

  If PIN blocking results in the MB device or SIM becomes blocked, miniport drivers must send an event notification with ReadyState set to WwanReadyStateDeviceLocked.

• If there is an active PDP context at the time of PIN1 blocking, miniport drivers must deactivate the PDP context and send notifications to the operating system about the PDP deactivation and link state change.

Requirements

See also

OID_WWAN_PIN

NDIS_STATUS_WWAN_PIN_INFO