StorPortGetBusData function (storport.h)

Article
02/22/2024

The StorPortGetBusData routine retrieves the bus-specific configuration information necessary to initialize the HBA.

Syntax

STORPORT_API ULONG StorPortGetBusData(
  [in]      PVOID DeviceExtension,
  [in]      ULONG BusDataType,
  [in]      ULONG SystemIoBusNumber,
  [in]      ULONG SlotNumber,
  [in, out] PVOID Buffer,
  [in]      ULONG Length
);

Parameters

[in] DeviceExtension

Pointer to the miniport driver's per-HBA storage area.

[in] BusDataType

Contains a value of type BUS_DATA_TYPE that specifies the type of bus-specific configuration data to be returned. Currently, this value can be one of the following: Cmos, EisaConfiguration, Pos, or PCIConfiguration. However, additional types of bus configuration will be supported in the future. The upper bound on the types supported is always MaximumBusDataType.

[in] SystemIoBusNumber

Specifies the system-assigned number of the I/O bus. The miniport driver's HwStorFindAdapter routine obtains this value from the SystemIoBusNumber member initially set in PORT_CONFIGURATION_INFORMATION.

[in] SlotNumber

Specifies the logical slot number or location of the device.

If PCIConfiguration is specified as the BusDataType, this parameter must be specified as a PCI_SLOT_NUMBER-type value.

[in, out] Buffer

Pointer to a buffer or area to which the configuration data is returned or, if the given Length is zero, points to a location to which the OS-specific port driver returns a pointer to a buffer that it allocates.

[in] Length

Specifies the maximum number of bytes to return at Buffer, or zero if the caller requires the OS-specific port driver to allocate a buffer to contain the data.

Return value

StorPortGetBusData returns the number of bytes of configuration information it stored in the buffer. When the input BusDataType is PCIConfiguration, StorPortGetBusData can return either of the following values to indicate an error.

Return code	Description
0 (zero)	The PCI bus does not exist.
2	The PCI bus exists, but there is no device at the given PCI SlotNumber. The Buffer contains the value PCI_INVALID_VENDOR_ID at the PCI_COMMON_CONFIG VendorId member.

Remarks

A miniport driver can call StorPortGetBusData from the following routines:

From its HwStorFindAdapter callback routine.
From its HwStorAdapterControl only when the ControlType is ScsiSetRunningConfig.

Calls from other miniport driver routines will result in system failure or incorrect operation for the caller.

Configuration data returned by StorPortGetBusData is valid only until the miniport driver calls StorPortGetBusData again. As soon as the caller's HwStorFindAdapter routine returns control, any returned configuration data becomes invalid.

Requirements

Requirement	Value
Target Platform	Universal
Header	storport.h (include Storport.h)
Library	Storport.lib