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/usbohci/hub_controller.cpp
5 * PURPOSE: USB OHCI 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_USBOHCI
);
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
= 0x110; //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_USBOHCI
);
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_USBOHCI
);
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
= 0; 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_USBOHCI
);
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
)
960 Status
= m_Hardware
->SetPortFeature(PortId
, PORT_ENABLE
);
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(
1127 PC_ASSERT(Urb
->UrbControlGetStatusRequest
.Index
== 0);
1128 PC_ASSERT(Urb
->UrbControlGetStatusRequest
.TransferBufferLength
>= sizeof(USHORT
));
1129 PC_ASSERT(Urb
->UrbControlGetStatusRequest
.TransferBuffer
);
1130 PC_ASSERT(Urb
->UrbHeader
.UsbdDeviceHandle
== NULL
);
1133 // get status buffer
1135 Status
= (PUSHORT
)Urb
->UrbControlGetStatusRequest
.TransferBuffer
;
1138 // FIXME need more flags ?
1140 *Status
= USB_PORT_STATUS_CONNECT
;
1145 return STATUS_SUCCESS
;
1148 //-----------------------------------------------------------------------------------------
1150 CHubController::HandleClassDevice(
1154 NTSTATUS Status
= STATUS_NOT_IMPLEMENTED
;
1155 PUSB_HUB_DESCRIPTOR UsbHubDescriptor
;
1156 ULONG PortCount
, Dummy2
;
1159 DPRINT("CHubController::HandleClassDevice Request %x Class %x\n", Urb
->UrbControlVendorClassRequest
.Request
, Urb
->UrbControlVendorClassRequest
.Value
>> 8);
1162 // check class request type
1164 switch(Urb
->UrbControlVendorClassRequest
.Request
)
1166 case USB_REQUEST_GET_DESCRIPTOR
:
1168 switch (Urb
->UrbControlVendorClassRequest
.Value
>> 8)
1170 case USB_DEVICE_CLASS_RESERVED
: // FALL THROUGH
1171 case USB_DEVICE_CLASS_HUB
:
1176 PC_ASSERT(Urb
->UrbControlVendorClassRequest
.TransferBuffer
);
1177 PC_ASSERT(Urb
->UrbControlVendorClassRequest
.TransferBufferLength
>= sizeof(USB_HUB_DESCRIPTOR
));
1180 // get hub descriptor
1182 UsbHubDescriptor
= (PUSB_HUB_DESCRIPTOR
)Urb
->UrbControlVendorClassRequest
.TransferBuffer
;
1185 // one hub is handled
1187 UsbHubDescriptor
->bDescriptorLength
= sizeof(USB_HUB_DESCRIPTOR
);
1188 Urb
->UrbControlVendorClassRequest
.TransferBufferLength
= sizeof(USB_HUB_DESCRIPTOR
);
1191 // type should 0x29 according to msdn
1193 UsbHubDescriptor
->bDescriptorType
= 0x29;
1198 Status
= m_Hardware
->GetDeviceDetails(&Dummy1
, &Dummy1
, &PortCount
, &Dummy2
);
1199 PC_ASSERT(Status
== STATUS_SUCCESS
);
1202 // FIXME: retrieve values
1204 UsbHubDescriptor
->bNumberOfPorts
= (UCHAR
)PortCount
;
1205 UsbHubDescriptor
->wHubCharacteristics
= 0x00;
1206 UsbHubDescriptor
->bPowerOnToPowerGood
= 0x01;
1207 UsbHubDescriptor
->bHubControlCurrent
= 0x00;
1212 Status
= STATUS_SUCCESS
;
1216 DPRINT1("CHubController::HandleClassDevice Class %x not implemented\n", Urb
->UrbControlVendorClassRequest
.Value
>> 8);
1222 DPRINT1("CHubController::HandleClassDevice Type %x not implemented\n", Urb
->UrbControlVendorClassRequest
.Request
);
1228 //-----------------------------------------------------------------------------------------
1230 CHubController::HandleGetDescriptorFromInterface(
1234 PUSBDEVICE UsbDevice
;
1235 USB_DEFAULT_PIPE_SETUP_PACKET CtrlSetup
;
1241 ASSERT(Urb
->UrbControlDescriptorRequest
.TransferBufferLength
);
1242 ASSERT(Urb
->UrbControlDescriptorRequest
.TransferBuffer
);
1245 // check if this is a valid usb device handle
1247 ASSERT(ValidateUsbDevice(PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
)));
1252 UsbDevice
= PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
);
1255 // generate setup packet
1257 CtrlSetup
.bRequest
= USB_REQUEST_GET_DESCRIPTOR
;
1258 CtrlSetup
.wValue
.LowByte
= Urb
->UrbControlDescriptorRequest
.Index
;
1259 CtrlSetup
.wValue
.HiByte
= Urb
->UrbControlDescriptorRequest
.DescriptorType
;
1260 CtrlSetup
.wIndex
.W
= Urb
->UrbControlDescriptorRequest
.LanguageId
;
1261 CtrlSetup
.wLength
= (USHORT
)Urb
->UrbControlDescriptorRequest
.TransferBufferLength
;
1262 CtrlSetup
.bmRequestType
.B
= 0x81;
1265 // submit setup packet
1267 Status
= UsbDevice
->SubmitSetupPacket(&CtrlSetup
, Urb
->UrbControlDescriptorRequest
.TransferBufferLength
, Urb
->UrbControlDescriptorRequest
.TransferBuffer
);
1268 ASSERT(Status
== STATUS_SUCCESS
);
1276 //-----------------------------------------------------------------------------------------
1278 CHubController::HandleGetDescriptor(
1282 NTSTATUS Status
= STATUS_NOT_IMPLEMENTED
;
1283 PUSB_CONFIGURATION_DESCRIPTOR ConfigurationDescriptor
;
1284 USB_DEFAULT_PIPE_SETUP_PACKET CtrlSetup
;
1286 PUSBDEVICE UsbDevice
;
1289 DPRINT("CHubController::HandleGetDescriptor\n");
1292 // check descriptor type
1294 switch(Urb
->UrbControlDescriptorRequest
.DescriptorType
)
1296 case USB_DEVICE_DESCRIPTOR_TYPE
:
1301 PC_ASSERT(Urb
->UrbControlDescriptorRequest
.TransferBufferLength
>= sizeof(USB_DEVICE_DESCRIPTOR
));
1302 PC_ASSERT(Urb
->UrbControlDescriptorRequest
.TransferBuffer
);
1304 if (Urb
->UrbHeader
.UsbdDeviceHandle
== NULL
)
1307 // copy root hub device descriptor
1309 RtlCopyMemory((PUCHAR
)Urb
->UrbControlDescriptorRequest
.TransferBuffer
, &m_DeviceDescriptor
, sizeof(USB_DEVICE_DESCRIPTOR
));
1310 Status
= STATUS_SUCCESS
;
1315 // check if this is a valid usb device handle
1317 PC_ASSERT(ValidateUsbDevice(PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
)));
1322 UsbDevice
= PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
);
1325 // retrieve device descriptor from device
1327 UsbDevice
->GetDeviceDescriptor((PUSB_DEVICE_DESCRIPTOR
)Urb
->UrbControlDescriptorRequest
.TransferBuffer
);
1328 Status
= STATUS_SUCCESS
;
1332 case USB_CONFIGURATION_DESCRIPTOR_TYPE
:
1337 PC_ASSERT(Urb
->UrbControlDescriptorRequest
.TransferBuffer
);
1338 PC_ASSERT(Urb
->UrbControlDescriptorRequest
.TransferBufferLength
>= sizeof(USB_CONFIGURATION_DESCRIPTOR
));
1340 if (Urb
->UrbHeader
.UsbdDeviceHandle
== NULL
)
1343 // request is for the root bus controller
1345 RtlCopyMemory(Urb
->UrbControlDescriptorRequest
.TransferBuffer
, &ROOTHUB2_CONFIGURATION_DESCRIPTOR
, sizeof(USB_CONFIGURATION_DESCRIPTOR
));
1348 // get configuration descriptor, very retarded!
1350 ConfigurationDescriptor
= (PUSB_CONFIGURATION_DESCRIPTOR
)Urb
->UrbControlDescriptorRequest
.TransferBuffer
;
1353 // check if buffer can hold interface and endpoint descriptor
1355 if (ConfigurationDescriptor
->wTotalLength
> Urb
->UrbControlDescriptorRequest
.TransferBufferLength
)
1360 Status
= STATUS_SUCCESS
;
1366 // copy interface descriptor template
1368 Buffer
= (PUCHAR
)(ConfigurationDescriptor
+ 1);
1369 RtlCopyMemory(Buffer
, &ROOTHUB2_INTERFACE_DESCRIPTOR
, sizeof(USB_INTERFACE_DESCRIPTOR
));
1372 // copy end point descriptor template
1374 Buffer
+= sizeof(USB_INTERFACE_DESCRIPTOR
);
1375 RtlCopyMemory(Buffer
, &ROOTHUB2_ENDPOINT_DESCRIPTOR
, sizeof(USB_ENDPOINT_DESCRIPTOR
));
1380 Status
= STATUS_SUCCESS
;
1386 // check if this is a valid usb device handle
1388 PC_ASSERT(ValidateUsbDevice(PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
)));
1393 UsbDevice
= PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
);
1395 if (sizeof(USB_CONFIGURATION_DESCRIPTOR
) > Urb
->UrbControlDescriptorRequest
.TransferBufferLength
)
1400 Urb
->UrbControlDescriptorRequest
.TransferBufferLength
= UsbDevice
->GetConfigurationDescriptorsLength();
1405 Status
= STATUS_SUCCESS
;
1410 // perform work in IUSBDevice
1412 UsbDevice
->GetConfigurationDescriptors((PUSB_CONFIGURATION_DESCRIPTOR
)Urb
->UrbControlDescriptorRequest
.TransferBuffer
, Urb
->UrbControlDescriptorRequest
.TransferBufferLength
, &Length
);
1415 // store result size
1417 Urb
->UrbControlDescriptorRequest
.TransferBufferLength
= Length
;
1418 Status
= STATUS_SUCCESS
;
1422 case USB_STRING_DESCRIPTOR_TYPE
:
1427 PC_ASSERT(Urb
->UrbControlDescriptorRequest
.TransferBuffer
);
1428 PC_ASSERT(Urb
->UrbControlDescriptorRequest
.TransferBufferLength
);
1432 // check if this is a valid usb device handle
1434 PC_ASSERT(ValidateUsbDevice(PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
)));
1439 UsbDevice
= PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
);
1442 // generate setup packet
1444 CtrlSetup
.bRequest
= USB_REQUEST_GET_DESCRIPTOR
;
1445 CtrlSetup
.wValue
.LowByte
= Urb
->UrbControlDescriptorRequest
.Index
;
1446 CtrlSetup
.wValue
.HiByte
= Urb
->UrbControlDescriptorRequest
.DescriptorType
;
1447 CtrlSetup
.wIndex
.W
= Urb
->UrbControlDescriptorRequest
.LanguageId
;
1448 CtrlSetup
.wLength
= (USHORT
)Urb
->UrbControlDescriptorRequest
.TransferBufferLength
;
1449 CtrlSetup
.bmRequestType
.B
= 0x80;
1452 // submit setup packet
1454 Status
= UsbDevice
->SubmitSetupPacket(&CtrlSetup
, Urb
->UrbControlDescriptorRequest
.TransferBufferLength
, Urb
->UrbControlDescriptorRequest
.TransferBuffer
);
1458 DPRINT1("CHubController::HandleGetDescriptor DescriptorType %x unimplemented\n", Urb
->UrbControlDescriptorRequest
.DescriptorType
);
1468 //-----------------------------------------------------------------------------------------
1470 CHubController::HandleClassEndpoint(
1474 USB_DEFAULT_PIPE_SETUP_PACKET CtrlSetup
;
1476 PUSBDEVICE UsbDevice
;
1481 PC_ASSERT(Urb
->UrbControlVendorClassRequest
.TransferBuffer
);
1482 PC_ASSERT(Urb
->UrbControlVendorClassRequest
.TransferBufferLength
);
1483 PC_ASSERT(Urb
->UrbHeader
.UsbdDeviceHandle
);
1486 // check if this is a valid usb device handle
1488 PC_ASSERT(ValidateUsbDevice(PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
)));
1493 UsbDevice
= PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
);
1496 DPRINT1("URB_FUNCTION_CLASS_ENDPOINT\n");
1497 DPRINT1("TransferFlags %x\n", Urb
->UrbControlVendorClassRequest
.TransferFlags
);
1498 DPRINT1("TransferBufferLength %x\n", Urb
->UrbControlVendorClassRequest
.TransferBufferLength
);
1499 DPRINT1("TransferBuffer %x\n", Urb
->UrbControlVendorClassRequest
.TransferBuffer
);
1500 DPRINT1("TransferBufferMDL %x\n", Urb
->UrbControlVendorClassRequest
.TransferBufferMDL
);
1501 DPRINT1("RequestTypeReservedBits %x\n", Urb
->UrbControlVendorClassRequest
.RequestTypeReservedBits
);
1502 DPRINT1("Request %x\n", Urb
->UrbControlVendorClassRequest
.Request
);
1503 DPRINT1("Value %x\n", Urb
->UrbControlVendorClassRequest
.Value
);
1504 DPRINT1("Index %x\n", Urb
->UrbControlVendorClassRequest
.Index
);
1507 // initialize setup packet
1509 CtrlSetup
.bmRequestType
.B
= 0xa2; //FIXME: Const.
1510 CtrlSetup
.bRequest
= Urb
->UrbControlVendorClassRequest
.Request
;
1511 CtrlSetup
.wValue
.W
= Urb
->UrbControlVendorClassRequest
.Value
;
1512 CtrlSetup
.wIndex
.W
= Urb
->UrbControlVendorClassRequest
.Index
;
1513 CtrlSetup
.wLength
= Urb
->UrbControlVendorClassRequest
.TransferBufferLength
;
1518 Status
= UsbDevice
->SubmitSetupPacket(&CtrlSetup
, Urb
->UrbControlVendorClassRequest
.TransferBufferLength
, Urb
->UrbControlVendorClassRequest
.TransferBuffer
);
1521 // assert on failure
1523 PC_ASSERT(NT_SUCCESS(Status
));
1532 //-----------------------------------------------------------------------------------------
1534 CHubController::HandleClassInterface(
1538 USB_DEFAULT_PIPE_SETUP_PACKET CtrlSetup
;
1540 PUSBDEVICE UsbDevice
;
1545 //ASSERT(Urb->UrbControlVendorClassRequest.TransferBuffer || Urb->UrbControlVendorClassRequest.TransferBufferMDL);
1546 //ASSERT(Urb->UrbControlVendorClassRequest.TransferBufferLength);
1547 PC_ASSERT(Urb
->UrbHeader
.UsbdDeviceHandle
);
1550 // check if this is a valid usb device handle
1552 PC_ASSERT(ValidateUsbDevice(PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
)));
1557 UsbDevice
= PUSBDEVICE(Urb
->UrbHeader
.UsbdDeviceHandle
);
1560 DPRINT1("URB_FUNCTION_CLASS_INTERFACE\n");
1561 DPRINT1("TransferFlags %x\n", Urb
->UrbControlVendorClassRequest
.TransferFlags
);
1562 DPRINT1("TransferBufferLength %x\n", Urb
->UrbControlVendorClassRequest
.TransferBufferLength
);
1563 DPRINT1("TransferBuffer %x\n", Urb
->UrbControlVendorClassRequest
.TransferBuffer
);
1564 DPRINT1("TransferBufferMDL %x\n", Urb
->UrbControlVendorClassRequest
.TransferBufferMDL
);
1565 DPRINT1("RequestTypeReservedBits %x\n", Urb
->UrbControlVendorClassRequest
.RequestTypeReservedBits
);
1566 DPRINT1("Request %x\n", Urb
->UrbControlVendorClassRequest
.Request
);
1567 DPRINT1("Value %x\n", Urb
->UrbControlVendorClassRequest
.Value
);
1568 DPRINT1("Index %x\n", Urb
->UrbControlVendorClassRequest
.Index
);
1571 // initialize setup packet
1573 CtrlSetup
.bmRequestType
.B
= 0xa1;
1574 CtrlSetup
.bRequest
= Urb
->UrbControlVendorClassRequest
.Request
;
1575 CtrlSetup
.wValue
.W
= Urb
->UrbControlVendorClassRequest
.Value
;
1576 CtrlSetup
.wIndex
.W
= Urb
->UrbControlVendorClassRequest
.Index
;
1577 CtrlSetup
.wLength
= Urb
->UrbControlVendorClassRequest
.TransferBufferLength
;
1582 Status
= UsbDevice
->SubmitSetupPacket(&CtrlSetup
, Urb
->UrbControlVendorClassRequest
.TransferBufferLength
, Urb
->UrbControlVendorClassRequest
.TransferBuffer
);
1585 // assert on failure
1587 PC_ASSERT(NT_SUCCESS(Status
));
1596 //-----------------------------------------------------------------------------------------
1598 CHubController::HandleDeviceControl(
1599 IN PDEVICE_OBJECT DeviceObject
,
1602 PIO_STACK_LOCATION IoStack
;
1603 PCOMMON_DEVICE_EXTENSION DeviceExtension
;
1605 NTSTATUS Status
= STATUS_NOT_IMPLEMENTED
;
1608 // get current stack location
1610 IoStack
= IoGetCurrentIrpStackLocation(Irp
);
1613 // get device extension
1615 DeviceExtension
= (PCOMMON_DEVICE_EXTENSION
)DeviceObject
->DeviceExtension
;
1618 // determine which request should be performed
1620 switch(IoStack
->Parameters
.DeviceIoControl
.IoControlCode
)
1622 case IOCTL_INTERNAL_USB_SUBMIT_URB
:
1627 Urb
= (PURB
)IoStack
->Parameters
.Others
.Argument1
;
1630 switch (Urb
->UrbHeader
.Function
)
1632 case URB_FUNCTION_GET_DESCRIPTOR_FROM_INTERFACE
:
1633 Status
= HandleGetDescriptorFromInterface(Irp
, Urb
);
1635 case URB_FUNCTION_GET_DESCRIPTOR_FROM_DEVICE
:
1636 Status
= HandleGetDescriptor(Irp
, Urb
);
1638 case URB_FUNCTION_CLASS_DEVICE
:
1639 Status
= HandleClassDevice(Irp
, Urb
);
1641 case URB_FUNCTION_GET_STATUS_FROM_DEVICE
:
1642 Status
= HandleGetStatusFromDevice(Irp
, Urb
);
1644 case URB_FUNCTION_SELECT_CONFIGURATION
:
1645 Status
= HandleSelectConfiguration(Irp
, Urb
);
1647 case URB_FUNCTION_SELECT_INTERFACE
:
1648 Status
= HandleSelectInterface(Irp
, Urb
);
1650 case URB_FUNCTION_CLASS_OTHER
:
1651 Status
= HandleClassOther(Irp
, Urb
);
1653 case URB_FUNCTION_BULK_OR_INTERRUPT_TRANSFER
:
1654 Status
= HandleBulkOrInterruptTransfer(Irp
, Urb
);
1656 case URB_FUNCTION_ISOCH_TRANSFER
:
1657 Status
= HandleIsochronousTransfer(Irp
, Urb
);
1659 case URB_FUNCTION_CLASS_INTERFACE
:
1660 Status
= HandleClassInterface(Irp
, Urb
);
1662 case URB_FUNCTION_CLASS_ENDPOINT
:
1663 Status
= HandleClassEndpoint(Irp
, Urb
);
1666 DPRINT1("IOCTL_INTERNAL_USB_SUBMIT_URB Function %x NOT IMPLEMENTED\n", Urb
->UrbHeader
.Function
);
1670 // request completed
1674 case IOCTL_INTERNAL_USB_GET_DEVICE_HANDLE
:
1676 DPRINT("IOCTL_INTERNAL_USB_GET_DEVICE_HANDLE %p\n", this);
1678 if (IoStack
->Parameters
.Others
.Argument1
)
1681 // store object as device handle
1683 *(PVOID
*)IoStack
->Parameters
.Others
.Argument1
= (PVOID
)this;
1684 Status
= STATUS_SUCCESS
;
1689 // mis-behaving hub driver
1691 Status
= STATUS_INVALID_DEVICE_REQUEST
;
1695 // request completed
1699 case IOCTL_INTERNAL_USB_GET_ROOTHUB_PDO
:
1701 DPRINT("IOCTL_INTERNAL_USB_GET_ROOTHUB_PDO\n");
1704 // this is the first request send, it delivers the PDO to the caller
1706 if (IoStack
->Parameters
.Others
.Argument1
)
1709 // store root hub pdo object
1711 *(PVOID
*)IoStack
->Parameters
.Others
.Argument1
= DeviceObject
;
1714 if (IoStack
->Parameters
.Others
.Argument2
)
1717 // documentation claims to deliver the hcd controller object, although it is wrong
1719 *(PVOID
*)IoStack
->Parameters
.Others
.Argument2
= DeviceObject
;
1723 // request completed
1725 Status
= STATUS_SUCCESS
;
1728 case IOCTL_INTERNAL_USB_GET_HUB_COUNT
:
1730 DPRINT("IOCTL_INTERNAL_USB_GET_HUB_COUNT\n");
1733 // after IOCTL_INTERNAL_USB_GET_ROOTHUB_PDO is delivered, the usbhub driver
1734 // requests this ioctl to deliver the number of presents.
1736 if (IoStack
->Parameters
.Others
.Argument1
)
1739 // FIXME / verify: there is only one hub
1741 *(PULONG
)IoStack
->Parameters
.Others
.Argument1
= 1;
1745 // request completed
1747 Status
= STATUS_SUCCESS
;
1748 Irp
->IoStatus
.Information
= sizeof(ULONG
);
1751 case IOCTL_INTERNAL_USB_SUBMIT_IDLE_NOTIFICATION
:
1753 DPRINT1("IOCTL_INTERNAL_USB_SUBMIT_IDLE_NOTIFICATION UNIMPLEMENTED\n");
1754 Status
= STATUS_SUCCESS
;
1759 DPRINT1("HandleDeviceControl>Type: IoCtl %x InputBufferLength %lu OutputBufferLength %lu NOT IMPLEMENTED\n",
1760 IoStack
->Parameters
.DeviceIoControl
.IoControlCode
,
1761 IoStack
->Parameters
.DeviceIoControl
.InputBufferLength
,
1762 IoStack
->Parameters
.DeviceIoControl
.OutputBufferLength
);
1766 if (Status
!= STATUS_PENDING
)
1768 Irp
->IoStatus
.Status
= Status
;
1769 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
1775 //-----------------------------------------------------------------------------------------
1777 CHubController::GetUsbHardware()
1782 //-----------------------------------------------------------------------------------------
1784 CHubController::AcquireDeviceAddress()
1787 ULONG DeviceAddress
;
1790 // acquire device lock
1792 KeAcquireSpinLock(&m_Lock
, &OldLevel
);
1797 DeviceAddress
= RtlFindClearBits(&m_DeviceAddressBitmap
, 1, 0);
1798 if (DeviceAddress
!= MAXULONG
)
1803 RtlSetBits(&m_DeviceAddressBitmap
, DeviceAddress
, 1);
1806 // device addresses start from 0x1 - 0xFF
1812 // release spin lock
1814 KeReleaseSpinLock(&m_Lock
, OldLevel
);
1817 // return device address
1819 return DeviceAddress
;
1821 //-----------------------------------------------------------------------------------------
1823 CHubController::ReleaseDeviceAddress(
1824 ULONG DeviceAddress
)
1829 // acquire device lock
1831 KeAcquireSpinLock(&m_Lock
, &OldLevel
);
1836 PC_ASSERT(DeviceAddress
!= 0);
1839 // convert back to bit number
1846 RtlClearBits(&m_DeviceAddressBitmap
, DeviceAddress
, 1);
1851 KeReleaseSpinLock(&m_Lock
, OldLevel
);
1853 //-----------------------------------------------------------------------------------------
1855 CHubController::RemoveUsbDevice(
1856 PUSBDEVICE UsbDevice
)
1858 PUSBDEVICE_ENTRY DeviceEntry
;
1860 NTSTATUS Status
= STATUS_UNSUCCESSFUL
;
1866 KeAcquireSpinLock(&m_Lock
, &OldLevel
);
1869 // point to first entry
1871 Entry
= m_UsbDeviceList
.Flink
;
1874 // find matching entry
1876 while(Entry
!= &m_UsbDeviceList
)
1881 DeviceEntry
= (PUSBDEVICE_ENTRY
)CONTAINING_RECORD(Entry
, USBDEVICE_ENTRY
, Entry
);
1884 // is it current entry
1886 if (DeviceEntry
->Device
== UsbDevice
)
1891 RemoveEntryList(Entry
);
1896 ExFreePoolWithTag(DeviceEntry
, TAG_USBOHCI
);
1901 Status
= STATUS_SUCCESS
;
1908 Entry
= Entry
->Flink
;
1914 KeReleaseSpinLock(&m_Lock
, OldLevel
);
1921 //-----------------------------------------------------------------------------------------
1923 CHubController::ValidateUsbDevice(PUSBDEVICE UsbDevice
)
1925 PUSBDEVICE_ENTRY DeviceEntry
;
1928 BOOLEAN Result
= FALSE
;
1933 KeAcquireSpinLock(&m_Lock
, &OldLevel
);
1936 // point to first entry
1938 Entry
= m_UsbDeviceList
.Flink
;
1941 // find matching entry
1943 while(Entry
!= &m_UsbDeviceList
)
1948 DeviceEntry
= (PUSBDEVICE_ENTRY
)CONTAINING_RECORD(Entry
, USBDEVICE_ENTRY
, Entry
);
1951 // is it current entry
1953 if (DeviceEntry
->Device
== UsbDevice
)
1965 Entry
= Entry
->Flink
;
1971 KeReleaseSpinLock(&m_Lock
, OldLevel
);
1980 //-----------------------------------------------------------------------------------------
1982 CHubController::AddUsbDevice(
1983 PUSBDEVICE UsbDevice
)
1985 PUSBDEVICE_ENTRY DeviceEntry
;
1989 // allocate device entry
1991 DeviceEntry
= (PUSBDEVICE_ENTRY
)ExAllocatePoolWithTag(NonPagedPool
, sizeof(USBDEVICE_ENTRY
), TAG_USBOHCI
);
1997 return STATUS_INSUFFICIENT_RESOURCES
;
2003 DeviceEntry
->Device
= UsbDevice
;
2008 KeAcquireSpinLock(&m_Lock
, &OldLevel
);
2013 InsertTailList(&m_UsbDeviceList
, &DeviceEntry
->Entry
);
2016 // release spin lock
2018 KeReleaseSpinLock(&m_Lock
, OldLevel
);
2023 return STATUS_SUCCESS
;
2026 //-----------------------------------------------------------------------------------------
2028 CHubController::SetNotification(
2029 PVOID CallbackContext
,
2030 PRH_INIT_CALLBACK CallbackRoutine
)
2035 // acquire hub controller lock
2037 KeAcquireSpinLock(&m_Lock
, &OldLevel
);
2040 // now set the callback routine and context of the hub
2042 m_HubCallbackContext
= CallbackContext
;
2043 m_HubCallbackRoutine
= CallbackRoutine
;
2046 // release hub controller lock
2048 KeReleaseSpinLock(&m_Lock
, OldLevel
);
2051 //=================================================================================================
2053 // Generic Interface functions
2057 USBI_InterfaceReference(
2060 CHubController
* Controller
= (CHubController
*)BusContext
;
2062 DPRINT1("USBH_InterfaceReference\n");
2067 Controller
->AddRef();
2072 USBI_InterfaceDereference(
2075 CHubController
* Controller
= (CHubController
*)BusContext
;
2077 DPRINT1("USBH_InterfaceDereference\n");
2082 Controller
->Release();
2084 //=================================================================================================
2086 // USB Hub Interface functions
2090 USBHI_CreateUsbDevice(
2092 PUSB_DEVICE_HANDLE
*NewDevice
,
2093 PUSB_DEVICE_HANDLE HubDeviceHandle
,
2097 PUSBDEVICE NewUsbDevice
;
2098 CHubController
* Controller
;
2101 DPRINT1("USBHI_CreateUsbDevice\n");
2104 // first get hub controller
2106 Controller
= (CHubController
*)BusContext
;
2111 PC_ASSERT(Controller
);
2112 PC_ASSERT(BusContext
== HubDeviceHandle
);
2115 // now allocate usb device
2117 Status
= CreateUSBDevice(&NewUsbDevice
);
2120 // check for success
2122 if (!NT_SUCCESS(Status
))
2125 // release controller
2127 Controller
->Release();
2128 DPRINT1("USBHI_CreateUsbDevice: failed to create usb device %x\n", Status
);
2133 // now initialize device
2135 Status
= NewUsbDevice
->Initialize(PHUBCONTROLLER(Controller
), Controller
->GetUsbHardware(),PVOID(Controller
), PortNumber
, PortStatus
);
2138 // check for success
2140 if (!NT_SUCCESS(Status
))
2143 // release usb device
2145 NewUsbDevice
->Release();
2146 DPRINT1("USBHI_CreateUsbDevice: failed to initialize usb device %x\n", Status
);
2153 Status
= Controller
->AddUsbDevice(NewUsbDevice
);
2155 // check for success
2157 if (!NT_SUCCESS(Status
))
2160 // release usb device
2162 NewUsbDevice
->Release();
2164 DPRINT1("USBHI_CreateUsbDevice: failed to add usb device %x\n", Status
);
2171 *NewDevice
= NewUsbDevice
;
2176 return STATUS_SUCCESS
;
2181 USBHI_InitializeUsbDevice(
2183 PUSB_DEVICE_HANDLE DeviceHandle
)
2185 PUSBDEVICE UsbDevice
;
2186 CHubController
* Controller
;
2187 ULONG DeviceAddress
;
2191 DPRINT1("USBHI_InitializeUsbDevice\n");
2194 // first get controller
2196 Controller
= (CHubController
*)BusContext
;
2197 PC_ASSERT(Controller
);
2200 // get device object
2202 UsbDevice
= (PUSBDEVICE
)DeviceHandle
;
2203 PC_ASSERT(UsbDevice
);
2206 // validate device handle
2208 if (!Controller
->ValidateUsbDevice(UsbDevice
))
2210 DPRINT1("USBHI_InitializeUsbDevice invalid device handle %p\n", DeviceHandle
);
2213 // invalid device handle
2215 return STATUS_DEVICE_NOT_CONNECTED
;
2219 // now reserve an address
2221 DeviceAddress
= Controller
->AcquireDeviceAddress();
2224 // is the device address valid
2226 if (DeviceAddress
== MAXULONG
)
2229 // failed to get an device address from the device address pool
2231 DPRINT1("USBHI_InitializeUsbDevice failed to get device address\n");
2232 return STATUS_DEVICE_DATA_ERROR
;
2238 // now set the device address
2240 Status
= UsbDevice
->SetDeviceAddress((UCHAR
)DeviceAddress
);
2242 if (NT_SUCCESS(Status
))
2245 }while(Index
++ < 3 );
2248 // check for failure
2250 if (!NT_SUCCESS(Status
))
2253 // failed to set device address
2255 DPRINT1("USBHI_InitializeUsbDevice failed to set address with %x\n", Status
);
2260 Controller
->ReleaseDeviceAddress(DeviceAddress
);
2265 return STATUS_DEVICE_DATA_ERROR
;
2271 return STATUS_SUCCESS
;
2276 USBHI_GetUsbDescriptors(
2278 PUSB_DEVICE_HANDLE DeviceHandle
,
2279 PUCHAR DeviceDescriptorBuffer
,
2280 PULONG DeviceDescriptorBufferLength
,
2281 PUCHAR ConfigDescriptorBuffer
,
2282 PULONG ConfigDescriptorBufferLength
)
2284 PUSBDEVICE UsbDevice
;
2285 CHubController
* Controller
;
2287 DPRINT1("USBHI_GetUsbDescriptors\n");
2292 PC_ASSERT(DeviceDescriptorBuffer
);
2293 PC_ASSERT(DeviceDescriptorBufferLength
);
2294 PC_ASSERT(*DeviceDescriptorBufferLength
>= sizeof(USB_DEVICE_DESCRIPTOR
));
2295 PC_ASSERT(ConfigDescriptorBufferLength
);
2296 PC_ASSERT(*ConfigDescriptorBufferLength
>= sizeof(USB_CONFIGURATION_DESCRIPTOR
));
2299 // first get controller
2301 Controller
= (CHubController
*)BusContext
;
2302 PC_ASSERT(Controller
);
2306 // get device object
2308 UsbDevice
= (PUSBDEVICE
)DeviceHandle
;
2309 PC_ASSERT(UsbDevice
);
2312 // validate device handle
2314 if (!Controller
->ValidateUsbDevice(UsbDevice
))
2316 DPRINT1("USBHI_GetUsbDescriptors invalid device handle %p\n", DeviceHandle
);
2319 // invalid device handle
2321 return STATUS_DEVICE_NOT_CONNECTED
;
2325 // get device descriptor
2327 UsbDevice
->GetDeviceDescriptor((PUSB_DEVICE_DESCRIPTOR
)DeviceDescriptorBuffer
);
2330 // store result length
2332 *DeviceDescriptorBufferLength
= sizeof(USB_DEVICE_DESCRIPTOR
);
2335 // get configuration descriptor
2337 UsbDevice
->GetConfigurationDescriptors((PUSB_CONFIGURATION_DESCRIPTOR
)ConfigDescriptorBuffer
, *ConfigDescriptorBufferLength
, ConfigDescriptorBufferLength
);
2340 // complete the request
2342 return STATUS_SUCCESS
;
2347 USBHI_RemoveUsbDevice(
2349 PUSB_DEVICE_HANDLE DeviceHandle
,
2352 PUSBDEVICE UsbDevice
;
2353 CHubController
* Controller
;
2356 DPRINT1("USBHI_RemoveUsbDevice\n");
2359 // first get controller
2361 Controller
= (CHubController
*)BusContext
;
2362 PC_ASSERT(Controller
);
2365 // get device object
2367 UsbDevice
= (PUSBDEVICE
)DeviceHandle
;
2368 PC_ASSERT(UsbDevice
);
2371 // validate device handle
2373 if (!Controller
->ValidateUsbDevice(UsbDevice
))
2375 DPRINT1("USBHI_RemoveUsbDevice invalid device handle %p\n", DeviceHandle
);
2378 // invalid device handle
2380 return STATUS_DEVICE_NOT_CONNECTED
;
2384 // check if there were flags passed
2386 if (Flags
& USBD_KEEP_DEVICE_DATA
|| Flags
& USBD_MARK_DEVICE_BUSY
)
2389 // ignore flags for now
2391 return STATUS_SUCCESS
;
2397 Status
= Controller
->RemoveUsbDevice(UsbDevice
);
2398 if (!NT_SUCCESS(Status
))
2401 // invalid device handle
2403 DPRINT1("USBHI_RemoveUsbDevice Invalid device handle %p\n", UsbDevice
);
2405 return STATUS_DEVICE_NOT_CONNECTED
;
2409 // release usb device
2411 UsbDevice
->Release();
2416 return STATUS_SUCCESS
;
2421 USBHI_RestoreUsbDevice(
2423 PUSB_DEVICE_HANDLE OldDeviceHandle
,
2424 PUSB_DEVICE_HANDLE NewDeviceHandle
)
2426 PUSBDEVICE OldUsbDevice
, NewUsbDevice
;
2427 CHubController
* Controller
;
2429 DPRINT1("USBHI_RestoreUsbDevice\n");
2432 // first get controller
2434 Controller
= (CHubController
*)BusContext
;
2435 PC_ASSERT(Controller
);
2438 // get device object
2440 OldUsbDevice
= (PUSBDEVICE
)OldDeviceHandle
;
2441 NewUsbDevice
= (PUSBDEVICE
)NewDeviceHandle
;
2442 PC_ASSERT(OldUsbDevice
);
2443 PC_ASSERT(NewDeviceHandle
);
2446 // validate device handle
2448 PC_ASSERT(Controller
->ValidateUsbDevice(NewUsbDevice
));
2449 PC_ASSERT(Controller
->ValidateUsbDevice(OldUsbDevice
));
2451 DPRINT1("NewUsbDevice: DeviceAddress %x\n", NewUsbDevice
->GetDeviceAddress());
2452 DPRINT1("OldUsbDevice: DeviceAddress %x\n", OldUsbDevice
->GetDeviceAddress());
2455 // remove old device handle
2457 USBHI_RemoveUsbDevice(BusContext
, OldDeviceHandle
, 0);
2459 return STATUS_SUCCESS
;
2464 USBHI_QueryDeviceInformation(
2466 PUSB_DEVICE_HANDLE DeviceHandle
,
2467 PVOID DeviceInformationBuffer
,
2468 ULONG DeviceInformationBufferLength
,
2469 PULONG LengthReturned
)
2471 PUSB_DEVICE_INFORMATION_0 DeviceInfo
;
2472 PUSBDEVICE UsbDevice
;
2473 CHubController
* Controller
;
2475 DPRINT1("USBHI_QueryDeviceInformation %p\n", BusContext
);
2480 PC_ASSERT(DeviceInformationBufferLength
>= sizeof(USB_DEVICE_INFORMATION_0
));
2481 PC_ASSERT(DeviceInformationBuffer
);
2482 PC_ASSERT(LengthReturned
);
2485 // get controller object
2487 Controller
= (CHubController
*)BusContext
;
2488 PC_ASSERT(Controller
);
2491 // get device object
2493 UsbDevice
= (PUSBDEVICE
)DeviceHandle
;
2494 PC_ASSERT(UsbDevice
);
2496 if (BusContext
!= DeviceHandle
)
2499 // validate device handle
2501 if (!Controller
->ValidateUsbDevice(UsbDevice
))
2503 DPRINT1("USBHI_QueryDeviceInformation invalid device handle %p\n", DeviceHandle
);
2506 // invalid device handle
2508 return STATUS_DEVICE_NOT_CONNECTED
;
2512 // access information buffer
2514 DeviceInfo
= (PUSB_DEVICE_INFORMATION_0
)DeviceInformationBuffer
;
2517 // initialize with default values
2519 DeviceInfo
->InformationLevel
= 0;
2520 DeviceInfo
->ActualLength
= sizeof(USB_DEVICE_INFORMATION_0
);
2521 DeviceInfo
->PortNumber
= UsbDevice
->GetPort();
2522 DeviceInfo
->CurrentConfigurationValue
= UsbDevice
->GetConfigurationValue();
2523 DeviceInfo
->DeviceAddress
= UsbDevice
->GetDeviceAddress();
2524 DeviceInfo
->HubAddress
= 0; //FIXME
2525 DeviceInfo
->DeviceSpeed
= UsbDevice
->GetSpeed();
2526 DeviceInfo
->DeviceType
= UsbDevice
->GetType();
2527 DeviceInfo
->NumberOfOpenPipes
= 0; //FIXME
2530 // get device descriptor
2532 UsbDevice
->GetDeviceDescriptor(&DeviceInfo
->DeviceDescriptor
);
2535 // FIXME return pipe information
2539 // store result length
2541 *LengthReturned
= sizeof(USB_DEVICE_INFORMATION_0
);
2543 return STATUS_SUCCESS
;
2547 // access information buffer
2549 DeviceInfo
= (PUSB_DEVICE_INFORMATION_0
)DeviceInformationBuffer
;
2552 // initialize with default values
2554 DeviceInfo
->InformationLevel
= 0;
2555 DeviceInfo
->ActualLength
= sizeof(USB_DEVICE_INFORMATION_0
);
2556 DeviceInfo
->PortNumber
= 0;
2557 DeviceInfo
->CurrentConfigurationValue
= 0; //FIXME;
2558 DeviceInfo
->DeviceAddress
= 0;
2559 DeviceInfo
->HubAddress
= 0; //FIXME
2560 DeviceInfo
->DeviceSpeed
= UsbFullSpeed
; //FIXME
2561 DeviceInfo
->DeviceType
= Usb11Device
; //FIXME
2562 DeviceInfo
->NumberOfOpenPipes
= 0; //FIXME
2565 // get device descriptor
2567 RtlMoveMemory(&DeviceInfo
->DeviceDescriptor
, ROOTHUB2_DEVICE_DESCRIPTOR
, sizeof(USB_DEVICE_DESCRIPTOR
));
2570 // FIXME return pipe information
2574 // store result length
2577 *LengthReturned
= FIELD_OFFSET(USB_DEVICE_INFORMATION_0
, PipeList
[DeviceInfo
->NumberOfOpenPipes
]);
2579 *LengthReturned
= sizeof(USB_DEVICE_INFORMATION_0
) + (DeviceInfo
->NumberOfOpenPipes
> 1 ? (DeviceInfo
->NumberOfOpenPipes
- 1) * sizeof(USB_PIPE_INFORMATION_0
) : 0);
2584 return STATUS_SUCCESS
;
2589 USBHI_GetControllerInformation(
2591 PVOID ControllerInformationBuffer
,
2592 ULONG ControllerInformationBufferLength
,
2593 PULONG LengthReturned
)
2595 PUSB_CONTROLLER_INFORMATION_0 ControllerInfo
;
2597 DPRINT1("USBHI_GetControllerInformation\n");
2602 PC_ASSERT(ControllerInformationBuffer
);
2603 PC_ASSERT(ControllerInformationBufferLength
>= sizeof(USB_CONTROLLER_INFORMATION_0
));
2606 // get controller info buffer
2608 ControllerInfo
= (PUSB_CONTROLLER_INFORMATION_0
)ControllerInformationBuffer
;
2611 // FIXME only version 0 is supported for now
2613 PC_ASSERT(ControllerInfo
->InformationLevel
== 0);
2616 // fill in information
2618 ControllerInfo
->ActualLength
= sizeof(USB_CONTROLLER_INFORMATION_0
);
2619 ControllerInfo
->SelectiveSuspendEnabled
= FALSE
; //FIXME
2620 ControllerInfo
->IsHighSpeedController
= FALSE
;
2623 // set length returned
2625 *LengthReturned
= ControllerInfo
->ActualLength
;
2630 return STATUS_SUCCESS
;
2635 USBHI_ControllerSelectiveSuspend(
2640 return STATUS_NOT_IMPLEMENTED
;
2645 USBHI_GetExtendedHubInformation(
2647 PDEVICE_OBJECT HubPhysicalDeviceObject
,
2648 PVOID HubInformationBuffer
,
2649 ULONG HubInformationBufferLength
,
2650 PULONG LengthReturned
)
2652 PUSB_EXTHUB_INFORMATION_0 HubInfo
;
2653 CHubController
* Controller
;
2654 PUSBHARDWAREDEVICE Hardware
;
2656 ULONG NumPort
, Dummy2
;
2660 DPRINT1("USBHI_GetExtendedHubInformation\n");
2665 PC_ASSERT(HubInformationBuffer
);
2666 PC_ASSERT(HubInformationBufferLength
== sizeof(USB_EXTHUB_INFORMATION_0
));
2667 PC_ASSERT(LengthReturned
);
2670 // get hub controller
2672 Controller
= (CHubController
*)BusContext
;
2673 PC_ASSERT(Controller
);
2676 // get usb hardware device
2678 Hardware
= Controller
->GetUsbHardware();
2681 // retrieve number of ports
2683 Status
= Hardware
->GetDeviceDetails(&Dummy1
, &Dummy1
, &NumPort
, &Dummy2
);
2684 if (!NT_SUCCESS(Status
))
2687 // failed to get hardware details, ouch ;)
2689 DPRINT1("USBHI_GetExtendedHubInformation failed to get hardware details with %x\n", Status
);
2694 // get hub information buffer
2696 HubInfo
= (PUSB_EXTHUB_INFORMATION_0
)HubInformationBuffer
;
2699 // initialize hub information
2701 HubInfo
->InformationLevel
= 0;
2706 HubInfo
->NumberOfPorts
= NumPort
;
2709 // initialize port information
2711 for(Index
= 0; Index
< NumPort
; Index
++)
2713 HubInfo
->Port
[Index
].PhysicalPortNumber
= Index
+ 1;
2714 HubInfo
->Port
[Index
].PortLabelNumber
= Index
+ 1;
2715 HubInfo
->Port
[Index
].VidOverride
= 0;
2716 HubInfo
->Port
[Index
].PidOverride
= 0;
2717 HubInfo
->Port
[Index
].PortAttributes
= 0; //FIXME
2721 // store result length
2724 *LengthReturned
= FIELD_OFFSET(USB_EXTHUB_INFORMATION_0
, Port
[HubInfo
->NumberOfPorts
]);
2726 *LengthReturned
= FIELD_OFFSET(USB_EXTHUB_INFORMATION_0
, Port
) + sizeof(USB_EXTPORT_INFORMATION_0
) * HubInfo
->NumberOfPorts
;
2732 return STATUS_SUCCESS
;
2737 USBHI_GetRootHubSymbolicName(
2739 PVOID HubSymNameBuffer
,
2740 ULONG HubSymNameBufferLength
,
2741 PULONG HubSymNameActualLength
)
2744 return STATUS_NOT_IMPLEMENTED
;
2749 USBHI_GetDeviceBusContext(
2750 PVOID HubBusContext
,
2759 USBHI_RootHubInitNotification(
2761 PVOID CallbackContext
,
2762 PRH_INIT_CALLBACK CallbackRoutine
)
2764 CHubController
* Controller
;
2766 DPRINT("USBHI_RootHubInitNotification %p \n", CallbackContext
);
2769 // get controller object
2771 Controller
= (CHubController
*)BusContext
;
2772 PC_ASSERT(Controller
);
2775 // set notification routine
2777 Controller
->SetNotification(CallbackContext
, CallbackRoutine
);
2780 // FIXME: determine when to perform callback
2782 CallbackRoutine(CallbackContext
);
2787 return STATUS_SUCCESS
;
2792 USBHI_FlushTransfers(
2801 USBHI_SetDeviceHandleData(
2804 PDEVICE_OBJECT UsbDevicePdo
)
2806 PUSBDEVICE UsbDevice
;
2807 CHubController
* Controller
;
2812 Controller
= (CHubController
*)BusContext
;
2813 PC_ASSERT(Controller
);
2816 // get device handle
2818 UsbDevice
= (PUSBDEVICE
)DeviceHandle
;
2821 // validate device handle
2823 if (!Controller
->ValidateUsbDevice(UsbDevice
))
2825 DPRINT1("USBHI_SetDeviceHandleData DeviceHandle %p is invalid\n", DeviceHandle
);
2835 // usbhub sends this request as a part of the Pnp startup sequence
2836 // looks like we need apply a dragon voodoo to fixup the device stack
2837 // otherwise usbhub will cause a bugcheck
2839 DPRINT1("USBHI_SetDeviceHandleData %p\n", UsbDevicePdo
);
2844 PC_ASSERT(UsbDevicePdo
->AttachedDevice
);
2847 // should be usbstor
2848 // fixup device stack voodoo part #2
2850 UsbDevicePdo
->AttachedDevice
->StackSize
++;
2853 // set device handle data
2855 UsbDevice
->SetDeviceHandleData(UsbDevicePdo
);
2859 //=================================================================================================
2861 // USB Device Interface functions
2866 USBDI_GetUSBDIVersion(
2868 PUSBD_VERSION_INFORMATION VersionInformation
,
2869 PULONG HcdCapabilites
)
2871 CHubController
* Controller
;
2872 PUSBHARDWAREDEVICE Device
;
2873 ULONG Speed
, Dummy2
;
2876 DPRINT1("USBDI_GetUSBDIVersion\n");
2881 Controller
= (CHubController
*)BusContext
;
2886 Device
= Controller
->GetUsbHardware();
2889 if (VersionInformation
)
2892 // windows xp supported
2894 VersionInformation
->USBDI_Version
= 0x00000500;
2899 Device
->GetDeviceDetails(&Dummy1
, &Dummy1
, &Dummy2
, &Speed
);
2902 // store speed details
2904 VersionInformation
->Supported_USB_Version
= Speed
;
2908 // no flags supported
2910 *HcdCapabilites
= 0;
2917 PULONG CurrentFrame
)
2920 return STATUS_NOT_IMPLEMENTED
;
2925 USBDI_SubmitIsoOutUrb(
2930 return STATUS_NOT_IMPLEMENTED
;
2935 USBDI_QueryBusInformation(
2938 PVOID BusInformationBuffer
,
2939 PULONG BusInformationBufferLength
,
2940 PULONG BusInformationActualLength
)
2943 return STATUS_NOT_IMPLEMENTED
;
2948 USBDI_IsDeviceHighSpeed(
2951 CHubController
* Controller
;
2952 PUSBHARDWAREDEVICE Device
;
2953 ULONG Speed
, Dummy2
;
2956 DPRINT1("USBDI_IsDeviceHighSpeed\n");
2961 Controller
= (CHubController
*)BusContext
;
2966 Device
= Controller
->GetUsbHardware();
2972 Device
->GetDeviceDetails(&Dummy1
, &Dummy1
, &Dummy2
, &Speed
);
2975 // USB 2.0 equals 0x200
2977 return (Speed
== 0x200);
2990 return STATUS_NOT_IMPLEMENTED
;
2994 CHubController::HandleQueryInterface(
2995 PIO_STACK_LOCATION IoStack
)
2997 PUSB_BUS_INTERFACE_HUB_V5 InterfaceHub
;
2998 PUSB_BUS_INTERFACE_USBDI_V2 InterfaceDI
;
2999 UNICODE_STRING GuidBuffer
;
3002 if (IsEqualGUIDAligned(*IoStack
->Parameters
.QueryInterface
.InterfaceType
, USB_BUS_INTERFACE_HUB_GUID
))
3005 // get request parameters
3007 InterfaceHub
= (PUSB_BUS_INTERFACE_HUB_V5
)IoStack
->Parameters
.QueryInterface
.Interface
;
3008 InterfaceHub
->Version
= IoStack
->Parameters
.QueryInterface
.Version
;
3013 if (IoStack
->Parameters
.QueryInterface
.Version
>= 6)
3015 DPRINT1("USB_BUS_INTERFACE_HUB_GUID version %x not supported!\n", IoStack
->Parameters
.QueryInterface
.Version
);
3018 // version not supported
3020 return STATUS_NOT_SUPPORTED
;
3024 // Interface version 0
3026 if (IoStack
->Parameters
.QueryInterface
.Version
>= 0)
3028 InterfaceHub
->Size
= IoStack
->Parameters
.QueryInterface
.Size
;
3029 InterfaceHub
->BusContext
= PVOID(this);
3030 InterfaceHub
->InterfaceReference
= USBI_InterfaceReference
;
3031 InterfaceHub
->InterfaceDereference
= USBI_InterfaceDereference
;
3035 // Interface version 1
3037 if (IoStack
->Parameters
.QueryInterface
.Version
>= 1)
3039 InterfaceHub
->CreateUsbDevice
= USBHI_CreateUsbDevice
;
3040 InterfaceHub
->InitializeUsbDevice
= USBHI_InitializeUsbDevice
;
3041 InterfaceHub
->GetUsbDescriptors
= USBHI_GetUsbDescriptors
;
3042 InterfaceHub
->RemoveUsbDevice
= USBHI_RemoveUsbDevice
;
3043 InterfaceHub
->RestoreUsbDevice
= USBHI_RestoreUsbDevice
;
3044 InterfaceHub
->QueryDeviceInformation
= USBHI_QueryDeviceInformation
;
3048 // Interface version 2
3050 if (IoStack
->Parameters
.QueryInterface
.Version
>= 2)
3052 InterfaceHub
->GetControllerInformation
= USBHI_GetControllerInformation
;
3053 InterfaceHub
->ControllerSelectiveSuspend
= USBHI_ControllerSelectiveSuspend
;
3054 InterfaceHub
->GetExtendedHubInformation
= USBHI_GetExtendedHubInformation
;
3055 InterfaceHub
->GetRootHubSymbolicName
= USBHI_GetRootHubSymbolicName
;
3056 InterfaceHub
->GetDeviceBusContext
= USBHI_GetDeviceBusContext
;
3060 // Interface version 3
3062 if (IoStack
->Parameters
.QueryInterface
.Version
>= 3)
3064 InterfaceHub
->RootHubInitNotification
= USBHI_RootHubInitNotification
;
3068 // Interface version 4
3070 if (IoStack
->Parameters
.QueryInterface
.Version
>= 4)
3072 InterfaceHub
->FlushTransfers
= USBHI_FlushTransfers
;
3076 // Interface version 5
3078 if (IoStack
->Parameters
.QueryInterface
.Version
>= 5)
3080 InterfaceHub
->SetDeviceHandleData
= USBHI_SetDeviceHandleData
;
3084 // request completed
3086 return STATUS_SUCCESS
;
3088 else if (IsEqualGUIDAligned(*IoStack
->Parameters
.QueryInterface
.InterfaceType
, USB_BUS_INTERFACE_USBDI_GUID
))
3091 // get request parameters
3093 InterfaceDI
= (PUSB_BUS_INTERFACE_USBDI_V2
) IoStack
->Parameters
.QueryInterface
.Interface
;
3094 InterfaceDI
->Version
= IoStack
->Parameters
.QueryInterface
.Version
;
3099 if (IoStack
->Parameters
.QueryInterface
.Version
>= 3)
3101 DPRINT1("USB_BUS_INTERFACE_USBDI_GUID version %x not supported!\n", IoStack
->Parameters
.QueryInterface
.Version
);
3104 // version not supported
3106 return STATUS_NOT_SUPPORTED
;
3110 // interface version 0
3112 if (IoStack
->Parameters
.QueryInterface
.Version
>= 0)
3114 InterfaceDI
->Size
= IoStack
->Parameters
.QueryInterface
.Size
;
3115 InterfaceDI
->BusContext
= PVOID(this);
3116 InterfaceDI
->InterfaceReference
= USBI_InterfaceReference
;
3117 InterfaceDI
->InterfaceDereference
= USBI_InterfaceDereference
;
3118 InterfaceDI
->GetUSBDIVersion
= USBDI_GetUSBDIVersion
;
3119 InterfaceDI
->QueryBusTime
= USBDI_QueryBusTime
;
3120 InterfaceDI
->SubmitIsoOutUrb
= USBDI_SubmitIsoOutUrb
;
3121 InterfaceDI
->QueryBusInformation
= USBDI_QueryBusInformation
;
3125 // interface version 1
3127 if (IoStack
->Parameters
.QueryInterface
.Version
>= 1)
3129 InterfaceDI
->IsDeviceHighSpeed
= USBDI_IsDeviceHighSpeed
;
3133 // interface version 2
3135 if (IoStack
->Parameters
.QueryInterface
.Version
>= 2)
3137 InterfaceDI
->EnumLogEntry
= USBDI_EnumLogEntry
;
3141 // request completed
3143 return STATUS_SUCCESS
;
3148 // convert guid to string
3150 Status
= RtlStringFromGUID(*IoStack
->Parameters
.QueryInterface
.InterfaceType
, &GuidBuffer
);
3151 if (NT_SUCCESS(Status
))
3156 DPRINT1("HandleQueryInterface UNKNOWN INTERFACE GUID: %wZ Version %x\n", &GuidBuffer
, IoStack
->Parameters
.QueryInterface
.Version
);
3161 RtlFreeUnicodeString(&GuidBuffer
);
3164 return STATUS_NOT_SUPPORTED
;
3168 CHubController::SetDeviceInterface(
3171 NTSTATUS Status
= STATUS_SUCCESS
;
3176 // register device interface
3178 Status
= IoRegisterDeviceInterface(m_HubControllerDeviceObject
, &GUID_DEVINTERFACE_USB_HUB
, 0, &m_HubDeviceInterfaceString
);
3180 if (NT_SUCCESS(Status
))
3183 // now enable the device interface
3185 Status
= IoSetDeviceInterfaceState(&m_HubDeviceInterfaceString
, TRUE
);
3190 m_InterfaceEnabled
= TRUE
;
3193 else if (m_InterfaceEnabled
)
3196 // disable device interface
3198 Status
= IoSetDeviceInterfaceState(&m_HubDeviceInterfaceString
, FALSE
);
3200 if (NT_SUCCESS(Status
))
3203 // now delete interface string
3205 RtlFreeUnicodeString(&m_HubDeviceInterfaceString
);
3209 // disable interface
3211 m_InterfaceEnabled
= FALSE
;
3221 CHubController::CreatePDO(
3222 PDRIVER_OBJECT DriverObject
,
3223 PDEVICE_OBJECT
* OutDeviceObject
)
3225 WCHAR CharDeviceName
[64];
3227 ULONG UsbDeviceNumber
= 0;
3228 UNICODE_STRING DeviceName
;
3233 // construct device name
3235 swprintf(CharDeviceName
, L
"\\Device\\USBPDO-%d", UsbDeviceNumber
);
3238 // initialize device name
3240 RtlInitUnicodeString(&DeviceName
, CharDeviceName
);
3245 Status
= IoCreateDevice(DriverObject
,
3246 sizeof(COMMON_DEVICE_EXTENSION
),
3248 FILE_DEVICE_CONTROLLER
,
3253 /* check for success */
3254 if (NT_SUCCESS(Status
))
3258 // is there a device object with that same name
3260 if ((Status
== STATUS_OBJECT_NAME_EXISTS
) || (Status
== STATUS_OBJECT_NAME_COLLISION
))
3263 // Try the next name
3270 // bail out on other errors
3272 if (!NT_SUCCESS(Status
))
3274 DPRINT1("CreatePDO: Failed to create %wZ, Status %x\n", &DeviceName
, Status
);
3279 DPRINT1("CHubController::CreatePDO: DeviceName %wZ\n", &DeviceName
);
3282 // fixup device stack voodoo part #1
3284 (*OutDeviceObject
)->StackSize
++;
3293 CreateHubController(
3294 PHUBCONTROLLER
*OutHcdController
)
3296 PHUBCONTROLLER This
;
3299 // allocate controller
3301 This
= new(NonPagedPool
, TAG_USBOHCI
) CHubController(0);
3305 // failed to allocate
3307 return STATUS_INSUFFICIENT_RESOURCES
;
3311 // add reference count
3318 *OutHcdController
= (PHUBCONTROLLER
)This
;
3323 return STATUS_SUCCESS
;
3326 VOID
StatusChangeEndpointCallBack(PVOID Context
)
3328 CHubController
* This
;
3330 This
= (CHubController
*)Context
;
3334 Irp
= This
->m_PendingSCEIrp
;
3337 DPRINT1("There was no pending IRP for SCE. Did the usb hub 2.0 driver (usbhub2) load?\n");
3341 This
->m_PendingSCEIrp
= NULL
;
3342 This
->QueryStatusChageEndpoint(Irp
);
3344 Irp
->IoStatus
.Status
= STATUS_SUCCESS
;
3345 Irp
->IoStatus
.Information
= 0;
3347 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);