StorPortPoFxSetComponentLatency routine

The StorPortPoFxSetComponentLatency routine specifies the maximum latency that can be tolerated in the transition from the idle condition to the active condition in the specified storage device component.

Syntax


ULONG StorPortPoFxSetComponentLatency(
  _In_     PVOID         HwDeviceExtension,
  _In_opt_ PSTOR_ADDRESS Address,
  _In_     ULONG         Component,
  _In_     ULONGLONG     Latency
);

Parameters

HwDeviceExtension [in]

A pointer to the hardware device extension for the host bus adapter (HBA). This is the device extension used to register the device in a prior call to StorPortInitializePoFxPower.

Address [in, optional]

The address of a storage device unit. This parameter is NULL when setting the latency of a storage adapter component.

Component [in]

The index that identifies the component. This parameter is an index into the Components array in the STOR_POFX_DEVICE structure that the miniport driver registered for the device with a call to StorPortInitializePoFxPower. If the Components array contains N elements, component indexes range from 0 to N–1.

Latency [in]

The time, in units of 100 nanoseconds, that the storage device component can tolerate for a transition from an idle state the active state.

Return value

The StorPortPoFxSetComponentLatency routine returns one of these status codes:

Return codeDescription
STOR_STATUS_SUCCESS

The component latency successfully set.

STOR_STATUS_INVALID_PARAMETER

Either HwDeviceExtension or Device is NULL.

-or-

Address points to an invalid unit address structure.

-or-

The storage device specified by Address is not found.

-or-

The index in Component specifies a component greater than the component count for the device.

STOR_STATUS_INVALID_DEVICE_REQUEST

The storage device is not registered with the power management framework (PoFx).

STOR_STATUS_INVALID_IRQL

The current IRQL > DISPATCH_LEVEL.

 

Requirements

Target platform

Universal

Version

Available in starting with Windows 8.

Header

Storport.h

IRQL

<= DISPATCH_LEVEL

See also

PoFxSetComponentLatency

 

 

Send comments about this topic to Microsoft

Show: