StorPortInitializeTimer routine

Creates a Storport timer context object.

Syntax


ULONG StorPortInitializeTimer(
  _In_   PVOID HwDeviceExtension,
  _Out_  PVOID *TimerHandle
);

Parameters

HwDeviceExtension [in]

A pointer to the hardware device extension for the host bus adapter (HBA).

TimerHandle [out]

A pointer to an opaque buffer that holds context information for the timer.

Return value

The StorPortInitializeTimer routine returns one of these status codes:

Return codeDescription
STOR_STATUS_INVALID_IRQL

Current IRQL > DISPATCH_LEVEL.

STOR_STATUS_INVALID_PARAMETER

Either HwDeviceExtension or TimerHandle is NULL.

STOR_STATUS_INSUFFICIENT_RESOURCES

Insufficient resources are available to initialize the timer context.

STOR_STATUS_SUCCESS

The timer context was successfully initialized.

STOR_STATUS_UNSUCCESSFUL

The number of supported timers is exceeded.

 

Remarks

Storport provides a single timer to a miniport driver by using the RequestTimerCall notification type in StorPortNotification. If a miniport requires more than one timer, additional timers are created with StorPortInitializeTimer.

It is recommended that miniports call StorPortInitializeTimer in the HwStorFindAdapter function to ensure that the additional timer resources are available.

Miniports can use this routine to set coalescing timers to create a delay period after an initial timeout.

Prior to Windows 8, a maximum of 4 timers can be created with StorPortInitializeTimer. Starting with Windows 8, there is no maximum timers limitation.

Requirements

Version

Available in Windows 8 and later versions of Windows.

Header

Storport.h (include Storport.h)

IRQL

<= DISPATCH_LEVEL

See also

HwStorFindAdapter
StorPortFreeTimer
StorPortNotification
StorPortRequestTimer

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft