2 * PROJECT: ReactOS Universal Serial Bus Bulk Driver Library
3 * LICENSE: GPL - See COPYING in the top level directory
4 * FILE: lib/drivers/libusb/usb_device.cpp
5 * PURPOSE: USB Common Driver Library.
7 * Michael Martin (michael.martin@reactos.org)
8 * Johannes Anderwald (johannes.anderwald@reactos.org)
15 class CUSBDevice
: public IUSBDevice
18 STDMETHODIMP
QueryInterface( REFIID InterfaceId
, PVOID
* Interface
);
20 STDMETHODIMP_(ULONG
) AddRef()
22 InterlockedIncrement(&m_Ref
);
25 STDMETHODIMP_(ULONG
) Release()
27 InterlockedDecrement(&m_Ref
);
37 // IUSBDevice interface functions
38 virtual NTSTATUS
Initialize(IN PHUBCONTROLLER HubController
, IN PUSBHARDWAREDEVICE Device
, IN PVOID Parent
, IN ULONG Port
, IN ULONG PortStatus
);
39 virtual BOOLEAN
IsHub();
40 virtual NTSTATUS
GetParent(PVOID
* Parent
);
41 virtual UCHAR
GetDeviceAddress();
42 virtual ULONG
GetPort();
43 virtual USB_DEVICE_SPEED
GetSpeed();
44 virtual USB_DEVICE_TYPE
GetType();
45 virtual ULONG
GetState();
46 virtual void SetDeviceHandleData(PVOID Data
);
47 virtual NTSTATUS
SetDeviceAddress(UCHAR DeviceAddress
);
48 virtual void GetDeviceDescriptor(PUSB_DEVICE_DESCRIPTOR DeviceDescriptor
);
49 virtual UCHAR
GetConfigurationValue();
50 virtual NTSTATUS
SubmitIrp(PIRP Irp
);
51 virtual VOID
GetConfigurationDescriptors(IN PUSB_CONFIGURATION_DESCRIPTOR ConfigDescriptorBuffer
, IN ULONG BufferLength
, OUT PULONG OutBufferLength
);
52 virtual ULONG
GetConfigurationDescriptorsLength();
53 virtual NTSTATUS
SubmitSetupPacket(IN PUSB_DEFAULT_PIPE_SETUP_PACKET SetupPacket
, OUT ULONG BufferLength
, OUT PVOID Buffer
);
54 virtual NTSTATUS
SelectConfiguration(IN PUSB_CONFIGURATION_DESCRIPTOR ConfigurationDescriptor
, IN PUSBD_INTERFACE_INFORMATION Interface
, OUT USBD_CONFIGURATION_HANDLE
*ConfigurationHandle
);
55 virtual NTSTATUS
SelectInterface(IN USBD_CONFIGURATION_HANDLE ConfigurationHandle
, IN OUT PUSBD_INTERFACE_INFORMATION Interface
);
56 virtual NTSTATUS
AbortPipe(IN PUSB_ENDPOINT_DESCRIPTOR EndpointDescriptor
);
57 virtual UCHAR
GetMaxPacketSize();
61 virtual NTSTATUS
CommitIrp(PIRP Irp
);
62 virtual NTSTATUS
CommitSetupPacket(PUSB_DEFAULT_PIPE_SETUP_PACKET Packet
, IN OPTIONAL PUSB_ENDPOINT EndpointDescriptor
, IN ULONG BufferLength
, IN OUT PMDL Mdl
);
63 virtual NTSTATUS
CreateConfigurationDescriptor(UCHAR ConfigurationIndex
);
64 virtual NTSTATUS
CreateDeviceDescriptor();
65 virtual VOID
DumpDeviceDescriptor(PUSB_DEVICE_DESCRIPTOR DeviceDescriptor
);
66 virtual VOID
DumpConfigurationDescriptor(PUSB_CONFIGURATION_DESCRIPTOR ConfigurationDescriptor
);
67 virtual NTSTATUS
GetConfigurationDescriptor(UCHAR ConfigurationIndex
, USHORT BufferSize
, PVOID Buffer
);
68 virtual NTSTATUS
BuildInterfaceDescriptor(IN ULONG ConfigurationIndex
, IN PUSB_INTERFACE_DESCRIPTOR InterfaceDescriptor
, OUT PUSBD_INTERFACE_INFORMATION InterfaceInfo
, OUT PUSB_INTERFACE
*OutUsbInterface
);
71 // constructor / destructor
72 CUSBDevice(IUnknown
*OuterUnknown
){}
73 virtual ~CUSBDevice(){}
77 PHUBCONTROLLER m_HubController
;
78 PUSBHARDWAREDEVICE m_Device
;
81 UCHAR m_DeviceAddress
;
83 UCHAR m_ConfigurationIndex
;
85 USB_DEVICE_DESCRIPTOR m_DeviceDescriptor
;
88 PDMAMEMORYMANAGER m_DmaManager
;
91 PUSB_CONFIGURATION m_ConfigurationDescriptors
;
94 //----------------------------------------------------------------------------------------
97 CUSBDevice::QueryInterface(
101 return STATUS_UNSUCCESSFUL
;
104 //----------------------------------------------------------------------------------------
106 CUSBDevice::Initialize(
107 IN PHUBCONTROLLER HubController
,
108 IN PUSBHARDWAREDEVICE Device
,
116 // initialize members
118 m_HubController
= HubController
;
122 m_PortStatus
= PortStatus
;
123 m_USBType
= m_Device
->GetUSBType();
126 // initialize device lock
128 KeInitializeSpinLock(&m_Lock
);
131 // no device address has been set yet
136 // get usb request queue
138 Status
= m_Device
->GetUSBQueue(&m_Queue
);
139 if (!NT_SUCCESS(Status
))
142 // failed to get usb queue
144 DPRINT1("[%S] GetUsbQueue failed with %x\n", m_USBType
, Status
);
151 Status
= m_Device
->GetDMA(&m_DmaManager
);
152 if (!NT_SUCCESS(Status
))
155 // failed to get dma manager
157 DPRINT1("[%S] GetDMA failed with %x\n", m_USBType
, Status
);
164 PC_ASSERT(m_DmaManager
);
167 // get device descriptor
169 Status
= CreateDeviceDescriptor();
170 if (!NT_SUCCESS(Status
))
173 // failed to get device descriptor
175 DPRINT1("[%S] Failed to get device descriptor with %x\n", m_USBType
, Status
);
185 //----------------------------------------------------------------------------------------
190 // USB Standard Device Class see http://www.usb.org/developers/defined_class/#BaseClass09h
193 return (m_DeviceDescriptor
.bDeviceClass
== 0x09 && m_DeviceDescriptor
.bDeviceSubClass
== 0x00);
196 //----------------------------------------------------------------------------------------
198 CUSBDevice::GetParent(
209 return STATUS_SUCCESS
;
212 //----------------------------------------------------------------------------------------
214 CUSBDevice::GetDeviceAddress()
217 // get device address
219 return m_DeviceAddress
;
222 //----------------------------------------------------------------------------------------
224 CUSBDevice::GetPort()
227 // get port to which this device is connected to
232 //----------------------------------------------------------------------------------------
234 CUSBDevice::GetSpeed()
236 if (m_PortStatus
& USB_PORT_STATUS_LOW_SPEED
)
243 else if (m_PortStatus
& USB_PORT_STATUS_HIGH_SPEED
)
252 // default to full speed
257 //----------------------------------------------------------------------------------------
259 CUSBDevice::GetType()
262 // device is encoded into bcdUSB
264 if (m_DeviceDescriptor
.bcdUSB
== 0x110)
271 else if (m_DeviceDescriptor
.bcdUSB
== 0x200)
279 DPRINT1("[%S] GetType Unknown bcdUSB Type %x\n", m_USBType
, m_DeviceDescriptor
.bcdUSB
);
285 //----------------------------------------------------------------------------------------
287 CUSBDevice::GetState()
293 //----------------------------------------------------------------------------------------
295 CUSBDevice::SetDeviceHandleData(
299 // set device data, for debugging issues
304 //----------------------------------------------------------------------------------------
306 CUSBDevice::SetDeviceAddress(
309 PUSB_DEFAULT_PIPE_SETUP_PACKET CtrlSetup
;
314 DPRINT1("[%S] SetDeviceAddress> Address %x\n", m_USBType
, DeviceAddress
);
316 CtrlSetup
= (PUSB_DEFAULT_PIPE_SETUP_PACKET
)ExAllocatePoolWithTag(NonPagedPool
, sizeof(USB_DEFAULT_PIPE_SETUP_PACKET
), TAG_USBLIB
);
318 return STATUS_INSUFFICIENT_RESOURCES
;
321 RtlZeroMemory(CtrlSetup
, sizeof(USB_DEFAULT_PIPE_SETUP_PACKET
));
323 // initialize request
324 CtrlSetup
->bRequest
= USB_REQUEST_SET_ADDRESS
;
325 CtrlSetup
->wValue
.W
= DeviceAddress
;
327 // set device address
328 Status
= CommitSetupPacket(CtrlSetup
, NULL
, 0, NULL
);
331 ExFreePoolWithTag(CtrlSetup
, TAG_USBLIB
);
334 if (!NT_SUCCESS(Status
))
336 // failed to set device address
337 DPRINT1("[%S] SetDeviceAddress> failed to set device address with %lx Address %x\n", m_USBType
, Status
, DeviceAddress
);
341 // lets have a short nap
342 KeStallExecutionProcessor(300);
344 // back up old address
345 OldAddress
= m_DeviceAddress
;
347 // store new device address
348 m_DeviceAddress
= DeviceAddress
;
350 // fetch device descriptor
351 Status
= CreateDeviceDescriptor();
352 if (!NT_SUCCESS(Status
))
354 DPRINT1("[%S] SetDeviceAddress failed to retrieve device descriptor with device address set Error %lx\n", m_USBType
, Status
);
355 // return error status
359 // check for invalid device descriptor
360 if (m_DeviceDescriptor
.bLength
!= sizeof(USB_DEVICE_DESCRIPTOR
) ||
361 m_DeviceDescriptor
.bDescriptorType
!= USB_DEVICE_DESCRIPTOR_TYPE
||
362 m_DeviceDescriptor
.bNumConfigurations
== 0)
364 // failed to retrieve device descriptor
365 DPRINT1("[%S] SetDeviceAddress> device returned bogus device descriptor\n", m_USBType
);
366 DumpDeviceDescriptor(&m_DeviceDescriptor
);
368 // return error status
369 return STATUS_UNSUCCESSFUL
;
372 // dump device descriptor
373 DumpDeviceDescriptor(&m_DeviceDescriptor
);
376 PC_ASSERT(m_DeviceDescriptor
.bNumConfigurations
);
378 // allocate configuration descriptor
379 m_ConfigurationDescriptors
= (PUSB_CONFIGURATION
) ExAllocatePoolWithTag(NonPagedPool
, sizeof(USB_CONFIGURATION
) * m_DeviceDescriptor
.bNumConfigurations
, TAG_USBLIB
);
381 // zero configuration descriptor
382 RtlZeroMemory(m_ConfigurationDescriptors
, sizeof(USB_CONFIGURATION
) * m_DeviceDescriptor
.bNumConfigurations
);
384 // retrieve the configuration descriptors
385 for (Index
= 0; Index
< m_DeviceDescriptor
.bNumConfigurations
; Index
++)
387 // retrieve configuration descriptors from device
388 Status
= CreateConfigurationDescriptor(Index
);
389 if (!NT_SUCCESS(Status
))
391 DPRINT1("[%S] SetDeviceAddress> failed to retrieve configuration %lu\n", m_USBType
, Index
);
403 //----------------------------------------------------------------------------------------
405 CUSBDevice::GetDeviceDescriptor(
406 PUSB_DEVICE_DESCRIPTOR DeviceDescriptor
)
408 RtlMoveMemory(DeviceDescriptor
, &m_DeviceDescriptor
, sizeof(USB_DEVICE_DESCRIPTOR
));
411 //----------------------------------------------------------------------------------------
413 CUSBDevice::GetConfigurationValue()
416 // return configuration index
418 return m_ConfigurationIndex
;
421 //----------------------------------------------------------------------------------------
423 CUSBDevice::CommitIrp(
429 if (!m_Queue
|| !m_DmaManager
)
434 DPRINT1("[%S] CommitIrp> no queue / dma !!!\n", m_USBType
);
435 return STATUS_UNSUCCESSFUL
;
441 Status
= m_Queue
->CreateUSBRequest(&Request
);
442 if (!NT_SUCCESS(Status
))
445 // failed to build request
447 DPRINT1("[%S] CommitIrp> CreateUSBRequest failed with %lx\n", m_USBType
, Status
);
452 // initialize request
454 Status
= Request
->InitializeWithIrp(m_DmaManager
, PUSBDEVICE(this), Irp
);
457 // mark irp as pending
459 IoMarkIrpPending(Irp
);
462 // now add the request
464 Status
= m_Queue
->AddUSBRequest(Request
);
465 if (!NT_SUCCESS(Status
))
468 // failed to add request
470 DPRINT1("[%S] failed add request to queue with %lx\n", m_USBType
, Status
);
478 return STATUS_PENDING
;
481 //----------------------------------------------------------------------------------------
483 CUSBDevice::SubmitIrp(
490 // acquire device lock
492 KeAcquireSpinLock(&m_Lock
, &OldLevel
);
497 Status
= CommitIrp(Irp
);
502 KeReleaseSpinLock(&m_Lock
, OldLevel
);
507 //----------------------------------------------------------------------------------------
509 CUSBDevice::CommitSetupPacket(
510 IN PUSB_DEFAULT_PIPE_SETUP_PACKET Packet
,
511 IN OPTIONAL PUSB_ENDPOINT EndpointDescriptor
,
512 IN ULONG BufferLength
,
523 DPRINT1("[%S] CommitSetupPacket> no queue!!!\n", m_USBType
);
524 return STATUS_UNSUCCESSFUL
;
530 Status
= m_Queue
->CreateUSBRequest(&Request
);
531 if (!NT_SUCCESS(Status
))
534 // failed to build request
536 DPRINT1("[%S] CommitSetupPacket> CreateUSBRequest failed with %x\n", m_USBType
, Status
);
541 // initialize request
543 Status
= Request
->InitializeWithSetupPacket(m_DmaManager
, Packet
, PUSBDEVICE(this), EndpointDescriptor
, BufferLength
, Mdl
);
544 if (!NT_SUCCESS(Status
))
547 // failed to initialize request
549 DPRINT1("[%S] CommitSetupPacket failed to initialize usb request with %x\n", m_USBType
, Status
);
555 // now add the request
557 Status
= m_Queue
->AddUSBRequest(Request
);
558 if (!NT_SUCCESS(Status
))
561 // failed to add request
563 DPRINT1("[%S] CommitSetupPacket> failed add request to queue with %x\n", m_USBType
, Status
);
569 // get the result code when the operation has been finished
571 Request
->GetResultStatus(&Status
, NULL
);
584 //----------------------------------------------------------------------------------------
586 CUSBDevice::CreateDeviceDescriptor()
588 USB_DEFAULT_PIPE_SETUP_PACKET CtrlSetup
;
596 RtlZeroMemory(&m_DeviceDescriptor
, sizeof(USB_DEVICE_DESCRIPTOR
));
597 RtlZeroMemory(&CtrlSetup
, sizeof(USB_DEFAULT_PIPE_SETUP_PACKET
));
602 CtrlSetup
.bRequest
= USB_REQUEST_GET_DESCRIPTOR
;
603 CtrlSetup
.wValue
.HiByte
= USB_DEVICE_DESCRIPTOR_TYPE
;
604 CtrlSetup
.wLength
= sizeof(USB_DEVICE_DESCRIPTOR
);
605 CtrlSetup
.bmRequestType
.B
= 0x80;
610 Buffer
= ExAllocatePool(NonPagedPool
, PAGE_SIZE
);
614 // failed to allocate
616 return STATUS_INSUFFICIENT_RESOURCES
;
622 RtlZeroMemory(Buffer
, PAGE_SIZE
);
625 // allocate mdl describing the device descriptor
627 Mdl
= IoAllocateMdl(Buffer
, sizeof(USB_DEVICE_DESCRIPTOR
), FALSE
, FALSE
, 0);
631 // failed to allocate mdl
633 return STATUS_INSUFFICIENT_RESOURCES
;
637 // build mdl for non paged pool
639 MmBuildMdlForNonPagedPool(Mdl
);
642 // commit setup packet
644 Status
= CommitSetupPacket(&CtrlSetup
, NULL
, sizeof(USB_DEVICE_DESCRIPTOR
), Mdl
);
651 if (NT_SUCCESS(Status
))
654 // copy device descriptor
656 RtlCopyMemory(&m_DeviceDescriptor
, Buffer
, sizeof(USB_DEVICE_DESCRIPTOR
));
671 //----------------------------------------------------------------------------------------
673 CUSBDevice::GetConfigurationDescriptor(
674 IN UCHAR ConfigurationIndex
,
675 IN USHORT BufferSize
,
678 USB_DEFAULT_PIPE_SETUP_PACKET CtrlSetup
;
684 // now build MDL describing the buffer
686 Mdl
= IoAllocateMdl(Buffer
, BufferSize
, FALSE
, FALSE
, 0);
690 // failed to allocate mdl
692 return STATUS_INSUFFICIENT_RESOURCES
;
696 // build mdl for non paged pool
698 MmBuildMdlForNonPagedPool(Mdl
);
702 // build setup packet
704 CtrlSetup
.bmRequestType
._BM
.Recipient
= BMREQUEST_TO_DEVICE
;
705 CtrlSetup
.bmRequestType
._BM
.Type
= BMREQUEST_STANDARD
;
706 CtrlSetup
.bmRequestType
._BM
.Reserved
= 0;
707 CtrlSetup
.bmRequestType
._BM
.Dir
= BMREQUEST_DEVICE_TO_HOST
;
708 CtrlSetup
.bRequest
= USB_REQUEST_GET_DESCRIPTOR
;
709 CtrlSetup
.wValue
.LowByte
= ConfigurationIndex
;
710 CtrlSetup
.wValue
.HiByte
= USB_CONFIGURATION_DESCRIPTOR_TYPE
;
711 CtrlSetup
.wIndex
.W
= 0;
712 CtrlSetup
.wLength
= BufferSize
;
717 Status
= CommitSetupPacket(&CtrlSetup
, NULL
, BufferSize
, Mdl
);
730 //----------------------------------------------------------------------------------------
732 CUSBDevice::CreateConfigurationDescriptor(
736 PUSB_CONFIGURATION_DESCRIPTOR ConfigurationDescriptor
;
741 PC_ASSERT(m_ConfigurationDescriptors
);
744 // first allocate a buffer which should be enough to store all different interfaces and endpoints
746 ConfigurationDescriptor
= (PUSB_CONFIGURATION_DESCRIPTOR
)ExAllocatePoolWithTag(NonPagedPool
, PAGE_SIZE
, TAG_USBLIB
);
747 if (!ConfigurationDescriptor
)
750 // failed to allocate buffer
752 return STATUS_INSUFFICIENT_RESOURCES
;
756 // get partial configuration descriptor
758 Status
= GetConfigurationDescriptor(Index
, sizeof(USB_CONFIGURATION_DESCRIPTOR
), ConfigurationDescriptor
);
759 if (!NT_SUCCESS(Status
))
762 // failed to get partial configuration descriptor
764 DPRINT1("[%S] Failed to get partial configuration descriptor Status %x Index %x\n", m_USBType
, Status
, Index
);
765 ExFreePoolWithTag(ConfigurationDescriptor
, TAG_USBLIB
);
770 // now get full descriptor
772 Status
= GetConfigurationDescriptor(Index
, ConfigurationDescriptor
->wTotalLength
, ConfigurationDescriptor
);
773 if (!NT_SUCCESS(Status
))
776 // failed to get full configuration descriptor
778 DPRINT1("[%S] Failed to get full configuration descriptor Status %x Index %x\n", m_USBType
, Status
, Index
);
779 ExFreePoolWithTag(ConfigurationDescriptor
, TAG_USBLIB
);
784 // informal debug print
786 DumpConfigurationDescriptor(ConfigurationDescriptor
);
791 PC_ASSERT(ConfigurationDescriptor
->bLength
== sizeof(USB_CONFIGURATION_DESCRIPTOR
));
792 PC_ASSERT(ConfigurationDescriptor
->wTotalLength
<= PAGE_SIZE
);
793 PC_ASSERT(ConfigurationDescriptor
->bNumInterfaces
);
796 // request is complete, initialize configuration descriptor
798 m_ConfigurationDescriptors
[Index
].ConfigurationDescriptor
= ConfigurationDescriptor
;
799 InitializeListHead(&m_ConfigurationDescriptors
[Index
].InterfaceList
);
806 //----------------------------------------------------------------------------------------
808 CUSBDevice::GetConfigurationDescriptors(
809 IN PUSB_CONFIGURATION_DESCRIPTOR ConfigDescriptorBuffer
,
810 IN ULONG BufferLength
,
811 OUT PULONG OutBufferLength
)
816 ASSERT(BufferLength
>= sizeof(USB_CONFIGURATION_DESCRIPTOR
));
817 ASSERT(ConfigDescriptorBuffer
);
818 ASSERT(OutBufferLength
);
820 // reset copied length
821 *OutBufferLength
= 0;
823 // FIXME: support multiple configurations
824 PC_ASSERT(m_DeviceDescriptor
.bNumConfigurations
== 1);
826 // copy configuration descriptor
827 Length
= min(m_ConfigurationDescriptors
[0].ConfigurationDescriptor
->wTotalLength
, BufferLength
);
828 RtlCopyMemory(ConfigDescriptorBuffer
, m_ConfigurationDescriptors
[0].ConfigurationDescriptor
, Length
);
829 *OutBufferLength
= Length
;
832 //----------------------------------------------------------------------------------------
834 CUSBDevice::GetConfigurationDescriptorsLength()
837 // FIXME: support multiple configurations
839 PC_ASSERT(m_DeviceDescriptor
.bNumConfigurations
== 1);
841 return m_ConfigurationDescriptors
[0].ConfigurationDescriptor
->wTotalLength
;
843 //----------------------------------------------------------------------------------------
845 CUSBDevice::DumpDeviceDescriptor(PUSB_DEVICE_DESCRIPTOR DeviceDescriptor
)
847 DPRINT1("Dumping Device Descriptor %p\n", DeviceDescriptor
);
848 DPRINT1("bLength %x\n", DeviceDescriptor
->bLength
);
849 DPRINT1("bDescriptorType %x\n", DeviceDescriptor
->bDescriptorType
);
850 DPRINT1("bcdUSB %x\n", DeviceDescriptor
->bcdUSB
);
851 DPRINT1("bDeviceClass %x\n", DeviceDescriptor
->bDeviceClass
);
852 DPRINT1("bDeviceSubClass %x\n", DeviceDescriptor
->bDeviceSubClass
);
853 DPRINT1("bDeviceProtocol %x\n", DeviceDescriptor
->bDeviceProtocol
);
854 DPRINT1("bMaxPacketSize0 %x\n", DeviceDescriptor
->bMaxPacketSize0
);
855 DPRINT1("idVendor %x\n", DeviceDescriptor
->idVendor
);
856 DPRINT1("idProduct %x\n", DeviceDescriptor
->idProduct
);
857 DPRINT1("bcdDevice %x\n", DeviceDescriptor
->bcdDevice
);
858 DPRINT1("iManufacturer %x\n", DeviceDescriptor
->iManufacturer
);
859 DPRINT1("iProduct %x\n", DeviceDescriptor
->iProduct
);
860 DPRINT1("iSerialNumber %x\n", DeviceDescriptor
->iSerialNumber
);
861 DPRINT1("bNumConfigurations %x\n", DeviceDescriptor
->bNumConfigurations
);
864 //----------------------------------------------------------------------------------------
866 CUSBDevice::DumpConfigurationDescriptor(PUSB_CONFIGURATION_DESCRIPTOR ConfigurationDescriptor
)
868 DPRINT1("Dumping ConfigurationDescriptor %p\n", ConfigurationDescriptor
);
869 DPRINT1("bLength %x\n", ConfigurationDescriptor
->bLength
);
870 DPRINT1("bDescriptorType %x\n", ConfigurationDescriptor
->bDescriptorType
);
871 DPRINT1("wTotalLength %x\n", ConfigurationDescriptor
->wTotalLength
);
872 DPRINT1("bNumInterfaces %x\n", ConfigurationDescriptor
->bNumInterfaces
);
873 DPRINT1("bConfigurationValue %x\n", ConfigurationDescriptor
->bConfigurationValue
);
874 DPRINT1("iConfiguration %x\n", ConfigurationDescriptor
->iConfiguration
);
875 DPRINT1("bmAttributes %x\n", ConfigurationDescriptor
->bmAttributes
);
876 DPRINT1("MaxPower %x\n", ConfigurationDescriptor
->MaxPower
);
878 //----------------------------------------------------------------------------------------
880 CUSBDevice::SubmitSetupPacket(
881 IN PUSB_DEFAULT_PIPE_SETUP_PACKET SetupPacket
,
882 IN OUT ULONG BufferLength
,
893 Mdl
= IoAllocateMdl(Buffer
, BufferLength
, FALSE
, FALSE
, 0);
899 return STATUS_INSUFFICIENT_RESOURCES
;
903 // HACK HACK HACK: assume the buffer is build from non paged pool
905 MmBuildMdlForNonPagedPool(Mdl
);
909 // commit setup packet
911 Status
= CommitSetupPacket(SetupPacket
, NULL
, BufferLength
, Mdl
);
926 //----------------------------------------------------------------------------------------
928 CUSBDevice::BuildInterfaceDescriptor(
929 IN ULONG ConfigurationIndex
,
930 IN PUSB_INTERFACE_DESCRIPTOR InterfaceDescriptor
,
931 OUT PUSBD_INTERFACE_INFORMATION InterfaceInfo
,
932 OUT PUSB_INTERFACE
*OutUsbInterface
)
934 PUSB_INTERFACE UsbInterface
;
935 PUSB_ENDPOINT_DESCRIPTOR EndpointDescriptor
;
938 // allocate interface handle
939 UsbInterface
= (PUSB_INTERFACE
)ExAllocatePool(NonPagedPool
, sizeof(USB_INTERFACE
) + (InterfaceDescriptor
->bNumEndpoints
- 1) * sizeof(USB_ENDPOINT
));
942 // failed to allocate memory
943 return STATUS_INSUFFICIENT_RESOURCES
;
947 RtlZeroMemory(UsbInterface
, sizeof(USB_INTERFACE
) + (InterfaceDescriptor
->bNumEndpoints
- 1) * sizeof(USB_ENDPOINT
));
950 InterfaceInfo
->InterfaceHandle
= (USBD_INTERFACE_HANDLE
)UsbInterface
;
951 InterfaceInfo
->Class
= InterfaceDescriptor
->bInterfaceClass
;
952 InterfaceInfo
->SubClass
= InterfaceDescriptor
->bInterfaceSubClass
;
953 InterfaceInfo
->Protocol
= InterfaceDescriptor
->bInterfaceProtocol
;
954 InterfaceInfo
->Reserved
= 0;
957 // init interface handle
958 UsbInterface
->InterfaceDescriptor
= InterfaceDescriptor
;
959 InsertTailList(&m_ConfigurationDescriptors
[ConfigurationIndex
].InterfaceList
, &UsbInterface
->ListEntry
);
961 // grab first endpoint descriptor
962 EndpointDescriptor
= (PUSB_ENDPOINT_DESCRIPTOR
) (InterfaceDescriptor
+ 1);
964 // now copy all endpoint information
965 for(PipeIndex
= 0; PipeIndex
< InterfaceDescriptor
->bNumEndpoints
; PipeIndex
++)
967 while(EndpointDescriptor
->bDescriptorType
!= USB_ENDPOINT_DESCRIPTOR_TYPE
)
969 // skip intermediate descriptors
970 if (EndpointDescriptor
->bLength
== 0 || EndpointDescriptor
->bDescriptorType
== USB_INTERFACE_DESCRIPTOR_TYPE
)
972 // bogus configuration descriptor
973 DPRINT1("[%S] Bogus descriptor found in InterfaceNumber %x Alternate %x EndpointIndex %x bLength %x bDescriptorType %x\n", m_USBType
, InterfaceDescriptor
->bInterfaceNumber
, InterfaceDescriptor
->bAlternateSetting
, PipeIndex
,
974 EndpointDescriptor
->bLength
, EndpointDescriptor
->bDescriptorType
);
977 return STATUS_UNSUCCESSFUL
;
980 // move to next descriptor
981 EndpointDescriptor
= (PUSB_ENDPOINT_DESCRIPTOR
)((ULONG_PTR
)EndpointDescriptor
+ EndpointDescriptor
->bLength
);
984 // store in interface info
985 RtlCopyMemory(&UsbInterface
->EndPoints
[PipeIndex
].EndPointDescriptor
, EndpointDescriptor
, sizeof(USB_ENDPOINT_DESCRIPTOR
));
987 DPRINT("Configuration Descriptor %p Length %lu\n", m_ConfigurationDescriptors
[ConfigurationIndex
].ConfigurationDescriptor
, m_ConfigurationDescriptors
[ConfigurationIndex
].ConfigurationDescriptor
->wTotalLength
);
988 DPRINT("EndpointDescriptor %p DescriptorType %x bLength %x\n", EndpointDescriptor
, EndpointDescriptor
->bDescriptorType
, EndpointDescriptor
->bLength
);
989 DPRINT("EndpointDescriptorHandle %p bAddress %x bmAttributes %x\n",&UsbInterface
->EndPoints
[PipeIndex
], UsbInterface
->EndPoints
[PipeIndex
].EndPointDescriptor
.bEndpointAddress
,
990 UsbInterface
->EndPoints
[PipeIndex
].EndPointDescriptor
.bmAttributes
);
993 InterfaceInfo
->Pipes
[PipeIndex
].MaximumPacketSize
= UsbInterface
->EndPoints
[PipeIndex
].EndPointDescriptor
.wMaxPacketSize
;
994 InterfaceInfo
->Pipes
[PipeIndex
].EndpointAddress
= UsbInterface
->EndPoints
[PipeIndex
].EndPointDescriptor
.bEndpointAddress
;
995 InterfaceInfo
->Pipes
[PipeIndex
].Interval
= UsbInterface
->EndPoints
[PipeIndex
].EndPointDescriptor
.bInterval
;
996 InterfaceInfo
->Pipes
[PipeIndex
].PipeType
= (USBD_PIPE_TYPE
)UsbInterface
->EndPoints
[PipeIndex
].EndPointDescriptor
.bmAttributes
;
997 InterfaceInfo
->Pipes
[PipeIndex
].PipeHandle
= (PVOID
)&UsbInterface
->EndPoints
[PipeIndex
];
999 // move to next descriptor
1000 EndpointDescriptor
= (PUSB_ENDPOINT_DESCRIPTOR
)((ULONG_PTR
)EndpointDescriptor
+ EndpointDescriptor
->bLength
);
1003 if (OutUsbInterface
)
1006 *OutUsbInterface
= UsbInterface
;
1008 return STATUS_SUCCESS
;
1013 //----------------------------------------------------------------------------------------
1015 CUSBDevice::SelectConfiguration(
1016 IN PUSB_CONFIGURATION_DESCRIPTOR ConfigurationDescriptor
,
1017 IN PUSBD_INTERFACE_INFORMATION InterfaceInfo
,
1018 OUT USBD_CONFIGURATION_HANDLE
*ConfigurationHandle
)
1020 ULONG InterfaceIndex
;
1021 USB_DEFAULT_PIPE_SETUP_PACKET CtrlSetup
;
1023 UCHAR bConfigurationValue
= 0;
1024 ULONG ConfigurationIndex
= 0, Index
;
1025 UCHAR Found
= FALSE
;
1026 PUSB_INTERFACE_DESCRIPTOR InterfaceDescriptor
;
1027 PUSB_INTERFACE UsbInterface
;
1030 if (ConfigurationDescriptor
)
1032 // find configuration index
1033 for (Index
= 0; Index
< m_DeviceDescriptor
.bNumConfigurations
; Index
++)
1035 if (m_ConfigurationDescriptors
[Index
].ConfigurationDescriptor
->bConfigurationValue
== ConfigurationDescriptor
->bConfigurationValue
)
1037 // found configuration index
1038 ConfigurationIndex
= Index
;
1045 DPRINT1("[%S] invalid configuration value %u\n", m_USBType
, ConfigurationDescriptor
->bConfigurationValue
);
1046 return STATUS_INVALID_PARAMETER
;
1050 ASSERT(ConfigurationDescriptor
->bNumInterfaces
<= m_ConfigurationDescriptors
[ConfigurationIndex
].ConfigurationDescriptor
->bNumInterfaces
);
1052 // get configuration value
1053 bConfigurationValue
= ConfigurationDescriptor
->bConfigurationValue
;
1056 // now build setup packet
1057 RtlZeroMemory(&CtrlSetup
, sizeof(USB_DEFAULT_PIPE_SETUP_PACKET
));
1058 CtrlSetup
.bRequest
= USB_REQUEST_SET_CONFIGURATION
;
1059 CtrlSetup
.wValue
.W
= bConfigurationValue
;
1061 // select configuration
1062 Status
= CommitSetupPacket(&CtrlSetup
, NULL
, 0, NULL
);
1064 if (!ConfigurationDescriptor
)
1066 // unconfigure request
1067 DPRINT1("[%S] SelectConfiguration Unconfigure Request Status %lx\n", m_USBType
, Status
);
1068 m_ConfigurationIndex
= 0;
1072 // informal debug print
1073 DPRINT1("[%S] SelectConfiguration New Configuration %x Old Configuration %x Result %lx\n", m_USBType
, ConfigurationIndex
, m_ConfigurationIndex
, Status
);
1074 if (!NT_SUCCESS(Status
))
1082 // destroy old interface info
1083 while (!IsListEmpty(&m_ConfigurationDescriptors
[m_ConfigurationIndex
].InterfaceList
))
1086 Entry
= RemoveHeadList(&m_ConfigurationDescriptors
[m_ConfigurationIndex
].InterfaceList
);
1088 // get interface info
1089 UsbInterface
= (PUSB_INTERFACE
)CONTAINING_RECORD(Entry
, USB_INTERFACE
, ListEntry
);
1091 // free interface info
1092 ExFreePool(UsbInterface
);
1096 ASSERT(IsListEmpty(&m_ConfigurationDescriptors
[ConfigurationIndex
].InterfaceList
));
1098 // store new configuration device index
1099 m_ConfigurationIndex
= ConfigurationIndex
;
1101 // store configuration handle
1102 *ConfigurationHandle
= &m_ConfigurationDescriptors
[ConfigurationIndex
];
1104 // copy interface info and pipe info
1105 for(InterfaceIndex
= 0; InterfaceIndex
< ConfigurationDescriptor
->bNumInterfaces
; InterfaceIndex
++)
1107 // interface info checks
1108 ASSERT(InterfaceInfo
->Length
!= 0);
1111 PC_ASSERT(InterfaceInfo
->Length
== FIELD_OFFSET(USBD_INTERFACE_INFORMATION
, Pipes
[InterfaceInfo
->NumberOfPipes
]));
1114 // find interface descriptor
1115 InterfaceDescriptor
= USBD_ParseConfigurationDescriptor(m_ConfigurationDescriptors
[ConfigurationIndex
].ConfigurationDescriptor
, InterfaceInfo
->InterfaceNumber
, InterfaceInfo
->AlternateSetting
);
1118 ASSERT(InterfaceDescriptor
!= NULL
);
1120 // check if the number of pipes have been properly set
1121 ASSERT(InterfaceInfo
->NumberOfPipes
== InterfaceDescriptor
->bNumEndpoints
);
1123 // copy interface info
1124 Status
= BuildInterfaceDescriptor(ConfigurationIndex
, InterfaceDescriptor
, InterfaceInfo
, NULL
);
1125 if (!NT_SUCCESS(Status
))
1128 DPRINT1("[%S] Failed to copy interface descriptor Index %lu InterfaceDescriptor %p InterfaceInfo %p\n", m_USBType
, ConfigurationIndex
, InterfaceDescriptor
, InterfaceInfo
);
1133 InterfaceInfo
= (PUSBD_INTERFACE_INFORMATION
)((PUCHAR
)InterfaceInfo
+ InterfaceInfo
->Length
);
1142 //----------------------------------------------------------------------------------------
1144 CUSBDevice::SelectInterface(
1145 IN USBD_CONFIGURATION_HANDLE ConfigurationHandle
,
1146 IN OUT PUSBD_INTERFACE_INFORMATION InterfaceInfo
)
1149 USB_DEFAULT_PIPE_SETUP_PACKET CtrlSetup
;
1151 ULONG Index
, ConfigurationIndex
= 0, Found
= FALSE
;
1152 PUSB_INTERFACE UsbInterface
;
1154 PUSB_INTERFACE_DESCRIPTOR InterfaceDescriptor
;
1156 // check if handle is valid
1157 for(Index
= 0; Index
< m_DeviceDescriptor
.bNumConfigurations
; Index
++)
1159 if (&m_ConfigurationDescriptors
[Index
] == ConfigurationHandle
)
1161 // found configuration index
1162 ConfigurationIndex
= Index
;
1169 // invalid handle passed
1170 DPRINT1("[%S] Invalid configuration handle passed %p\n", m_USBType
, ConfigurationHandle
);
1171 return STATUS_INVALID_PARAMETER
;
1174 // initialize setup packet
1175 RtlZeroMemory(&CtrlSetup
, sizeof(USB_DEFAULT_PIPE_SETUP_PACKET
));
1176 CtrlSetup
.bRequest
= USB_REQUEST_SET_INTERFACE
;
1177 CtrlSetup
.wValue
.W
= InterfaceInfo
->AlternateSetting
;
1178 CtrlSetup
.wIndex
.W
= InterfaceInfo
->InterfaceNumber
;
1179 CtrlSetup
.bmRequestType
.B
= 0x01;
1182 Status
= CommitSetupPacket(&CtrlSetup
, NULL
, 0, NULL
);
1184 // informal debug print
1185 DPRINT1("[%S] SelectInterface AlternateSetting %x InterfaceNumber %x Status %lx\n", m_USBType
, InterfaceInfo
->AlternateSetting
, InterfaceInfo
->InterfaceNumber
, Status
);
1187 if (!NT_SUCCESS(Status
))
1189 // failed to select interface
1194 Status
= STATUS_SUCCESS
;
1198 Entry
= m_ConfigurationDescriptors
[ConfigurationIndex
].InterfaceList
.Flink
;
1199 while (Entry
!= &m_ConfigurationDescriptors
[ConfigurationIndex
].InterfaceList
)
1201 // grab interface descriptor
1202 UsbInterface
= (PUSB_INTERFACE
)CONTAINING_RECORD(Entry
, USB_INTERFACE
, ListEntry
);
1203 if (UsbInterface
->InterfaceDescriptor
->bAlternateSetting
== InterfaceInfo
->AlternateSetting
&&
1204 UsbInterface
->InterfaceDescriptor
->bInterfaceNumber
== InterfaceInfo
->InterfaceNumber
)
1212 Entry
= Entry
->Flink
;
1217 // find interface descriptor
1218 InterfaceDescriptor
= USBD_ParseConfigurationDescriptor(m_ConfigurationDescriptors
[ConfigurationIndex
].ConfigurationDescriptor
, InterfaceInfo
->InterfaceNumber
, InterfaceInfo
->AlternateSetting
);
1219 if (!InterfaceDescriptor
)
1221 DPRINT1("[%S] No such interface Alternate %x InterfaceNumber %x\n", m_USBType
, InterfaceInfo
->AlternateSetting
, InterfaceInfo
->InterfaceNumber
);
1222 return STATUS_UNSUCCESSFUL
;
1225 // build interface descriptor
1226 Status
= BuildInterfaceDescriptor(ConfigurationIndex
, InterfaceDescriptor
, InterfaceInfo
, &UsbInterface
);
1227 if (!NT_SUCCESS(Status
))
1230 DPRINT1("[%S] Failed to build interface descriptor Status %x\n", m_USBType
, Status
);
1235 // assert on pipe length mismatch
1236 DPRINT1("NumberOfPipes %lu Endpoints %lu Length %lu\n", InterfaceInfo
->NumberOfPipes
, UsbInterface
->InterfaceDescriptor
->bNumEndpoints
, InterfaceInfo
->Length
);
1239 ASSERT(GET_USBD_INTERFACE_SIZE(UsbInterface
->InterfaceDescriptor
->bNumEndpoints
) == InterfaceInfo
->Length
);
1241 // store number of pipes
1242 InterfaceInfo
->NumberOfPipes
= UsbInterface
->InterfaceDescriptor
->bNumEndpoints
;
1244 // copy pipe handles
1245 for (PipeIndex
= 0; PipeIndex
< UsbInterface
->InterfaceDescriptor
->bNumEndpoints
; PipeIndex
++)
1248 DPRINT1("PipeIndex %lu\n", PipeIndex
);
1249 DPRINT1("EndpointAddress %x\n", InterfaceInfo
->Pipes
[PipeIndex
].EndpointAddress
);
1250 DPRINT1("Interval %c\n", InterfaceInfo
->Pipes
[PipeIndex
].Interval
);
1251 DPRINT1("MaximumPacketSize %hu\n", InterfaceInfo
->Pipes
[PipeIndex
].MaximumPacketSize
);
1252 DPRINT1("MaximumTransferSize %lu\n", InterfaceInfo
->Pipes
[PipeIndex
].MaximumTransferSize
);
1253 DPRINT1("PipeFlags %lu\n", InterfaceInfo
->Pipes
[PipeIndex
].PipeFlags
);
1254 DPRINT1("PipeType %d\n", InterfaceInfo
->Pipes
[PipeIndex
].PipeType
);
1255 DPRINT1("UsbEndPoint %x\n", InterfaceInfo
->Pipes
[PipeIndex
].EndpointAddress
);
1258 ASSERT(InterfaceInfo
->Pipes
[PipeIndex
].EndpointAddress
== UsbInterface
->EndPoints
[PipeIndex
].EndPointDescriptor
.bEndpointAddress
);
1259 ASSERT(InterfaceInfo
->Pipes
[PipeIndex
].Interval
== UsbInterface
->EndPoints
[PipeIndex
].EndPointDescriptor
.bInterval
);
1261 // store pipe handle
1262 InterfaceInfo
->Pipes
[PipeIndex
].PipeHandle
= &UsbInterface
->EndPoints
[PipeIndex
];
1264 // data toggle is reset on select interface requests
1265 UsbInterface
->EndPoints
[PipeIndex
].DataToggle
= FALSE
;
1275 CUSBDevice::AbortPipe(
1276 IN PUSB_ENDPOINT_DESCRIPTOR EndpointDescriptor
)
1279 // let it handle usb queue
1282 ASSERT(m_DeviceAddress
);
1287 return m_Queue
->AbortDevicePipe(m_DeviceAddress
, EndpointDescriptor
);
1291 CUSBDevice::GetMaxPacketSize()
1293 return m_DeviceDescriptor
.bMaxPacketSize0
;
1297 //----------------------------------------------------------------------------------------
1301 PUSBDEVICE
*OutDevice
)
1306 // allocate controller
1308 This
= new(NonPagedPool
, TAG_USBLIB
) CUSBDevice(0);
1312 // failed to allocate
1314 return STATUS_INSUFFICIENT_RESOURCES
;
1318 // add reference count
1325 *OutDevice
= (PUSBDEVICE
)This
;
1330 return STATUS_SUCCESS
;