NdisMInitializeTimer

NdisMInitializeTimer

VOID
NdisMInitializeTimer(
IN OUT PNDIS_MINIPORT_TIMER Timer,
IN NDIS_HANDLE MiniportAdapterHandle,
IN PNDIS_TIMER_FUNCTION TimerFunction,
IN PVOID FunctionContext
);

NdisMInitializeTimer initializes a timer object associated with a driver's MiniportTimer function.

Parameters

Timer

Points to caller-supplied, resident storage for a timer object. The timer object is opaque to the caller, but, when it has been initialized, this pointer is a required parameter to the NdisM..Timer functions.

MiniportAdapterHandle

Specifies the handle input to MiniportInitialize.

TimerFunction

Specifies the entry point of a caller-supplied MiniportTimer function.

FunctionContext

Points to a caller-supplied context area to be passed to the given MiniportTimer function when it is called.

Comments

The MiniportInitialize function must call NdisMInitializeTimer to set up the driver's MiniportTimer function(s), if any. MiniportInitialize must call NdisMInitializeTimer before the driver passes the MiniportTimer pointer to any other NdisM..Timer function.

Drivers of NICs that do not generate interrupts initialize at least one timer object for a polling MiniportTimer function that monitors the NIC state for incoming receives and for send completions.

Calls to the NdisMSet..Timer functions insert the timer object in the system timer queue. Calls to NdisMCancelTimer dequeue the timer object if it is currently queued. Only one instantiation of a particular timer object can be queued at any given moment.

When a driver calls NdisMSetTimer, the timer object at Timer is queued until the interval specified in the call expires. When it does, the timer object is dequeued and the caller-supplied TimerFunction is run once at IRQL DISPATCH_LEVEL as soon as a processor becomes available. When a driver calls NdisMSetPeriodicTimer, the timer object is dequeued and the caller-supplied TimerFunction is run when the given interval expires, but the timer object is automatically requeued for the same fixed interval so the MiniportTimer function runs periodically, also at IRQL DISPATCH_LEVEL.

MiniportInitialize can call NdisMInitializeTimer more than once to initialize more than one timer object, each associated with a distinct MiniportTimer function. For example, a NIC driver might have one MiniportTimer function that polls the NIC state periodically and another that the miniport uses only to time-out a particular operation on its NIC. Each such MiniportTimer function has different functionality, and each such function should be associated with a different timer object by calling NdisMInitializeTimer from MiniportInitialize.

Callers of NdisMInitializeTimer run at IRQL PASSIVE_LEVEL.