drivers/usb/usbport/usbport.h

   1 /*
   2  * PROJECT:     ReactOS USB Port Driver
   3  * LICENSE:     GPL-2.0+ (https://spdx.org/licenses/GPL-2.0+)
   4  * PURPOSE:     USBPort declarations
   5  * COPYRIGHT:   Copyright 2017 Vadim Galyant <vgal@rambler.ru>
   6  */
   7
   8 #ifndef USBPORT_H__
   9 #define USBPORT_H__
  10
  11 #include <ntddk.h>
  12 #include <windef.h>
  13 #include <stdio.h>
  14 #include <wdmguid.h>
  15 #include <ntstrsafe.h>
  16 #include <usb.h>
  17 #include <hubbusif.h>
  18 #include <usbbusif.h>
  19 #include <usbdlib.h>
  20 #include <usbuser.h>
  21 #include <drivers/usbport/usbmport.h>
  22
  23 #define PCI_INTERFACE_USB_ID_UHCI 0x00
  24 #define PCI_INTERFACE_USB_ID_OHCI 0x10
  25 #define PCI_INTERFACE_USB_ID_EHCI 0x20
  26 #define PCI_INTERFACE_USB_ID_XHCI 0x30
  27
  28 #ifdef USBD_TRANSFER_DIRECTION // due hubbusif.h included usbdi.h (Which overwrites...)
  29 #undef USBD_TRANSFER_DIRECTION
  30 #define USBD_TRANSFER_DIRECTION 0x00000001
  31 #endif
  32
  33 #define USBPORT_RECIPIENT_HUB  BMREQUEST_TO_DEVICE
  34 #define USBPORT_RECIPIENT_PORT BMREQUEST_TO_OTHER
  35
  36 #define INVALIDATE_ENDPOINT_ONLY           0
  37 #define INVALIDATE_ENDPOINT_WORKER_THREAD  1
  38 #define INVALIDATE_ENDPOINT_WORKER_DPC     2
  39 #define INVALIDATE_ENDPOINT_INT_NEXT_SOF   3
  40
  41 #define USBPORT_DMA_DIRECTION_FROM_DEVICE 1
  42 #define USBPORT_DMA_DIRECTION_TO_DEVICE   2
  43
  44 #define USB_PORT_TAG 'pbsu'
  45 #define URB_FUNCTION_MAX 0x31
  46
  47 /* Hub Class Feature Selectors (Recipient - Port) */
  48 #define FEATURE_PORT_CONNECTION     0
  49 #define FEATURE_PORT_ENABLE         1
  50 #define FEATURE_PORT_SUSPEND        2
  51 #define FEATURE_PORT_OVER_CURRENT   3
  52 #define FEATURE_PORT_RESET          4
  53 #define FEATURE_PORT_POWER          8
  54 #define FEATURE_PORT_LOW_SPEED      9
  55 #define FEATURE_C_PORT_CONNECTION   16
  56 #define FEATURE_C_PORT_ENABLE       17
  57 #define FEATURE_C_PORT_SUSPEND      18
  58 #define FEATURE_C_PORT_OVER_CURRENT 19
  59 #define FEATURE_C_PORT_RESET        20
  60
  61 /* Hub Class Feature Selectors (Recipient - Hub) */
  62 #define FEATURE_C_HUB_LOCAL_POWER  0
  63 #define FEATURE_C_HUB_OVER_CURRENT 1
  64
  65 /* Flags */
  66 #define USBPORT_FLAG_INT_CONNECTED     0x00000001
  67 #define USBPORT_FLAG_HC_STARTED        0x00000002
  68 #define USBPORT_FLAG_HC_POLLING        0x00000004
  69 #define USBPORT_FLAG_WORKER_THREAD_ON  0x00000008
  70 #define USBPORT_FLAG_HC_SUSPEND        0x00000100
  71 #define USBPORT_FLAG_INTERRUPT_ENABLED 0x00000400
  72 #define USBPORT_FLAG_SELECTIVE_SUSPEND 0x00000800
  73 #define USBPORT_FLAG_DOS_SYMBOLIC_NAME 0x00010000
  74 #define USBPORT_FLAG_LEGACY_SUPPORT    0x00080000
  75 #define USBPORT_FLAG_HC_WAKE_SUPPORT   0x00200000
  76 #define USBPORT_FLAG_DIAGNOSTIC_MODE   0x00800000 //IOCTL_USB_DIAGNOSTIC_MODE_ON
  77 #define USBPORT_FLAG_COMPANION_HC      0x01000000
  78 #define USBPORT_FLAG_REGISTERED_FDO    0x02000000
  79 #define USBPORT_FLAG_NO_HACTION        0x04000000
  80 #define USBPORT_FLAG_BIOS_DISABLE_SS   0x08000000 //Selective Suspend
  81 #define USBPORT_FLAG_PWR_AND_CHIRP_LOCK 0x10000000
  82 #define USBPORT_FLAG_POWER_AND_CHIRP_OK 0x40000000
  83 #define USBPORT_FLAG_RH_INIT_CALLBACK  0x80000000
  84
  85 /* PnP state Flags */
  86 #define USBPORT_PNP_STATE_NOT_INIT  0x00000001
  87 #define USBPORT_PNP_STATE_STARTED   0x00000002
  88 #define USBPORT_PNP_STATE_FAILED    0x00000004
  89 #define USBPORT_PNP_STATE_STOPPED   0x00000008
  90
  91 /* Timer Flags */
  92 #define USBPORT_TMFLAG_TIMER_QUEUED       0x00000001
  93 #define USBPORT_TMFLAG_HC_SUSPENDED       0x00000002
  94 #define USBPORT_TMFLAG_HC_RESUME          0x00000004
  95 #define USBPORT_TMFLAG_RH_SUSPENDED       0x00000008
  96 #define USBPORT_TMFLAG_TIMER_STARTED      0x00000010
  97 #define USBPORT_TMFLAG_WAKE               0x00000020
  98 #define USBPORT_TMFLAG_IDLE_QUEUEITEM_ON  0x00000040
  99
 100 /* Miniport Flags */
 101 #define USBPORT_MPFLAG_INTERRUPTS_ENABLED  0x00000001
 102 #define USBPORT_MPFLAG_SUSPENDED           0x00000002
 103
 104 /* Device handle Flags (USBPORT_DEVICE_HANDLE) */
 105 #define DEVICE_HANDLE_FLAG_ROOTHUB     0x00000002
 106 #define DEVICE_HANDLE_FLAG_REMOVED     0x00000008
 107 #define DEVICE_HANDLE_FLAG_USB2HUB     0x00000010
 108
 109 /* Endpoint Flags (USBPORT_ENDPOINT) */
 110 #define ENDPOINT_FLAG_DMA_TYPE      0x00000001
 111 #define ENDPOINT_FLAG_ROOTHUB_EP0   0x00000002
 112 #define ENDPOINT_FLAG_NUKE          0x00000008
 113 #define ENDPOINT_FLAG_QUEUENE_EMPTY 0x00000010
 114 #define ENDPOINT_FLAG_ABORTING      0x00000020
 115 #define ENDPOINT_FLAG_IDLE          0x00000100
 116 #define ENDPOINT_FLAG_OPENED        0x00000200
 117 #define ENDPOINT_FLAG_CLOSED        0x00000400
 118
 119 /* UsbdFlags Flags (URB) */
 120 #define USBD_FLAG_ALLOCATED_MDL      0x00000002
 121 #define USBD_FLAG_NOT_ISO_TRANSFER   0x00000010
 122 #define USBD_FLAG_ALLOCATED_TRANSFER 0x00000020
 123
 124 /* Pipe handle Flags (USBPORT_PIPE_HANDLE) */
 125 #define PIPE_HANDLE_FLAG_CLOSED 0x00000001
 126 #define PIPE_HANDLE_FLAG_NULL_PACKET_SIZE 0x00000002
 127
 128 /* Transfer Flags (USBPORT_TRANSFER) */
 129 #define TRANSFER_FLAG_CANCELED   0x00000001
 130 #define TRANSFER_FLAG_DMA_MAPPED 0x00000002
 131 #define TRANSFER_FLAG_HIGH_SPEED 0x00000004
 132 #define TRANSFER_FLAG_SUBMITED   0x00000008
 133 #define TRANSFER_FLAG_ABORTED    0x00000010
 134 #define TRANSFER_FLAG_ISO        0x00000020
 135 #define TRANSFER_FLAG_DEVICE_GONE 0x00000080
 136 #define TRANSFER_FLAG_SPLITED    0x00000100
 137 #define TRANSFER_FLAG_COMPLETED  0x00000200
 138 #define TRANSFER_FLAG_PARENT     0x00000400
 139
 140 extern KSPIN_LOCK USBPORT_SpinLock;
 141 extern LIST_ENTRY USBPORT_MiniPortDrivers;
 142
 143 typedef USBD_STATUS* PUSBD_STATUS;
 144
 145 typedef struct _USBPORT_COMMON_BUFFER_HEADER {
 146   ULONG Length;
 147   ULONG_PTR BaseVA;
 148   PHYSICAL_ADDRESS LogicalAddress;
 149   SIZE_T BufferLength;
 150   ULONG_PTR VirtualAddress;
 151   ULONG_PTR PhysicalAddress;
 152 } USBPORT_COMMON_BUFFER_HEADER, *PUSBPORT_COMMON_BUFFER_HEADER;
 153
 154 typedef struct _USBPORT_ENDPOINT *PUSBPORT_ENDPOINT;
 155
 156 typedef struct _USB2_HC_EXTENSION *PUSB2_HC_EXTENSION;
 157 typedef struct _USB2_TT_EXTENSION *PUSB2_TT_EXTENSION;
 158 typedef struct _USB2_TT *PUSB2_TT;
 159 typedef struct _USB2_TT_ENDPOINT *PUSB2_TT_ENDPOINT;
 160
 161 typedef struct _USBPORT_PIPE_HANDLE {
 162   ULONG Flags;
 163   ULONG PipeFlags;
 164   USB_ENDPOINT_DESCRIPTOR EndpointDescriptor;
 165   UCHAR Padded;
 166   PUSBPORT_ENDPOINT Endpoint;
 167   LIST_ENTRY PipeLink;
 168 } USBPORT_PIPE_HANDLE, *PUSBPORT_PIPE_HANDLE;
 169
 170 typedef struct _USBPORT_CONFIGURATION_HANDLE {
 171   PUSB_CONFIGURATION_DESCRIPTOR ConfigurationDescriptor;
 172   LIST_ENTRY InterfaceHandleList;
 173   //USB_CONFIGURATION_DESCRIPTOR CfgDescriptor; // Body.
 174 } USBPORT_CONFIGURATION_HANDLE, *PUSBPORT_CONFIGURATION_HANDLE;
 175
 176 typedef struct _USBPORT_INTERFACE_HANDLE {
 177   LIST_ENTRY InterfaceLink;
 178   UCHAR AlternateSetting;
 179   UCHAR Pad1[3];
 180   USB_INTERFACE_DESCRIPTOR InterfaceDescriptor;
 181   UCHAR Pad2[3];
 182   USBPORT_PIPE_HANDLE PipeHandle[1];
 183 } USBPORT_INTERFACE_HANDLE, *PUSBPORT_INTERFACE_HANDLE;
 184
 185 typedef struct _USBPORT_DEVICE_HANDLE {
 186   ULONG Flags;
 187   USHORT DeviceAddress;
 188   USHORT PortNumber;
 189   USBPORT_PIPE_HANDLE PipeHandle;
 190   ULONG DeviceSpeed;
 191   BOOL IsRootHub;
 192   LIST_ENTRY PipeHandleList;
 193   PUSBPORT_CONFIGURATION_HANDLE ConfigHandle;
 194   struct _USBPORT_DEVICE_HANDLE *HubDeviceHandle;
 195   USB_DEVICE_DESCRIPTOR DeviceDescriptor;
 196   LIST_ENTRY DeviceHandleLink;
 197   LONG DeviceHandleLock;
 198   ULONG TtCount;
 199   PUSB2_TT_EXTENSION TtExtension; // Transaction Translator
 200   LIST_ENTRY TtList;
 201 } USBPORT_DEVICE_HANDLE, *PUSBPORT_DEVICE_HANDLE;
 202
 203 typedef struct _USBPORT_ENDPOINT {
 204   ULONG Flags;
 205   PDEVICE_OBJECT FdoDevice;
 206   PUSBPORT_COMMON_BUFFER_HEADER HeaderBuffer;
 207   PUSBPORT_DEVICE_HANDLE DeviceHandle;
 208   PUSB2_TT_EXTENSION TtExtension; // Transaction Translator
 209   PUSB2_TT_ENDPOINT TtEndpoint;
 210   USBPORT_ENDPOINT_PROPERTIES EndpointProperties;
 211   ULONG EndpointWorker;
 212   ULONG FrameNumber;
 213   /* Locks */
 214   KSPIN_LOCK EndpointSpinLock;
 215   KIRQL EndpointOldIrql;
 216   KIRQL EndpointStateOldIrql;
 217   UCHAR Padded[2];
 218   LONG LockCounter;
 219   LONG FlushPendingLock;
 220   /* State */
 221   ULONG StateLast;
 222   ULONG StateNext;
 223   LIST_ENTRY StateChangeLink;
 224   KSPIN_LOCK StateChangeSpinLock;
 225   /* Transfer lists */
 226   LIST_ENTRY PendingTransferList;
 227   LIST_ENTRY TransferList;
 228   LIST_ENTRY CancelList;
 229   LIST_ENTRY AbortList;
 230   /* Links */
 231   LIST_ENTRY EndpointLink;
 232   LIST_ENTRY WorkerLink;
 233   LIST_ENTRY CloseLink;
 234   LIST_ENTRY DispatchLink;
 235   LIST_ENTRY FlushLink;
 236   LIST_ENTRY FlushControllerLink;
 237   LIST_ENTRY FlushAbortLink;
 238   LIST_ENTRY TtLink;
 239   LIST_ENTRY RebalanceLink;
 240 } USBPORT_ENDPOINT, *PUSBPORT_ENDPOINT;
 241
 242 typedef struct _USBPORT_ISO_BLOCK *PUSBPORT_ISO_BLOCK;
 243
 244 typedef struct _USBPORT_TRANSFER {
 245   ULONG Flags;
 246   PIRP Irp;
 247   PURB Urb;
 248   PRKEVENT Event;
 249   PVOID MiniportTransfer;
 250   SIZE_T PortTransferLength; // Only port part
 251   SIZE_T FullTransferLength; // Port + miniport
 252   PUSBPORT_ENDPOINT Endpoint;
 253   USBPORT_TRANSFER_PARAMETERS TransferParameters;
 254   PMDL TransferBufferMDL;
 255   ULONG Direction;
 256   LIST_ENTRY TransferLink;
 257   USBD_STATUS USBDStatus;
 258   ULONG CompletedTransferLen;
 259   ULONG NumberOfMapRegisters;
 260   PVOID MapRegisterBase;
 261   ULONG TimeOut;
 262   LARGE_INTEGER Time;
 263   struct _USBPORT_TRANSFER * ParentTransfer;
 264   KSPIN_LOCK TransferSpinLock;
 265   LIST_ENTRY SplitTransfersList; // for parent transfers
 266   LIST_ENTRY SplitLink; // for splitted transfers
 267   ULONG Period;
 268   PUSBPORT_ISO_BLOCK IsoBlockPtr; // pointer on IsoBlock
 269   // SgList should be LAST field
 270   USBPORT_SCATTER_GATHER_LIST SgList; // variable length
 271   //USBPORT_ISO_BLOCK IsoBlock; // variable length
 272 } USBPORT_TRANSFER, *PUSBPORT_TRANSFER;
 273
 274 typedef struct _USBPORT_IRP_TABLE {
 275   struct _USBPORT_IRP_TABLE * LinkNextTable;
 276   PIRP irp[0X200];
 277 } USBPORT_IRP_TABLE, *PUSBPORT_IRP_TABLE;
 278
 279 typedef struct _USBPORT_COMMON_DEVICE_EXTENSION {
 280   PDEVICE_OBJECT SelfDevice;
 281   PDEVICE_OBJECT LowerPdoDevice; // PhysicalDeviceObject
 282   PDEVICE_OBJECT LowerDevice; // TopOfStackDeviceObject
 283   ULONG IsPDO;
 284   UNICODE_STRING SymbolicLinkName;
 285   BOOL IsInterfaceEnabled;
 286   DEVICE_POWER_STATE DevicePowerState;
 287   ULONG PnpStateFlags;
 288 } USBPORT_COMMON_DEVICE_EXTENSION, *PUSBPORT_COMMON_DEVICE_EXTENSION;
 289
 290 typedef struct _USBPORT_DEVICE_EXTENSION {
 291   USBPORT_COMMON_DEVICE_EXTENSION CommonExtension;
 292   ULONG Flags;
 293   PDEVICE_OBJECT RootHubPdo; // RootHubDeviceObject
 294   KSPIN_LOCK RootHubCallbackSpinLock;
 295   LONG RHInitCallBackLock;
 296   LONG ChirpRootPortLock;
 297   KSEMAPHORE ControllerSemaphore;
 298   ULONG FdoNameNumber;
 299   UNICODE_STRING DosDeviceSymbolicName;
 300   ULONG UsbBIOSx;
 301   LIST_ENTRY ControllerLink;
 302   ULONG CommonBufferLimit;
 303   /* Miniport */
 304   ULONG MiniPortFlags;
 305   PVOID MiniPortExt;
 306   PUSBPORT_MINIPORT_INTERFACE MiniPortInterface;
 307   USBPORT_RESOURCES UsbPortResources;
 308   PUSBPORT_COMMON_BUFFER_HEADER MiniPortCommonBuffer;
 309   KSPIN_LOCK MiniportSpinLock;
 310   /* Bus Interface */
 311   BUS_INTERFACE_STANDARD BusInterface;
 312   USHORT VendorID;
 313   USHORT DeviceID;
 314   UCHAR RevisionID;
 315   UCHAR ProgIf;
 316   UCHAR SubClass;
 317   UCHAR BaseClass;
 318   /* Dma Adapter */
 319   PDMA_ADAPTER DmaAdapter;
 320   ULONG NumberMapRegs;
 321   /* Interrupt */
 322   PKINTERRUPT InterruptObject;
 323   KDPC IsrDpc;
 324   LONG IsrDpcCounter;
 325   LONG IsrDpcHandlerCounter;
 326   KSPIN_LOCK MiniportInterruptsSpinLock;
 327   KTIMER TimerSoftInterrupt;
 328   KDPC SoftInterruptDpc;
 329   /* Endpoints */
 330   ULONG PeriodicEndpoints;
 331   LIST_ENTRY EndpointList;
 332   KSPIN_LOCK EndpointListSpinLock;
 333   LIST_ENTRY EpStateChangeList;
 334   KSPIN_LOCK EpStateChangeSpinLock;
 335   LIST_ENTRY EndpointClosedList;
 336   KSPIN_LOCK EndpointClosedSpinLock;
 337   LIST_ENTRY WorkerList;
 338   /* Transfers */
 339   LIST_ENTRY MapTransferList;
 340   KSPIN_LOCK MapTransferSpinLock;
 341   LIST_ENTRY DoneTransferList;
 342   KSPIN_LOCK DoneTransferSpinLock;
 343   KDPC TransferFlushDpc;
 344   KSPIN_LOCK FlushTransferSpinLock;
 345   KSPIN_LOCK FlushPendingTransferSpinLock;
 346   /* Timer */
 347   ULONG TimerValue; // Timer period (500) msec. default
 348   ULONG TimerFlags;
 349   KTIMER TimerObject;
 350   KDPC TimerDpc;
 351   KSPIN_LOCK TimerFlagsSpinLock;
 352   /* Worker Thread */
 353   PRKTHREAD WorkerThread;
 354   HANDLE WorkerThreadHandle;
 355   KEVENT WorkerThreadEvent;
 356   KSPIN_LOCK WorkerThreadEventSpinLock;
 357   /* Usb Devices */
 358   ULONG UsbAddressBitMap[4];
 359   LIST_ENTRY DeviceHandleList;
 360   KSPIN_LOCK DeviceHandleSpinLock;
 361   KSEMAPHORE DeviceSemaphore;
 362   /* Device Capabilities */
 363   DEVICE_CAPABILITIES Capabilities;
 364   ULONG BusNumber;
 365   ULONG PciDeviceNumber;
 366   ULONG PciFunctionNumber;
 367   ULONG TotalBusBandwidth;
 368   /* Idle */
 369   LARGE_INTEGER IdleTime;
 370   IO_CSQ IdleIoCsq;
 371   KSPIN_LOCK IdleIoCsqSpinLock;
 372   LIST_ENTRY IdleIrpList;
 373   LONG IdleLockCounter;
 374   /* Bad Requests */
 375   IO_CSQ BadRequestIoCsq;
 376   KSPIN_LOCK BadRequestIoCsqSpinLock;
 377   LIST_ENTRY BadRequestList;
 378   LONG BadRequestLockCounter;
 379   /* Irp Queues */
 380   PUSBPORT_IRP_TABLE PendingIrpTable;
 381   PUSBPORT_IRP_TABLE ActiveIrpTable;
 382   /* Power */
 383   LONG SetPowerLockCounter;
 384   KSPIN_LOCK PowerWakeSpinLock;
 385   KSPIN_LOCK SetPowerD0SpinLock;
 386   KDPC WorkerRequestDpc;
 387   KDPC HcWakeDpc;
 388   /* Usb 2.0 HC Extension */
 389   PUSB2_HC_EXTENSION Usb2Extension;
 390   ULONG Bandwidth[32];
 391   KSPIN_LOCK TtSpinLock;
 392
 393   /* Miniport extension should be aligned on 0x100 */
 394 #if !defined(_M_X64)
 395   ULONG Padded[64];
 396 #else
 397   ULONG Padded[0];
 398 #endif
 399
 400 } USBPORT_DEVICE_EXTENSION, *PUSBPORT_DEVICE_EXTENSION;
 401
 402 #if !defined(_M_X64)
 403 C_ASSERT(sizeof(USBPORT_DEVICE_EXTENSION) == 0x500);
 404 #else
 405 C_ASSERT(sizeof(USBPORT_DEVICE_EXTENSION) == 0x600);
 406 #endif
 407
 408 typedef struct _USBPORT_RH_DESCRIPTORS {
 409   USB_DEVICE_DESCRIPTOR DeviceDescriptor;
 410   USB_CONFIGURATION_DESCRIPTOR ConfigDescriptor;
 411   USB_INTERFACE_DESCRIPTOR InterfaceDescriptor;
 412   USB_ENDPOINT_DESCRIPTOR EndPointDescriptor;
 413   USB_HUB_DESCRIPTOR Descriptor; // Size may be: 7 + 2[1..32] (7 + 2..64)
 414 } USBPORT_RH_DESCRIPTORS, *PUSBPORT_RH_DESCRIPTORS;
 415
 416 typedef struct _USBPORT_RHDEVICE_EXTENSION {
 417   USBPORT_COMMON_DEVICE_EXTENSION CommonExtension;
 418   ULONG Flags;
 419   PDEVICE_OBJECT FdoDevice;
 420   ULONG PdoNameNumber;
 421   USBPORT_DEVICE_HANDLE DeviceHandle;
 422   PUSBPORT_RH_DESCRIPTORS RootHubDescriptors;
 423   PUSBPORT_ENDPOINT Endpoint;
 424   ULONG ConfigurationValue;
 425   PRH_INIT_CALLBACK RootHubInitCallback;
 426   PVOID RootHubInitContext;
 427   DEVICE_CAPABILITIES Capabilities;
 428   PIRP WakeIrp;
 429 } USBPORT_RHDEVICE_EXTENSION, *PUSBPORT_RHDEVICE_EXTENSION;
 430
 431 typedef struct _USBPORT_ASYNC_CALLBACK_DATA {
 432   ULONG Reserved;
 433   PDEVICE_OBJECT FdoDevice;
 434   KTIMER AsyncTimer;
 435   KDPC AsyncTimerDpc;
 436   ASYNC_TIMER_CALLBACK *CallbackFunction;
 437   ULONG CallbackContext;
 438 } USBPORT_ASYNC_CALLBACK_DATA, *PUSBPORT_ASYNC_CALLBACK_DATA;
 439
 440 C_ASSERT(sizeof(USBPORT_ASYNC_CALLBACK_DATA) == 16 + 18 * sizeof(PVOID));
 441
 442 typedef struct _TIMER_WORK_QUEUE_ITEM {
 443   WORK_QUEUE_ITEM WqItem;
 444   PDEVICE_OBJECT FdoDevice;
 445   ULONG Context;
 446 } TIMER_WORK_QUEUE_ITEM, *PTIMER_WORK_QUEUE_ITEM;
 447
 448 /* Transaction Translator */
 449 /* See Chapter 5 - USB Data Flow Model and Chapter 11 - Hub Specification */
 450
 451 #define USB2_FRAMES           32
 452 #define USB2_MICROFRAMES      8
 453 #define USB2_MAX_MICROFRAMES  (USB2_FRAMES * USB2_MICROFRAMES)
 454
 455 #define USB2_MAX_MICROFRAME_ALLOCATION         7000 // bytes
 456 #define USB2_CONTROLLER_DELAY                  100
 457 #define USB2_FS_MAX_PERIODIC_ALLOCATION        1157 // ((12000 / 8 bits) * 0.9) / (7/6) - 90% max, and bits stuffing
 458 #define USB2_FS_SOF_TIME                       6
 459 #define USB2_HUB_DELAY                         30
 460 #define USB2_MAX_FS_LS_TRANSACTIONS_IN_UFRAME  16
 461 #define USB2_FS_RAW_BYTES_IN_MICROFRAME        188  // (12000 / 8 bits / USB2_MICROFRAMES) = 187,5. But we use "best case budget"
 462
 463 /* Overheads */
 464 #define USB2_LS_INTERRUPT_OVERHEAD             117 // FS-bytes
 465 #define USB2_FS_INTERRUPT_OVERHEAD             13
 466 #define USB2_HS_INTERRUPT_OUT_OVERHEAD         45
 467 #define USB2_HS_INTERRUPT_IN_OVERHEAD          25
 468 #define USB2_FS_ISOCHRONOUS_OVERHEAD           9
 469 #define USB2_HS_ISOCHRONOUS_OUT_OVERHEAD       38
 470 #define USB2_HS_ISOCHRONOUS_IN_OVERHEAD        18
 471
 472 #define USB2_HS_SS_INTERRUPT_OUT_OVERHEAD      58
 473 #define USB2_HS_CS_INTERRUPT_OUT_OVERHEAD      36
 474 #define USB2_HS_SS_INTERRUPT_IN_OVERHEAD       39
 475 #define USB2_HS_CS_INTERRUPT_IN_OVERHEAD       38
 476
 477 #define USB2_HS_SS_ISOCHRONOUS_OUT_OVERHEAD    58
 478 #define USB2_HS_SS_ISOCHRONOUS_IN_OVERHEAD     39
 479 #define USB2_HS_CS_ISOCHRONOUS_IN_OVERHEAD     38
 480
 481 typedef union _USB2_TT_ENDPOINT_PARAMS {
 482   struct {
 483     ULONG TransferType           : 4;
 484     ULONG Direction              : 1;
 485     USB_DEVICE_SPEED DeviceSpeed : 2;
 486     BOOL EndpointMoved           : 1;
 487     ULONG Reserved               : 24;
 488   };
 489   ULONG AsULONG;
 490 } USB2_TT_ENDPOINT_PARAMS;
 491
 492 C_ASSERT(sizeof(USB2_TT_ENDPOINT_PARAMS) == sizeof(ULONG));
 493
 494 typedef union _USB2_TT_ENDPOINT_NUMS {
 495   struct {
 496     ULONG NumStarts     : 4;
 497     ULONG NumCompletes  : 4;
 498     ULONG Reserved      : 24;
 499   };
 500   ULONG AsULONG;
 501 } USB2_TT_ENDPOINT_NUMS;
 502
 503 C_ASSERT(sizeof(USB2_TT_ENDPOINT_NUMS) == sizeof(ULONG));
 504
 505 typedef struct _USB2_TT_ENDPOINT {
 506   PUSB2_TT Tt;
 507   PUSBPORT_ENDPOINT Endpoint;
 508   struct _USB2_TT_ENDPOINT * NextTtEndpoint;
 509   USB2_TT_ENDPOINT_PARAMS TtEndpointParams;
 510   USB2_TT_ENDPOINT_NUMS Nums;
 511   USHORT MaxPacketSize;
 512   USHORT PreviosPeriod;
 513   USHORT Period;
 514   USHORT ActualPeriod;
 515   USHORT CalcBusTime;
 516   USHORT StartTime;
 517   USHORT Reserved2;
 518   UCHAR StartFrame;
 519   UCHAR StartMicroframe;
 520 } USB2_TT_ENDPOINT, *PUSB2_TT_ENDPOINT;
 521
 522 typedef struct _USB2_FRAME_BUDGET {
 523   PUSB2_TT_ENDPOINT IsoEndpoint;
 524   PUSB2_TT_ENDPOINT IntEndpoint;
 525   PUSB2_TT_ENDPOINT AltEndpoint;
 526   USHORT TimeUsed;
 527   USHORT Reserved2;
 528 } USB2_FRAME_BUDGET, *PUSB2_FRAME_BUDGET;
 529
 530 typedef struct _USB2_TT {
 531   PUSB2_HC_EXTENSION HcExtension;
 532   ULONG DelayTime;
 533   ULONG MaxTime;
 534   USB2_TT_ENDPOINT IntEndpoint[USB2_FRAMES];
 535   USB2_TT_ENDPOINT IsoEndpoint[USB2_FRAMES];
 536   USB2_FRAME_BUDGET FrameBudget[USB2_FRAMES];
 537   ULONG NumStartSplits[USB2_FRAMES][USB2_MICROFRAMES];
 538   ULONG TimeCS[USB2_FRAMES][USB2_MICROFRAMES];
 539 } USB2_TT, *PUSB2_TT;
 540
 541 #define USB2_TT_EXTENSION_FLAG_DELETED  1
 542
 543 typedef struct _USB2_TT_EXTENSION {
 544   PDEVICE_OBJECT RootHubPdo;
 545   ULONG Flags;
 546   ULONG BusBandwidth;
 547   ULONG Bandwidth[USB2_FRAMES];
 548   ULONG MaxBandwidth;
 549   ULONG MinBandwidth;
 550   USHORT DeviceAddress;
 551   USHORT TtNumber;
 552   LIST_ENTRY EndpointList;
 553   LIST_ENTRY Link;
 554   USB2_TT Tt;
 555 } USB2_TT_EXTENSION, *PUSB2_TT_EXTENSION;
 556
 557 typedef struct _USB2_HC_EXTENSION {
 558   ULONG MaxHsBusAllocation;
 559   ULONG HcDelayTime;
 560   ULONG TimeUsed[USB2_FRAMES][USB2_MICROFRAMES];
 561   USB2_TT HcTt;
 562 } USB2_HC_EXTENSION, *PUSB2_HC_EXTENSION;
 563
 564 typedef struct _USB2_REBALANCE {
 565   PUSB2_TT_ENDPOINT RebalanceEndpoint[USB2_FRAMES - 2];
 566 } USB2_REBALANCE, *PUSB2_REBALANCE;
 567
 568 /* usbport.c */
 569 NTSTATUS
 570 NTAPI
 571 USBPORT_USBDStatusToNtStatus(
 572   IN PURB Urb,
 573   IN USBD_STATUS USBDStatus);
 574
 575 NTSTATUS
 576 NTAPI
 577 USBPORT_Wait(
 578   IN PVOID MiniPortExtension,
 579   IN ULONG Milliseconds);
 580
 581 VOID
 582 NTAPI
 583 USBPORT_TransferFlushDpc(
 584   IN PRKDPC Dpc,
 585   IN PVOID DeferredContext,
 586   IN PVOID SystemArgument1,
 587   IN PVOID SystemArgument2);
 588
 589 NTSTATUS
 590 NTAPI
 591 USBPORT_CreateWorkerThread(
 592   IN PDEVICE_OBJECT FdoDevice);
 593
 594 BOOLEAN
 595 NTAPI
 596 USBPORT_StartTimer(
 597   IN PDEVICE_OBJECT FdoDevice,
 598   IN ULONG Time);
 599
 600 PUSBPORT_COMMON_BUFFER_HEADER
 601 NTAPI
 602 USBPORT_AllocateCommonBuffer(
 603   IN PDEVICE_OBJECT FdoDevice,
 604   IN SIZE_T BufferLength);
 605
 606 VOID
 607 NTAPI
 608 USBPORT_FreeCommonBuffer(
 609   IN PDEVICE_OBJECT FdoDevice,
 610   IN PUSBPORT_COMMON_BUFFER_HEADER HeaderBuffer);
 611
 612 USBD_STATUS
 613 NTAPI
 614 USBPORT_AllocateTransfer(
 615   IN PDEVICE_OBJECT FdoDevice,
 616   IN PURB Urb,
 617   IN PUSBPORT_DEVICE_HANDLE DeviceHandle,
 618   IN PIRP Irp,
 619   IN PRKEVENT Event);
 620
 621 VOID
 622 NTAPI
 623 USBPORT_FlushMapTransfers(
 624   IN PDEVICE_OBJECT FdoDevice);
 625
 626 VOID
 627 NTAPI
 628 USBPORT_IsrDpc(
 629   IN PRKDPC Dpc,
 630   IN PVOID DeferredContext,
 631   IN PVOID SystemArgument1,
 632   IN PVOID SystemArgument2);
 633
 634 BOOLEAN
 635 NTAPI
 636 USBPORT_InterruptService(
 637   IN PKINTERRUPT Interrupt,
 638   IN PVOID ServiceContext);
 639
 640 VOID
 641 NTAPI
 642 USBPORT_SignalWorkerThread(
 643   IN PDEVICE_OBJECT FdoDevice);
 644
 645 VOID
 646 NTAPI
 647 USBPORT_CompleteTransfer(
 648   IN PURB Urb,
 649   IN USBD_STATUS TransferStatus);
 650
 651 VOID
 652 NTAPI
 653 USBPORT_DpcHandler(
 654   IN PDEVICE_OBJECT FdoDevice);
 655
 656 VOID
 657 NTAPI
 658 USBPORT_WorkerRequestDpc(
 659   IN PRKDPC Dpc,
 660   IN PVOID DeferredContext,
 661   IN PVOID SystemArgument1,
 662   IN PVOID SystemArgument2);
 663
 664 BOOLEAN
 665 NTAPI
 666 USBPORT_QueueDoneTransfer(
 667   IN PUSBPORT_TRANSFER Transfer,
 668   IN USBD_STATUS USBDStatus);
 669
 670 VOID
 671 NTAPI
 672 USBPORT_MiniportInterrupts(
 673   IN PDEVICE_OBJECT FdoDevice,
 674   IN BOOLEAN IsEnable);
 675
 676 NTSTATUS
 677 NTAPI
 678 USBPORT_SetRegistryKeyValue(
 679   IN PDEVICE_OBJECT DeviceObject,
 680   IN BOOL UseDriverKey,
 681   IN ULONG Type,
 682   IN PCWSTR ValueNameString,
 683   IN PVOID Data,
 684   IN ULONG DataSize);
 685
 686 NTSTATUS
 687 NTAPI
 688 USBPORT_GetRegistryKeyValueFullInfo(
 689   IN PDEVICE_OBJECT FdoDevice,
 690   IN PDEVICE_OBJECT PdoDevice,
 691   IN BOOL UseDriverKey,
 692   IN PCWSTR SourceString,
 693   IN ULONG LengthStr,
 694   IN PVOID Buffer,
 695   IN ULONG NumberOfBytes);
 696
 697 VOID
 698 NTAPI
 699 USBPORT_AddUSB1Fdo(
 700   IN PDEVICE_OBJECT FdoDevice);
 701
 702 VOID
 703 NTAPI
 704 USBPORT_AddUSB2Fdo(
 705   IN PDEVICE_OBJECT FdoDevice);
 706
 707 VOID
 708 NTAPI
 709 USBPORT_RemoveUSBxFdo(
 710   IN PDEVICE_OBJECT FdoDevice);
 711
 712 PDEVICE_OBJECT
 713 NTAPI
 714 USBPORT_FindUSB2Controller(
 715   IN PDEVICE_OBJECT FdoDevice);
 716
 717 PDEVICE_RELATIONS
 718 NTAPI
 719 USBPORT_FindCompanionControllers(
 720   IN PDEVICE_OBJECT USB2FdoDevice,
 721   IN BOOLEAN IsObRefer,
 722   IN BOOLEAN IsFDOsReturned);
 723
 724 VOID
 725 NTAPI
 726 USBPORT_InvalidateControllerHandler(
 727   IN PDEVICE_OBJECT FdoDevice,
 728   IN ULONG Type);
 729
 730 VOID
 731 NTAPI
 732 USBPORT_DoneTransfer(
 733   IN PUSBPORT_TRANSFER Transfer);
 734
 735 /* debug.c */
 736 ULONG
 737 NTAPI
 738 USBPORT_DbgPrint(
 739   IN PVOID MiniPortExtension,
 740   IN ULONG Level,
 741   IN PCH Format,
 742   ...);
 743
 744 ULONG
 745 NTAPI
 746 USBPORT_TestDebugBreak(
 747   IN PVOID MiniPortExtension);
 748
 749 ULONG
 750 NTAPI
 751 USBPORT_AssertFailure(
 752   PVOID MiniPortExtension,
 753   PVOID FailedAssertion,
 754   PVOID FileName,
 755   ULONG LineNumber,
 756   PCHAR Message);
 757
 758 VOID
 759 NTAPI
 760 USBPORT_BugCheck(
 761   IN PVOID MiniPortExtension);
 762
 763 ULONG
 764 NTAPI
 765 USBPORT_LogEntry(
 766   IN PVOID MiniPortExtension,
 767   IN ULONG DriverTag,
 768   IN ULONG EnumTag,
 769   IN ULONG P1,
 770   IN ULONG P2,
 771   IN ULONG P3);
 772
 773 VOID
 774 NTAPI
 775 USBPORT_DumpingDeviceDescriptor(
 776   IN PUSB_DEVICE_DESCRIPTOR DeviceDescriptor);
 777
 778 VOID
 779 NTAPI
 780 USBPORT_DumpingConfiguration(
 781   IN PUSB_CONFIGURATION_DESCRIPTOR ConfigDescriptor);
 782
 783 VOID
 784 NTAPI
 785 USBPORT_DumpingCapabilities(
 786   IN PDEVICE_CAPABILITIES Capabilities);
 787
 788 VOID
 789 NTAPI
 790 USBPORT_DumpingSetupPacket(
 791   IN PUSB_DEFAULT_PIPE_SETUP_PACKET SetupPacket);
 792
 793 VOID
 794 NTAPI
 795 USBPORT_DumpingURB(
 796   IN PURB Urb);
 797
 798 VOID
 799 NTAPI
 800 USBPORT_DumpingIDs(
 801   IN PVOID Buffer);
 802
 803 /* device.c */
 804 NTSTATUS
 805 NTAPI
 806 USBPORT_HandleSelectConfiguration(
 807   IN PDEVICE_OBJECT FdoDevice,
 808   IN PIRP Irp,
 809   IN PURB Urb);
 810
 811 VOID
 812 NTAPI
 813 USBPORT_AddDeviceHandle(
 814   IN PDEVICE_OBJECT FdoDevice,
 815   IN PUSBPORT_DEVICE_HANDLE DeviceHandle);
 816
 817 VOID
 818 NTAPI
 819 USBPORT_RemoveDeviceHandle(
 820   IN PDEVICE_OBJECT FdoDevice,
 821   IN PUSBPORT_DEVICE_HANDLE DeviceHandle);
 822
 823 BOOLEAN
 824 NTAPI
 825 USBPORT_ValidateDeviceHandle(
 826   IN PDEVICE_OBJECT FdoDevice,
 827   IN PUSBPORT_DEVICE_HANDLE DeviceHandle);
 828
 829 NTSTATUS
 830 NTAPI
 831 USBPORT_CreateDevice(
 832   IN OUT PUSB_DEVICE_HANDLE *pUsbdDeviceHandle,
 833   IN PDEVICE_OBJECT FdoDevice,
 834   IN PUSBPORT_DEVICE_HANDLE HubDeviceHandle,
 835   IN USHORT PortStatus,
 836   IN USHORT Port);
 837
 838 NTSTATUS
 839 NTAPI
 840 USBPORT_InitializeDevice(
 841   IN PUSBPORT_DEVICE_HANDLE DeviceHandle,
 842   IN PDEVICE_OBJECT FdoDevice);
 843
 844 NTSTATUS
 845 NTAPI
 846 USBPORT_GetUsbDescriptor(
 847   IN PUSBPORT_DEVICE_HANDLE DeviceHandle,
 848   IN PDEVICE_OBJECT FdoDevice,
 849   IN UCHAR Type,
 850   IN PUCHAR ConfigDesc,
 851   IN PULONG ConfigDescSize);
 852
 853 NTSTATUS
 854 NTAPI
 855 USBPORT_HandleSelectInterface(
 856   IN PDEVICE_OBJECT FdoDevice,
 857   IN PIRP Irp,
 858   IN PURB Urb);
 859
 860 NTSTATUS
 861 NTAPI
 862 USBPORT_RemoveDevice(
 863   IN PDEVICE_OBJECT FdoDevice,
 864   IN OUT PUSBPORT_DEVICE_HANDLE DeviceHandle,
 865   IN ULONG Flags);
 866
 867 NTSTATUS
 868 NTAPI
 869 USBPORT_SendSetupPacket(
 870   IN PUSBPORT_DEVICE_HANDLE DeviceHandle,
 871   IN PDEVICE_OBJECT FdoDevice,
 872   IN PUSB_DEFAULT_PIPE_SETUP_PACKET SetupPacket,
 873   IN PVOID Buffer,
 874   IN ULONG Length,
 875   IN OUT PULONG TransferedLen,
 876   IN OUT PUSBD_STATUS pUSBDStatus);
 877
 878 NTSTATUS
 879 NTAPI
 880 USBPORT_RestoreDevice(
 881   IN PDEVICE_OBJECT FdoDevice,
 882   IN OUT PUSBPORT_DEVICE_HANDLE OldDeviceHandle,
 883   IN OUT PUSBPORT_DEVICE_HANDLE NewDeviceHandle);
 884
 885 NTSTATUS
 886 NTAPI
 887 USBPORT_Initialize20Hub(
 888   IN PDEVICE_OBJECT FdoDevice,
 889   IN PUSBPORT_DEVICE_HANDLE HubDeviceHandle,
 890   IN ULONG TtCount);
 891
 892 /* endpoint.c */
 893 NTSTATUS
 894 NTAPI
 895 USBPORT_OpenPipe(
 896   IN PDEVICE_OBJECT FdoDevice,
 897   IN PUSBPORT_DEVICE_HANDLE DeviceHandle,
 898   IN PUSBPORT_PIPE_HANDLE PipeHandle,
 899   IN PUSBD_STATUS UsbdStatus);
 900
 901 MPSTATUS
 902 NTAPI
 903 MiniportOpenEndpoint(
 904   IN PDEVICE_OBJECT FdoDevice,
 905   IN PUSBPORT_ENDPOINT Endpoint);
 906
 907 NTSTATUS
 908 NTAPI
 909 USBPORT_ReopenPipe(
 910   IN PDEVICE_OBJECT FdoDevice,
 911   IN PUSBPORT_ENDPOINT Endpoint);
 912
 913 VOID
 914 NTAPI
 915 USBPORT_ClosePipe(
 916   IN PUSBPORT_DEVICE_HANDLE DeviceHandle,
 917   IN PDEVICE_OBJECT FdoDevice,
 918   IN PUSBPORT_PIPE_HANDLE PipeHandle);
 919
 920 VOID
 921 NTAPI
 922 MiniportCloseEndpoint(
 923   IN PDEVICE_OBJECT FdoDevice,
 924   IN PUSBPORT_ENDPOINT Endpoint);
 925
 926 VOID
 927 NTAPI
 928 USBPORT_AddPipeHandle(
 929   IN PUSBPORT_DEVICE_HANDLE DeviceHandle,
 930   IN PUSBPORT_PIPE_HANDLE PipeHandle);
 931
 932 VOID
 933 NTAPI
 934 USBPORT_RemovePipeHandle(
 935   IN PUSBPORT_DEVICE_HANDLE DeviceHandle,
 936   IN PUSBPORT_PIPE_HANDLE PipeHandle);
 937
 938 BOOLEAN
 939 NTAPI
 940 USBPORT_ValidatePipeHandle(
 941   IN PUSBPORT_DEVICE_HANDLE DeviceHandle,
 942   IN PUSBPORT_PIPE_HANDLE PipeHandle);
 943
 944 VOID
 945 NTAPI
 946 USBPORT_FlushClosedEndpointList(
 947   IN PDEVICE_OBJECT FdoDevice);
 948
 949 VOID
 950 NTAPI
 951 USBPORT_SetEndpointState(
 952   IN PUSBPORT_ENDPOINT Endpoint,
 953   IN ULONG State);
 954
 955 ULONG
 956 NTAPI
 957 USBPORT_GetEndpointState(
 958   IN PUSBPORT_ENDPOINT Endpoint);
 959
 960 VOID
 961 NTAPI
 962 USBPORT_InvalidateEndpointHandler(
 963   IN PDEVICE_OBJECT FdoDevice,
 964   IN PUSBPORT_ENDPOINT Endpoint,
 965   IN ULONG Type);
 966
 967 BOOLEAN
 968 NTAPI
 969 USBPORT_EndpointWorker(
 970   IN PUSBPORT_ENDPOINT Endpoint,
 971   IN BOOLEAN Flag);
 972
 973 VOID
 974 NTAPI
 975 USBPORT_NukeAllEndpoints(
 976   IN PDEVICE_OBJECT FdoDevice);
 977
 978 BOOLEAN
 979 NTAPI
 980 USBPORT_EndpointHasQueuedTransfers(
 981   IN PDEVICE_OBJECT FdoDevice,
 982   IN PUSBPORT_ENDPOINT Endpoint,
 983   IN PULONG TransferCount);
 984
 985 /* iface.c */
 986 NTSTATUS
 987 NTAPI
 988 USBPORT_PdoQueryInterface(
 989   IN PDEVICE_OBJECT FdoDevice,
 990   IN PDEVICE_OBJECT PdoDevice,
 991   IN PIRP Irp);
 992
 993 /* ioctl.c */
 994 NTSTATUS
 995 NTAPI
 996 USBPORT_PdoDeviceControl(
 997   PDEVICE_OBJECT PdoDevice,
 998   PIRP Irp);
 999
