Static Driver Verifier NDIS Function Declarations

To enable SDV to verify your NDIS driver, you must declare each callback function, by using a callback function role type. The callback function role types are defined in the Ndis.h header file and are included when you build your driver with that header file.

You must declare the driver's callback functions before you declare the callback function definitions. The following code example shows the function role type declaration for the MiniportInitializeEx callback function. This callback function must be declared by using the MINIPORT_INITIALIZE role type. In this example, the callback function is called myMiniportInitializeEx.

#include <ndis.h>  
MINIPORT_INITIALIZE myMiniportInitializeEx

If a callback function has a function prototype declaration, you must replace the function prototype with the function role type declaration. For more information about the function role type declarations, see the Using Function Role Type Declarations topic.

The following table shows the callback function role types and the NDIS callback functions that they are associated with.

Required Function Declarations

NDIS miniport driver callback function	Role type name
MiniportAddDevice	MINIPORT_ADD_DEVICE
MiniportCancelDirectOidRequest	MINIPORT_CANCEL_DIRECT_OID_REQUEST
MiniportCancelOidRequest	MINIPORT_CANCEL_OID_REQUEST
MiniportCancelSend	MINIPORT_CANCEL_SEND
MiniportCheckForHangEx	MINIPORT_CHECK_FOR_HANG
MiniportDevicePnPEventNotify	MINIPORT_DEVICE_PNP_EVENT_NOTIFY
MiniportDirectOidRequest	MINIPORT_DIRECT_OID_REQUEST
MiniportDisableInterruptEx	MINIPORT_DISABLE_INTERRUPT
MiniportDisableMessageInterrupt	MINIPORT_DISABLE_MESSAGE_INTERRUPT
MiniportDriverUnload	MINIPORT_UNLOAD
MiniportEnableInterruptEx	MINIPORT_ENABLE_INTERRUPT
MiniportEnableMessageInterrupt	MINIPORT_ENABLE_MESSAGE_INTERRUPT
MiniportFilterResourceRequirements	MINIPORT_FILTER_RESOURCE_REQUIREMENTS
MiniportHaltEx	MINIPORT_HALT
MiniportInitializeEx	MINIPORT_INITIALIZE
MiniportInterrupt	MINIPORT_ISR
MiniportInterruptDPC	MINIPORT_INTERRUPT_DPC
MiniportMessageInterrupt	MINIPORT_MESSAGE_INTERRUPT
MiniportMessageInterruptDPC	MINIPORT_MESSAGE_INTERRUPT_DPC
MiniportOidRequest	MINIPORT_OID_REQUEST
MiniportPause	MINIPORT_PAUSE
MiniportProcessSGList	MINIPORT_PROCESS_SG_LIST
MiniportRemoveDevice	MINIPORT_REMOVE_DEVICE
MiniportResetEx	MINIPORT_RESET
MiniportRestart	MINIPORT_RESTART
MiniportReturnNetBufferLists	MINIPORT_RETURN_NET_BUFFER_LISTS
MiniportSendNetBufferLists	MINIPORT_SEND_NET_BUFFER_LISTS
MiniportSetOptions	MINIPORT_SET_OPTIONS
MiniportSharedMemoryAllocateComplete	MINIPORT_ALLOCATE_SHARED_MEM_COMPLETE
MiniportShutdownEx	MINIPORT_SHUTDOWN
MiniportStartDevice	MINIPORT_START_DEVICE
MiniportSynchronizeInterrupt	MINIPORT_SYNCHRONIZE_INTERRUPT
MiniportSynchronizeMessageInterrupt	MINIPORT_SYNCHRONIZE_MESSAGE_INTERRUPT

NDIS other callback function	Role type name
NDIS_IO_WORKITEM_ROUTINE Routine Routine is the callback routine that is specified in the second parameter to the NdisQueueIoWorkItem function.	NDIS_IO_WORKITEM_FUNCTION
NetTimerCallback	NDIS_TIMER_FUNCTION

Recommended Function Declarations

The following function role types are not currently used in SDV rules for NDIS drivers; however, they are likely to be used the future. These function role types are fully supported in Windows 7 and we recommended that you use their specific function role types to declare these callbacks.

NDIS filter driver callback function	Role type name
FilterAttach	FILTER_ATTACH
FilterCancelDirectOidRequest	FILTER_CANCEL_DIRECT_OID_REQUEST
FilterCancelSendNetBufferLists	FILTER_CANCEL_SEND_NET_BUFFER_LISTS
FilterCancelOidRequest	FILTER_CANCEL_OID_REQUEST
FilterDetach	FILTER_DETACH
FilterDevicePnPEventNotify	FILTER_DEVICE_PNP_EVENT_NOTIFY
FilterDirectOidRequest	FILTER_DIRECT_OID_REQUEST
FilterDirectOidRequestComplete	FILTER_DIRECT_OID_REQUEST_COMPLETE
FilterDriverUnload	DRIVER_UNLOAD
FilterNetPnPEvent	FILTER_NET_PNP_EVENT
FilterOidRequest	FILTER_OID_REQUEST
FilterOidRequestComplete	FILTER_OID_REQUEST_COMPLETE
FilterPause	FILTER_PAUSE
FilterReceiveNetBufferLists	FILTER_RECEIVE_NET_BUFFER_LISTS
FilterRestart	FILTER_RESTART
FilterReturnNetBufferLists	FILTER_RETURN_NET_BUFFER_LISTS
FilterSendNetBufferLists	FILTER_SEND_NET_BUFFER_LISTS
FilterSendNetBufferListsComplete	FILTER_SEND_NET_BUFFER_LISTS_COMPLETE
FilterSetModuleOptions	FILTER_SET_MODULE_OPTIONS
FilterSetOptions	FILTER_SET_OPTIONS
FilterStatus	FILTER_STATUS

