Export (0) Print
Expand All

ReadVfConfigBlock routine

The ReadVfConfigBlock routine reads a block of configuration data for a PCI Express (PCIe) virtual function (VF). This routine is called by the driver of a PCIe VF on a device that supports the single root I/O virtualization (SR-IOV) interface.

Syntax


NTSTATUS ReadVfConfigBlock(
  _In_   PVOID Context,
  _In_   ULONG BlockId,
  _Out_  PVOID Buffer,
  _In_   ULONG Length
);

Parameters

Context [in]

A pointer to interface-specific context information. The caller passes the value that is passed as the Context member of the VPCI_INTERFACE_STANDARD structure for the interface.

BlockId [in]

The identifier of the VF configuration block to be read. This identifier is proprietary to the independent hardware vendor (IHV) and is used only by the drivers for the PCIe physical function (PF) and VF on the device.

Buffer [out]

A pointer to a caller-allocated buffer that will contain the configuration data to be read. For more information, see Remarks.

Length [in]

The number of bytes to be read from the VF configuration block.

Note  The value of this parameter must not exceed VPCI_MAX_READ_WRITE_BLOCK_SIZE.

Return value

The ReadVfConfigBlock routine returns STATUS_SUCCESS if the operation succeeds. Otherwise, the routine returns an appropriate NTSTATUS value.

Remarks

When the ReadVfConfigBlock routine is called, the driver of the PF is notified to return data from a specified VF configuration block.

A VF configuration block is used for backchannel communication between the drivers of the PF and a VF on a device that supports the SR-IOV interface. The IHV can define one or more VF configuration blocks for the device. Each VF configuration block has an IHV-defined format, length, and block ID.

VF configuration data can be exchanged between the following drivers in a protected manner:

  • The VF driver, which runs in the guest operating system. This operating system runs within a Hyper-V child partition.

  • The PF driver, which runs in the management operating system. This operating system runs within the Hyper-V parent partition.

Data from each VF configuration block is used only by the drivers of the PF and VF.

Note  The IOCTL_VPCI_READ_BLOCK IOCTL offers an asynchronous alternative to the ReadVfConfigBlock routine.

Requirements

Version

Supported in Windows Server 2012 and later versions of Windows.

Header

Pcivirt.h (include Wdm.h)

IRQL

<= APC_LEVEL

See also

IOCTL_VPCI_READ_BLOCK
VPCI_INTERFACE_STANDARD

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft