WdfUsbTargetPipeSetNoMaximumPacketSizeCheck - NtDoc

Native API online documentation, based on the System Informer (formerly Process Hacker) phnt headers
// wdfusb.h

VOID WdfUsbTargetPipeSetNoMaximumPacketSizeCheck(
  [in] WDFUSBPIPE Pipe
);

View the official Windows Driver Kit DDI reference

NtDoc

No description available.

Windows Driver Kit DDI reference (nf-wdfusb-wdfusbtargetpipesetnomaximumpacketsizecheck)

WdfUsbTargetPipeSetNoMaximumPacketSizeCheck function

Description

[Applies to KMDF and UMDF]

The WdfUsbTargetPipeSetNoMaximumPacketSizeCheck method disables the framework's test of whether the size of a driver's read buffer is a multiple of a USB pipe's maximum packet size.

Parameters

Pipe [in]

A handle to a framework pipe object that was obtained by calling WdfUsbInterfaceGetConfiguredPipe.

Remarks

A bug check occurs if the driver supplies an invalid object handle.

To avoid receiving extra data from unexpected bus activity, which is sometimes called babble, drivers usually specify read buffers that are a multiple of the pipe's maximum packet size. (Drivers receive a USB pipe's maximum packet size in a WDF_USB_PIPE_INFORMATION structure.) By default, the framework reports an error if a driver specifies a read buffer that is not a multiple of the pipe's maximum packet size. If the driver calls WdfUsbTargetPipeSetNoMaximumPacketSizeCheck, the framework does not report an error if a read buffer is not a multiple of the maximum packet size.

For more information about the WdfUsbTargetPipeSetNoMaximumPacketSizeCheck method and USB I/O targets, see USB I/O Targets.

Examples

The following code example disables the framework's test of whether the size of a buffer is a multiple of a USB pipe's maximum packet size.

WdfUsbTargetPipeSetNoMaximumPacketSizeCheck(pipe);

See also

WDF_USB_PIPE_INFORMATION

WdfUsbInterfaceGetConfiguredPipe