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
);
60 virtual NTSTATUS
CommitIrp(PIRP Irp
);
61 virtual NTSTATUS
CommitSetupPacket(PUSB_DEFAULT_PIPE_SETUP_PACKET Packet
, IN OPTIONAL PUSB_ENDPOINT EndpointDescriptor
, IN ULONG BufferLength
, IN OUT PMDL Mdl
);
62 virtual NTSTATUS
CreateConfigurationDescriptor(UCHAR ConfigurationIndex
);
63 virtual NTSTATUS
CreateDeviceDescriptor();
64 virtual VOID
DumpDeviceDescriptor(PUSB_DEVICE_DESCRIPTOR DeviceDescriptor
);
65 virtual VOID
DumpConfigurationDescriptor(PUSB_CONFIGURATION_DESCRIPTOR ConfigurationDescriptor
);
66 virtual NTSTATUS
GetConfigurationDescriptor(UCHAR ConfigurationIndex
, USHORT BufferSize
, PVOID Buffer
);
68 // constructor / destructor
69 CUSBDevice(IUnknown
*OuterUnknown
){}
70 virtual ~CUSBDevice(){}
74 PHUBCONTROLLER m_HubController
;
75 PUSBHARDWAREDEVICE m_Device
;
78 UCHAR m_DeviceAddress
;
80 UCHAR m_ConfigurationIndex
;
82 USB_DEVICE_DESCRIPTOR m_DeviceDescriptor
;
85 PDMAMEMORYMANAGER m_DmaManager
;
87 PUSB_CONFIGURATION m_ConfigurationDescriptors
;
90 //----------------------------------------------------------------------------------------
93 CUSBDevice::QueryInterface(
97 return STATUS_UNSUCCESSFUL
;
100 //----------------------------------------------------------------------------------------
102 CUSBDevice::Initialize(
103 IN PHUBCONTROLLER HubController
,
104 IN PUSBHARDWAREDEVICE Device
,
112 // initialize members
114 m_HubController
= HubController
;
118 m_PortStatus
= PortStatus
;
121 // initialize device lock
123 KeInitializeSpinLock(&m_Lock
);
126 // no device address has been set yet
131 // get usb request queue
133 Status
= m_Device
->GetUSBQueue(&m_Queue
);
134 if (!NT_SUCCESS(Status
))
137 // failed to get usb queue
139 DPRINT1("CUSBDevice::Initialize GetUsbQueue failed with %x\n", Status
);
146 Status
= m_Device
->GetDMA(&m_DmaManager
);
147 if (!NT_SUCCESS(Status
))
150 // failed to get dma manager
152 DPRINT1("CUSBDevice::Initialize GetDMA failed with %x\n", Status
);
159 PC_ASSERT(m_DmaManager
);
162 // get device descriptor
164 Status
= CreateDeviceDescriptor();
165 if (!NT_SUCCESS(Status
))
168 // failed to get device descriptor
170 DPRINT1("CUSBDevice::Initialize Failed to get device descriptor with %x\n", Status
);
180 //----------------------------------------------------------------------------------------
185 // USB Standard Device Class see http://www.usb.org/developers/defined_class/#BaseClass09h
188 return (m_DeviceDescriptor
.bDeviceClass
== 0x09 && m_DeviceDescriptor
.bDeviceSubClass
== 0x00);
191 //----------------------------------------------------------------------------------------
193 CUSBDevice::GetParent(
204 return STATUS_SUCCESS
;
207 //----------------------------------------------------------------------------------------
209 CUSBDevice::GetDeviceAddress()
212 // get device address
214 return m_DeviceAddress
;
217 //----------------------------------------------------------------------------------------
219 CUSBDevice::GetPort()
222 // get port to which this device is connected to
227 //----------------------------------------------------------------------------------------
229 CUSBDevice::GetSpeed()
231 if (m_PortStatus
& USB_PORT_STATUS_LOW_SPEED
)
238 else if (m_PortStatus
& USB_PORT_STATUS_HIGH_SPEED
)
247 // default to full speed
252 //----------------------------------------------------------------------------------------
254 CUSBDevice::GetType()
257 // device is encoded into bcdUSB
259 if (m_DeviceDescriptor
.bcdUSB
== 0x110)
266 else if (m_DeviceDescriptor
.bcdUSB
== 0x200)
274 DPRINT1("CUSBDevice::GetType Unknown bcdUSB Type %x\n", m_DeviceDescriptor
.bcdUSB
);
280 //----------------------------------------------------------------------------------------
282 CUSBDevice::GetState()
288 //----------------------------------------------------------------------------------------
290 CUSBDevice::SetDeviceHandleData(
294 // set device data, for debugging issues
299 //----------------------------------------------------------------------------------------
301 CUSBDevice::SetDeviceAddress(
304 PUSB_DEFAULT_PIPE_SETUP_PACKET CtrlSetup
;
309 DPRINT1("CUSBDevice::SetDeviceAddress Address %d\n", DeviceAddress
);
311 CtrlSetup
= (PUSB_DEFAULT_PIPE_SETUP_PACKET
)ExAllocatePoolWithTag(NonPagedPool
, sizeof(USB_DEFAULT_PIPE_SETUP_PACKET
), TAG_USBLIB
);
313 return STATUS_INSUFFICIENT_RESOURCES
;
316 RtlZeroMemory(CtrlSetup
, sizeof(USB_DEFAULT_PIPE_SETUP_PACKET
));
318 // initialize request
319 CtrlSetup
->bRequest
= USB_REQUEST_SET_ADDRESS
;
320 CtrlSetup
->wValue
.W
= DeviceAddress
;
322 // set device address
323 Status
= CommitSetupPacket(CtrlSetup
, 0, 0, 0);
326 ExFreePoolWithTag(CtrlSetup
, TAG_USBLIB
);
329 if (!NT_SUCCESS(Status
))
331 // failed to set device address
332 DPRINT1("CUSBDevice::SetDeviceAddress> failed to set device address with %x Address %x\n", Status
, DeviceAddress
);
336 // lets have a short nap
337 KeStallExecutionProcessor(300);
339 // back up old address
340 OldAddress
= m_DeviceAddress
;
342 // store new device address
343 m_DeviceAddress
= DeviceAddress
;
345 // check that setting device address succeeded by retrieving the device descriptor
346 Status
= CreateDeviceDescriptor();
347 if (!NT_SUCCESS(Status
))
349 // failed to retrieve device descriptor
350 DPRINT1("CUSBbDevice::SetDeviceAddress> failed to retrieve device descriptor with device address set Error %x\n", Status
);
351 m_DeviceAddress
= OldAddress
;
353 // return error status
358 PC_ASSERT(m_DeviceDescriptor
.bNumConfigurations
);
360 // allocate configuration descriptor
361 m_ConfigurationDescriptors
= (PUSB_CONFIGURATION
) ExAllocatePoolWithTag(NonPagedPool
, sizeof(USB_CONFIGURATION
) * m_DeviceDescriptor
.bNumConfigurations
, TAG_USBLIB
);
363 // zero configuration descriptor
364 RtlZeroMemory(m_ConfigurationDescriptors
, sizeof(USB_CONFIGURATION
) * m_DeviceDescriptor
.bNumConfigurations
);
366 // retrieve the configuration descriptors
367 for(Index
= 0; Index
< m_DeviceDescriptor
.bNumConfigurations
; Index
++)
369 // retrieve configuration descriptors from device
370 Status
= CreateConfigurationDescriptor(Index
);
371 if (!NT_SUCCESS(Status
))
373 DPRINT1("CUSBDevice::SetDeviceAddress> failed to retrieve configuration %lu\n", Index
);
386 //----------------------------------------------------------------------------------------
388 CUSBDevice::GetDeviceDescriptor(
389 PUSB_DEVICE_DESCRIPTOR DeviceDescriptor
)
391 RtlMoveMemory(DeviceDescriptor
, &m_DeviceDescriptor
, sizeof(USB_DEVICE_DESCRIPTOR
));
394 //----------------------------------------------------------------------------------------
396 CUSBDevice::GetConfigurationValue()
399 // return configuration index
401 return m_ConfigurationIndex
;
404 //----------------------------------------------------------------------------------------
406 CUSBDevice::CommitIrp(
412 if (!m_Queue
|| !m_DmaManager
)
417 DPRINT1("CUSBDevice::CommitUrb> no queue / dma !!!\n");
418 return STATUS_UNSUCCESSFUL
;
424 Status
= m_Queue
->CreateUSBRequest(&Request
);
425 if (!NT_SUCCESS(Status
))
428 // failed to build request
430 DPRINT1("CUSBDevice::CommitSetupPacket> CreateUSBRequest failed with %x\n", Status
);
435 // initialize request
437 Status
= Request
->InitializeWithIrp(m_DmaManager
, PUSBDEVICE(this), Irp
);
440 // mark irp as pending
442 IoMarkIrpPending(Irp
);
445 // now add the request
447 Status
= m_Queue
->AddUSBRequest(Request
);
448 if (!NT_SUCCESS(Status
))
451 // failed to add request
453 DPRINT1("CUSBDevice::CommitSetupPacket> failed add request to queue with %x\n", Status
);
461 return STATUS_PENDING
;
464 //----------------------------------------------------------------------------------------
466 CUSBDevice::SubmitIrp(
473 // acquire device lock
475 KeAcquireSpinLock(&m_Lock
, &OldLevel
);
480 Status
= CommitIrp(Irp
);
485 KeReleaseSpinLock(&m_Lock
, OldLevel
);
489 //----------------------------------------------------------------------------------------
491 CUSBDevice::CommitSetupPacket(
492 IN PUSB_DEFAULT_PIPE_SETUP_PACKET Packet
,
493 IN OPTIONAL PUSB_ENDPOINT EndpointDescriptor
,
494 IN ULONG BufferLength
,
505 DPRINT1("CUSBDevice::CommitSetupPacket> no queue!!!\n");
506 return STATUS_UNSUCCESSFUL
;
512 Status
= m_Queue
->CreateUSBRequest(&Request
);
513 if (!NT_SUCCESS(Status
))
516 // failed to build request
518 DPRINT1("CUSBDevice::CommitSetupPacket> CreateUSBRequest failed with %x\n", Status
);
523 // initialize request
525 Status
= Request
->InitializeWithSetupPacket(m_DmaManager
, Packet
, PUSBDEVICE(this), EndpointDescriptor
, BufferLength
, Mdl
);
526 if (!NT_SUCCESS(Status
))
529 // failed to initialize request
531 DPRINT1("CUSBDevice::CommitSetupPacket> failed to initialize usb request with %x\n", Status
);
537 // now add the request
539 Status
= m_Queue
->AddUSBRequest(Request
);
540 if (!NT_SUCCESS(Status
))
543 // failed to add request
545 DPRINT1("CUSBDevice::CommitSetupPacket> failed add request to queue with %x\n", Status
);
551 // get the result code when the operation has been finished
553 Request
->GetResultStatus(&Status
, NULL
);
566 //----------------------------------------------------------------------------------------
568 CUSBDevice::CreateDeviceDescriptor()
570 USB_DEFAULT_PIPE_SETUP_PACKET CtrlSetup
;
578 RtlZeroMemory(&m_DeviceDescriptor
, sizeof(USB_DEVICE_DESCRIPTOR
));
579 RtlZeroMemory(&CtrlSetup
, sizeof(USB_DEFAULT_PIPE_SETUP_PACKET
));
584 CtrlSetup
.bRequest
= USB_REQUEST_GET_DESCRIPTOR
;
585 CtrlSetup
.wValue
.HiByte
= USB_DEVICE_DESCRIPTOR_TYPE
;
586 CtrlSetup
.wLength
= sizeof(USB_DEVICE_DESCRIPTOR
);
587 CtrlSetup
.bmRequestType
.B
= 0x80;
592 Buffer
= ExAllocatePool(NonPagedPool
, PAGE_SIZE
);
596 // failed to allocate
598 return STATUS_INSUFFICIENT_RESOURCES
;
604 RtlZeroMemory(Buffer
, PAGE_SIZE
);
607 // allocate mdl describing the device descriptor
609 Mdl
= IoAllocateMdl(Buffer
, sizeof(USB_DEVICE_DESCRIPTOR
), FALSE
, FALSE
, 0);
613 // failed to allocate mdl
615 return STATUS_INSUFFICIENT_RESOURCES
;
619 // build mdl for non paged pool
621 MmBuildMdlForNonPagedPool(Mdl
);
624 // commit setup packet
626 Status
= CommitSetupPacket(&CtrlSetup
, 0, sizeof(USB_DEVICE_DESCRIPTOR
), Mdl
);
633 if (NT_SUCCESS(Status
))
636 // informal dbg print
638 RtlCopyMemory(&m_DeviceDescriptor
, Buffer
, sizeof(USB_DEVICE_DESCRIPTOR
));
639 DumpDeviceDescriptor(&m_DeviceDescriptor
);
654 //----------------------------------------------------------------------------------------
656 CUSBDevice::GetConfigurationDescriptor(
657 IN UCHAR ConfigurationIndex
,
658 IN USHORT BufferSize
,
661 USB_DEFAULT_PIPE_SETUP_PACKET CtrlSetup
;
667 // now build MDL describing the buffer
669 Mdl
= IoAllocateMdl(Buffer
, BufferSize
, FALSE
, FALSE
, 0);
673 // failed to allocate mdl
675 return STATUS_INSUFFICIENT_RESOURCES
;
679 // build mdl for non paged pool
681 MmBuildMdlForNonPagedPool(Mdl
);
685 // build setup packet
687 CtrlSetup
.bmRequestType
._BM
.Recipient
= BMREQUEST_TO_DEVICE
;
688 CtrlSetup
.bmRequestType
._BM
.Type
= BMREQUEST_STANDARD
;
689 CtrlSetup
.bmRequestType
._BM
.Reserved
= 0;
690 CtrlSetup
.bmRequestType
._BM
.Dir
= BMREQUEST_DEVICE_TO_HOST
;
691 CtrlSetup
.bRequest
= USB_REQUEST_GET_DESCRIPTOR
;
692 CtrlSetup
.wValue
.LowByte
= ConfigurationIndex
;
693 CtrlSetup
.wValue
.HiByte
= USB_CONFIGURATION_DESCRIPTOR_TYPE
;
694 CtrlSetup
.wIndex
.W
= 0;
695 CtrlSetup
.wLength
= BufferSize
;
700 Status
= CommitSetupPacket(&CtrlSetup
, 0, BufferSize
, Mdl
);
713 //----------------------------------------------------------------------------------------
715 CUSBDevice::CreateConfigurationDescriptor(
719 PUSB_CONFIGURATION_DESCRIPTOR ConfigurationDescriptor
;
724 PC_ASSERT(m_ConfigurationDescriptors
);
727 // first allocate a buffer which should be enough to store all different interfaces and endpoints
729 ConfigurationDescriptor
= (PUSB_CONFIGURATION_DESCRIPTOR
)ExAllocatePoolWithTag(NonPagedPool
, PAGE_SIZE
, TAG_USBLIB
);
730 if (!ConfigurationDescriptor
)
733 // failed to allocate buffer
735 return STATUS_INSUFFICIENT_RESOURCES
;
739 // get partial configuration descriptor
741 Status
= GetConfigurationDescriptor(Index
, sizeof(USB_CONFIGURATION_DESCRIPTOR
), ConfigurationDescriptor
);
742 if (!NT_SUCCESS(Status
))
745 // failed to get partial configuration descriptor
747 DPRINT1("[USBLIB] Failed to get partial configuration descriptor Status %x Index %x\n", Status
, Index
);
748 ExFreePoolWithTag(ConfigurationDescriptor
, TAG_USBLIB
);
753 // now get full descriptor
755 Status
= GetConfigurationDescriptor(Index
, ConfigurationDescriptor
->wTotalLength
, ConfigurationDescriptor
);
756 if (!NT_SUCCESS(Status
))
759 // failed to get full configuration descriptor
761 DPRINT1("[USBLIB] Failed to get full configuration descriptor Status %x Index %x\n", Status
, Index
);
762 ExFreePoolWithTag(ConfigurationDescriptor
, TAG_USBLIB
);
767 // informal debug print
769 DumpConfigurationDescriptor(ConfigurationDescriptor
);
774 PC_ASSERT(ConfigurationDescriptor
->bLength
== sizeof(USB_CONFIGURATION_DESCRIPTOR
));
775 PC_ASSERT(ConfigurationDescriptor
->wTotalLength
<= PAGE_SIZE
);
776 PC_ASSERT(ConfigurationDescriptor
->bNumInterfaces
);
779 // request is complete, initialize configuration descriptor
781 m_ConfigurationDescriptors
[Index
].ConfigurationDescriptor
= ConfigurationDescriptor
;
782 InitializeListHead(&m_ConfigurationDescriptors
[Index
].InterfaceList
);
789 //----------------------------------------------------------------------------------------
791 CUSBDevice::GetConfigurationDescriptors(
792 IN PUSB_CONFIGURATION_DESCRIPTOR ConfigDescriptorBuffer
,
793 IN ULONG BufferLength
,
794 OUT PULONG OutBufferLength
)
797 ASSERT(BufferLength
>= sizeof(USB_CONFIGURATION_DESCRIPTOR
));
798 ASSERT(ConfigDescriptorBuffer
);
799 ASSERT(OutBufferLength
);
801 // reset copied length
802 *OutBufferLength
= 0;
804 // FIXME: support multiple configurations
805 PC_ASSERT(m_DeviceDescriptor
.bNumConfigurations
== 1);
807 // copy configuration descriptor
808 RtlCopyMemory(ConfigDescriptorBuffer
, m_ConfigurationDescriptors
[0].ConfigurationDescriptor
, min(m_ConfigurationDescriptors
[0].ConfigurationDescriptor
->wTotalLength
, BufferLength
));
809 *OutBufferLength
= m_ConfigurationDescriptors
[0].ConfigurationDescriptor
->wTotalLength
;
812 //----------------------------------------------------------------------------------------
814 CUSBDevice::GetConfigurationDescriptorsLength()
817 // FIXME: support multiple configurations
819 PC_ASSERT(m_DeviceDescriptor
.bNumConfigurations
== 1);
821 return m_ConfigurationDescriptors
[0].ConfigurationDescriptor
->wTotalLength
;
823 //----------------------------------------------------------------------------------------
825 CUSBDevice::DumpDeviceDescriptor(PUSB_DEVICE_DESCRIPTOR DeviceDescriptor
)
827 DPRINT1("Dumping Device Descriptor %x\n", DeviceDescriptor
);
828 DPRINT1("bLength %x\n", DeviceDescriptor
->bLength
);
829 DPRINT1("bDescriptorType %x\n", DeviceDescriptor
->bDescriptorType
);
830 DPRINT1("bcdUSB %x\n", DeviceDescriptor
->bcdUSB
);
831 DPRINT1("bDeviceClass %x\n", DeviceDescriptor
->bDeviceClass
);
832 DPRINT1("bDeviceSubClass %x\n", DeviceDescriptor
->bDeviceSubClass
);
833 DPRINT1("bDeviceProtocol %x\n", DeviceDescriptor
->bDeviceProtocol
);
834 DPRINT1("bMaxPacketSize0 %x\n", DeviceDescriptor
->bMaxPacketSize0
);
835 DPRINT1("idVendor %x\n", DeviceDescriptor
->idVendor
);
836 DPRINT1("idProduct %x\n", DeviceDescriptor
->idProduct
);
837 DPRINT1("bcdDevice %x\n", DeviceDescriptor
->bcdDevice
);
838 DPRINT1("iManufacturer %x\n", DeviceDescriptor
->iManufacturer
);
839 DPRINT1("iProduct %x\n", DeviceDescriptor
->iProduct
);
840 DPRINT1("iSerialNumber %x\n", DeviceDescriptor
->iSerialNumber
);
841 DPRINT1("bNumConfigurations %x\n", DeviceDescriptor
->bNumConfigurations
);
844 //----------------------------------------------------------------------------------------
846 CUSBDevice::DumpConfigurationDescriptor(PUSB_CONFIGURATION_DESCRIPTOR ConfigurationDescriptor
)
848 DPRINT1("Dumping ConfigurationDescriptor %x\n", ConfigurationDescriptor
);
849 DPRINT1("bLength %x\n", ConfigurationDescriptor
->bLength
);
850 DPRINT1("bDescriptorType %x\n", ConfigurationDescriptor
->bDescriptorType
);
851 DPRINT1("wTotalLength %x\n", ConfigurationDescriptor
->wTotalLength
);
852 DPRINT1("bNumInterfaces %x\n", ConfigurationDescriptor
->bNumInterfaces
);
853 DPRINT1("bConfigurationValue %x\n", ConfigurationDescriptor
->bConfigurationValue
);
854 DPRINT1("iConfiguration %x\n", ConfigurationDescriptor
->iConfiguration
);
855 DPRINT1("bmAttributes %x\n", ConfigurationDescriptor
->bmAttributes
);
856 DPRINT1("MaxPower %x\n", ConfigurationDescriptor
->MaxPower
);
858 //----------------------------------------------------------------------------------------
860 CUSBDevice::SubmitSetupPacket(
861 IN PUSB_DEFAULT_PIPE_SETUP_PACKET SetupPacket
,
862 IN OUT ULONG BufferLength
,
873 Mdl
= IoAllocateMdl(Buffer
, BufferLength
, FALSE
, FALSE
, 0);
879 return STATUS_INSUFFICIENT_RESOURCES
;
883 // HACK HACK HACK: assume the buffer is build from non paged pool
885 MmBuildMdlForNonPagedPool(Mdl
);
889 // commit setup packet
891 Status
= CommitSetupPacket(SetupPacket
, 0, BufferLength
, Mdl
);
907 //----------------------------------------------------------------------------------------
909 CUSBDevice::SelectConfiguration(
910 IN PUSB_CONFIGURATION_DESCRIPTOR ConfigurationDescriptor
,
911 IN PUSBD_INTERFACE_INFORMATION InterfaceInfo
,
912 OUT USBD_CONFIGURATION_HANDLE
*ConfigurationHandle
)
914 ULONG InterfaceIndex
, PipeIndex
;
915 USB_DEFAULT_PIPE_SETUP_PACKET CtrlSetup
;
917 UCHAR bConfigurationValue
= 0;
918 ULONG ConfigurationIndex
= 0, Index
;
920 PUSB_INTERFACE_DESCRIPTOR InterfaceDescriptor
;
921 PUSB_INTERFACE UsbInterface
;
922 PUSB_ENDPOINT_DESCRIPTOR EndpointDescriptor
;
925 if (ConfigurationDescriptor
)
927 // find configuration index
928 for(Index
= 0; Index
< m_DeviceDescriptor
.bNumConfigurations
; Index
++)
930 if (m_ConfigurationDescriptors
[Index
].ConfigurationDescriptor
->bConfigurationValue
== ConfigurationDescriptor
->bConfigurationValue
)
932 // found configuration index
933 ConfigurationIndex
= Index
;
940 DPRINT1("[USBUHCI] invalid configuration value %lu\n", ConfigurationDescriptor
->bConfigurationValue
);
941 return STATUS_INVALID_PARAMETER
;
945 ASSERT(ConfigurationDescriptor
->bNumInterfaces
<= m_ConfigurationDescriptors
[ConfigurationIndex
].ConfigurationDescriptor
->bNumInterfaces
);
947 // get configuration value
948 bConfigurationValue
= ConfigurationDescriptor
->bConfigurationValue
;
951 // now build setup packet
952 RtlZeroMemory(&CtrlSetup
, sizeof(USB_DEFAULT_PIPE_SETUP_PACKET
));
953 CtrlSetup
.bRequest
= USB_REQUEST_SET_CONFIGURATION
;
954 CtrlSetup
.wValue
.W
= bConfigurationValue
;
956 // select configuration
957 Status
= CommitSetupPacket(&CtrlSetup
, 0, 0, 0);
959 if (!ConfigurationDescriptor
)
961 // unconfigure request
962 DPRINT1("CUsbDevice::SelectConfiguration Unconfigure Request Status %x\n", Status
);
963 m_ConfigurationIndex
= 0;
967 // informal debug print
968 DPRINT1("CUsbDevice::SelectConfiguration New Configuration %x Old Configuration %x Result %x\n", ConfigurationIndex
, m_ConfigurationIndex
, Status
);
969 if (!NT_SUCCESS(Status
))
977 // destroy old interface info
978 while(!IsListEmpty(&m_ConfigurationDescriptors
[m_ConfigurationIndex
].InterfaceList
))
981 Entry
= RemoveHeadList(&m_ConfigurationDescriptors
[m_ConfigurationIndex
].InterfaceList
);
983 // get interface info
984 UsbInterface
= (PUSB_INTERFACE
)CONTAINING_RECORD(Entry
, USB_INTERFACE
, ListEntry
);
986 // free interface info
987 ExFreePool(UsbInterface
);
991 ASSERT(IsListEmpty(&m_ConfigurationDescriptors
[ConfigurationIndex
].InterfaceList
));
993 // store new configuration device index
994 m_ConfigurationIndex
= ConfigurationIndex
;
996 // store configuration handle
997 *ConfigurationHandle
= &m_ConfigurationDescriptors
[ConfigurationIndex
];
999 // copy interface info and pipe info
1000 for(InterfaceIndex
= 0; InterfaceIndex
< ConfigurationDescriptor
->bNumInterfaces
; InterfaceIndex
++)
1002 // interface info checks
1003 ASSERT(InterfaceInfo
->Length
!= 0);
1006 PC_ASSERT(InterfaceInfo
->Length
== FIELD_OFFSET(USBD_INTERFACE_INFORMATION
, Pipes
[InterfaceInfo
->NumberOfPipes
]));
1009 // find interface descriptor
1010 InterfaceDescriptor
= USBD_ParseConfigurationDescriptor(m_ConfigurationDescriptors
[ConfigurationIndex
].ConfigurationDescriptor
, InterfaceInfo
->InterfaceNumber
, InterfaceInfo
->AlternateSetting
);
1013 ASSERT(InterfaceDescriptor
!= NULL
);
1015 // check if the number of pipes have been properly set
1016 ASSERT(InterfaceInfo
->NumberOfPipes
== InterfaceDescriptor
->bNumEndpoints
);
1018 // copy interface info
1019 InterfaceInfo
->Class
= InterfaceDescriptor
->bInterfaceClass
;
1020 InterfaceInfo
->SubClass
= InterfaceDescriptor
->bInterfaceSubClass
;
1021 InterfaceInfo
->Protocol
= InterfaceDescriptor
->bInterfaceProtocol
;
1022 InterfaceInfo
->Reserved
= 0;
1024 // allocate interface handle
1025 UsbInterface
= (PUSB_INTERFACE
)ExAllocatePool(NonPagedPool
, sizeof(USB_INTERFACE
) + (InterfaceInfo
->NumberOfPipes
- 1) * sizeof(USB_ENDPOINT
));
1028 // failed to allocate memory
1029 return STATUS_INSUFFICIENT_RESOURCES
;
1033 InterfaceInfo
->InterfaceHandle
= (USBD_INTERFACE_HANDLE
)UsbInterface
;
1035 // init interface handle
1036 UsbInterface
->InterfaceDescriptor
= InterfaceDescriptor
;
1037 InsertTailList(&m_ConfigurationDescriptors
[ConfigurationIndex
].InterfaceList
, &UsbInterface
->ListEntry
);
1039 // grab first endpoint descriptor
1040 EndpointDescriptor
= (PUSB_ENDPOINT_DESCRIPTOR
) (InterfaceDescriptor
+ 1);
1042 // now copy all endpoint information
1043 for(PipeIndex
= 0; PipeIndex
< InterfaceInfo
->NumberOfPipes
; PipeIndex
++)
1045 while(EndpointDescriptor
->bDescriptorType
!= USB_ENDPOINT_DESCRIPTOR_TYPE
&& EndpointDescriptor
->bLength
!= sizeof(USB_ENDPOINT_DESCRIPTOR
))
1047 // skip intermediate descriptors
1048 if (EndpointDescriptor
->bLength
== 0 || EndpointDescriptor
->bDescriptorType
== USB_INTERFACE_DESCRIPTOR_TYPE
)
1050 // bogus configuration descriptor
1051 DPRINT1("[USBEHCI] Bogus descriptor found in InterfaceNumber %x Alternate %x EndpointIndex %x bLength %x bDescriptorType %x\n", InterfaceDescriptor
->bInterfaceNumber
, InterfaceDescriptor
->bAlternateSetting
, PipeIndex
,
1052 EndpointDescriptor
->bLength
, EndpointDescriptor
->bDescriptorType
);
1055 return STATUS_UNSUCCESSFUL
;
1058 // move to next descriptor
1059 EndpointDescriptor
= (PUSB_ENDPOINT_DESCRIPTOR
)((ULONG_PTR
)EndpointDescriptor
+ EndpointDescriptor
->bLength
);
1062 // store in interface info
1063 RtlCopyMemory(&UsbInterface
->EndPoints
[PipeIndex
].EndPointDescriptor
, EndpointDescriptor
, sizeof(USB_ENDPOINT_DESCRIPTOR
));
1066 InterfaceInfo
->Pipes
[PipeIndex
].MaximumPacketSize
= UsbInterface
->EndPoints
[PipeIndex
].EndPointDescriptor
.wMaxPacketSize
;
1067 InterfaceInfo
->Pipes
[PipeIndex
].EndpointAddress
= UsbInterface
->EndPoints
[PipeIndex
].EndPointDescriptor
.bEndpointAddress
;
1068 InterfaceInfo
->Pipes
[PipeIndex
].Interval
= UsbInterface
->EndPoints
[PipeIndex
].EndPointDescriptor
.bInterval
;
1069 InterfaceInfo
->Pipes
[PipeIndex
].PipeType
= (USBD_PIPE_TYPE
)UsbInterface
->EndPoints
[PipeIndex
].EndPointDescriptor
.bmAttributes
;
1070 InterfaceInfo
->Pipes
[PipeIndex
].PipeHandle
= (PVOID
)&UsbInterface
->EndPoints
[PipeIndex
];
1072 // move to next descriptor
1073 EndpointDescriptor
= (PUSB_ENDPOINT_DESCRIPTOR
)((ULONG_PTR
)EndpointDescriptor
+ EndpointDescriptor
->bLength
);
1077 InterfaceInfo
= (PUSBD_INTERFACE_INFORMATION
)((ULONG_PTR
)PtrToUlong(InterfaceInfo
) + InterfaceInfo
->Length
);
1086 //----------------------------------------------------------------------------------------
1088 CUSBDevice::SelectInterface(
1089 IN USBD_CONFIGURATION_HANDLE ConfigurationHandle
,
1090 IN OUT PUSBD_INTERFACE_INFORMATION InterfaceInfo
)
1093 USB_DEFAULT_PIPE_SETUP_PACKET CtrlSetup
;
1095 ULONG Index
, ConfigurationIndex
= 0, Found
= FALSE
;
1096 PUSB_INTERFACE UsbInterface
;
1099 // check if handle is valid
1100 for(Index
= 0; Index
< m_DeviceDescriptor
.bNumConfigurations
; Index
++)
1102 if (&m_ConfigurationDescriptors
[Index
] == ConfigurationHandle
)
1104 // found configuration index
1105 ConfigurationIndex
= Index
;
1112 // invalid handle passed
1113 DPRINT1("[USBEHCI] Invalid configuration handle passed %p\n", ConfigurationHandle
);
1114 return STATUS_INVALID_PARAMETER
;
1117 // initialize setup packet
1118 RtlZeroMemory(&CtrlSetup
, sizeof(USB_DEFAULT_PIPE_SETUP_PACKET
));
1119 CtrlSetup
.bRequest
= USB_REQUEST_SET_INTERFACE
;
1120 CtrlSetup
.wValue
.W
= InterfaceInfo
->AlternateSetting
;
1121 CtrlSetup
.wIndex
.W
= InterfaceInfo
->InterfaceNumber
;
1122 CtrlSetup
.bmRequestType
.B
= 0x01;
1125 Status
= CommitSetupPacket(&CtrlSetup
, 0, 0, 0);
1127 // informal debug print
1128 DPRINT1("CUSBDevice::SelectInterface AlternateSetting %x InterfaceNumber %x Status %x\n", InterfaceInfo
->AlternateSetting
, InterfaceInfo
->InterfaceNumber
, Status
);
1130 if (!NT_SUCCESS(Status
))
1132 // failed to select interface
1137 Status
= STATUS_SUCCESS
;
1142 Entry
= m_ConfigurationDescriptors
[ConfigurationIndex
].InterfaceList
.Flink
;
1143 while(Entry
!= &m_ConfigurationDescriptors
[ConfigurationIndex
].InterfaceList
)
1145 // grab interface descriptor
1146 UsbInterface
= (PUSB_INTERFACE
)CONTAINING_RECORD(Entry
, USB_INTERFACE
, ListEntry
);
1147 if (UsbInterface
->InterfaceDescriptor
->bAlternateSetting
== InterfaceInfo
->AlternateSetting
&&
1148 UsbInterface
->InterfaceDescriptor
->bInterfaceNumber
== InterfaceInfo
->InterfaceNumber
)
1158 // selected interface but interface not found
1159 // something is really wrong
1160 DPRINT1("[USBEHCI] Error: interface not found!!!\n");
1161 return STATUS_UNSUCCESSFUL
;
1164 // assert on pipe length mismatch
1165 ASSERT(InterfaceInfo
->NumberOfPipes
== UsbInterface
->InterfaceDescriptor
->bNumEndpoints
);
1167 // copy pipe handles
1168 for(PipeIndex
= 0; PipeIndex
< min(InterfaceInfo
->NumberOfPipes
, UsbInterface
->InterfaceDescriptor
->bNumEndpoints
); PipeIndex
++)
1171 DPRINT1("PipeIndex %lu\n", PipeIndex
);
1172 DPRINT1("EndpointAddress %x\n", InterfaceInfo
->Pipes
[PipeIndex
].EndpointAddress
);
1173 DPRINT1("Interval %d\n", InterfaceInfo
->Pipes
[PipeIndex
].Interval
);
1174 DPRINT1("MaximumPacketSize %d\n", InterfaceInfo
->Pipes
[PipeIndex
].MaximumPacketSize
);
1175 DPRINT1("MaximumTransferSize %d\n", InterfaceInfo
->Pipes
[PipeIndex
].MaximumTransferSize
);
1176 DPRINT1("PipeFlags %d\n", InterfaceInfo
->Pipes
[PipeIndex
].PipeFlags
);
1177 DPRINT1("PipeType %dd\n", InterfaceInfo
->Pipes
[PipeIndex
].PipeType
);
1178 DPRINT1("UsbEndPoint %x\n", InterfaceInfo
->Pipes
[PipeIndex
].EndpointAddress
);
1181 ASSERT(InterfaceInfo
->Pipes
[PipeIndex
].EndpointAddress
== UsbInterface
->EndPoints
[PipeIndex
].EndPointDescriptor
.bEndpointAddress
);
1182 ASSERT(InterfaceInfo
->Pipes
[PipeIndex
].Interval
== UsbInterface
->EndPoints
[PipeIndex
].EndPointDescriptor
.bInterval
);
1184 // store pipe handle
1185 InterfaceInfo
->Pipes
[PipeIndex
].PipeHandle
= &UsbInterface
->EndPoints
[PipeIndex
];
1187 // data toggle is reset on select interface requests
1188 UsbInterface
->EndPoints
[PipeIndex
].DataToggle
= FALSE
;
1199 CUSBDevice::AbortPipe(
1200 IN PUSB_ENDPOINT_DESCRIPTOR EndpointDescriptor
)
1203 // let it handle usb queue
1206 ASSERT(m_DeviceAddress
);
1211 return m_Queue
->AbortDevicePipe(m_DeviceAddress
, EndpointDescriptor
);
1215 //----------------------------------------------------------------------------------------
1219 PUSBDEVICE
*OutDevice
)
1224 // allocate controller
1226 This
= new(NonPagedPool
, TAG_USBLIB
) CUSBDevice(0);
1230 // failed to allocate
1232 return STATUS_INSUFFICIENT_RESOURCES
;
1236 // add reference count
1243 *OutDevice
= (PUSBDEVICE
)This
;
1248 return STATUS_SUCCESS
;