usbdlib.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	_USBD_INTERFACE_LIST_ENTRY

Macros
#define	DECLSPEC_EXPORT   __declspec(dllexport)
#define	UsbBuildInterruptOrBulkTransferRequest(urb, length, pipeHandle, transferBuffer, transferBufferMDL, transferBufferLength, transferFlags, link)
#define	UsbBuildGetDescriptorRequest(urb, length, descriptorType, descriptorIndex, languageId, transferBuffer, transferBufferMDL, transferBufferLength, link)
#define	UsbBuildGetStatusRequest(urb, op, index, transferBuffer, transferBufferMDL, link)
#define	UsbBuildFeatureRequest(urb, op, featureSelector, index, link)
#define	UsbBuildSelectConfigurationRequest(urb, length, configurationDescriptor)
#define	UsbBuildSelectInterfaceRequest(urb, length, configurationHandle, interfaceNumber, alternateSetting)
#define	UsbBuildVendorRequest(urb, cmd, length, transferFlags, reservedbits, request, value, index, transferBuffer, transferBufferMDL, transferBufferLength, link)
#define	UsbBuildOsFeatureDescriptorRequest(urb, length, interface, index, transferBuffer, transferBufferMDL, transferBufferLength, link)
#define	USBD_CLIENT_CONTRACT_VERSION_INVALID   0xFFFFFFFF
#define	USBD_CLIENT_CONTRACT_VERSION_602   0x602
#define	USBD_INTERFACE_VERSION_600   0x600
#define	USBD_INTERFACE_VERSION_602   0x602
#define	USBD_INTERFACE_VERSION_603   0x603
#define	URB_STATUS(urb)   ((urb)->UrbHeader.Status)
#define	GET_SELECT_CONFIGURATION_REQUEST_SIZE(totalInterfaces, totalPipes)
#define	GET_SELECT_INTERFACE_REQUEST_SIZE(totalPipes)
#define	GET_USBD_INTERFACE_SIZE(numEndpoints)
#define	GET_ISO_URB_SIZE(n)

Typedefs
typedef struct _USBD_INTERFACE_LIST_ENTRY	USBD_INTERFACE_LIST_ENTRY
typedef struct _USBD_INTERFACE_LIST_ENTRY *	PUSBD_INTERFACE_LIST_ENTRY

Functions
	DECLARE_HANDLE (USBD_HANDLE)
	_IRQL_requires_max_ (DISPATCH_LEVEL) DECLSPEC_IMPORT VOID NTAPI USBD_GetUSBDIVersion(_Out_ PUSBD_VERSION_INFORMATION VersionInformation)
DECLSPEC_IMPORT PUSB_INTERFACE_DESCRIPTOR NTAPI	USBD_ParseConfigurationDescriptor (_In_ PUSB_CONFIGURATION_DESCRIPTOR ConfigurationDescriptor, _In_ UCHAR InterfaceNumber, _In_ UCHAR AlternateSetting)
DECLSPEC_IMPORT PURB NTAPI	USBD_CreateConfigurationRequest (_In_ PUSB_CONFIGURATION_DESCRIPTOR ConfigurationDescriptor, _Out_ PUSHORT Siz)
	_IRQL_requires_max_ (APC_LEVEL) DECLSPEC_IMPORT PUSB_COMMON_DESCRIPTOR NTAPI USBD_ParseDescriptors(_In_ PVOID DescriptorBuffer
	_IRQL_requires_max_ (PASSIVE_LEVEL) DECLSPEC_EXPORT ULONG NTAPI USBD_GetInterfaceLength(_In_ PUSB_INTERFACE_DESCRIPTOR InterfaceDescriptor
	_Inout_updates_bytes_ (ParameterLength) PVOID Parameter
_In_ ULONG	_In_reads_bytes_ (KeyNameLength) PWSTR KeyName
DECLSPEC_EXPORT NTSTATUS NTAPI	USBD_QueryBusTime (_In_ PDEVICE_OBJECT RootHubPdo, _Out_ PULONG CurrentFrame)

Variables
_In_ ULONG	TotalLength
_In_ ULONG _In_ PVOID	StartPosition
_In_ ULONG _In_ PVOID _In_ LONG	DescriptorType
_In_ PVOID _In_ LONG	InterfaceNumber
_In_ PVOID _In_ LONG _In_ LONG	AlternateSetting
_In_ PVOID _In_ LONG _In_ LONG _In_ LONG	InterfaceClass
_In_ PVOID _In_ LONG _In_ LONG _In_ LONG _In_ LONG	InterfaceSubClass
_In_ PVOID _In_ LONG _In_ LONG _In_ LONG _In_ LONG _In_ LONG	InterfaceProtocol
_In_ PUSBD_INTERFACE_LIST_ENTRY	InterfaceList
_In_ PUCHAR	BufferEnd
_In_ PDEVICE_OBJECT	FilterDeviceObject
_In_ ULONG	ParameterLength
_In_ ULONG _In_ ULONG	KeyNameLength
_In_ UCHAR	EndpointType
_In_ UCHAR _In_ BOOLEAN	LowSpeed
_In_ ULONG	BufferLength
_In_ ULONG _In_ USHORT	Level
_In_ ULONG _In_ USHORT _Out_ PUCHAR *	Offset
_In_ ULONG _In_ USHORT _Out_ PUCHAR _In_opt_ ULONG	Tag

Macro Definition Documentation

DECLSPEC_EXPORT

#define DECLSPEC_EXPORT   __declspec(dllexport)

Definition at line 4 of file usbdlib.h.

GET_ISO_URB_SIZE

#define GET_ISO_URB_SIZE

(

n

)

Value:

(sizeof(struct _URB_ISOCH_TRANSFER)+ \
  sizeof(USBD_ISO_PACKET_DESCRIPTOR)*n)

Definition at line 125 of file usbdlib.h.

GET_SELECT_CONFIGURATION_REQUEST_SIZE

#define GET_SELECT_CONFIGURATION_REQUEST_SIZE	(		totalInterfaces,
			totalPipes
	)

Value:

(sizeof(struct _URB_SELECT_CONFIGURATION) +                              \
  ((totalInterfaces-1) * sizeof(USBD_INTERFACE_INFORMATION)) +             \
  ((totalPipes-totalInterfaces)*sizeof(USBD_PIPE_INFORMATION)))

Definition at line 112 of file usbdlib.h.

GET_SELECT_INTERFACE_REQUEST_SIZE

#define GET_SELECT_INTERFACE_REQUEST_SIZE

(

totalPipes

)

Value:

(sizeof(struct _URB_SELECT_INTERFACE) +             \
  ((totalPipes-1)*sizeof(USBD_PIPE_INFORMATION)))

Definition at line 117 of file usbdlib.h.

GET_USBD_INTERFACE_SIZE

#define GET_USBD_INTERFACE_SIZE

(

numEndpoints

)

Value:

(sizeof(USBD_INTERFACE_INFORMATION) +                                       \
  (sizeof(USBD_PIPE_INFORMATION)*(numEndpoints)) - sizeof(USBD_PIPE_INFORMATION))

Definition at line 121 of file usbdlib.h.

URB_STATUS

#define URB_STATUS

(

urb

)

((urb)->UrbHeader.Status)

Definition at line 110 of file usbdlib.h.

UsbBuildFeatureRequest

#define UsbBuildFeatureRequest	(		urb,
			op,
			featureSelector,
			index,
			link
	)

