#include "fxusbpch.hpp"
#include "FxUsbInterfaceAPI.tmh"

Include dependency graph for fxusbinterfaceapi.cpp:

Functions
_Must_inspect_result_	__drv_maxIRQL (PASSIVE_LEVEL) NTSTATUS WDFAPI WDFEXPORT(WdfUsbInterfaceSelectSetting)(__in PWDF_DRIVER_GLOBALS DriverGlobals

	FxObjectHandleGetPtrAndGlobals (GetFxDriverGlobals(DriverGlobals), UsbInterface, FX_TYPE_USB_INTERFACE,(PVOID *) &pUsbInterface, &pFxDriverGlobals)

	FxPointerNotNull (pFxDriverGlobals, Params)

	if (!NT_SUCCESS(status))

	if (Params->Size !=sizeof(WDF_USB_INTERFACE_SELECT_SETTING_PARAMS))

	if (Params->Type !=WdfUsbInterfaceSelectSettingTypeSetting)

	switch (Params->Type)

	__drv_maxIRQL (DISPATCH_LEVEL) BYTE WDFAPI WDFEXPORT(WdfUsbInterfaceGetInterfaceNumber)(__in PWDF_DRIVER_GLOBALS DriverGlobals

	FxObjectHandleGetPtr (GetFxDriverGlobals(DriverGlobals), UsbInterface, FX_TYPE_USB_INTERFACE,(PVOID *) &pUsbInterface)

return pUsbInterface	GetInterfaceNumber ()

return pUsbInterface	GetNumEndpoints (SettingIndex)

	FxPointerNotNull (pFxDriverGlobals, EndpointInfo)

	if (EndpointInfo->Size !=sizeof(WDF_USB_PIPE_INFORMATION))

pUsbInterface	GetEndpointInformation (SettingIndex, EndpointIndex, EndpointInfo)

return pUsbInterface	GetNumSettings ()

	FxPointerNotNull (pFxDriverGlobals, InterfaceDescriptor)

pUsbInterface	GetDescriptor (InterfaceDescriptor, SettingIndex)

return pUsbInterface	GetConfiguredSettingIndex ()

return pUsbInterface	GetNumConfiguredPipes ()

	if (PipeInfo !=NULL &&PipeInfo->Size !=sizeof(WDF_USB_PIPE_INFORMATION))

return pUsbInterface	GetConfiguredPipe (PipeIndex, PipeInfo)

Variables
_Must_inspect_result_ __in WDFUSBINTERFACE	UsbInterface

_Must_inspect_result_ __in WDFUSBINTERFACE __in_opt PWDF_OBJECT_ATTRIBUTES	PipesAttributes

_Must_inspect_result_ __in WDFUSBINTERFACE __in_opt PWDF_OBJECT_ATTRIBUTES __in PWDF_USB_INTERFACE_SELECT_SETTING_PARAMS	Params

PFX_DRIVER_GLOBALS	pFxDriverGlobals

FxUsbInterface *	pUsbInterface

NTSTATUS	status = FxVerifierCheckIrqlLevel(pFxDriverGlobals, PASSIVE_LEVEL)

__in WDFUSBINTERFACE __in UCHAR	SettingIndex

__in WDFUSBINTERFACE __in UCHAR __in UCHAR	EndpointIndex

__in WDFUSBINTERFACE __in UCHAR __in UCHAR __out PWDF_USB_PIPE_INFORMATION	EndpointInfo

__in WDFUSBINTERFACE __in UCHAR __out PUSB_INTERFACE_DESCRIPTOR	InterfaceDescriptor

__in WDFUSBINTERFACE __in UCHAR	PipeIndex

__in WDFUSBINTERFACE __in UCHAR __out_opt PWDF_USB_PIPE_INFORMATION	PipeInfo

Function Documentation

◆ __drv_maxIRQL() [1/2]

__drv_maxIRQL ( DISPATCH_LEVEL )

◆ __drv_maxIRQL() [2/2]

_Must_inspect_result_ __drv_maxIRQL ( PASSIVE_LEVEL )

◆ FxObjectHandleGetPtr()

FxObjectHandleGetPtr	(	GetFxDriverGlobals(DriverGlobals)	,
		UsbInterface	,
		FX_TYPE_USB_INTERFACE	,
		(PVOID *) &	pUsbInterface
	)

◆ FxObjectHandleGetPtrAndGlobals()

FxObjectHandleGetPtrAndGlobals	(	GetFxDriverGlobals(DriverGlobals)	,
		UsbInterface	,
		FX_TYPE_USB_INTERFACE	,
		(PVOID *) &	pUsbInterface,
		&	pFxDriverGlobals
	)

◆ FxPointerNotNull() [1/3]

FxPointerNotNull	(	pFxDriverGlobals	,
		EndpointInfo
	)

◆ FxPointerNotNull() [2/3]

FxPointerNotNull	(	pFxDriverGlobals	,
		InterfaceDescriptor
	)

◆ FxPointerNotNull() [3/3]

FxPointerNotNull	(	pFxDriverGlobals	,
		Params
	)

◆ GetConfiguredPipe()

return pUsbInterface GetConfiguredPipe	(	PipeIndex	,
		PipeInfo
	)

◆ GetConfiguredSettingIndex()

return pUsbInterface GetConfiguredSettingIndex ( )

Referenced by FxUsbInterface::CheckAndSelectSettingByIndex().

◆ GetDescriptor()

pUsbInterface GetDescriptor	(	InterfaceDescriptor	,
		SettingIndex
	)

◆ GetEndpointInformation()

pUsbInterface GetEndpointInformation	(	SettingIndex	,
		EndpointIndex	,
		EndpointInfo
	)

◆ GetInterfaceNumber()

return pUsbInterface GetInterfaceNumber ( )

Referenced by FxUsbDevice::GetInterfaceFromNumber().

◆ GetNumConfiguredPipes()

return pUsbInterface GetNumConfiguredPipes ( )

◆ GetNumEndpoints()

return pUsbInterface GetNumEndpoints ( SettingIndex )

◆ GetNumSettings()

return pUsbInterface GetNumSettings ( )

◆ if() [1/5]

if ( ! NT_SUCCESSstatus )

Definition at line 78 of file fxusbinterfaceapi.cpp.

                             {
        return status;
    }

◆ if() [2/5]

if ( EndpointInfo->Size ! = sizeof(WDF_USB_PIPE_INFORMATION) )

Definition at line 279 of file fxusbinterfaceapi.cpp.

                                                                {
        DoTraceLevelMessage(
            pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
            "EndpointInfo Size %d incorrect, expected %d, %!STATUS!",
            EndpointInfo->Size, sizeof(WDF_USB_PIPE_INFORMATION),
            STATUS_INFO_LENGTH_MISMATCH);
        FxVerifierDbgBreakPoint(pFxDriverGlobals);
        return;
    }

◆ if() [3/5]

if ( Params->Size ! = sizeof(WDF_USB_INTERFACE_SELECT_SETTING_PARAMS) )

Definition at line 82 of file fxusbinterfaceapi.cpp.

                                                                         {
        status = STATUS_INFO_LENGTH_MISMATCH;
        DoTraceLevelMessage(
            pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
            "Params size %d, expected %d %!STATUS!", Params->Size,
            sizeof(WDF_USB_INTERFACE_SELECT_SETTING_PARAMS), status);
        return status;
    }

◆ if() [4/5]

if ( Params->Type ! = WdfUsbInterfaceSelectSettingTypeSetting )

Definition at line 99 of file fxusbinterfaceapi.cpp.

                                                                 {
        FX_VERIFY_WITH_NAME(INTERNAL, TRAPMSG("UMDF may only select settings by index."),
            DriverGlobals->DriverName);
    }

◆ if() [5/5]

if ( PipeInfo ! = NULL && PipeInfo->Size != sizeof(WDF_USB_PIPE_INFORMATION) )

Definition at line 481 of file fxusbinterfaceapi.cpp.

                                                                                {
        status = STATUS_INFO_LENGTH_MISMATCH;
 
        DoTraceLevelMessage(
            pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
            "PipeInfo Size %d incorrect, expected %d, %!STATUS!",
            PipeInfo->Size, sizeof(WDF_USB_PIPE_INFORMATION), status);
 
        FxVerifierDbgBreakPoint(pFxDriverGlobals);
 
        return NULL;
    }

◆ switch()

switch ( Params-> Type )

Definition at line 105 of file fxusbinterfaceapi.cpp.

                          {
    case WdfUsbInterfaceSelectSettingTypeDescriptor:
        if (Params->Types.Descriptor.InterfaceDescriptor == NULL) {
            status = STATUS_INVALID_PARAMETER;
            DoTraceLevelMessage(
                pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                "InterfaceDescriptor passed in is NULL %!STATUS!", status);
 
        }
        else {
            status = pUsbInterface->SelectSettingByDescriptor(
                PipesAttributes,
                Params->Types.Descriptor.InterfaceDescriptor
                );
        }
        break;
 
    case WdfUsbInterfaceSelectSettingTypeSetting:
        status = pUsbInterface->SelectSettingByIndex(
            PipesAttributes,
            Params->Types.Interface.SettingIndex
            );
        break;
 
    case WdfUsbInterfaceSelectSettingTypeUrb:
        if (Params->Types.Urb.Urb == NULL ||
            Params->Types.Urb.Urb->UrbHeader.Function != URB_FUNCTION_SELECT_INTERFACE ||
            (Params->Types.Urb.Urb->UrbHeader.Length  <
            sizeof(struct _URB_SELECT_INTERFACE) - sizeof(USBD_PIPE_INFORMATION)) ) {
            status = STATUS_INVALID_PARAMETER;
            DoTraceLevelMessage(
                pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                "URB or URB fields passed in are invalid Urb 0x%p  %!STATUS!",
                Params->Types.Urb.Urb, status);
 
        }
        else {
            status = pUsbInterface->SelectSetting(PipesAttributes,
                                                 Params->Types.Urb.Urb);
        }
        break;
 
    default:
        status = STATUS_INVALID_PARAMETER;
        break;
    }