StorPortPoFxSetComponentResidency routine

The StorPortPoFxSetComponentResidency routine sets the estimated time for how long a storage device component is likely to remain idle after the component enters the idle condition.

Syntax


ULONG StorPortPoFxSetComponentResidency(
  _In_      PVOID HwDeviceExtension,
  _In_opt_  PSTOR_ADDRESS Address,
  _In_      ULONG Component,
  _In_      ULONGLONG Residency
);

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 residency 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.

Residency [in]

The estimated residency time, in 100-nanosecond units. This parameter is a hint to power management framework (PoFx) about how long the component is likely to remain idle after a transition from the active condition to the idle condition.

Return value

The StorPortPoFxSetComponentResidency routine returns one of these status codes:

Return codeDescription
STOR_STATUS_SUCCESS

The component residency is 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 PoFx.

STOR_STATUS_INVALID_IRQL

The current IRQL > DISPATCH_LEVEL.

 

Requirements

Version

Available in starting with Windows 8.

Header

Storport.h

Library

Storport.lib

IRQL

<= DISPATCH_LEVEL

See also

PoFxSetComponentResidency

 

 

Send comments about this topic to Microsoft

表示:
© 2014 Microsoft