Value:

{  \
  (urb)->UrbHeader.Function =  (op);                                     \
  (urb)->UrbHeader.Length = sizeof(struct _URB_CONTROL_FEATURE_REQUEST); \
  (urb)->UrbControlFeatureRequest.FeatureSelector = (featureSelector);   \
  (urb)->UrbControlFeatureRequest.Index = (index);                       \
  (urb)->UrbControlFeatureRequest.UrbLink = (link);                      \
}

Definition at line 45 of file usbdlib.h.

UsbBuildGetDescriptorRequest

#define UsbBuildGetDescriptorRequest	(		urb,
			length,
			descriptorType,
			descriptorIndex,
			languageId,
			transferBuffer,
			transferBufferMDL,
			transferBufferLength,
			link
	)

Value:

{ \
  (urb)->UrbHeader.Function =  URB_FUNCTION_GET_DESCRIPTOR_FROM_DEVICE;                                                                                         \
  (urb)->UrbHeader.Length = (length);                                                                                                                           \
  (urb)->UrbControlDescriptorRequest.TransferBufferLength = (transferBufferLength);                                                                             \
  (urb)->UrbControlDescriptorRequest.TransferBufferMDL = (transferBufferMDL);                                                                                   \
  (urb)->UrbControlDescriptorRequest.TransferBuffer = (transferBuffer);                                                                                         \
  (urb)->UrbControlDescriptorRequest.DescriptorType = (descriptorType);                                                                                         \
  (urb)->UrbControlDescriptorRequest.Index = (descriptorIndex);                                                                                                 \
  (urb)->UrbControlDescriptorRequest.LanguageId = (languageId);                                                                                                 \
  (urb)->UrbControlDescriptorRequest.UrbLink = (link);                                                                                                          \
}

Definition at line 23 of file usbdlib.h.

UsbBuildGetStatusRequest

#define UsbBuildGetStatusRequest	(		urb,
			op,
			index,
			transferBuffer,
			transferBufferMDL,
			link
	)

Value:

{ \
  (urb)->UrbHeader.Function =  (op);                                                        \
  (urb)->UrbHeader.Length = sizeof(struct _URB_CONTROL_GET_STATUS_REQUEST);                 \
  (urb)->UrbControlGetStatusRequest.TransferBufferLength = sizeof(USHORT);                  \
  (urb)->UrbControlGetStatusRequest.TransferBufferMDL = (transferBufferMDL);                \
  (urb)->UrbControlGetStatusRequest.TransferBuffer = (transferBuffer);                      \
  (urb)->UrbControlGetStatusRequest.Index = (index);                                        \
  (urb)->UrbControlGetStatusRequest.UrbLink = (link);                                       \
}

