#include <ntddk.h>
#include <windef.h>
#include <fxldr.h>
#include <wdf.h>
#include <ucxclass.h>

Include dependency graph for ucx01000.h:

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

Macros
#define	UCX_POOL_TAG 'xcUR'

#define	UCX_CLASS_MAJOR_VERSION 1

#define	UCX_CLASS_MINOR_VERSION 7

Functions
	_IRQL_requires_ (PASSIVE_LEVEL) NTSTATUS NTAPI UcxOnClassLoad(VOID)
	Sends a synchronous IOCTL to the specified device object.

_Must_inspect_result_	_IRQL_requires_max_ (DISPATCH_LEVEL) BOOLEAN NTAPI UcxApiIoDeviceControl(_In_ PUCX_DRIVER_GLOBALS DriverGlobals

VOID NTAPI	UcxApiUsbDeviceInitSetEventCallbacks (_In_ PUCX_DRIVER_GLOBALS DriverGlobals, _Inout_ PUCXUSBDEVICE_INIT UsbDeviceInit, _In_ PUCX_USBDEVICE_EVENT_CALLBACKS EventCallbacks)

VOID NTAPI	UcxApiEndpointInitSetEventCallbacks (_In_ PUCX_DRIVER_GLOBALS DriverGlobals, _Inout_ PUCXENDPOINT_INIT EndpointInit, _In_ PUCX_ENDPOINT_EVENT_CALLBACKS EventCallbacks)

VOID NTAPI	UcxApiDefaultEndpointInitSetEventCallbacks (_In_ PUCX_DRIVER_GLOBALS DriverGlobals, _Inout_ PUCXENDPOINT_INIT EndpointInit, _In_ PUCX_DEFAULT_ENDPOINT_EVENT_CALLBACKS EventCallbacks)

VOID NTAPI	UcxApiEndpointSetWdfIoQueue (_In_ PUCX_DRIVER_GLOBALS DriverGlobals, _In_ UCXENDPOINT Endpoint, _In_ WDFQUEUE WdfQueue)

VOID NTAPI	UcxApiStaticStreamsSetStreamInfo (_In_ PUCX_DRIVER_GLOBALS DriverGlobals, _In_ UCXSSTREAMS StaticStreams, _In_ PSTREAM_INFO StreamInfo)

Variables
WDF_CLASS_LIBRARY_INFO	UcxClassLibraryInfo

_Out_ PWDF_COMPONENT_GLOBALS *	ComponentGlobals

_Must_inspect_result_ _In_ WDFDEVICE	Device

_Must_inspect_result_ _In_ WDFDEVICE _In_ WDFREQUEST	Request

_Must_inspect_result_ _In_ WDFDEVICE _In_ WDFREQUEST _In_ size_t	OutputBufferLength

_Must_inspect_result_ _In_ WDFDEVICE _In_ WDFREQUEST _In_ size_t _In_ size_t	InputBufferLength

_Must_inspect_result_ _In_ WDFDEVICE _In_ WDFREQUEST _In_ size_t _In_ size_t _In_ ULONG	IoControlCode

_Must_inspect_result_ _In_ WDFDEVICE _In_ PUCX_CONTROLLER_CONFIG	Config

_Must_inspect_result_ _In_ WDFDEVICE _In_ PUCX_CONTROLLER_CONFIG _In_opt_ PWDF_OBJECT_ATTRIBUTES	Attributes

_Must_inspect_result_ _In_ WDFDEVICE _In_ PUCX_CONTROLLER_CONFIG _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_ UCXCONTROLLER *	Controller

_In_ UCXCONTROLLER _In_ PUCX_CONTROLLER_RESET_COMPLETE_INFO	UcxControllerResetCompleteInfo

_Must_inspect_result_ _In_ UCXCONTROLLER _In_ PUCX_ROOTHUB_CONFIG _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_ UCXROOTHUB *	RootHub

_In_ UCXROOTHUB	UcxRootHub

_Must_inspect_result_ _In_ UCXCONTROLLER _Inout_ PUCXUSBDEVICE_INIT *	UsbDeviceInit

_Must_inspect_result_ _In_ UCXCONTROLLER _Inout_ PUCXUSBDEVICE_INIT _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_ UCXUSBDEVICE *	UsbDevice

_In_ UCXUSBDEVICE _In_ ULONG	Interface

_Must_inspect_result_ _In_ UCXUSBDEVICE _Inout_ PUCXENDPOINT_INIT *	EndpointInit

_Must_inspect_result_ _In_ UCXUSBDEVICE _Inout_ PUCXENDPOINT_INIT _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_ UCXENDPOINT *	Endpoint

_Must_inspect_result_ _In_ UCXENDPOINT _In_ PVOID	Tag

_Must_inspect_result_ _In_ UCXENDPOINT _Inout_ PUCXSSTREAMS_INIT *	StaticStreamsInit

_Must_inspect_result_ _In_ UCXENDPOINT _Inout_ PUCXSSTREAMS_INIT _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_ UCXSSTREAMS *	StaticStreams

_Inout_ PWDFDEVICE_INIT	DeviceInit

_In_ UCXCONTROLLER _In_ PUNICODE_STRING	ManufacturerNameString

_In_ UCXCONTROLLER _In_ PUNICODE_STRING _In_ PUNICODE_STRING	ModelNameString

_In_ UCXCONTROLLER _In_ PUNICODE_STRING _In_ PUNICODE_STRING _In_ PUNICODE_STRING	ModelNumberString

_In_ UCXCONTROLLER _In_ PUCX_CONTROLLER_TRANSPORT_CHARACTERISTICS	UcxControllerTransportCharacteristics

Macro Definition Documentation

◆ UCX_CLASS_MAJOR_VERSION

#define UCX_CLASS_MAJOR_VERSION 1

Definition at line 18 of file ucx01000.h.

◆ UCX_CLASS_MINOR_VERSION

#define UCX_CLASS_MINOR_VERSION 7

Definition at line 19 of file ucx01000.h.

◆ UCX_POOL_TAG

#define UCX_POOL_TAG 'xcUR'

Definition at line 16 of file ucx01000.h.

Function Documentation

◆ _IRQL_requires_()

_IRQL_requires_ ( PASSIVE_LEVEL )

Sends a synchronous IOCTL to the specified device object.

Parameters

[in]	IoControlCode	The IOCTL to send to the device.
[in]	DeviceObject	Pointer to the device object that will handle the IOCTL.
[in]	InputBuffer	Optional pointer to a buffer containing input data for the IOCTL. When specified, the buffer should be at least of InputBufferLength size.
[in]	InputBufferLength	Size in bytes, of the buffer pointed by InputBuffer.
[out]	OutputBuffer	Optional pointer to a buffer that will receive output data from the IOCTL. When specified, the buffer should be at least of OutputBufferLength size.
[in]	OutputBufferLength	Size in bytes, of the buffer pointed by OutputBuffer.
[in]	FileObject	Optional pointer to a file object that may be necessary for the IOCTL.

Returns: An NTSTATUS code indicating success or failure of this function.

Note: Must be called at PASSIVE_LEVEL with all APCs enabled.

Definition at line 2121 of file class.c.

{
    NTSTATUS status = STATUS_SUCCESS;
 
    PAGED_CODE();
 
    TracePrint((TRACE_LEVEL_VERBOSE,
                TRACE_FLAG_PNP,
                "ClassDetermineTokenOperationCommandSupport (%p): Entering function.\n",
                DeviceObject));
 
    //
    // Send down Inquiry for VPD_THIRD_PARTY_COPY_PAGE and cache away the device parameters
    // from WINDOWS_BLOCK_DEVICE_TOKEN_LIMITS_DESCRIPTOR.
    //
    status = ClasspGetBlockDeviceTokenLimitsInfo(DeviceObject);
 
    if (NT_SUCCESS(status)) {
 
        ULONG maxListIdentifier = MaxTokenOperationListIdentifier;
 
        //
        // Query the maximum list identifier to use for TokenOperation commands.
        //
        if (NT_SUCCESS(ClasspGetMaximumTokenListIdentifier(DeviceObject, REG_DISK_CLASS_CONTROL, &maxListIdentifier))) {
            if (maxListIdentifier >= MIN_TOKEN_LIST_IDENTIFIERS) {
 
                NT_ASSERT(maxListIdentifier <= MAX_TOKEN_LIST_IDENTIFIERS);
                MaxTokenOperationListIdentifier = maxListIdentifier;
            }
        }
 
    }
 
    TracePrint((TRACE_LEVEL_VERBOSE,
                TRACE_FLAG_PNP,
                "ClassDetermineTokenOperationCommandSupport (%p): Exiting function with status %x.\n",
                DeviceObject,
                status));
 
    return status;
}

◆ _IRQL_requires_max_()

_Must_inspect_result_ _IRQL_requires_max_ ( DISPATCH_LEVEL )

Definition at line 77 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;
}

