WDF_USB_PIPE_INFORMATION structure

[Applies to KMDF and UMDF]

The WDF_USB_PIPE_INFORMATION structure contains information about a USB pipe and its endpoint.

Syntax

typedef struct _WDF_USB_PIPE_INFORMATION {
  ULONG             Size;
  ULONG             MaximumPacketSize;
  UCHAR             EndpointAddress;
  UCHAR             Interval;
  UCHAR             SettingIndex;
  WDF_USB_PIPE_TYPE PipeType;
  ULONG             MaximumTransferSize;
} WDF_USB_PIPE_INFORMATION, *PWDF_USB_PIPE_INFORMATION;

Members

Size

The size, in bytes, of this structure.

MaximumPacketSize

The maximum packet size, in bytes, that the pipe's endpoint is capable of sending or receiving.

For high-speed isochronous endpoints, the received MaximumPacketSize value includes the number of bytes that can be transferred in additional transactions, if the endpoint supports them.

EndpointAddress

The address of the endpoint on the USB device. For more information about endpoint addresses, see the USB specification.

Interval

The endpoint's polling interval, if the PipeType member is set to WdfUsbPipeTypeInterrupt. For more information about polling intervals, see the USB specification.

SettingIndex

An index value that identifies the alternate setting, within an interface, that the pipe belongs to. For more information about alternate settings, see the USB specification.

PipeType

A WDF_USB_PIPE_TYPE-typed value that specifies the type of pipe.

MaximumTransferSize

This member is not used.

Remarks

The WDF_USB_PIPE_INFORMATION structure is filled in by the WdfUsbTargetPipeGetInformation, WdfUsbInterfaceGetConfiguredPipe, and WdfUsbInterfaceGetEndpointInformation methods.

To initialize a WDF_USB_PIPE_INFORMATION structure, your driver should call WDF_USB_PIPE_INFORMATION_INIT.

For more information about the MaximumPacketSize member of this structure, see the Remarks section of USBD_PIPE_INFORMATION.

For information on how to transfer data to and from supported isochronous endpoints in a USB device, see How to Transfer Data to USB Isochronous Endpoints.

Requirements

See also

USBD_PIPE_INFORMATION

WDF_USB_PIPE_INFORMATION_INIT

WDF_USB_PIPE_TYPE

WdfUsbInterfaceGetConfiguredPipe

WdfUsbInterfaceGetEndpointInformation

WdfUsbTargetPipeGetInformation

Send comments about this topic to Microsoft