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
;
90 PUSB_CONFIGURATION m_ConfigurationDescriptors
;
93 //----------------------------------------------------------------------------------------
96 CUSBDevice::QueryInterface(
100 return STATUS_UNSUCCESSFUL
;
103 //----------------------------------------------------------------------------------------
105 CUSBDevice::Initialize(
106 IN PHUBCONTROLLER HubController
,
107 IN PUSBHARDWAREDEVICE Device
,
115 // initialize members
117 m_HubController
= HubController
;
121 m_PortStatus
= PortStatus
;
124 // initialize device lock
126 KeInitializeSpinLock(&m_Lock
);
129 // no device address has been set yet
134 // get usb request queue
136 Status
= m_Device
->GetUSBQueue(&m_Queue
);
137 if (!NT_SUCCESS(Status
))
140 // failed to get usb queue
142 DPRINT1("CUSBDevice::Initialize GetUsbQueue failed with %x\n", Status
);
149 Status
= m_Device
->GetDMA(&m_DmaManager
);
150 if (!NT_SUCCESS(Status
))
153 // failed to get dma manager
155 DPRINT1("CUSBDevice::Initialize GetDMA failed with %x\n", Status
);
162 PC_ASSERT(m_DmaManager
);
165 // get device descriptor
167 Status
= CreateDeviceDescriptor();
168 if (!NT_SUCCESS(Status
))
171 // failed to get device descriptor
173 DPRINT1("CUSBDevice::Initialize Failed to get device descriptor with %x\n", Status
);
183 //----------------------------------------------------------------------------------------
188 // USB Standard Device Class see http://www.usb.org/developers/defined_class/#BaseClass09h
191 return (m_DeviceDescriptor
.bDeviceClass
== 0x09 && m_DeviceDescriptor
.bDeviceSubClass
== 0x00);
194 //----------------------------------------------------------------------------------------
196 CUSBDevice::GetParent(
207 return STATUS_SUCCESS
;
210 //----------------------------------------------------------------------------------------
212 CUSBDevice::GetDeviceAddress()
215 // get device address
217 return m_DeviceAddress
;
220 //----------------------------------------------------------------------------------------
222 CUSBDevice::GetPort()
225 // get port to which this device is connected to
230 //----------------------------------------------------------------------------------------
232 CUSBDevice::GetSpeed()
234 if (m_PortStatus
& USB_PORT_STATUS_LOW_SPEED
)
241 else if (m_PortStatus
& USB_PORT_STATUS_HIGH_SPEED
)
250 // default to full speed
255 //----------------------------------------------------------------------------------------
257 CUSBDevice::GetType()
260 // device is encoded into bcdUSB
262 if (m_DeviceDescriptor
.bcdUSB
== 0x110)
269 else if (m_DeviceDescriptor
.bcdUSB
== 0x200)
277 DPRINT1("CUSBDevice::GetType Unknown bcdUSB Type %x\n", m_DeviceDescriptor
.bcdUSB
);
283 //----------------------------------------------------------------------------------------
285 CUSBDevice::GetState()
291 //----------------------------------------------------------------------------------------
293 CUSBDevice::SetDeviceHandleData(
297 // set device data, for debugging issues
302 //----------------------------------------------------------------------------------------
304 CUSBDevice::SetDeviceAddress(
307 PUSB_DEFAULT_PIPE_SETUP_PACKET CtrlSetup
;
312 DPRINT1("CUSBDevice::SetDeviceAddress> Address %x\n", DeviceAddress
);
314 CtrlSetup
= (PUSB_DEFAULT_PIPE_SETUP_PACKET
)ExAllocatePoolWithTag(NonPagedPool
, sizeof(USB_DEFAULT_PIPE_SETUP_PACKET
), TAG_USBLIB
);
316 return STATUS_INSUFFICIENT_RESOURCES
;
319 RtlZeroMemory(CtrlSetup
, sizeof(USB_DEFAULT_PIPE_SETUP_PACKET
));
321 // initialize request
322 CtrlSetup
->bRequest
= USB_REQUEST_SET_ADDRESS
;
323 CtrlSetup
->wValue
.W
= DeviceAddress
;
325 // set device address
326 Status
= CommitSetupPacket(CtrlSetup
, NULL
, 0, NULL
);
329 ExFreePoolWithTag(CtrlSetup
, TAG_USBLIB
);
332 if (!NT_SUCCESS(Status
))
334 // failed to set device address
335 DPRINT1("CUSBDevice::SetDeviceAddress> failed to set device address with %lx Address %x\n", Status
, DeviceAddress
);
339 // lets have a short nap
340 KeStallExecutionProcessor(300);
342 // back up old address
343 OldAddress
= m_DeviceAddress
;
345 // store new device address
346 m_DeviceAddress
= DeviceAddress
;
348 // fetch device descriptor
349 Status
= CreateDeviceDescriptor();
350 if (!NT_SUCCESS(Status
))
352 DPRINT1("CUSBDevice::SetDeviceAddress> failed to retrieve device descriptor with device address set Error %lx\n", Status
);
353 // return error status
357 // check for invalid device descriptor
358 if (m_DeviceDescriptor
.bLength
!= sizeof(USB_DEVICE_DESCRIPTOR
) ||
359 m_DeviceDescriptor
.bDescriptorType
!= USB_DEVICE_DESCRIPTOR_TYPE
||
360 m_DeviceDescriptor
.bNumConfigurations
== 0)
362 // failed to retrieve device descriptor
363 DPRINT1("CUSBDevice::SetDeviceAddress> device returned bogus device descriptor\n");
364 DumpDeviceDescriptor(&m_DeviceDescriptor
);
366 // return error status
367 return STATUS_UNSUCCESSFUL
;
370 // dump device descriptor
371 DumpDeviceDescriptor(&m_DeviceDescriptor
);
374 PC_ASSERT(m_DeviceDescriptor
.bNumConfigurations
);
376 // allocate configuration descriptor
377 m_ConfigurationDescriptors
= (PUSB_CONFIGURATION
) ExAllocatePoolWithTag(NonPagedPool
, sizeof(USB_CONFIGURATION
) * m_DeviceDescriptor
.bNumConfigurations
, TAG_USBLIB
);
379 // zero configuration descriptor
380 RtlZeroMemory(m_ConfigurationDescriptors
, sizeof(USB_CONFIGURATION
) * m_DeviceDescriptor
.bNumConfigurations
);
382 // retrieve the configuration descriptors
383 for (Index
= 0; Index
< m_DeviceDescriptor
.bNumConfigurations
; Index
++)
385 // retrieve configuration descriptors from device
386 Status
= CreateConfigurationDescriptor(Index
);
387 if (!NT_SUCCESS(Status
))
389 DPRINT1("CUSBDevice::SetDeviceAddress> failed to retrieve configuration %lu\n", Index
);
401 //----------------------------------------------------------------------------------------
403 CUSBDevice::GetDeviceDescriptor(
404 PUSB_DEVICE_DESCRIPTOR DeviceDescriptor
)
406 RtlMoveMemory(DeviceDescriptor
, &m_DeviceDescriptor
, sizeof(USB_DEVICE_DESCRIPTOR
));
409 //----------------------------------------------------------------------------------------
411 CUSBDevice::GetConfigurationValue()
414 // return configuration index
416 return m_ConfigurationIndex
;
419 //----------------------------------------------------------------------------------------
421 CUSBDevice::CommitIrp(
427 if (!m_Queue
|| !m_DmaManager
)
432 DPRINT1("CUSBDevice::CommitIrp> no queue / dma !!!\n");
433 return STATUS_UNSUCCESSFUL
;
439 Status
= m_Queue
->CreateUSBRequest(&Request
);
440 if (!NT_SUCCESS(Status
))
443 // failed to build request
445 DPRINT1("CUSBDevice::CommitIrp> CreateUSBRequest failed with %lx\n", Status
);
450 // initialize request
452 Status
= Request
->InitializeWithIrp(m_DmaManager
, PUSBDEVICE(this), Irp
);
455 // mark irp as pending
457 IoMarkIrpPending(Irp
);
460 // now add the request
462 Status
= m_Queue
->AddUSBRequest(Request
);
463 if (!NT_SUCCESS(Status
))
466 // failed to add request
468 DPRINT1("CUSBDevice::CommitIrp> failed add request to queue with %lx\n", Status
);
476 return STATUS_PENDING
;
479 //----------------------------------------------------------------------------------------
481 CUSBDevice::SubmitIrp(
488 // acquire device lock
490 KeAcquireSpinLock(&m_Lock
, &OldLevel
);
495 Status
= CommitIrp(Irp
);
500 KeReleaseSpinLock(&m_Lock
, OldLevel
);
505 //----------------------------------------------------------------------------------------
507 CUSBDevice::CommitSetupPacket(
508 IN PUSB_DEFAULT_PIPE_SETUP_PACKET Packet
,
509 IN OPTIONAL PUSB_ENDPOINT EndpointDescriptor
,
510 IN ULONG BufferLength
,
521 DPRINT1("CUSBDevice::CommitSetupPacket> no queue!!!\n");
522 return STATUS_UNSUCCESSFUL
;
528 Status
= m_Queue
->CreateUSBRequest(&Request
);
529 if (!NT_SUCCESS(Status
))
532 // failed to build request
534 DPRINT1("CUSBDevice::CommitSetupPacket> CreateUSBRequest failed with %x\n", Status
);
539 // initialize request
541 Status
= Request
->InitializeWithSetupPacket(m_DmaManager
, Packet
, PUSBDEVICE(this), EndpointDescriptor
, BufferLength
, Mdl
);
542 if (!NT_SUCCESS(Status
))
545 // failed to initialize request
547 DPRINT1("CUSBDevice::CommitSetupPacket> failed to initialize usb request with %x\n", Status
);
553 // now add the request
555 Status
= m_Queue
->AddUSBRequest(Request
);
556 if (!NT_SUCCESS(Status
))
559 // failed to add request
561 DPRINT1("CUSBDevice::CommitSetupPacket> failed add request to queue with %x\n", Status
);
567 // get the result code when the operation has been finished
569 Request
->GetResultStatus(&Status
, NULL
);
582 //----------------------------------------------------------------------------------------
584 CUSBDevice::CreateDeviceDescriptor()
586 USB_DEFAULT_PIPE_SETUP_PACKET CtrlSetup
;
594 RtlZeroMemory(&m_DeviceDescriptor
, sizeof(USB_DEVICE_DESCRIPTOR
));
595 RtlZeroMemory(&CtrlSetup
, sizeof(USB_DEFAULT_PIPE_SETUP_PACKET
));
600 CtrlSetup
.bRequest
= USB_REQUEST_GET_DESCRIPTOR
;
601 CtrlSetup
.wValue
.HiByte
= USB_DEVICE_DESCRIPTOR_TYPE
;
602 CtrlSetup
.wLength
= sizeof(USB_DEVICE_DESCRIPTOR
);
603 CtrlSetup
.bmRequestType
.B
= 0x80;
608 Buffer
= ExAllocatePool(NonPagedPool
, PAGE_SIZE
);
612 // failed to allocate
614 return STATUS_INSUFFICIENT_RESOURCES
;
620 RtlZeroMemory(Buffer
, PAGE_SIZE
);
623 // allocate mdl describing the device descriptor
625 Mdl
= IoAllocateMdl(Buffer
, sizeof(USB_DEVICE_DESCRIPTOR
), FALSE
, FALSE
, 0);
629 // failed to allocate mdl
631 return STATUS_INSUFFICIENT_RESOURCES
;
635 // build mdl for non paged pool
637 MmBuildMdlForNonPagedPool(Mdl
);
640 // commit setup packet
642 Status
= CommitSetupPacket(&CtrlSetup
, NULL
, sizeof(USB_DEVICE_DESCRIPTOR
), Mdl
);
649 if (NT_SUCCESS(Status
))
652 // copy device descriptor
654 RtlCopyMemory(&m_DeviceDescriptor
, Buffer
, sizeof(USB_DEVICE_DESCRIPTOR
));
669 //----------------------------------------------------------------------------------------
671 CUSBDevice::GetConfigurationDescriptor(
672 IN UCHAR ConfigurationIndex
,
673 IN USHORT BufferSize
,
676 USB_DEFAULT_PIPE_SETUP_PACKET CtrlSetup
;
682 // now build MDL describing the buffer
684 Mdl
= IoAllocateMdl(Buffer
, BufferSize
, FALSE
, FALSE
, 0);
688 // failed to allocate mdl
690 return STATUS_INSUFFICIENT_RESOURCES
;
694 // build mdl for non paged pool
696 MmBuildMdlForNonPagedPool(Mdl
);
700 // build setup packet
702 CtrlSetup
.bmRequestType
._BM
.Recipient
= BMREQUEST_TO_DEVICE
;
703 CtrlSetup
.bmRequestType
._BM
.Type
= BMREQUEST_STANDARD
;
704 CtrlSetup
.bmRequestType
._BM
.Reserved
= 0;
705 CtrlSetup
.bmRequestType
._BM
.Dir
= BMREQUEST_DEVICE_TO_HOST
;
706 CtrlSetup
.bRequest
= USB_REQUEST_GET_DESCRIPTOR
;
707 CtrlSetup
.wValue
.LowByte
= ConfigurationIndex
;
708 CtrlSetup
.wValue
.HiByte
= USB_CONFIGURATION_DESCRIPTOR_TYPE
;
709 CtrlSetup
.wIndex
.W
= 0;
710 CtrlSetup
.wLength
= BufferSize
;
715 Status
= CommitSetupPacket(&CtrlSetup
, NULL
, BufferSize
, Mdl
);
728 //----------------------------------------------------------------------------------------
730 CUSBDevice::CreateConfigurationDescriptor(
734 PUSB_CONFIGURATION_DESCRIPTOR ConfigurationDescriptor
;
739 PC_ASSERT(m_ConfigurationDescriptors
);
742 // first allocate a buffer which should be enough to store all different interfaces and endpoints
744 ConfigurationDescriptor
= (PUSB_CONFIGURATION_DESCRIPTOR
)ExAllocatePoolWithTag(NonPagedPool
, PAGE_SIZE
, TAG_USBLIB
);
745 if (!ConfigurationDescriptor
)
748 // failed to allocate buffer
750 return STATUS_INSUFFICIENT_RESOURCES
;
754 // get partial configuration descriptor
756 Status
= GetConfigurationDescriptor(Index
, sizeof(USB_CONFIGURATION_DESCRIPTOR
), ConfigurationDescriptor
);
757 if (!NT_SUCCESS(Status
))
760 // failed to get partial configuration descriptor
762 DPRINT1("[USBLIB] Failed to get partial configuration descriptor Status %x Index %x\n", Status
, Index
);
763 ExFreePoolWithTag(ConfigurationDescriptor
, TAG_USBLIB
);
768 // now get full descriptor
770 Status
= GetConfigurationDescriptor(Index
, ConfigurationDescriptor
->wTotalLength
, ConfigurationDescriptor
);
771 if (!NT_SUCCESS(Status
))
774 // failed to get full configuration descriptor
776 DPRINT1("[USBLIB] Failed to get full configuration descriptor Status %x Index %x\n", Status
, Index
);
777 ExFreePoolWithTag(ConfigurationDescriptor
, TAG_USBLIB
);
782 // informal debug print
784 DumpConfigurationDescriptor(ConfigurationDescriptor
);
789 PC_ASSERT(ConfigurationDescriptor
->bLength
== sizeof(USB_CONFIGURATION_DESCRIPTOR
));
790 PC_ASSERT(ConfigurationDescriptor
->wTotalLength
<= PAGE_SIZE
);
791 PC_ASSERT(ConfigurationDescriptor
->bNumInterfaces
);
794 // request is complete, initialize configuration descriptor
796 m_ConfigurationDescriptors
[Index
].ConfigurationDescriptor
= ConfigurationDescriptor
;
797 InitializeListHead(&m_ConfigurationDescriptors
[Index
].InterfaceList
);
804 //----------------------------------------------------------------------------------------
806 CUSBDevice::GetConfigurationDescriptors(
807 IN PUSB_CONFIGURATION_DESCRIPTOR ConfigDescriptorBuffer
,
808 IN ULONG BufferLength
,
809 OUT PULONG OutBufferLength
)
814 ASSERT(BufferLength
>= sizeof(USB_CONFIGURATION_DESCRIPTOR
));
815 ASSERT(ConfigDescriptorBuffer
);
816 ASSERT(OutBufferLength
);
818 // reset copied length
819 *OutBufferLength
= 0;
821 // FIXME: support multiple configurations
822 PC_ASSERT(m_DeviceDescriptor
.bNumConfigurations
== 1);
824 // copy configuration descriptor
825 Length
= min(m_ConfigurationDescriptors
[0].ConfigurationDescriptor
->wTotalLength
, BufferLength
);
826 RtlCopyMemory(ConfigDescriptorBuffer
, m_ConfigurationDescriptors
[0].ConfigurationDescriptor
, Length
);
827 *OutBufferLength
= Length
;
830 //----------------------------------------------------------------------------------------
832 CUSBDevice::GetConfigurationDescriptorsLength()
835 // FIXME: support multiple configurations
837 PC_ASSERT(m_DeviceDescriptor
.bNumConfigurations
== 1);
839 return m_ConfigurationDescriptors
[0].ConfigurationDescriptor
->wTotalLength
;
841 //----------------------------------------------------------------------------------------
843 CUSBDevice::DumpDeviceDescriptor(PUSB_DEVICE_DESCRIPTOR DeviceDescriptor
)
845 DPRINT1("Dumping Device Descriptor %x\n", DeviceDescriptor
);
846 DPRINT1("bLength %x\n", DeviceDescriptor
->bLength
);
847 DPRINT1("bDescriptorType %x\n", DeviceDescriptor
->bDescriptorType
);
848 DPRINT1("bcdUSB %x\n", DeviceDescriptor
->bcdUSB
);
849 DPRINT1("bDeviceClass %x\n", DeviceDescriptor
->bDeviceClass
);
850 DPRINT1("bDeviceSubClass %x\n", DeviceDescriptor
->bDeviceSubClass
);
851 DPRINT1("bDeviceProtocol %x\n", DeviceDescriptor
->bDeviceProtocol
);
852 DPRINT1("bMaxPacketSize0 %x\n", DeviceDescriptor
->bMaxPacketSize0
);
853 DPRINT1("idVendor %x\n", DeviceDescriptor
->idVendor
);
854 DPRINT1("idProduct %x\n", DeviceDescriptor
->idProduct
);
855 DPRINT1("bcdDevice %x\n", DeviceDescriptor
->bcdDevice
);
856 DPRINT1("iManufacturer %x\n", DeviceDescriptor
->iManufacturer
);
857 DPRINT1("iProduct %x\n", DeviceDescriptor
->iProduct
);
858 DPRINT1("iSerialNumber %x\n", DeviceDescriptor
->iSerialNumber
);
859 DPRINT1("bNumConfigurations %x\n", DeviceDescriptor
->bNumConfigurations
);
862 //----------------------------------------------------------------------------------------
864 CUSBDevice::DumpConfigurationDescriptor(PUSB_CONFIGURATION_DESCRIPTOR ConfigurationDescriptor
)
866 DPRINT1("Dumping ConfigurationDescriptor %x\n", ConfigurationDescriptor
);
867 DPRINT1("bLength %x\n", ConfigurationDescriptor
->bLength
);
868 DPRINT1("bDescriptorType %x\n", ConfigurationDescriptor
->bDescriptorType
);
869 DPRINT1("wTotalLength %x\n", ConfigurationDescriptor
->wTotalLength
);
870 DPRINT1("bNumInterfaces %x\n", ConfigurationDescriptor
->bNumInterfaces
);
871 DPRINT1("bConfigurationValue %x\n", ConfigurationDescriptor
->bConfigurationValue
);
872 DPRINT1("iConfiguration %x\n", ConfigurationDescriptor
->iConfiguration
);
873 DPRINT1("bmAttributes %x\n", ConfigurationDescriptor
->bmAttributes
);
874 DPRINT1("MaxPower %x\n", ConfigurationDescriptor
->MaxPower
);
876 //----------------------------------------------------------------------------------------
878 CUSBDevice::SubmitSetupPacket(
879 IN PUSB_DEFAULT_PIPE_SETUP_PACKET SetupPacket
,
880 IN OUT ULONG BufferLength
,
891 Mdl
= IoAllocateMdl(Buffer
, BufferLength
, FALSE
, FALSE
, 0);
897 return STATUS_INSUFFICIENT_RESOURCES
;
901 // HACK HACK HACK: assume the buffer is build from non paged pool
903 MmBuildMdlForNonPagedPool(Mdl
);
907 // commit setup packet
909 Status
= CommitSetupPacket(SetupPacket
, NULL
, BufferLength
, Mdl
);
924 //----------------------------------------------------------------------------------------
926 CUSBDevice::BuildInterfaceDescriptor(
927 IN ULONG ConfigurationIndex
,
928 IN PUSB_INTERFACE_DESCRIPTOR InterfaceDescriptor
,
929 OUT PUSBD_INTERFACE_INFORMATION InterfaceInfo
,
930 OUT PUSB_INTERFACE
*OutUsbInterface
)
932 PUSB_INTERFACE UsbInterface
;
933 PUSB_ENDPOINT_DESCRIPTOR EndpointDescriptor
;
936 // allocate interface handle
937 UsbInterface
= (PUSB_INTERFACE
)ExAllocatePool(NonPagedPool
, sizeof(USB_INTERFACE
) + (InterfaceDescriptor
->bNumEndpoints
- 1) * sizeof(USB_ENDPOINT
));
940 // failed to allocate memory
941 return STATUS_INSUFFICIENT_RESOURCES
;
945 RtlZeroMemory(UsbInterface
, sizeof(USB_INTERFACE
) + (InterfaceDescriptor
->bNumEndpoints
- 1) * sizeof(USB_ENDPOINT
));
948 InterfaceInfo
->InterfaceHandle
= (USBD_INTERFACE_HANDLE
)UsbInterface
;
949 InterfaceInfo
->Class
= InterfaceDescriptor
->bInterfaceClass
;
950 InterfaceInfo
->SubClass
= InterfaceDescriptor
->bInterfaceSubClass
;
951 InterfaceInfo
->Protocol
= InterfaceDescriptor
->bInterfaceProtocol
;
952 InterfaceInfo
->Reserved
= 0;
955 // init interface handle
956 UsbInterface
->InterfaceDescriptor
= InterfaceDescriptor
;
957 InsertTailList(&m_ConfigurationDescriptors
[ConfigurationIndex
].InterfaceList
, &UsbInterface
->ListEntry
);
959 // grab first endpoint descriptor
960 EndpointDescriptor
= (PUSB_ENDPOINT_DESCRIPTOR
) (InterfaceDescriptor
+ 1);
962 // now copy all endpoint information
963 for(PipeIndex
= 0; PipeIndex
< InterfaceDescriptor
->bNumEndpoints
; PipeIndex
++)
965 while(EndpointDescriptor
->bDescriptorType
!= USB_ENDPOINT_DESCRIPTOR_TYPE
)
967 // skip intermediate descriptors
968 if (EndpointDescriptor
->bLength
== 0 || EndpointDescriptor
->bDescriptorType
== USB_INTERFACE_DESCRIPTOR_TYPE
)
970 // bogus configuration descriptor
971 DPRINT1("[USBLIB] Bogus descriptor found in InterfaceNumber %x Alternate %x EndpointIndex %x bLength %x bDescriptorType %x\n", InterfaceDescriptor
->bInterfaceNumber
, InterfaceDescriptor
->bAlternateSetting
, PipeIndex
,
972 EndpointDescriptor
->bLength
, EndpointDescriptor
->bDescriptorType
);
975 return STATUS_UNSUCCESSFUL
;
978 // move to next descriptor
979 EndpointDescriptor
= (PUSB_ENDPOINT_DESCRIPTOR
)((ULONG_PTR
)EndpointDescriptor
+ EndpointDescriptor
->bLength
);
982 // store in interface info
983 RtlCopyMemory(&UsbInterface
->EndPoints
[PipeIndex
].EndPointDescriptor
, EndpointDescriptor
, sizeof(USB_ENDPOINT_DESCRIPTOR
));
985 DPRINT("Configuration Descriptor %p Length %lu\n", m_ConfigurationDescriptors
[ConfigurationIndex
].ConfigurationDescriptor
, m_ConfigurationDescriptors
[ConfigurationIndex
].ConfigurationDescriptor
->wTotalLength
);
986 DPRINT("EndpointDescriptor %p DescriptorType %x bLength %x\n", EndpointDescriptor
, EndpointDescriptor
->bDescriptorType
, EndpointDescriptor
->bLength
);
987 DPRINT("EndpointDescriptorHandle %p bAddress %x bmAttributes %x\n",&UsbInterface
->EndPoints
[PipeIndex
], UsbInterface
->EndPoints
[PipeIndex
].EndPointDescriptor
.bEndpointAddress
,
988 UsbInterface
->EndPoints
[PipeIndex
].EndPointDescriptor
.bmAttributes
);
991 InterfaceInfo
->Pipes
[PipeIndex
].MaximumPacketSize
= UsbInterface
->EndPoints
[PipeIndex
].EndPointDescriptor
.wMaxPacketSize
;
992 InterfaceInfo
->Pipes
[PipeIndex
].EndpointAddress
= UsbInterface
->EndPoints
[PipeIndex
].EndPointDescriptor
.bEndpointAddress
;
993 InterfaceInfo
->Pipes
[PipeIndex
].Interval
= UsbInterface
->EndPoints
[PipeIndex
].EndPointDescriptor
.bInterval
;
994 InterfaceInfo
->Pipes
[PipeIndex
].PipeType
= (USBD_PIPE_TYPE
)UsbInterface
->EndPoints
[PipeIndex
].EndPointDescriptor
.bmAttributes
;
995 InterfaceInfo
->Pipes
[PipeIndex
].PipeHandle
= (PVOID
)&UsbInterface
->EndPoints
[PipeIndex
];
997 // move to next descriptor
998 EndpointDescriptor
= (PUSB_ENDPOINT_DESCRIPTOR
)((ULONG_PTR
)EndpointDescriptor
+ EndpointDescriptor
->bLength
);
1001 if (OutUsbInterface
)
1004 *OutUsbInterface
= UsbInterface
;
1006 return STATUS_SUCCESS
;
1011 //----------------------------------------------------------------------------------------
1013 CUSBDevice::SelectConfiguration(
1014 IN PUSB_CONFIGURATION_DESCRIPTOR ConfigurationDescriptor
,
1015 IN PUSBD_INTERFACE_INFORMATION InterfaceInfo
,
1016 OUT USBD_CONFIGURATION_HANDLE
*ConfigurationHandle
)
1018 ULONG InterfaceIndex
;
1019 USB_DEFAULT_PIPE_SETUP_PACKET CtrlSetup
;
1021 UCHAR bConfigurationValue
= 0;
1022 ULONG ConfigurationIndex
= 0, Index
;
1023 UCHAR Found
= FALSE
;
1024 PUSB_INTERFACE_DESCRIPTOR InterfaceDescriptor
;
1025 PUSB_INTERFACE UsbInterface
;
1028 if (ConfigurationDescriptor
)
1030 // find configuration index
1031 for (Index
= 0; Index
< m_DeviceDescriptor
.bNumConfigurations
; Index
++)
1033 if (m_ConfigurationDescriptors
[Index
].ConfigurationDescriptor
->bConfigurationValue
== ConfigurationDescriptor
->bConfigurationValue
)
1035 // found configuration index
1036 ConfigurationIndex
= Index
;
1043 DPRINT1("[USBLIB] invalid configuration value %u\n", ConfigurationDescriptor
->bConfigurationValue
);
1044 return STATUS_INVALID_PARAMETER
;
1048 ASSERT(ConfigurationDescriptor
->bNumInterfaces
<= m_ConfigurationDescriptors
[ConfigurationIndex
].ConfigurationDescriptor
->bNumInterfaces
);
1050 // get configuration value
1051 bConfigurationValue
= ConfigurationDescriptor
->bConfigurationValue
;
1054 // now build setup packet
1055 RtlZeroMemory(&CtrlSetup
, sizeof(USB_DEFAULT_PIPE_SETUP_PACKET
));
1056 CtrlSetup
.bRequest
= USB_REQUEST_SET_CONFIGURATION
;
1057 CtrlSetup
.wValue
.W
= bConfigurationValue
;
1059 // select configuration
1060 Status
= CommitSetupPacket(&CtrlSetup
, NULL
, 0, NULL
);
1062 if (!ConfigurationDescriptor
)
1064 // unconfigure request
1065 DPRINT1("CUSBDevice::SelectConfiguration Unconfigure Request Status %lx\n", Status
);
1066 m_ConfigurationIndex
= 0;
1070 // informal debug print
1071 DPRINT1("CUSBDevice::SelectConfiguration New Configuration %x Old Configuration %x Result %lx\n", ConfigurationIndex
, m_ConfigurationIndex
, Status
);
1072 if (!NT_SUCCESS(Status
))
1080 // destroy old interface info
1081 while (!IsListEmpty(&m_ConfigurationDescriptors
[m_ConfigurationIndex
].InterfaceList
))
1084 Entry
= RemoveHeadList(&m_ConfigurationDescriptors
[m_ConfigurationIndex
].InterfaceList
);
1086 // get interface info
1087 UsbInterface
= (PUSB_INTERFACE
)CONTAINING_RECORD(Entry
, USB_INTERFACE
, ListEntry
);
1089 // free interface info
1090 ExFreePool(UsbInterface
);
1094 ASSERT(IsListEmpty(&m_ConfigurationDescriptors
[ConfigurationIndex
].InterfaceList
));
1096 // store new configuration device index
1097 m_ConfigurationIndex
= ConfigurationIndex
;
1099 // store configuration handle
1100 *ConfigurationHandle
= &m_ConfigurationDescriptors
[ConfigurationIndex
];
1102 // copy interface info and pipe info
1103 for(InterfaceIndex
= 0; InterfaceIndex
< ConfigurationDescriptor
->bNumInterfaces
; InterfaceIndex
++)
1105 // interface info checks
1106 ASSERT(InterfaceInfo
->Length
!= 0);
1109 PC_ASSERT(InterfaceInfo
->Length
== FIELD_OFFSET(USBD_INTERFACE_INFORMATION
, Pipes
[InterfaceInfo
->NumberOfPipes
]));
1112 // find interface descriptor
1113 InterfaceDescriptor
= USBD_ParseConfigurationDescriptor(m_ConfigurationDescriptors
[ConfigurationIndex
].ConfigurationDescriptor
, InterfaceInfo
->InterfaceNumber
, InterfaceInfo
->AlternateSetting
);
1116 ASSERT(InterfaceDescriptor
!= NULL
);
1118 // check if the number of pipes have been properly set
1119 ASSERT(InterfaceInfo
->NumberOfPipes
== InterfaceDescriptor
->bNumEndpoints
);
1121 // copy interface info
1122 Status
= BuildInterfaceDescriptor(ConfigurationIndex
, InterfaceDescriptor
, InterfaceInfo
, NULL
);
1123 if (!NT_SUCCESS(Status
))
1126 DPRINT1("[LIBUSB] Failed to copy interface descriptor Index %lu InterfaceDescriptor %p InterfaceInfo %p\n", ConfigurationIndex
, InterfaceDescriptor
, InterfaceInfo
);
1131 InterfaceInfo
= (PUSBD_INTERFACE_INFORMATION
)((PUCHAR
)InterfaceInfo
+ InterfaceInfo
->Length
);
1140 //----------------------------------------------------------------------------------------
1142 CUSBDevice::SelectInterface(
1143 IN USBD_CONFIGURATION_HANDLE ConfigurationHandle
,
1144 IN OUT PUSBD_INTERFACE_INFORMATION InterfaceInfo
)
1147 USB_DEFAULT_PIPE_SETUP_PACKET CtrlSetup
;
1149 ULONG Index
, ConfigurationIndex
= 0, Found
= FALSE
;
1150 PUSB_INTERFACE UsbInterface
;
1152 PUSB_INTERFACE_DESCRIPTOR InterfaceDescriptor
;
1154 // check if handle is valid
1155 for(Index
= 0; Index
< m_DeviceDescriptor
.bNumConfigurations
; Index
++)
1157 if (&m_ConfigurationDescriptors
[Index
] == ConfigurationHandle
)
1159 // found configuration index
1160 ConfigurationIndex
= Index
;
1167 // invalid handle passed
1168 DPRINT1("[USBLIB] Invalid configuration handle passed %p\n", ConfigurationHandle
);
1169 return STATUS_INVALID_PARAMETER
;
1172 // initialize setup packet
1173 RtlZeroMemory(&CtrlSetup
, sizeof(USB_DEFAULT_PIPE_SETUP_PACKET
));
1174 CtrlSetup
.bRequest
= USB_REQUEST_SET_INTERFACE
;
1175 CtrlSetup
.wValue
.W
= InterfaceInfo
->AlternateSetting
;
1176 CtrlSetup
.wIndex
.W
= InterfaceInfo
->InterfaceNumber
;
1177 CtrlSetup
.bmRequestType
.B
= 0x01;
1180 Status
= CommitSetupPacket(&CtrlSetup
, NULL
, 0, NULL
);
1182 // informal debug print
1183 DPRINT1("CUSBDevice::SelectInterface AlternateSetting %x InterfaceNumber %x Status %lx\n", InterfaceInfo
->AlternateSetting
, InterfaceInfo
->InterfaceNumber
, Status
);
1185 if (!NT_SUCCESS(Status
))
1187 // failed to select interface
1192 Status
= STATUS_SUCCESS
;
1196 Entry
= m_ConfigurationDescriptors
[ConfigurationIndex
].InterfaceList
.Flink
;
1197 while (Entry
!= &m_ConfigurationDescriptors
[ConfigurationIndex
].InterfaceList
)
1199 // grab interface descriptor
1200 UsbInterface
= (PUSB_INTERFACE
)CONTAINING_RECORD(Entry
, USB_INTERFACE
, ListEntry
);
1201 if (UsbInterface
->InterfaceDescriptor
->bAlternateSetting
== InterfaceInfo
->AlternateSetting
&&
1202 UsbInterface
->InterfaceDescriptor
->bInterfaceNumber
== InterfaceInfo
->InterfaceNumber
)
1210 Entry
= Entry
->Flink
;
1215 // find interface descriptor
1216 InterfaceDescriptor
= USBD_ParseConfigurationDescriptor(m_ConfigurationDescriptors
[ConfigurationIndex
].ConfigurationDescriptor
, InterfaceInfo
->InterfaceNumber
, InterfaceInfo
->AlternateSetting
);
1217 if (!InterfaceDescriptor
)
1219 DPRINT1("[LIBUSB] No such interface Alternate %x InterfaceNumber %x\n", InterfaceInfo
->AlternateSetting
, InterfaceInfo
->InterfaceNumber
);
1220 return STATUS_UNSUCCESSFUL
;
1223 // build interface descriptor
1224 Status
= BuildInterfaceDescriptor(ConfigurationIndex
, InterfaceDescriptor
, InterfaceInfo
, &UsbInterface
);
1225 if (!NT_SUCCESS(Status
))
1228 DPRINT1("[LIBUSB] Failed to build interface descriptor Status %x\n", Status
);
1233 // assert on pipe length mismatch
1234 DPRINT1("NumberOfPipes %lu Endpoints %lu Length %lu\n", InterfaceInfo
->NumberOfPipes
, UsbInterface
->InterfaceDescriptor
->bNumEndpoints
, InterfaceInfo
->Length
);
1237 ASSERT(GET_USBD_INTERFACE_SIZE(UsbInterface
->InterfaceDescriptor
->bNumEndpoints
) == InterfaceInfo
->Length
);
1239 // store number of pipes
1240 InterfaceInfo
->NumberOfPipes
= UsbInterface
->InterfaceDescriptor
->bNumEndpoints
;
1242 // copy pipe handles
1243 for (PipeIndex
= 0; PipeIndex
< UsbInterface
->InterfaceDescriptor
->bNumEndpoints
; PipeIndex
++)
1246 DPRINT1("PipeIndex %lu\n", PipeIndex
);
1247 DPRINT1("EndpointAddress %x\n", InterfaceInfo
->Pipes
[PipeIndex
].EndpointAddress
);
1248 DPRINT1("Interval %d\n", InterfaceInfo
->Pipes
[PipeIndex
].Interval
);
1249 DPRINT1("MaximumPacketSize %d\n", InterfaceInfo
->Pipes
[PipeIndex
].MaximumPacketSize
);
1250 DPRINT1("MaximumTransferSize %d\n", InterfaceInfo
->Pipes
[PipeIndex
].MaximumTransferSize
);
1251 DPRINT1("PipeFlags %d\n", InterfaceInfo
->Pipes
[PipeIndex
].PipeFlags
);
1252 DPRINT1("PipeType %d\n", InterfaceInfo
->Pipes
[PipeIndex
].PipeType
);
1253 DPRINT1("UsbEndPoint %x\n", InterfaceInfo
->Pipes
[PipeIndex
].EndpointAddress
);
1256 ASSERT(InterfaceInfo
->Pipes
[PipeIndex
].EndpointAddress
== UsbInterface
->EndPoints
[PipeIndex
].EndPointDescriptor
.bEndpointAddress
);
1257 ASSERT(InterfaceInfo
->Pipes
[PipeIndex
].Interval
== UsbInterface
->EndPoints
[PipeIndex
].EndPointDescriptor
.bInterval
);
1259 // store pipe handle
1260 InterfaceInfo
->Pipes
[PipeIndex
].PipeHandle
= &UsbInterface
->EndPoints
[PipeIndex
];
1262 // data toggle is reset on select interface requests
1263 UsbInterface
->EndPoints
[PipeIndex
].DataToggle
= FALSE
;
1273 CUSBDevice::AbortPipe(
1274 IN PUSB_ENDPOINT_DESCRIPTOR EndpointDescriptor
)
1277 // let it handle usb queue
1280 ASSERT(m_DeviceAddress
);
1285 return m_Queue
->AbortDevicePipe(m_DeviceAddress
, EndpointDescriptor
);
1289 CUSBDevice::GetMaxPacketSize()
1291 return m_DeviceDescriptor
.bMaxPacketSize0
;
1295 //----------------------------------------------------------------------------------------
1299 PUSBDEVICE
*OutDevice
)
1304 // allocate controller
1306 This
= new(NonPagedPool
, TAG_USBLIB
) CUSBDevice(0);
1310 // failed to allocate
1312 return STATUS_INSUFFICIENT_RESOURCES
;
1316 // add reference count
1323 *OutDevice
= (PUSBDEVICE
)This
;
1328 return STATUS_SUCCESS
;