drivers/usb_ohci.h

   1 /*
   2  * URB OHCI HCD (Host Controller Driver) for USB.
   3  *
   4  * (C) Copyright 1999 Roman Weissgaerber <weissg@vienna.at>
   5  * (C) Copyright 2000-2001 David Brownell <dbrownell@users.sourceforge.net>
   6  *
   7  * usb-ohci.h
   8  */
   9
  10 /* functions for doing board or CPU specific setup/cleanup */
  11 extern int usb_board_init(void);
  12 extern int usb_board_stop(void);
  13 extern int usb_cpu_init_fail(void);
  14
  15 extern int usb_cpu_init(void);
  16 extern int usb_cpu_stop(void);
  17 extern int usb_cpu_init_fail(void);
  18
  19
  20 static int cc_to_error[16] = {
  21
  22 /* mapping of the OHCI CC status to error codes */
  23         /* No  Error  */               0,
  24         /* CRC Error  */               USB_ST_CRC_ERR,
  25         /* Bit Stuff  */               USB_ST_BIT_ERR,
  26         /* Data Togg  */               USB_ST_CRC_ERR,
  27         /* Stall      */               USB_ST_STALLED,
  28         /* DevNotResp */               -1,
  29         /* PIDCheck   */               USB_ST_BIT_ERR,
  30         /* UnExpPID   */               USB_ST_BIT_ERR,
  31         /* DataOver   */               USB_ST_BUF_ERR,
  32         /* DataUnder  */               USB_ST_BUF_ERR,
  33         /* reservd    */               -1,
  34         /* reservd    */               -1,
  35         /* BufferOver */               USB_ST_BUF_ERR,
  36         /* BuffUnder  */               USB_ST_BUF_ERR,
  37         /* Not Access */               -1,
  38         /* Not Access */               -1
  39 };
  40
  41 /* ED States */
  42
  43 #define ED_NEW          0x00
  44 #define ED_UNLINK       0x01
  45 #define ED_OPER         0x02
  46 #define ED_DEL          0x04
  47 #define ED_URB_DEL      0x08
  48
  49 /* usb_ohci_ed */
  50 struct ed {
  51         __u32 hwINFO;
  52         __u32 hwTailP;
  53         __u32 hwHeadP;
  54         __u32 hwNextED;
  55
  56         struct ed *ed_prev;
  57         __u8 int_period;
  58         __u8 int_branch;
  59         __u8 int_load;
  60         __u8 int_interval;
  61         __u8 state;
  62         __u8 type;
  63         __u16 last_iso;
  64         struct ed *ed_rm_list;
  65
  66         struct usb_device *usb_dev;
  67         __u32 unused[3];
  68 } __attribute((aligned(16)));
  69 typedef struct ed ed_t;
  70
  71
  72 /* TD info field */
  73 #define TD_CC       0xf0000000
  74 #define TD_CC_GET(td_p) ((td_p >>28) & 0x0f)
  75 #define TD_CC_SET(td_p, cc) (td_p) = ((td_p) & 0x0fffffff) | (((cc) & 0x0f) << 28)
  76 #define TD_EC       0x0C000000
  77 #define TD_T        0x03000000
  78 #define TD_T_DATA0  0x02000000
  79 #define TD_T_DATA1  0x03000000
  80 #define TD_T_TOGGLE 0x00000000
  81 #define TD_R        0x00040000
  82 #define TD_DI       0x00E00000
  83 #define TD_DI_SET(X) (((X) & 0x07)<< 21)
  84 #define TD_DP       0x00180000
  85 #define TD_DP_SETUP 0x00000000
  86 #define TD_DP_IN    0x00100000
  87 #define TD_DP_OUT   0x00080000
  88
  89 #define TD_ISO      0x00010000
  90 #define TD_DEL      0x00020000
  91
  92 /* CC Codes */
  93 #define TD_CC_NOERROR      0x00
  94 #define TD_CC_CRC          0x01
  95 #define TD_CC_BITSTUFFING  0x02
  96 #define TD_CC_DATATOGGLEM  0x03
  97 #define TD_CC_STALL        0x04
  98 #define TD_DEVNOTRESP      0x05
  99 #define TD_PIDCHECKFAIL    0x06
 100 #define TD_UNEXPECTEDPID   0x07
 101 #define TD_DATAOVERRUN     0x08
 102 #define TD_DATAUNDERRUN    0x09
 103 #define TD_BUFFEROVERRUN   0x0C
 104 #define TD_BUFFERUNDERRUN  0x0D
 105 #define TD_NOTACCESSED     0x0F
 106
 107
 108 #define MAXPSW 1
 109
 110 struct td {
 111         __u32 hwINFO;
 112         __u32 hwCBP;            /* Current Buffer Pointer */
 113         __u32 hwNextTD;         /* Next TD Pointer */
 114         __u32 hwBE;             /* Memory Buffer End Pointer */
 115
 116 /* #ifndef CONFIG_MPC5200 /\* this seems wrong *\/ */
 117         __u16 hwPSW[MAXPSW];
 118 /* #endif */
 119         __u8 unused;
 120         __u8 index;
 121         struct ed *ed;
 122         struct td *next_dl_td;
 123         struct usb_device *usb_dev;
 124         int transfer_len;
 125         __u32 data;
 126
 127         __u32 unused2[2];
 128 } __attribute((aligned(32)));
 129 typedef struct td td_t;
 130
 131 #define OHCI_ED_SKIP    (1 << 14)
 132
 133 /*
 134  * The HCCA (Host Controller Communications Area) is a 256 byte
 135  * structure defined in the OHCI spec. that the host controller is
 136  * told the base address of.  It must be 256-byte aligned.
 137  */
 138
 139 #define NUM_INTS 32     /* part of the OHCI standard */
 140 struct ohci_hcca {
 141         __u32   int_table[NUM_INTS];    /* Interrupt ED table */
 142 #if defined(CONFIG_MPC5200)
 143         __u16   pad1;                   /* set to 0 on each frame_no change */
 144         __u16   frame_no;               /* current frame number */
 145 #else
 146         __u16   frame_no;               /* current frame number */
 147         __u16   pad1;                   /* set to 0 on each frame_no change */
 148 #endif
 149         __u32   done_head;              /* info returned for an interrupt */
 150         u8              reserved_for_hc[116];
 151 } __attribute((aligned(256)));
 152
 153
 154 /*
 155  * Maximum number of root hub ports.
 156  */
 157 #ifndef CFG_USB_OHCI_MAX_ROOT_PORTS
 158 # error "CFG_USB_OHCI_MAX_ROOT_PORTS undefined!"
 159 #endif
 160
 161 /*
 162  * This is the structure of the OHCI controller's memory mapped I/O
 163  * region.  This is Memory Mapped I/O.  You must use the readl() and
 164  * writel() macros defined in asm/io.h to access these!!
 165  */
 166 struct ohci_regs {
 167         /* control and status registers */
 168         __u32   revision;
 169         __u32   control;
 170         __u32   cmdstatus;
 171         __u32   intrstatus;
 172         __u32   intrenable;
 173         __u32   intrdisable;
 174         /* memory pointers */
 175         __u32   hcca;
 176         __u32   ed_periodcurrent;
 177         __u32   ed_controlhead;
 178         __u32   ed_controlcurrent;
 179         __u32   ed_bulkhead;
 180         __u32   ed_bulkcurrent;
 181         __u32   donehead;
 182         /* frame counters */
 183         __u32   fminterval;
 184         __u32   fmremaining;
 185         __u32   fmnumber;
 186         __u32   periodicstart;
 187         __u32   lsthresh;
 188         /* Root hub ports */
 189         struct  ohci_roothub_regs {
 190                 __u32   a;
 191                 __u32   b;
 192                 __u32   status;
 193                 __u32   portstatus[CFG_USB_OHCI_MAX_ROOT_PORTS];
 194         } roothub;
 195 } __attribute((aligned(32)));
 196
 197
 198 /* OHCI CONTROL AND STATUS REGISTER MASKS */
 199
 200 /*
 201  * HcControl (control) register masks
 202  */
 203 #define OHCI_CTRL_CBSR  (3 << 0)        /* control/bulk service ratio */
 204 #define OHCI_CTRL_PLE   (1 << 2)        /* periodic list enable */
 205 #define OHCI_CTRL_IE    (1 << 3)        /* isochronous enable */
 206 #define OHCI_CTRL_CLE   (1 << 4)        /* control list enable */
 207 #define OHCI_CTRL_BLE   (1 << 5)        /* bulk list enable */
 208 #define OHCI_CTRL_HCFS  (3 << 6)        /* host controller functional state */
 209 #define OHCI_CTRL_IR    (1 << 8)        /* interrupt routing */
 210 #define OHCI_CTRL_RWC   (1 << 9)        /* remote wakeup connected */
 211 #define OHCI_CTRL_RWE   (1 << 10)       /* remote wakeup enable */
 212
 213 /* pre-shifted values for HCFS */
 214 #       define OHCI_USB_RESET   (0 << 6)
 215 #       define OHCI_USB_RESUME  (1 << 6)
 216 #       define OHCI_USB_OPER    (2 << 6)
 217 #       define OHCI_USB_SUSPEND (3 << 6)
 218
 219 /*
 220  * HcCommandStatus (cmdstatus) register masks
 221  */
 222 #define OHCI_HCR        (1 << 0)        /* host controller reset */
 223 #define OHCI_CLF        (1 << 1)        /* control list filled */
 224 #define OHCI_BLF        (1 << 2)        /* bulk list filled */
 225 #define OHCI_OCR        (1 << 3)        /* ownership change request */
 226 #define OHCI_SOC        (3 << 16)       /* scheduling overrun count */
 227
 228 /*
 229  * masks used with interrupt registers:
 230  * HcInterruptStatus (intrstatus)
 231  * HcInterruptEnable (intrenable)
 232  * HcInterruptDisable (intrdisable)
 233  */
 234 #define OHCI_INTR_SO    (1 << 0)        /* scheduling overrun */
 235 #define OHCI_INTR_WDH   (1 << 1)        /* writeback of done_head */
 236 #define OHCI_INTR_SF    (1 << 2)        /* start frame */
 237 #define OHCI_INTR_RD    (1 << 3)        /* resume detect */
 238 #define OHCI_INTR_UE    (1 << 4)        /* unrecoverable error */
 239 #define OHCI_INTR_FNO   (1 << 5)        /* frame number overflow */
 240 #define OHCI_INTR_RHSC  (1 << 6)        /* root hub status change */
 241 #define OHCI_INTR_OC    (1 << 30)       /* ownership change */
 242 #define OHCI_INTR_MIE   (1 << 31)       /* master interrupt enable */
 243
 244
 245 /* Virtual Root HUB */
 246 struct virt_root_hub {
 247         int devnum; /* Address of Root Hub endpoint */
 248         void *dev;  /* was urb */
 249         void *int_addr;
 250         int send;
 251         int interval;
 252 };
 253
 254 /* USB HUB CONSTANTS (not OHCI-specific; see hub.h) */
 255
 256 /* destination of request */
 257 #define RH_INTERFACE               0x01
 258 #define RH_ENDPOINT                0x02
 259 #define RH_OTHER                   0x03
 260
 261 #define RH_CLASS                   0x20
 262 #define RH_VENDOR                  0x40
 263
 264 /* Requests: bRequest << 8 | bmRequestType */
 265 #define RH_GET_STATUS           0x0080
 266 #define RH_CLEAR_FEATURE        0x0100
 267 #define RH_SET_FEATURE          0x0300
 268 #define RH_SET_ADDRESS          0x0500
 269 #define RH_GET_DESCRIPTOR       0x0680
 270 #define RH_SET_DESCRIPTOR       0x0700
 271 #define RH_GET_CONFIGURATION    0x0880
 272 #define RH_SET_CONFIGURATION    0x0900
 273 #define RH_GET_STATE            0x0280
 274 #define RH_GET_INTERFACE        0x0A80
 275 #define RH_SET_INTERFACE        0x0B00
 276 #define RH_SYNC_FRAME           0x0C80
 277 /* Our Vendor Specific Request */
 278 #define RH_SET_EP               0x2000
 279
 280
 281 /* Hub port features */
 282 #define RH_PORT_CONNECTION         0x00
 283 #define RH_PORT_ENABLE             0x01
 284 #define RH_PORT_SUSPEND            0x02
 285 #define RH_PORT_OVER_CURRENT       0x03
 286 #define RH_PORT_RESET              0x04
 287 #define RH_PORT_POWER              0x08
 288 #define RH_PORT_LOW_SPEED          0x09
 289
 290 #define RH_C_PORT_CONNECTION       0x10
 291 #define RH_C_PORT_ENABLE           0x11
 292 #define RH_C_PORT_SUSPEND          0x12
 293 #define RH_C_PORT_OVER_CURRENT     0x13
 294 #define RH_C_PORT_RESET            0x14
 295
 296 /* Hub features */
 297 #define RH_C_HUB_LOCAL_POWER       0x00
 298 #define RH_C_HUB_OVER_CURRENT      0x01
 299
 300 #define RH_DEVICE_REMOTE_WAKEUP    0x00
 301 #define RH_ENDPOINT_STALL          0x01
 302
 303 #define RH_ACK                     0x01
 304 #define RH_REQ_ERR                 -1
 305 #define RH_NACK                    0x00
 306
 307
 308 /* OHCI ROOT HUB REGISTER MASKS */
 309
 310 /* roothub.portstatus [i] bits */
 311 #define RH_PS_CCS            0x00000001         /* current connect status */
 312 #define RH_PS_PES            0x00000002         /* port enable status*/
 313 #define RH_PS_PSS            0x00000004         /* port suspend status */
 314 #define RH_PS_POCI           0x00000008         /* port over current indicator */
 315 #define RH_PS_PRS            0x00000010         /* port reset status */
 316 #define RH_PS_PPS            0x00000100         /* port power status */
 317 #define RH_PS_LSDA           0x00000200         /* low speed device attached */
 318 #define RH_PS_CSC            0x00010000         /* connect status change */
 319 #define RH_PS_PESC           0x00020000         /* port enable status change */
 320 #define RH_PS_PSSC           0x00040000         /* port suspend status change */
 321 #define RH_PS_OCIC           0x00080000         /* over current indicator change */
 322 #define RH_PS_PRSC           0x00100000         /* port reset status change */
 323
 324 /* roothub.status bits */
 325 #define RH_HS_LPS            0x00000001         /* local power status */
 326 #define RH_HS_OCI            0x00000002         /* over current indicator */
 327 #define RH_HS_DRWE           0x00008000         /* device remote wakeup enable */
 328 #define RH_HS_LPSC           0x00010000         /* local power status change */
 329 #define RH_HS_OCIC           0x00020000         /* over current indicator change */
 330 #define RH_HS_CRWE           0x80000000         /* clear remote wakeup enable */
 331
 332 /* roothub.b masks */
 333 #define RH_B_DR         0x0000ffff              /* device removable flags */
 334 #define RH_B_PPCM       0xffff0000              /* port power control mask */
 335
 336 /* roothub.a masks */
 337 #define RH_A_NDP        (0xff << 0)             /* number of downstream ports */
 338 #define RH_A_PSM        (1 << 8)                /* power switching mode */
 339 #define RH_A_NPS        (1 << 9)                /* no power switching */
 340 #define RH_A_DT         (1 << 10)               /* device type (mbz) */
 341 #define RH_A_OCPM       (1 << 11)               /* over current protection mode */
 342 #define RH_A_NOCP       (1 << 12)               /* no over current protection */
 343 #define RH_A_POTPGT     (0xff << 24)            /* power on to power good time */
 344
 345 /* urb */
 346 #define N_URB_TD 48
 347 typedef struct
 348 {
 349         ed_t *ed;
 350         __u16 length;   /* number of tds associated with this request */
 351         __u16 td_cnt;   /* number of tds already serviced */
 352         int   state;
 353         unsigned long pipe;
 354         int actual_length;
 355         td_t *td[N_URB_TD];     /* list pointer to all corresponding TDs associated with this request */
 356 } urb_priv_t;
 357 #define URB_DEL 1
 358
 359 /*
 360  * This is the full ohci controller description
 361  *
 362  * Note how the "proper" USB information is just
 363  * a subset of what the full implementation needs. (Linus)
 364  */
 365
 366
 367 typedef struct ohci {
 368         struct ohci_hcca *hcca;         /* hcca */
 369         /*dma_addr_t hcca_dma;*/
 370
 371         int irq;
 372         int disabled;                   /* e.g. got a UE, we're hung */
 373         int sleeping;
 374         unsigned long flags;            /* for HC bugs */
 375
 376         struct ohci_regs *regs; /* OHCI controller's memory */
 377
 378         ed_t *ed_rm_list[2];     /* lists of all endpoints to be removed */
 379         ed_t *ed_bulktail;       /* last endpoint of bulk list */
 380         ed_t *ed_controltail;    /* last endpoint of control list */
 381         int intrstatus;
 382         __u32 hc_control;               /* copy of the hc control reg */
 383         struct usb_device *dev[32];
 384         struct virt_root_hub rh;
 385
 386         const char      *slot_name;
 387 } ohci_t;
 388
 389 #define NUM_EDS 8               /* num of preallocated endpoint descriptors */
 390
 391 struct ohci_device {
 392         ed_t    ed[NUM_EDS];
 393         int ed_cnt;
 394 };
 395
 396 /* hcd */
 397 /* endpoint */
 398 static int ep_link(ohci_t * ohci, ed_t * ed);
 399 static int ep_unlink(ohci_t * ohci, ed_t * ed);
 400 static ed_t * ep_add_ed(struct usb_device * usb_dev, unsigned long pipe);
 401
 402 /*-------------------------------------------------------------------------*/
 403
 404 /* we need more TDs than EDs */
 405 #define NUM_TD 64
 406
 407 /* +1 so we can align the storage */
 408 td_t gtd[NUM_TD+1];
 409 /* pointers to aligned storage */
 410 td_t *ptd;
 411
 412 /* TDs ... */
 413 static inline struct td *
 414 td_alloc (struct usb_device *usb_dev)
 415 {
 416         int i;
 417         struct td       *td;
 418
 419         td = NULL;
 420         for (i = 0; i < NUM_TD; i++)
 421         {
 422                 if (ptd[i].usb_dev == NULL)
 423                 {
 424                         td = &ptd[i];
 425                         td->usb_dev = usb_dev;
 426                         break;
 427                 }
 428         }
 429
 430         return td;
 431 }
 432
 433 static inline void
 434 ed_free (struct ed *ed)
 435 {
 436         ed->usb_dev = NULL;
 437 }