Definition at line 35 of file usbdlib.h.

UsbBuildInterruptOrBulkTransferRequest

#define UsbBuildInterruptOrBulkTransferRequest	(		urb,
			length,
			pipeHandle,
			transferBuffer,
			transferBufferMDL,
			transferBufferLength,
			transferFlags,
			link
	)

Value:

{ \
  (urb)->UrbHeader.Function = URB_FUNCTION_BULK_OR_INTERRUPT_TRANSFER;                                                                                 \
  (urb)->UrbHeader.Length = (length);                                                                                                                  \
  (urb)->UrbBulkOrInterruptTransfer.PipeHandle = (pipeHandle);                                                                                         \
  (urb)->UrbBulkOrInterruptTransfer.TransferBufferLength = (transferBufferLength);                                                                     \
  (urb)->UrbBulkOrInterruptTransfer.TransferBufferMDL = (transferBufferMDL);                                                                           \
  (urb)->UrbBulkOrInterruptTransfer.TransferBuffer = (transferBuffer);                                                                                 \
  (urb)->UrbBulkOrInterruptTransfer.TransferFlags = (transferFlags);                                                                                   \
  (urb)->UrbBulkOrInterruptTransfer.UrbLink = (link);                                                                                                  \
}

Definition at line 12 of file usbdlib.h.

UsbBuildOsFeatureDescriptorRequest

#define UsbBuildOsFeatureDescriptorRequest	(		urb,
			length,
			interface,
			index,
			transferBuffer,
			transferBufferMDL,
			transferBufferLength,
			link
	)

Value:

{ \
  (urb)->UrbHeader.Function = URB_FUNCTION_GET_MS_FEATURE_DESCRIPTOR;                                                                      \
  (urb)->UrbHeader.Length = (length);                                                                                                      \
  (urb)->UrbOSFeatureDescriptorRequest.TransferBufferLength = (transferBufferLength);                                                      \
  (urb)->UrbOSFeatureDescriptorRequest.TransferBufferMDL = (transferBufferMDL);                                                            \
  (urb)->UrbOSFeatureDescriptorRequest.TransferBuffer = (transferBuffer);                                                                  \
  (urb)->UrbOSFeatureDescriptorRequest.InterfaceNumber = (interface);                                                                      \
  (urb)->UrbOSFeatureDescriptorRequest.MS_FeatureDescriptorIndex = (index);                                                                \
  (urb)->UrbOSFeatureDescriptorRequest.UrbLink = (link);                                                                                    \
}

Definition at line 84 of file usbdlib.h.

UsbBuildSelectConfigurationRequest

#define UsbBuildSelectConfigurationRequest	(		urb,
			length,
			configurationDescriptor
	)

Value:

{   \
  (urb)->UrbHeader.Function =  URB_FUNCTION_SELECT_CONFIGURATION;                    \
  (urb)->UrbHeader.Length = (length);                                                \
  (urb)->UrbSelectConfiguration.ConfigurationDescriptor = (configurationDescriptor); \
}

Definition at line 53 of file usbdlib.h.

UsbBuildSelectInterfaceRequest

#define UsbBuildSelectInterfaceRequest	(		urb,
			length,
			configurationHandle,
			interfaceNumber,
			alternateSetting
	)

Value:

{             \
  (urb)->UrbHeader.Function =  URB_FUNCTION_SELECT_INTERFACE;                                                             \
  (urb)->UrbHeader.Length = (length);                                                                                     \
  (urb)->UrbSelectInterface.Interface.AlternateSetting = (alternateSetting);                                              \
  (urb)->UrbSelectInterface.Interface.InterfaceNumber = (interfaceNumber);                                                \
  (urb)->UrbSelectInterface.Interface.Length = (length - sizeof(struct _URB_HEADER) - sizeof(USBD_CONFIGURATION_HANDLE)); \
  (urb)->UrbSelectInterface.ConfigurationHandle = (configurationHandle);                                                  \
}

Definition at line 59 of file usbdlib.h.

UsbBuildVendorRequest

#define UsbBuildVendorRequest	(		urb,
			cmd,
			length,
			transferFlags,
			reservedbits,
			request,
			value,
			index,
			transferBuffer,
			transferBufferMDL,
			transferBufferLength,
			link
	)

Value:

{ \
  (urb)->UrbHeader.Function =  cmd;                                                                                                                                  \
  (urb)->UrbHeader.Length = (length);                                                                                                                                \
  (urb)->UrbControlVendorClassRequest.TransferBufferLength = (transferBufferLength);                                                                                 \
  (urb)->UrbControlVendorClassRequest.TransferBufferMDL = (transferBufferMDL);                                                                                       \
  (urb)->UrbControlVendorClassRequest.TransferBuffer = (transferBuffer);                                                                                             \
  (urb)->UrbControlVendorClassRequest.RequestTypeReservedBits = (reservedbits);                                                                                      \
  (urb)->UrbControlVendorClassRequest.Request = (request);                                                                                                           \
  (urb)->UrbControlVendorClassRequest.Value = (value);                                                                                                               \
  (urb)->UrbControlVendorClassRequest.Index = (index);                                                                                                               \
  (urb)->UrbControlVendorClassRequest.TransferFlags = (transferFlags);                                                                                               \
  (urb)->UrbControlVendorClassRequest.UrbLink = (link);                                                                                                              \
}

