2 * PROJECT: ReactOS Universal Serial Bus Bulk Enhanced Host Controller Interface
3 * LICENSE: GPL - See COPYING in the top level directory
4 * FILE: drivers/usb/usbehci/hub_controller.cpp
5 * PURPOSE: USB EHCI device driver.
7 * Michael Martin (michael.martin@reactos.org)
8 * Johannes Anderwald (johannes.anderwald@reactos.org)
14 VOID
StatusChangeEndpointCallBack(
17 class CHubController
: public IHubController
,
21 STDMETHODIMP
QueryInterface( REFIID InterfaceId
, PVOID
* Interface
);
23 STDMETHODIMP_(ULONG
) AddRef()
25 InterlockedIncrement(&m_Ref
);
28 STDMETHODIMP_(ULONG
) Release()
30 InterlockedDecrement(&m_Ref
);
40 // IHubController interface functions
41 virtual NTSTATUS
Initialize(IN PDRIVER_OBJECT DriverObject
, IN PHCDCONTROLLER Controller
, IN PUSBHARDWAREDEVICE Device
, IN BOOLEAN IsRootHubDevice
, IN ULONG DeviceAddress
);
42 virtual NTSTATUS
GetHubControllerDeviceObject(PDEVICE_OBJECT
* HubDeviceObject
);
43 virtual NTSTATUS
GetHubControllerSymbolicLink(ULONG BufferLength
, PVOID Buffer
, PULONG RequiredLength
);
45 // IDispatchIrp interface functions
46 virtual NTSTATUS
HandlePnp(IN PDEVICE_OBJECT DeviceObject
, IN OUT PIRP Irp
);
47 virtual NTSTATUS
HandlePower(IN PDEVICE_OBJECT DeviceObject
, IN OUT PIRP Irp
);
48 virtual NTSTATUS
HandleDeviceControl(IN PDEVICE_OBJECT DeviceObject
, IN OUT PIRP Irp
);
51 NTSTATUS
HandleQueryInterface(PIO_STACK_LOCATION IoStack
);
52 NTSTATUS
SetDeviceInterface(BOOLEAN bEnable
);
53 NTSTATUS
CreatePDO(PDRIVER_OBJECT DriverObject
, PDEVICE_OBJECT
* OutDeviceObject
);
54 PUSBHARDWAREDEVICE
GetUsbHardware();
55 ULONG
AcquireDeviceAddress();
56 VOID
ReleaseDeviceAddress(ULONG DeviceAddress
);
57 BOOLEAN
ValidateUsbDevice(PUSBDEVICE UsbDevice
);
58 NTSTATUS
AddUsbDevice(PUSBDEVICE UsbDevice
);
59 NTSTATUS
RemoveUsbDevice(PUSBDEVICE UsbDevice
);
60 VOID
SetNotification(PVOID CallbackContext
, PRH_INIT_CALLBACK CallbackRoutine
);
61 // internal ioctl routines
62 NTSTATUS
HandleGetDescriptor(IN OUT PIRP Irp
, PURB Urb
);
63 NTSTATUS
HandleGetDescriptorFromInterface(IN OUT PIRP Irp
, PURB Urb
);
64 NTSTATUS
HandleClassDevice(IN OUT PIRP Irp
, PURB Urb
);
65 NTSTATUS
HandleGetStatusFromDevice(IN OUT PIRP Irp
, PURB Urb
);
66 NTSTATUS
HandleSelectConfiguration(IN OUT PIRP Irp
, PURB Urb
);
67 NTSTATUS
HandleSelectInterface(IN OUT PIRP Irp
, PURB Urb
);
68 NTSTATUS
HandleClassOther(IN OUT PIRP Irp
, PURB Urb
);
69 NTSTATUS
HandleClassInterface(IN OUT PIRP Irp
, PURB Urb
);
70 NTSTATUS
HandleClassEndpoint(IN OUT PIRP Irp
, PURB Urb
);
71 NTSTATUS
HandleBulkOrInterruptTransfer(IN OUT PIRP Irp
, PURB Urb
);
72 NTSTATUS
HandleIsochronousTransfer(IN OUT PIRP Irp
, PURB Urb
);
74 friend VOID
StatusChangeEndpointCallBack(PVOID Context
);
76 // constructor / destructor
77 CHubController(IUnknown
*OuterUnknown
){}
78 virtual ~CHubController(){}
82 PHCDCONTROLLER m_Controller
;
83 PUSBHARDWAREDEVICE m_Hardware
;
84 BOOLEAN m_IsRootHubDevice
;
85 ULONG m_DeviceAddress
;
87 BOOLEAN m_InterfaceEnabled
;
88 UNICODE_STRING m_HubDeviceInterfaceString
;
90 PDEVICE_OBJECT m_HubControllerDeviceObject
;
91 PDRIVER_OBJECT m_DriverObject
;
93 PVOID m_HubCallbackContext
;
94 PRH_INIT_CALLBACK m_HubCallbackRoutine
;
96 USB_DEVICE_DESCRIPTOR m_DeviceDescriptor
;
99 RTL_BITMAP m_DeviceAddressBitmap
;
100 PULONG m_DeviceAddressBitmapBuffer
;
101 LIST_ENTRY m_UsbDeviceList
;
102 PIRP m_PendingSCEIrp
;
105 BOOLEAN
QueryStatusChageEndpoint(PIRP Irp
);
112 }USBDEVICE_ENTRY
, *PUSBDEVICE_ENTRY
;
114 /* Lifted from Linux with slight changes */
115 const UCHAR ROOTHUB2_DEVICE_DESCRIPTOR
[] =
118 USB_DEVICE_DESCRIPTOR_TYPE
, /* bDescriptorType; Device */
119 0x00, 0x20, /* bcdUSB; v1.1 */
120 USB_DEVICE_CLASS_HUB
, /* bDeviceClass; HUB_CLASSCODE */
121 0x01, /* bDeviceSubClass; */
122 0x00, /* bDeviceProtocol; [ low/full speeds only ] */
123 0x08, /* bMaxPacketSize0; 8 Bytes */
124 /* Fill Vendor and Product in when init root hub */
125 0x00, 0x00, /* idVendor; */
126 0x00, 0x00, /* idProduct; */
127 0x00, 0x00, /* bcdDevice */
128 0x00, /* iManufacturer; */
129 0x00, /* iProduct; */
130 0x00, /* iSerialNumber; */
131 0x01 /* bNumConfigurations; */
135 const USB_CONFIGURATION_DESCRIPTOR ROOTHUB2_CONFIGURATION_DESCRIPTOR
=
137 sizeof(USB_CONFIGURATION_DESCRIPTOR
),
138 USB_CONFIGURATION_DESCRIPTOR_TYPE
,
139 sizeof(USB_CONFIGURATION_DESCRIPTOR
) + sizeof(USB_INTERFACE_DESCRIPTOR
) + sizeof(USB_ENDPOINT_DESCRIPTOR
),
143 0x40, /* self powered */
147 const USB_INTERFACE_DESCRIPTOR ROOTHUB2_INTERFACE_DESCRIPTOR
=
149 sizeof(USB_INTERFACE_DESCRIPTOR
), /* bLength */
150 USB_INTERFACE_DESCRIPTOR_TYPE
, /* bDescriptorType; Interface */
151 0, /* bInterfaceNumber; */
152 0, /* bAlternateSetting; */
153 0x1, /* bNumEndpoints; */
154 0x09, /* bInterfaceClass; HUB_CLASSCODE */
155 0x01, /* bInterfaceSubClass; */
156 0x00, /* bInterfaceProtocol: */
157 0x00, /* iInterface; */
160 const USB_ENDPOINT_DESCRIPTOR ROOTHUB2_ENDPOINT_DESCRIPTOR
=
162 sizeof(USB_ENDPOINT_DESCRIPTOR
), /* bLength */
163 USB_ENDPOINT_DESCRIPTOR_TYPE
, /* bDescriptorType */
164 0x81, /* bEndPointAddress */
165 USB_ENDPOINT_TYPE_INTERRUPT
, /* bmAttributes */
166 0x01, /* wMaxPacketSize */
170 //----------------------------------------------------------------------------------------
173 CHubController::QueryInterface(
177 return STATUS_UNSUCCESSFUL
;
179 //----------------------------------------------------------------------------------------
181 CHubController::Initialize(
182 IN PDRIVER_OBJECT DriverObject
,
183 IN PHCDCONTROLLER Controller
,
184 IN PUSBHARDWAREDEVICE Device
,
185 IN BOOLEAN IsRootHubDevice
,
186 IN ULONG DeviceAddress
)
189 PCOMMON_DEVICE_EXTENSION DeviceExtension
;
190 USHORT VendorID
, DeviceID
;
193 DPRINT1("CHubController::Initialize\n");
196 // initialize members
198 m_Controller
= Controller
;
200 m_IsRootHubDevice
= IsRootHubDevice
;
201 m_DeviceAddress
= DeviceAddress
;
202 m_DriverObject
= DriverObject
;
203 KeInitializeSpinLock(&m_Lock
);
204 InitializeListHead(&m_UsbDeviceList
);
207 // allocate device address bitmap buffer
209 m_DeviceAddressBitmapBuffer
= (PULONG
)ExAllocatePoolWithTag(NonPagedPool
, 16, TAG_USBEHCI
);
210 if (!m_DeviceAddressBitmapBuffer
)
215 return STATUS_INSUFFICIENT_RESOURCES
;
219 // initialize device address bitmap
221 RtlInitializeBitMap(&m_DeviceAddressBitmap
, m_DeviceAddressBitmapBuffer
, 128);
222 RtlClearAllBits(&m_DeviceAddressBitmap
);
228 Status
= CreatePDO(m_DriverObject
, &m_HubControllerDeviceObject
);
229 if (!NT_SUCCESS(Status
))
232 // failed to create hub device object
238 // get device extension
240 DeviceExtension
= (PCOMMON_DEVICE_EXTENSION
)m_HubControllerDeviceObject
->DeviceExtension
;
243 // initialize device extension
245 DeviceExtension
->IsFDO
= FALSE
;
246 DeviceExtension
->IsHub
= TRUE
; //FIXME
247 DeviceExtension
->Dispatcher
= PDISPATCHIRP(this);
250 // intialize device descriptor
252 C_ASSERT(sizeof(USB_DEVICE_DESCRIPTOR
) == sizeof(ROOTHUB2_DEVICE_DESCRIPTOR
));
253 RtlMoveMemory(&m_DeviceDescriptor
, ROOTHUB2_DEVICE_DESCRIPTOR
, sizeof(USB_DEVICE_DESCRIPTOR
));
255 if (NT_SUCCESS(m_Hardware
->GetDeviceDetails(&VendorID
, &DeviceID
, &Dummy1
, &Dummy1
)))
258 // update device descriptor
260 m_DeviceDescriptor
.idVendor
= VendorID
;
261 m_DeviceDescriptor
.idProduct
= DeviceID
;
262 m_DeviceDescriptor
.bcdUSB
= 0x200; //FIXME
266 // Set the SCE Callback that the Hardware Device will call on port status change
268 Device
->SetStatusChangeEndpointCallBack((PVOID
)StatusChangeEndpointCallBack
, this);
273 m_HubControllerDeviceObject
->Flags
&= ~DO_DEVICE_INITIALIZING
;
275 return STATUS_SUCCESS
;
279 // Queries the ports to see if there has been a device connected or removed.
282 CHubController::QueryStatusChageEndpoint(
285 ULONG PortCount
, PortId
;
286 PIO_STACK_LOCATION IoStack
;
287 USHORT PortStatus
, PortChange
;
289 PUCHAR TransferBuffer
;
290 UCHAR Changed
= FALSE
;
293 // get current stack location
295 IoStack
= IoGetCurrentIrpStackLocation(Irp
);
301 Urb
= (PURB
)IoStack
->Parameters
.Others
.Argument1
;
305 // Get the number of ports and check each one for device connected
307 m_Hardware
->GetDeviceDetails(NULL
, NULL
, &PortCount
, NULL
);
308 DPRINT1("SCE Request %p TransferBufferLength %lu Flags %x MDL %p\n", Urb
->UrbBulkOrInterruptTransfer
.TransferBuffer
, Urb
->UrbBulkOrInterruptTransfer
.TransferBufferLength
, Urb
->UrbBulkOrInterruptTransfer
.TransferFlags
, Urb
->UrbBulkOrInterruptTransfer
.TransferBufferMDL
);
310 TransferBuffer
= (PUCHAR
)Urb
->UrbBulkOrInterruptTransfer
.TransferBuffer
;
315 for (PortId
= 0; PortId
< PortCount
; PortId
++)
317 m_Hardware
->GetPortStatus(PortId
, &PortStatus
, &PortChange
);
319 DPRINT1("Port %d: Status %x, Change %x\n", PortId
, PortStatus
, PortChange
);
323 // If theres a flag in PortChange return TRUE so the SCE Irp will be completed
327 DPRINT1("Change state on port %d\n", PortId
);
328 // Set the value for the port number
329 *TransferBuffer
= 1 << ((PortId
+ 1) & 7);
337 //-----------------------------------------------------------------------------------------
339 CHubController::GetHubControllerDeviceObject(PDEVICE_OBJECT
* HubDeviceObject
)
342 // store controller object
344 *HubDeviceObject
= m_HubControllerDeviceObject
;
346 return STATUS_SUCCESS
;
348 //-----------------------------------------------------------------------------------------
350 CHubController::GetHubControllerSymbolicLink(
353 PULONG RequiredLength
)
355 if (!m_InterfaceEnabled
)
358 // device interface not yet enabled
360 return STATUS_UNSUCCESSFUL
;
363 if (BufferLength
< (ULONG
)m_HubDeviceInterfaceString
.Length
- 8)
367 // length is without '\??\'
369 *RequiredLength
= m_HubDeviceInterfaceString
.Length
- 8;
374 return STATUS_BUFFER_OVERFLOW
;
378 // copy symbolic link
380 RtlCopyMemory(Buffer
, &m_HubDeviceInterfaceString
.Buffer
[4], m_HubDeviceInterfaceString
.Length
- 8);
383 // store length, length is without '\??\'
385 *RequiredLength
= m_HubDeviceInterfaceString
.Length
- 8;
390 return STATUS_SUCCESS
;
393 //-----------------------------------------------------------------------------------------
395 CHubController::HandlePnp(
396 IN PDEVICE_OBJECT DeviceObject
,
399 PIO_STACK_LOCATION IoStack
;
400 PCOMMON_DEVICE_EXTENSION DeviceExtension
;
401 PDEVICE_CAPABILITIES DeviceCapabilities
;
402 PPNP_BUS_INFORMATION BusInformation
;
403 PDEVICE_RELATIONS DeviceRelations
;
405 ULONG Index
= 0, Length
;
406 USHORT VendorID
, DeviceID
;
407 ULONG HiSpeed
, NumPorts
;
412 // get device extension
414 DeviceExtension
= (PCOMMON_DEVICE_EXTENSION
)DeviceObject
->DeviceExtension
;
419 ASSERT(DeviceExtension
->IsFDO
== FALSE
);
422 // get current stack location
424 IoStack
= IoGetCurrentIrpStackLocation(Irp
);
426 switch(IoStack
->MinorFunction
)
428 case IRP_MN_START_DEVICE
:
430 DPRINT1("CHubController::HandlePnp IRP_MN_START_DEVICE\n");
432 // register device interface
434 Status
= SetDeviceInterface(TRUE
);
437 case IRP_MN_QUERY_ID
:
439 DPRINT1("CHubController::HandlePnp IRP_MN_QUERY_ID Type %x\n", IoStack
->Parameters
.QueryId
.IdType
);
441 if (IoStack
->Parameters
.QueryId
.IdType
== BusQueryDeviceID
)
448 Status
= m_Hardware
->GetDeviceDetails(&VendorID
, &DeviceID
, &NumPorts
, &HiSpeed
);
450 if (HiSpeed
== 0x200)
455 swprintf(Buffer
, L
"USB\\ROOT_HUB20");
462 swprintf(Buffer
, L
"USB\\ROOT_HUB");
465 DPRINT1("Name %S\n", Buffer
);
470 Length
= (wcslen(Buffer
) + 1);
475 DeviceName
= (LPWSTR
)ExAllocatePoolWithTag(PagedPool
, Length
* sizeof(WCHAR
), TAG_USBEHCI
);
482 Status
= STATUS_INSUFFICIENT_RESOURCES
;
489 wcscpy(DeviceName
, Buffer
);
494 Irp
->IoStatus
.Information
= (ULONG_PTR
)DeviceName
;
495 Status
= STATUS_SUCCESS
;
498 Status
= STATUS_UNSUCCESSFUL
;
503 if (IoStack
->Parameters
.QueryId
.IdType
== BusQueryHardwareIDs
)
510 Status
= m_Hardware
->GetDeviceDetails(&VendorID
, &DeviceID
, &NumPorts
, &HiSpeed
);
512 if (!NT_SUCCESS(Status
))
514 DPRINT1("CHubController::HandlePnp> failed to get hardware id %x\n", Status
);
519 if (HiSpeed
== 0x200)
524 Index
+= swprintf(&Buffer
[Index
], L
"USB\\ROOT_HUB20&VID%04x&PID%04x&REV0000", VendorID
, DeviceID
) + 1;
525 Index
+= swprintf(&Buffer
[Index
], L
"USB\\ROOT_HUB20&VID%04x&PID%04x", VendorID
, DeviceID
) + 1;
526 Index
+= swprintf(&Buffer
[Index
], L
"USB\\ROOT_HUB20") + 1;
533 Index
+= swprintf(&Buffer
[Index
], L
"USB\\ROOT_HUB&VID%04x&PID%04x&REV0000", VendorID
, DeviceID
) + 1;
534 Index
+= swprintf(&Buffer
[Index
], L
"USB\\ROOT_HUB&VID%04x&PID%04x", VendorID
, DeviceID
) + 1;
535 Index
+= swprintf(&Buffer
[Index
], L
"USB\\ROOT_HUB") + 1;
538 Buffer
[Index
] = UNICODE_NULL
;
542 DPRINT1("Name %S\n", Buffer
);
547 DeviceName
= (LPWSTR
)ExAllocatePoolWithTag(PagedPool
, Index
* sizeof(WCHAR
), TAG_USBEHCI
);
554 Status
= STATUS_INSUFFICIENT_RESOURCES
;
561 RtlMoveMemory(DeviceName
, Buffer
, Index
* sizeof(WCHAR
));
566 Irp
->IoStatus
.Information
= (ULONG_PTR
)DeviceName
;
567 Status
= STATUS_SUCCESS
;
571 Status
= STATUS_SUCCESS
;
574 case IRP_MN_QUERY_CAPABILITIES
:
576 DPRINT1("CHubController::HandlePnp IRP_MN_QUERY_CAPABILITIES\n");
578 DeviceCapabilities
= (PDEVICE_CAPABILITIES
)IoStack
->Parameters
.DeviceCapabilities
.Capabilities
;
580 DeviceCapabilities
->LockSupported
= FALSE
;
581 DeviceCapabilities
->EjectSupported
= FALSE
;
582 DeviceCapabilities
->Removable
= FALSE
;
583 DeviceCapabilities
->DockDevice
= FALSE
;
584 DeviceCapabilities
->UniqueID
= FALSE
;
585 DeviceCapabilities
->SilentInstall
= FALSE
;
586 DeviceCapabilities
->RawDeviceOK
= FALSE
;
587 DeviceCapabilities
->SurpriseRemovalOK
= FALSE
;
588 DeviceCapabilities
->Address
= 0;
589 DeviceCapabilities
->UINumber
= 0;
590 DeviceCapabilities
->DeviceD2
= 1;
593 DeviceCapabilities
->HardwareDisabled
= FALSE
;
594 DeviceCapabilities
->NoDisplayInUI
= FALSE
;
595 DeviceCapabilities
->DeviceState
[0] = PowerDeviceD0
;
596 for (Index
= 1; Index
< PowerSystemMaximum
; Index
++)
597 DeviceCapabilities
->DeviceState
[Index
] = PowerDeviceD3
;
598 DeviceCapabilities
->DeviceWake
= PowerDeviceUnspecified
;
599 DeviceCapabilities
->D1Latency
= 0;
600 DeviceCapabilities
->D2Latency
= 0;
601 DeviceCapabilities
->D3Latency
= 0;
603 Status
= STATUS_SUCCESS
;
606 case IRP_MN_QUERY_INTERFACE
:
608 DPRINT1("CHubController::HandlePnp IRP_MN_QUERY_INTERFACE\n");
611 // handle device interface requests
613 Status
= HandleQueryInterface(IoStack
);
616 case IRP_MN_REMOVE_DEVICE
:
618 DPRINT1("CHubController::HandlePnp IRP_MN_REMOVE_DEVICE\n");
621 // deactivate device interface for BUS PDO
623 SetDeviceInterface(FALSE
);
626 // complete the request first
628 Irp
->IoStatus
.Status
= STATUS_SUCCESS
;
629 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
634 IoDeleteDevice(m_HubControllerDeviceObject
);
639 m_HubControllerDeviceObject
= 0;
644 return STATUS_SUCCESS
;
646 case IRP_MN_QUERY_DEVICE_RELATIONS
:
648 DPRINT1("CHubController::HandlePnp IRP_MN_QUERY_DEVICE_RELATIONS Type %x\n", IoStack
->Parameters
.QueryDeviceRelations
.Type
);
650 if (IoStack
->Parameters
.QueryDeviceRelations
.Type
== TargetDeviceRelation
)
653 // allocate device relations
655 DeviceRelations
= (PDEVICE_RELATIONS
)ExAllocatePoolWithTag(PagedPool
, sizeof(DEVICE_RELATIONS
), TAG_USBEHCI
);
656 if (!DeviceRelations
)
661 Status
= STATUS_INSUFFICIENT_RESOURCES
;
666 // initialize device relations
668 DeviceRelations
->Count
= 1;
669 DeviceRelations
->Objects
[0] = DeviceObject
;
670 ObReferenceObject(DeviceObject
);
675 Status
= STATUS_SUCCESS
;
676 Irp
->IoStatus
.Information
= (ULONG_PTR
)DeviceRelations
;
683 Status
= Irp
->IoStatus
.Status
;
687 case IRP_MN_QUERY_BUS_INFORMATION
:
689 DPRINT1("CHubController::HandlePnp IRP_MN_QUERY_BUS_INFORMATION\n");
692 // allocate buffer for bus information
694 BusInformation
= (PPNP_BUS_INFORMATION
)ExAllocatePool(PagedPool
, sizeof(PNP_BUS_INFORMATION
));
700 RtlMoveMemory(&BusInformation
->BusTypeGuid
, &GUID_BUS_TYPE_USB
, sizeof(GUID
));
705 BusInformation
->LegacyBusType
= PNPBus
;
706 BusInformation
->BusNumber
= 0;
708 Status
= STATUS_SUCCESS
;
709 Irp
->IoStatus
.Information
= (ULONG_PTR
)BusInformation
;
716 Status
= STATUS_INSUFFICIENT_RESOURCES
;
720 case IRP_MN_STOP_DEVICE
:
722 DPRINT1("CHubController::HandlePnp IRP_MN_STOP_DEVICE\n");
726 Status
= STATUS_SUCCESS
;
732 // ignore request with default status
734 Status
= Irp
->IoStatus
.Status
;
742 Irp
->IoStatus
.Status
= Status
;
743 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
751 //-----------------------------------------------------------------------------------------
753 CHubController::HandlePower(
754 IN PDEVICE_OBJECT DeviceObject
,
758 Irp
->IoStatus
.Status
= STATUS_NOT_IMPLEMENTED
;
759 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
760 return STATUS_NOT_IMPLEMENTED
;
763 //-----------------------------------------------------------------------------------------
765 CHubController::HandleIsochronousTransfer(
769 PUSBDEVICE UsbDevice
;
770 PUSB_ENDPOINT_DESCRIPTOR EndPointDesc
= NULL
;
773 // Check PipeHandle to determine if this is a Bulk or Interrupt Transfer Request
775 EndPointDesc
= (PUSB_ENDPOINT_DESCRIPTOR
)Urb
->UrbIsochronousTransfer
.PipeHandle
;
779 DPRINT1("No EndpointDesc\n");
780 Urb
->UrbIsochronousTransfer
.Hdr
.Status
= USBD_STATUS_INVALID_PIPE_HANDLE
;
781 return STATUS_INVALID_PARAMETER
;
787 ASSERT(EndPointDesc
);
788 ASSERT((EndPointDesc
->bmAttributes
& USB_ENDPOINT_TYPE_MASK
) == USB_ENDPOINT_TYPE_ISOCHRONOUS
);
791 // check if this is a valid usb device handle
793 PC_ASSERT(ValidateUsbDevice(PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
)));
798 UsbDevice
= PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
);
800 return UsbDevice
->SubmitIrp(Irp
);
803 //-----------------------------------------------------------------------------------------
805 CHubController::HandleBulkOrInterruptTransfer(
809 PUSBDEVICE UsbDevice
;
810 PUSB_ENDPOINT_DESCRIPTOR EndPointDesc
= NULL
;
812 // First check if the request is for the Status Change Endpoint
816 // Is the Request for the root hub
818 if (Urb
->UrbHeader
.UsbdDeviceHandle
== 0)
820 ASSERT(m_PendingSCEIrp
== NULL
);
821 if (QueryStatusChageEndpoint(Irp
))
823 StatusChangeEndpointCallBack(this);
824 return STATUS_SUCCESS
;
828 // Else pend the IRP, to be completed when a device connects or disconnects.
830 DPRINT1("Pending SCE Irp\n");;
831 m_PendingSCEIrp
= Irp
;
832 IoMarkIrpPending(Irp
);
833 return STATUS_PENDING
;
837 // Check PipeHandle to determine if this is a Bulk or Interrupt Transfer Request
839 EndPointDesc
= (PUSB_ENDPOINT_DESCRIPTOR
)Urb
->UrbBulkOrInterruptTransfer
.PipeHandle
;
844 ASSERT(EndPointDesc
);
845 ASSERT((EndPointDesc
->bmAttributes
& USB_ENDPOINT_TYPE_MASK
) == USB_ENDPOINT_TYPE_BULK
|| (EndPointDesc
->bmAttributes
& USB_ENDPOINT_TYPE_MASK
) == USB_ENDPOINT_TYPE_INTERRUPT
);
848 // check if this is a valid usb device handle
850 PC_ASSERT(ValidateUsbDevice(PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
)));
855 UsbDevice
= PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
);
857 return UsbDevice
->SubmitIrp(Irp
);
860 //-----------------------------------------------------------------------------------------
862 CHubController::HandleClassOther(
866 NTSTATUS Status
= STATUS_NOT_IMPLEMENTED
;
867 USHORT PortStatus
= 0, PortChange
= 0;
872 DPRINT("CHubController::HandleClassOther> Request %x Value %x\n", Urb
->UrbControlVendorClassRequest
.Request
, Urb
->UrbControlVendorClassRequest
.Value
);
875 // get number of ports available
877 Status
= m_Hardware
->GetDeviceDetails(NULL
, NULL
, &NumPort
, NULL
);
878 PC_ASSERT(Status
== STATUS_SUCCESS
);
883 PC_ASSERT(Urb
->UrbControlVendorClassRequest
.Index
- 1 < (USHORT
)NumPort
);
886 // port range reported start from 1 -n
887 // convert back port id so it matches the hardware
889 PortId
= Urb
->UrbControlVendorClassRequest
.Index
- 1;
892 // check request code
894 switch(Urb
->UrbControlVendorClassRequest
.Request
)
896 case USB_REQUEST_GET_STATUS
:
901 PC_ASSERT(Urb
->UrbControlVendorClassRequest
.TransferBufferLength
== sizeof(USHORT
) * 2);
902 PC_ASSERT(Urb
->UrbControlVendorClassRequest
.TransferBuffer
);
907 Status
= m_Hardware
->GetPortStatus(PortId
, &PortStatus
, &PortChange
);
909 if (NT_SUCCESS(Status
))
912 // request contains buffer of 2 ushort which are used from submitting port status and port change status
914 DPRINT("PortId %x PortStatus %x PortChange %x\n", PortId
, PortStatus
, PortChange
);
915 Buffer
= (PUSHORT
)Urb
->UrbControlVendorClassRequest
.TransferBuffer
;
918 // store status, then port change
920 *Buffer
= PortStatus
;
922 *Buffer
= PortChange
;
930 case USB_REQUEST_CLEAR_FEATURE
:
932 switch (Urb
->UrbControlVendorClassRequest
.Value
)
934 case C_PORT_CONNECTION
:
935 Status
= m_Hardware
->ClearPortStatus(PortId
, C_PORT_CONNECTION
);
938 Status
= m_Hardware
->ClearPortStatus(PortId
, C_PORT_RESET
);
941 DPRINT("Unknown Value for Clear Feature %x \n", Urb
->UrbControlVendorClassRequest
.Value
);
945 Status
= STATUS_SUCCESS
;
948 case USB_REQUEST_SET_FEATURE
:
951 // request set feature
953 switch(Urb
->UrbControlVendorClassRequest
.Value
)
958 // port enable is a no-op for EHCI
960 Status
= STATUS_SUCCESS
;
967 // set suspend port feature
969 Status
= m_Hardware
->SetPortFeature(PortId
, PORT_SUSPEND
);
975 // set power feature on port
977 Status
= m_Hardware
->SetPortFeature(PortId
, PORT_POWER
);
984 // reset port feature
986 Status
= m_Hardware
->SetPortFeature(PortId
, PORT_RESET
);
987 PC_ASSERT(Status
== STATUS_SUCCESS
);
991 DPRINT1("Unsupported request id %x\n", Urb
->UrbControlVendorClassRequest
.Value
);
997 DPRINT1("CHubController::HandleClassOther Unknown request code %x\n", Urb
->UrbControlVendorClassRequest
.Request
);
999 Status
= STATUS_INVALID_DEVICE_REQUEST
;
1004 //-----------------------------------------------------------------------------------------
1006 CHubController::HandleSelectConfiguration(
1010 PUSBDEVICE UsbDevice
;
1011 PUSBD_INTERFACE_INFORMATION InterfaceInfo
;
1014 // is the request for the Root Hub
1016 if (Urb
->UrbHeader
.UsbdDeviceHandle
== NULL
)
1019 // FIXME: support setting device to unconfigured state
1021 PC_ASSERT(Urb
->UrbSelectConfiguration
.ConfigurationDescriptor
);
1024 // set device handle
1026 Urb
->UrbSelectConfiguration
.ConfigurationHandle
= (PVOID
)&ROOTHUB2_CONFIGURATION_DESCRIPTOR
;
1029 // copy interface info
1031 InterfaceInfo
= &Urb
->UrbSelectConfiguration
.Interface
;
1033 InterfaceInfo
->InterfaceHandle
= (USBD_INTERFACE_HANDLE
)&ROOTHUB2_INTERFACE_DESCRIPTOR
;
1034 InterfaceInfo
->Class
= ROOTHUB2_INTERFACE_DESCRIPTOR
.bInterfaceClass
;
1035 InterfaceInfo
->SubClass
= ROOTHUB2_INTERFACE_DESCRIPTOR
.bInterfaceSubClass
;
1036 InterfaceInfo
->Protocol
= ROOTHUB2_INTERFACE_DESCRIPTOR
.bInterfaceProtocol
;
1037 InterfaceInfo
->Reserved
= 0;
1042 PC_ASSERT(InterfaceInfo
->NumberOfPipes
== 1);
1047 InterfaceInfo
->Pipes
[0].MaximumPacketSize
= ROOTHUB2_ENDPOINT_DESCRIPTOR
.wMaxPacketSize
;
1048 InterfaceInfo
->Pipes
[0].EndpointAddress
= ROOTHUB2_ENDPOINT_DESCRIPTOR
.bEndpointAddress
;
1049 InterfaceInfo
->Pipes
[0].Interval
= ROOTHUB2_ENDPOINT_DESCRIPTOR
.bInterval
;
1050 InterfaceInfo
->Pipes
[0].PipeType
= (USBD_PIPE_TYPE
)(ROOTHUB2_ENDPOINT_DESCRIPTOR
.bmAttributes
& USB_ENDPOINT_TYPE_MASK
);
1051 InterfaceInfo
->Pipes
[0].PipeHandle
= (PVOID
)&ROOTHUB2_ENDPOINT_DESCRIPTOR
;
1053 return STATUS_SUCCESS
;
1058 // check if this is a valid usb device handle
1060 PC_ASSERT(ValidateUsbDevice(PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
)));
1065 UsbDevice
= PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
);
1068 // select configuration
1070 return UsbDevice
->SelectConfiguration(Urb
->UrbSelectConfiguration
.ConfigurationDescriptor
, &Urb
->UrbSelectConfiguration
.Interface
, &Urb
->UrbSelectConfiguration
.ConfigurationHandle
);
1074 //-----------------------------------------------------------------------------------------
1076 CHubController::HandleSelectInterface(
1080 PUSBDEVICE UsbDevice
;
1085 PC_ASSERT(Urb
->UrbSelectInterface
.ConfigurationHandle
);
1088 // is the request for the Root Hub
1090 if (Urb
->UrbHeader
.UsbdDeviceHandle
== NULL
)
1093 // no op for root hub
1095 return STATUS_SUCCESS
;
1100 // check if this is a valid usb device handle
1102 PC_ASSERT(ValidateUsbDevice(PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
)));
1107 UsbDevice
= PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
);
1112 return UsbDevice
->SelectInterface(Urb
->UrbSelectInterface
.ConfigurationHandle
, &Urb
->UrbSelectInterface
.Interface
);
1116 //-----------------------------------------------------------------------------------------
1118 CHubController::HandleGetStatusFromDevice(
1122 PUSHORT DeviceStatus
;
1123 USB_DEFAULT_PIPE_SETUP_PACKET CtrlSetup
;
1125 PUSBDEVICE UsbDevice
;
1130 PC_ASSERT(Urb
->UrbControlGetStatusRequest
.Index
== 0);
1131 PC_ASSERT(Urb
->UrbControlGetStatusRequest
.TransferBufferLength
>= sizeof(USHORT
));
1132 PC_ASSERT(Urb
->UrbControlGetStatusRequest
.TransferBuffer
);
1135 // get status buffer
1137 DeviceStatus
= (PUSHORT
)Urb
->UrbControlGetStatusRequest
.TransferBuffer
;
1140 if (Urb
->UrbHeader
.UsbdDeviceHandle
== NULL
)
1143 // FIXME need more flags ?
1145 *DeviceStatus
= USB_PORT_STATUS_CONNECT
;
1146 return STATUS_SUCCESS
;
1150 // check if this is a valid usb device handle
1152 ASSERT(ValidateUsbDevice(PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
)));
1157 UsbDevice
= PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
);
1161 // generate setup packet
1163 CtrlSetup
.bRequest
= USB_REQUEST_GET_STATUS
;
1164 CtrlSetup
.wValue
.LowByte
= 0;
1165 CtrlSetup
.wValue
.HiByte
= 0;
1166 CtrlSetup
.wIndex
.W
= Urb
->UrbControlGetStatusRequest
.Index
;
1167 CtrlSetup
.wLength
= (USHORT
)Urb
->UrbControlGetStatusRequest
.TransferBufferLength
;
1168 CtrlSetup
.bmRequestType
.B
= 0x80;
1171 // submit setup packet
1173 Status
= UsbDevice
->SubmitSetupPacket(&CtrlSetup
, Urb
->UrbControlDescriptorRequest
.TransferBufferLength
, Urb
->UrbControlDescriptorRequest
.TransferBuffer
);
1174 ASSERT(Status
== STATUS_SUCCESS
);
1175 DPRINT1("CHubController::HandleGetStatusFromDevice Status %x Length %lu DeviceStatus %x\n", Status
, Urb
->UrbControlDescriptorRequest
.TransferBufferLength
, *DeviceStatus
);
1183 //-----------------------------------------------------------------------------------------
1185 CHubController::HandleClassDevice(
1189 NTSTATUS Status
= STATUS_NOT_IMPLEMENTED
;
1190 PUSB_HUB_DESCRIPTOR UsbHubDescriptor
;
1191 ULONG PortCount
, Dummy2
;
1193 PUSBDEVICE UsbDevice
;
1194 USB_DEFAULT_PIPE_SETUP_PACKET CtrlSetup
;
1196 DPRINT("CHubController::HandleClassDevice Request %x Class %x\n", Urb
->UrbControlVendorClassRequest
.Request
, Urb
->UrbControlVendorClassRequest
.Value
>> 8);
1199 // check class request type
1201 switch(Urb
->UrbControlVendorClassRequest
.Request
)
1203 case USB_REQUEST_GET_STATUS
:
1206 // check if this is a valid usb device handle
1208 ASSERT(ValidateUsbDevice(PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
)));
1213 UsbDevice
= PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
);
1217 // generate setup packet
1219 CtrlSetup
.bRequest
= USB_REQUEST_GET_STATUS
;
1220 CtrlSetup
.wValue
.LowByte
= Urb
->UrbControlVendorClassRequest
.Index
;
1221 CtrlSetup
.wValue
.W
= Urb
->UrbControlVendorClassRequest
.Value
;
1222 CtrlSetup
.wIndex
.W
= Urb
->UrbControlVendorClassRequest
.Index
;
1223 CtrlSetup
.wLength
= (USHORT
)Urb
->UrbControlGetStatusRequest
.TransferBufferLength
;
1224 CtrlSetup
.bmRequestType
.B
= 0xA0;
1227 // submit setup packet
1229 Status
= UsbDevice
->SubmitSetupPacket(&CtrlSetup
, Urb
->UrbControlDescriptorRequest
.TransferBufferLength
, Urb
->UrbControlDescriptorRequest
.TransferBuffer
);
1230 ASSERT(Status
== STATUS_SUCCESS
);
1233 case USB_REQUEST_GET_DESCRIPTOR
:
1235 switch (Urb
->UrbControlVendorClassRequest
.Value
>> 8)
1237 case USB_DEVICE_CLASS_RESERVED
: // FALL THROUGH
1238 case USB_DEVICE_CLASS_HUB
:
1243 PC_ASSERT(Urb
->UrbControlVendorClassRequest
.TransferBuffer
);
1244 PC_ASSERT(Urb
->UrbControlVendorClassRequest
.TransferBufferLength
>= sizeof(USB_HUB_DESCRIPTOR
));
1247 // get hub descriptor
1249 UsbHubDescriptor
= (PUSB_HUB_DESCRIPTOR
)Urb
->UrbControlVendorClassRequest
.TransferBuffer
;
1252 // one hub is handled
1254 UsbHubDescriptor
->bDescriptorLength
= sizeof(USB_HUB_DESCRIPTOR
);
1255 Urb
->UrbControlVendorClassRequest
.TransferBufferLength
= sizeof(USB_HUB_DESCRIPTOR
);
1258 // type should 0x29 according to msdn
1260 UsbHubDescriptor
->bDescriptorType
= 0x29;
1265 Status
= m_Hardware
->GetDeviceDetails(&Dummy1
, &Dummy1
, &PortCount
, &Dummy2
);
1266 PC_ASSERT(Status
== STATUS_SUCCESS
);
1269 // FIXME: retrieve values
1271 UsbHubDescriptor
->bNumberOfPorts
= (UCHAR
)PortCount
;
1272 UsbHubDescriptor
->wHubCharacteristics
= 0x00;
1273 UsbHubDescriptor
->bPowerOnToPowerGood
= 0x01;
1274 UsbHubDescriptor
->bHubControlCurrent
= 0x00;
1279 Status
= STATUS_SUCCESS
;
1283 DPRINT1("CHubController::HandleClassDevice Class %x not implemented\n", Urb
->UrbControlVendorClassRequest
.Value
>> 8);
1289 DPRINT1("CHubController::HandleClassDevice Type %x not implemented\n", Urb
->UrbControlVendorClassRequest
.Request
);
1295 //-----------------------------------------------------------------------------------------
1297 CHubController::HandleGetDescriptorFromInterface(
1301 PUSBDEVICE UsbDevice
;
1302 USB_DEFAULT_PIPE_SETUP_PACKET CtrlSetup
;
1308 ASSERT(Urb
->UrbControlDescriptorRequest
.TransferBufferLength
);
1309 ASSERT(Urb
->UrbControlDescriptorRequest
.TransferBuffer
);
1312 // check if this is a valid usb device handle
1314 ASSERT(ValidateUsbDevice(PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
)));
1319 UsbDevice
= PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
);
1322 // generate setup packet
1324 CtrlSetup
.bRequest
= USB_REQUEST_GET_DESCRIPTOR
;
1325 CtrlSetup
.wValue
.LowByte
= Urb
->UrbControlDescriptorRequest
.Index
;
1326 CtrlSetup
.wValue
.HiByte
= Urb
->UrbControlDescriptorRequest
.DescriptorType
;
1327 CtrlSetup
.wIndex
.W
= Urb
->UrbControlDescriptorRequest
.LanguageId
;
1328 CtrlSetup
.wLength
= (USHORT
)Urb
->UrbControlDescriptorRequest
.TransferBufferLength
;
1329 CtrlSetup
.bmRequestType
.B
= 0x81;
1332 // submit setup packet
1334 Status
= UsbDevice
->SubmitSetupPacket(&CtrlSetup
, Urb
->UrbControlDescriptorRequest
.TransferBufferLength
, Urb
->UrbControlDescriptorRequest
.TransferBuffer
);
1335 ASSERT(Status
== STATUS_SUCCESS
);
1343 //-----------------------------------------------------------------------------------------
1345 CHubController::HandleGetDescriptor(
1349 NTSTATUS Status
= STATUS_NOT_IMPLEMENTED
;
1350 PUSB_CONFIGURATION_DESCRIPTOR ConfigurationDescriptor
;
1351 USB_DEFAULT_PIPE_SETUP_PACKET CtrlSetup
;
1353 PUSBDEVICE UsbDevice
;
1356 DPRINT("CHubController::HandleGetDescriptor\n");
1359 // check descriptor type
1361 switch(Urb
->UrbControlDescriptorRequest
.DescriptorType
)
1363 case USB_DEVICE_DESCRIPTOR_TYPE
:
1368 PC_ASSERT(Urb
->UrbControlDescriptorRequest
.TransferBufferLength
>= sizeof(USB_DEVICE_DESCRIPTOR
));
1369 PC_ASSERT(Urb
->UrbControlDescriptorRequest
.TransferBuffer
);
1371 if (Urb
->UrbHeader
.UsbdDeviceHandle
== NULL
)
1374 // copy root hub device descriptor
1376 RtlCopyMemory((PUCHAR
)Urb
->UrbControlDescriptorRequest
.TransferBuffer
, &m_DeviceDescriptor
, sizeof(USB_DEVICE_DESCRIPTOR
));
1377 Status
= STATUS_SUCCESS
;
1382 // check if this is a valid usb device handle
1384 PC_ASSERT(ValidateUsbDevice(PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
)));
1389 UsbDevice
= PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
);
1392 // retrieve device descriptor from device
1394 UsbDevice
->GetDeviceDescriptor((PUSB_DEVICE_DESCRIPTOR
)Urb
->UrbControlDescriptorRequest
.TransferBuffer
);
1395 Status
= STATUS_SUCCESS
;
1399 case USB_CONFIGURATION_DESCRIPTOR_TYPE
:
1404 PC_ASSERT(Urb
->UrbControlDescriptorRequest
.TransferBuffer
);
1405 PC_ASSERT(Urb
->UrbControlDescriptorRequest
.TransferBufferLength
>= sizeof(USB_CONFIGURATION_DESCRIPTOR
));
1407 if (Urb
->UrbHeader
.UsbdDeviceHandle
== NULL
)
1410 // request is for the root bus controller
1412 RtlCopyMemory(Urb
->UrbControlDescriptorRequest
.TransferBuffer
, &ROOTHUB2_CONFIGURATION_DESCRIPTOR
, sizeof(USB_CONFIGURATION_DESCRIPTOR
));
1415 // get configuration descriptor, very retarded!
1417 ConfigurationDescriptor
= (PUSB_CONFIGURATION_DESCRIPTOR
)Urb
->UrbControlDescriptorRequest
.TransferBuffer
;
1420 // check if buffer can hold interface and endpoint descriptor
1422 if (ConfigurationDescriptor
->wTotalLength
> Urb
->UrbControlDescriptorRequest
.TransferBufferLength
)
1427 Status
= STATUS_SUCCESS
;
1433 // copy interface descriptor template
1435 Buffer
= (PUCHAR
)(ConfigurationDescriptor
+ 1);
1436 RtlCopyMemory(Buffer
, &ROOTHUB2_INTERFACE_DESCRIPTOR
, sizeof(USB_INTERFACE_DESCRIPTOR
));
1439 // copy end point descriptor template
1441 Buffer
+= sizeof(USB_INTERFACE_DESCRIPTOR
);
1442 RtlCopyMemory(Buffer
, &ROOTHUB2_ENDPOINT_DESCRIPTOR
, sizeof(USB_ENDPOINT_DESCRIPTOR
));
1447 Status
= STATUS_SUCCESS
;
1453 // check if this is a valid usb device handle
1455 PC_ASSERT(ValidateUsbDevice(PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
)));
1460 UsbDevice
= PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
);
1462 if (sizeof(USB_CONFIGURATION_DESCRIPTOR
) > Urb
->UrbControlDescriptorRequest
.TransferBufferLength
)
1467 Urb
->UrbControlDescriptorRequest
.TransferBufferLength
= UsbDevice
->GetConfigurationDescriptorsLength();
1472 Status
= STATUS_SUCCESS
;
1477 // perform work in IUSBDevice
1479 UsbDevice
->GetConfigurationDescriptors((PUSB_CONFIGURATION_DESCRIPTOR
)Urb
->UrbControlDescriptorRequest
.TransferBuffer
, Urb
->UrbControlDescriptorRequest
.TransferBufferLength
, &Length
);
1484 PC_ASSERT(Urb
->UrbControlDescriptorRequest
.TransferBufferLength
>= Length
);
1487 // store result size
1489 Urb
->UrbControlDescriptorRequest
.TransferBufferLength
= Length
;
1490 Status
= STATUS_SUCCESS
;
1494 case USB_STRING_DESCRIPTOR_TYPE
:
1499 PC_ASSERT(Urb
->UrbControlDescriptorRequest
.TransferBuffer
);
1500 PC_ASSERT(Urb
->UrbControlDescriptorRequest
.TransferBufferLength
);
1504 // check if this is a valid usb device handle
1506 PC_ASSERT(ValidateUsbDevice(PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
)));
1511 UsbDevice
= PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
);
1514 // generate setup packet
1516 CtrlSetup
.bRequest
= USB_REQUEST_GET_DESCRIPTOR
;
1517 CtrlSetup
.wValue
.LowByte
= Urb
->UrbControlDescriptorRequest
.Index
;
1518 CtrlSetup
.wValue
.HiByte
= Urb
->UrbControlDescriptorRequest
.DescriptorType
;
1519 CtrlSetup
.wIndex
.W
= Urb
->UrbControlDescriptorRequest
.LanguageId
;
1520 CtrlSetup
.wLength
= (USHORT
)Urb
->UrbControlDescriptorRequest
.TransferBufferLength
;
1521 CtrlSetup
.bmRequestType
.B
= 0x80;
1524 // submit setup packet
1526 Status
= UsbDevice
->SubmitSetupPacket(&CtrlSetup
, Urb
->UrbControlDescriptorRequest
.TransferBufferLength
, Urb
->UrbControlDescriptorRequest
.TransferBuffer
);
1530 DPRINT1("CHubController::HandleGetDescriptor DescriptorType %x unimplemented\n", Urb
->UrbControlDescriptorRequest
.DescriptorType
);
1540 //-----------------------------------------------------------------------------------------
1542 CHubController::HandleClassEndpoint(
1546 USB_DEFAULT_PIPE_SETUP_PACKET CtrlSetup
;
1548 PUSBDEVICE UsbDevice
;
1553 PC_ASSERT(Urb
->UrbControlVendorClassRequest
.TransferBuffer
);
1554 PC_ASSERT(Urb
->UrbControlVendorClassRequest
.TransferBufferLength
);
1555 PC_ASSERT(Urb
->UrbHeader
.UsbdDeviceHandle
);
1558 // check if this is a valid usb device handle
1560 PC_ASSERT(ValidateUsbDevice(PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
)));
1565 UsbDevice
= PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
);
1568 DPRINT1("URB_FUNCTION_CLASS_ENDPOINT\n");
1569 DPRINT1("TransferFlags %x\n", Urb
->UrbControlVendorClassRequest
.TransferFlags
);
1570 DPRINT1("TransferBufferLength %x\n", Urb
->UrbControlVendorClassRequest
.TransferBufferLength
);
1571 DPRINT1("TransferBuffer %x\n", Urb
->UrbControlVendorClassRequest
.TransferBuffer
);
1572 DPRINT1("TransferBufferMDL %x\n", Urb
->UrbControlVendorClassRequest
.TransferBufferMDL
);
1573 DPRINT1("RequestTypeReservedBits %x\n", Urb
->UrbControlVendorClassRequest
.RequestTypeReservedBits
);
1574 DPRINT1("Request %x\n", Urb
->UrbControlVendorClassRequest
.Request
);
1575 DPRINT1("Value %x\n", Urb
->UrbControlVendorClassRequest
.Value
);
1576 DPRINT1("Index %x\n", Urb
->UrbControlVendorClassRequest
.Index
);
1579 // initialize setup packet
1581 CtrlSetup
.bmRequestType
.B
= 0xa2; //FIXME: Const.
1582 CtrlSetup
.bRequest
= Urb
->UrbControlVendorClassRequest
.Request
;
1583 CtrlSetup
.wValue
.W
= Urb
->UrbControlVendorClassRequest
.Value
;
1584 CtrlSetup
.wIndex
.W
= Urb
->UrbControlVendorClassRequest
.Index
;
1585 CtrlSetup
.wLength
= Urb
->UrbControlVendorClassRequest
.TransferBufferLength
;
1590 Status
= UsbDevice
->SubmitSetupPacket(&CtrlSetup
, Urb
->UrbControlVendorClassRequest
.TransferBufferLength
, Urb
->UrbControlVendorClassRequest
.TransferBuffer
);
1593 // assert on failure
1595 PC_ASSERT(NT_SUCCESS(Status
));
1604 //-----------------------------------------------------------------------------------------
1606 CHubController::HandleClassInterface(
1610 USB_DEFAULT_PIPE_SETUP_PACKET CtrlSetup
;
1612 PUSBDEVICE UsbDevice
;
1617 //ASSERT(Urb->UrbControlVendorClassRequest.TransferBuffer || Urb->UrbControlVendorClassRequest.TransferBufferMDL);
1618 //ASSERT(Urb->UrbControlVendorClassRequest.TransferBufferLength);
1619 PC_ASSERT(Urb
->UrbHeader
.UsbdDeviceHandle
);
1622 // check if this is a valid usb device handle
1624 PC_ASSERT(ValidateUsbDevice(PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
)));
1629 UsbDevice
= PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
);
1632 DPRINT1("URB_FUNCTION_CLASS_INTERFACE\n");
1633 DPRINT1("TransferFlags %x\n", Urb
->UrbControlVendorClassRequest
.TransferFlags
);
1634 DPRINT1("TransferBufferLength %x\n", Urb
->UrbControlVendorClassRequest
.TransferBufferLength
);
1635 DPRINT1("TransferBuffer %x\n", Urb
->UrbControlVendorClassRequest
.TransferBuffer
);
1636 DPRINT1("TransferBufferMDL %x\n", Urb
->UrbControlVendorClassRequest
.TransferBufferMDL
);
1637 DPRINT1("RequestTypeReservedBits %x\n", Urb
->UrbControlVendorClassRequest
.RequestTypeReservedBits
);
1638 DPRINT1("Request %x\n", Urb
->UrbControlVendorClassRequest
.Request
);
1639 DPRINT1("Value %x\n", Urb
->UrbControlVendorClassRequest
.Value
);
1640 DPRINT1("Index %x\n", Urb
->UrbControlVendorClassRequest
.Index
);
1643 // initialize setup packet
1645 CtrlSetup
.bmRequestType
.B
= 0xa1; //FIXME: Const.
1646 CtrlSetup
.bRequest
= Urb
->UrbControlVendorClassRequest
.Request
;
1647 CtrlSetup
.wValue
.W
= Urb
->UrbControlVendorClassRequest
.Value
;
1648 CtrlSetup
.wIndex
.W
= Urb
->UrbControlVendorClassRequest
.Index
;
1649 CtrlSetup
.wLength
= Urb
->UrbControlVendorClassRequest
.TransferBufferLength
;
1654 Status
= UsbDevice
->SubmitSetupPacket(&CtrlSetup
, Urb
->UrbControlVendorClassRequest
.TransferBufferLength
, Urb
->UrbControlVendorClassRequest
.TransferBuffer
);
1657 // assert on failure
1659 PC_ASSERT(NT_SUCCESS(Status
));
1668 //-----------------------------------------------------------------------------------------
1670 CHubController::HandleDeviceControl(
1671 IN PDEVICE_OBJECT DeviceObject
,
1674 PIO_STACK_LOCATION IoStack
;
1675 PCOMMON_DEVICE_EXTENSION DeviceExtension
;
1677 NTSTATUS Status
= STATUS_NOT_IMPLEMENTED
;
1680 // get current stack location
1682 IoStack
= IoGetCurrentIrpStackLocation(Irp
);
1685 // get device extension
1687 DeviceExtension
= (PCOMMON_DEVICE_EXTENSION
)DeviceObject
->DeviceExtension
;
1690 // determine which request should be performed
1692 switch(IoStack
->Parameters
.DeviceIoControl
.IoControlCode
)
1694 case IOCTL_INTERNAL_USB_SUBMIT_URB
:
1699 Urb
= (PURB
)IoStack
->Parameters
.Others
.Argument1
;
1702 switch (Urb
->UrbHeader
.Function
)
1704 case URB_FUNCTION_GET_DESCRIPTOR_FROM_INTERFACE
:
1705 Status
= HandleGetDescriptorFromInterface(Irp
, Urb
);
1707 case URB_FUNCTION_GET_DESCRIPTOR_FROM_DEVICE
:
1708 Status
= HandleGetDescriptor(Irp
, Urb
);
1710 case URB_FUNCTION_CLASS_DEVICE
:
1711 Status
= HandleClassDevice(Irp
, Urb
);
1713 case URB_FUNCTION_GET_STATUS_FROM_DEVICE
:
1714 Status
= HandleGetStatusFromDevice(Irp
, Urb
);
1716 case URB_FUNCTION_SELECT_CONFIGURATION
:
1717 Status
= HandleSelectConfiguration(Irp
, Urb
);
1719 case URB_FUNCTION_SELECT_INTERFACE
:
1720 Status
= HandleSelectInterface(Irp
, Urb
);
1722 case URB_FUNCTION_CLASS_OTHER
:
1723 Status
= HandleClassOther(Irp
, Urb
);
1725 case URB_FUNCTION_BULK_OR_INTERRUPT_TRANSFER
:
1726 Status
= HandleBulkOrInterruptTransfer(Irp
, Urb
);
1728 case URB_FUNCTION_ISOCH_TRANSFER
:
1729 Status
= HandleIsochronousTransfer(Irp
, Urb
);
1731 case URB_FUNCTION_CLASS_INTERFACE
:
1732 Status
= HandleClassInterface(Irp
, Urb
);
1734 case URB_FUNCTION_CLASS_ENDPOINT
:
1735 Status
= HandleClassEndpoint(Irp
, Urb
);
1738 DPRINT1("IOCTL_INTERNAL_USB_SUBMIT_URB Function %x NOT IMPLEMENTED\n", Urb
->UrbHeader
.Function
);
1742 // request completed
1746 case IOCTL_INTERNAL_USB_GET_DEVICE_HANDLE
:
1748 DPRINT("IOCTL_INTERNAL_USB_GET_DEVICE_HANDLE %p\n", this);
1750 if (IoStack
->Parameters
.Others
.Argument1
)
1753 // store object as device handle
1755 *(PVOID
*)IoStack
->Parameters
.Others
.Argument1
= (PVOID
)this;
1756 Status
= STATUS_SUCCESS
;
1761 // mis-behaving hub driver
1763 Status
= STATUS_INVALID_DEVICE_REQUEST
;
1767 // request completed
1771 case IOCTL_INTERNAL_USB_GET_ROOTHUB_PDO
:
1773 DPRINT("IOCTL_INTERNAL_USB_GET_ROOTHUB_PDO\n");
1776 // this is the first request send, it delivers the PDO to the caller
1778 if (IoStack
->Parameters
.Others
.Argument1
)
1781 // store root hub pdo object
1783 *(PVOID
*)IoStack
->Parameters
.Others
.Argument1
= DeviceObject
;
1786 if (IoStack
->Parameters
.Others
.Argument2
)
1789 // documentation claims to deliver the hcd controller object, although it is wrong
1791 *(PVOID
*)IoStack
->Parameters
.Others
.Argument2
= DeviceObject
;
1795 // request completed
1797 Status
= STATUS_SUCCESS
;
1800 case IOCTL_INTERNAL_USB_GET_HUB_COUNT
:
1802 DPRINT("IOCTL_INTERNAL_USB_GET_HUB_COUNT\n");
1805 // after IOCTL_INTERNAL_USB_GET_ROOTHUB_PDO is delivered, the usbhub driver
1806 // requests this ioctl to deliver the number of presents.
1808 if (IoStack
->Parameters
.Others
.Argument1
)
1811 // FIXME / verify: there is only one hub
1813 *(PULONG
)IoStack
->Parameters
.Others
.Argument1
= 1;
1817 // request completed
1819 Status
= STATUS_SUCCESS
;
1820 Irp
->IoStatus
.Information
= sizeof(ULONG
);
1823 case IOCTL_INTERNAL_USB_SUBMIT_IDLE_NOTIFICATION
:
1825 DPRINT1("IOCTL_INTERNAL_USB_SUBMIT_IDLE_NOTIFICATION UNIMPLEMENTED\n");
1826 Status
= STATUS_SUCCESS
;
1831 DPRINT1("HandleDeviceControl>Type: IoCtl %x InputBufferLength %lu OutputBufferLength %lu NOT IMPLEMENTED\n",
1832 IoStack
->Parameters
.DeviceIoControl
.IoControlCode
,
1833 IoStack
->Parameters
.DeviceIoControl
.InputBufferLength
,
1834 IoStack
->Parameters
.DeviceIoControl
.OutputBufferLength
);
1838 if (Status
!= STATUS_PENDING
)
1840 Irp
->IoStatus
.Status
= Status
;
1841 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
1847 //-----------------------------------------------------------------------------------------
1849 CHubController::GetUsbHardware()
1854 //-----------------------------------------------------------------------------------------
1856 CHubController::AcquireDeviceAddress()
1859 ULONG DeviceAddress
;
1862 // acquire device lock
1864 DPRINT(__FUNCTION__
" acquire\n");
1865 KeAcquireSpinLock(&m_Lock
, &OldLevel
);
1866 DPRINT(__FUNCTION__
" acquired\n");
1871 DeviceAddress
= RtlFindClearBits(&m_DeviceAddressBitmap
, 1, 0);
1872 if (DeviceAddress
!= MAXULONG
)
1877 RtlSetBits(&m_DeviceAddressBitmap
, DeviceAddress
, 1);
1880 // device addresses start from 0x1 - 0xFF
1886 // release spin lock
1888 DPRINT(__FUNCTION__
"release\n");
1889 KeReleaseSpinLock(&m_Lock
, OldLevel
);
1892 // return device address
1894 return DeviceAddress
;
1896 //-----------------------------------------------------------------------------------------
1898 CHubController::ReleaseDeviceAddress(
1899 ULONG DeviceAddress
)
1904 // acquire device lock
1906 DPRINT(__FUNCTION__
" acquire\n");
1907 KeAcquireSpinLock(&m_Lock
, &OldLevel
);
1908 DPRINT(__FUNCTION__
" acquired\n");
1913 PC_ASSERT(DeviceAddress
!= 0);
1916 // convert back to bit number
1923 RtlClearBits(&m_DeviceAddressBitmap
, DeviceAddress
, 1);
1928 DPRINT(__FUNCTION__
"release\n");
1929 KeReleaseSpinLock(&m_Lock
, OldLevel
);
1931 //-----------------------------------------------------------------------------------------
1933 CHubController::RemoveUsbDevice(
1934 PUSBDEVICE UsbDevice
)
1936 PUSBDEVICE_ENTRY DeviceEntry
;
1938 NTSTATUS Status
= STATUS_UNSUCCESSFUL
;
1944 DPRINT(__FUNCTION__
" acquire\n");
1945 KeAcquireSpinLock(&m_Lock
, &OldLevel
);
1946 DPRINT(__FUNCTION__
" acquired\n");
1949 // point to first entry
1951 Entry
= m_UsbDeviceList
.Flink
;
1954 // find matching entry
1956 while(Entry
!= &m_UsbDeviceList
)
1961 DeviceEntry
= (PUSBDEVICE_ENTRY
)CONTAINING_RECORD(Entry
, USBDEVICE_ENTRY
, Entry
);
1964 // is it current entry
1966 if (DeviceEntry
->Device
== UsbDevice
)
1971 RemoveEntryList(Entry
);
1976 ExFreePoolWithTag(DeviceEntry
, TAG_USBEHCI
);
1981 Status
= STATUS_SUCCESS
;
1988 Entry
= Entry
->Flink
;
1994 DPRINT(__FUNCTION__
"release\n");
1995 KeReleaseSpinLock(&m_Lock
, OldLevel
);
2002 //-----------------------------------------------------------------------------------------
2004 CHubController::ValidateUsbDevice(PUSBDEVICE UsbDevice
)
2006 PUSBDEVICE_ENTRY DeviceEntry
;
2009 BOOLEAN Result
= FALSE
;
2014 DPRINT(__FUNCTION__
" acquire\n");
2015 KeAcquireSpinLock(&m_Lock
, &OldLevel
);
2016 DPRINT(__FUNCTION__
" acquired\n");
2019 // point to first entry
2021 Entry
= m_UsbDeviceList
.Flink
;
2024 // find matching entry
2026 while(Entry
!= &m_UsbDeviceList
)
2031 DeviceEntry
= (PUSBDEVICE_ENTRY
)CONTAINING_RECORD(Entry
, USBDEVICE_ENTRY
, Entry
);
2034 // is it current entry
2036 if (DeviceEntry
->Device
== UsbDevice
)
2048 Entry
= Entry
->Flink
;
2054 DPRINT(__FUNCTION__
"release\n");
2055 KeReleaseSpinLock(&m_Lock
, OldLevel
);
2064 //-----------------------------------------------------------------------------------------
2066 CHubController::AddUsbDevice(
2067 PUSBDEVICE UsbDevice
)
2069 PUSBDEVICE_ENTRY DeviceEntry
;
2073 // allocate device entry
2075 DeviceEntry
= (PUSBDEVICE_ENTRY
)ExAllocatePoolWithTag(NonPagedPool
, sizeof(USBDEVICE_ENTRY
), TAG_USBEHCI
);
2081 return STATUS_INSUFFICIENT_RESOURCES
;
2087 DeviceEntry
->Device
= UsbDevice
;
2092 DPRINT(__FUNCTION__
" acquire\n");
2093 KeAcquireSpinLock(&m_Lock
, &OldLevel
);
2094 DPRINT(__FUNCTION__
" acquired\n");
2099 InsertTailList(&m_UsbDeviceList
, &DeviceEntry
->Entry
);
2102 // release spin lock
2104 DPRINT(__FUNCTION__
"release\n");
2105 KeReleaseSpinLock(&m_Lock
, OldLevel
);
2110 return STATUS_SUCCESS
;
2113 //-----------------------------------------------------------------------------------------
2115 CHubController::SetNotification(
2116 PVOID CallbackContext
,
2117 PRH_INIT_CALLBACK CallbackRoutine
)
2122 // acquire hub controller lock
2124 DPRINT(__FUNCTION__
" acquire\n");
2125 KeAcquireSpinLock(&m_Lock
, &OldLevel
);
2126 DPRINT(__FUNCTION__
" acquired\n");
2129 // now set the callback routine and context of the hub
2131 m_HubCallbackContext
= CallbackContext
;
2132 m_HubCallbackRoutine
= CallbackRoutine
;
2135 // release hub controller lock
2137 DPRINT(__FUNCTION__
"release\n");
2138 KeReleaseSpinLock(&m_Lock
, OldLevel
);
2141 //=================================================================================================
2143 // Generic Interface functions
2147 USBI_InterfaceReference(
2150 CHubController
* Controller
= (CHubController
*)BusContext
;
2152 DPRINT1("USBH_InterfaceReference\n");
2157 Controller
->AddRef();
2162 USBI_InterfaceDereference(
2165 CHubController
* Controller
= (CHubController
*)BusContext
;
2167 DPRINT1("USBH_InterfaceDereference\n");
2172 Controller
->Release();
2174 //=================================================================================================
2176 // USB Hub Interface functions
2180 USBHI_CreateUsbDevice(
2182 PUSB_DEVICE_HANDLE
*NewDevice
,
2183 PUSB_DEVICE_HANDLE HubDeviceHandle
,
2187 PUSBDEVICE NewUsbDevice
;
2188 CHubController
* Controller
;
2191 DPRINT1("USBHI_CreateUsbDevice\n");
2194 // first get hub controller
2196 Controller
= (CHubController
*)BusContext
;
2201 PC_ASSERT(Controller
);
2202 PC_ASSERT(BusContext
== HubDeviceHandle
);
2205 // now allocate usb device
2207 Status
= CreateUSBDevice(&NewUsbDevice
);
2210 // check for success
2212 if (!NT_SUCCESS(Status
))
2215 // release controller
2217 Controller
->Release();
2218 DPRINT1("USBHI_CreateUsbDevice: failed to create usb device %x\n", Status
);
2223 // now initialize device
2225 Status
= NewUsbDevice
->Initialize(PHUBCONTROLLER(Controller
), Controller
->GetUsbHardware(),PVOID(Controller
), PortNumber
, PortStatus
);
2228 // check for success
2230 if (!NT_SUCCESS(Status
))
2233 // release usb device
2235 NewUsbDevice
->Release();
2236 DPRINT1("USBHI_CreateUsbDevice: failed to initialize usb device %x\n", Status
);
2243 Status
= Controller
->AddUsbDevice(NewUsbDevice
);
2245 // check for success
2247 if (!NT_SUCCESS(Status
))
2250 // release usb device
2252 NewUsbDevice
->Release();
2254 DPRINT1("USBHI_CreateUsbDevice: failed to add usb device %x\n", Status
);
2261 *NewDevice
= NewUsbDevice
;
2266 return STATUS_SUCCESS
;
2271 USBHI_InitializeUsbDevice(
2273 PUSB_DEVICE_HANDLE DeviceHandle
)
2275 PUSBDEVICE UsbDevice
;
2276 CHubController
* Controller
;
2277 ULONG DeviceAddress
;
2281 DPRINT1("USBHI_InitializeUsbDevice\n");
2284 // first get controller
2286 Controller
= (CHubController
*)BusContext
;
2287 PC_ASSERT(Controller
);
2290 // get device object
2292 UsbDevice
= (PUSBDEVICE
)DeviceHandle
;
2293 PC_ASSERT(UsbDevice
);
2296 // validate device handle
2298 if (!Controller
->ValidateUsbDevice(UsbDevice
))
2300 DPRINT1("USBHI_InitializeUsbDevice invalid device handle %p\n", DeviceHandle
);
2303 // invalid device handle
2305 return STATUS_DEVICE_NOT_CONNECTED
;
2309 // now reserve an address
2311 DeviceAddress
= Controller
->AcquireDeviceAddress();
2314 // is the device address valid
2316 if (DeviceAddress
== MAXULONG
)
2319 // failed to get an device address from the device address pool
2321 DPRINT1("USBHI_InitializeUsbDevice failed to get device address\n");
2322 return STATUS_DEVICE_DATA_ERROR
;
2328 // now set the device address
2330 Status
= UsbDevice
->SetDeviceAddress((UCHAR
)DeviceAddress
);
2332 if (NT_SUCCESS(Status
))
2335 }while(Index
++ < 3 );
2338 // check for failure
2340 if (!NT_SUCCESS(Status
))
2343 // failed to set device address
2345 DPRINT1("USBHI_InitializeUsbDevice failed to set address with %x\n", Status
);
2350 Controller
->ReleaseDeviceAddress(DeviceAddress
);
2355 return STATUS_DEVICE_DATA_ERROR
;
2361 return STATUS_SUCCESS
;
2366 USBHI_GetUsbDescriptors(
2368 PUSB_DEVICE_HANDLE DeviceHandle
,
2369 PUCHAR DeviceDescriptorBuffer
,
2370 PULONG DeviceDescriptorBufferLength
,
2371 PUCHAR ConfigDescriptorBuffer
,
2372 PULONG ConfigDescriptorBufferLength
)
2374 PUSBDEVICE UsbDevice
;
2375 CHubController
* Controller
;
2377 DPRINT1("USBHI_GetUsbDescriptors\n");
2382 PC_ASSERT(DeviceDescriptorBuffer
);
2383 PC_ASSERT(DeviceDescriptorBufferLength
);
2384 PC_ASSERT(*DeviceDescriptorBufferLength
>= sizeof(USB_DEVICE_DESCRIPTOR
));
2385 PC_ASSERT(ConfigDescriptorBufferLength
);
2386 PC_ASSERT(*ConfigDescriptorBufferLength
>= sizeof(USB_CONFIGURATION_DESCRIPTOR
));
2389 // first get controller
2391 Controller
= (CHubController
*)BusContext
;
2392 PC_ASSERT(Controller
);
2396 // get device object
2398 UsbDevice
= (PUSBDEVICE
)DeviceHandle
;
2399 PC_ASSERT(UsbDevice
);
2402 // validate device handle
2404 if (!Controller
->ValidateUsbDevice(UsbDevice
))
2406 DPRINT1("USBHI_GetUsbDescriptors invalid device handle %p\n", DeviceHandle
);
2409 // invalid device handle
2411 return STATUS_DEVICE_NOT_CONNECTED
;
2415 // get device descriptor
2417 UsbDevice
->GetDeviceDescriptor((PUSB_DEVICE_DESCRIPTOR
)DeviceDescriptorBuffer
);
2420 // store result length
2422 *DeviceDescriptorBufferLength
= sizeof(USB_DEVICE_DESCRIPTOR
);
2425 // get configuration descriptor
2427 UsbDevice
->GetConfigurationDescriptors((PUSB_CONFIGURATION_DESCRIPTOR
)ConfigDescriptorBuffer
, *ConfigDescriptorBufferLength
, ConfigDescriptorBufferLength
);
2430 // complete the request
2432 return STATUS_SUCCESS
;
2437 USBHI_RemoveUsbDevice(
2439 PUSB_DEVICE_HANDLE DeviceHandle
,
2442 PUSBDEVICE UsbDevice
;
2443 CHubController
* Controller
;
2446 DPRINT1("USBHI_RemoveUsbDevice\n");
2449 // first get controller
2451 Controller
= (CHubController
*)BusContext
;
2452 PC_ASSERT(Controller
);
2455 // get device object
2457 UsbDevice
= (PUSBDEVICE
)DeviceHandle
;
2458 PC_ASSERT(UsbDevice
);
2461 // validate device handle
2463 if (!Controller
->ValidateUsbDevice(UsbDevice
))
2465 DPRINT1("USBHI_RemoveUsbDevice invalid device handle %p\n", DeviceHandle
);
2468 // invalid device handle
2470 return STATUS_DEVICE_NOT_CONNECTED
;
2474 // check if there were flags passed
2476 if (Flags
& USBD_KEEP_DEVICE_DATA
|| Flags
& USBD_MARK_DEVICE_BUSY
)
2479 // ignore flags for now
2481 return STATUS_SUCCESS
;
2487 Status
= Controller
->RemoveUsbDevice(UsbDevice
);
2488 if (!NT_SUCCESS(Status
))
2491 // invalid device handle
2493 DPRINT1("USBHI_RemoveUsbDevice Invalid device handle %p\n", UsbDevice
);
2495 return STATUS_DEVICE_NOT_CONNECTED
;
2499 // release usb device
2501 UsbDevice
->Release();
2506 return STATUS_SUCCESS
;
2511 USBHI_RestoreUsbDevice(
2513 PUSB_DEVICE_HANDLE OldDeviceHandle
,
2514 PUSB_DEVICE_HANDLE NewDeviceHandle
)
2516 PUSBDEVICE OldUsbDevice
, NewUsbDevice
;
2517 CHubController
* Controller
;
2519 DPRINT1("USBHI_RestoreUsbDevice\n");
2522 // first get controller
2524 Controller
= (CHubController
*)BusContext
;
2525 PC_ASSERT(Controller
);
2528 // get device object
2530 OldUsbDevice
= (PUSBDEVICE
)OldDeviceHandle
;
2531 NewUsbDevice
= (PUSBDEVICE
)NewDeviceHandle
;
2532 PC_ASSERT(OldUsbDevice
);
2533 PC_ASSERT(NewDeviceHandle
);
2536 // validate device handle
2538 PC_ASSERT(Controller
->ValidateUsbDevice(NewUsbDevice
));
2539 PC_ASSERT(Controller
->ValidateUsbDevice(OldUsbDevice
));
2541 DPRINT1("NewUsbDevice: DeviceAddress %x\n", NewUsbDevice
->GetDeviceAddress());
2542 DPRINT1("OldUsbDevice: DeviceAddress %x\n", OldUsbDevice
->GetDeviceAddress());
2545 // remove old device handle
2547 USBHI_RemoveUsbDevice(BusContext
, OldDeviceHandle
, 0);
2549 return STATUS_SUCCESS
;
2554 USBHI_QueryDeviceInformation(
2556 PUSB_DEVICE_HANDLE DeviceHandle
,
2557 PVOID DeviceInformationBuffer
,
2558 ULONG DeviceInformationBufferLength
,
2559 PULONG LengthReturned
)
2561 PUSB_DEVICE_INFORMATION_0 DeviceInfo
;
2562 PUSBDEVICE UsbDevice
;
2563 CHubController
* Controller
;
2565 DPRINT1("USBHI_QueryDeviceInformation %p\n", BusContext
);
2570 PC_ASSERT(DeviceInformationBufferLength
>= sizeof(USB_DEVICE_INFORMATION_0
));
2571 PC_ASSERT(DeviceInformationBuffer
);
2572 PC_ASSERT(LengthReturned
);
2575 // get controller object
2577 Controller
= (CHubController
*)BusContext
;
2578 PC_ASSERT(Controller
);
2581 // get device object
2583 UsbDevice
= (PUSBDEVICE
)DeviceHandle
;
2584 PC_ASSERT(UsbDevice
);
2586 if (BusContext
!= DeviceHandle
)
2589 // validate device handle
2591 if (!Controller
->ValidateUsbDevice(UsbDevice
))
2593 DPRINT1("USBHI_QueryDeviceInformation invalid device handle %p\n", DeviceHandle
);
2596 // invalid device handle
2598 return STATUS_DEVICE_NOT_CONNECTED
;
2602 // access information buffer
2604 DeviceInfo
= (PUSB_DEVICE_INFORMATION_0
)DeviceInformationBuffer
;
2607 // initialize with default values
2609 DeviceInfo
->InformationLevel
= 0;
2610 DeviceInfo
->ActualLength
= sizeof(USB_DEVICE_INFORMATION_0
);
2611 DeviceInfo
->PortNumber
= UsbDevice
->GetPort();
2612 DeviceInfo
->CurrentConfigurationValue
= UsbDevice
->GetConfigurationValue();
2613 DeviceInfo
->DeviceAddress
= UsbDevice
->GetDeviceAddress();
2614 DeviceInfo
->HubAddress
= 0; //FIXME
2615 DeviceInfo
->DeviceSpeed
= UsbDevice
->GetSpeed();
2616 DeviceInfo
->DeviceType
= UsbDevice
->GetType();
2617 DeviceInfo
->NumberOfOpenPipes
= 0; //FIXME
2620 // get device descriptor
2622 UsbDevice
->GetDeviceDescriptor(&DeviceInfo
->DeviceDescriptor
);
2625 // FIXME return pipe information
2629 // store result length
2631 *LengthReturned
= sizeof(USB_DEVICE_INFORMATION_0
);
2633 return STATUS_SUCCESS
;
2637 // access information buffer
2639 DeviceInfo
= (PUSB_DEVICE_INFORMATION_0
)DeviceInformationBuffer
;
2642 // initialize with default values
2644 DeviceInfo
->InformationLevel
= 0;
2645 DeviceInfo
->ActualLength
= sizeof(USB_DEVICE_INFORMATION_0
);
2646 DeviceInfo
->PortNumber
= 0;
2647 DeviceInfo
->CurrentConfigurationValue
= 0; //FIXME;
2648 DeviceInfo
->DeviceAddress
= 0;
2649 DeviceInfo
->HubAddress
= 0; //FIXME
2650 DeviceInfo
->DeviceSpeed
= UsbHighSpeed
; //FIXME
2651 DeviceInfo
->DeviceType
= Usb20Device
; //FIXME
2652 DeviceInfo
->NumberOfOpenPipes
= 0; //FIXME
2655 // get device descriptor
2657 RtlMoveMemory(&DeviceInfo
->DeviceDescriptor
, ROOTHUB2_DEVICE_DESCRIPTOR
, sizeof(USB_DEVICE_DESCRIPTOR
));
2660 // FIXME return pipe information
2664 // store result length
2667 *LengthReturned
= FIELD_OFFSET(USB_DEVICE_INFORMATION_0
, PipeList
[DeviceInfo
->NumberOfOpenPipes
]);
2669 *LengthReturned
= sizeof(USB_DEVICE_INFORMATION_0
) + (DeviceInfo
->NumberOfOpenPipes
> 1 ? (DeviceInfo
->NumberOfOpenPipes
- 1) * sizeof(USB_PIPE_INFORMATION_0
) : 0);
2674 return STATUS_SUCCESS
;
2679 USBHI_GetControllerInformation(
2681 PVOID ControllerInformationBuffer
,
2682 ULONG ControllerInformationBufferLength
,
2683 PULONG LengthReturned
)
2685 PUSB_CONTROLLER_INFORMATION_0 ControllerInfo
;
2687 DPRINT1("USBHI_GetControllerInformation\n");
2692 PC_ASSERT(ControllerInformationBuffer
);
2693 PC_ASSERT(ControllerInformationBufferLength
>= sizeof(USB_CONTROLLER_INFORMATION_0
));
2696 // get controller info buffer
2698 ControllerInfo
= (PUSB_CONTROLLER_INFORMATION_0
)ControllerInformationBuffer
;
2701 // FIXME only version 0 is supported for now
2703 PC_ASSERT(ControllerInfo
->InformationLevel
== 0);
2706 // fill in information
2708 ControllerInfo
->ActualLength
= sizeof(USB_CONTROLLER_INFORMATION_0
);
2709 ControllerInfo
->SelectiveSuspendEnabled
= FALSE
; //FIXME
2710 ControllerInfo
->IsHighSpeedController
= TRUE
;
2713 // set length returned
2715 *LengthReturned
= ControllerInfo
->ActualLength
;
2720 return STATUS_SUCCESS
;
2725 USBHI_ControllerSelectiveSuspend(
2730 return STATUS_NOT_IMPLEMENTED
;
2735 USBHI_GetExtendedHubInformation(
2737 PDEVICE_OBJECT HubPhysicalDeviceObject
,
2738 PVOID HubInformationBuffer
,
2739 ULONG HubInformationBufferLength
,
2740 PULONG LengthReturned
)
2742 PUSB_EXTHUB_INFORMATION_0 HubInfo
;
2743 CHubController
* Controller
;
2744 PUSBHARDWAREDEVICE Hardware
;
2746 ULONG NumPort
, Dummy2
;
2750 DPRINT1("USBHI_GetExtendedHubInformation\n");
2755 PC_ASSERT(HubInformationBuffer
);
2756 PC_ASSERT(HubInformationBufferLength
== sizeof(USB_EXTHUB_INFORMATION_0
));
2757 PC_ASSERT(LengthReturned
);
2760 // get hub controller
2762 Controller
= (CHubController
*)BusContext
;
2763 PC_ASSERT(Controller
);
2766 // get usb hardware device
2768 Hardware
= Controller
->GetUsbHardware();
2771 // retrieve number of ports
2773 Status
= Hardware
->GetDeviceDetails(&Dummy1
, &Dummy1
, &NumPort
, &Dummy2
);
2774 if (!NT_SUCCESS(Status
))
2777 // failed to get hardware details, ouch ;)
2779 DPRINT1("USBHI_GetExtendedHubInformation failed to get hardware details with %x\n", Status
);
2784 // get hub information buffer
2786 HubInfo
= (PUSB_EXTHUB_INFORMATION_0
)HubInformationBuffer
;
2789 // initialize hub information
2791 HubInfo
->InformationLevel
= 0;
2796 HubInfo
->NumberOfPorts
= NumPort
;
2799 // initialize port information
2801 for(Index
= 0; Index
< NumPort
; Index
++)
2803 HubInfo
->Port
[Index
].PhysicalPortNumber
= Index
+ 1;
2804 HubInfo
->Port
[Index
].PortLabelNumber
= Index
+ 1;
2805 HubInfo
->Port
[Index
].VidOverride
= 0;
2806 HubInfo
->Port
[Index
].PidOverride
= 0;
2807 HubInfo
->Port
[Index
].PortAttributes
= USB_PORTATTR_SHARED_USB2
; //FIXME
2811 // store result length
2814 *LengthReturned
= FIELD_OFFSET(USB_EXTHUB_INFORMATION_0
, Port
[HubInfo
->NumberOfPorts
]);
2816 *LengthReturned
= FIELD_OFFSET(USB_EXTHUB_INFORMATION_0
, Port
) + sizeof(USB_EXTPORT_INFORMATION_0
) * HubInfo
->NumberOfPorts
;
2822 return STATUS_SUCCESS
;
2827 USBHI_GetRootHubSymbolicName(
2829 PVOID HubSymNameBuffer
,
2830 ULONG HubSymNameBufferLength
,
2831 PULONG HubSymNameActualLength
)
2834 return STATUS_NOT_IMPLEMENTED
;
2839 USBHI_GetDeviceBusContext(
2840 PVOID HubBusContext
,
2849 USBHI_Initialize20Hub(
2851 PUSB_DEVICE_HANDLE HubDeviceHandle
,
2854 DPRINT("USBHI_Initialize20Hub HubDeviceHandle %p UNIMPLEMENTED TtCount %lu\n", HubDeviceHandle
, TtCount
);
2855 return STATUS_SUCCESS
;
2860 USBHI_RootHubInitNotification(
2862 PVOID CallbackContext
,
2863 PRH_INIT_CALLBACK CallbackRoutine
)
2865 CHubController
* Controller
;
2867 DPRINT("USBHI_RootHubInitNotification %p \n", CallbackContext
);
2870 // get controller object
2872 Controller
= (CHubController
*)BusContext
;
2873 PC_ASSERT(Controller
);
2876 // set notification routine
2878 Controller
->SetNotification(CallbackContext
, CallbackRoutine
);
2881 // FIXME: determine when to perform callback
2883 CallbackRoutine(CallbackContext
);
2888 return STATUS_SUCCESS
;
2893 USBHI_FlushTransfers(
2902 USBHI_SetDeviceHandleData(
2905 PDEVICE_OBJECT UsbDevicePdo
)
2907 PUSBDEVICE UsbDevice
;
2908 CHubController
* Controller
;
2913 Controller
= (CHubController
*)BusContext
;
2914 PC_ASSERT(Controller
);
2917 // get device handle
2919 UsbDevice
= (PUSBDEVICE
)DeviceHandle
;
2922 // validate device handle
2924 if (!Controller
->ValidateUsbDevice(UsbDevice
))
2926 DPRINT1("USBHI_SetDeviceHandleData DeviceHandle %p is invalid\n", DeviceHandle
);
2936 // usbhub sends this request as a part of the Pnp startup sequence
2937 // looks like we need apply a dragon voodoo to fixup the device stack
2938 // otherwise usbhub will cause a bugcheck
2940 DPRINT1("USBHI_SetDeviceHandleData %p\n", UsbDevicePdo
);
2945 PC_ASSERT(UsbDevicePdo
->AttachedDevice
);
2948 // should be usbstor
2949 // fixup device stack voodoo part #2
2951 UsbDevicePdo
->AttachedDevice
->StackSize
++;
2954 // set device handle data
2956 UsbDevice
->SetDeviceHandleData(UsbDevicePdo
);
2960 //=================================================================================================
2962 // USB Device Interface functions
2967 USBDI_GetUSBDIVersion(
2969 PUSBD_VERSION_INFORMATION VersionInformation
,
2970 PULONG HcdCapabilites
)
2972 CHubController
* Controller
;
2973 PUSBHARDWAREDEVICE Device
;
2974 ULONG Speed
, Dummy2
;
2977 DPRINT1("USBDI_GetUSBDIVersion\n");
2982 Controller
= (CHubController
*)BusContext
;
2987 Device
= Controller
->GetUsbHardware();
2990 if (VersionInformation
)
2993 // windows xp supported
2995 VersionInformation
->USBDI_Version
= 0x00000500;
3000 Device
->GetDeviceDetails(&Dummy1
, &Dummy1
, &Dummy2
, &Speed
);
3003 // store speed details
3005 VersionInformation
->Supported_USB_Version
= Speed
;
3009 // no flags supported
3011 *HcdCapabilites
= 0;
3018 PULONG CurrentFrame
)
3021 return STATUS_NOT_IMPLEMENTED
;
3026 USBDI_SubmitIsoOutUrb(
3031 return STATUS_NOT_IMPLEMENTED
;
3036 USBDI_QueryBusInformation(
3039 PVOID BusInformationBuffer
,
3040 PULONG BusInformationBufferLength
,
3041 PULONG BusInformationActualLength
)
3044 return STATUS_NOT_IMPLEMENTED
;
3049 USBDI_IsDeviceHighSpeed(
3052 CHubController
* Controller
;
3053 PUSBHARDWAREDEVICE Device
;
3054 ULONG Speed
, Dummy2
;
3057 DPRINT1("USBDI_IsDeviceHighSpeed\n");
3062 Controller
= (CHubController
*)BusContext
;
3067 Device
= Controller
->GetUsbHardware();
3073 Device
->GetDeviceDetails(&Dummy1
, &Dummy1
, &Dummy2
, &Speed
);
3076 // USB 2.0 equals 0x200
3078 return (Speed
== 0x200);
3091 return STATUS_NOT_IMPLEMENTED
;
3095 CHubController::HandleQueryInterface(
3096 PIO_STACK_LOCATION IoStack
)
3098 PUSB_BUS_INTERFACE_HUB_V5 InterfaceHub
;
3099 PUSB_BUS_INTERFACE_USBDI_V2 InterfaceDI
;
3100 UNICODE_STRING GuidBuffer
;
3103 if (IsEqualGUIDAligned(*IoStack
->Parameters
.QueryInterface
.InterfaceType
, USB_BUS_INTERFACE_HUB_GUID
))
3106 // get request parameters
3108 InterfaceHub
= (PUSB_BUS_INTERFACE_HUB_V5
)IoStack
->Parameters
.QueryInterface
.Interface
;
3109 InterfaceHub
->Version
= IoStack
->Parameters
.QueryInterface
.Version
;
3114 if (IoStack
->Parameters
.QueryInterface
.Version
>= 6)
3116 DPRINT1("USB_BUS_INTERFACE_HUB_GUID version %x not supported!\n", IoStack
->Parameters
.QueryInterface
.Version
);
3119 // version not supported
3121 return STATUS_NOT_SUPPORTED
;
3125 // Interface version 0
3127 if (IoStack
->Parameters
.QueryInterface
.Version
>= 0)
3129 InterfaceHub
->Size
= IoStack
->Parameters
.QueryInterface
.Size
;
3130 InterfaceHub
->BusContext
= PVOID(this);
3131 InterfaceHub
->InterfaceReference
= USBI_InterfaceReference
;
3132 InterfaceHub
->InterfaceDereference
= USBI_InterfaceDereference
;
3136 // Interface version 1
3138 if (IoStack
->Parameters
.QueryInterface
.Version
>= 1)
3140 InterfaceHub
->CreateUsbDevice
= USBHI_CreateUsbDevice
;
3141 InterfaceHub
->InitializeUsbDevice
= USBHI_InitializeUsbDevice
;
3142 InterfaceHub
->GetUsbDescriptors
= USBHI_GetUsbDescriptors
;
3143 InterfaceHub
->RemoveUsbDevice
= USBHI_RemoveUsbDevice
;
3144 InterfaceHub
->RestoreUsbDevice
= USBHI_RestoreUsbDevice
;
3145 InterfaceHub
->QueryDeviceInformation
= USBHI_QueryDeviceInformation
;
3149 // Interface version 2
3151 if (IoStack
->Parameters
.QueryInterface
.Version
>= 2)
3153 InterfaceHub
->GetControllerInformation
= USBHI_GetControllerInformation
;
3154 InterfaceHub
->ControllerSelectiveSuspend
= USBHI_ControllerSelectiveSuspend
;
3155 InterfaceHub
->GetExtendedHubInformation
= USBHI_GetExtendedHubInformation
;
3156 InterfaceHub
->GetRootHubSymbolicName
= USBHI_GetRootHubSymbolicName
;
3157 InterfaceHub
->GetDeviceBusContext
= USBHI_GetDeviceBusContext
;
3158 InterfaceHub
->Initialize20Hub
= USBHI_Initialize20Hub
;
3163 // Interface version 3
3165 if (IoStack
->Parameters
.QueryInterface
.Version
>= 3)
3167 InterfaceHub
->RootHubInitNotification
= USBHI_RootHubInitNotification
;
3171 // Interface version 4
3173 if (IoStack
->Parameters
.QueryInterface
.Version
>= 4)
3175 InterfaceHub
->FlushTransfers
= USBHI_FlushTransfers
;
3179 // Interface version 5
3181 if (IoStack
->Parameters
.QueryInterface
.Version
>= 5)
3183 InterfaceHub
->SetDeviceHandleData
= USBHI_SetDeviceHandleData
;
3187 // request completed
3189 return STATUS_SUCCESS
;
3191 else if (IsEqualGUIDAligned(*IoStack
->Parameters
.QueryInterface
.InterfaceType
, USB_BUS_INTERFACE_USBDI_GUID
))
3194 // get request parameters
3196 InterfaceDI
= (PUSB_BUS_INTERFACE_USBDI_V2
) IoStack
->Parameters
.QueryInterface
.Interface
;
3197 InterfaceDI
->Version
= IoStack
->Parameters
.QueryInterface
.Version
;
3202 if (IoStack
->Parameters
.QueryInterface
.Version
>= 3)
3204 DPRINT1("USB_BUS_INTERFACE_USBDI_GUID version %x not supported!\n", IoStack
->Parameters
.QueryInterface
.Version
);
3207 // version not supported
3209 return STATUS_NOT_SUPPORTED
;
3213 // interface version 0
3215 if (IoStack
->Parameters
.QueryInterface
.Version
>= 0)
3217 InterfaceDI
->Size
= IoStack
->Parameters
.QueryInterface
.Size
;
3218 InterfaceDI
->BusContext
= PVOID(this);
3219 InterfaceDI
->InterfaceReference
= USBI_InterfaceReference
;
3220 InterfaceDI
->InterfaceDereference
= USBI_InterfaceDereference
;
3221 InterfaceDI
->GetUSBDIVersion
= USBDI_GetUSBDIVersion
;
3222 InterfaceDI
->QueryBusTime
= USBDI_QueryBusTime
;
3223 InterfaceDI
->SubmitIsoOutUrb
= USBDI_SubmitIsoOutUrb
;
3224 InterfaceDI
->QueryBusInformation
= USBDI_QueryBusInformation
;
3228 // interface version 1
3230 if (IoStack
->Parameters
.QueryInterface
.Version
>= 1)
3232 InterfaceDI
->IsDeviceHighSpeed
= USBDI_IsDeviceHighSpeed
;
3236 // interface version 2
3238 if (IoStack
->Parameters
.QueryInterface
.Version
>= 2)
3240 InterfaceDI
->EnumLogEntry
= USBDI_EnumLogEntry
;
3244 // request completed
3246 return STATUS_SUCCESS
;
3251 // convert guid to string
3253 Status
= RtlStringFromGUID(*IoStack
->Parameters
.QueryInterface
.InterfaceType
, &GuidBuffer
);
3254 if (NT_SUCCESS(Status
))
3259 DPRINT1("HandleQueryInterface UNKNOWN INTERFACE GUID: %wZ Version %x\n", &GuidBuffer
, IoStack
->Parameters
.QueryInterface
.Version
);
3264 RtlFreeUnicodeString(&GuidBuffer
);
3267 return STATUS_NOT_SUPPORTED
;
3271 CHubController::SetDeviceInterface(
3274 NTSTATUS Status
= STATUS_SUCCESS
;
3279 // register device interface
3281 Status
= IoRegisterDeviceInterface(m_HubControllerDeviceObject
, &GUID_DEVINTERFACE_USB_HUB
, 0, &m_HubDeviceInterfaceString
);
3283 if (NT_SUCCESS(Status
))
3286 // now enable the device interface
3288 Status
= IoSetDeviceInterfaceState(&m_HubDeviceInterfaceString
, TRUE
);
3293 m_InterfaceEnabled
= TRUE
;
3296 else if (m_InterfaceEnabled
)
3299 // disable device interface
3301 Status
= IoSetDeviceInterfaceState(&m_HubDeviceInterfaceString
, FALSE
);
3303 if (NT_SUCCESS(Status
))
3306 // now delete interface string
3308 RtlFreeUnicodeString(&m_HubDeviceInterfaceString
);
3312 // disable interface
3314 m_InterfaceEnabled
= FALSE
;
3320 return STATUS_SUCCESS
;
3324 CHubController::CreatePDO(
3325 PDRIVER_OBJECT DriverObject
,
3326 PDEVICE_OBJECT
* OutDeviceObject
)
3328 WCHAR CharDeviceName
[64];
3330 ULONG UsbDeviceNumber
= 0;
3331 UNICODE_STRING DeviceName
;
3336 // construct device name
3338 swprintf(CharDeviceName
, L
"\\Device\\USBPDO-%d", UsbDeviceNumber
);
3341 // initialize device name
3343 RtlInitUnicodeString(&DeviceName
, CharDeviceName
);
3348 Status
= IoCreateDevice(DriverObject
,
3349 sizeof(COMMON_DEVICE_EXTENSION
),
3351 FILE_DEVICE_CONTROLLER
,
3356 /* check for success */
3357 if (NT_SUCCESS(Status
))
3361 // is there a device object with that same name
3363 if ((Status
== STATUS_OBJECT_NAME_EXISTS
) || (Status
== STATUS_OBJECT_NAME_COLLISION
))
3366 // Try the next name
3373 // bail out on other errors
3375 if (!NT_SUCCESS(Status
))
3377 DPRINT1("CreatePDO: Failed to create %wZ, Status %x\n", &DeviceName
, Status
);
3382 DPRINT1("CHubController::CreatePDO: DeviceName %wZ\n", &DeviceName
);
3385 // fixup device stack voodoo part #1
3387 (*OutDeviceObject
)->StackSize
++;
3396 CreateHubController(
3397 PHUBCONTROLLER
*OutHcdController
)
3399 PHUBCONTROLLER This
;
3402 // allocate controller
3404 This
= new(NonPagedPool
, TAG_USBEHCI
) CHubController(0);
3408 // failed to allocate
3410 return STATUS_INSUFFICIENT_RESOURCES
;
3414 // add reference count
3421 *OutHcdController
= (PHUBCONTROLLER
)This
;
3426 return STATUS_SUCCESS
;
3429 VOID
StatusChangeEndpointCallBack(PVOID Context
)
3431 CHubController
* This
;
3433 This
= (CHubController
*)Context
;
3437 Irp
= This
->m_PendingSCEIrp
;
3440 DPRINT1("There was no pending IRP for SCE. Did the usb hub 2.0 driver (usbhub2) load?\n");
3444 This
->m_PendingSCEIrp
= NULL
;
3445 This
->QueryStatusChageEndpoint(Irp
);
3447 Irp
->IoStatus
.Status
= STATUS_SUCCESS
;
3448 Irp
->IoStatus
.Information
= 0;
3450 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);