◆ UcxApiDefaultEndpointInitSetEventCallbacks()

VOID NTAPI UcxApiDefaultEndpointInitSetEventCallbacks	(	_In_ PUCX_DRIVER_GLOBALS	DriverGlobals,
		_Inout_ PUCXENDPOINT_INIT	EndpointInit,
		_In_ PUCX_DEFAULT_ENDPOINT_EVENT_CALLBACKS	EventCallbacks
	)

Definition at line 299 of file exports.cpp.

{
    UNREFERENCED_PARAMETER(DriverGlobals);
    UNREFERENCED_PARAMETER(EndpointInit);
    UNREFERENCED_PARAMETER(EventCallbacks);
    UNIMPLEMENTED;
}

Referenced by _IRQL_requires_().

◆ UcxApiEndpointInitSetEventCallbacks()

VOID NTAPI UcxApiEndpointInitSetEventCallbacks	(	_In_ PUCX_DRIVER_GLOBALS	DriverGlobals,
		_Inout_ PUCXENDPOINT_INIT	EndpointInit,
		_In_ PUCX_ENDPOINT_EVENT_CALLBACKS	EventCallbacks
	)

Definition at line 286 of file exports.cpp.

{
    UNREFERENCED_PARAMETER(DriverGlobals);
    UNREFERENCED_PARAMETER(EndpointInit);
    UNREFERENCED_PARAMETER(EventCallbacks);
    UNIMPLEMENTED;
}

