HOST Shutdown Device Service

This topic provides guidelines for Mobile Broadband Interface Model (MBIM)-compliant devices to implement and report the described device service when queried by CID_MBIM_DEVICE_SERVICES.

The information in this topic applies to Windows 8 and later.

Microsoft Host Shutdown

The MBIM-compliant device implements and reports the following device service when queried by CID_MBIM_DEVICE_SERVICES. The existing well-known services are defined in section 10.1 of the USB NCM Mobile Broadband Interface Model (MBIM) V1.0 specification. Microsoft extends this to define the following service.

Service Name = Microsoft Host Shutdown

UUID = UUID_MS_HOSTSHUTDOWN

UUID Value = 883b7c26-985f-43fa-9804-27d7fb80959c

Defined CIDs for UUID_MS_HOSTSHUTDOWN device service

CID	Minimum OS version
CID_MBIM_MSHOSTSHUTDOWN	Windows 8
CID_MBIM_MSHOSTPRESHUTDOWN	Windows 10, version 1511

CID_MBIM_MSHOSTSHUTDOWN

This command informs the device that the host is shutting down. The MB device may lose power.

CID: CID_MBIM_MSHOSTSHUTDOWN

Command Code: 1

Set: Yes

Query: No

Event: No

Set InformationBuffer payload: N/A

Query InformationBuffer payload: N/A

Completion InformationBuffer payload: N/A

Set: InformationBuffer on MBIM_COMMAND_MSG not used. InformationBuffer of MBIM_COMMAND_DONE not used.

Query: Unsupported

Unsolicited Event: Unsupported

Remarks

The Mobile Broadband Class Driver sends the host shutdown notification to mobile broadband devices supporting this device service, on each host state transition into S4 and S5 states.

This notification is to provide mobile broadband devices with an early indication to allow them to initiate a mobile network deregister message and initiate SIM electrical de-initialization.

The following information summarizes the list of host sent CIDs/CMDs to the device for various system transitions and device power state transitions:

• MSHOSTSHUTDOWN CID is sent to the device on host state transitioning into S4 and S5.
• MBIM_CMD_CLOSE is sent to the device when host puts the device into D3 mode.

	S0	S1/S2/S3	S4	S5
D0	MBIM_CMD_OPEN	N/A	N/A	N/A
D1	N/A	N/A	N/A	N/A
D2	N/A	N/A	N/A	N/A
D3	N/A	MBIM_CMD_CLOSE	MSHOSTSHUTDOWN	MSHOSTSHUTDOWN

CID_MBIM_MSHOSTPRESHUTDOWN

This command notifies the MBIM modem that the system is undergoing pre-shutdown and it should finish all its operations, deregister from the network, and store necessary information to the host for flashless modem cases. The pre-shutdown notification is sent down when the host is preparing to enter S4 and S5 states and is waiting for all services to shut down appropriately.

CID: CID_MBIM_MSHOSTPRESHUTDOWN

Command Code: 2

Set: Yes

Query: No

Notification: No

Set InformationBuffer payload: N/A

Query InformationBuffer payload: N/A

Completion InformationBuffer payload: N/A

Parameters:

	Set	Query	Notification
Command	CID_MBIM_SET_MSHOSTPRESHUTDOWN	N/A	N/A
Response	Empty	N/A	N/A

For the Set operation, InformationBuffer and InformationBufferLength are empty.

Status Codes:

Status code	Description
MBIM_STATUS_SUCCESS	Pre-shutdown operations completed by the modem.
MBIM_STATUS_NO_DEVICE_SUPPORT	The device does not support pre-shutdown and no pre-shutdown operations are needed.