Something went wrong. Try again.
Reactos
Something went wrong. Try again.
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448/*++
Copyright (c) Microsoft Corporation
Module Name:
FxUsbDeviceAPI.cpp
Abstract:
Author:
Environment:
Both kernel and user mode
Revision History:
--*/
#include "fxusbpch.hpp"
extern "C" {#if defined(EVENT_TRACING)#include "FxUsbDeviceAPI.tmh"#endif}
//// Extern "C" all APIs//extern "C" {
_Must_inspect_result___drv_maxIRQL(PASSIVE_LEVEL)NTSTATUSWDFAPIFxUsbTargetDeviceCreate( __in PFX_DRIVER_GLOBALS FxDriverGlobals, __in FxDeviceBase* Device, __in ULONG USBDClientContractVersion, __in_opt PWDF_OBJECT_ATTRIBUTES Attributes, __out WDFUSBDEVICE* UsbDevice )/*++
Routine Description: Creates a WDFUSBDEVICE handle for the client.
Arguments:
Device - FxDeviceBase object
USBDClientContractVersion - The USBD Client Contract version of the client driver
UsbDevice - Pointer which will receive the created handle
Return Value: STATUS_SUCCESS - success STATUS_INSUFFICIENT_RESOURCES - no memory available ...
--*/{ FxUsbDevice* pUsbDevice; NTSTATUS status;
// // Basic parameter validation //
FxPointerNotNull(FxDriverGlobals, UsbDevice); *UsbDevice = NULL;
status = FxVerifierCheckIrqlLevel(FxDriverGlobals, PASSIVE_LEVEL); if (!NT_SUCCESS(status)) { return status; }
status = FxValidateObjectAttributes(FxDriverGlobals, Attributes, FX_VALIDATE_OPTION_PARENT_NOT_ALLOWED); if (!NT_SUCCESS(status)) { return status; }
pUsbDevice = new(FxDriverGlobals, Attributes) FxUsbDevice(FxDriverGlobals); if (pUsbDevice == NULL) { return STATUS_INSUFFICIENT_RESOURCES; }
// // Perform all init and handle creation functions. Check for error at the // end and clean up there. // status = pUsbDevice->Init(Device);
if (NT_SUCCESS(status)) { WDFOBJECT device;
device = NULL;
status = pUsbDevice->InitDevice(USBDClientContractVersion);
if (NT_SUCCESS(status)) { status = pUsbDevice->CreateInterfaces(); }
if (NT_SUCCESS(status)) { status = Device->AddIoTarget(pUsbDevice); }
if (NT_SUCCESS(status)) { status = pUsbDevice->Commit(Attributes, &device, Device); }
if (NT_SUCCESS(status)) { *UsbDevice = (WDFUSBDEVICE) device; } }
if (!NT_SUCCESS(status)) { // // And now free it // pUsbDevice->DeleteFromFailedCreate(); }
return status;}
_Must_inspect_result___drv_maxIRQL(PASSIVE_LEVEL)NTSTATUSWDFAPINTAPIWDFEXPORT(WdfUsbTargetDeviceCreate)( __in PWDF_DRIVER_GLOBALS DriverGlobals, __in WDFDEVICE Device, __in_opt PWDF_OBJECT_ATTRIBUTES Attributes, __out WDFUSBDEVICE* UsbDevice )/*++
Routine Description: Creates a WDFUSBDEVICE handle for the client.
Arguments: Device - WDFDEVICE handle to which we are attaching the WDFUSBDEVICE handle to PUsbDevice - Pointer which will receive the created handle
Return Value: STATUS_SUCCESS - success STATUS_INSUFFICIENT_RESOURCES - no memory available ...
--*/{ DDI_ENTRY();
PFX_DRIVER_GLOBALS pFxDriverGlobals; FxDeviceBase* pDevice;
FxObjectHandleGetPtrAndGlobals(GetFxDriverGlobals(DriverGlobals), Device, FX_TYPE_DEVICE_BASE, (PVOID*)&pDevice, &pFxDriverGlobals);
return FxUsbTargetDeviceCreate(pFxDriverGlobals, pDevice, USBD_CLIENT_CONTRACT_VERSION_INVALID, Attributes, UsbDevice);}
__checkReturn__drv_maxIRQL(PASSIVE_LEVEL)NTSTATUSWDFAPINTAPIWDFEXPORT(WdfUsbTargetDeviceCreateWithParameters)( __in PWDF_DRIVER_GLOBALS DriverGlobals, __in WDFDEVICE Device, __in PWDF_USB_DEVICE_CREATE_CONFIG Config, __in_opt PWDF_OBJECT_ATTRIBUTES Attributes, __out WDFUSBDEVICE* UsbDevice )/*++
Routine Description: Creates a WDFUSBDEVICE handle for the client.
Arguments: Device - WDFDEVICE handle to which we are attaching the WDFUSBDEVICE handle to PUsbDevice - Pointer which will receive the created handle
Return Value: STATUS_SUCCESS - success STATUS_INSUFFICIENT_RESOURCES - no memory available ...
--*/{ DDI_ENTRY();
PFX_DRIVER_GLOBALS pFxDriverGlobals; FxDeviceBase* pDevice; NTSTATUS status;
FxObjectHandleGetPtrAndGlobals(GetFxDriverGlobals(DriverGlobals), Device, FX_TYPE_DEVICE_BASE, (PVOID*)&pDevice, &pFxDriverGlobals);
FxPointerNotNull(pFxDriverGlobals, Config);
if (Config->Size != sizeof(WDF_USB_DEVICE_CREATE_CONFIG)) { status = STATUS_INFO_LENGTH_MISMATCH;
DoTraceLevelMessage( pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET, "WDF_USB_DEVICE_CREATE_CONFIG Size 0x%x, expected 0x%x, %!STATUS!", Config->Size, sizeof(WDF_USB_DEVICE_CREATE_CONFIG), status);
return status; }
return FxUsbTargetDeviceCreate(pFxDriverGlobals, pDevice, Config->USBDClientContractVersion, Attributes, UsbDevice);}
_Must_inspect_result___drv_maxIRQL(DISPATCH_LEVEL)NTSTATUSWDFAPINTAPIWDFEXPORT(WdfUsbTargetDeviceRetrieveInformation)( __in PWDF_DRIVER_GLOBALS DriverGlobals, __in WDFUSBDEVICE UsbDevice, __out PWDF_USB_DEVICE_INFORMATION Information ){ DDI_ENTRY();
PFX_DRIVER_GLOBALS pFxDriverGlobals; FxUsbDevice* pUsbDevice; NTSTATUS status;
FxObjectHandleGetPtrAndGlobals(GetFxDriverGlobals(DriverGlobals), UsbDevice, FX_TYPE_IO_TARGET_USB_DEVICE, (PVOID*) &pUsbDevice, &pFxDriverGlobals);
FxPointerNotNull(pFxDriverGlobals, Information);
if (Information->Size != sizeof(WDF_USB_DEVICE_INFORMATION)) { status = STATUS_INFO_LENGTH_MISMATCH; DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET, "Information size %d, expected %d %!STATUS!", Information->Size, sizeof(WDF_USB_DEVICE_INFORMATION), status); return status; }
pUsbDevice->GetInformation(Information);
return STATUS_SUCCESS;}
__drv_maxIRQL(PASSIVE_LEVEL)VOIDWDFAPINTAPIWDFEXPORT(WdfUsbTargetDeviceGetDeviceDescriptor)( __in PWDF_DRIVER_GLOBALS DriverGlobals, __in WDFUSBDEVICE UsbDevice, __out PUSB_DEVICE_DESCRIPTOR UsbDeviceDescriptor ){ DDI_ENTRY();
PFX_DRIVER_GLOBALS pFxDriverGlobals; FxUsbDevice* pUsbDevice; NTSTATUS status;
FxObjectHandleGetPtrAndGlobals(GetFxDriverGlobals(DriverGlobals), UsbDevice, FX_TYPE_IO_TARGET_USB_DEVICE, (PVOID*) &pUsbDevice, &pFxDriverGlobals);
FxPointerNotNull(pFxDriverGlobals, UsbDeviceDescriptor);
status = FxVerifierCheckIrqlLevel(pFxDriverGlobals, PASSIVE_LEVEL); if (!NT_SUCCESS(status)) { return; }
pUsbDevice->CopyDeviceDescriptor(UsbDeviceDescriptor);}
_Must_inspect_result___drv_maxIRQL(PASSIVE_LEVEL)NTSTATUSWDFAPINTAPIWDFEXPORT(WdfUsbTargetDeviceRetrieveConfigDescriptor)( __in PWDF_DRIVER_GLOBALS DriverGlobals, __in WDFUSBDEVICE UsbDevice, __out_bcount_part_opt(*ConfigDescriptorLength, *ConfigDescriptorLength) PVOID ConfigDescriptor, __inout PUSHORT ConfigDescriptorLength ){ DDI_ENTRY();
PFX_DRIVER_GLOBALS pFxDriverGlobals; FxUsbDevice* pUsbDevice; NTSTATUS status;
FxObjectHandleGetPtrAndGlobals(GetFxDriverGlobals(DriverGlobals), UsbDevice, FX_TYPE_IO_TARGET_USB_DEVICE, (PVOID*) &pUsbDevice, &pFxDriverGlobals);
FxPointerNotNull(pFxDriverGlobals, ConfigDescriptorLength);
status = FxVerifierCheckIrqlLevel(pFxDriverGlobals, PASSIVE_LEVEL); if (!NT_SUCCESS(status)) { return status; }
return pUsbDevice->GetConfigDescriptor(ConfigDescriptor, ConfigDescriptorLength);}
_Must_inspect_result___drv_maxIRQL(PASSIVE_LEVEL)NTSTATUSWDFAPINTAPIWDFEXPORT(WdfUsbTargetDeviceQueryString)( __in PWDF_DRIVER_GLOBALS DriverGlobals, __in WDFUSBDEVICE UsbDevice, __in_opt WDFREQUEST Request, __in_opt PWDF_REQUEST_SEND_OPTIONS RequestOptions, __out_ecount_opt(*NumCharacters) PUSHORT String, __inout PUSHORT NumCharacters, __in UCHAR StringIndex, __in_opt USHORT LangID ){ DDI_ENTRY();
PFX_DRIVER_GLOBALS pFxDriverGlobals; FxUsbDevice* pUsbDevice; NTSTATUS status;
FxObjectHandleGetPtrAndGlobals(GetFxDriverGlobals(DriverGlobals), UsbDevice, FX_TYPE_IO_TARGET_USB_DEVICE, (PVOID*) &pUsbDevice, &pFxDriverGlobals);
FxPointerNotNull(pFxDriverGlobals, NumCharacters);
status = FxVerifierCheckIrqlLevel(pFxDriverGlobals, PASSIVE_LEVEL); if (!NT_SUCCESS(status)) { return status; }
status = FxValidateRequestOptions(pFxDriverGlobals, RequestOptions); if (!NT_SUCCESS(status)) { return status; }
status = pUsbDevice->GetString(String, NumCharacters, StringIndex, LangID, Request, RequestOptions);
return status;}
_Must_inspect_result___drv_maxIRQL(PASSIVE_LEVEL)NTSTATUSWDFAPINTAPIWDFEXPORT(WdfUsbTargetDeviceAllocAndQueryString)( __in PWDF_DRIVER_GLOBALS DriverGlobals, __in WDFUSBDEVICE UsbDevice, __in_opt PWDF_OBJECT_ATTRIBUTES StringMemoryAttributes, __out WDFMEMORY* StringMemory, __out_opt PUSHORT NumCharacters, __in UCHAR StringIndex, __in_opt USHORT LangID ){ DDI_ENTRY();
PFX_DRIVER_GLOBALS pFxDriverGlobals; WDFMEMORY hMemory; FxUsbDevice* pUsbDevice; NTSTATUS status; USHORT numChars = 0;
FxObjectHandleGetPtrAndGlobals(GetFxDriverGlobals(DriverGlobals), UsbDevice, FX_TYPE_IO_TARGET_USB_DEVICE, (PVOID*) &pUsbDevice, &pFxDriverGlobals);
FxPointerNotNull(pFxDriverGlobals, StringMemory);
*StringMemory = NULL; if (NumCharacters != NULL) { *NumCharacters = 0; }
status = FxVerifierCheckIrqlLevel(pFxDriverGlobals, PASSIVE_LEVEL); if (!NT_SUCCESS(status)) { return status; }
status = FxValidateObjectAttributes(pFxDriverGlobals, StringMemoryAttributes); if (!NT_SUCCESS(status)) { return status; }
status = pUsbDevice->GetString(NULL, &numChars, StringIndex, LangID);
if (NT_SUCCESS(status) && numChars > 0) { FxMemoryObject* pBuffer;
status = FxMemoryObject::_Create(pFxDriverGlobals, StringMemoryAttributes, NonPagedPool, pFxDriverGlobals->Tag, numChars * sizeof(WCHAR), &pBuffer);
if (!NT_SUCCESS(status)) { return STATUS_INSUFFICIENT_RESOURCES; }
status = pBuffer->Commit(StringMemoryAttributes, (WDFOBJECT*)&hMemory);
if (NT_SUCCESS(status)) { status = pUsbDevice->GetString((PUSHORT) pBuffer->GetBuffer(), &numChars, StringIndex, LangID);
if (NT_SUCCESS(status)) { if (NumCharacters != NULL) { *NumCharacters = numChars; } *StringMemory = hMemory; } }
if (!NT_SUCCESS(status)) { // // There can only be one context on this object right now, // so just clear out the one. // pBuffer->DeleteFromFailedCreate(); } }
return status;}
_Must_inspect_result___drv_maxIRQL(DISPATCH_LEVEL)NTSTATUSNTAPIWDFEXPORT(WdfUsbTargetDeviceFormatRequestForString)( __in PWDF_DRIVER_GLOBALS DriverGlobals, __in WDFUSBDEVICE UsbDevice, __in WDFREQUEST Request, __in WDFMEMORY Memory, __in_opt PWDFMEMORY_OFFSET Offset, __in UCHAR StringIndex, __in_opt USHORT LangID )/*++
Routine Description: Formats a request so that it can be used to query for a string from the device.
Arguments: UsbDevice - device to be queried
Request - request to format
Memory - memory to write the string into
Return Value:
--*/
{ DDI_ENTRY();
PFX_DRIVER_GLOBALS pFxDriverGlobals; IFxMemory* pMemory; FxUsbDevice* pUsbDevice; FxRequestBuffer buf; FxRequest* pRequest; NTSTATUS status; size_t bufferSize;
FxObjectHandleGetPtrAndGlobals(GetFxDriverGlobals(DriverGlobals), UsbDevice, FX_TYPE_IO_TARGET_USB_DEVICE, (PVOID*) &pUsbDevice, &pFxDriverGlobals);
DoTraceLevelMessage( pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET, "WDFUSBDEVICE %p, WDFREQUEST %p, WDFMEMORY %p, StringIndex %d, LandID 0x%x", UsbDevice, Request, Memory, StringIndex, LangID);
FxObjectHandleGetPtr(pFxDriverGlobals, Memory, IFX_TYPE_MEMORY, (PVOID*) &pMemory);
FxObjectHandleGetPtr(pFxDriverGlobals, Request, FX_TYPE_REQUEST, (PVOID*) &pRequest);
status = pMemory->ValidateMemoryOffsets(Offset); if (!NT_SUCCESS(status)) { return status; }
buf.SetMemory(pMemory, Offset);
bufferSize = buf.GetBufferLength();
// // the string descriptor is array of WCHARs so the buffer being used must be // of an integral number of them. // if ((bufferSize % sizeof(WCHAR)) != 0) { status = STATUS_INVALID_PARAMETER;
DoTraceLevelMessage( pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET, "WDFMEMORY %p length must be even number of WCHARs, but is %I64d in " "length, %!STATUS!", Memory, bufferSize, status);
return status; }
// // While the length in the descriptor (bLength) is a byte, so the requested // buffer cannot be bigger then that, do not check the bufferSize < 0xFF. // We don't check because the driver can be using the WDFMEMORY as a part // of a larger structure. //
// // Format the request // status = pUsbDevice->FormatStringRequest(pRequest, &buf, StringIndex, LangID);
if (NT_SUCCESS(status)) { FxUsbDeviceStringContext* pContext;
pContext = (FxUsbDeviceStringContext*) pRequest->GetContext(); pContext->m_UsbParameters.Parameters.DeviceString.Buffer = Memory; pContext->m_UsbParameters.Parameters.DeviceString.StringIndex = StringIndex; pContext->m_UsbParameters.Parameters.DeviceString.LangID = LangID; }
DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET, "WDFUSBDEVICE %p, WDFREQUEST %p, WDFMEMORY %p, %!STATUS!", UsbDevice, Request, Memory, status);
return status;}
_Must_inspect_result___drv_maxIRQL(PASSIVE_LEVEL)NTSTATUSWDFAPINTAPIWDFEXPORT(WdfUsbTargetDeviceSelectConfig)( __in PWDF_DRIVER_GLOBALS DriverGlobals, __in WDFUSBDEVICE UsbDevice, __in_opt PWDF_OBJECT_ATTRIBUTES PipesAttributes, __inout PWDF_USB_DEVICE_SELECT_CONFIG_PARAMS Params ){ DDI_ENTRY();
PFX_DRIVER_GLOBALS pFxDriverGlobals; FxUsbDevice* pUsbDevice; NTSTATUS status;
FxObjectHandleGetPtrAndGlobals(GetFxDriverGlobals(DriverGlobals), UsbDevice, FX_TYPE_IO_TARGET_USB_DEVICE, (PVOID*) &pUsbDevice, &pFxDriverGlobals);
FxPointerNotNull(pFxDriverGlobals, Params);
status = FxVerifierCheckIrqlLevel(pFxDriverGlobals, PASSIVE_LEVEL); if (!NT_SUCCESS(status)) { return status; }
if (Params->Size != sizeof(WDF_USB_DEVICE_SELECT_CONFIG_PARAMS)) { status = STATUS_INFO_LENGTH_MISMATCH; DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET, "Params size %d, expected %d %!STATUS!", Params->Size, sizeof(WDF_USB_DEVICE_SELECT_CONFIG_PARAMS), status); return status; }
// // Sanity check the Type value as well to be in range. // if (Params->Type < WdfUsbTargetDeviceSelectConfigTypeDeconfig || Params->Type > WdfUsbTargetDeviceSelectConfigTypeUrb) {
status = STATUS_INVALID_PARAMETER;
DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET, "Params Type %d not a valid value, %!STATUS!", Params->Size, status);
return status; }
#if (FX_CORE_MODE == FX_CORE_USER_MODE) if ((Params->Type == WdfUsbTargetDeviceSelectConfigTypeDeconfig) || (Params->Type == WdfUsbTargetDeviceSelectConfigTypeUrb) || (Params->Type == WdfUsbTargetDeviceSelectConfigTypeInterfacesDescriptor)) { status = STATUS_NOT_SUPPORTED;
DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET, "Params Type %d not supported for UMDF, %!STATUS!", Params->Type, status);
return status;
}#endif
status = FxValidateObjectAttributes(pFxDriverGlobals, PipesAttributes, FX_VALIDATE_OPTION_PARENT_NOT_ALLOWED); if (!NT_SUCCESS(status)) { return status; }
if (pUsbDevice->HasMismatchedInterfacesInConfigDescriptor()) { // // Config descriptor reported zero interfaces, but we found an // interface descriptor in it. // status = STATUS_INVALID_DEVICE_REQUEST;
DoTraceLevelMessage( pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET, "WDFUSBDEVICE %p number of interfaces found in the config descriptor " "does not match bNumInterfaces in config descriptor, failing config " "operation %!WdfUsbTargetDeviceSelectConfigType!, %!STATUS!", UsbDevice, Params->Type, status);
return status; } else if (pUsbDevice->GetNumInterfaces() == 0) { // // Special case the zero interface case and exit early // status = STATUS_SUCCESS;
DoTraceLevelMessage( pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET, "WDFUSBDEVICE %p succeeding config operation " "%!WdfUsbTargetDeviceSelectConfigType! on zero interfaces " "immediately, %!STATUS!", UsbDevice, Params->Type, status);
return status; }
switch (Params->Type) {
#if (FX_CORE_MODE == FX_CORE_KERNEL_MODE)
case WdfUsbTargetDeviceSelectConfigTypeDeconfig: status = pUsbDevice->Deconfig(); break;
case WdfUsbTargetDeviceSelectConfigTypeInterfacesDescriptor: if (Params->Types.Descriptor.InterfaceDescriptors == NULL || Params->Types.Descriptor.NumInterfaceDescriptors == 0) { status = STATUS_INVALID_PARAMETER; DoTraceLevelMessage( pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET, "Either InterfaceDescriptor is NULL or NumInterfaceDescriptors is zero " "WDFUSBDEVICE %p InterfaceDescriptor %p NumInterfaceDescriptors 0x%x" "%!WdfUsbTargetDeviceSelectConfigType! %!STATUS!", UsbDevice, Params->Types.Descriptor.InterfaceDescriptors, Params->Types.Descriptor.NumInterfaceDescriptors, Params->Type, status);
} else { status = pUsbDevice->SelectConfigDescriptor( PipesAttributes, Params); } break;
case WdfUsbTargetDeviceSelectConfigTypeUrb: // // Since the USBD macro's dont include the USBD_PIPE_INFORMATION for 0 EP's, // make the length check to use // sizeof(struct _URB_SELECT_CONFIGURATION) - sizeof(USBD_PIPE_INFORMATION) // if (Params->Types.Urb.Urb == NULL || Params->Types.Urb.Urb->UrbHeader.Function != URB_FUNCTION_SELECT_CONFIGURATION || Params->Types.Urb.Urb->UrbHeader.Length < (sizeof(struct _URB_SELECT_CONFIGURATION) - sizeof(USBD_PIPE_INFORMATION))) { status = STATUS_INVALID_PARAMETER; DoTraceLevelMessage( pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET, "Either URB passed in was NULL or the URB Function or Length was invalid " " WDFUSBDEVICE %p Urb 0x%p " "%!WdfUsbTargetDeviceSelectConfigType!" " %!STATUS!", UsbDevice, Params->Types.Urb.Urb, Params->Type, status);
} else { status = pUsbDevice->SelectConfig( PipesAttributes, Params->Types.Urb.Urb, FxUrbTypeLegacy, NULL); } break;
#endif
case WdfUsbTargetDeviceSelectConfigTypeInterfacesPairs: if (Params->Types.MultiInterface.Pairs == NULL) { status = STATUS_INVALID_PARAMETER;
DoTraceLevelMessage( pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET, "WDFUSBDEVICE %p SettingPairs Array passed is NULL, %!STATUS!", pUsbDevice->GetHandle(),status);
break; } else if (Params->Types.MultiInterface.NumberInterfaces != pUsbDevice->GetNumInterfaces()) { status = STATUS_INVALID_PARAMETER;
DoTraceLevelMessage( pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET, "WDFUSBDEVICE %p MultiInterface.NumberInterfaces %d != %d " "(reported num interfaces), %!STATUS!", pUsbDevice->GetHandle(), Params->Types.MultiInterface.NumberInterfaces, pUsbDevice->GetNumInterfaces(), status);
break; }
// || || Fall through || || // \/ \/ \/ \/ case WdfUsbTargetDeviceSelectConfigTypeMultiInterface:
// // Validate SettingIndexes passed-in // for (ULONG i = 0; i < Params->Types.MultiInterface.NumberInterfaces; i++) {
PWDF_USB_INTERFACE_SETTING_PAIR pair; FxUsbInterface * pUsbInterface; UCHAR numSettings;
pair = &(Params->Types.MultiInterface.Pairs[i]);
FxObjectHandleGetPtr(GetFxDriverGlobals(DriverGlobals), pair->UsbInterface, FX_TYPE_USB_INTERFACE, (PVOID*) &pUsbInterface);
numSettings = pUsbInterface->GetNumSettings();
if (pair->SettingIndex >= numSettings) { status = STATUS_INVALID_PARAMETER;
DoTraceLevelMessage( pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET, "WDFUSBDEVICE %p SettingPairs contains invalid SettingIndex" " for WDFUSBINTERFACE %p. Setting index passed in: %d, " "max index: %d, returning %!STATUS!", pUsbDevice->GetHandle(), pair->UsbInterface, pair->SettingIndex, pUsbInterface->GetNumSettings() - 1, status);
return status; } }
status = pUsbDevice->SelectConfigMulti( PipesAttributes, Params); break;
case WdfUsbTargetDeviceSelectConfigTypeSingleInterface: status = pUsbDevice->SelectConfigSingle( //vm changed name from SelectConfigAuto PipesAttributes, Params); break;
default: status = STATUS_INVALID_PARAMETER; }
return status;}
__drv_maxIRQL(DISPATCH_LEVEL)UCHARWDFAPINTAPIWDFEXPORT(WdfUsbTargetDeviceGetNumInterfaces)( __in PWDF_DRIVER_GLOBALS DriverGlobals, __in WDFUSBDEVICE UsbDevice ){ DDI_ENTRY();
FxUsbDevice* pUsbDevice;
FxObjectHandleGetPtr(GetFxDriverGlobals(DriverGlobals), UsbDevice, FX_TYPE_IO_TARGET_USB_DEVICE, (PVOID*) &pUsbDevice);
return pUsbDevice->GetNumInterfaces();}
__drv_maxIRQL(DISPATCH_LEVEL)USBD_CONFIGURATION_HANDLEWDFAPINTAPIWDFEXPORT(WdfUsbTargetDeviceWdmGetConfigurationHandle)( __in PWDF_DRIVER_GLOBALS DriverGlobals, __in WDFUSBDEVICE UsbDevice ){ DDI_ENTRY();
FxUsbDevice* pUsbDevice;
FxObjectHandleGetPtr(GetFxDriverGlobals(DriverGlobals), UsbDevice, FX_TYPE_IO_TARGET_USB_DEVICE, (PVOID*) &pUsbDevice);
return pUsbDevice->GetConfigHandle();}
_Must_inspect_result___drv_maxIRQL(PASSIVE_LEVEL)NTSTATUSNTAPIWDFEXPORT(WdfUsbTargetDeviceSendControlTransferSynchronously)( __in PWDF_DRIVER_GLOBALS DriverGlobals, __in WDFUSBDEVICE UsbDevice, __in_opt WDFREQUEST Request, __in_opt PWDF_REQUEST_SEND_OPTIONS RequestOptions, __in PWDF_USB_CONTROL_SETUP_PACKET SetupPacket, __in_opt PWDF_MEMORY_DESCRIPTOR MemoryDescriptor, __out_opt PULONG BytesTransferred )/*++
Routine Description: Synchronously sends a control transfer to the default control pipe on the device.
Arguments: UsbDevice - the target representing the device
Request - Request whose PIRP to use
RequestOptions - options to use when sending the request
SetupPacket - control setup packet to be used in the transfer
MemoryDescriptor - memory to use in the transfer after the setup packet
BytesTransferred - number of bytes sent to or by the device
Return Value: NTSTATUS
--*/{ DDI_ENTRY();
PFX_DRIVER_GLOBALS pFxDriverGlobals; FxUsbDevice* pUsbDevice; NTSTATUS status; FxRequestBuffer buf;
FxObjectHandleGetPtrAndGlobals(GetFxDriverGlobals(DriverGlobals), UsbDevice, FX_TYPE_IO_TARGET_USB_DEVICE, (PVOID*) &pUsbDevice, &pFxDriverGlobals);
FxUsbDeviceControlContext context(FxUrbTypeLegacy);
FxSyncRequest request(pFxDriverGlobals, &context, Request);
// // FxSyncRequest always succeesds for KM but can fail for UM. // status = request.Initialize(); if (!NT_SUCCESS(status)) { DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET, "Failed to initialize FxSyncRequest"); return status; }
DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET, "WDFUSBDEVICE %p control transfer sync", UsbDevice);
FxPointerNotNull(pFxDriverGlobals, SetupPacket);
status = FxVerifierCheckIrqlLevel(pFxDriverGlobals, PASSIVE_LEVEL); if (!NT_SUCCESS(status)) { return status; }
status = FxValidateRequestOptions(pFxDriverGlobals, RequestOptions); if (!NT_SUCCESS(status)) { return status; }
status = buf.ValidateMemoryDescriptor( pFxDriverGlobals, MemoryDescriptor, MemoryDescriptorNullAllowed | MemoryDescriptorNoBufferAllowed );
if (!NT_SUCCESS(status)) { return status; }
status = pUsbDevice->FormatControlRequest(request.m_TrueRequest, SetupPacket, &buf);
if (NT_SUCCESS(status)) { DoTraceLevelMessage( pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET, "WDFUSBDEVICE %p, WDFREQUEST %p being submitted", UsbDevice, request.m_TrueRequest->GetTraceObjectHandle());
status = pUsbDevice->SubmitSync(request.m_TrueRequest, RequestOptions);
if (BytesTransferred != NULL) { if (NT_SUCCESS(status)) {#if (FX_CORE_MODE == FX_CORE_KERNEL_MODE) *BytesTransferred = context.m_Urb->TransferBufferLength;#elif (FX_CORE_MODE == FX_CORE_USER_MODE) *BytesTransferred = context.m_UmUrb.UmUrbControlTransfer.TransferBufferLength;#endif } else { *BytesTransferred = 0; } } }
DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET, "WDFUSBDEVICE %p, %!STATUS!", UsbDevice, status);
return status;}
_Must_inspect_result___drv_maxIRQL(DISPATCH_LEVEL)NTSTATUSNTAPIWDFEXPORT(WdfUsbTargetDeviceFormatRequestForControlTransfer)( __in PWDF_DRIVER_GLOBALS DriverGlobals, __in WDFUSBDEVICE UsbDevice, __in WDFREQUEST Request, __in PWDF_USB_CONTROL_SETUP_PACKET SetupPacket, __in_opt WDFMEMORY TransferMemory, __in_opt PWDFMEMORY_OFFSET TransferOffset )/*++
Routine Description: Formats a request so that a control transfer can be sent to the device after this call returns successfully.
Arguments: UsbDevice - the target representing the device
Request - Request to format
SetupPacket - control setup packet to be used in the transfer
TransferMemory - memory to use in the transfer after the setup packet
TransferOffset - offset into TransferMemory and size override for transfer length
Return Value: NTSTATUS
--*/{ DDI_ENTRY();
PFX_DRIVER_GLOBALS pFxDriverGlobals; IFxMemory* pMemory; FxUsbDevice* pUsbDevice; FxRequestBuffer buf; FxRequest* pRequest; NTSTATUS status;
FxObjectHandleGetPtrAndGlobals(GetFxDriverGlobals(DriverGlobals), UsbDevice, FX_TYPE_IO_TARGET_USB_DEVICE, (PVOID*) &pUsbDevice, &pFxDriverGlobals);
DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET, "WDFUSBDEVICE %p, WDFREQUEST %p, WDFMEMORY %p", UsbDevice, Request, TransferMemory);
FxPointerNotNull(pFxDriverGlobals, SetupPacket);
if (TransferMemory != NULL) { FxObjectHandleGetPtr(pFxDriverGlobals, TransferMemory, IFX_TYPE_MEMORY, (PVOID*) &pMemory);
status = pMemory->ValidateMemoryOffsets(TransferOffset); if (!NT_SUCCESS(status)) { return status; }
buf.SetMemory(pMemory, TransferOffset); } else { pMemory = NULL; }
FxObjectHandleGetPtr(pFxDriverGlobals, Request, FX_TYPE_REQUEST, (PVOID*) &pRequest);
status = pUsbDevice->FormatControlRequest(pRequest, SetupPacket, &buf);
if (NT_SUCCESS(status)) { FxUsbDeviceControlContext* pContext;
pContext = (FxUsbDeviceControlContext*) pRequest->GetContext();
RtlCopyMemory( &pContext->m_UsbParameters.Parameters.DeviceControlTransfer.SetupPacket, SetupPacket, sizeof(*SetupPacket) );
if (pMemory != NULL) { pContext->m_UsbParameters.Parameters.DeviceControlTransfer.Buffer = TransferMemory; } }
DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET, "format control request WDFUSBDEVICE %p, WDFREQWUEST %p, WDFMEMORY %p, %!STATUS!", UsbDevice, Request, TransferMemory, status);
return status;}
_Must_inspect_result___drv_maxIRQL(PASSIVE_LEVEL)NTSTATUSWDFAPINTAPIWDFEXPORT(WdfUsbTargetDeviceResetPortSynchronously)( __in PWDF_DRIVER_GLOBALS DriverGlobals, __in WDFUSBDEVICE UsbDevice ){ DDI_ENTRY();
PFX_DRIVER_GLOBALS pFxDriverGlobals; FxUsbDevice* pUsbDevice; NTSTATUS status;
FxObjectHandleGetPtrAndGlobals(GetFxDriverGlobals(DriverGlobals), UsbDevice, FX_TYPE_IO_TARGET_USB_DEVICE, (PVOID*) &pUsbDevice, &pFxDriverGlobals);
status = FxVerifierCheckIrqlLevel(pFxDriverGlobals, PASSIVE_LEVEL); if (!NT_SUCCESS(status)) { return status; }
status = pUsbDevice->Reset();
return status;}
#pragma warning(disable:28285)__checkReturn__drv_maxIRQL(DISPATCH_LEVEL)NTSTATUSWDFAPINTAPIWDFEXPORT(WdfUsbTargetDeviceCreateIsochUrb)( __in PWDF_DRIVER_GLOBALS DriverGlobals, __in WDFUSBDEVICE UsbDevice, __in_opt PWDF_OBJECT_ATTRIBUTES Attributes, __in ULONG NumberOfIsochPackets, __out WDFMEMORY* UrbMemory, __deref_opt_out_bcount(GET_ISOCH_URB_SIZE(NumberOfIsochPackets)) PURB* Urb )/*++
Routine Description: Creates a WDFUSBDEVICE handle for the client.
Arguments: Attributes - Attributes associated with this object
NumberOfIsochPacket - Maximum number of Isoch packets that will be programmed into this Urb
UrbMemory - The returned handle to the caller for the allocated Urb
Urb - (opt) Pointer to the associated urb buffer.
Return Value: STATUS_INVALID_PARAMETER - any required parameters are not present/invalid
STATUS_INVALID_DEVICE_STATE - If the client did not specify a client contract verion while creating the WDFUSBDEVICE
STATUS_INSUFFICIENT_RESOURCES - could not allocated the object that backs the handle
STATUS_SUCCESS - success
...
--*/{ DDI_ENTRY();
PFX_DRIVER_GLOBALS pFxDriverGlobals; FxUsbDevice* pUsbDevice; NTSTATUS status;
FxObjectHandleGetPtrAndGlobals(GetFxDriverGlobals(DriverGlobals), UsbDevice, FX_TYPE_IO_TARGET_USB_DEVICE, (PVOID*) &pUsbDevice, &pFxDriverGlobals);
// // Basic parameter validation // FxPointerNotNull(pFxDriverGlobals, UrbMemory);
if (pUsbDevice->GetUSBDHandle() == NULL) { status = STATUS_INVALID_DEVICE_STATE;
DoTraceLevelMessage( pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET, "USBDEVICE Must have been created with Client Contract Verion Info, %!STATUS!", status);
return status; }
status = pUsbDevice->CreateIsochUrb(Attributes, NumberOfIsochPackets, UrbMemory, Urb);
return status;}
__drv_maxIRQL(DISPATCH_LEVEL)WDFUSBINTERFACEWDFAPINTAPIWDFEXPORT(WdfUsbTargetDeviceGetInterface)( __in PWDF_DRIVER_GLOBALS DriverGlobals, __in WDFUSBDEVICE UsbDevice, __in UCHAR InterfaceIndex )/*++
Routine Description:
Arguments:
Return Value:
--*/
{ DDI_ENTRY();
PFX_DRIVER_GLOBALS pFxDriverGlobals; FxUsbDevice* pUsbDevice; FxUsbInterface *pUsbInterface;
FxObjectHandleGetPtrAndGlobals(GetFxDriverGlobals(DriverGlobals), UsbDevice, FX_TYPE_IO_TARGET_USB_DEVICE, (PVOID*) &pUsbDevice, &pFxDriverGlobals);
pUsbInterface = pUsbDevice->GetInterfaceFromIndex(InterfaceIndex);
if (pUsbInterface != NULL) { return pUsbInterface->GetHandle(); } else { DoTraceLevelMessage( pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET, "WDFUSBDEVICE %p has %d interfaces, index %d requested, returning " "NULL handle", UsbDevice, pUsbDevice->GetNumInterfaces(), InterfaceIndex);
return NULL; }}
_Must_inspect_result___drv_maxIRQL(PASSIVE_LEVEL)NTSTATUSWDFAPINTAPIWDFEXPORT(WdfUsbTargetDeviceQueryUsbCapability)( __in PWDF_DRIVER_GLOBALS DriverGlobals, __in WDFUSBDEVICE UsbDevice, __in CONST GUID* CapabilityType, __in ULONG CapabilityBufferLength, __drv_when(CapabilityBufferLength == 0, __out_opt) __drv_when(CapabilityBufferLength != 0 && ResultLength == NULL, __out_bcount(CapabilityBufferLength)) __drv_when(CapabilityBufferLength != 0 && ResultLength != NULL, __out_bcount_part_opt(CapabilityBufferLength, *ResultLength)) PVOID CapabilityBuffer, __out_opt __drv_when(ResultLength != NULL,__deref_out_range(<=,CapabilityBufferLength)) PULONG ResultLength )/*++
Routine Description: Queries USB capability for the device. Such capabilities are available only with USB 3.0 stack. On earlier stacks this API will fail with STATUS_NOT_IMPLEMENTED
Arguments: UsbDevice - Device whose capability is to be queried.
CapabilityType - Type of capability as defined by IOCTL_INTERNAL_USB_GET_USB_CAPABILITY
CapabilityBufferLength - Length of Capability buffer
CapabilityBuffer - Buffer for capability. Can be NULL if CapabilitiyBufferLength is 0
ResultLength - Actual length of the capability. This parameter is optional.
Return Value: STATUS_SUCCESS - success STATUS_NOT_IMPLEMENTED - Capabilties are not supported by USB stack STATUS_INSUFFICIENT_RESOURCES - no memory available ...
--*/{ DDI_ENTRY();
NTSTATUS status; PFX_DRIVER_GLOBALS pFxDriverGlobals; FxUsbDevice* pUsbDevice;
FxObjectHandleGetPtrAndGlobals(GetFxDriverGlobals(DriverGlobals), UsbDevice, FX_TYPE_IO_TARGET_USB_DEVICE, (PVOID*) &pUsbDevice, &pFxDriverGlobals);
if (CapabilityBufferLength > 0) { FxPointerNotNull(pFxDriverGlobals, CapabilityBuffer); }
status = pUsbDevice->QueryUsbCapability(CapabilityType, CapabilityBufferLength, CapabilityBuffer, ResultLength); return status;}
} // extern "C"