Definition at line 68 of file usbdlib.h.

USBD_CLIENT_CONTRACT_VERSION_602

#define USBD_CLIENT_CONTRACT_VERSION_602   0x602

Definition at line 100 of file usbdlib.h.

USBD_CLIENT_CONTRACT_VERSION_INVALID

#define USBD_CLIENT_CONTRACT_VERSION_INVALID   0xFFFFFFFF

Definition at line 99 of file usbdlib.h.

USBD_INTERFACE_VERSION_600

#define USBD_INTERFACE_VERSION_600   0x600

Definition at line 102 of file usbdlib.h.

USBD_INTERFACE_VERSION_602

#define USBD_INTERFACE_VERSION_602   0x602

Definition at line 103 of file usbdlib.h.

USBD_INTERFACE_VERSION_603

#define USBD_INTERFACE_VERSION_603   0x603

Definition at line 104 of file usbdlib.h.

Typedef Documentation

PUSBD_INTERFACE_LIST_ENTRY

typedef struct _USBD_INTERFACE_LIST_ENTRY * PUSBD_INTERFACE_LIST_ENTRY

USBD_INTERFACE_LIST_ENTRY

typedef struct _USBD_INTERFACE_LIST_ENTRY USBD_INTERFACE_LIST_ENTRY

Function Documentation

_In_reads_bytes_()

_In_ ULONG _In_reads_bytes_

(

KeyNameLength

)

_Inout_updates_bytes_()

_Inout_updates_bytes_

(

ParameterLength

)

_IRQL_requires_max_() [1/3]

_IRQL_requires_max_

(

DISPATCH_LEVEL

)

Definition at line 3557 of file common.c.

