mirror of
https://github.com/reactos/reactos.git
synced 2025-08-06 05:42:59 +00:00
cebadab3ab
- Remove WorkItem code yet again as its not needed. - Set Ports PortChange to STATUS_CONNECTED when detecting insertion of new usb device. - Change UrbWorkerThread to use timer and wait so we dont waste cpu cycles. - Implement IOCTL_INTERNAL_USB_SUBMIT_IDLE_NOTIFICATION. - Upon receiving the IRP_MN_QUERY_DEVICE_RELATIONS with type BusRelation, stop processing the root hub IRPs, as at this point the hub driver has been informed of everything it needs to know about the device. The next SCE request will remain pending until another devices is connected. - Implement ExecuteControlRequest for all control related communications to/from usb devices. - Remove GetDeviceDescriptor and GetDeviceStringDescriptor as no longer needed. - Fix implementation of Direct Call function CreateUsbDevice. - Implement Direct Call functions InitializeUsbDevice and GetUsbDescriptors. - Misc rearranging and clean up. svn path=/trunk/; revision=46867
479 lines
12 KiB
C
479 lines
12 KiB
C
#pragma once
|
|
|
|
#include <ntifs.h>
|
|
#include <ntddk.h>
|
|
#include <stdio.h>
|
|
#define NDEBUG
|
|
#include <debug.h>
|
|
#include <hubbusif.h>
|
|
#include <usbioctl.h>
|
|
#include <usb.h>
|
|
|
|
#define USB_POOL_TAG (ULONG)'UsbR'
|
|
|
|
#define DEVICEINTIALIZED 0x01
|
|
#define DEVICESTARTED 0x02
|
|
#define DEVICEBUSY 0x04
|
|
#define DEVICESTOPPED 0x08
|
|
|
|
|
|
#define MAX_USB_DEVICES 127
|
|
#define EHCI_MAX_SIZE_TRANSFER 0x100000
|
|
|
|
/* USB Command Register */
|
|
#define EHCI_USBCMD 0x00
|
|
#define EHCI_USBSTS 0x04
|
|
#define EHCI_USBINTR 0x08
|
|
#define EHCI_FRINDEX 0x0C
|
|
#define EHCI_CTRLDSSEGMENT 0x10
|
|
#define EHCI_PERIODICLISTBASE 0x14
|
|
#define EHCI_ASYNCLISTBASE 0x18
|
|
#define EHCI_CONFIGFLAG 0x40
|
|
#define EHCI_PORTSC 0x44
|
|
|
|
/* USB Interrupt Register Flags 32 Bits */
|
|
#define EHCI_USBINTR_INTE 0x01
|
|
#define EHCI_USBINTR_ERR 0x02
|
|
#define EHCI_USBINTR_PC 0x04
|
|
#define EHCI_USBINTR_FLROVR 0x08
|
|
#define EHCI_USBINTR_HSERR 0x10
|
|
#define EHCI_USBINTR_ASYNC 0x20
|
|
/* Bits 6:31 Reserved */
|
|
|
|
/* Status Register Flags 32 Bits */
|
|
#define EHCI_STS_INT 0x01
|
|
#define EHCI_STS_ERR 0x02
|
|
#define EHCI_STS_PCD 0x04
|
|
#define EHCI_STS_FLR 0x08
|
|
#define EHCI_STS_FATAL 0x10
|
|
#define EHCI_STS_IAA 0x20
|
|
/* Bits 11:6 Reserved */
|
|
#define EHCI_STS_HALT 0x1000
|
|
#define EHCI_STS_RECL 0x2000
|
|
#define EHCI_STS_PSS 0x4000
|
|
#define EHCI_STS_ASS 0x8000
|
|
#define EHCI_ERROR_INT ( EHCI_STS_FATAL | EHCI_STS_ERR )
|
|
|
|
|
|
/* Last bit in QUEUE ELEMENT TRANSFER DESCRIPTOR Next Pointer */
|
|
/* Used for Queue Element Transfer Descriptor Pointers
|
|
and Queue Head Horizontal Link Pointers */
|
|
#define TERMINATE_POINTER 0x01
|
|
|
|
/* QUEUE ELEMENT TRANSFER DESCRIPTOR, Token defines and structs */
|
|
|
|
/* PIDCodes for QETD_TOKEN
|
|
OR with QUEUE_TRANSFER_DESCRIPTOR Token.PIDCode*/
|
|
#define PID_CODE_OUT_TOKEN 0x00
|
|
#define PID_CODE_IN_TOKEN 0x01
|
|
#define PID_CODE_SETUP_TOKEN 0x02
|
|
|
|
/* Split Transaction States
|
|
OR with QUEUE_TRANSFER_DESCRIPTOR Token.SplitTransactionState */
|
|
#define DO_START_SPLIT 0x00
|
|
#define DO_COMPLETE_SPLIT 0x01
|
|
|
|
/* Ping States, OR with QUEUE_TRANSFER_DESCRIPTOR Token. */
|
|
#define PING_STATE_DO_OUT 0x00
|
|
#define PING_STATE_DO_PING 0x01
|
|
|
|
#define C_HUB_LOCAL_POWER 0
|
|
#define C_HUB_OVER_CURRENT 1
|
|
#define PORT_CONNECTION 0
|
|
#define PORT_ENABLE 1
|
|
#define PORT_SUSPEND 2
|
|
#define PORT_OVER_CURRENT 3
|
|
#define PORT_RESET 4
|
|
#define PORT_POWER 8
|
|
#define PORT_LOW_SPEED 9
|
|
#define PORT_HIGH_SPEED 9
|
|
#define C_PORT_CONNECTION 16
|
|
#define C_PORT_ENABLE 17
|
|
#define C_PORT_SUSPEND 18
|
|
#define C_PORT_OVER_CURRENT 19
|
|
#define C_PORT_RESET 20
|
|
#define PORT_TEST 21
|
|
#define PORT_INDICATOR 22
|
|
#define USB_PORT_STATUS_CHANGE 0x4000
|
|
|
|
/* QUEUE ELEMENT TRANSFER DESCRIPTOR TOKEN */
|
|
typedef struct _QETD_TOKEN_BITS
|
|
{
|
|
ULONG PingState:1;
|
|
ULONG SplitTransactionState:1;
|
|
ULONG MissedMicroFrame:1;
|
|
ULONG TransactionError:1;
|
|
ULONG BabbelDetected:1;
|
|
ULONG DataBufferError:1;
|
|
ULONG Halted:1;
|
|
ULONG Active:1;
|
|
ULONG PIDCode:2;
|
|
ULONG ErrorCounter:2;
|
|
ULONG CurrentPage:3;
|
|
ULONG InterruptOnComplete:1;
|
|
ULONG TotalBytesToTransfer:15;
|
|
ULONG DataToggle:1;
|
|
} QETD_TOKEN_BITS, *PQETD_TOKEN_BITS;
|
|
|
|
|
|
/* QUEUE ELEMENT TRANSFER DESCRIPTOR */
|
|
typedef struct _QUEUE_TRANSFER_DESCRIPTOR
|
|
{
|
|
ULONG NextPointer;
|
|
ULONG AlternateNextPointer;
|
|
union
|
|
{
|
|
QETD_TOKEN_BITS Bits;
|
|
ULONG DWord;
|
|
} Token;
|
|
ULONG BufferPointer[5];
|
|
} QUEUE_TRANSFER_DESCRIPTOR, *PQUEUE_TRANSFER_DESCRIPTOR;
|
|
|
|
/* EndPointSpeeds of END_POINT_CAPABILITIES */
|
|
#define QH_ENDPOINT_FULLSPEED 0x00
|
|
#define QH_ENDPOINT_LOWSPEED 0x01
|
|
#define QH_ENDPOINT_HIGHSPEED 0x02
|
|
|
|
typedef struct _END_POINT_CAPABILITIES1
|
|
{
|
|
ULONG DeviceAddress:7;
|
|
ULONG InactiveOnNextTransaction:1;
|
|
ULONG EndPointNumber:4;
|
|
ULONG EndPointSpeed:2;
|
|
ULONG QEDTDataToggleControl:1;
|
|
ULONG HeadOfReclamation:1;
|
|
ULONG MaximumPacketLength:11;
|
|
ULONG ControlEndPointFlag:1;
|
|
ULONG NakCountReload:4;
|
|
} END_POINT_CAPABILITIES1, *PEND_POINT_CAPABILITIES1;
|
|
|
|
typedef struct _END_POINT_CAPABILITIES2
|
|
{
|
|
ULONG InterruptScheduleMask:8;
|
|
ULONG SplitCompletionMask:8;
|
|
ULONG HubAddr:6;
|
|
ULONG PortNumber:6;
|
|
/* Multi */
|
|
ULONG NumberOfTransactionPerFrame:2;
|
|
} END_POINT_CAPABILITIES2, *PEND_POINT_CAPABILITIES2;
|
|
|
|
|
|
/* QUEUE HEAD defines and structs */
|
|
|
|
/* QUEUE HEAD Select Types, OR with QUEUE_HEAD HorizontalLinkPointer */
|
|
#define QH_TYPE_IDT 0x00
|
|
#define QH_TYPE_QH 0x02
|
|
#define QH_TYPE_SITD 0x04
|
|
#define QH_TYPE_FSTN 0x06
|
|
|
|
/* QUEUE HEAD */
|
|
typedef struct _QUEUE_HEAD
|
|
{
|
|
ULONG HorizontalLinkPointer;
|
|
END_POINT_CAPABILITIES1 EndPointCapabilities1;
|
|
END_POINT_CAPABILITIES2 EndPointCapabilities2;
|
|
/* TERMINATE_POINTER not valid for this member */
|
|
ULONG CurrentLinkPointer;
|
|
/* TERMINATE_POINTER valid */
|
|
ULONG QETDPointer;
|
|
/* TERMINATE_POINTER valid, bits 1:4 is NAK_COUNTER */
|
|
ULONG AlternateNextPointer;
|
|
/* Only DataToggle, InterruptOnComplete, ErrorCounter, PingState valid */
|
|
union
|
|
{
|
|
QETD_TOKEN_BITS Bits;
|
|
ULONG DWord;
|
|
} Token;
|
|
ULONG BufferPointer[5];
|
|
} QUEUE_HEAD, *PQUEUE_HEAD;
|
|
|
|
typedef struct _EHCI_SETUP_FORMAT
|
|
{
|
|
UCHAR bmRequestType;
|
|
UCHAR bRequest;
|
|
USHORT wValue;
|
|
USHORT wIndex;
|
|
USHORT wLength;
|
|
} EHCI_SETUP_FORMAT, *PEHCI_SETUP_FORMAT;
|
|
|
|
typedef struct _STRING_DESCRIPTOR
|
|
{
|
|
UCHAR bLength; /* Size of this descriptor in bytes */
|
|
UCHAR bDescriptorType; /* STRING Descriptor Type */
|
|
UCHAR bString[0]; /* UNICODE encoded string */
|
|
} STRING_DESCRIPTOR, *PSTRING_DESCRIPTOR;
|
|
|
|
typedef struct _USB_ENDPOINT
|
|
{
|
|
ULONG Flags;
|
|
LIST_ENTRY UrbList;
|
|
struct _USB_INTERFACE *Interface;
|
|
USB_ENDPOINT_DESCRIPTOR EndPointDescriptor;
|
|
} USB_ENDPOINT, *PUSB_ENDPOINT;
|
|
|
|
typedef struct _USB_INTERFACE
|
|
{
|
|
struct _USB_CONFIGURATION *Config;
|
|
USB_INTERFACE_DESCRIPTOR InterfaceDescriptor;
|
|
USB_ENDPOINT *EndPoints[];
|
|
} USB_INTERFACE, *PUSB_INTERFACE;
|
|
|
|
typedef struct _USB_CONFIGURATION
|
|
{
|
|
struct _USB_DEVICE *Device;
|
|
USB_CONFIGURATION_DESCRIPTOR ConfigurationDescriptor;
|
|
USB_INTERFACE *Interfaces[];
|
|
} USB_CONFIGURATION, *PUSB_CONFIGURATION;
|
|
|
|
typedef struct _USB_DEVICE
|
|
{
|
|
UCHAR Address;
|
|
ULONG Port;
|
|
PVOID ParentDevice;
|
|
BOOLEAN IsHub;
|
|
USB_DEVICE_SPEED DeviceSpeed;
|
|
USB_DEVICE_TYPE DeviceType;
|
|
USB_DEVICE_DESCRIPTOR DeviceDescriptor;
|
|
USB_CONFIGURATION *ActiveConfig;
|
|
USB_INTERFACE *ActiveInterface;
|
|
USB_CONFIGURATION **Configs;
|
|
|
|
} USB_DEVICE, *PUSB_DEVICE;
|
|
|
|
/* USBCMD register 32 bits */
|
|
typedef struct _EHCI_USBCMD_CONTENT
|
|
{
|
|
ULONG Run : 1;
|
|
ULONG HCReset : 1;
|
|
ULONG FrameListSize : 2;
|
|
ULONG PeriodicEnable : 1;
|
|
ULONG AsyncEnable : 1;
|
|
ULONG DoorBell : 1;
|
|
ULONG LightReset : 1;
|
|
ULONG AsyncParkCount : 2;
|
|
ULONG Reserved : 1;
|
|
ULONG AsyncParkEnable : 1;
|
|
ULONG Reserved1 : 4;
|
|
ULONG IntThreshold : 8;
|
|
ULONG Reserved2 : 8;
|
|
|
|
} EHCI_USBCMD_CONTENT, *PEHCI_USBCMD_CONTENT;
|
|
|
|
typedef struct _EHCI_USBSTS_CONTENT
|
|
{
|
|
ULONG USBInterrupt:1;
|
|
ULONG ErrorInterrupt:1;
|
|
ULONG DetectChangeInterrupt:1;
|
|
ULONG FrameListRolloverInterrupt:1;
|
|
ULONG HostSystemErrorInterrupt:1;
|
|
ULONG AsyncAdvanceInterrupt:1;
|
|
ULONG Reserved:6;
|
|
ULONG HCHalted:1;
|
|
ULONG Reclamation:1;
|
|
ULONG PeriodicScheduleStatus:1;
|
|
ULONG AsynchronousScheduleStatus:1;
|
|
} EHCI_USBSTS_CONTEXT, *PEHCI_USBSTS_CONTEXT;
|
|
|
|
typedef struct _EHCI_USBPORTSC_CONTENT
|
|
{
|
|
ULONG CurrentConnectStatus:1;
|
|
ULONG ConnectStatusChange:1;
|
|
ULONG PortEnabled:1;
|
|
ULONG PortEnableChanged:1;
|
|
ULONG OverCurrentActive:1;
|
|
ULONG OverCurrentChange:1;
|
|
ULONG ForcePortResume:1;
|
|
ULONG Suspend:1;
|
|
ULONG PortReset:1;
|
|
ULONG Reserved:1;
|
|
ULONG LineStatus:2;
|
|
ULONG PortPower:1;
|
|
ULONG PortOwner:1;
|
|
} EHCI_USBPORTSC_CONTENT, *PEHCI_USBPORTSC_CONTENT;
|
|
|
|
typedef struct _EHCI_HCS_CONTENT
|
|
{
|
|
ULONG PortCount : 4;
|
|
ULONG PortPowerControl: 1;
|
|
ULONG Reserved : 2;
|
|
ULONG PortRouteRules : 1;
|
|
ULONG PortPerCHC : 4;
|
|
ULONG CHCCount : 4;
|
|
ULONG PortIndicator : 1;
|
|
ULONG Reserved2 : 3;
|
|
ULONG DbgPortNum : 4;
|
|
ULONG Reserved3 : 8;
|
|
|
|
} EHCI_HCS_CONTENT, *PEHCI_HCS_CONTENT;
|
|
|
|
typedef struct _EHCI_HCC_CONTENT
|
|
{
|
|
ULONG CurAddrBits : 1;
|
|
ULONG VarFrameList : 1;
|
|
ULONG ParkMode : 1;
|
|
ULONG Reserved : 1;
|
|
ULONG IsoSchedThreshold : 4;
|
|
ULONG EECPCapable : 8;
|
|
ULONG Reserved2 : 16;
|
|
|
|
} EHCI_HCC_CONTENT, *PEHCI_HCC_CONTENT;
|
|
|
|
typedef struct _EHCI_CAPS {
|
|
UCHAR Length;
|
|
UCHAR Reserved;
|
|
USHORT HCIVersion;
|
|
union
|
|
{
|
|
EHCI_HCS_CONTENT HCSParams;
|
|
ULONG HCSParamsLong;
|
|
};
|
|
ULONG HCCParams;
|
|
UCHAR PortRoute [8];
|
|
} EHCI_CAPS, *PEHCI_CAPS;
|
|
|
|
typedef struct _COMMON_DEVICE_EXTENSION
|
|
{
|
|
BOOLEAN IsFdo;
|
|
PDRIVER_OBJECT DriverObject;
|
|
PDEVICE_OBJECT DeviceObject;
|
|
} COMMON_DEVICE_EXTENSION, *PCOMMON_DEVICE_EXTENSION;
|
|
|
|
typedef struct _EHCIPORTS
|
|
{
|
|
ULONG PortNumber;
|
|
ULONG PortType;
|
|
USHORT PortStatus;
|
|
USHORT PortChange;
|
|
} EHCIPORTS, *PEHCIPORTS;
|
|
|
|
typedef struct _FDO_DEVICE_EXTENSION
|
|
{
|
|
COMMON_DEVICE_EXTENSION Common;
|
|
PDRIVER_OBJECT DriverObject;
|
|
PDEVICE_OBJECT DeviceObject;
|
|
PDEVICE_OBJECT LowerDevice;
|
|
PDEVICE_OBJECT Pdo;
|
|
ULONG DeviceState;
|
|
|
|
PVOID RootHubDeviceHandle;
|
|
PDMA_ADAPTER pDmaAdapter;
|
|
|
|
ULONG Vector;
|
|
KIRQL Irql;
|
|
|
|
KINTERRUPT_MODE Mode;
|
|
BOOLEAN IrqShared;
|
|
PKINTERRUPT EhciInterrupt;
|
|
KDPC DpcObject;
|
|
KAFFINITY Affinity;
|
|
|
|
ULONG MapRegisters;
|
|
|
|
ULONG BusNumber;
|
|
ULONG BusAddress;
|
|
ULONG PCIAddress;
|
|
USHORT VendorId;
|
|
USHORT DeviceId;
|
|
|
|
BUS_INTERFACE_STANDARD BusInterface;
|
|
|
|
EHCI_CAPS ECHICaps;
|
|
|
|
union
|
|
{
|
|
PULONG ResourcePort;
|
|
PULONG ResourceMemory;
|
|
};
|
|
|
|
PULONG PeriodicFramList;
|
|
PULONG AsyncListQueueHeadPtr;
|
|
PHYSICAL_ADDRESS PeriodicFramListPhysAddr;
|
|
PHYSICAL_ADDRESS AsyncListQueueHeadPtrPhysAddr;
|
|
|
|
BOOLEAN AsyncComplete;
|
|
|
|
PULONG ResourceBase;
|
|
ULONG Size;
|
|
} FDO_DEVICE_EXTENSION, *PFDO_DEVICE_EXTENSION;
|
|
|
|
typedef struct _PDO_DEVICE_EXTENSION
|
|
{
|
|
COMMON_DEVICE_EXTENSION Common;
|
|
PDEVICE_OBJECT DeviceObject;
|
|
PDEVICE_OBJECT ControllerFdo;
|
|
PUSB_DEVICE UsbDevices[127];
|
|
LIST_ENTRY IrpQueue;
|
|
KSPIN_LOCK IrpQueueLock;
|
|
PIRP CurrentIrp;
|
|
HANDLE ThreadHandle;
|
|
ULONG ChildDeviceCount;
|
|
BOOLEAN HaltQueue;
|
|
PVOID CallbackContext;
|
|
RH_INIT_CALLBACK *CallbackRoutine;
|
|
USB_IDLE_CALLBACK IdleCallback;
|
|
PVOID IdleContext;
|
|
ULONG NumberOfPorts;
|
|
EHCIPORTS Ports[32];
|
|
KTIMER Timer;
|
|
KEVENT QueueDrainedEvent;
|
|
FAST_MUTEX ListLock;
|
|
} PDO_DEVICE_EXTENSION, *PPDO_DEVICE_EXTENSION;
|
|
|
|
typedef struct _WORKITEM_DATA
|
|
{
|
|
PIO_WORKITEM IoWorkItem;
|
|
PPDO_DEVICE_EXTENSION PdoDeviceExtension;
|
|
PDEVICE_OBJECT PortDeviceObject;
|
|
} WORKITEM_DATA, *PWORKITEM_DATA;
|
|
|
|
|
|
VOID NTAPI
|
|
UrbWorkerThread(PVOID Context);
|
|
|
|
NTSTATUS NTAPI
|
|
GetBusInterface(PDEVICE_OBJECT pcifido, PBUS_INTERFACE_STANDARD busInterface);
|
|
|
|
NTSTATUS NTAPI
|
|
ForwardAndWaitCompletionRoutine(PDEVICE_OBJECT DeviceObject, PIRP Irp, PKEVENT Event);
|
|
|
|
NTSTATUS NTAPI
|
|
ForwardAndWait(PDEVICE_OBJECT DeviceObject, PIRP Irp);
|
|
|
|
NTSTATUS NTAPI
|
|
ForwardIrpAndForget(PDEVICE_OBJECT DeviceObject,PIRP Irp);
|
|
|
|
NTSTATUS NTAPI
|
|
FdoDispatchPnp(IN PDEVICE_OBJECT DeviceObject, IN PIRP Irp);
|
|
|
|
NTSTATUS NTAPI
|
|
PdoDispatchPnp(IN PDEVICE_OBJECT DeviceObject, IN PIRP Irp);
|
|
|
|
NTSTATUS NTAPI
|
|
AddDevice(PDRIVER_OBJECT DriverObject, PDEVICE_OBJECT Pdo);
|
|
|
|
NTSTATUS
|
|
DuplicateUnicodeString(ULONG Flags, PCUNICODE_STRING SourceString, PUNICODE_STRING DestinationString);
|
|
|
|
PWSTR
|
|
GetSymbolicName(PDEVICE_OBJECT DeviceObject);
|
|
|
|
PWSTR
|
|
GetPhysicalDeviceObjectName(PDEVICE_OBJECT DeviceObject);
|
|
|
|
NTSTATUS NTAPI
|
|
PdoDispatchInternalDeviceControl(PDEVICE_OBJECT DeviceObject, PIRP Irp);
|
|
|
|
BOOLEAN
|
|
ExecuteControlRequest(PFDO_DEVICE_EXTENSION DeviceExtension, PUSB_DEFAULT_PIPE_SETUP_PACKET SetupPacket, UCHAR Address, ULONG Port, PVOID Buffer, ULONG BufferLength);
|
|
|
|
VOID
|
|
QueueURBRequest(PPDO_DEVICE_EXTENSION DeviceExtension, PIRP Irp);
|
|
|
|
VOID
|
|
CompletePendingURBRequest(PPDO_DEVICE_EXTENSION DeviceExtension);
|
|
|
|
VOID
|
|
URBRequestCancel (PDEVICE_OBJECT DeviceObject, PIRP Irp);
|
|
|
|
VOID NTAPI
|
|
DeviceArrivalWorkItem(PDEVICE_OBJECT DeviceObject, PVOID Context);
|