Hardware Dev Center

Declaring Functions by Using Function Role Types for NDIS Drivers

To enable SDV to analyze an NDIS driver, you must declare your functions by using the function role type declarations for NDIS. The function role types are defined in Ndis.h.

For the list of function role types and their corresponding event callback functions, see the Static Driver Verifier NDIS Function Declarations.

Each callback function in an NDIS driver must be declared by specifying the corresponding role type.

The following code example shows the function role type declaration for the MiniportPause callback function. In this example, the callback function is called myMiniportPause. The function role type is MINIPORT_PAUSE.


MINIPORT_PAUSE myMiniportPause;

If a callback function has a function prototype declaration, you must replace the function prototype with the function role type declaration.

The following example shows NDIS function declarations from the header file MP.h, which is located in the SDV fail_drivers subdirectory of the WDK. The related functions are declared in Main.c.

\tools\sdv\samples\fail_drivers\NDIS\fail_driver1.


/--------------------------------------
// Miniport routines in MAIN.C
//--------------------------------------

NDIS_STATUS
DriverEntry(
    IN  PDRIVER_OBJECT      DriverObject,
    IN  PUNICODE_STRING     RegistryPath
    );


MINIPORT_ALLOCATE_SHARED_MEM_COMPLETE MPAllocateComplete;

MINIPORT_HALT MPHalt;
MINIPORT_SET_OPTIONS MPSetOptions;
MINIPORT_INITIALIZE MPInitialize;
MINIPORT_PAUSE MPPause;
MINIPORT_RESTART MPRestart;
MINIPORT_OID_REQUEST MPOidRequest;
MINIPORT_INTERRUPT_DPC MPHandleInterrupt;
MINIPORT_ISR MPIsr;
MINIPORT_RESET MPReset;
MINIPORT_RETURN_NET_BUFFER_LISTS MPReturnNetBufferLists;
MINIPORT_CANCEL_OID_REQUEST MPCancelOidRequest;
MINIPORT_SHUTDOWN MPShutdown;
MINIPORT_SEND_NET_BUFFER_LISTS MPSendNetBufferLists;
MINIPORT_CANCEL_SEND MPCancelSendNetBufferLists;
MINIPORT_DEVICE_PNP_EVENT_NOTIFY MPPnPEventNotify;
MINIPORT_UNLOAD MPUnload;
MINIPORT_CHECK_FOR_HANG MPCheckForHang;
MINIPORT_ENABLE_INTERRUPT MpEnableInterrupt;
MINIPORT_DISABLE_INTERRUPT MpDisableInterrupt;
MINIPORT_SYNCHRONIZE_INTERRUPT MPSynchronizeInterrupt;
MINIPORT_PROCESS_SG_LIST MPProcessSGList;
NDIS_TIMER_FUNCTION MpDemonstrationTimer;
NDIS_IO_WORKITEM MPQueuedWorkItem;

Function Parameters and Function Role Types

As required in the C programming language, the parameter types that you use in the function definition must match the parameter types of the function prototype, or in this case, the function role type. SDV depends upon the function signatures for analysis and ignores functions whose signatures do not match.

For example, you should declare an MiniportInterrupt function using the MINIPORT_ISR function role type:


MINIPORT_ISR myMPIsr;

When you implement the interrupt routine, myMPIsr, the parameter types must match those used by MINIPORT_ISR, namely, NDIS_HANDLE, PBOOLEAN, and PULONG (see the MiniportInterrupt function for syntax).


BOOLEAN 
myMPIsr(
    __in  NDIS_HANDLE      MiniportInterruptContext,
    __out PBOOLEAN        QueueMiniportInterruptDpcHandler,
    __out PULONG          TargetProcessors
    ) {
}

Running Code Analysis for Drivers to verify the function declarations

To help you determine whether the source code is prepared, run Code Analysis for Drivers. Code Analysis for Drivers checks for function role type declarations and can help identify function declarations that might have been missed or warn you when the parameters of the function definition do not match those in the function role type.

 

 

Send comments about this topic to Microsoft

Show:
© 2015 Microsoft