2 * PROJECT: ReactOS Universal Serial Bus Bulk Driver Library
3 * LICENSE: GPL - See COPYING in the top level directory
4 * FILE: lib/drivers/libusb/hub_controller.cpp
5 * PURPOSE: USB Common Driver Library.
7 * Michael Martin (michael.martin@reactos.org)
8 * Johannes Anderwald (johannes.anderwald@reactos.org)
15 VOID
StatusChangeEndpointCallBack(
18 class CHubController
: public IHubController
,
22 STDMETHODIMP
QueryInterface( REFIID InterfaceId
, PVOID
* Interface
);
24 STDMETHODIMP_(ULONG
) AddRef()
26 InterlockedIncrement(&m_Ref
);
29 STDMETHODIMP_(ULONG
) Release()
31 InterlockedDecrement(&m_Ref
);
41 // IHubController interface functions
42 virtual NTSTATUS
Initialize(IN PDRIVER_OBJECT DriverObject
, IN PHCDCONTROLLER Controller
, IN PUSBHARDWAREDEVICE Device
, IN BOOLEAN IsRootHubDevice
, IN ULONG DeviceAddress
);
43 virtual NTSTATUS
GetHubControllerDeviceObject(PDEVICE_OBJECT
* HubDeviceObject
);
44 virtual NTSTATUS
GetHubControllerSymbolicLink(ULONG BufferLength
, PVOID Buffer
, PULONG RequiredLength
);
46 // IDispatchIrp interface functions
47 virtual NTSTATUS
HandlePnp(IN PDEVICE_OBJECT DeviceObject
, IN OUT PIRP Irp
);
48 virtual NTSTATUS
HandlePower(IN PDEVICE_OBJECT DeviceObject
, IN OUT PIRP Irp
);
49 virtual NTSTATUS
HandleDeviceControl(IN PDEVICE_OBJECT DeviceObject
, IN OUT PIRP Irp
);
52 NTSTATUS
HandleQueryInterface(PIO_STACK_LOCATION IoStack
);
53 NTSTATUS
SetDeviceInterface(BOOLEAN bEnable
);
54 NTSTATUS
CreatePDO(PDRIVER_OBJECT DriverObject
, PDEVICE_OBJECT
* OutDeviceObject
);
55 PUSBHARDWAREDEVICE
GetUsbHardware();
56 ULONG
AcquireDeviceAddress();
57 VOID
ReleaseDeviceAddress(ULONG DeviceAddress
);
58 BOOLEAN
ValidateUsbDevice(PUSBDEVICE UsbDevice
);
59 NTSTATUS
AddUsbDevice(PUSBDEVICE UsbDevice
);
60 NTSTATUS
RemoveUsbDevice(PUSBDEVICE UsbDevice
);
61 VOID
SetNotification(PVOID CallbackContext
, PRH_INIT_CALLBACK CallbackRoutine
);
62 // internal ioctl routines
63 NTSTATUS
HandleGetDescriptor(IN OUT PIRP Irp
, PURB Urb
);
64 NTSTATUS
HandleGetDescriptorFromInterface(IN OUT PIRP Irp
, PURB Urb
);
65 NTSTATUS
HandleClassDevice(IN OUT PIRP Irp
, PURB Urb
);
66 NTSTATUS
HandleGetStatusFromDevice(IN OUT PIRP Irp
, PURB Urb
);
67 NTSTATUS
HandleSelectConfiguration(IN OUT PIRP Irp
, PURB Urb
);
68 NTSTATUS
HandleSelectInterface(IN OUT PIRP Irp
, PURB Urb
);
69 NTSTATUS
HandleClassOther(IN OUT PIRP Irp
, PURB Urb
);
70 NTSTATUS
HandleClassInterface(IN OUT PIRP Irp
, PURB Urb
);
71 NTSTATUS
HandleClassEndpoint(IN OUT PIRP Irp
, PURB Urb
);
72 NTSTATUS
HandleVendorDevice(IN OUT PIRP Irp
, PURB Urb
);
73 NTSTATUS
HandleBulkOrInterruptTransfer(IN OUT PIRP Irp
, PURB Urb
);
74 NTSTATUS
HandleIsochronousTransfer(IN OUT PIRP Irp
, PURB Urb
);
75 NTSTATUS
HandleClearStall(IN OUT PIRP Irp
, PURB Urb
);
76 NTSTATUS
HandleSyncResetAndClearStall(IN OUT PIRP Irp
, PURB Urb
);
77 NTSTATUS
HandleAbortPipe(IN OUT PIRP Irp
, PURB Urb
);
79 friend VOID
StatusChangeEndpointCallBack(PVOID Context
);
81 // constructor / destructor
82 CHubController(IUnknown
*OuterUnknown
){}
83 virtual ~CHubController(){}
87 PHCDCONTROLLER m_Controller
;
88 PUSBHARDWAREDEVICE m_Hardware
;
89 BOOLEAN m_IsRootHubDevice
;
90 ULONG m_DeviceAddress
;
92 BOOLEAN m_InterfaceEnabled
;
93 UNICODE_STRING m_HubDeviceInterfaceString
;
95 PDEVICE_OBJECT m_HubControllerDeviceObject
;
96 PDRIVER_OBJECT m_DriverObject
;
98 PVOID m_HubCallbackContext
;
99 PRH_INIT_CALLBACK m_HubCallbackRoutine
;
101 USB_DEVICE_DESCRIPTOR m_DeviceDescriptor
;
104 RTL_BITMAP m_DeviceAddressBitmap
;
105 PULONG m_DeviceAddressBitmapBuffer
;
106 LIST_ENTRY m_UsbDeviceList
;
107 PIRP m_PendingSCEIrp
;
110 BOOLEAN
QueryStatusChageEndpoint(PIRP Irp
);
117 }USBDEVICE_ENTRY
, *PUSBDEVICE_ENTRY
;
119 /* Lifted from Linux with slight changes */
120 const UCHAR ROOTHUB2_DEVICE_DESCRIPTOR
[] =
123 USB_DEVICE_DESCRIPTOR_TYPE
, /* bDescriptorType; Device */
124 0x00, 0x20, /* bcdUSB; v1.1 */
125 USB_DEVICE_CLASS_HUB
, /* bDeviceClass; HUB_CLASSCODE */
126 0x01, /* bDeviceSubClass; */
127 0x00, /* bDeviceProtocol; [ low/full speeds only ] */
128 0x08, /* bMaxPacketSize0; 8 Bytes */
129 /* Fill Vendor and Product in when init root hub */
130 0x00, 0x00, /* idVendor; */
131 0x00, 0x00, /* idProduct; */
132 0x00, 0x00, /* bcdDevice */
133 0x00, /* iManufacturer; */
134 0x00, /* iProduct; */
135 0x00, /* iSerialNumber; */
136 0x01 /* bNumConfigurations; */
140 const USB_CONFIGURATION_DESCRIPTOR ROOTHUB2_CONFIGURATION_DESCRIPTOR
=
142 sizeof(USB_CONFIGURATION_DESCRIPTOR
),
143 USB_CONFIGURATION_DESCRIPTOR_TYPE
,
144 sizeof(USB_CONFIGURATION_DESCRIPTOR
) + sizeof(USB_INTERFACE_DESCRIPTOR
) + sizeof(USB_ENDPOINT_DESCRIPTOR
),
148 0x40, /* self powered */
152 const USB_INTERFACE_DESCRIPTOR ROOTHUB2_INTERFACE_DESCRIPTOR
=
154 sizeof(USB_INTERFACE_DESCRIPTOR
), /* bLength */
155 USB_INTERFACE_DESCRIPTOR_TYPE
, /* bDescriptorType; Interface */
156 0, /* bInterfaceNumber; */
157 0, /* bAlternateSetting; */
158 0x1, /* bNumEndpoints; */
159 0x09, /* bInterfaceClass; HUB_CLASSCODE */
160 0x01, /* bInterfaceSubClass; */
161 0x00, /* bInterfaceProtocol: */
162 0x00, /* iInterface; */
165 const USB_ENDPOINT_DESCRIPTOR ROOTHUB2_ENDPOINT_DESCRIPTOR
=
167 sizeof(USB_ENDPOINT_DESCRIPTOR
), /* bLength */
168 USB_ENDPOINT_DESCRIPTOR_TYPE
, /* bDescriptorType */
169 0x81, /* bEndPointAddress */
170 USB_ENDPOINT_TYPE_INTERRUPT
, /* bmAttributes */
171 0x01, /* wMaxPacketSize */
175 //----------------------------------------------------------------------------------------
178 CHubController::QueryInterface(
182 return STATUS_UNSUCCESSFUL
;
184 //----------------------------------------------------------------------------------------
186 CHubController::Initialize(
187 IN PDRIVER_OBJECT DriverObject
,
188 IN PHCDCONTROLLER Controller
,
189 IN PUSBHARDWAREDEVICE Device
,
190 IN BOOLEAN IsRootHubDevice
,
191 IN ULONG DeviceAddress
)
194 PCOMMON_DEVICE_EXTENSION DeviceExtension
;
195 USHORT VendorID
, DeviceID
;
198 DPRINT1("CHubController::Initialize\n");
201 // initialize members
203 m_Controller
= Controller
;
205 m_IsRootHubDevice
= IsRootHubDevice
;
206 m_DeviceAddress
= DeviceAddress
;
207 m_DriverObject
= DriverObject
;
208 KeInitializeSpinLock(&m_Lock
);
209 InitializeListHead(&m_UsbDeviceList
);
212 // allocate device address bitmap buffer
214 m_DeviceAddressBitmapBuffer
= (PULONG
)ExAllocatePoolWithTag(NonPagedPool
, 16, TAG_USBLIB
);
215 if (!m_DeviceAddressBitmapBuffer
)
220 return STATUS_INSUFFICIENT_RESOURCES
;
224 // initialize device address bitmap
226 RtlInitializeBitMap(&m_DeviceAddressBitmap
, m_DeviceAddressBitmapBuffer
, 128);
227 RtlClearAllBits(&m_DeviceAddressBitmap
);
233 Status
= CreatePDO(m_DriverObject
, &m_HubControllerDeviceObject
);
234 if (!NT_SUCCESS(Status
))
237 // failed to create hub device object
243 // get device extension
245 DeviceExtension
= (PCOMMON_DEVICE_EXTENSION
)m_HubControllerDeviceObject
->DeviceExtension
;
248 // initialize device extension
250 DeviceExtension
->IsFDO
= FALSE
;
251 DeviceExtension
->IsHub
= TRUE
; //FIXME
252 DeviceExtension
->Dispatcher
= PDISPATCHIRP(this);
255 // intialize device descriptor
257 C_ASSERT(sizeof(USB_DEVICE_DESCRIPTOR
) == sizeof(ROOTHUB2_DEVICE_DESCRIPTOR
));
258 RtlMoveMemory(&m_DeviceDescriptor
, ROOTHUB2_DEVICE_DESCRIPTOR
, sizeof(USB_DEVICE_DESCRIPTOR
));
260 if (NT_SUCCESS(m_Hardware
->GetDeviceDetails(&VendorID
, &DeviceID
, &Dummy1
, &Dummy1
)))
263 // update device descriptor
265 m_DeviceDescriptor
.idVendor
= VendorID
;
266 m_DeviceDescriptor
.idProduct
= DeviceID
;
267 m_DeviceDescriptor
.bcdUSB
= 0x200; //FIXME
271 // Set the SCE Callback that the Hardware Device will call on port status change
273 Device
->SetStatusChangeEndpointCallBack((PVOID
)StatusChangeEndpointCallBack
, this);
278 m_HubControllerDeviceObject
->Flags
&= ~DO_DEVICE_INITIALIZING
;
280 return STATUS_SUCCESS
;
284 // Queries the ports to see if there has been a device connected or removed.
287 CHubController::QueryStatusChageEndpoint(
290 ULONG PortCount
, PortId
;
291 PIO_STACK_LOCATION IoStack
;
292 USHORT PortStatus
, PortChange
;
294 PUCHAR TransferBuffer
;
295 UCHAR Changed
= FALSE
;
298 // get current stack location
300 IoStack
= IoGetCurrentIrpStackLocation(Irp
);
306 Urb
= (PURB
)IoStack
->Parameters
.Others
.Argument1
;
310 // Get the number of ports and check each one for device connected
312 m_Hardware
->GetDeviceDetails(NULL
, NULL
, &PortCount
, NULL
);
313 DPRINT1("[USBLIB] SCE Request %p TransferBufferLength %lu Flags %x MDL %p\n", Urb
->UrbBulkOrInterruptTransfer
.TransferBuffer
, Urb
->UrbBulkOrInterruptTransfer
.TransferBufferLength
, Urb
->UrbBulkOrInterruptTransfer
.TransferFlags
, Urb
->UrbBulkOrInterruptTransfer
.TransferBufferMDL
);
315 TransferBuffer
= (PUCHAR
)Urb
->UrbBulkOrInterruptTransfer
.TransferBuffer
;
320 for (PortId
= 0; PortId
< PortCount
; PortId
++)
322 m_Hardware
->GetPortStatus(PortId
, &PortStatus
, &PortChange
);
324 DPRINT1("[USBLIB] Port %d: Status %x, Change %x\n", PortId
, PortStatus
, PortChange
);
328 // If theres a flag in PortChange return TRUE so the SCE Irp will be completed
332 DPRINT1("[USBLIB] Change state on port %d\n", PortId
);
333 // Set the value for the port number
334 *TransferBuffer
= 1 << ((PortId
+ 1) & 7);
342 //-----------------------------------------------------------------------------------------
344 CHubController::GetHubControllerDeviceObject(PDEVICE_OBJECT
* HubDeviceObject
)
347 // store controller object
349 *HubDeviceObject
= m_HubControllerDeviceObject
;
351 return STATUS_SUCCESS
;
353 //-----------------------------------------------------------------------------------------
355 CHubController::GetHubControllerSymbolicLink(
358 PULONG RequiredLength
)
360 if (!m_InterfaceEnabled
)
363 // device interface not yet enabled
365 return STATUS_UNSUCCESSFUL
;
368 if (BufferLength
< (ULONG
)m_HubDeviceInterfaceString
.Length
- 8)
372 // length is without '\??\'
374 *RequiredLength
= m_HubDeviceInterfaceString
.Length
- 8;
379 return STATUS_BUFFER_OVERFLOW
;
383 // copy symbolic link
385 RtlCopyMemory(Buffer
, &m_HubDeviceInterfaceString
.Buffer
[4], m_HubDeviceInterfaceString
.Length
- 8);
388 // store length, length is without '\??\'
390 *RequiredLength
= m_HubDeviceInterfaceString
.Length
- 8;
395 return STATUS_SUCCESS
;
398 //-----------------------------------------------------------------------------------------
400 CHubController::HandlePnp(
401 IN PDEVICE_OBJECT DeviceObject
,
404 PIO_STACK_LOCATION IoStack
;
405 PCOMMON_DEVICE_EXTENSION DeviceExtension
;
406 PDEVICE_CAPABILITIES DeviceCapabilities
;
407 PPNP_BUS_INFORMATION BusInformation
;
408 PDEVICE_RELATIONS DeviceRelations
;
410 ULONG Index
= 0, Length
;
411 USHORT VendorID
, DeviceID
;
412 ULONG HiSpeed
, NumPorts
;
417 // get device extension
419 DeviceExtension
= (PCOMMON_DEVICE_EXTENSION
)DeviceObject
->DeviceExtension
;
424 ASSERT(DeviceExtension
->IsFDO
== FALSE
);
427 // get current stack location
429 IoStack
= IoGetCurrentIrpStackLocation(Irp
);
431 switch(IoStack
->MinorFunction
)
433 case IRP_MN_START_DEVICE
:
435 DPRINT("[USBLIB] HandlePnp IRP_MN_START_DEVICE\n");
437 // register device interface
439 Status
= SetDeviceInterface(TRUE
);
442 case IRP_MN_QUERY_STOP_DEVICE
:
443 case IRP_MN_QUERY_REMOVE_DEVICE
:
448 Status
= STATUS_SUCCESS
;
451 case IRP_MN_QUERY_ID
:
453 DPRINT("[USBLIB] HandlePnp IRP_MN_QUERY_ID Type %x\n", IoStack
->Parameters
.QueryId
.IdType
);
455 if (IoStack
->Parameters
.QueryId
.IdType
== BusQueryDeviceID
)
462 Status
= m_Hardware
->GetDeviceDetails(&VendorID
, &DeviceID
, &NumPorts
, &HiSpeed
);
464 if (HiSpeed
== 0x200)
469 swprintf(Buffer
, L
"USB\\ROOT_HUB20");
476 swprintf(Buffer
, L
"USB\\ROOT_HUB");
479 DPRINT("Name %S\n", Buffer
);
484 Length
= (wcslen(Buffer
) + 1);
489 DeviceName
= (LPWSTR
)ExAllocatePoolWithTag(PagedPool
, Length
* sizeof(WCHAR
), TAG_USBLIB
);
496 Status
= STATUS_INSUFFICIENT_RESOURCES
;
503 wcscpy(DeviceName
, Buffer
);
508 Irp
->IoStatus
.Information
= (ULONG_PTR
)DeviceName
;
509 Status
= STATUS_SUCCESS
;
512 Status
= STATUS_UNSUCCESSFUL
;
517 if (IoStack
->Parameters
.QueryId
.IdType
== BusQueryHardwareIDs
)
524 Status
= m_Hardware
->GetDeviceDetails(&VendorID
, &DeviceID
, &NumPorts
, &HiSpeed
);
526 if (!NT_SUCCESS(Status
))
528 DPRINT1("[USBLIB] HandlePnp> failed to get hardware id %x\n", Status
);
533 if (HiSpeed
== 0x200)
538 Index
+= swprintf(&Buffer
[Index
], L
"USB\\ROOT_HUB20&VID%04x&PID%04x&REV0000", VendorID
, DeviceID
) + 1;
539 Index
+= swprintf(&Buffer
[Index
], L
"USB\\ROOT_HUB20&VID%04x&PID%04x", VendorID
, DeviceID
) + 1;
540 Index
+= swprintf(&Buffer
[Index
], L
"USB\\ROOT_HUB20") + 1;
547 Index
+= swprintf(&Buffer
[Index
], L
"USB\\ROOT_HUB&VID%04x&PID%04x&REV0000", VendorID
, DeviceID
) + 1;
548 Index
+= swprintf(&Buffer
[Index
], L
"USB\\ROOT_HUB&VID%04x&PID%04x", VendorID
, DeviceID
) + 1;
549 Index
+= swprintf(&Buffer
[Index
], L
"USB\\ROOT_HUB") + 1;
552 Buffer
[Index
] = UNICODE_NULL
;
556 DPRINT1("[USBLIB] Name %S\n", Buffer
);
561 DeviceName
= (LPWSTR
)ExAllocatePoolWithTag(PagedPool
, Index
* sizeof(WCHAR
), TAG_USBLIB
);
568 Status
= STATUS_INSUFFICIENT_RESOURCES
;
575 RtlMoveMemory(DeviceName
, Buffer
, Index
* sizeof(WCHAR
));
580 Irp
->IoStatus
.Information
= (ULONG_PTR
)DeviceName
;
581 Status
= STATUS_SUCCESS
;
585 Status
= STATUS_SUCCESS
;
588 case IRP_MN_QUERY_CAPABILITIES
:
590 DPRINT("[USBLIB] HandlePnp IRP_MN_QUERY_CAPABILITIES\n");
592 DeviceCapabilities
= (PDEVICE_CAPABILITIES
)IoStack
->Parameters
.DeviceCapabilities
.Capabilities
;
594 DeviceCapabilities
->LockSupported
= FALSE
;
595 DeviceCapabilities
->EjectSupported
= FALSE
;
596 DeviceCapabilities
->Removable
= FALSE
;
597 DeviceCapabilities
->DockDevice
= FALSE
;
598 DeviceCapabilities
->UniqueID
= FALSE
;
599 DeviceCapabilities
->SilentInstall
= FALSE
;
600 DeviceCapabilities
->RawDeviceOK
= FALSE
;
601 DeviceCapabilities
->SurpriseRemovalOK
= FALSE
;
602 DeviceCapabilities
->Address
= 0;
603 DeviceCapabilities
->UINumber
= 0;
604 DeviceCapabilities
->DeviceD2
= 1;
607 DeviceCapabilities
->HardwareDisabled
= FALSE
;
608 DeviceCapabilities
->NoDisplayInUI
= FALSE
;
609 DeviceCapabilities
->DeviceState
[0] = PowerDeviceD0
;
610 for (Index
= 1; Index
< PowerSystemMaximum
; Index
++)
611 DeviceCapabilities
->DeviceState
[Index
] = PowerDeviceD3
;
612 DeviceCapabilities
->DeviceWake
= PowerDeviceUnspecified
;
613 DeviceCapabilities
->D1Latency
= 0;
614 DeviceCapabilities
->D2Latency
= 0;
615 DeviceCapabilities
->D3Latency
= 0;
617 Status
= STATUS_SUCCESS
;
620 case IRP_MN_QUERY_INTERFACE
:
622 DPRINT("[USBLIB] HandlePnp IRP_MN_QUERY_INTERFACE\n");
625 // handle device interface requests
627 Status
= HandleQueryInterface(IoStack
);
630 case IRP_MN_REMOVE_DEVICE
:
632 DPRINT("[USBLIB] HandlePnp IRP_MN_REMOVE_DEVICE\n");
635 // deactivate device interface for BUS PDO
637 SetDeviceInterface(FALSE
);
640 // complete the request first
642 Irp
->IoStatus
.Status
= STATUS_SUCCESS
;
643 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
648 IoDeleteDevice(m_HubControllerDeviceObject
);
653 m_HubControllerDeviceObject
= 0;
658 return STATUS_SUCCESS
;
660 case IRP_MN_QUERY_DEVICE_RELATIONS
:
662 DPRINT("[USBLIB] HandlePnp IRP_MN_QUERY_DEVICE_RELATIONS Type %x\n", IoStack
->Parameters
.QueryDeviceRelations
.Type
);
664 if (IoStack
->Parameters
.QueryDeviceRelations
.Type
== TargetDeviceRelation
)
667 // allocate device relations
669 DeviceRelations
= (PDEVICE_RELATIONS
)ExAllocatePoolWithTag(PagedPool
, sizeof(DEVICE_RELATIONS
), TAG_USBLIB
);
670 if (!DeviceRelations
)
675 Status
= STATUS_INSUFFICIENT_RESOURCES
;
680 // initialize device relations
682 DeviceRelations
->Count
= 1;
683 DeviceRelations
->Objects
[0] = DeviceObject
;
684 ObReferenceObject(DeviceObject
);
689 Status
= STATUS_SUCCESS
;
690 Irp
->IoStatus
.Information
= (ULONG_PTR
)DeviceRelations
;
697 Status
= Irp
->IoStatus
.Status
;
701 case IRP_MN_QUERY_BUS_INFORMATION
:
703 DPRINT("[USBLIB] HandlePnp IRP_MN_QUERY_BUS_INFORMATION\n");
706 // allocate buffer for bus information
708 BusInformation
= (PPNP_BUS_INFORMATION
)ExAllocatePool(PagedPool
, sizeof(PNP_BUS_INFORMATION
));
714 RtlMoveMemory(&BusInformation
->BusTypeGuid
, &GUID_BUS_TYPE_USB
, sizeof(GUID
));
719 BusInformation
->LegacyBusType
= PNPBus
;
720 BusInformation
->BusNumber
= 0;
722 Status
= STATUS_SUCCESS
;
723 Irp
->IoStatus
.Information
= (ULONG_PTR
)BusInformation
;
730 Status
= STATUS_INSUFFICIENT_RESOURCES
;
734 case IRP_MN_STOP_DEVICE
:
736 DPRINT("[USBLIB] HandlePnp IRP_MN_STOP_DEVICE\n");
740 Status
= STATUS_SUCCESS
;
743 case IRP_MN_SURPRISE_REMOVAL
:
745 DPRINT("[USBLIB] HandlePnp IRP_MN_SURPRISE_REMOVAL\n");
746 Status
= STATUS_SUCCESS
;
752 // ignore request with default status
754 Status
= Irp
->IoStatus
.Status
;
762 Irp
->IoStatus
.Status
= Status
;
763 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
771 //-----------------------------------------------------------------------------------------
773 CHubController::HandlePower(
774 IN PDEVICE_OBJECT DeviceObject
,
778 Irp
->IoStatus
.Status
= STATUS_NOT_IMPLEMENTED
;
779 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
780 return STATUS_NOT_IMPLEMENTED
;
783 //-----------------------------------------------------------------------------------------
785 CHubController::HandleIsochronousTransfer(
789 PUSBDEVICE UsbDevice
;
790 PUSB_ENDPOINT_DESCRIPTOR EndPointDesc
= NULL
;
793 // Check PipeHandle to determine if this is a Bulk or Interrupt Transfer Request
795 EndPointDesc
= (PUSB_ENDPOINT_DESCRIPTOR
)Urb
->UrbIsochronousTransfer
.PipeHandle
;
799 DPRINT1("[USBLIB] Error No EndpointDesc\n");
800 Urb
->UrbIsochronousTransfer
.Hdr
.Status
= USBD_STATUS_INVALID_PIPE_HANDLE
;
801 return STATUS_INVALID_PARAMETER
;
807 ASSERT(EndPointDesc
);
808 DPRINT("HandleIsochronousTransfer EndPointDesc %p Address %x bmAttributes %x\n", EndPointDesc
, EndPointDesc
->bEndpointAddress
, EndPointDesc
->bmAttributes
);
809 ASSERT((EndPointDesc
->bmAttributes
& USB_ENDPOINT_TYPE_MASK
) == USB_ENDPOINT_TYPE_ISOCHRONOUS
);
812 // check if this is a valid usb device handle
814 if (!ValidateUsbDevice(PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
)))
816 DPRINT1("[USBLIB] HandleIsochronousTransfer invalid device handle %p\n", Urb
->UrbHeader
.UsbdDeviceHandle
);
819 // invalid device handle
821 return STATUS_DEVICE_NOT_CONNECTED
;
827 UsbDevice
= PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
);
829 return UsbDevice
->SubmitIrp(Irp
);
832 //-----------------------------------------------------------------------------------------
834 CHubController::HandleBulkOrInterruptTransfer(
838 PUSBDEVICE UsbDevice
;
839 PUSB_ENDPOINT EndPointDesc
= NULL
;
841 // First check if the request is for the Status Change Endpoint
845 // Is the Request for the root hub
847 if (Urb
->UrbHeader
.UsbdDeviceHandle
== PVOID(this))
849 ASSERT(m_PendingSCEIrp
== NULL
);
850 if (QueryStatusChageEndpoint(Irp
))
852 StatusChangeEndpointCallBack(this);
853 return STATUS_SUCCESS
;
857 // Else pend the IRP, to be completed when a device connects or disconnects.
859 DPRINT("[USBLIB] Pending SCE Irp\n");
860 m_PendingSCEIrp
= Irp
;
861 IoMarkIrpPending(Irp
);
862 return STATUS_PENDING
;
866 // Check PipeHandle to determine if this is a Bulk or Interrupt Transfer Request
868 EndPointDesc
= (PUSB_ENDPOINT
)Urb
->UrbBulkOrInterruptTransfer
.PipeHandle
;
873 ASSERT(EndPointDesc
);
874 ASSERT((EndPointDesc
->EndPointDescriptor
.bmAttributes
& USB_ENDPOINT_TYPE_MASK
) == USB_ENDPOINT_TYPE_BULK
|| (EndPointDesc
->EndPointDescriptor
.bmAttributes
& USB_ENDPOINT_TYPE_MASK
) == USB_ENDPOINT_TYPE_INTERRUPT
);
877 // check if this is a valid usb device handle
879 if (!ValidateUsbDevice(PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
)))
881 DPRINT1("[USBLIB] HandleBulkOrInterruptTransfer invalid device handle %p\n", Urb
->UrbHeader
.UsbdDeviceHandle
);
884 // invalid device handle
886 return STATUS_DEVICE_NOT_CONNECTED
;
892 UsbDevice
= PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
);
893 return UsbDevice
->SubmitIrp(Irp
);
896 //-----------------------------------------------------------------------------------------
898 CHubController::HandleClassOther(
902 NTSTATUS Status
= STATUS_NOT_IMPLEMENTED
;
903 USHORT PortStatus
= 0, PortChange
= 0;
908 DPRINT("[USBLIB] HandleClassOther> Request %x Value %x\n", Urb
->UrbControlVendorClassRequest
.Request
, Urb
->UrbControlVendorClassRequest
.Value
);
911 // get number of ports available
913 Status
= m_Hardware
->GetDeviceDetails(NULL
, NULL
, &NumPort
, NULL
);
914 PC_ASSERT(Status
== STATUS_SUCCESS
);
919 PC_ASSERT(Urb
->UrbControlVendorClassRequest
.Index
- 1 < (USHORT
)NumPort
);
922 // port range reported start from 1 -n
923 // convert back port id so it matches the hardware
925 PortId
= Urb
->UrbControlVendorClassRequest
.Index
- 1;
928 // check request code
930 switch(Urb
->UrbControlVendorClassRequest
.Request
)
932 case USB_REQUEST_GET_STATUS
:
937 PC_ASSERT(Urb
->UrbControlVendorClassRequest
.TransferBufferLength
== sizeof(USHORT
) * 2);
938 PC_ASSERT(Urb
->UrbControlVendorClassRequest
.TransferBuffer
);
943 Status
= m_Hardware
->GetPortStatus(PortId
, &PortStatus
, &PortChange
);
945 if (NT_SUCCESS(Status
))
948 // request contains buffer of 2 ushort which are used from submitting port status and port change status
950 DPRINT("[USBLIB] PortId %x PortStatus %x PortChange %x\n", PortId
, PortStatus
, PortChange
);
951 Buffer
= (PUSHORT
)Urb
->UrbControlVendorClassRequest
.TransferBuffer
;
954 // store status, then port change
956 *Buffer
= PortStatus
;
958 *Buffer
= PortChange
;
966 case USB_REQUEST_CLEAR_FEATURE
:
968 switch (Urb
->UrbControlVendorClassRequest
.Value
)
970 case C_PORT_CONNECTION
:
971 Status
= m_Hardware
->ClearPortStatus(PortId
, C_PORT_CONNECTION
);
974 Status
= m_Hardware
->ClearPortStatus(PortId
, C_PORT_RESET
);
977 DPRINT("[USBLIB] Unknown Value for Clear Feature %x \n", Urb
->UrbControlVendorClassRequest
.Value
);
983 case USB_REQUEST_SET_FEATURE
:
986 // request set feature
988 switch(Urb
->UrbControlVendorClassRequest
.Value
)
993 // port enable is a no-op for EHCI
995 Status
= STATUS_SUCCESS
;
1002 // set suspend port feature
1004 Status
= m_Hardware
->SetPortFeature(PortId
, PORT_SUSPEND
);
1010 // set power feature on port
1012 Status
= m_Hardware
->SetPortFeature(PortId
, PORT_POWER
);
1019 // reset port feature
1021 Status
= m_Hardware
->SetPortFeature(PortId
, PORT_RESET
);
1022 PC_ASSERT(Status
== STATUS_SUCCESS
);
1026 DPRINT1("[USBLIB] Unsupported request id %x\n", Urb
->UrbControlVendorClassRequest
.Value
);
1032 DPRINT1("[USBLIB] HandleClassOther Unknown request code %x\n", Urb
->UrbControlVendorClassRequest
.Request
);
1034 Status
= STATUS_INVALID_DEVICE_REQUEST
;
1039 //-----------------------------------------------------------------------------------------
1041 CHubController::HandleSelectConfiguration(
1045 PUSBDEVICE UsbDevice
;
1046 PUSBD_INTERFACE_INFORMATION InterfaceInfo
;
1049 // is the request for the Root Hub
1051 if (Urb
->UrbHeader
.UsbdDeviceHandle
== NULL
)
1054 // FIXME: support setting device to unconfigured state
1056 PC_ASSERT(Urb
->UrbSelectConfiguration
.ConfigurationDescriptor
);
1059 // set device handle
1061 Urb
->UrbSelectConfiguration
.ConfigurationHandle
= (PVOID
)&ROOTHUB2_CONFIGURATION_DESCRIPTOR
;
1064 // copy interface info
1066 InterfaceInfo
= &Urb
->UrbSelectConfiguration
.Interface
;
1068 InterfaceInfo
->InterfaceHandle
= (USBD_INTERFACE_HANDLE
)&ROOTHUB2_INTERFACE_DESCRIPTOR
;
1069 InterfaceInfo
->Class
= ROOTHUB2_INTERFACE_DESCRIPTOR
.bInterfaceClass
;
1070 InterfaceInfo
->SubClass
= ROOTHUB2_INTERFACE_DESCRIPTOR
.bInterfaceSubClass
;
1071 InterfaceInfo
->Protocol
= ROOTHUB2_INTERFACE_DESCRIPTOR
.bInterfaceProtocol
;
1072 InterfaceInfo
->Reserved
= 0;
1077 PC_ASSERT(InterfaceInfo
->NumberOfPipes
== 1);
1082 InterfaceInfo
->Pipes
[0].MaximumPacketSize
= ROOTHUB2_ENDPOINT_DESCRIPTOR
.wMaxPacketSize
;
1083 InterfaceInfo
->Pipes
[0].EndpointAddress
= ROOTHUB2_ENDPOINT_DESCRIPTOR
.bEndpointAddress
;
1084 InterfaceInfo
->Pipes
[0].Interval
= ROOTHUB2_ENDPOINT_DESCRIPTOR
.bInterval
;
1085 InterfaceInfo
->Pipes
[0].PipeType
= (USBD_PIPE_TYPE
)(ROOTHUB2_ENDPOINT_DESCRIPTOR
.bmAttributes
& USB_ENDPOINT_TYPE_MASK
);
1086 InterfaceInfo
->Pipes
[0].PipeHandle
= (PVOID
)&ROOTHUB2_ENDPOINT_DESCRIPTOR
;
1088 return STATUS_SUCCESS
;
1093 // check if this is a valid usb device handle
1095 if (!ValidateUsbDevice(PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
)))
1097 DPRINT1("[USBLIB] HandleSelectConfiguration invalid device handle %p\n", Urb
->UrbHeader
.UsbdDeviceHandle
);
1100 // invalid device handle
1102 return STATUS_DEVICE_NOT_CONNECTED
;
1108 UsbDevice
= PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
);
1111 // select configuration
1113 return UsbDevice
->SelectConfiguration(Urb
->UrbSelectConfiguration
.ConfigurationDescriptor
, &Urb
->UrbSelectConfiguration
.Interface
, &Urb
->UrbSelectConfiguration
.ConfigurationHandle
);
1117 //-----------------------------------------------------------------------------------------
1119 CHubController::HandleSelectInterface(
1123 PUSBDEVICE UsbDevice
;
1128 PC_ASSERT(Urb
->UrbSelectInterface
.ConfigurationHandle
);
1131 // is the request for the Root Hub
1133 if (Urb
->UrbHeader
.UsbdDeviceHandle
== NULL
)
1136 // no op for root hub
1138 return STATUS_SUCCESS
;
1143 // check if this is a valid usb device handle
1145 if (!ValidateUsbDevice(PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
)))
1147 DPRINT1("[USBLIB] HandleSelectInterface invalid device handle %p\n", Urb
->UrbHeader
.UsbdDeviceHandle
);
1150 // invalid device handle
1152 return STATUS_DEVICE_NOT_CONNECTED
;
1158 UsbDevice
= PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
);
1163 return UsbDevice
->SelectInterface(Urb
->UrbSelectInterface
.ConfigurationHandle
, &Urb
->UrbSelectInterface
.Interface
);
1167 //-----------------------------------------------------------------------------------------
1169 CHubController::HandleGetStatusFromDevice(
1173 PUSHORT DeviceStatus
;
1174 USB_DEFAULT_PIPE_SETUP_PACKET CtrlSetup
;
1176 PUSBDEVICE UsbDevice
;
1181 PC_ASSERT(Urb
->UrbControlGetStatusRequest
.TransferBufferLength
>= sizeof(USHORT
));
1182 PC_ASSERT(Urb
->UrbControlGetStatusRequest
.TransferBuffer
);
1185 // get status buffer
1187 DeviceStatus
= (PUSHORT
)Urb
->UrbControlGetStatusRequest
.TransferBuffer
;
1190 if (Urb
->UrbHeader
.UsbdDeviceHandle
== PVOID(this))
1193 // FIXME need more flags ?
1195 *DeviceStatus
= USB_PORT_STATUS_CONNECT
;
1196 return STATUS_SUCCESS
;
1200 // check if this is a valid usb device handle
1202 if (!ValidateUsbDevice(PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
)))
1204 DPRINT1("[USBLIB] HandleGetStatusFromDevice invalid device handle %p\n", Urb
->UrbHeader
.UsbdDeviceHandle
);
1207 // invalid device handle
1209 return STATUS_DEVICE_NOT_CONNECTED
;
1215 UsbDevice
= PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
);
1219 // generate setup packet
1221 CtrlSetup
.bRequest
= USB_REQUEST_GET_STATUS
;
1222 CtrlSetup
.wValue
.LowByte
= 0;
1223 CtrlSetup
.wValue
.HiByte
= 0;
1224 CtrlSetup
.wIndex
.W
= Urb
->UrbControlGetStatusRequest
.Index
;
1225 CtrlSetup
.wLength
= (USHORT
)Urb
->UrbControlGetStatusRequest
.TransferBufferLength
;
1226 CtrlSetup
.bmRequestType
.B
= 0x80;
1228 if (Urb
->UrbHeader
.Function
== URB_FUNCTION_GET_STATUS_FROM_INTERFACE
)
1231 // add interface type
1233 CtrlSetup
.bmRequestType
.B
|= 0x01;
1235 else if (Urb
->UrbHeader
.Function
== URB_FUNCTION_GET_STATUS_FROM_ENDPOINT
)
1238 // add interface type
1240 CtrlSetup
.bmRequestType
.B
|= 0x02;
1244 // submit setup packet
1246 Status
= UsbDevice
->SubmitSetupPacket(&CtrlSetup
, Urb
->UrbControlDescriptorRequest
.TransferBufferLength
, Urb
->UrbControlDescriptorRequest
.TransferBuffer
);
1247 ASSERT(Status
== STATUS_SUCCESS
);
1248 DPRINT1("[USBLIB] HandleGetStatusFromDevice Status %x Length %lu DeviceStatus %x\n", Status
, Urb
->UrbControlDescriptorRequest
.TransferBufferLength
, *DeviceStatus
);
1256 //-----------------------------------------------------------------------------------------
1258 CHubController::HandleClassDevice(
1262 NTSTATUS Status
= STATUS_NOT_IMPLEMENTED
;
1263 PUSB_HUB_DESCRIPTOR UsbHubDescriptor
;
1264 ULONG PortCount
, Dummy2
;
1266 PUSBDEVICE UsbDevice
;
1267 USB_DEFAULT_PIPE_SETUP_PACKET CtrlSetup
;
1269 DPRINT("CHubController::HandleClassDevice Request %x Class %x\n", Urb
->UrbControlVendorClassRequest
.Request
, Urb
->UrbControlVendorClassRequest
.Value
>> 8);
1272 // check class request type
1274 switch(Urb
->UrbControlVendorClassRequest
.Request
)
1276 case USB_REQUEST_GET_STATUS
:
1279 // check if this is a valid usb device handle
1281 if (!ValidateUsbDevice(PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
)))
1283 DPRINT1("HandleClassDevice invalid device handle %p\n", Urb
->UrbHeader
.UsbdDeviceHandle
);
1286 // invalid device handle
1288 return STATUS_DEVICE_NOT_CONNECTED
;
1294 UsbDevice
= PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
);
1298 // generate setup packet
1300 CtrlSetup
.bRequest
= USB_REQUEST_GET_STATUS
;
1301 CtrlSetup
.wValue
.W
= Urb
->UrbControlVendorClassRequest
.Value
;
1302 CtrlSetup
.wIndex
.W
= Urb
->UrbControlVendorClassRequest
.Index
;
1303 CtrlSetup
.wLength
= (USHORT
)Urb
->UrbControlGetStatusRequest
.TransferBufferLength
;
1304 CtrlSetup
.bmRequestType
.B
= 0xA0;
1307 // submit setup packet
1309 Status
= UsbDevice
->SubmitSetupPacket(&CtrlSetup
, Urb
->UrbControlDescriptorRequest
.TransferBufferLength
, Urb
->UrbControlDescriptorRequest
.TransferBuffer
);
1310 ASSERT(Status
== STATUS_SUCCESS
);
1313 case USB_REQUEST_GET_DESCRIPTOR
:
1315 switch (Urb
->UrbControlVendorClassRequest
.Value
>> 8)
1317 case USB_DEVICE_CLASS_RESERVED
: // FALL THROUGH
1318 case USB_DEVICE_CLASS_HUB
:
1320 if (Urb
->UrbHeader
.UsbdDeviceHandle
== PVOID(this))
1325 PC_ASSERT(Urb
->UrbControlVendorClassRequest
.TransferBuffer
);
1326 PC_ASSERT(Urb
->UrbControlVendorClassRequest
.TransferBufferLength
>= sizeof(USB_HUB_DESCRIPTOR
));
1329 // get hub descriptor
1331 UsbHubDescriptor
= (PUSB_HUB_DESCRIPTOR
)Urb
->UrbControlVendorClassRequest
.TransferBuffer
;
1334 // one hub is handled
1336 UsbHubDescriptor
->bDescriptorLength
= sizeof(USB_HUB_DESCRIPTOR
);
1337 Urb
->UrbControlVendorClassRequest
.TransferBufferLength
= sizeof(USB_HUB_DESCRIPTOR
);
1340 // type should 0x29 according to msdn
1342 UsbHubDescriptor
->bDescriptorType
= 0x29;
1347 Status
= m_Hardware
->GetDeviceDetails(&Dummy1
, &Dummy1
, &PortCount
, &Dummy2
);
1348 PC_ASSERT(Status
== STATUS_SUCCESS
);
1351 // FIXME: retrieve values
1353 UsbHubDescriptor
->bNumberOfPorts
= (UCHAR
)PortCount
;
1354 UsbHubDescriptor
->wHubCharacteristics
= 0x00;
1355 UsbHubDescriptor
->bPowerOnToPowerGood
= 0x01;
1356 UsbHubDescriptor
->bHubControlCurrent
= 0x00;
1361 Status
= STATUS_SUCCESS
;
1365 if (!ValidateUsbDevice(PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
)))
1367 DPRINT1("HandleClassDevice invalid device handle %p\n", Urb
->UrbHeader
.UsbdDeviceHandle
);
1369 // invalid device handle
1371 return STATUS_DEVICE_NOT_CONNECTED
;
1375 // FIXME: implement support for real hubs
1378 Status
= STATUS_NOT_IMPLEMENTED
;
1383 DPRINT1("[USBLIB] HandleClassDevice Class %x not implemented\n", Urb
->UrbControlVendorClassRequest
.Value
>> 8);
1391 // check if this is a valid usb device handle
1393 if (!ValidateUsbDevice(PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
)))
1395 DPRINT1("HandleClassDevice invalid device handle %p\n", Urb
->UrbHeader
.UsbdDeviceHandle
);
1398 // invalid device handle
1400 return STATUS_DEVICE_NOT_CONNECTED
;
1406 UsbDevice
= PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
);
1409 // generate setup packet
1411 CtrlSetup
.bmRequestType
.B
= 0;
1412 CtrlSetup
.bmRequestType
._BM
.Recipient
= BMREQUEST_TO_DEVICE
;
1413 CtrlSetup
.bmRequestType
._BM
.Type
= BMREQUEST_CLASS
;
1414 CtrlSetup
.bRequest
= Urb
->UrbControlVendorClassRequest
.Request
;
1415 CtrlSetup
.wValue
.W
= Urb
->UrbControlVendorClassRequest
.Value
;
1416 CtrlSetup
.wIndex
.W
= Urb
->UrbControlVendorClassRequest
.Index
;
1417 CtrlSetup
.wLength
= (USHORT
)Urb
->UrbControlVendorClassRequest
.TransferBufferLength
;
1419 if (Urb
->UrbControlVendorClassRequest
.TransferFlags
& USBD_TRANSFER_DIRECTION_IN
)
1422 // data direction is device to host
1424 CtrlSetup
.bmRequestType
._BM
.Dir
= BMREQUEST_DEVICE_TO_HOST
;
1428 // submit setup packet
1430 Status
= UsbDevice
->SubmitSetupPacket(&CtrlSetup
, Urb
->UrbControlDescriptorRequest
.TransferBufferLength
, Urb
->UrbControlDescriptorRequest
.TransferBuffer
);
1431 ASSERT(Status
== STATUS_SUCCESS
);
1440 //-----------------------------------------------------------------------------------------
1442 CHubController::HandleGetDescriptorFromInterface(
1446 PUSBDEVICE UsbDevice
;
1447 USB_DEFAULT_PIPE_SETUP_PACKET CtrlSetup
;
1453 ASSERT(Urb
->UrbControlDescriptorRequest
.TransferBufferLength
);
1454 ASSERT(Urb
->UrbControlDescriptorRequest
.TransferBuffer
);
1457 // check if this is a valid usb device handle
1459 if (!ValidateUsbDevice(PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
)))
1461 DPRINT1("[USBLIB] HandleGetDescriptorFromInterface invalid device handle %p\n", Urb
->UrbHeader
.UsbdDeviceHandle
);
1464 // invalid device handle
1466 return STATUS_DEVICE_NOT_CONNECTED
;
1472 UsbDevice
= PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
);
1475 // generate setup packet
1477 CtrlSetup
.bRequest
= USB_REQUEST_GET_DESCRIPTOR
;
1478 CtrlSetup
.wValue
.LowByte
= Urb
->UrbControlDescriptorRequest
.Index
;
1479 CtrlSetup
.wValue
.HiByte
= Urb
->UrbControlDescriptorRequest
.DescriptorType
;
1480 CtrlSetup
.wIndex
.W
= Urb
->UrbControlDescriptorRequest
.LanguageId
;
1481 CtrlSetup
.wLength
= (USHORT
)Urb
->UrbControlDescriptorRequest
.TransferBufferLength
;
1482 CtrlSetup
.bmRequestType
.B
= 0x81;
1485 // submit setup packet
1487 Status
= UsbDevice
->SubmitSetupPacket(&CtrlSetup
, Urb
->UrbControlDescriptorRequest
.TransferBufferLength
, Urb
->UrbControlDescriptorRequest
.TransferBuffer
);
1488 if (!NT_SUCCESS(Status
))
1490 DPRINT1("[USBLIB] HandleGetDescriptorFromInterface failed with %x\n", Status
);
1499 //-----------------------------------------------------------------------------------------
1501 CHubController::HandleGetDescriptor(
1505 NTSTATUS Status
= STATUS_NOT_IMPLEMENTED
;
1506 USB_DEFAULT_PIPE_SETUP_PACKET CtrlSetup
;
1508 PUSBDEVICE UsbDevice
;
1509 ULONG Length
, BufferLength
;
1511 DPRINT("[USBLIB] HandleGetDescriptor Type %x\n", Urb
->UrbControlDescriptorRequest
.DescriptorType
);
1514 // check descriptor type
1516 switch(Urb
->UrbControlDescriptorRequest
.DescriptorType
)
1518 case USB_DEVICE_DESCRIPTOR_TYPE
:
1523 PC_ASSERT(Urb
->UrbControlDescriptorRequest
.TransferBufferLength
>= sizeof(USB_DEVICE_DESCRIPTOR
));
1524 PC_ASSERT(Urb
->UrbControlDescriptorRequest
.TransferBuffer
);
1526 if (Urb
->UrbHeader
.UsbdDeviceHandle
== PVOID(this))
1529 // copy root hub device descriptor
1531 RtlCopyMemory((PUCHAR
)Urb
->UrbControlDescriptorRequest
.TransferBuffer
, &m_DeviceDescriptor
, sizeof(USB_DEVICE_DESCRIPTOR
));
1532 Irp
->IoStatus
.Information
= sizeof(USB_DEVICE_DESCRIPTOR
);
1533 Urb
->UrbControlDescriptorRequest
.Hdr
.Status
= USBD_STATUS_SUCCESS
;
1534 Status
= STATUS_SUCCESS
;
1539 // check if this is a valid usb device handle
1541 if (!ValidateUsbDevice(PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
)))
1543 DPRINT1("[USBLIB] HandleGetDescriptor invalid device handle %p\n", Urb
->UrbHeader
.UsbdDeviceHandle
);
1546 // invalid device handle
1548 return STATUS_DEVICE_NOT_CONNECTED
;
1554 UsbDevice
= PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
);
1557 // retrieve device descriptor from device
1559 UsbDevice
->GetDeviceDescriptor((PUSB_DEVICE_DESCRIPTOR
)Urb
->UrbControlDescriptorRequest
.TransferBuffer
);
1560 Irp
->IoStatus
.Information
= sizeof(USB_DEVICE_DESCRIPTOR
);
1561 Urb
->UrbControlDescriptorRequest
.Hdr
.Status
= USBD_STATUS_SUCCESS
;
1562 Status
= STATUS_SUCCESS
;
1566 case USB_CONFIGURATION_DESCRIPTOR_TYPE
:
1571 PC_ASSERT(Urb
->UrbControlDescriptorRequest
.TransferBuffer
);
1574 // The caller must allocate a buffer large enough to hold all of this information or the data is truncated without error.
1576 BufferLength
= Urb
->UrbControlDescriptorRequest
.TransferBufferLength
;
1577 Buffer
= (PUCHAR
) Urb
->UrbControlDescriptorRequest
.TransferBuffer
;
1579 if (Urb
->UrbHeader
.UsbdDeviceHandle
== PVOID(this))
1582 // request is for the root bus controller
1584 Length
= BufferLength
> sizeof(USB_CONFIGURATION_DESCRIPTOR
) ?
1585 sizeof(USB_CONFIGURATION_DESCRIPTOR
) : BufferLength
;
1586 RtlCopyMemory(Buffer
, &ROOTHUB2_CONFIGURATION_DESCRIPTOR
, Length
);
1589 // Check if we still have some space left
1591 if(Length
== BufferLength
)
1594 // We copied all we could
1596 Status
= STATUS_SUCCESS
;
1603 BufferLength
-= Length
;
1606 // copy interface descriptor template
1608 Length
= BufferLength
> sizeof(USB_INTERFACE_DESCRIPTOR
) ?
1609 sizeof(USB_INTERFACE_DESCRIPTOR
) : BufferLength
;
1610 RtlCopyMemory(Buffer
, &ROOTHUB2_INTERFACE_DESCRIPTOR
, Length
);
1613 // Check if we still have some space left
1615 if(Length
== BufferLength
)
1618 // We copied all we could
1620 Status
= STATUS_SUCCESS
;
1627 BufferLength
-= Length
;
1631 // copy end point descriptor template
1633 Length
= BufferLength
> sizeof(USB_ENDPOINT_DESCRIPTOR
) ?
1634 sizeof(USB_ENDPOINT_DESCRIPTOR
) : BufferLength
;
1635 RtlCopyMemory(Buffer
, &ROOTHUB2_ENDPOINT_DESCRIPTOR
, Length
);
1640 Status
= STATUS_SUCCESS
;
1646 // check if this is a valid usb device handle
1648 if (!ValidateUsbDevice(PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
)))
1650 DPRINT1("[USBLIB] USB_CONFIGURATION_DESCRIPTOR_TYPE invalid device handle %p\n", Urb
->UrbHeader
.UsbdDeviceHandle
);
1653 // invalid device handle
1655 return STATUS_DEVICE_NOT_CONNECTED
;
1661 UsbDevice
= PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
);
1664 // Allocate temporary buffer
1666 BufferLength
= UsbDevice
->GetConfigurationDescriptorsLength();
1667 Buffer
= (PUCHAR
)ExAllocatePoolWithTag(NonPagedPool
, BufferLength
, TAG_USBLIB
);
1670 Status
= STATUS_NO_MEMORY
;
1675 // perform work in IUSBDevice
1677 UsbDevice
->GetConfigurationDescriptors((PUSB_CONFIGURATION_DESCRIPTOR
)Buffer
, BufferLength
, &Length
);
1682 Length
= Urb
->UrbControlDescriptorRequest
.TransferBufferLength
> Length
?
1683 Length
: Urb
->UrbControlDescriptorRequest
.TransferBufferLength
;
1684 RtlCopyMemory(Urb
->UrbControlDescriptorRequest
.TransferBuffer
, Buffer
, Length
);
1687 // Free temporary buffer
1689 ExFreePoolWithTag(Buffer
, TAG_USBLIB
);
1692 // store result size
1694 Irp
->IoStatus
.Information
= Length
;
1695 Urb
->UrbControlDescriptorRequest
.TransferBufferLength
= Length
;
1696 Urb
->UrbControlDescriptorRequest
.Hdr
.Status
= USBD_STATUS_SUCCESS
;
1697 Status
= STATUS_SUCCESS
;
1701 case USB_STRING_DESCRIPTOR_TYPE
:
1706 PC_ASSERT(Urb
->UrbControlDescriptorRequest
.TransferBuffer
);
1707 PC_ASSERT(Urb
->UrbControlDescriptorRequest
.TransferBufferLength
);
1711 // check if this is a valid usb device handle
1713 if (!ValidateUsbDevice(PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
)))
1715 DPRINT1("[USBLIB] USB_STRING_DESCRIPTOR_TYPE invalid device handle %p\n", Urb
->UrbHeader
.UsbdDeviceHandle
);
1718 // invalid device handle
1720 return STATUS_DEVICE_NOT_CONNECTED
;
1726 UsbDevice
= PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
);
1729 // generate setup packet
1731 CtrlSetup
.bRequest
= USB_REQUEST_GET_DESCRIPTOR
;
1732 CtrlSetup
.wValue
.LowByte
= Urb
->UrbControlDescriptorRequest
.Index
;
1733 CtrlSetup
.wValue
.HiByte
= Urb
->UrbControlDescriptorRequest
.DescriptorType
;
1734 CtrlSetup
.wIndex
.W
= Urb
->UrbControlDescriptorRequest
.LanguageId
;
1735 CtrlSetup
.wLength
= (USHORT
)Urb
->UrbControlDescriptorRequest
.TransferBufferLength
;
1736 CtrlSetup
.bmRequestType
.B
= 0x80;
1739 // submit setup packet
1741 Status
= UsbDevice
->SubmitSetupPacket(&CtrlSetup
, Urb
->UrbControlDescriptorRequest
.TransferBufferLength
, Urb
->UrbControlDescriptorRequest
.TransferBuffer
);
1745 DPRINT1("[USBLIB] CHubController::HandleGetDescriptor DescriptorType %x unimplemented\n", Urb
->UrbControlDescriptorRequest
.DescriptorType
);
1755 //-----------------------------------------------------------------------------------------
1757 CHubController::HandleClassEndpoint(
1761 USB_DEFAULT_PIPE_SETUP_PACKET CtrlSetup
;
1763 PUSBDEVICE UsbDevice
;
1768 PC_ASSERT(Urb
->UrbControlVendorClassRequest
.TransferBuffer
);
1769 PC_ASSERT(Urb
->UrbControlVendorClassRequest
.TransferBufferLength
);
1770 PC_ASSERT(Urb
->UrbHeader
.UsbdDeviceHandle
);
1773 // check if this is a valid usb device handle
1775 if (!ValidateUsbDevice(PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
)))
1777 DPRINT1("[USBLIB] HandleClassEndpoint invalid device handle %p\n", Urb
->UrbHeader
.UsbdDeviceHandle
);
1780 // invalid device handle
1782 return STATUS_DEVICE_NOT_CONNECTED
;
1788 UsbDevice
= PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
);
1791 DPRINT1("URB_FUNCTION_CLASS_ENDPOINT\n");
1792 DPRINT1("TransferFlags %x\n", Urb
->UrbControlVendorClassRequest
.TransferFlags
);
1793 DPRINT1("TransferBufferLength %x\n", Urb
->UrbControlVendorClassRequest
.TransferBufferLength
);
1794 DPRINT1("TransferBuffer %x\n", Urb
->UrbControlVendorClassRequest
.TransferBuffer
);
1795 DPRINT1("TransferBufferMDL %x\n", Urb
->UrbControlVendorClassRequest
.TransferBufferMDL
);
1796 DPRINT1("RequestTypeReservedBits %x\n", Urb
->UrbControlVendorClassRequest
.RequestTypeReservedBits
);
1797 DPRINT1("Request %x\n", Urb
->UrbControlVendorClassRequest
.Request
);
1798 DPRINT1("Value %x\n", Urb
->UrbControlVendorClassRequest
.Value
);
1799 DPRINT1("Index %x\n", Urb
->UrbControlVendorClassRequest
.Index
);
1802 // initialize setup packet
1804 CtrlSetup
.bmRequestType
.B
= 0x22; //FIXME: Const.
1805 CtrlSetup
.bRequest
= Urb
->UrbControlVendorClassRequest
.Request
;
1806 CtrlSetup
.wValue
.W
= Urb
->UrbControlVendorClassRequest
.Value
;
1807 CtrlSetup
.wIndex
.W
= Urb
->UrbControlVendorClassRequest
.Index
;
1808 CtrlSetup
.wLength
= (USHORT
)Urb
->UrbControlVendorClassRequest
.TransferBufferLength
;
1810 if (Urb
->UrbControlVendorClassRequest
.TransferFlags
& USBD_TRANSFER_DIRECTION_IN
)
1813 // data direction is device to host
1815 CtrlSetup
.bmRequestType
.B
|= 0x80;
1822 Status
= UsbDevice
->SubmitSetupPacket(&CtrlSetup
, Urb
->UrbControlVendorClassRequest
.TransferBufferLength
, Urb
->UrbControlVendorClassRequest
.TransferBuffer
);
1825 // assert on failure
1827 PC_ASSERT(NT_SUCCESS(Status
));
1836 //-----------------------------------------------------------------------------------------
1838 CHubController::HandleVendorDevice(
1842 NTSTATUS Status
= STATUS_NOT_IMPLEMENTED
;
1843 PUSBDEVICE UsbDevice
;
1844 USB_DEFAULT_PIPE_SETUP_PACKET CtrlSetup
;
1846 DPRINT("CHubController::HandleVendorDevice Request %x\n", Urb
->UrbControlVendorClassRequest
.Request
);
1851 PC_ASSERT(Urb
->UrbHeader
.UsbdDeviceHandle
);
1854 // check if this is a valid usb device handle
1856 if (!ValidateUsbDevice(PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
)))
1858 DPRINT1("[USBLIB] HandleVendorDevice invalid device handle %p\n", Urb
->UrbHeader
.UsbdDeviceHandle
);
1861 // invalid device handle
1863 return STATUS_DEVICE_NOT_CONNECTED
;
1869 UsbDevice
= PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
);
1872 // initialize setup packet
1874 CtrlSetup
.bmRequestType
.B
= 0;
1875 CtrlSetup
.bmRequestType
._BM
.Recipient
= BMREQUEST_TO_DEVICE
;
1876 CtrlSetup
.bmRequestType
._BM
.Type
= BMREQUEST_VENDOR
;
1877 CtrlSetup
.bRequest
= Urb
->UrbControlVendorClassRequest
.Request
;
1878 CtrlSetup
.wValue
.W
= Urb
->UrbControlVendorClassRequest
.Value
;
1879 CtrlSetup
.wIndex
.W
= Urb
->UrbControlVendorClassRequest
.Index
;
1880 CtrlSetup
.wLength
= (USHORT
)Urb
->UrbControlVendorClassRequest
.TransferBufferLength
;
1882 if (Urb
->UrbControlVendorClassRequest
.TransferFlags
& USBD_TRANSFER_DIRECTION_IN
)
1885 // data direction is device to host
1887 CtrlSetup
.bmRequestType
._BM
.Dir
= BMREQUEST_DEVICE_TO_HOST
;
1893 Status
= UsbDevice
->SubmitSetupPacket(&CtrlSetup
, Urb
->UrbControlVendorClassRequest
.TransferBufferLength
, Urb
->UrbControlVendorClassRequest
.TransferBuffer
);
1898 //-----------------------------------------------------------------------------------------
1900 CHubController::HandleSyncResetAndClearStall(
1904 NTSTATUS Status
= STATUS_SUCCESS
;
1905 PUSB_ENDPOINT EndpointDescriptor
;
1911 PC_ASSERT(Urb
->UrbHeader
.UsbdDeviceHandle
);
1912 PC_ASSERT(Urb
->UrbHeader
.Length
== sizeof(struct _URB_PIPE_REQUEST
));
1913 PC_ASSERT(Urb
->UrbPipeRequest
.PipeHandle
);
1916 // check if this is a valid usb device handle
1918 if (!ValidateUsbDevice(PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
)))
1920 DPRINT1("[USBLIB] HandleSyncResetAndClearStall invalid device handle %p\n", Urb
->UrbHeader
.UsbdDeviceHandle
);
1923 // invalid device handle
1925 return STATUS_DEVICE_NOT_CONNECTED
;
1931 Status
= HandleAbortPipe(Irp
, Urb
);
1932 if (!NT_SUCCESS(Status
))
1937 DPRINT1("[USBLIB] failed to reset pipe %x\n", Status
);
1942 // get endpoint descriptor
1944 EndpointDescriptor
= (PUSB_ENDPOINT
)Urb
->UrbPipeRequest
.PipeHandle
;
1949 Type
= (EndpointDescriptor
->EndPointDescriptor
.bmAttributes
& USB_ENDPOINT_TYPE_MASK
);
1950 if (Type
!= USB_ENDPOINT_TYPE_ISOCHRONOUS
)
1955 Status
= HandleClearStall(Irp
, Urb
);
1957 DPRINT1("[USBLIB] URB_FUNCTION_SYNC_RESET_PIPE_AND_CLEAR_STALL Status %x\n", Status
);
1960 // reset data toggle
1962 if (NT_SUCCESS(Status
))
1963 EndpointDescriptor
->DataToggle
= 0x0;
1971 //-----------------------------------------------------------------------------------------
1973 CHubController::HandleAbortPipe(
1978 PUSBDEVICE UsbDevice
;
1979 PUSB_ENDPOINT_DESCRIPTOR EndpointDescriptor
;
1984 PC_ASSERT(Urb
->UrbHeader
.UsbdDeviceHandle
);
1985 PC_ASSERT(Urb
->UrbHeader
.Length
== sizeof(struct _URB_PIPE_REQUEST
));
1986 PC_ASSERT(Urb
->UrbPipeRequest
.PipeHandle
);
1989 // check if this is a valid usb device handle
1991 if (!ValidateUsbDevice(PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
)))
1993 DPRINT1("[USBLIB] HandleAbortPipe invalid device handle %p\n", Urb
->UrbHeader
.UsbdDeviceHandle
);
1996 // invalid device handle
1998 return STATUS_DEVICE_NOT_CONNECTED
;
2002 // get endpoint descriptor
2004 EndpointDescriptor
= (PUSB_ENDPOINT_DESCRIPTOR
)Urb
->UrbPipeRequest
.PipeHandle
;
2009 UsbDevice
= PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
);
2015 Status
= UsbDevice
->AbortPipe(EndpointDescriptor
);
2016 DPRINT1("[USBLIB] URB_FUNCTION_ABORT_PIPE Status %x\n", Status
);
2025 //-----------------------------------------------------------------------------------------
2027 CHubController::HandleClearStall(
2031 USB_DEFAULT_PIPE_SETUP_PACKET CtrlSetup
;
2033 PUSBDEVICE UsbDevice
;
2034 PUSB_ENDPOINT_DESCRIPTOR EndpointDescriptor
;
2040 PC_ASSERT(Urb
->UrbHeader
.UsbdDeviceHandle
);
2041 PC_ASSERT(Urb
->UrbHeader
.Length
== sizeof(struct _URB_PIPE_REQUEST
));
2042 PC_ASSERT(Urb
->UrbPipeRequest
.PipeHandle
);
2045 // check if this is a valid usb device handle
2047 if (!ValidateUsbDevice(PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
)))
2049 DPRINT1("[USBLIB] HandleClearStall invalid device handle %p\n", Urb
->UrbHeader
.UsbdDeviceHandle
);
2052 // invalid device handle
2054 return STATUS_DEVICE_NOT_CONNECTED
;
2058 // get endpoint descriptor
2060 EndpointDescriptor
= (PUSB_ENDPOINT_DESCRIPTOR
)Urb
->UrbPipeRequest
.PipeHandle
;
2065 UsbDevice
= PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
);
2066 DPRINT1("[USBLIB] URB_FUNCTION_SYNC_CLEAR_STALL\n");
2069 // initialize setup packet
2071 CtrlSetup
.bmRequestType
.B
= 0x02;
2072 CtrlSetup
.bRequest
= USB_REQUEST_CLEAR_FEATURE
;
2073 CtrlSetup
.wValue
.W
= USB_FEATURE_ENDPOINT_STALL
;
2074 CtrlSetup
.wIndex
.W
= EndpointDescriptor
->bEndpointAddress
;
2075 CtrlSetup
.wLength
= 0;
2076 CtrlSetup
.wValue
.W
= 0;
2081 Status
= UsbDevice
->SubmitSetupPacket(&CtrlSetup
, 0, 0);
2083 DPRINT1("[USBLIB] URB_FUNCTION_CLEAR_STALL Status %x\n", Status
);
2092 //-----------------------------------------------------------------------------------------
2094 CHubController::HandleClassInterface(
2098 USB_DEFAULT_PIPE_SETUP_PACKET CtrlSetup
;
2100 PUSBDEVICE UsbDevice
;
2105 //ASSERT(Urb->UrbControlVendorClassRequest.TransferBuffer || Urb->UrbControlVendorClassRequest.TransferBufferMDL);
2106 //ASSERT(Urb->UrbControlVendorClassRequest.TransferBufferLength);
2107 PC_ASSERT(Urb
->UrbHeader
.UsbdDeviceHandle
);
2110 // check if this is a valid usb device handle
2112 if (!ValidateUsbDevice(PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
)))
2114 DPRINT1("[USBLIB] HandleClassInterface invalid device handle %p\n", Urb
->UrbHeader
.UsbdDeviceHandle
);
2117 // invalid device handle
2119 return STATUS_DEVICE_NOT_CONNECTED
;
2125 UsbDevice
= PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
);
2128 DPRINT1("URB_FUNCTION_CLASS_INTERFACE\n");
2129 DPRINT1("TransferFlags %x\n", Urb
->UrbControlVendorClassRequest
.TransferFlags
);
2130 DPRINT1("TransferBufferLength %x\n", Urb
->UrbControlVendorClassRequest
.TransferBufferLength
);
2131 DPRINT1("TransferBuffer %x\n", Urb
->UrbControlVendorClassRequest
.TransferBuffer
);
2132 DPRINT1("TransferBufferMDL %x\n", Urb
->UrbControlVendorClassRequest
.TransferBufferMDL
);
2133 DPRINT1("RequestTypeReservedBits %x\n", Urb
->UrbControlVendorClassRequest
.RequestTypeReservedBits
);
2134 DPRINT1("Request %x\n", Urb
->UrbControlVendorClassRequest
.Request
);
2135 DPRINT1("Value %x\n", Urb
->UrbControlVendorClassRequest
.Value
);
2136 DPRINT1("Index %x\n", Urb
->UrbControlVendorClassRequest
.Index
);
2139 // initialize setup packet
2141 CtrlSetup
.bmRequestType
.B
= 0x21;
2142 CtrlSetup
.bRequest
= Urb
->UrbControlVendorClassRequest
.Request
;
2143 CtrlSetup
.wValue
.W
= Urb
->UrbControlVendorClassRequest
.Value
;
2144 CtrlSetup
.wIndex
.W
= Urb
->UrbControlVendorClassRequest
.Index
;
2145 CtrlSetup
.wLength
= (USHORT
)Urb
->UrbControlVendorClassRequest
.TransferBufferLength
;
2147 if (Urb
->UrbControlVendorClassRequest
.TransferFlags
& USBD_TRANSFER_DIRECTION_IN
)
2150 // data direction is device to host
2152 CtrlSetup
.bmRequestType
.B
|= 0x80;
2158 Status
= UsbDevice
->SubmitSetupPacket(&CtrlSetup
, Urb
->UrbControlVendorClassRequest
.TransferBufferLength
, Urb
->UrbControlVendorClassRequest
.TransferBuffer
);
2161 // assert on failure
2163 if (!NT_SUCCESS(Status
))
2168 DPRINT1("URB_FUNCTION_CLASS_INTERFACE failed with Urb Status %x\n", Urb
->UrbHeader
.Status
);
2177 //-----------------------------------------------------------------------------------------
2179 CHubController::HandleDeviceControl(
2180 IN PDEVICE_OBJECT DeviceObject
,
2183 PIO_STACK_LOCATION IoStack
;
2184 PCOMMON_DEVICE_EXTENSION DeviceExtension
;
2186 NTSTATUS Status
= STATUS_NOT_IMPLEMENTED
;
2189 // get current stack location
2191 IoStack
= IoGetCurrentIrpStackLocation(Irp
);
2194 // get device extension
2196 DeviceExtension
= (PCOMMON_DEVICE_EXTENSION
)DeviceObject
->DeviceExtension
;
2199 // determine which request should be performed
2201 switch(IoStack
->Parameters
.DeviceIoControl
.IoControlCode
)
2203 case IOCTL_INTERNAL_USB_SUBMIT_URB
:
2208 Urb
= (PURB
)IoStack
->Parameters
.Others
.Argument1
;
2211 switch (Urb
->UrbHeader
.Function
)
2213 case URB_FUNCTION_SYNC_RESET_PIPE
:
2214 case URB_FUNCTION_SYNC_RESET_PIPE_AND_CLEAR_STALL
:
2215 Status
= HandleSyncResetAndClearStall(Irp
, Urb
);
2217 case URB_FUNCTION_ABORT_PIPE
:
2218 Status
= HandleAbortPipe(Irp
, Urb
);
2220 case URB_FUNCTION_SYNC_CLEAR_STALL
:
2221 Status
= HandleClearStall(Irp
, Urb
);
2223 case URB_FUNCTION_GET_DESCRIPTOR_FROM_INTERFACE
:
2224 Status
= HandleGetDescriptorFromInterface(Irp
, Urb
);
2226 case URB_FUNCTION_GET_DESCRIPTOR_FROM_DEVICE
:
2227 Status
= HandleGetDescriptor(Irp
, Urb
);
2229 case URB_FUNCTION_CLASS_DEVICE
:
2230 Status
= HandleClassDevice(Irp
, Urb
);
2232 case URB_FUNCTION_GET_STATUS_FROM_DEVICE
:
2233 case URB_FUNCTION_GET_STATUS_FROM_INTERFACE
:
2234 case URB_FUNCTION_GET_STATUS_FROM_ENDPOINT
:
2235 Status
= HandleGetStatusFromDevice(Irp
, Urb
);
2237 case URB_FUNCTION_SELECT_CONFIGURATION
:
2238 Status
= HandleSelectConfiguration(Irp
, Urb
);
2240 case URB_FUNCTION_SELECT_INTERFACE
:
2241 Status
= HandleSelectInterface(Irp
, Urb
);
2243 case URB_FUNCTION_CLASS_OTHER
:
2244 Status
= HandleClassOther(Irp
, Urb
);
2246 case URB_FUNCTION_BULK_OR_INTERRUPT_TRANSFER
:
2247 Status
= HandleBulkOrInterruptTransfer(Irp
, Urb
);
2249 case URB_FUNCTION_ISOCH_TRANSFER
:
2250 Status
= HandleIsochronousTransfer(Irp
, Urb
);
2252 case URB_FUNCTION_CLASS_INTERFACE
:
2253 Status
= HandleClassInterface(Irp
, Urb
);
2255 case URB_FUNCTION_CLASS_ENDPOINT
:
2256 Status
= HandleClassEndpoint(Irp
, Urb
);
2258 case URB_FUNCTION_VENDOR_DEVICE
:
2259 Status
= HandleVendorDevice(Irp
, Urb
);
2262 DPRINT1("[USBLIB] IOCTL_INTERNAL_USB_SUBMIT_URB Function %x NOT IMPLEMENTED\n", Urb
->UrbHeader
.Function
);
2266 // request completed
2270 case IOCTL_INTERNAL_USB_GET_DEVICE_HANDLE
:
2272 DPRINT("[USBLIB] IOCTL_INTERNAL_USB_GET_DEVICE_HANDLE %p\n", this);
2274 if (IoStack
->Parameters
.Others
.Argument1
)
2277 // store object as device handle
2279 *(PVOID
*)IoStack
->Parameters
.Others
.Argument1
= (PVOID
)this;
2280 Status
= STATUS_SUCCESS
;
2285 // mis-behaving hub driver
2287 Status
= STATUS_INVALID_DEVICE_REQUEST
;
2291 // request completed
2295 case IOCTL_INTERNAL_USB_GET_ROOTHUB_PDO
:
2297 DPRINT("[USBLIB] IOCTL_INTERNAL_USB_GET_ROOTHUB_PDO\n");
2300 // this is the first request send, it delivers the PDO to the caller
2302 if (IoStack
->Parameters
.Others
.Argument1
)
2305 // store root hub pdo object
2307 *(PVOID
*)IoStack
->Parameters
.Others
.Argument1
= DeviceObject
;
2310 if (IoStack
->Parameters
.Others
.Argument2
)
2313 // documentation claims to deliver the hcd controller object, although it is wrong
2315 *(PVOID
*)IoStack
->Parameters
.Others
.Argument2
= DeviceObject
;
2319 // request completed
2321 Status
= STATUS_SUCCESS
;
2324 case IOCTL_INTERNAL_USB_GET_HUB_COUNT
:
2326 DPRINT("[USBLIB] IOCTL_INTERNAL_USB_GET_HUB_COUNT\n");
2329 // after IOCTL_INTERNAL_USB_GET_ROOTHUB_PDO is delivered, the usbhub driver
2330 // requests this ioctl to deliver the number of presents.
2332 if (IoStack
->Parameters
.Others
.Argument1
)
2335 // FIXME / verify: there is only one hub
2337 *(PULONG
)IoStack
->Parameters
.Others
.Argument1
= 1;
2341 // request completed
2343 Status
= STATUS_SUCCESS
;
2344 Irp
->IoStatus
.Information
= sizeof(ULONG
);
2347 case IOCTL_INTERNAL_USB_SUBMIT_IDLE_NOTIFICATION
:
2349 DPRINT1("[USBLIB] IOCTL_INTERNAL_USB_SUBMIT_IDLE_NOTIFICATION UNIMPLEMENTED\n");
2350 Status
= STATUS_SUCCESS
;
2355 DPRINT1("[USBLIB] HandleDeviceControl>Type: IoCtl %x InputBufferLength %lu OutputBufferLength %lu NOT IMPLEMENTED\n",
2356 IoStack
->Parameters
.DeviceIoControl
.IoControlCode
,
2357 IoStack
->Parameters
.DeviceIoControl
.InputBufferLength
,
2358 IoStack
->Parameters
.DeviceIoControl
.OutputBufferLength
);
2362 if (Status
!= STATUS_PENDING
)
2364 Irp
->IoStatus
.Status
= Status
;
2365 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
2371 //-----------------------------------------------------------------------------------------
2373 CHubController::GetUsbHardware()
2378 //-----------------------------------------------------------------------------------------
2380 CHubController::AcquireDeviceAddress()
2383 ULONG DeviceAddress
;
2386 // acquire device lock
2388 KeAcquireSpinLock(&m_Lock
, &OldLevel
);
2393 DeviceAddress
= RtlFindClearBits(&m_DeviceAddressBitmap
, 1, 0);
2394 if (DeviceAddress
!= MAXULONG
)
2399 RtlSetBits(&m_DeviceAddressBitmap
, DeviceAddress
, 1);
2402 // device addresses start from 0x1 - 0xFF
2408 // release spin lock
2410 KeReleaseSpinLock(&m_Lock
, OldLevel
);
2413 // return device address
2415 return DeviceAddress
;
2417 //-----------------------------------------------------------------------------------------
2419 CHubController::ReleaseDeviceAddress(
2420 ULONG DeviceAddress
)
2425 // acquire device lock
2427 KeAcquireSpinLock(&m_Lock
, &OldLevel
);
2432 PC_ASSERT(DeviceAddress
!= 0);
2435 // convert back to bit number
2442 RtlClearBits(&m_DeviceAddressBitmap
, DeviceAddress
, 1);
2447 KeReleaseSpinLock(&m_Lock
, OldLevel
);
2449 //-----------------------------------------------------------------------------------------
2451 CHubController::RemoveUsbDevice(
2452 PUSBDEVICE UsbDevice
)
2454 PUSBDEVICE_ENTRY DeviceEntry
;
2456 NTSTATUS Status
= STATUS_UNSUCCESSFUL
;
2462 KeAcquireSpinLock(&m_Lock
, &OldLevel
);
2465 // point to first entry
2467 Entry
= m_UsbDeviceList
.Flink
;
2470 // find matching entry
2472 while(Entry
!= &m_UsbDeviceList
)
2477 DeviceEntry
= (PUSBDEVICE_ENTRY
)CONTAINING_RECORD(Entry
, USBDEVICE_ENTRY
, Entry
);
2480 // is it current entry
2482 if (DeviceEntry
->Device
== UsbDevice
)
2487 RemoveEntryList(Entry
);
2492 ExFreePoolWithTag(DeviceEntry
, TAG_USBLIB
);
2497 Status
= STATUS_SUCCESS
;
2504 Entry
= Entry
->Flink
;
2510 KeReleaseSpinLock(&m_Lock
, OldLevel
);
2517 //-----------------------------------------------------------------------------------------
2519 CHubController::ValidateUsbDevice(PUSBDEVICE UsbDevice
)
2521 PUSBDEVICE_ENTRY DeviceEntry
;
2524 BOOLEAN Result
= FALSE
;
2529 KeAcquireSpinLock(&m_Lock
, &OldLevel
);
2532 // point to first entry
2534 Entry
= m_UsbDeviceList
.Flink
;
2537 // find matching entry
2539 while(Entry
!= &m_UsbDeviceList
)
2544 DeviceEntry
= (PUSBDEVICE_ENTRY
)CONTAINING_RECORD(Entry
, USBDEVICE_ENTRY
, Entry
);
2547 // is it current entry
2549 if (DeviceEntry
->Device
== UsbDevice
)
2561 Entry
= Entry
->Flink
;
2567 KeReleaseSpinLock(&m_Lock
, OldLevel
);
2576 //-----------------------------------------------------------------------------------------
2578 CHubController::AddUsbDevice(
2579 PUSBDEVICE UsbDevice
)
2581 PUSBDEVICE_ENTRY DeviceEntry
;
2585 // allocate device entry
2587 DeviceEntry
= (PUSBDEVICE_ENTRY
)ExAllocatePoolWithTag(NonPagedPool
, sizeof(USBDEVICE_ENTRY
), TAG_USBLIB
);
2593 return STATUS_INSUFFICIENT_RESOURCES
;
2599 DeviceEntry
->Device
= UsbDevice
;
2604 KeAcquireSpinLock(&m_Lock
, &OldLevel
);
2609 InsertTailList(&m_UsbDeviceList
, &DeviceEntry
->Entry
);
2612 // release spin lock
2614 KeReleaseSpinLock(&m_Lock
, OldLevel
);
2619 return STATUS_SUCCESS
;
2622 //-----------------------------------------------------------------------------------------
2624 CHubController::SetNotification(
2625 PVOID CallbackContext
,
2626 PRH_INIT_CALLBACK CallbackRoutine
)
2631 // acquire hub controller lock
2633 KeAcquireSpinLock(&m_Lock
, &OldLevel
);
2636 // now set the callback routine and context of the hub
2638 m_HubCallbackContext
= CallbackContext
;
2639 m_HubCallbackRoutine
= CallbackRoutine
;
2642 // release hub controller lock
2644 KeReleaseSpinLock(&m_Lock
, OldLevel
);
2647 //=================================================================================================
2649 // Generic Interface functions
2653 USBI_InterfaceReference(
2656 CHubController
* Controller
= (CHubController
*)BusContext
;
2658 DPRINT1("USBH_InterfaceReference\n");
2663 Controller
->AddRef();
2668 USBI_InterfaceDereference(
2671 CHubController
* Controller
= (CHubController
*)BusContext
;
2673 DPRINT1("USBH_InterfaceDereference\n");
2678 Controller
->Release();
2680 //=================================================================================================
2682 // USB Hub Interface functions
2686 USBHI_CreateUsbDevice(
2688 PUSB_DEVICE_HANDLE
*NewDevice
,
2689 PUSB_DEVICE_HANDLE HubDeviceHandle
,
2693 PUSBDEVICE NewUsbDevice
;
2694 CHubController
* Controller
;
2697 DPRINT1("USBHI_CreateUsbDevice\n");
2700 // first get hub controller
2702 Controller
= (CHubController
*)BusContext
;
2707 PC_ASSERT(Controller
);
2708 PC_ASSERT(BusContext
== HubDeviceHandle
);
2711 // now allocate usb device
2713 Status
= CreateUSBDevice(&NewUsbDevice
);
2716 // check for success
2718 if (!NT_SUCCESS(Status
))
2721 // release controller
2723 Controller
->Release();
2724 DPRINT1("USBHI_CreateUsbDevice: failed to create usb device %x\n", Status
);
2729 // now initialize device
2731 Status
= NewUsbDevice
->Initialize(PHUBCONTROLLER(Controller
), Controller
->GetUsbHardware(), HubDeviceHandle
, PortNumber
, PortStatus
);
2734 // check for success
2736 if (!NT_SUCCESS(Status
))
2739 // release usb device
2741 NewUsbDevice
->Release();
2742 DPRINT1("USBHI_CreateUsbDevice: failed to initialize usb device %x\n", Status
);
2749 Status
= Controller
->AddUsbDevice(NewUsbDevice
);
2751 // check for success
2753 if (!NT_SUCCESS(Status
))
2756 // release usb device
2758 NewUsbDevice
->Release();
2760 DPRINT1("USBHI_CreateUsbDevice: failed to add usb device %x\n", Status
);
2767 *NewDevice
= NewUsbDevice
;
2772 return STATUS_SUCCESS
;
2777 USBHI_InitializeUsbDevice(
2779 PUSB_DEVICE_HANDLE DeviceHandle
)
2781 PUSBDEVICE UsbDevice
;
2782 CHubController
* Controller
;
2783 ULONG DeviceAddress
;
2787 DPRINT1("USBHI_InitializeUsbDevice\n");
2790 // first get controller
2792 Controller
= (CHubController
*)BusContext
;
2793 PC_ASSERT(Controller
);
2796 // get device object
2798 UsbDevice
= (PUSBDEVICE
)DeviceHandle
;
2799 PC_ASSERT(UsbDevice
);
2802 // validate device handle
2804 if (!Controller
->ValidateUsbDevice(UsbDevice
))
2806 DPRINT1("USBHI_InitializeUsbDevice invalid device handle %p\n", DeviceHandle
);
2809 // invalid device handle
2811 return STATUS_DEVICE_NOT_CONNECTED
;
2815 // now reserve an address
2817 DeviceAddress
= Controller
->AcquireDeviceAddress();
2820 // is the device address valid
2822 if (DeviceAddress
== MAXULONG
)
2825 // failed to get an device address from the device address pool
2827 DPRINT1("USBHI_InitializeUsbDevice failed to get device address\n");
2828 return STATUS_DEVICE_DATA_ERROR
;
2834 // now set the device address
2836 Status
= UsbDevice
->SetDeviceAddress((UCHAR
)DeviceAddress
);
2838 if (NT_SUCCESS(Status
))
2841 }while(Index
++ < 3 );
2844 // check for failure
2846 if (!NT_SUCCESS(Status
))
2849 // failed to set device address
2851 DPRINT1("USBHI_InitializeUsbDevice failed to set address with %x\n", Status
);
2856 Controller
->ReleaseDeviceAddress(DeviceAddress
);
2861 return STATUS_DEVICE_DATA_ERROR
;
2867 return STATUS_SUCCESS
;
2872 USBHI_GetUsbDescriptors(
2874 PUSB_DEVICE_HANDLE DeviceHandle
,
2875 PUCHAR DeviceDescriptorBuffer
,
2876 PULONG DeviceDescriptorBufferLength
,
2877 PUCHAR ConfigDescriptorBuffer
,
2878 PULONG ConfigDescriptorBufferLength
)
2880 PUSBDEVICE UsbDevice
;
2881 CHubController
* Controller
;
2883 DPRINT1("USBHI_GetUsbDescriptors\n");
2888 PC_ASSERT(DeviceDescriptorBuffer
);
2889 PC_ASSERT(DeviceDescriptorBufferLength
);
2890 PC_ASSERT(*DeviceDescriptorBufferLength
>= sizeof(USB_DEVICE_DESCRIPTOR
));
2891 PC_ASSERT(ConfigDescriptorBufferLength
);
2892 PC_ASSERT(*ConfigDescriptorBufferLength
>= sizeof(USB_CONFIGURATION_DESCRIPTOR
));
2895 // first get controller
2897 Controller
= (CHubController
*)BusContext
;
2898 PC_ASSERT(Controller
);
2902 // get device object
2904 UsbDevice
= (PUSBDEVICE
)DeviceHandle
;
2905 PC_ASSERT(UsbDevice
);
2908 // validate device handle
2910 if (!Controller
->ValidateUsbDevice(UsbDevice
))
2912 DPRINT1("USBHI_GetUsbDescriptors invalid device handle %p\n", DeviceHandle
);
2915 // invalid device handle
2917 return STATUS_DEVICE_NOT_CONNECTED
;
2921 // get device descriptor
2923 UsbDevice
->GetDeviceDescriptor((PUSB_DEVICE_DESCRIPTOR
)DeviceDescriptorBuffer
);
2926 // store result length
2928 *DeviceDescriptorBufferLength
= sizeof(USB_DEVICE_DESCRIPTOR
);
2931 // get configuration descriptor
2933 UsbDevice
->GetConfigurationDescriptors((PUSB_CONFIGURATION_DESCRIPTOR
)ConfigDescriptorBuffer
, *ConfigDescriptorBufferLength
, ConfigDescriptorBufferLength
);
2936 // complete the request
2938 return STATUS_SUCCESS
;
2943 USBHI_RemoveUsbDevice(
2945 PUSB_DEVICE_HANDLE DeviceHandle
,
2948 PUSBDEVICE UsbDevice
;
2949 CHubController
* Controller
;
2952 DPRINT1("USBHI_RemoveUsbDevice\n");
2955 // first get controller
2957 Controller
= (CHubController
*)BusContext
;
2958 PC_ASSERT(Controller
);
2961 // get device object
2963 UsbDevice
= (PUSBDEVICE
)DeviceHandle
;
2964 PC_ASSERT(UsbDevice
);
2967 // validate device handle
2969 if (!Controller
->ValidateUsbDevice(UsbDevice
))
2971 DPRINT1("USBHI_RemoveUsbDevice invalid device handle %p\n", DeviceHandle
);
2974 // invalid device handle
2976 return STATUS_DEVICE_NOT_CONNECTED
;
2980 // check if there were flags passed
2982 if (Flags
& USBD_KEEP_DEVICE_DATA
|| Flags
& USBD_MARK_DEVICE_BUSY
)
2985 // ignore flags for now
2987 return STATUS_SUCCESS
;
2993 Status
= Controller
->RemoveUsbDevice(UsbDevice
);
2994 if (!NT_SUCCESS(Status
))
2997 // invalid device handle
2999 DPRINT1("USBHI_RemoveUsbDevice Invalid device handle %p\n", UsbDevice
);
3001 return STATUS_DEVICE_NOT_CONNECTED
;
3005 // release usb device
3007 UsbDevice
->Release();
3012 return STATUS_SUCCESS
;
3017 USBHI_RestoreUsbDevice(
3019 PUSB_DEVICE_HANDLE OldDeviceHandle
,
3020 PUSB_DEVICE_HANDLE NewDeviceHandle
)
3022 PUSBDEVICE OldUsbDevice
, NewUsbDevice
;
3023 CHubController
* Controller
;
3025 DPRINT1("USBHI_RestoreUsbDevice\n");
3028 // first get controller
3030 Controller
= (CHubController
*)BusContext
;
3031 PC_ASSERT(Controller
);
3034 // get device object
3036 OldUsbDevice
= (PUSBDEVICE
)OldDeviceHandle
;
3037 NewUsbDevice
= (PUSBDEVICE
)NewDeviceHandle
;
3038 PC_ASSERT(OldUsbDevice
);
3039 PC_ASSERT(NewDeviceHandle
);
3042 // validate device handle
3044 PC_ASSERT(Controller
->ValidateUsbDevice(NewUsbDevice
));
3045 PC_ASSERT(Controller
->ValidateUsbDevice(OldUsbDevice
));
3047 DPRINT1("NewUsbDevice: DeviceAddress %x\n", NewUsbDevice
->GetDeviceAddress());
3048 DPRINT1("OldUsbDevice: DeviceAddress %x\n", OldUsbDevice
->GetDeviceAddress());
3051 // remove old device handle
3053 USBHI_RemoveUsbDevice(BusContext
, OldDeviceHandle
, 0);
3055 return STATUS_SUCCESS
;
3060 USBHI_QueryDeviceInformation(
3062 PUSB_DEVICE_HANDLE DeviceHandle
,
3063 PVOID DeviceInformationBuffer
,
3064 ULONG DeviceInformationBufferLength
,
3065 PULONG LengthReturned
)
3067 PUSB_DEVICE_INFORMATION_0 DeviceInfo
;
3068 PUSBDEVICE UsbDevice
;
3069 CHubController
* Controller
;
3071 DPRINT1("USBHI_QueryDeviceInformation %p\n", BusContext
);
3076 PC_ASSERT(DeviceInformationBufferLength
>= sizeof(USB_DEVICE_INFORMATION_0
));
3077 PC_ASSERT(DeviceInformationBuffer
);
3078 PC_ASSERT(LengthReturned
);
3081 // get controller object
3083 Controller
= (CHubController
*)BusContext
;
3084 PC_ASSERT(Controller
);
3087 // get device object
3089 UsbDevice
= (PUSBDEVICE
)DeviceHandle
;
3090 PC_ASSERT(UsbDevice
);
3092 if (BusContext
!= DeviceHandle
)
3095 // validate device handle
3097 if (!Controller
->ValidateUsbDevice(UsbDevice
))
3099 DPRINT1("USBHI_QueryDeviceInformation invalid device handle %p\n", DeviceHandle
);
3102 // invalid device handle
3104 return STATUS_DEVICE_NOT_CONNECTED
;
3108 // access information buffer
3110 DeviceInfo
= (PUSB_DEVICE_INFORMATION_0
)DeviceInformationBuffer
;
3113 // initialize with default values
3115 DeviceInfo
->InformationLevel
= 0;
3116 DeviceInfo
->ActualLength
= sizeof(USB_DEVICE_INFORMATION_0
);
3117 DeviceInfo
->PortNumber
= UsbDevice
->GetPort();
3118 DeviceInfo
->CurrentConfigurationValue
= UsbDevice
->GetConfigurationValue();
3119 DeviceInfo
->DeviceAddress
= UsbDevice
->GetDeviceAddress();
3120 DeviceInfo
->HubAddress
= 0; //FIXME
3121 DeviceInfo
->DeviceSpeed
= UsbDevice
->GetSpeed();
3122 DeviceInfo
->DeviceType
= UsbDevice
->GetType();
3123 DeviceInfo
->NumberOfOpenPipes
= 0; //FIXME
3126 // get device descriptor
3128 UsbDevice
->GetDeviceDescriptor(&DeviceInfo
->DeviceDescriptor
);
3131 // FIXME return pipe information
3135 // store result length
3137 *LengthReturned
= sizeof(USB_DEVICE_INFORMATION_0
);
3139 return STATUS_SUCCESS
;
3143 // access information buffer
3145 DeviceInfo
= (PUSB_DEVICE_INFORMATION_0
)DeviceInformationBuffer
;
3148 // initialize with default values
3150 DeviceInfo
->InformationLevel
= 0;
3151 DeviceInfo
->ActualLength
= sizeof(USB_DEVICE_INFORMATION_0
);
3152 DeviceInfo
->PortNumber
= 0;
3153 DeviceInfo
->CurrentConfigurationValue
= 0; //FIXME;
3154 DeviceInfo
->DeviceAddress
= 0;
3155 DeviceInfo
->HubAddress
= 0; //FIXME
3156 DeviceInfo
->DeviceSpeed
= UsbHighSpeed
; //FIXME
3157 DeviceInfo
->DeviceType
= Usb20Device
; //FIXME
3158 DeviceInfo
->NumberOfOpenPipes
= 0; //FIXME
3161 // get device descriptor
3163 RtlMoveMemory(&DeviceInfo
->DeviceDescriptor
, ROOTHUB2_DEVICE_DESCRIPTOR
, sizeof(USB_DEVICE_DESCRIPTOR
));
3166 // FIXME return pipe information
3170 // store result length
3173 *LengthReturned
= FIELD_OFFSET(USB_DEVICE_INFORMATION_0
, PipeList
[DeviceInfo
->NumberOfOpenPipes
]);
3175 *LengthReturned
= sizeof(USB_DEVICE_INFORMATION_0
) + (DeviceInfo
->NumberOfOpenPipes
> 1 ? (DeviceInfo
->NumberOfOpenPipes
- 1) * sizeof(USB_PIPE_INFORMATION_0
) : 0);
3180 return STATUS_SUCCESS
;
3185 USBHI_GetControllerInformation(
3187 PVOID ControllerInformationBuffer
,
3188 ULONG ControllerInformationBufferLength
,
3189 PULONG LengthReturned
)
3191 PUSB_CONTROLLER_INFORMATION_0 ControllerInfo
;
3193 DPRINT1("USBHI_GetControllerInformation\n");
3198 PC_ASSERT(ControllerInformationBuffer
);
3199 PC_ASSERT(ControllerInformationBufferLength
>= sizeof(USB_CONTROLLER_INFORMATION_0
));
3202 // get controller info buffer
3204 ControllerInfo
= (PUSB_CONTROLLER_INFORMATION_0
)ControllerInformationBuffer
;
3207 // FIXME only version 0 is supported for now
3209 PC_ASSERT(ControllerInfo
->InformationLevel
== 0);
3212 // fill in information
3214 ControllerInfo
->ActualLength
= sizeof(USB_CONTROLLER_INFORMATION_0
);
3215 ControllerInfo
->SelectiveSuspendEnabled
= FALSE
; //FIXME
3216 ControllerInfo
->IsHighSpeedController
= TRUE
;
3219 // set length returned
3221 *LengthReturned
= ControllerInfo
->ActualLength
;
3226 return STATUS_SUCCESS
;
3231 USBHI_ControllerSelectiveSuspend(
3236 return STATUS_NOT_IMPLEMENTED
;
3241 USBHI_GetExtendedHubInformation(
3243 PDEVICE_OBJECT HubPhysicalDeviceObject
,
3244 PVOID HubInformationBuffer
,
3245 ULONG HubInformationBufferLength
,
3246 PULONG LengthReturned
)
3248 PUSB_EXTHUB_INFORMATION_0 HubInfo
;
3249 CHubController
* Controller
;
3250 PUSBHARDWAREDEVICE Hardware
;
3252 ULONG NumPort
, Dummy2
;
3256 DPRINT1("USBHI_GetExtendedHubInformation\n");
3261 PC_ASSERT(HubInformationBuffer
);
3262 PC_ASSERT(HubInformationBufferLength
== sizeof(USB_EXTHUB_INFORMATION_0
));
3263 PC_ASSERT(LengthReturned
);
3266 // get hub controller
3268 Controller
= (CHubController
*)BusContext
;
3269 PC_ASSERT(Controller
);
3272 // get usb hardware device
3274 Hardware
= Controller
->GetUsbHardware();
3277 // retrieve number of ports
3279 Status
= Hardware
->GetDeviceDetails(&Dummy1
, &Dummy1
, &NumPort
, &Dummy2
);
3280 if (!NT_SUCCESS(Status
))
3283 // failed to get hardware details, ouch ;)
3285 DPRINT1("USBHI_GetExtendedHubInformation failed to get hardware details with %x\n", Status
);
3290 // get hub information buffer
3292 HubInfo
= (PUSB_EXTHUB_INFORMATION_0
)HubInformationBuffer
;
3295 // initialize hub information
3297 HubInfo
->InformationLevel
= 0;
3302 HubInfo
->NumberOfPorts
= NumPort
;
3305 // initialize port information
3307 for(Index
= 0; Index
< NumPort
; Index
++)
3309 HubInfo
->Port
[Index
].PhysicalPortNumber
= Index
+ 1;
3310 HubInfo
->Port
[Index
].PortLabelNumber
= Index
+ 1;
3311 HubInfo
->Port
[Index
].VidOverride
= 0;
3312 HubInfo
->Port
[Index
].PidOverride
= 0;
3313 HubInfo
->Port
[Index
].PortAttributes
= USB_PORTATTR_SHARED_USB2
; //FIXME
3317 // store result length
3320 *LengthReturned
= FIELD_OFFSET(USB_EXTHUB_INFORMATION_0
, Port
[HubInfo
->NumberOfPorts
]);
3322 *LengthReturned
= FIELD_OFFSET(USB_EXTHUB_INFORMATION_0
, Port
) + sizeof(USB_EXTPORT_INFORMATION_0
) * HubInfo
->NumberOfPorts
;
3328 return STATUS_SUCCESS
;
3333 USBHI_GetRootHubSymbolicName(
3335 PVOID HubSymNameBuffer
,
3336 ULONG HubSymNameBufferLength
,
3337 PULONG HubSymNameActualLength
)
3340 return STATUS_NOT_IMPLEMENTED
;
3345 USBHI_GetDeviceBusContext(
3346 PVOID HubBusContext
,
3355 USBHI_Initialize20Hub(
3357 PUSB_DEVICE_HANDLE HubDeviceHandle
,
3360 DPRINT("USBHI_Initialize20Hub HubDeviceHandle %p UNIMPLEMENTED TtCount %lu\n", HubDeviceHandle
, TtCount
);
3361 return STATUS_SUCCESS
;
3366 USBHI_RootHubInitNotification(
3368 PVOID CallbackContext
,
3369 PRH_INIT_CALLBACK CallbackRoutine
)
3371 CHubController
* Controller
;
3373 DPRINT("USBHI_RootHubInitNotification %p \n", CallbackContext
);
3376 // get controller object
3378 Controller
= (CHubController
*)BusContext
;
3379 PC_ASSERT(Controller
);
3382 // set notification routine
3384 Controller
->SetNotification(CallbackContext
, CallbackRoutine
);
3387 // FIXME: determine when to perform callback
3389 CallbackRoutine(CallbackContext
);
3394 return STATUS_SUCCESS
;
3399 USBHI_FlushTransfers(
3408 USBHI_SetDeviceHandleData(
3411 PDEVICE_OBJECT UsbDevicePdo
)
3413 PUSBDEVICE UsbDevice
;
3414 CHubController
* Controller
;
3419 Controller
= (CHubController
*)BusContext
;
3420 PC_ASSERT(Controller
);
3423 // get device handle
3425 UsbDevice
= (PUSBDEVICE
)DeviceHandle
;
3428 // validate device handle
3430 if (!Controller
->ValidateUsbDevice(UsbDevice
))
3432 DPRINT1("USBHI_SetDeviceHandleData DeviceHandle %p is invalid\n", DeviceHandle
);
3442 // usbhub sends this request as a part of the Pnp startup sequence
3443 // looks like we need apply a dragon voodoo to fixup the device stack
3444 // otherwise usbhub will cause a bugcheck
3446 DPRINT1("USBHI_SetDeviceHandleData %p\n", UsbDevicePdo
);
3451 PC_ASSERT(UsbDevicePdo
->AttachedDevice
);
3454 // should be usbstor
3455 // fixup device stack voodoo part #2
3457 UsbDevicePdo
->AttachedDevice
->StackSize
++;
3460 // set device handle data
3462 UsbDevice
->SetDeviceHandleData(UsbDevicePdo
);
3466 //=================================================================================================
3468 // USB Device Interface functions
3473 USBDI_GetUSBDIVersion(
3475 PUSBD_VERSION_INFORMATION VersionInformation
,
3476 PULONG HcdCapabilites
)
3478 CHubController
* Controller
;
3479 PUSBHARDWAREDEVICE Device
;
3480 ULONG Speed
, Dummy2
;
3483 DPRINT1("USBDI_GetUSBDIVersion\n");
3488 Controller
= (CHubController
*)BusContext
;
3493 Device
= Controller
->GetUsbHardware();
3496 if (VersionInformation
)
3499 // windows xp supported
3501 VersionInformation
->USBDI_Version
= 0x00000500;
3506 Device
->GetDeviceDetails(&Dummy1
, &Dummy1
, &Dummy2
, &Speed
);
3509 // store speed details
3511 VersionInformation
->Supported_USB_Version
= Speed
;
3515 // no flags supported
3517 *HcdCapabilites
= 0;
3524 PULONG CurrentFrame
)
3527 return STATUS_NOT_IMPLEMENTED
;
3532 USBDI_SubmitIsoOutUrb(
3537 return STATUS_NOT_IMPLEMENTED
;
3542 USBDI_QueryBusInformation(
3545 PVOID BusInformationBuffer
,
3546 PULONG BusInformationBufferLength
,
3547 PULONG BusInformationActualLength
)
3550 return STATUS_NOT_IMPLEMENTED
;
3555 USBDI_IsDeviceHighSpeed(
3558 CHubController
* Controller
;
3559 PUSBHARDWAREDEVICE Device
;
3560 ULONG Speed
, Dummy2
;
3563 DPRINT1("USBDI_IsDeviceHighSpeed\n");
3568 Controller
= (CHubController
*)BusContext
;
3573 Device
= Controller
->GetUsbHardware();
3579 Device
->GetDeviceDetails(&Dummy1
, &Dummy1
, &Dummy2
, &Speed
);
3582 // USB 2.0 equals 0x200
3584 return (Speed
== 0x200);
3597 return STATUS_NOT_IMPLEMENTED
;
3601 CHubController::HandleQueryInterface(
3602 PIO_STACK_LOCATION IoStack
)
3604 PUSB_BUS_INTERFACE_HUB_V5 InterfaceHub
;
3605 PUSB_BUS_INTERFACE_USBDI_V2 InterfaceDI
;
3606 UNICODE_STRING GuidBuffer
;
3609 if (IsEqualGUIDAligned(*IoStack
->Parameters
.QueryInterface
.InterfaceType
, USB_BUS_INTERFACE_HUB_GUID
))
3612 // get request parameters
3614 InterfaceHub
= (PUSB_BUS_INTERFACE_HUB_V5
)IoStack
->Parameters
.QueryInterface
.Interface
;
3615 InterfaceHub
->Version
= IoStack
->Parameters
.QueryInterface
.Version
;
3620 if (IoStack
->Parameters
.QueryInterface
.Version
>= 6)
3622 DPRINT1("USB_BUS_INTERFACE_HUB_GUID version %x not supported!\n", IoStack
->Parameters
.QueryInterface
.Version
);
3625 // version not supported
3627 return STATUS_NOT_SUPPORTED
;
3631 // Interface version 0
3633 if (IoStack
->Parameters
.QueryInterface
.Version
>= 0)
3635 InterfaceHub
->Size
= IoStack
->Parameters
.QueryInterface
.Size
;
3636 InterfaceHub
->BusContext
= PVOID(this);
3637 InterfaceHub
->InterfaceReference
= USBI_InterfaceReference
;
3638 InterfaceHub
->InterfaceDereference
= USBI_InterfaceDereference
;
3642 // Interface version 1
3644 if (IoStack
->Parameters
.QueryInterface
.Version
>= 1)
3646 InterfaceHub
->CreateUsbDevice
= USBHI_CreateUsbDevice
;
3647 InterfaceHub
->InitializeUsbDevice
= USBHI_InitializeUsbDevice
;
3648 InterfaceHub
->GetUsbDescriptors
= USBHI_GetUsbDescriptors
;
3649 InterfaceHub
->RemoveUsbDevice
= USBHI_RemoveUsbDevice
;
3650 InterfaceHub
->RestoreUsbDevice
= USBHI_RestoreUsbDevice
;
3651 InterfaceHub
->QueryDeviceInformation
= USBHI_QueryDeviceInformation
;
3655 // Interface version 2
3657 if (IoStack
->Parameters
.QueryInterface
.Version
>= 2)
3659 InterfaceHub
->GetControllerInformation
= USBHI_GetControllerInformation
;
3660 InterfaceHub
->ControllerSelectiveSuspend
= USBHI_ControllerSelectiveSuspend
;
3661 InterfaceHub
->GetExtendedHubInformation
= USBHI_GetExtendedHubInformation
;
3662 InterfaceHub
->GetRootHubSymbolicName
= USBHI_GetRootHubSymbolicName
;
3663 InterfaceHub
->GetDeviceBusContext
= USBHI_GetDeviceBusContext
;
3664 InterfaceHub
->Initialize20Hub
= USBHI_Initialize20Hub
;
3669 // Interface version 3
3671 if (IoStack
->Parameters
.QueryInterface
.Version
>= 3)
3673 InterfaceHub
->RootHubInitNotification
= USBHI_RootHubInitNotification
;
3677 // Interface version 4
3679 if (IoStack
->Parameters
.QueryInterface
.Version
>= 4)
3681 InterfaceHub
->FlushTransfers
= USBHI_FlushTransfers
;
3685 // Interface version 5
3687 if (IoStack
->Parameters
.QueryInterface
.Version
>= 5)
3689 InterfaceHub
->SetDeviceHandleData
= USBHI_SetDeviceHandleData
;
3693 // request completed
3695 return STATUS_SUCCESS
;
3697 else if (IsEqualGUIDAligned(*IoStack
->Parameters
.QueryInterface
.InterfaceType
, USB_BUS_INTERFACE_USBDI_GUID
))
3700 // get request parameters
3702 InterfaceDI
= (PUSB_BUS_INTERFACE_USBDI_V2
) IoStack
->Parameters
.QueryInterface
.Interface
;
3703 InterfaceDI
->Version
= IoStack
->Parameters
.QueryInterface
.Version
;
3708 if (IoStack
->Parameters
.QueryInterface
.Version
>= 3)
3710 DPRINT1("USB_BUS_INTERFACE_USBDI_GUID version %x not supported!\n", IoStack
->Parameters
.QueryInterface
.Version
);
3713 // version not supported
3715 return STATUS_NOT_SUPPORTED
;
3719 // interface version 0
3721 if (IoStack
->Parameters
.QueryInterface
.Version
>= 0)
3723 InterfaceDI
->Size
= IoStack
->Parameters
.QueryInterface
.Size
;
3724 InterfaceDI
->BusContext
= PVOID(this);
3725 InterfaceDI
->InterfaceReference
= USBI_InterfaceReference
;
3726 InterfaceDI
->InterfaceDereference
= USBI_InterfaceDereference
;
3727 InterfaceDI
->GetUSBDIVersion
= USBDI_GetUSBDIVersion
;
3728 InterfaceDI
->QueryBusTime
= USBDI_QueryBusTime
;
3729 InterfaceDI
->SubmitIsoOutUrb
= USBDI_SubmitIsoOutUrb
;
3730 InterfaceDI
->QueryBusInformation
= USBDI_QueryBusInformation
;
3734 // interface version 1
3736 if (IoStack
->Parameters
.QueryInterface
.Version
>= 1)
3738 InterfaceDI
->IsDeviceHighSpeed
= USBDI_IsDeviceHighSpeed
;
3742 // interface version 2
3744 if (IoStack
->Parameters
.QueryInterface
.Version
>= 2)
3746 InterfaceDI
->EnumLogEntry
= USBDI_EnumLogEntry
;
3750 // request completed
3752 return STATUS_SUCCESS
;
3757 // convert guid to string
3759 Status
= RtlStringFromGUID(*IoStack
->Parameters
.QueryInterface
.InterfaceType
, &GuidBuffer
);
3760 if (NT_SUCCESS(Status
))
3765 DPRINT1("HandleQueryInterface UNKNOWN INTERFACE GUID: %wZ Version %x\n", &GuidBuffer
, IoStack
->Parameters
.QueryInterface
.Version
);
3770 RtlFreeUnicodeString(&GuidBuffer
);
3773 return STATUS_NOT_SUPPORTED
;
3777 CHubController::SetDeviceInterface(
3780 NTSTATUS Status
= STATUS_SUCCESS
;
3785 // register device interface
3787 Status
= IoRegisterDeviceInterface(m_HubControllerDeviceObject
, &GUID_DEVINTERFACE_USB_HUB
, 0, &m_HubDeviceInterfaceString
);
3789 if (NT_SUCCESS(Status
))
3792 // now enable the device interface
3794 Status
= IoSetDeviceInterfaceState(&m_HubDeviceInterfaceString
, TRUE
);
3799 m_InterfaceEnabled
= TRUE
;
3802 else if (m_InterfaceEnabled
)
3805 // disable device interface
3807 Status
= IoSetDeviceInterfaceState(&m_HubDeviceInterfaceString
, FALSE
);
3809 if (NT_SUCCESS(Status
))
3812 // now delete interface string
3814 RtlFreeUnicodeString(&m_HubDeviceInterfaceString
);
3818 // disable interface
3820 m_InterfaceEnabled
= FALSE
;
3826 return STATUS_SUCCESS
;
3830 CHubController::CreatePDO(
3831 PDRIVER_OBJECT DriverObject
,
3832 PDEVICE_OBJECT
* OutDeviceObject
)
3834 WCHAR CharDeviceName
[64];
3836 ULONG UsbDeviceNumber
= 0;
3837 UNICODE_STRING DeviceName
;
3842 // construct device name
3844 swprintf(CharDeviceName
, L
"\\Device\\USBPDO-%d", UsbDeviceNumber
);
3847 // initialize device name
3849 RtlInitUnicodeString(&DeviceName
, CharDeviceName
);
3854 Status
= IoCreateDevice(DriverObject
,
3855 sizeof(COMMON_DEVICE_EXTENSION
),
3857 FILE_DEVICE_CONTROLLER
,
3862 /* check for success */
3863 if (NT_SUCCESS(Status
))
3867 // is there a device object with that same name
3869 if ((Status
== STATUS_OBJECT_NAME_EXISTS
) || (Status
== STATUS_OBJECT_NAME_COLLISION
))
3872 // Try the next name
3879 // bail out on other errors
3881 if (!NT_SUCCESS(Status
))
3883 DPRINT1("CreatePDO: Failed to create %wZ, Status %x\n", &DeviceName
, Status
);
3888 DPRINT1("CHubController::CreatePDO: DeviceName %wZ\n", &DeviceName
);
3891 // fixup device stack voodoo part #1
3893 (*OutDeviceObject
)->StackSize
++;
3903 CreateHubController(
3904 PHUBCONTROLLER
*OutHcdController
)
3906 PHUBCONTROLLER This
;
3909 // allocate controller
3911 This
= new(NonPagedPool
, TAG_USBLIB
) CHubController(0);
3915 // failed to allocate
3917 return STATUS_INSUFFICIENT_RESOURCES
;
3921 // add reference count
3928 *OutHcdController
= (PHUBCONTROLLER
)This
;
3933 return STATUS_SUCCESS
;
3936 VOID
StatusChangeEndpointCallBack(PVOID Context
)
3938 CHubController
* This
;
3940 This
= (CHubController
*)Context
;
3944 Irp
= This
->m_PendingSCEIrp
;
3947 DPRINT1("There was no pending IRP for SCE. Did the usb hub 2.0 driver (usbhub2) load?\n");
3951 This
->m_PendingSCEIrp
= NULL
;
3952 This
->QueryStatusChageEndpoint(Irp
);
3954 Irp
->IoStatus
.Status
= STATUS_SUCCESS
;
3955 Irp
->IoStatus
.Information
= 0;
3957 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);