{
    NTSTATUS                    status;
    BOOLEAN                     requestSent = FALSE;

    BOOLEAN                     shouldRetry = TRUE;
    PCDB                        cdb = (PCDB)DeviceExtension->PowerContext.Srb.Cdb;
    ULONG                       timeoutValue = DeviceExtension->TimeOutValue;
    ULONG                       retryCount = 1;

    // reset some fields.
    DeviceExtension->PowerContext.RetryIntervalIn100ns = 0;
    status = PowerContextReuseRequest(DeviceExtension);
    RequestClearSendTime(DeviceExtension->PowerContext.PowerRequest);

    if (!NT_SUCCESS(status))
    {
        return status;
    }

    // set proper timeout value and max retry count.
    switch(DeviceExtension->PowerContext.PowerChangeState.PowerDown)
    {
    case PowerDownDeviceInitial:
    case PowerDownDeviceQuiesced:
    case PowerDownDeviceStopped:
        break;

    case PowerDownDeviceLocked:
        // Case of issuing SYNC CACHE command. Do not use power irp timeout remaining time in this case
        // as we want to give best try on SYNC CACHE command.
        retryCount = MAXIMUM_RETRIES;
        timeoutValue = DeviceExtension->TimeOutValue;
        break;

    case PowerDownDeviceFlushed:
    {
        // Case of issuing STOP UNIT command
        // As "Imme" bit is set to '1', this command should be completed in short time.
        // This command is at low importance, failure of this command has very small impact.
        ULONG secondsRemaining = 0;

#if (WINVER >= 0x0601)
        // this API is introduced in Windows7
        PoQueryWatchdogTime(DeviceExtension->LowerPdo, &secondsRemaining);
#endif

        if (secondsRemaining == 0)
        {
            // not able to retrieve remaining time from PoQueryWatchdogTime API, use default values.
            retryCount = MAXIMUM_RETRIES;
            timeoutValue = SCSI_CDROM_TIMEOUT;
        }
        else
        {
            // plan to leave about 30 seconds to lower level drivers if possible.
            if (secondsRemaining >= 32)
            {
                retryCount = (secondsRemaining - 30)/SCSI_CDROM_TIMEOUT + 1;
                timeoutValue = SCSI_CDROM_TIMEOUT;

                if (retryCount > MAXIMUM_RETRIES)
                {
                    retryCount = MAXIMUM_RETRIES;
                }

                if (retryCount == 1)
                {
                    timeoutValue = secondsRemaining - 30;
                }
            }
            else
            {
                // issue the command with minimal timeout value and do not retry on it.
                retryCount = 1;
                timeoutValue = 2;
            }
        }
    }
        break;
    default:
        NT_ASSERT( FALSE );
        status = STATUS_NOT_IMPLEMENTED;
        return status;
    }

    DeviceExtension->PowerContext.RetryCount = retryCount;

    // issue command.
    while (shouldRetry)
    {

        // set SRB fields.
        DeviceExtension->PowerContext.Srb.SrbFlags = SRB_FLAGS_NO_DATA_TRANSFER |
                                                     SRB_FLAGS_DISABLE_SYNCH_TRANSFER |
                                                     SRB_FLAGS_NO_QUEUE_FREEZE |
                                                     SRB_FLAGS_BYPASS_LOCKED_QUEUE |
                                                     SRB_FLAGS_D3_PROCESSING;

        DeviceExtension->PowerContext.Srb.Function = SRB_FUNCTION_EXECUTE_SCSI;
        DeviceExtension->PowerContext.Srb.TimeOutValue = timeoutValue;

        if (DeviceExtension->PowerContext.PowerChangeState.PowerDown == PowerDownDeviceInitial)
        {
            DeviceExtension->PowerContext.Srb.Function = SRB_FUNCTION_LOCK_QUEUE;
        }
        else if (DeviceExtension->PowerContext.PowerChangeState.PowerDown == PowerDownDeviceLocked)
        {
            DeviceExtension->PowerContext.Srb.Function = SRB_FUNCTION_QUIESCE_DEVICE;
        }
        else if (DeviceExtension->PowerContext.PowerChangeState.PowerDown == PowerDownDeviceQuiesced)
        {
            // Case of issuing SYNC CACHE command.
            DeviceExtension->PowerContext.Srb.CdbLength = 10;
            cdb->SYNCHRONIZE_CACHE10.OperationCode = SCSIOP_SYNCHRONIZE_CACHE;
        }
        else if (DeviceExtension->PowerContext.PowerChangeState.PowerDown == PowerDownDeviceFlushed)
        {
            // Case of issuing STOP UNIT command.
            DeviceExtension->PowerContext.Srb.CdbLength = 6;
            cdb->START_STOP.OperationCode = SCSIOP_START_STOP_UNIT;
            cdb->START_STOP.Start = 0;
            cdb->START_STOP.Immediate = 1;
        }
        else if (DeviceExtension->PowerContext.PowerChangeState.PowerDown == PowerDownDeviceStopped)
        {
            DeviceExtension->PowerContext.Srb.Function = SRB_FUNCTION_UNLOCK_QUEUE;
        }

        // Set up completion routine and context if requested
        if (CompletionRoutine)
        {
            WdfRequestSetCompletionRoutine(DeviceExtension->PowerContext.PowerRequest,
                                           CompletionRoutine,
                                           Context);
        }

        status = RequestSend(DeviceExtension,
                             DeviceExtension->PowerContext.PowerRequest,
                             DeviceExtension->IoTarget,
                             CompletionRoutine ? 0 : WDF_REQUEST_SEND_OPTION_SYNCHRONOUS,
                             &requestSent);

        if (requestSent)
        {
            if ((CompletionRoutine == NULL) &&
                (SRB_STATUS(DeviceExtension->PowerContext.Srb.SrbStatus) != SRB_STATUS_SUCCESS))
            {
                TracePrint((TRACE_LEVEL_ERROR,
                            TRACE_FLAG_POWER,
                            "%p\tError occured when issuing %s command to device. Srb %p, Status %x\n",
                            DeviceExtension->PowerContext.PowerRequest,
                            (DeviceExtension->PowerContext.PowerChangeState.PowerDown == PowerDownDeviceQuiesced) ? "SYNC CACHE" : "STOP UNIT",
                            &DeviceExtension->PowerContext.Srb,
                            DeviceExtension->PowerContext.Srb.SrbStatus));

                NT_ASSERT(!(TEST_FLAG(DeviceExtension->PowerContext.Srb.SrbStatus, SRB_STATUS_QUEUE_FROZEN)));

                shouldRetry = RequestSenseInfoInterpret(DeviceExtension,
                                                        DeviceExtension->PowerContext.PowerRequest,
                                                        &(DeviceExtension->PowerContext.Srb),
                                                        retryCount - DeviceExtension->PowerContext.RetryCount,
                                                        &status,
                                                        &(DeviceExtension->PowerContext.RetryIntervalIn100ns));

                if (shouldRetry && (DeviceExtension->PowerContext.RetryCount-- == 0))
                {
                    shouldRetry = FALSE;
                }
            }
            else
            {
                // succeeded, do not need to retry.
                shouldRetry = FALSE;
            }

        }
        else
        {
            // request failed to be sent
            shouldRetry = FALSE;
        }

        if (shouldRetry)
        {
            LARGE_INTEGER t;
            t.QuadPart = -DeviceExtension->PowerContext.RetryIntervalIn100ns;
            KeDelayExecutionThread(KernelMode, FALSE, &t);

            status = PowerContextReuseRequest(DeviceExtension);
            if (!NT_SUCCESS(status))
            {
                shouldRetry = FALSE;
            }
        }
    }

    if (DeviceExtension->PowerContext.PowerChangeState.PowerDown == PowerDownDeviceQuiesced)
    {
        // record SYNC CACHE command completion time stamp.
        KeQueryTickCount(&DeviceExtension->PowerContext.Step1CompleteTime);
    }

    return status;
}

_IRQL_requires_max_() [2/3]

_IRQL_requires_max_

(

APC_LEVEL

)

Definition at line 197 of file cddata.c.