CoNDIS miniport driver callback function	Role type name
MiniportCoActivateVc	MINIPORT_CO_ACTIVATE_VC
MiniportCoCreateVc	MINIPORT_CO_CREATE_VC
MiniportCoDeactivateVc	MINIPORT_CO_DEACTIVATE_VC
MiniportCoDeleteVc	MINIPORT_CO_DELETE_VC
MiniportCoOidRequest	MINIPORT_CO_OID_REQUEST
MiniportCoSendNetBufferLists	MINIPORT_CO_SEND_NET_BUFFER_LISTS

NDIS protocol driver callback function	Role type name
ProtocolBindAdapterEx	PROTOCOL_BIND_ADAPTER_EX
ProtocolCloseAdapterCompleteEx	PROTOCOL_CLOSE_ADAPTER_COMPLETE_EX
ProtocolDirectOidRequestComplete	PROTOCOL_DIRECT_OID_REQUEST_COMPLETE
ProtocolNetPnPEvent	PROTOCOL_NET_PNP_EVENT
ProtocolOidRequestComplete	PROTOCOL_OID_REQUEST_COMPLETE
ProtocolOpenAdapterCompleteEx	PROTOCOL_OPEN_ADAPTER_COMPLETE_EX
ProtocolReceiveNetBufferLists	PROTOCOL_RECEIVE_NET_BUFFER_LISTS
ProtocolSendNetBufferListsComplete	PROTOCOL_SEND_NET_BUFFER_LISTS_COMPLETE
ProtocolSetOptions	PROTOCOL_SET_OPTIONS
ProtocolStatusEx	PROTOCOL_STATUS_EX
ProtocolUnbindAdapterEx	PROTOCOL_UNBIND_ADAPTER_EX
ProtocolUninstall	PROTOCOL_UNINSTALL

NDIS protocol CL callback function	Role type name
ProtocolClAddPartyComplete	PROTOCOL_CL_ADD_PARTY_COMPLETE
ProtocolClCallConnected	PROTOCOL_CL_CALL_CONNECTED
ProtocolClCloseAfComplete	PROTOCOL_CL_CLOSE_AF_COMPLETE
ProtocolClCloseCallComplete	PROTOCOL_CL_CLOSE_CALL_COMPLETE
ProtocolClDeregisterSapComplete	PROTOCOL_CL_DEREGISTER_SAP_COMPLETE
ProtocolClDropPartyComplete	PROTOCOL_CL_DROP_PARTY_COMPLETE
ProtocolClIncomingCall	PROTOCOL_CL_INCOMING_CALL
ProtocolClIncomingCallQoSChange	PROTOCOL_CL_INCOMING_CALL_QOS_CHANGE
ProtocolClIncomingCloseCall	PROTOCOL_CL_INCOMING_CLOSE_CALL
ProtocolClIncomingDropParty	PROTOCOL_CL_INCOMING_DROP_PARTY
ProtocolClMakeCallComplete	PROTOCOL_CL_MAKE_CALL_COMPLETE
ProtocolClModifyCallQoSComplete	PROTOCOL_CL_MODIFY_CALL_QOS_COMPLETE
ProtocolClNotifyCloseAf	PROTOCOL_CL_NOTIFY_CLOSE_AF
ProtocolClOpenAfComplete	PROTOCOL_CL_OPEN_AF_COMPLETE
ProtocolClOpenAfCompleteEx	PROTOCOL_CL_OPEN_AF_COMPLETE_EX
ProtocolClRegisterSapComplete	PROTOCOL_CL_REGISTER_SAP_COMPLETE

CoNDIS CM callback function	Role type name
ProtocolCmActivateVcComplete	PROTOCOL_CM_ACTIVATE_VC_COMPLETE
ProtocolCmAddParty	PROTOCOL_CM_ADD_PARTY
ProtocolCmCloseAf	PROTOCOL_CM_CLOSE_AF
ProtocolCmCloseCall	PROTOCOL_CM_CLOSE_CALL
ProtocolCmDeactivateVcComplete	PROTOCOL_CM_DEACTIVATE_VC_COMPLETE
ProtocolCmDeregisterSap	PROTOCOL_CM_DEREGISTER_SAP
ProtocolCmDropParty	PROTOCOL_CM_DROP_PARTY
ProtocolCmIncomingCallComplete	PROTOCOL_CM_INCOMING_CALL_COMPLETE
ProtocolCmMakeCall	PROTOCOL_CM_MAKE_CALL
ProtocolCmModifyCallQoS	PROTOCOL_CM_MODIFY_QOS_CALL
ProtocolCmNotifyCloseAfComplete	PROTOCOL_CM_NOTIFY_CLOSE_AF_COMPLETE
ProtocolCmOpenAf	PROTOCOL_CM_OPEN_AF
ProtocolCmRegisterSap	PROTOCOL_CM_REG_SAP

CoNDIS CO callback function	Role type name
ProtocolCoAfRegisterNotify	PROTCOL_CO_AF_REGISTER_NOTIFY
ProtocolCoCreateVc	PROTOCOL_CO_CREATE_VC
ProtocolCoDeleteVc	PROTOCOL_CO_DELETE_VC
ProtocolCoOidRequest	PROTOCOL_CO_OID_REQUEST
ProtocolCoOidRequestComplete	PROTOCOL_CO_OID_REQUEST_COMPLETE
ProtocolCoReceiveNetBufferLists	PROTOCOL_CO_RECEIVE_NET_BUFFER_LISTS
ProtocolCoSendNetBufferListsComplete	PROTOCOL_CO_SEND_NET_BUFFER_LISTS_COMPLETE
ProtocolCoStatusEx	PROTOCOL_CO_STATUS_EX