Something went wrong. Try again.
Reactos
Something went wrong. Try again.
C++
at master
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509/*++
Copyright (c) Microsoft Corporation
Module Name:
FxUsbInterfaceAPI.cpp
Abstract:
Author:
Environment:
Both kernel and user mode
Revision History:
--*/#include "fxusbpch.hpp"
extern "C" {#if defined(EVENT_TRACING)#include "FxUsbInterfaceAPI.tmh"#endif}
//// Extern "C" all APIs//extern "C" {
_Must_inspect_result___drv_maxIRQL(PASSIVE_LEVEL)NTSTATUSWDFAPINTAPIWDFEXPORT(WdfUsbInterfaceSelectSetting)( __in PWDF_DRIVER_GLOBALS DriverGlobals, __in WDFUSBINTERFACE UsbInterface, __in_opt PWDF_OBJECT_ATTRIBUTES PipesAttributes, __in PWDF_USB_INTERFACE_SELECT_SETTING_PARAMS Params )/*++
Routine Description: Selects an alternate setting on a given interface number
Arguments: UsbInterface - the interface whose setting will be selected
PipesAttributes - Attributes to apply to each of the new pipes on the setting
Params - Strucutre indicating how to select a new setting
Return Value: NTSTATUS
--*/{ DDI_ENTRY();
PFX_DRIVER_GLOBALS pFxDriverGlobals; FxUsbInterface* pUsbInterface; NTSTATUS status;
FxObjectHandleGetPtrAndGlobals(GetFxDriverGlobals(DriverGlobals), UsbInterface, FX_TYPE_USB_INTERFACE, (PVOID*) &pUsbInterface, &pFxDriverGlobals);
FxPointerNotNull(pFxDriverGlobals, Params);
status = FxVerifierCheckIrqlLevel(pFxDriverGlobals, PASSIVE_LEVEL); if (!NT_SUCCESS(status)) { return status; }
if (Params->Size != sizeof(WDF_USB_INTERFACE_SELECT_SETTING_PARAMS)) { 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; }
status = FxValidateObjectAttributes(pFxDriverGlobals, PipesAttributes, FX_VALIDATE_OPTION_PARENT_NOT_ALLOWED); if (!NT_SUCCESS(status)) { return status; }
#if (FX_CORE_MODE == FX_CORE_USER_MODE) if (Params->Type != WdfUsbInterfaceSelectSettingTypeSetting) { FX_VERIFY_WITH_NAME(INTERNAL, TRAPMSG("UMDF may only select settings by index."), DriverGlobals->DriverName); }#endif
switch (Params->Type) { 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; }
return status;}
__drv_maxIRQL(DISPATCH_LEVEL)BYTEWDFAPINTAPIWDFEXPORT(WdfUsbInterfaceGetInterfaceNumber)( __in PWDF_DRIVER_GLOBALS DriverGlobals, __in WDFUSBINTERFACE UsbInterface )/*++
Routine Description: Returns the interface number of the given interface. The interface number is not necessarily the same as the index of the interface. Once is specified by the device, the other is where it is located within an internal array.
Arguments: UsbInterface - Interace whose number will be returned
Return Value: interface number
--*/{ DDI_ENTRY();
FxUsbInterface * pUsbInterface;
FxObjectHandleGetPtr(GetFxDriverGlobals(DriverGlobals), UsbInterface, FX_TYPE_USB_INTERFACE, (PVOID*) &pUsbInterface);
return pUsbInterface->GetInterfaceNumber();}
__drv_maxIRQL(DISPATCH_LEVEL)BYTEWDFAPINTAPIWDFEXPORT(WdfUsbInterfaceGetNumEndpoints)( __in PWDF_DRIVER_GLOBALS DriverGlobals, __in WDFUSBINTERFACE UsbInterface, __in UCHAR SettingIndex )/*++
Routine Description: Returns the number of endpoints (not configured) for a given setting on the given interface.
Arguments: UsbInterface - interface whose number of endpoints will be returned
SettingsIndex - the index into the alternate setting array
Return Value: Number of endpoints
--*/{ DDI_ENTRY();
FxUsbInterface * pUsbInterface;
FxObjectHandleGetPtr(GetFxDriverGlobals(DriverGlobals), UsbInterface, FX_TYPE_USB_INTERFACE , (PVOID*) &pUsbInterface);
return pUsbInterface->GetNumEndpoints(SettingIndex);}
__drv_maxIRQL(DISPATCH_LEVEL)VOIDWDFAPINTAPIWDFEXPORT(WdfUsbInterfaceGetEndpointInformation)( __in PWDF_DRIVER_GLOBALS DriverGlobals, __in WDFUSBINTERFACE UsbInterface, __in UCHAR SettingIndex, __in UCHAR EndpointIndex, __out PWDF_USB_PIPE_INFORMATION EndpointInfo )/*++
Routine Description: Returns information on a given endpoint (unconfigured) for an interface + alternate setting index.
Arguments: UsbInterface - interface which contains the endpoint
SettingIndex - alternate setting index
EndpointIndex - index into the endpoint array contained by interface+setting
EndpointInfo - structure to be filled in with the info of the endpoint
Return Value: None
--*/{ DDI_ENTRY();
PFX_DRIVER_GLOBALS pFxDriverGlobals; FxUsbInterface * pUsbInterface;
FxObjectHandleGetPtrAndGlobals(GetFxDriverGlobals(DriverGlobals), UsbInterface, FX_TYPE_USB_INTERFACE, (PVOID*) &pUsbInterface, &pFxDriverGlobals);
FxPointerNotNull(pFxDriverGlobals, EndpointInfo);
if (EndpointInfo->Size != sizeof(WDF_USB_PIPE_INFORMATION)) { 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; }
pUsbInterface->GetEndpointInformation(SettingIndex, EndpointIndex, EndpointInfo);}
__drv_maxIRQL(DISPATCH_LEVEL)BYTENTAPIWDFEXPORT(WdfUsbInterfaceGetNumSettings)( __in PWDF_DRIVER_GLOBALS DriverGlobals, __in WDFUSBINTERFACE UsbInterface )/*++
Routine Description: Returns the number of settings available on an interface.
Arguments: UsbInterface - the usb interface being queried
Return Value: Number of settings as described by the config descriptor
--*/{ DDI_ENTRY();
FxUsbInterface * pUsbInterface;
FxObjectHandleGetPtr(GetFxDriverGlobals(DriverGlobals), UsbInterface, FX_TYPE_USB_INTERFACE, (PVOID*) &pUsbInterface);
return pUsbInterface->GetNumSettings();}
__drv_maxIRQL(DISPATCH_LEVEL)VOIDWDFAPINTAPIWDFEXPORT(WdfUsbInterfaceGetDescriptor)( __in PWDF_DRIVER_GLOBALS DriverGlobals, __in WDFUSBINTERFACE UsbInterface, __in UCHAR SettingIndex, __out PUSB_INTERFACE_DESCRIPTOR InterfaceDescriptor )/*++
Routine Description: Returns the underlying USB interface descriptor for the given WDF handle
Arguments: UsbInterface - interface whose descriptor will be returned
SettingIndex - alternatve setting whose interface should be returned
InterfaceDescriptor - Pointer which will receive the descriptor
--*/{ DDI_ENTRY();
PFX_DRIVER_GLOBALS pFxDriverGlobals; FxUsbInterface * pUsbInterface;
FxObjectHandleGetPtrAndGlobals(GetFxDriverGlobals(DriverGlobals), UsbInterface, FX_TYPE_USB_INTERFACE, (PVOID*) &pUsbInterface, &pFxDriverGlobals);
FxPointerNotNull(pFxDriverGlobals, InterfaceDescriptor);
pUsbInterface->GetDescriptor(InterfaceDescriptor, SettingIndex);}
__drv_maxIRQL(DISPATCH_LEVEL)BYTEWDFAPINTAPIWDFEXPORT(WdfUsbInterfaceGetConfiguredSettingIndex)( __in PWDF_DRIVER_GLOBALS DriverGlobals, __in WDFUSBINTERFACE UsbInterface )/*++
Routine Description: Returns the alternate setting index which is currently configured
Arguments: UsbInterface - interfase whose configured setting is being queried
Return Value: The current setting or 0 on failure
--*/{ DDI_ENTRY();
FxUsbInterface * pUsbInterface;
FxObjectHandleGetPtr(GetFxDriverGlobals(DriverGlobals), UsbInterface, FX_TYPE_USB_INTERFACE , (PVOID*) &pUsbInterface);
return pUsbInterface->GetConfiguredSettingIndex();}
__drv_maxIRQL(DISPATCH_LEVEL)BYTEWDFAPINTAPIWDFEXPORT(WdfUsbInterfaceGetNumConfiguredPipes)( __in PWDF_DRIVER_GLOBALS DriverGlobals, __in WDFUSBINTERFACE UsbInterface )/*++
Routine Description: Returns the number of configured pipes on a given interface.
Arguments: UsbInterface - the configured interface
Return Value: Number of configured pipes or 0 on error
--*/{ DDI_ENTRY();
FxUsbInterface * pUsbInterface;
FxObjectHandleGetPtr(GetFxDriverGlobals(DriverGlobals), UsbInterface, FX_TYPE_USB_INTERFACE , (PVOID*) &pUsbInterface);
return pUsbInterface->GetNumConfiguredPipes();}
__drv_maxIRQL(DISPATCH_LEVEL)WDFUSBPIPEWDFAPINTAPIWDFEXPORT(WdfUsbInterfaceGetConfiguredPipe)( __in PWDF_DRIVER_GLOBALS DriverGlobals, __in WDFUSBINTERFACE UsbInterface, __in UCHAR PipeIndex, __out_opt PWDF_USB_PIPE_INFORMATION PipeInfo )/*++
Routine Description: Returns the WDFUSBPIPE handle for the configured interface + pipe index. Optionally, information about the pipe is also returned.
Arguments: UsbInterface - configured interface
PipeIndex - index into the number of pipes on the interface
PipeInfo - information to be returned on the pipe
Return Value: valid WDFUSBPIPE or NULL on error
--*/{ DDI_ENTRY();
PFX_DRIVER_GLOBALS pFxDriverGlobals; FxUsbInterface * pUsbInterface; NTSTATUS status;
FxObjectHandleGetPtrAndGlobals(GetFxDriverGlobals(DriverGlobals), UsbInterface, FX_TYPE_USB_INTERFACE, (PVOID*) &pUsbInterface, &pFxDriverGlobals);
if (PipeInfo != NULL && PipeInfo->Size != sizeof(WDF_USB_PIPE_INFORMATION)) { 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; }
return pUsbInterface->GetConfiguredPipe(PipeIndex, PipeInfo);}
} // extern "C"