{
    THREAD_CONTEXT ThreadContext = {0};
    PIRP_CONTEXT IrpContext = NULL;
    BOOLEAN Wait;

#ifdef CD_SANITY
    PVOID PreviousTopLevel;
#endif

    NTSTATUS Status;

#if DBG

    KIRQL SaveIrql = KeGetCurrentIrql();

#endif

    ASSERT_OPTIONAL_IRP( Irp );

    UNREFERENCED_PARAMETER( DeviceObject );

    FsRtlEnterFileSystem();

#ifdef CD_SANITY
    PreviousTopLevel = IoGetTopLevelIrp();
#endif

    //
    //  Loop until this request has been completed or posted.
    //

    do {

        //
        //  Use a try-except to handle the exception cases.
        //

        _SEH2_TRY {

            //
            //  If the IrpContext is NULL then this is the first pass through
            //  this loop.
            //

            if (IrpContext == NULL) {

                //
                //  Decide if this request is waitable an allocate the IrpContext.
                //  If the file object in the stack location is NULL then this
                //  is a mount which is always waitable.  Otherwise we look at
                //  the file object flags.
                //

                if (IoGetCurrentIrpStackLocation( Irp )->FileObject == NULL) {

                    Wait = TRUE;

                } else {

                    Wait = CanFsdWait( Irp );
                }

                IrpContext = CdCreateIrpContext( Irp, Wait );

                //
                //  Update the thread context information.
                //

                CdSetThreadContext( IrpContext, &ThreadContext );

#ifdef CD_SANITY
                NT_ASSERT( !CdTestTopLevel ||
                        SafeNodeType( IrpContext->TopLevel ) == CDFS_NTC_IRP_CONTEXT );
#endif

            //
            //  Otherwise cleanup the IrpContext for the retry.
            //

            } else {

                //
                //  Set the MORE_PROCESSING flag to make sure the IrpContext
                //  isn't inadvertently deleted here.  Then cleanup the
                //  IrpContext to perform the retry.
                //

                SetFlag( IrpContext->Flags, IRP_CONTEXT_FLAG_MORE_PROCESSING );
                CdCleanupIrpContext( IrpContext, FALSE );
            }

            //
            //  Case on the major irp code.
            //

            switch (IrpContext->MajorFunction) {

            case IRP_MJ_CREATE :

                Status = CdCommonCreate( IrpContext, Irp );
                break;

            case IRP_MJ_CLOSE :

                Status = CdCommonClose( IrpContext, Irp );
                break;

            case IRP_MJ_READ :

                //
                //  If this is an Mdl complete request, don't go through
                //  common read.
                //

                if (FlagOn( IrpContext->MinorFunction, IRP_MN_COMPLETE )) {

                    Status = CdCompleteMdl( IrpContext, Irp );

                } else {

                    Status = CdCommonRead( IrpContext, Irp );
                }

                break;

            case IRP_MJ_WRITE :

                Status = CdCommonWrite( IrpContext, Irp );
                break;

            case IRP_MJ_QUERY_INFORMATION :

                Status = CdCommonQueryInfo( IrpContext, Irp );
                break;

            case IRP_MJ_SET_INFORMATION :

                Status = CdCommonSetInfo( IrpContext, Irp );
                break;

            case IRP_MJ_QUERY_VOLUME_INFORMATION :

                Status = CdCommonQueryVolInfo( IrpContext, Irp );
                break;

            case IRP_MJ_DIRECTORY_CONTROL :

                Status = CdCommonDirControl( IrpContext, Irp );
                break;

            case IRP_MJ_FILE_SYSTEM_CONTROL :

                Status = CdCommonFsControl( IrpContext, Irp );
                break;

            case IRP_MJ_DEVICE_CONTROL :

                Status = CdCommonDevControl( IrpContext, Irp );
                break;

            case IRP_MJ_LOCK_CONTROL :

                Status = CdCommonLockControl( IrpContext, Irp );
                break;

            case IRP_MJ_CLEANUP :

                Status = CdCommonCleanup( IrpContext, Irp );
                break;

            case IRP_MJ_PNP :

                Status = CdCommonPnp( IrpContext, Irp );
                break;

            case IRP_MJ_SHUTDOWN :
            
                Status = CdCommonShutdown( IrpContext, Irp );
                break;

            default :

                Status = STATUS_INVALID_DEVICE_REQUEST;
                CdCompleteRequest( IrpContext, Irp, Status );
            }

        } _SEH2_EXCEPT( CdExceptionFilter( IrpContext, _SEH2_GetExceptionInformation() )) {

            Status = CdProcessException( IrpContext, Irp, _SEH2_GetExceptionCode() );
        } _SEH2_END;

    } while (Status == STATUS_CANT_WAIT);

#ifdef CD_SANITY
    NT_ASSERT( !CdTestTopLevel ||
            (PreviousTopLevel == IoGetTopLevelIrp()) );
#endif

    FsRtlExitFileSystem();

    NT_ASSERT( SaveIrql == KeGetCurrentIrql( ));

    return Status;
}

_IRQL_requires_max_() [3/3]

_IRQL_requires_max_

(

PASSIVE_LEVEL

)

Definition at line 64 of file Messaging.c.

