OID_WWAN_PIN sets or returns information related to Personal Identification Numbers (PINs).
Miniport drivers must process set and query requests asynchronously, initially returning NDIS_STATUS_INDICATION_REQUIRED to the original request, and later sending an NDIS_STATUS_WWAN_PIN_INFO status notification when they have completed the set or query request.
Miniport drivers should send NDIS_STATUS_WWAN_PIN_INFO status notifications containing an NDIS_WWAN_PIN_INFO structure to return PIN-type and PIN-entry state information, primarily to indicate whether a PIN is required to unlock the MB device or Subscriber Identity Module (SIM card) when completing query requests.
Callers requesting to set information related to PINs provide an NDIS_WWAN_SET_PIN structure to the miniport driver to send a PIN to the MB device, enable or disable PIN settings, or to change a PIN on the SIM.
See WWAN Pin Operations for more information about using this OID.
Windows 7 miniport drivers should use OID_WWAN_PIN. Windows 8 miniport drivers should use OID_WWAN_PIN_EX.
Miniport drivers can access the Subscriber Identity Module (SIM card) when processing query operations, but should not access the provider network.
During the miniport driver initialization process, the MB Service does not proceed to registration until PIN1 is successfully unlocked, if enabled.
Miniport drivers provide a PIN value, entered by the end user, in the PinAction.Pin member of the NDIS_WWAN_SET_PIN structure when processing set requests. Only when the PIN value matches the value stored in the SIM card should the request be processed by the miniport driver. Otherwise, miniport drivers should fail the set request with status code WWAN_STATUS_FAILURE.
CDMA-based devices must report the power-on device lock as PIN1.
For all supported PIN types, miniport drivers must support the WwanPinOperationEnter operation. Additionally, if PIN1 is supported, miniport drivers must support the WwanPinOperationEnable, WwanPinOperationDisable, and WwanPinOperationChange operations.
If a PIN disable operation for a PIN type is tried when that PIN type is locked, miniport drivers can either fail the request with WWAN_STATUS_PIN_REQUIRED or they can successfully complete the request. If the miniport driver completes the request successfully, the disable operation should also unlock the PIN.
If reporting multiple PINs are enabled, and only one PIN can be reported at a time, then miniport drivers are expected to report PIN1 first. For example, if reporting of SubsidyLock and SIM PIN1 are enabled, then the SubsidyLock PIN should be reported (in a subsequent query request) only after PIN1 has been successfully verified.
The MB API supports other PINs in addition to PIN1. However, a 3rd-party connection manager/GUI would need to be installed because the Windows Connection Manager/GUI supports only PIN1.
|Available in Windows 7 and later versions of Windows.|
Build date: 12/9/2013