Referenced by _IRQL_requires_().

◆ UcxApiEndpointSetWdfIoQueue()

VOID NTAPI UcxApiEndpointSetWdfIoQueue	(	_In_ PUCX_DRIVER_GLOBALS	DriverGlobals,
		_In_ UCXENDPOINT	Endpoint,
		_In_ WDFQUEUE	WdfQueue
	)

Definition at line 312 of file exports.cpp.

{
    UNREFERENCED_PARAMETER(DriverGlobals);
    UNREFERENCED_PARAMETER(Endpoint);
    UNREFERENCED_PARAMETER(WdfQueue);
    UNIMPLEMENTED;
}

Referenced by _IRQL_requires_().

◆ UcxApiStaticStreamsSetStreamInfo()

VOID NTAPI UcxApiStaticStreamsSetStreamInfo	(	_In_ PUCX_DRIVER_GLOBALS	DriverGlobals,
		_In_ UCXSSTREAMS	StaticStreams,
		_In_ PSTREAM_INFO	StreamInfo
	)

Definition at line 363 of file exports.cpp.

{
    UNREFERENCED_PARAMETER(DriverGlobals);
    UNREFERENCED_PARAMETER(StaticStreams);
    UNREFERENCED_PARAMETER(StreamInfo);
    UNIMPLEMENTED;
}

Referenced by _IRQL_requires_().

◆ UcxApiUsbDeviceInitSetEventCallbacks()

VOID NTAPI UcxApiUsbDeviceInitSetEventCallbacks	(	_In_ PUCX_DRIVER_GLOBALS	DriverGlobals,
		_Inout_ PUCXUSBDEVICE_INIT	UsbDeviceInit,
		_In_ PUCX_USBDEVICE_EVENT_CALLBACKS	EventCallbacks
	)

Definition at line 207 of file exports.cpp.

{
    UNREFERENCED_PARAMETER(DriverGlobals);
    UNREFERENCED_PARAMETER(UsbDeviceInit);
    UNREFERENCED_PARAMETER(EventCallbacks);
    UNIMPLEMENTED;
}