{
    PFLT_SERVER_PORT_OBJECT PortObject;
    NTSTATUS Status;

    /* The caller must allow at least one connection */
    if (MaxConnections == 0)
    {
        return STATUS_INVALID_PARAMETER;
    }

    /* The request must be for a kernel handle */
    if (!(ObjectAttributes->Attributes & OBJ_KERNEL_HANDLE))
    {
        return STATUS_INVALID_PARAMETER;
    }

    /*
     * Get rundown protection on the target to stop the owner
     * from unloading whilst this port object is open. It gets
     * removed in the FltpServerPortClose callback
     */
    Status = FltObjectReference(Filter);
    if (!NT_SUCCESS(Status))
    {
        return Status;
    }

    /* Create the server port object for this filter */
    Status = ObCreateObject(KernelMode,
                            ServerPortObjectType,
                            ObjectAttributes,
                            KernelMode,
                            NULL,
                            sizeof(FLT_SERVER_PORT_OBJECT),
                            0,
                            0,
                            (PVOID *)&PortObject);
    if (NT_SUCCESS(Status))
    {
        /* Zero out the struct */
        RtlZeroMemory(PortObject, sizeof(FLT_SERVER_PORT_OBJECT));

        /* Increment the ref count on the target filter */
        FltpObjectPointerReference((PFLT_OBJECT)Filter);

        /* Setup the filter port object */
        PortObject->Filter = Filter;
        PortObject->ConnectNotify = ConnectNotifyCallback;
        PortObject->DisconnectNotify = DisconnectNotifyCallback;
        PortObject->MessageNotify = MessageNotifyCallback;
        PortObject->Cookie = ServerPortCookie;
        PortObject->MaxConnections = MaxConnections;

        /* Insert the object */
        Status = ObInsertObject(PortObject,
                                NULL,
                                STANDARD_RIGHTS_ALL | FILE_READ_DATA,
                                0,
                                NULL,
                                (PHANDLE)ServerPort);
        if (NT_SUCCESS(Status))
        {
            /* Lock the connection list */
            ExAcquireFastMutex(&Filter->ConnectionList.mLock);

            /* Add the new port object to the connection list and increment the count */
            InsertTailList(&Filter->ConnectionList.mList, &PortObject->FilterLink);
            Filter->ConnectionList.mCount++;

            /* Unlock the connection list*/
            ExReleaseFastMutex(&Filter->ConnectionList.mLock);
        }
    }

    if (!NT_SUCCESS(Status))
    {
        /* Allow the filter to be cleaned up */
        FltObjectDereference(Filter);
    }

    return Status;
}

DECLARE_HANDLE()

DECLARE_HANDLE

(

USBD_HANDLE

)

USBD_CreateConfigurationRequest()

DECLSPEC_IMPORT PURB NTAPI USBD_CreateConfigurationRequest	(	_In_ PUSB_CONFIGURATION_DESCRIPTOR	ConfigurationDescriptor,
		_Out_ PUSHORT	Siz
	)

USBD_ParseConfigurationDescriptor()

DECLSPEC_IMPORT PUSB_INTERFACE_DESCRIPTOR NTAPI USBD_ParseConfigurationDescriptor	(	_In_ PUSB_CONFIGURATION_DESCRIPTOR	ConfigurationDescriptor,
		_In_ UCHAR	InterfaceNumber,
		_In_ UCHAR	AlternateSetting
	)

USBD_QueryBusTime()

DECLSPEC_EXPORT NTSTATUS NTAPI USBD_QueryBusTime	(	_In_ PDEVICE_OBJECT	RootHubPdo,
		_Out_ PULONG	CurrentFrame
	)

Variable Documentation

AlternateSetting

_In_ PVOID _In_ LONG _In_ LONG AlternateSetting

Definition at line 168 of file usbdlib.h.

Referenced by FxUsbParseConfigurationDescriptor(), USBD_ParseConfigurationDescriptor(), and USBD_ParseConfigurationDescriptorEx().

BufferEnd

_In_ PUCHAR BufferEnd

Definition at line 189 of file usbdlib.h.

Referenced by FindNextFileW(), OHCI_MapTransferToTD(), OHCI_ProcessDoneTD(), PointerFree(), test_pack_MIDL_STUB_MESSAGE(), USBD_GetInterfaceLength(), USBH_IoctlGetNodeName(), and USBPORT_QueueTransferUrb().

BufferLength

_In_ ULONG BufferLength

Definition at line 238 of file usbdlib.h.

DescriptorType

_In_ ULONG _In_ PVOID _In_ LONG DescriptorType

Definition at line 158 of file usbdlib.h.

Referenced by AcpiRsSetResourceHeader(), FxUsbFindDescriptorType(), FxUsbUmInitDescriptorUrb(), FxUsbValidateDescriptorType(), Hid_GetDescriptor(), USBAudioGetDescriptor(), USBCCGP_GetDescriptor(), USBD_ParseDescriptors(), and USBSTOR_GetDescriptor().

EndpointType

_In_ UCHAR EndpointType

Definition at line 225 of file usbdlib.h.

