drivers/usb/host/isp116x.h

   1 /*
   2  * ISP116x register declarations and HCD data structures
   3  *
   4  * Copyright (C) 2007 Rodolfo Giometti <giometti@linux.it>
   5  * Copyright (C) 2007 Eurotech S.p.A. <info@eurotech.it>
   6  * Copyright (C) 2005 Olav Kongas <ok@artecdesign.ee>
   7  * Portions:
   8  * Copyright (C) 2004 Lothar Wassmann
   9  * Copyright (C) 2004 Psion Teklogix
  10  * Copyright (C) 2004 David Brownell
  11  *
  12  * SPDX-License-Identifier:     GPL-2.0+
  13  */
  14
  15 #ifdef DEBUG
  16 #define DBG(fmt, args...)       \
  17                 printf("isp116x: %s: " fmt "\n" , __FUNCTION__ , ## args)
  18 #else
  19 #define DBG(fmt, args...)       do {} while (0)
  20 #endif
  21
  22 #ifdef VERBOSE
  23 #    define VDBG                DBG
  24 #else
  25 #    define VDBG(fmt, args...)  do {} while (0)
  26 #endif
  27
  28 #define ERR(fmt, args...)       \
  29                 printf("isp116x: %s: " fmt "\n" , __FUNCTION__ , ## args)
  30 #define WARN(fmt, args...)      \
  31                 printf("isp116x: %s: " fmt "\n" , __FUNCTION__ , ## args)
  32 #define INFO(fmt, args...)      \
  33                 printf("isp116x: " fmt "\n" , ## args)
  34
  35 /* ------------------------------------------------------------------------- */
  36
  37 /* us of 1ms frame */
  38 #define  MAX_LOAD_LIMIT         850
  39
  40 /* Full speed: max # of bytes to transfer for a single urb
  41    at a time must be < 1024 && must be multiple of 64.
  42    832 allows transfering 4kiB within 5 frames. */
  43 #define MAX_TRANSFER_SIZE_FULLSPEED     832
  44
  45 /* Low speed: there is no reason to schedule in very big
  46    chunks; often the requested long transfers are for
  47    string descriptors containing short strings. */
  48 #define MAX_TRANSFER_SIZE_LOWSPEED      64
  49
  50 /* Bytetime (us), a rough indication of how much time it
  51    would take to transfer a byte of useful data over USB */
  52 #define BYTE_TIME_FULLSPEED     1
  53 #define BYTE_TIME_LOWSPEED      20
  54
  55 /* Buffer sizes */
  56 #define ISP116x_BUF_SIZE        4096
  57 #define ISP116x_ITL_BUFSIZE     0
  58 #define ISP116x_ATL_BUFSIZE     ((ISP116x_BUF_SIZE) - 2*(ISP116x_ITL_BUFSIZE))
  59
  60 #define ISP116x_WRITE_OFFSET    0x80
  61
  62 /* --- ISP116x registers/bits ---------------------------------------------- */
  63
  64 #define HCREVISION      0x00
  65 #define HCCONTROL       0x01
  66 #define         HCCONTROL_HCFS  (3 << 6)        /* host controller
  67                                                    functional state */
  68 #define         HCCONTROL_USB_RESET     (0 << 6)
  69 #define         HCCONTROL_USB_RESUME    (1 << 6)
  70 #define         HCCONTROL_USB_OPER      (2 << 6)
  71 #define         HCCONTROL_USB_SUSPEND   (3 << 6)
  72 #define         HCCONTROL_RWC   (1 << 9)        /* remote wakeup connected */
  73 #define         HCCONTROL_RWE   (1 << 10)       /* remote wakeup enable */
  74 #define HCCMDSTAT       0x02
  75 #define         HCCMDSTAT_HCR   (1 << 0)        /* host controller reset */
  76 #define         HCCMDSTAT_SOC   (3 << 16)       /* scheduling overrun count */
  77 #define HCINTSTAT       0x03
  78 #define         HCINT_SO        (1 << 0)        /* scheduling overrun */
  79 #define         HCINT_WDH       (1 << 1)        /* writeback of done_head */
  80 #define         HCINT_SF        (1 << 2)        /* start frame */
  81 #define         HCINT_RD        (1 << 3)        /* resume detect */
  82 #define         HCINT_UE        (1 << 4)        /* unrecoverable error */
  83 #define         HCINT_FNO       (1 << 5)        /* frame number overflow */
  84 #define         HCINT_RHSC      (1 << 6)        /* root hub status change */
  85 #define         HCINT_OC        (1 << 30)       /* ownership change */
  86 #define         HCINT_MIE       (1 << 31)       /* master interrupt enable */
  87 #define HCINTENB        0x04
  88 #define HCINTDIS        0x05
  89 #define HCFMINTVL       0x0d
  90 #define HCFMREM         0x0e
  91 #define HCFMNUM         0x0f
  92 #define HCLSTHRESH      0x11
  93 #define HCRHDESCA       0x12
  94 #define         RH_A_NDP        (0x3 << 0)      /* # downstream ports */
  95 #define         RH_A_PSM        (1 << 8)        /* power switching mode */
  96 #define         RH_A_NPS        (1 << 9)        /* no power switching */
  97 #define         RH_A_DT         (1 << 10)       /* device type (mbz) */
  98 #define         RH_A_OCPM       (1 << 11)       /* overcurrent protection
  99                                                    mode */
 100 #define         RH_A_NOCP       (1 << 12)       /* no overcurrent protection */
 101 #define         RH_A_POTPGT     (0xff << 24)    /* power on -> power good
 102                                                    time */
 103 #define HCRHDESCB       0x13
 104 #define         RH_B_DR         (0xffff << 0)   /* device removable flags */
 105 #define         RH_B_PPCM       (0xffff << 16)  /* port power control mask */
 106 #define HCRHSTATUS      0x14
 107 #define         RH_HS_LPS       (1 << 0)        /* local power status */
 108 #define         RH_HS_OCI       (1 << 1)        /* over current indicator */
 109 #define         RH_HS_DRWE      (1 << 15)       /* device remote wakeup
 110                                                    enable */
 111 #define         RH_HS_LPSC      (1 << 16)       /* local power status change */
 112 #define         RH_HS_OCIC      (1 << 17)       /* over current indicator
 113                                                    change */
 114 #define         RH_HS_CRWE      (1 << 31)       /* clear remote wakeup
 115                                                    enable */
 116 #define HCRHPORT1       0x15
 117 #define         RH_PS_CCS       (1 << 0)        /* current connect status */
 118 #define         RH_PS_PES       (1 << 1)        /* port enable status */
 119 #define         RH_PS_PSS       (1 << 2)        /* port suspend status */
 120 #define         RH_PS_POCI      (1 << 3)        /* port over current
 121                                                    indicator */
 122 #define         RH_PS_PRS       (1 << 4)        /* port reset status */
 123 #define         RH_PS_PPS       (1 << 8)        /* port power status */
 124 #define         RH_PS_LSDA      (1 << 9)        /* low speed device attached */
 125 #define         RH_PS_CSC       (1 << 16)       /* connect status change */
 126 #define         RH_PS_PESC      (1 << 17)       /* port enable status change */
 127 #define         RH_PS_PSSC      (1 << 18)       /* port suspend status
 128                                                    change */
 129 #define         RH_PS_OCIC      (1 << 19)       /* over current indicator
 130                                                    change */
 131 #define         RH_PS_PRSC      (1 << 20)       /* port reset status change */
 132 #define         HCRHPORT_CLRMASK        (0x1f << 16)
 133 #define HCRHPORT2       0x16
 134 #define HCHWCFG         0x20
 135 #define         HCHWCFG_15KRSEL         (1 << 12)
 136 #define         HCHWCFG_CLKNOTSTOP      (1 << 11)
 137 #define         HCHWCFG_ANALOG_OC       (1 << 10)
 138 #define         HCHWCFG_DACK_MODE       (1 << 8)
 139 #define         HCHWCFG_EOT_POL         (1 << 7)
 140 #define         HCHWCFG_DACK_POL        (1 << 6)
 141 #define         HCHWCFG_DREQ_POL        (1 << 5)
 142 #define         HCHWCFG_DBWIDTH_MASK    (0x03 << 3)
 143 #define         HCHWCFG_DBWIDTH(n)      (((n) << 3) & HCHWCFG_DBWIDTH_MASK)
 144 #define         HCHWCFG_INT_POL         (1 << 2)
 145 #define         HCHWCFG_INT_TRIGGER     (1 << 1)
 146 #define         HCHWCFG_INT_ENABLE      (1 << 0)
 147 #define HCDMACFG        0x21
 148 #define         HCDMACFG_BURST_LEN_MASK (0x03 << 5)
 149 #define         HCDMACFG_BURST_LEN(n)   (((n) << 5) & HCDMACFG_BURST_LEN_MASK)
 150 #define         HCDMACFG_BURST_LEN_1    HCDMACFG_BURST_LEN(0)
 151 #define         HCDMACFG_BURST_LEN_4    HCDMACFG_BURST_LEN(1)
 152 #define         HCDMACFG_BURST_LEN_8    HCDMACFG_BURST_LEN(2)
 153 #define         HCDMACFG_DMA_ENABLE     (1 << 4)
 154 #define         HCDMACFG_BUF_TYPE_MASK  (0x07 << 1)
 155 #define         HCDMACFG_CTR_SEL        (1 << 2)
 156 #define         HCDMACFG_ITLATL_SEL     (1 << 1)
 157 #define         HCDMACFG_DMA_RW_SELECT  (1 << 0)
 158 #define HCXFERCTR       0x22
 159 #define HCuPINT         0x24
 160 #define         HCuPINT_SOF             (1 << 0)
 161 #define         HCuPINT_ATL             (1 << 1)
 162 #define         HCuPINT_AIIEOT          (1 << 2)
 163 #define         HCuPINT_OPR             (1 << 4)
 164 #define         HCuPINT_SUSP            (1 << 5)
 165 #define         HCuPINT_CLKRDY          (1 << 6)
 166 #define HCuPINTENB      0x25
 167 #define HCCHIPID        0x27
 168 #define         HCCHIPID_MASK           0xff00
 169 #define         HCCHIPID_MAGIC          0x6100
 170 #define HCSCRATCH       0x28
 171 #define HCSWRES         0x29
 172 #define         HCSWRES_MAGIC           0x00f6
 173 #define HCITLBUFLEN     0x2a
 174 #define HCATLBUFLEN     0x2b
 175 #define HCBUFSTAT       0x2c
 176 #define         HCBUFSTAT_ITL0_FULL     (1 << 0)
 177 #define         HCBUFSTAT_ITL1_FULL     (1 << 1)
 178 #define         HCBUFSTAT_ATL_FULL      (1 << 2)
 179 #define         HCBUFSTAT_ITL0_DONE     (1 << 3)
 180 #define         HCBUFSTAT_ITL1_DONE     (1 << 4)
 181 #define         HCBUFSTAT_ATL_DONE      (1 << 5)
 182 #define HCRDITL0LEN     0x2d
 183 #define HCRDITL1LEN     0x2e
 184 #define HCITLPORT       0x40
 185 #define HCATLPORT       0x41
 186
 187 /* PTD accessor macros. */
 188 #define PTD_GET_COUNT(p)        (((p)->count & PTD_COUNT_MSK) >> 0)
 189 #define PTD_COUNT(v)            (((v) << 0) & PTD_COUNT_MSK)
 190 #define PTD_GET_TOGGLE(p)       (((p)->count & PTD_TOGGLE_MSK) >> 10)
 191 #define PTD_TOGGLE(v)           (((v) << 10) & PTD_TOGGLE_MSK)
 192 #define PTD_GET_ACTIVE(p)       (((p)->count & PTD_ACTIVE_MSK) >> 11)
 193 #define PTD_ACTIVE(v)           (((v) << 11) & PTD_ACTIVE_MSK)
 194 #define PTD_GET_CC(p)           (((p)->count & PTD_CC_MSK) >> 12)
 195 #define PTD_CC(v)               (((v) << 12) & PTD_CC_MSK)
 196 #define PTD_GET_MPS(p)          (((p)->mps & PTD_MPS_MSK) >> 0)
 197 #define PTD_MPS(v)              (((v) << 0) & PTD_MPS_MSK)
 198 #define PTD_GET_SPD(p)          (((p)->mps & PTD_SPD_MSK) >> 10)
 199 #define PTD_SPD(v)              (((v) << 10) & PTD_SPD_MSK)
 200 #define PTD_GET_LAST(p)         (((p)->mps & PTD_LAST_MSK) >> 11)
 201 #define PTD_LAST(v)             (((v) << 11) & PTD_LAST_MSK)
 202 #define PTD_GET_EP(p)           (((p)->mps & PTD_EP_MSK) >> 12)
 203 #define PTD_EP(v)               (((v) << 12) & PTD_EP_MSK)
 204 #define PTD_GET_LEN(p)          (((p)->len & PTD_LEN_MSK) >> 0)
 205 #define PTD_LEN(v)              (((v) << 0) & PTD_LEN_MSK)
 206 #define PTD_GET_DIR(p)          (((p)->len & PTD_DIR_MSK) >> 10)
 207 #define PTD_DIR(v)              (((v) << 10) & PTD_DIR_MSK)
 208 #define PTD_GET_B5_5(p)         (((p)->len & PTD_B5_5_MSK) >> 13)
 209 #define PTD_B5_5(v)             (((v) << 13) & PTD_B5_5_MSK)
 210 #define PTD_GET_FA(p)           (((p)->faddr & PTD_FA_MSK) >> 0)
 211 #define PTD_FA(v)               (((v) << 0) & PTD_FA_MSK)
 212 #define PTD_GET_FMT(p)          (((p)->faddr & PTD_FMT_MSK) >> 7)
 213 #define PTD_FMT(v)              (((v) << 7) & PTD_FMT_MSK)
 214
 215 /*  Hardware transfer status codes -- CC from ptd->count */
 216 #define TD_CC_NOERROR      0x00
 217 #define TD_CC_CRC          0x01
 218 #define TD_CC_BITSTUFFING  0x02
 219 #define TD_CC_DATATOGGLEM  0x03
 220 #define TD_CC_STALL        0x04
 221 #define TD_DEVNOTRESP      0x05
 222 #define TD_PIDCHECKFAIL    0x06
 223 #define TD_UNEXPECTEDPID   0x07
 224 #define TD_DATAOVERRUN     0x08
 225 #define TD_DATAUNDERRUN    0x09
 226     /* 0x0A, 0x0B reserved for hardware */
 227 #define TD_BUFFEROVERRUN   0x0C
 228 #define TD_BUFFERUNDERRUN  0x0D
 229     /* 0x0E, 0x0F reserved for HCD */
 230 #define TD_NOTACCESSED     0x0F
 231
 232 /* ------------------------------------------------------------------------- */
 233
 234 #define LOG2_PERIODIC_SIZE      5       /* arbitrary; this matches OHCI */
 235 #define PERIODIC_SIZE           (1 << LOG2_PERIODIC_SIZE)
 236
 237 /* Philips transfer descriptor */
 238 struct ptd {
 239         u16 count;
 240 #define PTD_COUNT_MSK   (0x3ff << 0)
 241 #define PTD_TOGGLE_MSK  (1 << 10)
 242 #define PTD_ACTIVE_MSK  (1 << 11)
 243 #define PTD_CC_MSK      (0xf << 12)
 244         u16 mps;
 245 #define PTD_MPS_MSK     (0x3ff << 0)
 246 #define PTD_SPD_MSK     (1 << 10)
 247 #define PTD_LAST_MSK    (1 << 11)
 248 #define PTD_EP_MSK      (0xf << 12)
 249         u16 len;
 250 #define PTD_LEN_MSK     (0x3ff << 0)
 251 #define PTD_DIR_MSK     (3 << 10)
 252 #define PTD_DIR_SETUP   (0)
 253 #define PTD_DIR_OUT     (1)
 254 #define PTD_DIR_IN      (2)
 255 #define PTD_B5_5_MSK    (1 << 13)
 256         u16 faddr;
 257 #define PTD_FA_MSK      (0x7f << 0)
 258 #define PTD_FMT_MSK     (1 << 7)
 259 } __attribute__ ((packed, aligned(2)));
 260
 261 struct isp116x_ep {
 262         struct usb_device *udev;
 263         struct ptd ptd;
 264
 265         u8 maxpacket;
 266         u8 epnum;
 267         u8 nextpid;
 268
 269         u16 length;             /* of current packet */
 270         unsigned char *data;    /* to databuf */
 271
 272         u16 error_count;
 273 };
 274
 275 /* URB struct */
 276 #define N_URB_TD                48
 277 #define URB_DEL                 1
 278 typedef struct {
 279         struct isp116x_ep *ed;
 280         void *transfer_buffer;  /* (in) associated data buffer */
 281         int actual_length;      /* (return) actual transfer length */
 282         unsigned long pipe;     /* (in) pipe information */
 283 #if 0
 284         int state;
 285 #endif
 286 } urb_priv_t;
 287
 288 struct isp116x_platform_data {
 289         /* Enable internal resistors on downstream ports */
 290         unsigned sel15Kres:1;
 291         /* On-chip overcurrent detection */
 292         unsigned oc_enable:1;
 293         /* Enable wakeup by devices on usb bus (e.g. wakeup
 294            by attachment/detachment or by device activity
 295            such as moving a mouse). When chosen, this option
 296            prevents stopping internal clock, increasing
 297            thereby power consumption in suspended state. */
 298         unsigned remote_wakeup_enable:1;
 299 };
 300
 301 struct isp116x {
 302         u16 *addr_reg;
 303         u16 *data_reg;
 304
 305         struct isp116x_platform_data *board;
 306
 307         struct dentry *dentry;
 308         unsigned long stat1, stat2, stat4, stat8, stat16;
 309
 310         /* Status flags */
 311         unsigned disabled:1;
 312         unsigned sleeping:1;
 313
 314         /* Root hub registers */
 315         u32 rhdesca;
 316         u32 rhdescb;
 317         u32 rhstatus;
 318         u32 rhport[2];
 319
 320         /* Schedule for the current frame */
 321         struct isp116x_ep *atl_active;
 322         int atl_buflen;
 323         int atl_bufshrt;
 324         int atl_last_dir;
 325         int atl_finishing;
 326 };
 327
 328 /* ------------------------------------------------- */
 329
 330 /* Inter-io delay (ns). The chip is picky about access timings; it
 331  * expects at least:
 332  * 150ns delay between consecutive accesses to DATA_REG,
 333  * 300ns delay between access to ADDR_REG and DATA_REG
 334  * OE, WE MUST NOT be changed during these intervals
 335  */
 336 #if defined(UDELAY)
 337 #define isp116x_delay(h,d)      udelay(d)
 338 #else
 339 #define isp116x_delay(h,d)      do {} while (0)
 340 #endif
 341
 342 static inline void isp116x_write_addr(struct isp116x *isp116x, unsigned reg)
 343 {
 344         writew(reg & 0xff, isp116x->addr_reg);
 345         isp116x_delay(isp116x, UDELAY);
 346 }
 347
 348 static inline void isp116x_write_data16(struct isp116x *isp116x, u16 val)
 349 {
 350         writew(val, isp116x->data_reg);
 351         isp116x_delay(isp116x, UDELAY);
 352 }
 353
 354 static inline void isp116x_raw_write_data16(struct isp116x *isp116x, u16 val)
 355 {
 356         __raw_writew(val, isp116x->data_reg);
 357         isp116x_delay(isp116x, UDELAY);
 358 }
 359
 360 static inline u16 isp116x_read_data16(struct isp116x *isp116x)
 361 {
 362         u16 val;
 363
 364         val = readw(isp116x->data_reg);
 365         isp116x_delay(isp116x, UDELAY);
 366         return val;
 367 }
 368
 369 static inline u16 isp116x_raw_read_data16(struct isp116x *isp116x)
 370 {
 371         u16 val;
 372
 373         val = __raw_readw(isp116x->data_reg);
 374         isp116x_delay(isp116x, UDELAY);
 375         return val;
 376 }
 377
 378 static inline void isp116x_write_data32(struct isp116x *isp116x, u32 val)
 379 {
 380         writew(val & 0xffff, isp116x->data_reg);
 381         isp116x_delay(isp116x, UDELAY);
 382         writew(val >> 16, isp116x->data_reg);
 383         isp116x_delay(isp116x, UDELAY);
 384 }
 385
 386 static inline u32 isp116x_read_data32(struct isp116x *isp116x)
 387 {
 388         u32 val;
 389
 390         val = (u32) readw(isp116x->data_reg);
 391         isp116x_delay(isp116x, UDELAY);
 392         val |= ((u32) readw(isp116x->data_reg)) << 16;
 393         isp116x_delay(isp116x, UDELAY);
 394         return val;
 395 }
 396
 397 /* Let's keep register access functions out of line. Hint:
 398    we wait at least 150 ns at every access.
 399 */
 400 static u16 isp116x_read_reg16(struct isp116x *isp116x, unsigned reg)
 401 {
 402         isp116x_write_addr(isp116x, reg);
 403         return isp116x_read_data16(isp116x);
 404 }
 405
 406 static u32 isp116x_read_reg32(struct isp116x *isp116x, unsigned reg)
 407 {
 408         isp116x_write_addr(isp116x, reg);
 409         return isp116x_read_data32(isp116x);
 410 }
 411
 412 static void isp116x_write_reg16(struct isp116x *isp116x, unsigned reg,
 413                                 unsigned val)
 414 {
 415         isp116x_write_addr(isp116x, reg | ISP116x_WRITE_OFFSET);
 416         isp116x_write_data16(isp116x, (u16) (val & 0xffff));
 417 }
 418
 419 static void isp116x_write_reg32(struct isp116x *isp116x, unsigned reg,
 420                                 unsigned val)
 421 {
 422         isp116x_write_addr(isp116x, reg | ISP116x_WRITE_OFFSET);
 423         isp116x_write_data32(isp116x, (u32) val);
 424 }
 425
 426 /* --- USB HUB constants (not OHCI-specific; see hub.h) -------------------- */
 427
 428 /* destination of request */
 429 #define RH_INTERFACE               0x01
 430 #define RH_ENDPOINT                0x02
 431 #define RH_OTHER                   0x03
 432
 433 #define RH_CLASS                   0x20
 434 #define RH_VENDOR                  0x40
 435
 436 /* Requests: bRequest << 8 | bmRequestType */
 437 #define RH_GET_STATUS           0x0080
 438 #define RH_CLEAR_FEATURE        0x0100
 439 #define RH_SET_FEATURE          0x0300
 440 #define RH_SET_ADDRESS          0x0500
 441 #define RH_GET_DESCRIPTOR       0x0680
 442 #define RH_SET_DESCRIPTOR       0x0700
 443 #define RH_GET_CONFIGURATION    0x0880
 444 #define RH_SET_CONFIGURATION    0x0900
 445 #define RH_GET_STATE            0x0280
 446 #define RH_GET_INTERFACE        0x0A80
 447 #define RH_SET_INTERFACE        0x0B00
 448 #define RH_SYNC_FRAME           0x0C80
 449 /* Our Vendor Specific Request */
 450 #define RH_SET_EP               0x2000
 451
 452 /* Hub port features */
 453 #define RH_PORT_CONNECTION         0x00
 454 #define RH_PORT_ENABLE             0x01
 455 #define RH_PORT_SUSPEND            0x02
 456 #define RH_PORT_OVER_CURRENT       0x03
 457 #define RH_PORT_RESET              0x04
 458 #define RH_PORT_POWER              0x08
 459 #define RH_PORT_LOW_SPEED          0x09
 460
 461 #define RH_C_PORT_CONNECTION       0x10
 462 #define RH_C_PORT_ENABLE           0x11
 463 #define RH_C_PORT_SUSPEND          0x12
 464 #define RH_C_PORT_OVER_CURRENT     0x13
 465 #define RH_C_PORT_RESET            0x14
 466
 467 /* Hub features */
 468 #define RH_C_HUB_LOCAL_POWER       0x00
 469 #define RH_C_HUB_OVER_CURRENT      0x01
 470
 471 #define RH_DEVICE_REMOTE_WAKEUP    0x00
 472 #define RH_ENDPOINT_STALL          0x01
 473
 474 #define RH_ACK                     0x01
 475 #define RH_REQ_ERR                 -1
 476 #define RH_NACK                    0x00