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 typedef union _USB2_TT_ENDPOINT_PARAMS {
 473   struct {
 474     ULONG TransferType           : 4;
 475     ULONG Direction              : 1;
 476     USB_DEVICE_SPEED DeviceSpeed : 2;
 477     ULONG EndpointMoved          : 1;
 478     ULONG Reserved               : 24;
 479   };
 480   ULONG AsULONG;
 481 } USB2_TT_ENDPOINT_PARAMS;
 482
 483 C_ASSERT(sizeof(USB2_TT_ENDPOINT_PARAMS) == sizeof(ULONG));
 484
 485 typedef union _USB2_TT_ENDPOINT_NUMS {
 486   struct {
 487     ULONG NumStarts     : 4;
 488     ULONG NumCompletes  : 4;
 489     ULONG Reserved      : 24;
 490   };
 491   ULONG AsULONG;
 492 } USB2_TT_ENDPOINT_NUMS;
 493
 494 C_ASSERT(sizeof(USB2_TT_ENDPOINT_NUMS) == sizeof(ULONG));
 495
 496 typedef struct _USB2_TT_ENDPOINT {
 497   PUSB2_TT Tt;
 498   PUSBPORT_ENDPOINT Endpoint;
 499   struct _USB2_TT_ENDPOINT * NextTtEndpoint;
 500   USB2_TT_ENDPOINT_PARAMS TtEndpointParams;
 501   USB2_TT_ENDPOINT_NUMS Nums;
 502   USHORT MaxPacketSize;
 503   USHORT PreviosPeriod;
 504   USHORT Period;
 505   USHORT ActualPeriod;
 506   USHORT CalcBusTime;
 507   USHORT StartTime;
 508   USHORT Reserved2;
 509   UCHAR StartFrame;
 510   UCHAR StartMicroframe;
 511 } USB2_TT_ENDPOINT, *PUSB2_TT_ENDPOINT;
 512
 513 typedef struct _USB2_FRAME_BUDGET {
 514   PUSB2_TT_ENDPOINT IsoEndpoint;
 515   PUSB2_TT_ENDPOINT IntEndpoint;
 516   PUSB2_TT_ENDPOINT AltEndpoint;
 517   USHORT TimeUsed;
 518   USHORT Reserved2;
 519 } USB2_FRAME_BUDGET, *PUSB2_FRAME_BUDGET;
 520
 521 typedef struct _USB2_TT {
 522   PUSB2_HC_EXTENSION HcExtension;
 523   ULONG DelayTime;
 524   ULONG MaxTime;
 525   USB2_TT_ENDPOINT IntEndpoint[USB2_FRAMES];
 526   USB2_TT_ENDPOINT IsoEndpoint[USB2_FRAMES];
 527   USB2_FRAME_BUDGET FrameBudget[USB2_FRAMES];
 528   ULONG NumStartSplits[USB2_FRAMES][USB2_MICROFRAMES];
 529   ULONG TimeCS[USB2_FRAMES][USB2_MICROFRAMES];
 530 } USB2_TT, *PUSB2_TT;
 531
 532 #define USB2_TT_EXTENSION_FLAG_DELETED  1
 533
 534 typedef struct _USB2_TT_EXTENSION {
 535   PDEVICE_OBJECT RootHubPdo;
 536   ULONG Flags;
 537   ULONG BusBandwidth;
 538   ULONG Bandwidth[USB2_FRAMES];
 539   ULONG MaxBandwidth;
 540   ULONG MinBandwidth;
 541   USHORT DeviceAddress;
 542   USHORT TtNumber;
 543   LIST_ENTRY EndpointList;
 544   LIST_ENTRY Link;
 545   USB2_TT Tt;
 546 } USB2_TT_EXTENSION, *PUSB2_TT_EXTENSION;
 547
 548 typedef struct _USB2_HC_EXTENSION {
 549   ULONG MaxHsBusAllocation;
 550   ULONG HcDelayTime;
 551   ULONG TimeUsed[USB2_FRAMES][USB2_MICROFRAMES];
 552   USB2_TT HcTt;
 553 } USB2_HC_EXTENSION, *PUSB2_HC_EXTENSION;
 554
 555 typedef struct _USB2_REBALANCE {
 556   PUSB2_TT_ENDPOINT RebalanceEndpoint[USB2_FRAMES - 2];
 557 } USB2_REBALANCE, *PUSB2_REBALANCE;
 558
 559 /* usbport.c */
 560 NTSTATUS
 561 NTAPI
 562 USBPORT_USBDStatusToNtStatus(
 563   IN PURB Urb,
 564   IN USBD_STATUS USBDStatus);
 565
 566 NTSTATUS
 567 NTAPI
 568 USBPORT_Wait(
 569   IN PVOID MiniPortExtension,
 570   IN ULONG Milliseconds);
 571
 572 VOID
 573 NTAPI
 574 USBPORT_TransferFlushDpc(
 575   IN PRKDPC Dpc,
 576   IN PVOID DeferredContext,
 577   IN PVOID SystemArgument1,
 578   IN PVOID SystemArgument2);
 579
 580 NTSTATUS
 581 NTAPI
 582 USBPORT_CreateWorkerThread(
 583   IN PDEVICE_OBJECT FdoDevice);
 584
 585 BOOLEAN
 586 NTAPI
 587 USBPORT_StartTimer(
 588   IN PDEVICE_OBJECT FdoDevice,
 589   IN ULONG Time);
 590
 591 PUSBPORT_COMMON_BUFFER_HEADER
 592 NTAPI
 593 USBPORT_AllocateCommonBuffer(
 594   IN PDEVICE_OBJECT FdoDevice,
 595   IN SIZE_T BufferLength);
 596
 597 VOID
 598 NTAPI
 599 USBPORT_FreeCommonBuffer(
 600   IN PDEVICE_OBJECT FdoDevice,
 601   IN PUSBPORT_COMMON_BUFFER_HEADER HeaderBuffer);
 602
 603 USBD_STATUS
 604 NTAPI
 605 USBPORT_AllocateTransfer(
 606   IN PDEVICE_OBJECT FdoDevice,
 607   IN PURB Urb,
 608   IN PUSBPORT_DEVICE_HANDLE DeviceHandle,
 609   IN PIRP Irp,
 610   IN PRKEVENT Event);
 611
 612 VOID
 613 NTAPI
 614 USBPORT_FlushMapTransfers(
 615   IN PDEVICE_OBJECT FdoDevice);
 616
 617 VOID
 618 NTAPI
 619 USBPORT_IsrDpc(
 620   IN PRKDPC Dpc,
 621   IN PVOID DeferredContext,
 622   IN PVOID SystemArgument1,
 623   IN PVOID SystemArgument2);
 624
 625 BOOLEAN
 626 NTAPI
 627 USBPORT_InterruptService(
 628   IN PKINTERRUPT Interrupt,
 629   IN PVOID ServiceContext);
 630
 631 VOID
 632 NTAPI
 633 USBPORT_SignalWorkerThread(
 634   IN PDEVICE_OBJECT FdoDevice);
 635
 636 VOID
 637 NTAPI
 638 USBPORT_CompleteTransfer(
 639   IN PURB Urb,
 640   IN USBD_STATUS TransferStatus);
 641
 642 VOID
 643 NTAPI
 644 USBPORT_DpcHandler(
 645   IN PDEVICE_OBJECT FdoDevice);
 646
 647 VOID
 648 NTAPI
 649 USBPORT_WorkerRequestDpc(
 650   IN PRKDPC Dpc,
 651   IN PVOID DeferredContext,
 652   IN PVOID SystemArgument1,
 653   IN PVOID SystemArgument2);
 654
 655 BOOLEAN
 656 NTAPI
 657 USBPORT_QueueDoneTransfer(
 658   IN PUSBPORT_TRANSFER Transfer,
 659   IN USBD_STATUS USBDStatus);
 660
 661 VOID
 662 NTAPI
 663 USBPORT_MiniportInterrupts(
 664   IN PDEVICE_OBJECT FdoDevice,
 665   IN BOOLEAN IsEnable);
 666
 667 NTSTATUS
 668 NTAPI
 669 USBPORT_SetRegistryKeyValue(
 670   IN PDEVICE_OBJECT DeviceObject,
 671   IN BOOL UseDriverKey,
 672   IN ULONG Type,
 673   IN PCWSTR ValueNameString,
 674   IN PVOID Data,
 675   IN ULONG DataSize);
 676
 677 NTSTATUS
 678 NTAPI
 679 USBPORT_GetRegistryKeyValueFullInfo(
 680   IN PDEVICE_OBJECT FdoDevice,
 681   IN PDEVICE_OBJECT PdoDevice,
 682   IN BOOL UseDriverKey,
 683   IN PCWSTR SourceString,
 684   IN ULONG LengthStr,
 685   IN PVOID Buffer,
 686   IN ULONG NumberOfBytes);
 687
 688 VOID
 689 NTAPI
 690 USBPORT_AddUSB1Fdo(
 691   IN PDEVICE_OBJECT FdoDevice);
 692
 693 VOID
 694 NTAPI
 695 USBPORT_AddUSB2Fdo(
 696   IN PDEVICE_OBJECT FdoDevice);
 697
 698 VOID
 699 NTAPI
 700 USBPORT_RemoveUSBxFdo(
 701   IN PDEVICE_OBJECT FdoDevice);
 702
 703 PDEVICE_OBJECT
 704 NTAPI
 705 USBPORT_FindUSB2Controller(
 706   IN PDEVICE_OBJECT FdoDevice);
 707
 708 PDEVICE_RELATIONS
 709 NTAPI
 710 USBPORT_FindCompanionControllers(
 711   IN PDEVICE_OBJECT USB2FdoDevice,
 712   IN BOOLEAN IsObRefer,
 713   IN BOOLEAN IsFDOsReturned);
 714
 715 VOID
 716 NTAPI
 717 USBPORT_InvalidateControllerHandler(
 718   IN PDEVICE_OBJECT FdoDevice,
 719   IN ULONG Type);
 720
 721 VOID
 722 NTAPI
 723 USBPORT_DoneTransfer(
 724   IN PUSBPORT_TRANSFER Transfer);
 725
 726 /* debug.c */
 727 ULONG
 728 NTAPI
 729 USBPORT_DbgPrint(
 730   IN PVOID MiniPortExtension,
 731   IN ULONG Level,
 732   IN PCH Format,
 733   ...);
 734
 735 ULONG
 736 NTAPI
 737 USBPORT_TestDebugBreak(
 738   IN PVOID MiniPortExtension);
 739
 740 ULONG
 741 NTAPI
 742 USBPORT_AssertFailure(
 743   PVOID MiniPortExtension,
 744   PVOID FailedAssertion,
 745   PVOID FileName,
 746   ULONG LineNumber,
 747   PCHAR Message);
 748
 749 VOID
 750 NTAPI
 751 USBPORT_BugCheck(
 752   IN PVOID MiniPortExtension);
 753
 754 ULONG
 755 NTAPI
 756 USBPORT_LogEntry(
 757   IN PVOID MiniPortExtension,
 758   IN ULONG DriverTag,
 759   IN ULONG EnumTag,
 760   IN ULONG P1,
 761   IN ULONG P2,
 762   IN ULONG P3);
 763
 764 VOID
 765 NTAPI
 766 USBPORT_DumpingDeviceDescriptor(
 767   IN PUSB_DEVICE_DESCRIPTOR DeviceDescriptor);
 768
 769 VOID
 770 NTAPI
 771 USBPORT_DumpingConfiguration(
 772   IN PUSB_CONFIGURATION_DESCRIPTOR ConfigDescriptor);
 773
 774 VOID
 775 NTAPI
 776 USBPORT_DumpingCapabilities(
 777   IN PDEVICE_CAPABILITIES Capabilities);
 778
 779 VOID
 780 NTAPI
 781 USBPORT_DumpingSetupPacket(
 782   IN PUSB_DEFAULT_PIPE_SETUP_PACKET SetupPacket);
 783
 784 VOID
 785 NTAPI
 786 USBPORT_DumpingURB(
 787   IN PURB Urb);
 788
 789 VOID
 790 NTAPI
 791 USBPORT_DumpingIDs(
 792   IN PVOID Buffer);
 793
 794 /* device.c */
 795 NTSTATUS
 796 NTAPI
 797 USBPORT_HandleSelectConfiguration(
 798   IN PDEVICE_OBJECT FdoDevice,
 799   IN PIRP Irp,
 800   IN PURB Urb);
 801
 802 VOID
 803 NTAPI
 804 USBPORT_AddDeviceHandle(
 805   IN PDEVICE_OBJECT FdoDevice,
 806   IN PUSBPORT_DEVICE_HANDLE DeviceHandle);
 807
 808 VOID
 809 NTAPI
 810 USBPORT_RemoveDeviceHandle(
 811   IN PDEVICE_OBJECT FdoDevice,
 812   IN PUSBPORT_DEVICE_HANDLE DeviceHandle);
 813
 814 BOOLEAN
 815 NTAPI
 816 USBPORT_ValidateDeviceHandle(
 817   IN PDEVICE_OBJECT FdoDevice,
 818   IN PUSBPORT_DEVICE_HANDLE DeviceHandle);
 819
 820 NTSTATUS
 821 NTAPI
 822 USBPORT_CreateDevice(
 823   IN OUT PUSB_DEVICE_HANDLE *pUsbdDeviceHandle,
 824   IN PDEVICE_OBJECT FdoDevice,
 825   IN PUSBPORT_DEVICE_HANDLE HubDeviceHandle,
 826   IN USHORT PortStatus,
 827   IN USHORT Port);
 828
 829 NTSTATUS
 830 NTAPI
 831 USBPORT_InitializeDevice(
 832   IN PUSBPORT_DEVICE_HANDLE DeviceHandle,
 833   IN PDEVICE_OBJECT FdoDevice);
 834
 835 NTSTATUS
 836 NTAPI
 837 USBPORT_GetUsbDescriptor(
 838   IN PUSBPORT_DEVICE_HANDLE DeviceHandle,
 839   IN PDEVICE_OBJECT FdoDevice,
 840   IN UCHAR Type,
 841   IN PUCHAR ConfigDesc,
 842   IN PULONG ConfigDescSize);
 843
 844 NTSTATUS
 845 NTAPI
 846 USBPORT_HandleSelectInterface(
 847   IN PDEVICE_OBJECT FdoDevice,
 848   IN PIRP Irp,
 849   IN PURB Urb);
 850
 851 NTSTATUS
 852 NTAPI
 853 USBPORT_RemoveDevice(
 854   IN PDEVICE_OBJECT FdoDevice,
 855   IN OUT PUSBPORT_DEVICE_HANDLE DeviceHandle,
 856   IN ULONG Flags);
 857
 858 NTSTATUS
 859 NTAPI
 860 USBPORT_SendSetupPacket(
 861   IN PUSBPORT_DEVICE_HANDLE DeviceHandle,
 862   IN PDEVICE_OBJECT FdoDevice,
 863   IN PUSB_DEFAULT_PIPE_SETUP_PACKET SetupPacket,
 864   IN PVOID Buffer,
 865   IN ULONG Length,
 866   IN OUT PULONG TransferedLen,
 867   IN OUT PUSBD_STATUS pUSBDStatus);
 868
 869 NTSTATUS
 870 NTAPI
 871 USBPORT_RestoreDevice(
 872   IN PDEVICE_OBJECT FdoDevice,
 873   IN OUT PUSBPORT_DEVICE_HANDLE OldDeviceHandle,
 874   IN OUT PUSBPORT_DEVICE_HANDLE NewDeviceHandle);
 875
 876 NTSTATUS
 877 NTAPI
 878 USBPORT_Initialize20Hub(
 879   IN PDEVICE_OBJECT FdoDevice,
 880   IN PUSBPORT_DEVICE_HANDLE HubDeviceHandle,
 881   IN ULONG TtCount);
 882
 883 /* endpoint.c */
 884 NTSTATUS
 885 NTAPI
 886 USBPORT_OpenPipe(
 887   IN PDEVICE_OBJECT FdoDevice,
 888   IN PUSBPORT_DEVICE_HANDLE DeviceHandle,
 889   IN PUSBPORT_PIPE_HANDLE PipeHandle,
 890   IN PUSBD_STATUS UsbdStatus);
 891
 892 MPSTATUS
 893 NTAPI
 894 MiniportOpenEndpoint(
 895   IN PDEVICE_OBJECT FdoDevice,
 896   IN PUSBPORT_ENDPOINT Endpoint);
 897
 898 NTSTATUS
 899 NTAPI
 900 USBPORT_ReopenPipe(
 901   IN PDEVICE_OBJECT FdoDevice,
 902   IN PUSBPORT_ENDPOINT Endpoint);
 903
 904 VOID
 905 NTAPI
 906 USBPORT_ClosePipe(
 907   IN PUSBPORT_DEVICE_HANDLE DeviceHandle,
 908   IN PDEVICE_OBJECT FdoDevice,
 909   IN PUSBPORT_PIPE_HANDLE PipeHandle);
 910
 911 VOID
 912 NTAPI
 913 MiniportCloseEndpoint(
 914   IN PDEVICE_OBJECT FdoDevice,
 915   IN PUSBPORT_ENDPOINT Endpoint);
 916
 917 VOID
 918 NTAPI
 919 USBPORT_AddPipeHandle(
 920   IN PUSBPORT_DEVICE_HANDLE DeviceHandle,
 921   IN PUSBPORT_PIPE_HANDLE PipeHandle);
 922
 923 VOID
 924 NTAPI
 925 USBPORT_RemovePipeHandle(
 926   IN PUSBPORT_DEVICE_HANDLE DeviceHandle,
 927   IN PUSBPORT_PIPE_HANDLE PipeHandle);
 928
 929 BOOLEAN
 930 NTAPI
 931 USBPORT_ValidatePipeHandle(
 932   IN PUSBPORT_DEVICE_HANDLE DeviceHandle,
 933   IN PUSBPORT_PIPE_HANDLE PipeHandle);
 934
 935 VOID
 936 NTAPI
 937 USBPORT_FlushClosedEndpointList(
 938   IN PDEVICE_OBJECT FdoDevice);
 939
 940 VOID
 941 NTAPI
 942 USBPORT_SetEndpointState(
 943   IN PUSBPORT_ENDPOINT Endpoint,
 944   IN ULONG State);
 945
 946 ULONG
 947 NTAPI
 948 USBPORT_GetEndpointState(
 949   IN PUSBPORT_ENDPOINT Endpoint);
 950
 951 VOID
 952 NTAPI
 953 USBPORT_InvalidateEndpointHandler(
 954   IN PDEVICE_OBJECT FdoDevice,
 955   IN PUSBPORT_ENDPOINT Endpoint,
 956   IN ULONG Type);
 957
 958 BOOLEAN
 959 NTAPI
 960 USBPORT_EndpointWorker(
 961   IN PUSBPORT_ENDPOINT Endpoint,
 962   IN BOOLEAN Flag);
 963
 964 VOID
 965 NTAPI
 966 USBPORT_NukeAllEndpoints(
 967   IN PDEVICE_OBJECT FdoDevice);
 968
 969 BOOLEAN
 970 NTAPI
 971 USBPORT_EndpointHasQueuedTransfers(
 972   IN PDEVICE_OBJECT FdoDevice,
 973   IN PUSBPORT_ENDPOINT Endpoint,
 974   IN PULONG TransferCount);
 975
 976 /* iface.c */
 977 NTSTATUS
 978 NTAPI
 979 USBPORT_PdoQueryInterface(
 980   IN PDEVICE_OBJECT FdoDevice,
 981   IN PDEVICE_OBJECT PdoDevice,
 982   IN PIRP Irp);
 983
 984 /* ioctl.c */
 985 NTSTATUS
 986 NTAPI
 987 USBPORT_PdoDeviceControl(
 988   PDEVICE_OBJECT PdoDevice,
 989   PIRP Irp);
 990
 991 NTSTATUS
 992 NTAPI
 993 USBPORT_FdoDeviceControl(
 994   PDEVICE_OBJECT FdoDevice,
 995   PIRP Irp);
 996
 997 NTSTATUS
 998 NTAPI
 999 USBPORT_FdoInternalDeviceControl(
1000   IN PDEVICE_OBJECT FdoDevice,
1001   IN PIRP Irp);
1002
1003 NTSTATUS
1004 NTAPI
1005 USBPORT_PdoInternalDeviceControl(
1006   IN PDEVICE_OBJECT FdoDevice,
1007   IN PIRP Irp);
1008
1009 NTSTATUS
1010 NTAPI
1011 USBPORT_GetSymbolicName(
1012   IN PDEVICE_OBJECT RootHubPdo,
1013   IN PUNICODE_STRING DestinationString);
1014
1015 /* iso.c */
1016 USBD_STATUS
1017 NTAPI
1018 USBPORT_InitializeIsoTransfer(
1019   IN PDEVICE_OBJECT FdoDevice,
1020   IN struct _URB_ISOCH_TRANSFER * Urb,
1021   IN PUSBPORT_TRANSFER Transfer);
1022
1023 ULONG
1024 NTAPI
1025 USBPORT_CompleteIsoTransfer(
1026   IN PVOID MiniPortExtension,
1027   IN PVOID MiniPortEndpoint,
1028   IN PVOID TransferParameters,
1029   IN ULONG TransferLength);
1030
1031 /* pnp.c */
1032 NTSTATUS
1033 NTAPI
1034 USBPORT_FdoPnP(
1035   IN PDEVICE_OBJECT FdoDevice,
1036   IN PIRP Irp);
1037
1038 NTSTATUS
1039 NTAPI
1040 USBPORT_PdoPnP(
1041   IN PDEVICE_OBJECT FdoDevice,
1042   IN PIRP Irp);
1043
1044 /* power.c */
1045 NTSTATUS
1046 NTAPI
1047 USBPORT_PdoPower(
1048   IN PDEVICE_OBJECT PdoDevice,
1049   IN PIRP Irp);
1050
1051 NTSTATUS
1052 NTAPI
1053 USBPORT_FdoPower(
1054   IN PDEVICE_OBJECT FdoDevice,
1055   IN PIRP Irp);
1056
1057 NTSTATUS
1058 NTAPI
1059 USBPORT_IdleNotification(
1060   IN PDEVICE_OBJECT PdoDevice,
1061   IN PIRP Irp);
1062
1063 VOID
1064 NTAPI
1065 USBPORT_AdjustDeviceCapabilities(
1066   IN PDEVICE_OBJECT FdoDevice,
1067   IN PDEVICE_OBJECT PdoDevice);
1068
1069 VOID
1070 NTAPI
1071 USBPORT_DoIdleNotificationCallback(
1072   IN PVOID Context);
1073
1074 VOID
1075 NTAPI
1076 USBPORT_CompletePdoWaitWake(
1077   IN PDEVICE_OBJECT FdoDevice);
1078
1079 VOID
1080 NTAPI
1081 USBPORT_DoSetPowerD0(
1082   IN PDEVICE_OBJECT FdoDevice);
1083
1084 VOID
1085 NTAPI
1086 USBPORT_HcWakeDpc(
1087   IN PRKDPC Dpc,
1088   IN PVOID DeferredContext,
1089   IN PVOID SystemArgument1,
1090   IN PVOID SystemArgument2);
1091
1092 VOID
1093 NTAPI
1094 USBPORT_HcQueueWakeDpc(
1095   IN PDEVICE_OBJECT FdoDevice);
1096
1097 /* queue.c */
1098 VOID
1099 NTAPI
1100 USBPORT_InsertIdleIrp(
1101   IN PIO_CSQ Csq,
1102   IN PIRP Irp);
1103
1104 VOID
1105 NTAPI
1106 USBPORT_RemoveIdleIrp(
1107   IN PIO_CSQ Csq,
1108   IN PIRP Irp);
1109
1110 PIRP
1111 NTAPI
1112 USBPORT_PeekNextIdleIrp(
1113   IN PIO_CSQ Csq,
1114   IN PIRP Irp,
1115   IN PVOID PeekContext);
1116
1117 VOID
1118 NTAPI
1119 USBPORT_AcquireIdleLock(
1120   IN PIO_CSQ Csq,
1121   IN PKIRQL Irql);
1122
1123 VOID
1124 NTAPI
1125 USBPORT_ReleaseIdleLock(
1126   IN PIO_CSQ Csq,
1127   IN KIRQL Irql);
1128
1129 VOID
1130 NTAPI
1131 USBPORT_CompleteCanceledIdleIrp(
1132   IN PIO_CSQ Csq,
1133   IN PIRP Irp);
1134
1135 VOID
1136 NTAPI
1137 USBPORT_InsertBadRequest(
1138   IN PIO_CSQ Csq,
1139   IN PIRP Irp);
1140
1141 VOID
1142 NTAPI
1143 USBPORT_RemoveBadRequest(
1144   IN PIO_CSQ Csq,
1145   IN PIRP Irp);
1146
1147 PIRP
1148 NTAPI
1149 USBPORT_PeekNextBadRequest(
1150   IN PIO_CSQ Csq,
1151   IN PIRP Irp,
1152   IN PVOID PeekContext);
1153
1154 VOID
1155 NTAPI
1156 USBPORT_AcquireBadRequestLock(
1157   IN PIO_CSQ Csq,
1158   IN PKIRQL Irql);
1159
1160 VOID
1161 NTAPI
1162 USBPORT_ReleaseBadRequestLock(
1163   IN PIO_CSQ Csq,
1164   IN KIRQL Irql);
1165
1166 VOID
1167 NTAPI
1168 USBPORT_CompleteCanceledBadRequest(
1169   IN PIO_CSQ Csq,
1170   IN PIRP Irp);
1171
1172 VOID
1173 NTAPI
1174 USBPORT_InsertIrpInTable(
1175   IN PUSBPORT_IRP_TABLE IrpTable,
1176   IN PIRP Irp);
1177
1178 PIRP
1179 NTAPI
1180 USBPORT_RemovePendingTransferIrp(
1181   IN PDEVICE_OBJECT FdoDevice,
1182   IN PIRP Irp);
1183
1184 PIRP
1185 NTAPI
1186 USBPORT_RemoveActiveTransferIrp(
1187   IN PDEVICE_OBJECT FdoDevice,
1188   IN PIRP Irp);
1189
1190 VOID
1191 NTAPI
1192 USBPORT_FindUrbInIrpTable(
1193   IN PUSBPORT_IRP_TABLE IrpTable,
1194   IN PURB Urb,
1195   IN PIRP Irp);
1196
1197 VOID
1198 NTAPI
1199 USBPORT_CancelActiveTransferIrp(
1200   IN PDEVICE_OBJECT DeviceObject,
1201   IN PIRP Irp);
1202
1203 VOID
1204 NTAPI
1205 USBPORT_FlushAbortList(
1206   IN PUSBPORT_ENDPOINT Endpoint);
1207
1208 VOID
1209 NTAPI
1210 USBPORT_FlushCancelList(
1211   IN PUSBPORT_ENDPOINT Endpoint);
1212
1213 VOID
1214 NTAPI
1215 USBPORT_QueueTransferUrb(
1216   IN PURB Urb);
1217
1218 VOID
1219 NTAPI
1220 USBPORT_FlushAllEndpoints(
1221   IN PDEVICE_OBJECT FdoDevice);
1222
1223 VOID
1224 NTAPI
1225 USBPORT_FlushPendingTransfers(
1226   IN PUSBPORT_ENDPOINT Endpoint);
1227
1228 BOOLEAN
1229 NTAPI
1230 USBPORT_QueueActiveUrbToEndpoint(
1231   IN PUSBPORT_ENDPOINT Endpoint,
1232   IN PURB Urb);
1233
1234 VOID
1235 NTAPI
1236 USBPORT_FlushController(
1237   IN PDEVICE_OBJECT FdoDevice);
1238
1239 VOID
1240 NTAPI
1241 USBPORT_BadRequestFlush(
1242   IN PDEVICE_OBJECT FdoDevice);
1243
1244 VOID
1245 NTAPI
1246 USBPORT_AbortEndpoint(
1247   IN PDEVICE_OBJECT FdoDevice,
1248   IN PUSBPORT_ENDPOINT Endpoint,
1249   IN PIRP Irp);
1250
1251 /* roothub.c */
1252 VOID
1253 NTAPI
1254 USBPORT_RootHubEndpointWorker(
1255   PUSBPORT_ENDPOINT Endpoint);
1256
1257 NTSTATUS
1258 NTAPI
1259 USBPORT_RootHubCreateDevice(
1260   IN PDEVICE_OBJECT FdoDevice,
1261   IN PDEVICE_OBJECT PdoDevice);
1262
1263 ULONG
1264 NTAPI
1265 USBPORT_InvalidateRootHub(
1266   PVOID MiniPortExtension);
1267
1268 VOID
1269 NTAPI
1270 USBPORT_RootHubPowerAndChirpAllCcPorts(
1271   IN PDEVICE_OBJECT FdoDevice);
1272
1273 /* trfsplit.c */
1274 VOID
1275 NTAPI
1276 USBPORT_SplitTransfer(
1277   IN PDEVICE_OBJECT FdoDevice,
1278   IN PUSBPORT_ENDPOINT Endpoint,
1279   IN PUSBPORT_TRANSFER Transfer,
1280   IN PLIST_ENTRY List);
1281
1282 VOID
1283 NTAPI
1284 USBPORT_DoneSplitTransfer(
1285   IN PUSBPORT_TRANSFER SplitTransfer);
1286
1287 VOID
1288 NTAPI
1289 USBPORT_CancelSplitTransfer(
1290   IN PUSBPORT_TRANSFER SplitTransfer);
1291
1292 /* urb.c */
1293 NTSTATUS
1294 NTAPI
1295 USBPORT_HandleSubmitURB(
1296   IN PDEVICE_OBJECT PdoDevice,
1297   IN PIRP Irp,
1298   IN PURB Urb);
1299
1300 /* usb2.c */
1301 BOOLEAN
1302 NTAPI
1303 USBPORT_AllocateBandwidthUSB2(
1304   IN PDEVICE_OBJECT FdoDevice,
1305   IN PUSBPORT_ENDPOINT Endpoint);
1306
1307 VOID
1308 NTAPI
1309 USBPORT_FreeBandwidthUSB2(
1310   IN PDEVICE_OBJECT FdoDevice,
1311   IN PUSBPORT_ENDPOINT Endpoint);
1312
1313 VOID
1314 NTAPI
1315 USBPORT_UpdateAllocatedBwTt(
1316   IN PUSB2_TT_EXTENSION TtExtension);
1317
1318 VOID
1319 NTAPI
1320 USB2_InitTT(
1321   IN PUSB2_HC_EXTENSION HcExtension,
1322   IN PUSB2_TT Tt);
1323
1324 VOID
1325 NTAPI
1326 USB2_InitController(
1327   IN PUSB2_HC_EXTENSION HcExtension);
1328
1329 #endif /* USBPORT_H__ */