Referenced by USBD_CalculateUsbBandwidth().

FilterDeviceObject

_In_ PDEVICE_OBJECT FilterDeviceObject

Definition at line 197 of file usbdlib.h.

InterfaceClass

_In_ PVOID _In_ LONG _In_ LONG _In_ LONG InterfaceClass

Definition at line 168 of file usbdlib.h.

Referenced by USBD_ParseConfigurationDescriptorEx().

InterfaceList

_In_ PUSBD_INTERFACE_LIST_ENTRY InterfaceList

Definition at line 181 of file usbdlib.h.

Referenced by _RpcEnumInterfaces(), CInputPin::CreatePin(), COutputPin::CreatePin(), EnumMonikerImpl_Clone(), FxUsbCreateConfigRequest(), getInterfaces(), Hid_SelectConfiguration(), IrotEnumRunning(), COutputPin::KsQueryInterfaces(), CInputPin::KsQueryInterfaces(), PciQueryInterface(), RunningObjectTableImpl_EnumRunning(), USBAudioSelectConfiguration(), USBD_CreateConfigurationRequestEx(), USBH_OpenConfiguration(), and USBSTOR_SelectConfigurationAndInterface().

InterfaceNumber

_In_ PVOID _In_ LONG InterfaceNumber

Definition at line 168 of file usbdlib.h.

Referenced by FxUsbParseConfigurationDescriptor(), FxUsbDevice::GetInterfaceFromNumber(), FxUsbDevice::GetInterfaceNumberFromInterface(), FxUsbPipe::InitPipe(), USBCCGP_BuildConfigurationDescriptor(), USBCCGP_PdoAppendInterfaceNumber(), USBD_CreateConfigurationRequestEx(), USBD_ParseConfigurationDescriptor(), USBD_ParseConfigurationDescriptorEx(), USBPORT_GetInterfaceHandle(), and USBPORT_ParseConfigurationDescriptor().

InterfaceProtocol

_In_ PVOID _In_ LONG _In_ LONG _In_ LONG _In_ LONG _In_ LONG InterfaceProtocol

Definition at line 168 of file usbdlib.h.

Referenced by USBD_ParseConfigurationDescriptorEx().

InterfaceSubClass

_In_ PVOID _In_ LONG _In_ LONG _In_ LONG _In_ LONG InterfaceSubClass

Definition at line 168 of file usbdlib.h.

Referenced by USBD_ParseConfigurationDescriptorEx().

KeyNameLength

_In_ ULONG _In_ ULONG KeyNameLength

Definition at line 208 of file usbdlib.h.

Referenced by IoOpenDeviceRegistryKey(), and USBD_GetPdoRegistryParameter().

Level

_In_ ULONG _In_ USHORT Level

Definition at line 238 of file usbdlib.h.

LowSpeed

_In_ UCHAR _In_ BOOLEAN LowSpeed

Definition at line 225 of file usbdlib.h.

Referenced by USBD_CalculateUsbBandwidth().

Offset

_In_ ULONG _In_ USHORT _Out_ PUCHAR* Offset

Definition at line 238 of file usbdlib.h.

ParameterLength

_In_ ULONG ParameterLength

Definition at line 206 of file usbdlib.h.

Referenced by BusLogic_Command(), ClasspDeviceGetLBAStatusWorker(), and USBD_GetPdoRegistryParameter().

StartPosition

_In_ PVOID StartPosition

Definition at line 158 of file usbdlib.h.

Referenced by OpenRegistryHandlesFromSymbolicLink(), USBD_ParseConfigurationDescriptorEx(), and USBD_ParseDescriptors().

Tag

_In_ ULONG _In_ USHORT _Out_ PUCHAR _In_opt_ ULONG Tag

Definition at line 238 of file usbdlib.h.

TotalLength

_In_ ULONG TotalLength

Definition at line 158 of file usbdlib.h.

Referenced by AcpiRsGetResourceSource(), AcpiRsSetResourceHeader(), AcpiRsSetResourceLength(), BiEnumerateElements(), BroadcastOpen(), CmpInitializeMachineDependentConfiguration(), CopyPacketToBuffer(), DsppLoadFontFile(), GetPackageSize(), IopGetInterfaceDeviceList(), IopQueryCompatibleIds(), IopQueryHardwareIds(), KdpReportCommandStringStateChange(), LsapGetLogonSessionData(), MupRerouteOpen(), NdisMStartBufferPhysicalMapping(), NtQueryDirectoryObject(), PdoHandleQueryHardwareId(), PdoHandleQueryProperty(), PreloadGlobalMessageTable(), QueryPointsFromSymbolicLinkName(), RegisterBlueScreenMachineInformation(), RtlCopySecurityDescriptor(), RtlExpandEnvironmentStrings_U(), RtlMakeSelfRelativeSD(), SaveCustomPath(), SpiAdapterControl(), TCPSendDataCallback(), USBD_ParseDescriptors(), USBHUB_DumpingIDs(), USBPORT_DumpingIDs(), USBSTOR_HandleQueryProperty(), and USBSTOR_PdoHandleQueryHardwareId().