Intravision/reactos
1
0
Fork 0
mirror of https://github.com/reactos/reactos.git synced 2024-10-31 11:56:26 +00:00
Code Issues Packages Projects Releases Wiki Activity
reactos/drivers/usb/usbehci/hardware.h

326 lines
8.9 KiB
C
Raw Normal View History

[USBEHCI_NEW] - Add flags and structures needed for communicating with controller and handling schedules. - Add support routines for modifying operational registers on controller. - Implement getting the controller capabilties, starting and stopping the controller. svn path=/branches/usb-bringup/; revision=51365
2011-04-16 02:20:23 +00:00
#pragma once
[USBEHCI] - Use constants instead of hardcoding register offsets. Taken from Haiku - Elements in HCSP-PORTROUTE are 4 bit entries instead svn path=/branches/usb-bringup-trunk/; revision=55385
2012-02-02 22:18:58 +00:00
//
// Host Controller Capability Registers
//
#define EHCI_CAPLENGTH 0x00
#define EHCI_HCIVERSION 0x02
#define EHCI_HCSPARAMS 0x04
#define EHCI_HCCPARAMS 0x08
#define EHCI_HCSP_PORTROUTE 0x0c
[USBEHCI] - Check for bios ownership - Acquire ownership if bios owns it - Verify ownership svn path=/branches/usb-bringup-trunk/; revision=55386
2012-02-02 23:09:53 +00:00
//
// Extended Capabilities
//
#define EHCI_ECP_SHIFT 8
#define EHCI_ECP_MASK 0xff
#define EHCI_LEGSUP_CAPID_MASK 0xff
#define EHCI_LEGSUP_CAPID 0x01
#define EHCI_LEGSUP_OSOWNED (1 << 24)
#define EHCI_LEGSUP_BIOSOWNED (1 << 16)
[USBEHCI_NEW] - Add flags and structures needed for communicating with controller and handling schedules. - Add support routines for modifying operational registers on controller. - Implement getting the controller capabilties, starting and stopping the controller. svn path=/branches/usb-bringup/; revision=51365
2011-04-16 02:20:23 +00:00
//
// EHCI Operational Registers
//
#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
//
// Interrupt Register Flags
//
#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
//
#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)
[USBEHCI_NEW] - Add flags for Port Status Control Register and remove structiures for Port Status Control Register. - Remove USB Status Register and use the flags instead. - Remove functions that are not used and never will be. - Implement InterruptServiceRoutine and Deffered Procedure Routine. - Partially implement port status change to detect device insert and removal. svn path=/branches/usb-bringup/; revision=51366
2011-04-16 05:55:02 +00:00
//
// Port Register Flags
//
#define EHCI_PRT_CONNECTED 0x01
[USBEHCI_NEW] - Move USB_REQUEST_SET_FEATURE / USB_REQUEST_GET_FEATURE flags to header file. - Remove QueueHead and Descriptor creation as its in UsbRequest. - Move DMACommon Buffer allocation back to UsbHardwareDevice class. - Implement Port Handling functions GetPortStatus, ClearPortStatus and SetPortFeature. - Implement GetUSBQueue for returning pointer to UsbQueue and GetDMA to return DMAMemoryManager. - Fix a typo in one of the defines for Port Register Flags. svn path=/branches/usb-bringup/; revision=51397
2011-04-19 06:56:30 +00:00
#define EHCI_PRT_CONNECTSTATUSCHANGE 0x02
[USBEHCI_NEW] - Add flags for Port Status Control Register and remove structiures for Port Status Control Register. - Remove USB Status Register and use the flags instead. - Remove functions that are not used and never will be. - Implement InterruptServiceRoutine and Deffered Procedure Routine. - Partially implement port status change to detect device insert and removal. svn path=/branches/usb-bringup/; revision=51366
2011-04-16 05:55:02 +00:00
#define EHCI_PRT_ENABLED 0x04
#define EHCI_PRT_ENABLEDSTATUSCHANGE 0x08
#define EHCI_PRT_OVERCURRENTACTIVE 0x10
#define EHCI_PRT_OVERCURRENTCHANGE 0x20
#define EHCI_PRT_FORCERESUME 0x40
#define EHCI_PRT_SUSPEND 0x80
#define EHCI_PRT_RESET 0x100
[USBEHCI] - Create a macro for properly checking for low speed devices - Check again for a low speed device after the EHCI reset completes - Don't ignore status changes on ports that we have released (revert part of r55851) svn path=/trunk/; revision=55853
2012-02-25 06:23:12 +00:00
#define EHCI_PRT_LINESTATUSA 0x400
#define EHCI_PRT_LINESTATUSB 0x800
[USBEHCI_NEW] - Add flags for Port Status Control Register and remove structiures for Port Status Control Register. - Remove USB Status Register and use the flags instead. - Remove functions that are not used and never will be. - Implement InterruptServiceRoutine and Deffered Procedure Routine. - Partially implement port status change to detect device insert and removal. svn path=/branches/usb-bringup/; revision=51366
2011-04-16 05:55:02 +00:00
#define EHCI_PRT_POWER 0x1000
#define EHCI_PRT_RELEASEOWNERSHIP 0x2000
[USBEHCI_NEW] - Cache port status & port change settings because it appears that some ehci controllers do not store the status reset register bit correctly - This commit is a temporary solutions, needs to be reworked - Return correct status from HandleClassOther - Handle IOCTL_INTERNAL_USB_SUBMIT_IDLE_NOTIFICATION to return status success svn path=/branches/usb-bringup/; revision=51473
2011-04-28 12:41:16 +00:00
#define EHCI_PORTSC_DATAMASK 0xffffffd1
[USBEHCI] - Create a macro for properly checking for low speed devices - Check again for a low speed device after the EHCI reset completes - Don't ignore status changes on ports that we have released (revert part of r55851) svn path=/trunk/; revision=55853
2012-02-25 06:23:12 +00:00
#define EHCI_IS_LOW_SPEED(x) (((x) & EHCI_PRT_LINESTATUSA) && !((x) & EHCI_PRT_LINESTATUSB))
[USBEHCI_NEW] - Add flags and structures needed for communicating with controller and handling schedules. - Add support routines for modifying operational registers on controller. - Implement getting the controller capabilties, starting and stopping the controller. svn path=/branches/usb-bringup/; revision=51365
2011-04-16 02:20:23 +00:00
//
// Terminate Pointer used for QueueHeads and Element Transfer Descriptors to mark Pointers as the end
//
#define TERMINATE_POINTER 0x01
//
// QUEUE ELEMENT TRANSFER DESCRIPTOR, defines and structs
//
//
// Token Flags
//
#define PID_CODE_OUT_TOKEN 0x00
#define PID_CODE_IN_TOKEN 0x01
#define PID_CODE_SETUP_TOKEN 0x02
#define DO_START_SPLIT 0x00
#define DO_COMPLETE_SPLIT 0x01
#define PING_STATE_DO_OUT 0x00
#define PING_STATE_DO_PING 0x01
typedef struct _PERIODICFRAMELIST
{
PULONG VirtualAddr;
PHYSICAL_ADDRESS PhysicalAddr;
ULONG Size;
} PERIODICFRAMELIST, *PPERIODICFRAMELIST;
//
// QUEUE ELEMENT TRANSFER DESCRIPTOR TOKEN
//
typedef struct _QETD_TOKEN_BITS
{
ULONG PingState:1;
ULONG SplitTransactionState:1;
ULONG MissedMicroFrame:1;
ULONG TransactionError:1;
ULONG BabbleDetected: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
{
//Hardware
ULONG NextPointer;
ULONG AlternateNextPointer;
union
{
QETD_TOKEN_BITS Bits;
ULONG DWord;
} Token;
ULONG BufferPointer[5];
[USB] - Merge r55564 and r55567 from usb-bringup-trunk - USB development should now be done in trunk exclusively (UHCI implementation may be an exception) svn path=/trunk/; revision=55568
2012-02-12 18:28:52 +00:00
ULONG ExtendedBufferPointer[5];
[USBEHCI_NEW] - Add flags and structures needed for communicating with controller and handling schedules. - Add support routines for modifying operational registers on controller. - Implement getting the controller capabilties, starting and stopping the controller. svn path=/branches/usb-bringup/; revision=51365
2011-04-16 02:20:23 +00:00
//Software
ULONG PhysicalAddr;
[USBEHCI] - Partly revert 55516, as the memory bug got fixed svn path=/branches/usb-bringup-trunk/; revision=55530
2012-02-10 20:15:39 +00:00
LIST_ENTRY DescriptorEntry;
[USBEHCI_NEW] - Store number of bytes transferred in the transfer descriptors - Perform queue head completion when the door bell ring has been acknowledged. Fixes race condition between multiple irps in the async list - Fix calculation of transfer length when the request is an bulk in operation - Use EndPointDescriptor member to access transfer type / pid direction - Use MmGetSystemAddressForMdlSafe to retrieve system address for urb buffer - Fix check if first transfer buffer finishes on first size if the size is of page_size - With these changes and little luck and good weather, usb mass storage devices have been seen to work in Windows XP SP3 - Code inspired of mjmartin usbehci driver and Haiku's usb stack svn path=/branches/usb-bringup/; revision=51506
2011-04-30 17:44:43 +00:00
ULONG TotalBytesToTransfer;
[USBEHCI_NEW] - Add flags and structures needed for communicating with controller and handling schedules. - Add support routines for modifying operational registers on controller. - Implement getting the controller capabilties, starting and stopping the controller. svn path=/branches/usb-bringup/; revision=51365
2011-04-16 02:20:23 +00:00
} QUEUE_TRANSFER_DESCRIPTOR, *PQUEUE_TRANSFER_DESCRIPTOR;
[USB] - Merge r55564 and r55567 from usb-bringup-trunk - USB development should now be done in trunk exclusively (UHCI implementation may be an exception) svn path=/trunk/; revision=55568
2012-02-12 18:28:52 +00:00
C_ASSERT(FIELD_OFFSET(QUEUE_TRANSFER_DESCRIPTOR, PhysicalAddr) == 0x34);
[USBEHCI] - Don't set NumberOfTransaction 0x3 for the async queue head(Haiku doesnt do it too) - Also don't set maximum packet length or interrupt on complete - Stop the async / periodic schedules after acquiring ownership from os (ported from the Pedigree OS) - Remove unused structs from header - Allocate device descriptor from start of a page to prevent alignment issues - Clear halted bit in the queue overlay transaction layer (usb_queue.cpp:507) - Always set the alternative and next pointers in BuildControlTransferQueueHead - Use data the toggle in the transfer requests - Start using toggle in bulk requests, invert data toggle after each descriptor - EHCI controller still reports error 0xA / 0xB which is USB Error Interrupt + Frame List Rollover + [USB Interrupt] - Errors need to be researched more, though the control transfers results appear o.k. - Tested in real hw + ros stack with USB Mass Storage Device - Currently hangs after first completed CDB/Data/CSW block svn path=/branches/usb-bringup-trunk/; revision=55483
2012-02-07 16:18:56 +00:00
[USBEHCI_NEW] - Add flags and structures needed for communicating with controller and handling schedules. - Add support routines for modifying operational registers on controller. - Implement getting the controller capabilties, starting and stopping the controller. svn path=/branches/usb-bringup/; revision=51365
2011-04-16 02:20:23 +00:00
//
// EndPointSpeeds Flags and END_POINT_CHARACTERISTICS
//
#define QH_ENDPOINT_FULLSPEED 0x00
#define QH_ENDPOINT_LOWSPEED 0x01
#define QH_ENDPOINT_HIGHSPEED 0x02
typedef struct _END_POINT_CHARACTERISTICS
{
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_CHARACTERISTICS, *PEND_POINT_CHARACTERISTICS;
//
// Capabilities
//
typedef struct _END_POINT_CAPABILITIES
{
ULONG InterruptScheduleMask:8;
ULONG SplitCompletionMask:8;
ULONG HubAddr:6;
ULONG PortNumber:6;
ULONG NumberOfTransactionPerFrame:2;
} END_POINT_CAPABILITIES, *PEND_POINT_CAPABILITIES;
//
// QUEUE HEAD Flags and Struct
//
#define QH_TYPE_IDT 0x00
#define QH_TYPE_QH 0x02
#define QH_TYPE_SITD 0x04
#define QH_TYPE_FSTN 0x06
typedef struct _QUEUE_HEAD
{
//Hardware
ULONG HorizontalLinkPointer;
END_POINT_CHARACTERISTICS EndPointCharacteristics;
END_POINT_CAPABILITIES EndPointCapabilities;
// TERMINATE_POINTER not valid for this member
ULONG CurrentLinkPointer;
// TERMINATE_POINTER valid
ULONG NextPointer;
// TERMINATE_POINTER valid, bits 1:4 is NAK_COUNTERd
ULONG AlternateNextPointer;
// Only DataToggle, InterruptOnComplete, ErrorCounter, PingState valid
union
{
QETD_TOKEN_BITS Bits;
ULONG DWord;
} Token;
ULONG BufferPointer[5];
[USB] - Merge r55564 and r55567 from usb-bringup-trunk - USB development should now be done in trunk exclusively (UHCI implementation may be an exception) svn path=/trunk/; revision=55568
2012-02-12 18:28:52 +00:00
ULONG ExtendedBufferPointer[5];
[USBEHCI_NEW] - Add flags and structures needed for communicating with controller and handling schedules. - Add support routines for modifying operational registers on controller. - Implement getting the controller capabilties, starting and stopping the controller. svn path=/branches/usb-bringup/; revision=51365
2011-04-16 02:20:23 +00:00
//Software
ULONG PhysicalAddr;
[USBEHCI_NEW] - Use LIST_ENTRY in QueueHeads and Descriptors vice Next and Previous Pointers. - Add functions to interface for setting AsyncListRegister and PeriodicListRegister. - USBHardwareDevice: Initialize USBQueue when handling PNPStart. - USBQueue: Allocate Common Buffer and use it to Create and Initialize DmaMemoryManager object. - USBQueue: Implement CreateQueueHead and CreateDescriptor. svn path=/branches/usb-bringup/; revision=51388
2011-04-18 00:06:37 +00:00
LIST_ENTRY LinkedQueueHeads;
[USBEHCI] - Partly revert 55516, as the memory bug got fixed svn path=/branches/usb-bringup-trunk/; revision=55530
2012-02-10 20:15:39 +00:00
LIST_ENTRY TransferDescriptorListHead;
[USBEHCI] - Partly implement support for interrupt transfers, WIP, untested svn path=/trunk/; revision=55957
2012-03-02 14:21:44 +00:00
PVOID NextQueueHead;
[USBEHCI_NEW] - Create member for storing the request object - Add interface function which is invoked when the queue head should be freed - Add support functions which deal with completed queue heads svn path=/branches/usb-bringup/; revision=51440
2011-04-23 19:36:23 +00:00
PVOID Request;
[USBEHCI_NEW] - Add flags and structures needed for communicating with controller and handling schedules. - Add support routines for modifying operational registers on controller. - Implement getting the controller capabilties, starting and stopping the controller. svn path=/branches/usb-bringup/; revision=51365
2011-04-16 02:20:23 +00:00
} QUEUE_HEAD, *PQUEUE_HEAD;
[USBEHCI] - Partly revert 55516, as the memory bug got fixed svn path=/branches/usb-bringup-trunk/; revision=55530
2012-02-10 20:15:39 +00:00
C_ASSERT(sizeof(END_POINT_CHARACTERISTICS) == 4);
C_ASSERT(sizeof(END_POINT_CAPABILITIES) == 4);
C_ASSERT(FIELD_OFFSET(QUEUE_HEAD, HorizontalLinkPointer) == 0x00);
C_ASSERT(FIELD_OFFSET(QUEUE_HEAD, EndPointCharacteristics) == 0x04);
C_ASSERT(FIELD_OFFSET(QUEUE_HEAD, EndPointCapabilities) == 0x08);
C_ASSERT(FIELD_OFFSET(QUEUE_HEAD, CurrentLinkPointer) == 0xC);
C_ASSERT(FIELD_OFFSET(QUEUE_HEAD, NextPointer) == 0x10);
C_ASSERT(FIELD_OFFSET(QUEUE_HEAD, AlternateNextPointer) == 0x14);
C_ASSERT(FIELD_OFFSET(QUEUE_HEAD, Token) == 0x18);
C_ASSERT(FIELD_OFFSET(QUEUE_HEAD, BufferPointer) == 0x1C);
[USB] - Merge r55564 and r55567 from usb-bringup-trunk - USB development should now be done in trunk exclusively (UHCI implementation may be an exception) svn path=/trunk/; revision=55568
2012-02-12 18:28:52 +00:00
C_ASSERT(FIELD_OFFSET(QUEUE_HEAD, PhysicalAddr) == 0x44);
[USBEHCI] - Don't set NumberOfTransaction 0x3 for the async queue head(Haiku doesnt do it too) - Also don't set maximum packet length or interrupt on complete - Stop the async / periodic schedules after acquiring ownership from os (ported from the Pedigree OS) - Remove unused structs from header - Allocate device descriptor from start of a page to prevent alignment issues - Clear halted bit in the queue overlay transaction layer (usb_queue.cpp:507) - Always set the alternative and next pointers in BuildControlTransferQueueHead - Use data the toggle in the transfer requests - Start using toggle in bulk requests, invert data toggle after each descriptor - EHCI controller still reports error 0xA / 0xB which is USB Error Interrupt + Frame List Rollover + [USB Interrupt] - Errors need to be researched more, though the control transfers results appear o.k. - Tested in real hw + ros stack with USB Mass Storage Device - Currently hangs after first completed CDB/Data/CSW block svn path=/branches/usb-bringup-trunk/; revision=55483
2012-02-07 16:18:56 +00:00
[USBEHCI_NEW] - Add flags and structures needed for communicating with controller and handling schedules. - Add support routines for modifying operational registers on controller. - Implement getting the controller capabilties, starting and stopping the controller. svn path=/branches/usb-bringup/; revision=51365
2011-04-16 02:20:23 +00:00
//
// Command register content
//
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_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;
};
union
{
EHCI_HCC_CONTENT HCCParams;
ULONG HCCParamsLong;
};
[EHCI] - EHCI controllers support 15 ports as specified svn path=/branches/usb-bringup-trunk/; revision=55292
2012-01-29 17:25:34 +00:00
UCHAR PortRoute [15];
[USBEHCI_NEW] - Add flags and structures needed for communicating with controller and handling schedules. - Add support routines for modifying operational registers on controller. - Implement getting the controller capabilties, starting and stopping the controller. svn path=/branches/usb-bringup/; revision=51365
2011-04-16 02:20:23 +00:00
} EHCI_CAPS, *PEHCI_CAPS;
[USBEHCI_NEW] - Cache port status & port change settings because it appears that some ehci controllers do not store the status reset register bit correctly - This commit is a temporary solutions, needs to be reworked - Return correct status from HandleClassOther - Handle IOCTL_INTERNAL_USB_SUBMIT_IDLE_NOTIFICATION to return status success svn path=/branches/usb-bringup/; revision=51473
2011-04-28 12:41:16 +00:00
typedef struct
{
ULONG PortStatus;
ULONG PortChange;
}EHCI_PORT_STATUS;
[USBEHCI] - Partly implement support for interrupt transfers, WIP, untested svn path=/trunk/; revision=55957
2012-03-02 14:21:44 +00:00
#define EHCI_INTERRUPT_ENTRIES_COUNT (10 + 1)
#define EHCI_VFRAMELIST_ENTRIES_COUNT 128
#define EHCI_FRAMELIST_ENTRIES_COUNT 1024
#define MAX_AVAILABLE_BANDWIDTH 125 // Microseconds
#define EHCI_QH_CAPS_MULT_SHIFT 30 // Transactions per Micro-Frame
#define EHCI_QH_CAPS_MULT_MASK 0x03
#define EHCI_QH_CAPS_PORT_SHIFT 23 // Hub Port (Split-Transaction)
#define EHCI_QH_CAPS_PORT_MASK 0x7f
#define EHCI_QH_CAPS_HUB_SHIFT 16 // Hub Address (Split-Transaction)
#define EHCI_QH_CAPS_HUB_MASK 0x7f
#define EHCI_QH_CAPS_SCM_SHIFT 8 // Split Completion Mask
#define EHCI_QH_CAPS_SCM_MASK 0xff
#define EHCI_QH_CAPS_ISM_SHIFT 0 // Interrupt Schedule Mask
[USBEHCI] * Remove inclusions that already exist in the main header. * Cleanup the main header. * Improve the GUIDs situation. CORE-7716 svn path=/trunk/; revision=61502
2014-01-03 17:23:55 +00:00
#define EHCI_QH_CAPS_ISM_MASK 0xff
Reference in a new issue Copy permalink