1000 NTSTATUS
1001 NTAPI
1002 USBPORT_FdoDeviceControl(
1003   PDEVICE_OBJECT FdoDevice,
1004   PIRP Irp);
1005
1006 NTSTATUS
1007 NTAPI
1008 USBPORT_FdoInternalDeviceControl(
1009   IN PDEVICE_OBJECT FdoDevice,
1010   IN PIRP Irp);
1011
1012 NTSTATUS
1013 NTAPI
1014 USBPORT_PdoInternalDeviceControl(
1015   IN PDEVICE_OBJECT FdoDevice,
1016   IN PIRP Irp);
1017
1018 NTSTATUS
1019 NTAPI
1020 USBPORT_GetSymbolicName(
1021   IN PDEVICE_OBJECT RootHubPdo,
1022   IN PUNICODE_STRING DestinationString);
1023
1024 /* iso.c */
1025 USBD_STATUS
1026 NTAPI
1027 USBPORT_InitializeIsoTransfer(
1028   IN PDEVICE_OBJECT FdoDevice,
1029   IN struct _URB_ISOCH_TRANSFER * Urb,
1030   IN PUSBPORT_TRANSFER Transfer);
1031
1032 ULONG
1033 NTAPI
1034 USBPORT_CompleteIsoTransfer(
1035   IN PVOID MiniPortExtension,
1036   IN PVOID MiniPortEndpoint,
1037   IN PVOID TransferParameters,
1038   IN ULONG TransferLength);
1039
1040 /* pnp.c */
1041 NTSTATUS
1042 NTAPI
1043 USBPORT_FdoPnP(
1044   IN PDEVICE_OBJECT FdoDevice,
1045   IN PIRP Irp);
1046
1047 NTSTATUS
1048 NTAPI
1049 USBPORT_PdoPnP(
1050   IN PDEVICE_OBJECT FdoDevice,
1051   IN PIRP Irp);
1052
1053 /* power.c */
1054 NTSTATUS
1055 NTAPI
1056 USBPORT_PdoPower(
1057   IN PDEVICE_OBJECT PdoDevice,
1058   IN PIRP Irp);
1059
1060 NTSTATUS
1061 NTAPI
1062 USBPORT_FdoPower(
1063   IN PDEVICE_OBJECT FdoDevice,
1064   IN PIRP Irp);
1065
1066 NTSTATUS
1067 NTAPI
1068 USBPORT_IdleNotification(
1069   IN PDEVICE_OBJECT PdoDevice,
1070   IN PIRP Irp);
1071
1072 VOID
1073 NTAPI
1074 USBPORT_AdjustDeviceCapabilities(
1075   IN PDEVICE_OBJECT FdoDevice,
1076   IN PDEVICE_OBJECT PdoDevice);
1077
1078 VOID
1079 NTAPI
1080 USBPORT_DoIdleNotificationCallback(
1081   IN PVOID Context);
1082
1083 VOID
1084 NTAPI
1085 USBPORT_CompletePdoWaitWake(
1086   IN PDEVICE_OBJECT FdoDevice);
1087
1088 VOID
1089 NTAPI
1090 USBPORT_DoSetPowerD0(
1091   IN PDEVICE_OBJECT FdoDevice);
1092
1093 VOID
1094 NTAPI
1095 USBPORT_HcWakeDpc(
1096   IN PRKDPC Dpc,
1097   IN PVOID DeferredContext,
1098   IN PVOID SystemArgument1,
1099   IN PVOID SystemArgument2);
1100
1101 VOID
1102 NTAPI
1103 USBPORT_HcQueueWakeDpc(
1104   IN PDEVICE_OBJECT FdoDevice);
1105
1106 /* queue.c */
1107 VOID
1108 NTAPI
1109 USBPORT_InsertIdleIrp(
1110   IN PIO_CSQ Csq,
1111   IN PIRP Irp);
1112
1113 VOID
1114 NTAPI
1115 USBPORT_RemoveIdleIrp(
1116   IN PIO_CSQ Csq,
1117   IN PIRP Irp);
1118
1119 PIRP
1120 NTAPI
1121 USBPORT_PeekNextIdleIrp(
1122   IN PIO_CSQ Csq,
1123   IN PIRP Irp,
1124   IN PVOID PeekContext);
1125
1126 VOID
1127 NTAPI
1128 USBPORT_AcquireIdleLock(
1129   IN PIO_CSQ Csq,
1130   IN PKIRQL Irql);
1131
1132 VOID
1133 NTAPI
1134 USBPORT_ReleaseIdleLock(
1135   IN PIO_CSQ Csq,
1136   IN KIRQL Irql);
1137
1138 VOID
1139 NTAPI
1140 USBPORT_CompleteCanceledIdleIrp(
1141   IN PIO_CSQ Csq,
1142   IN PIRP Irp);
1143
1144 VOID
1145 NTAPI
1146 USBPORT_InsertBadRequest(
1147   IN PIO_CSQ Csq,
1148   IN PIRP Irp);
1149
1150 VOID
1151 NTAPI
1152 USBPORT_RemoveBadRequest(
1153   IN PIO_CSQ Csq,
1154   IN PIRP Irp);
1155
1156 PIRP
1157 NTAPI
1158 USBPORT_PeekNextBadRequest(
1159   IN PIO_CSQ Csq,
1160   IN PIRP Irp,
1161   IN PVOID PeekContext);
1162
1163 VOID
1164 NTAPI
1165 USBPORT_AcquireBadRequestLock(
1166   IN PIO_CSQ Csq,
1167   IN PKIRQL Irql);
1168
1169 VOID
1170 NTAPI
1171 USBPORT_ReleaseBadRequestLock(
1172   IN PIO_CSQ Csq,
1173   IN KIRQL Irql);
1174
1175 VOID
1176 NTAPI
1177 USBPORT_CompleteCanceledBadRequest(
1178   IN PIO_CSQ Csq,
1179   IN PIRP Irp);
1180
1181 VOID
1182 NTAPI
1183 USBPORT_InsertIrpInTable(
1184   IN PUSBPORT_IRP_TABLE IrpTable,
1185   IN PIRP Irp);
1186
1187 PIRP
1188 NTAPI
1189 USBPORT_RemovePendingTransferIrp(
1190   IN PDEVICE_OBJECT FdoDevice,
1191   IN PIRP Irp);
1192
1193 PIRP
1194 NTAPI
1195 USBPORT_RemoveActiveTransferIrp(
1196   IN PDEVICE_OBJECT FdoDevice,
1197   IN PIRP Irp);
1198
1199 VOID
1200 NTAPI
1201 USBPORT_FindUrbInIrpTable(
1202   IN PUSBPORT_IRP_TABLE IrpTable,
1203   IN PURB Urb,
1204   IN PIRP Irp);
1205
1206 VOID
1207 NTAPI
1208 USBPORT_CancelActiveTransferIrp(
1209   IN PDEVICE_OBJECT DeviceObject,
1210   IN PIRP Irp);
1211
1212 VOID
1213 NTAPI
1214 USBPORT_FlushAbortList(
1215   IN PUSBPORT_ENDPOINT Endpoint);
1216
1217 VOID
1218 NTAPI
1219 USBPORT_FlushCancelList(
1220   IN PUSBPORT_ENDPOINT Endpoint);
1221
1222 VOID
1223 NTAPI
1224 USBPORT_QueueTransferUrb(
1225   IN PURB Urb);
1226
1227 VOID
1228 NTAPI
1229 USBPORT_FlushAllEndpoints(
1230   IN PDEVICE_OBJECT FdoDevice);
1231
1232 VOID
1233 NTAPI
1234 USBPORT_FlushPendingTransfers(
1235   IN PUSBPORT_ENDPOINT Endpoint);
1236
1237 BOOLEAN
1238 NTAPI
1239 USBPORT_QueueActiveUrbToEndpoint(
1240   IN PUSBPORT_ENDPOINT Endpoint,
1241   IN PURB Urb);
1242
1243 VOID
1244 NTAPI
1245 USBPORT_FlushController(
1246   IN PDEVICE_OBJECT FdoDevice);
1247
1248 VOID
1249 NTAPI
1250 USBPORT_BadRequestFlush(
1251   IN PDEVICE_OBJECT FdoDevice);
1252
1253 VOID
1254 NTAPI
1255 USBPORT_AbortEndpoint(
1256   IN PDEVICE_OBJECT FdoDevice,
1257   IN PUSBPORT_ENDPOINT Endpoint,
1258   IN PIRP Irp);
1259
1260 /* roothub.c */
1261 VOID
1262 NTAPI
1263 USBPORT_RootHubEndpointWorker(
1264   PUSBPORT_ENDPOINT Endpoint);
1265
1266 NTSTATUS
1267 NTAPI
1268 USBPORT_RootHubCreateDevice(
1269   IN PDEVICE_OBJECT FdoDevice,
1270   IN PDEVICE_OBJECT PdoDevice);
1271
1272 ULONG
1273 NTAPI
1274 USBPORT_InvalidateRootHub(
1275   PVOID MiniPortExtension);
1276
1277 VOID
1278 NTAPI
1279 USBPORT_RootHubPowerAndChirpAllCcPorts(
1280   IN PDEVICE_OBJECT FdoDevice);
1281
1282 /* trfsplit.c */
1283 VOID
1284 NTAPI
1285 USBPORT_SplitTransfer(
1286   IN PDEVICE_OBJECT FdoDevice,
1287   IN PUSBPORT_ENDPOINT Endpoint,
1288   IN PUSBPORT_TRANSFER Transfer,
1289   IN PLIST_ENTRY List);
1290
1291 VOID
1292 NTAPI
1293 USBPORT_DoneSplitTransfer(
1294   IN PUSBPORT_TRANSFER SplitTransfer);
1295
1296 VOID
1297 NTAPI
1298 USBPORT_CancelSplitTransfer(
1299   IN PUSBPORT_TRANSFER SplitTransfer);
1300
1301 /* urb.c */
1302 NTSTATUS
1303 NTAPI
1304 USBPORT_HandleSubmitURB(
1305   IN PDEVICE_OBJECT PdoDevice,
1306   IN PIRP Irp,
1307   IN PURB Urb);
1308
1309 /* usb2.c */
1310 BOOLEAN
1311 NTAPI
1312 USBPORT_AllocateBandwidthUSB2(
1313   IN PDEVICE_OBJECT FdoDevice,
1314   IN PUSBPORT_ENDPOINT Endpoint);
1315
1316 VOID
1317 NTAPI
1318 USBPORT_FreeBandwidthUSB2(
1319   IN PDEVICE_OBJECT FdoDevice,
1320   IN PUSBPORT_ENDPOINT Endpoint);
1321
1322 VOID
1323 NTAPI
1324 USBPORT_UpdateAllocatedBwTt(
1325   IN PUSB2_TT_EXTENSION TtExtension);
1326
1327 VOID
1328 NTAPI
1329 USB2_InitTT(
1330   IN PUSB2_HC_EXTENSION HcExtension,
1331   IN PUSB2_TT Tt);
1332
1333 VOID
1334 NTAPI
1335 USB2_InitController(
1336   IN PUSB2_HC_EXTENSION HcExtension);
1337
1338 VOID
1339 NTAPI
1340 USBPORT_DumpingEndpointProperties(
1341   IN PUSBPORT_ENDPOINT_PROPERTIES EndpointProperties);
1342
1343 VOID
1344 NTAPI
1345 USBPORT_DumpingTtEndpoint(
1346   IN PUSB2_TT_ENDPOINT TtEndpoint);
1347
1348 #endif /* USBPORT_H__ */