MdeModulePkg/Bus/Pci/EhciDxe/EhciReg.h

   1 /** @file
   2
   3   This file contains the definination for host controller register operation routines.
   4
   5 Copyright (c) 2007, Intel Corporation
   6 All rights reserved. This program and the accompanying materials
   7 are licensed and made available under the terms and conditions of the BSD License
   8 which accompanies this distribution.  The full text of the license may be found at
   9 http://opensource.org/licenses/bsd-license.php
  10
  11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #ifndef _EFI_EHCI_REG_H_
  17 #define _EFI_EHCI_REG_H_
  18
  19
  20 typedef enum {
  21   //
  22   // Capability register offset
  23   //
  24   EHC_CAPLENGTH_OFFSET    = 0,    // Capability register length offset
  25   EHC_HCSPARAMS_OFFSET    = 0x04, // Structural Parameters 04-07h
  26   EHC_HCCPARAMS_OFFSET    = 0x08, // Capability parameters offset
  27
  28   //
  29   // Capability register bit definition
  30   //
  31   HCSP_NPORTS             = 0x0F, // Number of root hub port
  32   HCCP_64BIT              = 0x01, // 64-bit addressing capability
  33
  34   //
  35   // Operational register offset
  36   //
  37   EHC_USBCMD_OFFSET       = 0x0,  // USB command register offset
  38   EHC_USBSTS_OFFSET       = 0x04, // Statue register offset
  39   EHC_USBINTR_OFFSET      = 0x08, // USB interrutp offset
  40   EHC_FRINDEX_OFFSET      = 0x0C, // Frame index offset
  41   EHC_CTRLDSSEG_OFFSET    = 0x10, // Control data structure segment offset
  42   EHC_FRAME_BASE_OFFSET   = 0x14, // Frame list base address offset
  43   EHC_ASYNC_HEAD_OFFSET   = 0x18, // Next asynchronous list address offset
  44   EHC_CONFIG_FLAG_OFFSET  = 0x40, // Configure flag register offset
  45   EHC_PORT_STAT_OFFSET    = 0x44, // Port status/control offset
  46
  47   EHC_FRAME_LEN           = 1024,
  48
  49   //
  50   // Register bit definition
  51   //
  52   CONFIGFLAG_ROUTE_EHC    = 0x01, // Route port to EHC
  53
  54   USBCMD_RUN              = 0x01,   // Run/stop
  55   USBCMD_RESET            = 0x02,   // Start the host controller reset
  56   USBCMD_ENABLE_PERIOD    = 0x10,   // Enable periodic schedule
  57   USBCMD_ENABLE_ASYNC     = 0x20,   // Enable asynchronous schedule
  58   USBCMD_IAAD             = 0x40,   // Interrupt on async advance doorbell
  59
  60   USBSTS_IAA              = 0x20,   // Interrupt on async advance
  61   USBSTS_PERIOD_ENABLED   = 0x4000, // Periodic schedule status
  62   USBSTS_ASYNC_ENABLED    = 0x8000, // Asynchronous schedule status
  63   USBSTS_HALT             = 0x1000, // Host controller halted
  64   USBSTS_SYS_ERROR        = 0x10,   // Host system error
  65   USBSTS_INTACK_MASK      = 0x003F, // Mask for the interrupt ACK, the WC
  66                                     // (write clean) bits in USBSTS register
  67
  68   PORTSC_CONN             = 0x01,   // Current Connect Status
  69   PORTSC_CONN_CHANGE      = 0x02,   // Connect Status Change
  70   PORTSC_ENABLED          = 0x04,   // Port Enable / Disable
  71   PORTSC_ENABLE_CHANGE    = 0x08,   // Port Enable / Disable Change
  72   PORTSC_OVERCUR          = 0x10,   // Over current Active
  73   PORTSC_OVERCUR_CHANGE   = 0x20,   // Over current Change
  74   PORSTSC_RESUME          = 0x40,   // Force Port Resume
  75   PORTSC_SUSPEND          = 0x80,   // Port Suspend State
  76   PORTSC_RESET            = 0x100,  // Port Reset
  77   PORTSC_LINESTATE_K      = 0x400,  // Line Status K-state
  78   PORTSC_LINESTATE_J      = 0x800,  // Line Status J-state
  79   PORTSC_POWER            = 0x1000, // Port Power
  80   PORTSC_OWNER            = 0x2000, // Port Owner
  81   PORTSC_CHANGE_MASK      = 0x2A,   // Mask of the port change bits,
  82                                     // they are WC (write clean)
  83   //
  84   // PCI Configuration Registers
  85   //
  86   EHC_PCI_CLASSC          = 0x09,
  87   EHC_PCI_CLASSC_PI       = 0x20,
  88   EHC_BAR_INDEX           = 0 /* how many bytes away from USB_BASE to 0x10 */
  89 }EHCI_REGISTER_OFFSET;
  90
  91 #define EHC_LINK_TERMINATED(Link) (((Link) & 0x01) != 0)
  92
  93 #define EHC_ADDR(High, QhHw32)   \
  94         ((VOID *) (UINTN) (LShiftU64 ((High), 32) | ((QhHw32) & 0xFFFFFFF0)))
  95
  96 #define EHCI_IS_DATAIN(EndpointAddr) EHC_BIT_IS_SET((EndpointAddr), 0x80)
  97
  98 //
  99 // Structure to map the hardware port states to the
 100 // UEFI's port states.
 101 //
 102 typedef struct {
 103   UINT16                  HwState;
 104   UINT16                  UefiState;
 105 } USB_PORT_STATE_MAP;
 106
 107 //
 108 // Ehci Data and Ctrl Structures
 109 //
 110 #pragma pack(1)
 111 typedef struct {
 112   UINT8                   PI;
 113   UINT8                   SubClassCode;
 114   UINT8                   BaseCode;
 115 } USB_CLASSC;
 116 #pragma pack()
 117
 118 /**
 119   Read EHCI capability register.
 120
 121   @param  Ehc     The EHCI device.
 122   @param  Offset  Capability register address.
 123
 124   @return The register content.
 125
 126 **/
 127 UINT32
 128 EhcReadCapRegister (
 129   IN  USB2_HC_DEV         *Ehc,
 130   IN  UINT32              Offset
 131   )
 132 ;
 133
 134
 135 /**
 136   Read EHCI Operation register.
 137
 138   @param  Ehc      The EHCI device.
 139   @param  Offset   The operation register offset.
 140
 141   @return The register content.
 142
 143 **/
 144 UINT32
 145 EhcReadOpReg (
 146   IN  USB2_HC_DEV         *Ehc,
 147   IN  UINT32              Offset
 148   )
 149 ;
 150
 151
 152 /**
 153   Write  the data to the EHCI operation register.
 154
 155   @param  Ehc      The EHCI device.
 156   @param  Offset   EHCI operation register offset.
 157   @param  Data     The data to write.
 158
 159   @return None.
 160
 161 **/
 162 VOID
 163 EhcWriteOpReg (
 164   IN USB2_HC_DEV          *Ehc,
 165   IN UINT32               Offset,
 166   IN UINT32               Data
 167   )
 168 ;
 169
 170
 171 /**
 172   Add support for UEFI Over Legacy (UoL) feature, stop
 173   the legacy USB SMI support.
 174
 175   @param  Ehc      The EHCI device.
 176
 177   @return None.
 178
 179 **/
 180 VOID
 181 EhcClearLegacySupport (
 182   IN USB2_HC_DEV          *Ehc
 183   )
 184 ;
 185
 186
 187
 188 /**
 189   Set door bell and wait it to be ACKed by host controller.
 190   This function is used to synchronize with the hardware.
 191
 192   @param  Ehc          The EHCI device.
 193   @param  Timeout      The time to wait before abort (in millisecond, ms).
 194
 195   @retval EFI_SUCCESS  Synchronized with the hardware.
 196   @retval EFI_TIMEOUT  Time out happened while waiting door bell to set.
 197
 198 **/
 199 EFI_STATUS
 200 EhcSetAndWaitDoorBell (
 201   IN  USB2_HC_DEV         *Ehc,
 202   IN  UINT32               Timeout
 203   )
 204 ;
 205
 206
 207 /**
 208   Clear all the interrutp status bits, these bits are Write-Clean.
 209
 210   @param  Ehc      The EHCI device.
 211
 212   @return None.
 213
 214 **/
 215 VOID
 216 EhcAckAllInterrupt (
 217   IN  USB2_HC_DEV         *Ehc
 218   )
 219 ;
 220
 221
 222
 223 /**
 224   Whether Ehc is halted.
 225
 226   @param  Ehc     The EHCI device.
 227
 228   @retval TRUE    The controller is halted.
 229   @retval FALSE   It isn't halted.
 230
 231 **/
 232 BOOLEAN
 233 EhcIsHalt (
 234   IN USB2_HC_DEV          *Ehc
 235   )
 236 ;
 237
 238
 239 /**
 240   Whether system error occurred.
 241
 242   @param  Ehc      The EHCI device.
 243
 244   @retval TRUE     System error happened.
 245   @retval FALSE    No system error.
 246
 247 **/
 248 BOOLEAN
 249 EhcIsSysError (
 250   IN USB2_HC_DEV          *Ehc
 251   )
 252 ;
 253
 254
 255 /**
 256   Reset the host controller.
 257
 258   @param  Ehc          The EHCI device.
 259   @param  Timeout      Time to wait before abort (in millisecond, ms).
 260
 261   @retval EFI_SUCCESS  The host controller is reset.
 262   @return Others       Failed to reset the host.
 263
 264 **/
 265 EFI_STATUS
 266 EhcResetHC (
 267   IN USB2_HC_DEV          *Ehc,
 268   IN UINT32               Timeout
 269   )
 270 ;
 271
 272
 273 /**
 274   Halt the host controller.
 275
 276   @param  Ehc          The EHCI device.
 277   @param  Timeout      Time to wait before abort.
 278
 279   @return EFI_SUCCESS  The EHCI is halt.
 280   @return EFI_TIMEOUT  Failed to halt the controller before Timeout.
 281
 282 **/
 283 EFI_STATUS
 284 EhcHaltHC (
 285   IN USB2_HC_DEV         *Ehc,
 286   IN UINT32              Timeout
 287   )
 288 ;
 289
 290
 291 /**
 292   Set the EHCI to run.
 293
 294   @param  Ehc          The EHCI device.
 295   @param  Timeout      Time to wait before abort.
 296
 297   @return EFI_SUCCESS  The EHCI is running.
 298   @return Others       Failed to set the EHCI to run.
 299
 300 **/
 301 EFI_STATUS
 302 EhcRunHC (
 303   IN USB2_HC_DEV          *Ehc,
 304   IN UINT32               Timeout
 305   )
 306 ;
 307
 308
 309
 310 /**
 311   Initialize the HC hardware.
 312   EHCI spec lists the five things to do to initialize the hardware:
 313   1. Program CTRLDSSEGMENT
 314   2. Set USBINTR to enable interrupts
 315   3. Set periodic list base
 316   4. Set USBCMD, interrupt threshold, frame list size etc
 317   5. Write 1 to CONFIGFLAG to route all ports to EHCI
 318
 319   @param  Ehc          The EHCI device.
 320
 321   @return EFI_SUCCESS  The EHCI has come out of halt state.
 322   @return EFI_TIMEOUT  Time out happened.
 323
 324 **/
 325 EFI_STATUS
 326 EhcInitHC (
 327   IN USB2_HC_DEV          *Ehc
 328   )
 329 ;
 330
 331 #endif