drivers/usb/gadget/atmel_usba_udc.h

   1 /*
   2  * Driver for the Atmel USBA high speed USB device controller
   3  *
   4  * Copyright (C) 2005-2007 Atmel Corporation
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 as
   8  * published by the Free Software Foundation.
   9  */
  10 #ifndef __LINUX_USB_GADGET_USBA_UDC_H__
  11 #define __LINUX_USB_GADGET_USBA_UDC_H__
  12
  13 /* USB register offsets */
  14 #define USBA_CTRL                               0x0000
  15 #define USBA_FNUM                               0x0004
  16 #define USBA_INT_ENB                            0x0010
  17 #define USBA_INT_STA                            0x0014
  18 #define USBA_INT_CLR                            0x0018
  19 #define USBA_EPT_RST                            0x001c
  20 #define USBA_TST                                0x00e0
  21
  22 /* USB endpoint register offsets */
  23 #define USBA_EPT_CFG                            0x0000
  24 #define USBA_EPT_CTL_ENB                        0x0004
  25 #define USBA_EPT_CTL_DIS                        0x0008
  26 #define USBA_EPT_CTL                            0x000c
  27 #define USBA_EPT_SET_STA                        0x0014
  28 #define USBA_EPT_CLR_STA                        0x0018
  29 #define USBA_EPT_STA                            0x001c
  30
  31 /* USB DMA register offsets */
  32 #define USBA_DMA_NXT_DSC                        0x0000
  33 #define USBA_DMA_ADDRESS                        0x0004
  34 #define USBA_DMA_CONTROL                        0x0008
  35 #define USBA_DMA_STATUS                         0x000c
  36
  37 /* Bitfields in CTRL */
  38 #define USBA_DEV_ADDR_OFFSET                    0
  39 #define USBA_DEV_ADDR_SIZE                      7
  40 #define USBA_FADDR_EN                           (1 <<  7)
  41 #define USBA_EN_USBA                            (1 <<  8)
  42 #define USBA_DETACH                             (1 <<  9)
  43 #define USBA_REMOTE_WAKE_UP                     (1 << 10)
  44
  45 /* Bitfields in FNUM */
  46 #define USBA_MICRO_FRAME_NUM_OFFSET             0
  47 #define USBA_MICRO_FRAME_NUM_SIZE               3
  48 #define USBA_FRAME_NUMBER_OFFSET                3
  49 #define USBA_FRAME_NUMBER_SIZE                  11
  50 #define USBA_FRAME_NUM_ERROR                    (1 << 31)
  51
  52 /* Bitfields in INT_ENB/INT_STA/INT_CLR */
  53 #define USBA_HIGH_SPEED                         (1 <<  0)
  54 #define USBA_DET_SUSPEND                        (1 <<  1)
  55 #define USBA_MICRO_SOF                          (1 <<  2)
  56 #define USBA_SOF                                (1 <<  3)
  57 #define USBA_END_OF_RESET                       (1 <<  4)
  58 #define USBA_WAKE_UP                            (1 <<  5)
  59 #define USBA_END_OF_RESUME                      (1 <<  6)
  60 #define USBA_UPSTREAM_RESUME                    (1 <<  7)
  61 #define USBA_EPT_INT_OFFSET                     8
  62 #define USBA_EPT_INT_SIZE                       16
  63 #define USBA_DMA_INT_OFFSET                     24
  64 #define USBA_DMA_INT_SIZE                       8
  65
  66 /* Bitfields in EPT_RST */
  67 #define USBA_RST_OFFSET                         0
  68 #define USBA_RST_SIZE                           16
  69
  70 /* Bitfields in USBA_TST */
  71 #define USBA_SPEED_CFG_OFFSET                   0
  72 #define USBA_SPEED_CFG_SIZE                     2
  73 #define USBA_TST_J_MODE                         (1 <<  2)
  74 #define USBA_TST_K_MODE                         (1 <<  3)
  75 #define USBA_TST_PKT_MODE                       (1 <<  4)
  76 #define USBA_OPMODE2                            (1 <<  5)
  77
  78 /* Bitfields in EPT_CFG */
  79 #define USBA_EPT_SIZE_OFFSET                    0
  80 #define USBA_EPT_SIZE_SIZE                      3
  81 #define USBA_EPT_DIR_IN                         (1 <<  3)
  82 #define USBA_EPT_TYPE_OFFSET                    4
  83 #define USBA_EPT_TYPE_SIZE                      2
  84 #define USBA_BK_NUMBER_OFFSET                   6
  85 #define USBA_BK_NUMBER_SIZE                     2
  86 #define USBA_NB_TRANS_OFFSET                    8
  87 #define USBA_NB_TRANS_SIZE                      2
  88 #define USBA_EPT_MAPPED                         (1 << 31)
  89
  90 /* Bitfields in EPT_CTL/EPT_CTL_ENB/EPT_CTL_DIS */
  91 #define USBA_EPT_ENABLE                         (1 <<  0)
  92 #define USBA_AUTO_VALID                         (1 <<  1)
  93 #define USBA_INTDIS_DMA                         (1 <<  3)
  94 #define USBA_NYET_DIS                           (1 <<  4)
  95 #define USBA_DATAX_RX                           (1 <<  6)
  96 #define USBA_MDATA_RX                           (1 <<  7)
  97 /* Bits 8-15 and 31 enable interrupts for respective bits in EPT_STA */
  98 #define USBA_BUSY_BANK_IE                       (1 << 18)
  99
 100 /* Bitfields in EPT_SET_STA/EPT_CLR_STA/EPT_STA */
 101 #define USBA_FORCE_STALL                        (1 <<  5)
 102 #define USBA_TOGGLE_CLR                         (1 <<  6)
 103 #define USBA_TOGGLE_SEQ_OFFSET                  6
 104 #define USBA_TOGGLE_SEQ_SIZE                    2
 105 #define USBA_ERR_OVFLW                          (1 <<  8)
 106 #define USBA_RX_BK_RDY                          (1 <<  9)
 107 #define USBA_KILL_BANK                          (1 <<  9)
 108 #define USBA_TX_COMPLETE                        (1 << 10)
 109 #define USBA_TX_PK_RDY                          (1 << 11)
 110 #define USBA_ISO_ERR_TRANS                      (1 << 11)
 111 #define USBA_RX_SETUP                           (1 << 12)
 112 #define USBA_ISO_ERR_FLOW                       (1 << 12)
 113 #define USBA_STALL_SENT                         (1 << 13)
 114 #define USBA_ISO_ERR_CRC                        (1 << 13)
 115 #define USBA_ISO_ERR_NBTRANS                    (1 << 13)
 116 #define USBA_NAK_IN                             (1 << 14)
 117 #define USBA_ISO_ERR_FLUSH                      (1 << 14)
 118 #define USBA_NAK_OUT                            (1 << 15)
 119 #define USBA_CURRENT_BANK_OFFSET                16
 120 #define USBA_CURRENT_BANK_SIZE                  2
 121 #define USBA_BUSY_BANKS_OFFSET                  18
 122 #define USBA_BUSY_BANKS_SIZE                    2
 123 #define USBA_BYTE_COUNT_OFFSET                  20
 124 #define USBA_BYTE_COUNT_SIZE                    11
 125 #define USBA_SHORT_PACKET                       (1 << 31)
 126
 127 /* Bitfields in DMA_CONTROL */
 128 #define USBA_DMA_CH_EN                          (1 <<  0)
 129 #define USBA_DMA_LINK                           (1 <<  1)
 130 #define USBA_DMA_END_TR_EN                      (1 <<  2)
 131 #define USBA_DMA_END_BUF_EN                     (1 <<  3)
 132 #define USBA_DMA_END_TR_IE                      (1 <<  4)
 133 #define USBA_DMA_END_BUF_IE                     (1 <<  5)
 134 #define USBA_DMA_DESC_LOAD_IE                   (1 <<  6)
 135 #define USBA_DMA_BURST_LOCK                     (1 <<  7)
 136 #define USBA_DMA_BUF_LEN_OFFSET                 16
 137 #define USBA_DMA_BUF_LEN_SIZE                   16
 138
 139 /* Bitfields in DMA_STATUS */
 140 #define USBA_DMA_CH_ACTIVE                      (1 <<  1)
 141 #define USBA_DMA_END_TR_ST                      (1 <<  4)
 142 #define USBA_DMA_END_BUF_ST                     (1 <<  5)
 143 #define USBA_DMA_DESC_LOAD_ST                   (1 <<  6)
 144
 145 /* Constants for SPEED_CFG */
 146 #define USBA_SPEED_CFG_NORMAL                   0
 147 #define USBA_SPEED_CFG_FORCE_HIGH               2
 148 #define USBA_SPEED_CFG_FORCE_FULL               3
 149
 150 /* Constants for EPT_SIZE */
 151 #define USBA_EPT_SIZE_8                         0
 152 #define USBA_EPT_SIZE_16                        1
 153 #define USBA_EPT_SIZE_32                        2
 154 #define USBA_EPT_SIZE_64                        3
 155 #define USBA_EPT_SIZE_128                       4
 156 #define USBA_EPT_SIZE_256                       5
 157 #define USBA_EPT_SIZE_512                       6
 158 #define USBA_EPT_SIZE_1024                      7
 159
 160 /* Constants for EPT_TYPE */
 161 #define USBA_EPT_TYPE_CONTROL                   0
 162 #define USBA_EPT_TYPE_ISO                       1
 163 #define USBA_EPT_TYPE_BULK                      2
 164 #define USBA_EPT_TYPE_INT                       3
 165
 166 /* Constants for BK_NUMBER */
 167 #define USBA_BK_NUMBER_ZERO                     0
 168 #define USBA_BK_NUMBER_ONE                      1
 169 #define USBA_BK_NUMBER_DOUBLE                   2
 170 #define USBA_BK_NUMBER_TRIPLE                   3
 171
 172 /* Bit manipulation macros */
 173 #define USBA_BF(name, value)                                    \
 174         (((value) & ((1 << USBA_##name##_SIZE) - 1))            \
 175          << USBA_##name##_OFFSET)
 176 #define USBA_BFEXT(name, value)                                 \
 177         (((value) >> USBA_##name##_OFFSET)                      \
 178          & ((1 << USBA_##name##_SIZE) - 1))
 179 #define USBA_BFINS(name, value, old)                            \
 180         (((old) & ~(((1 << USBA_##name##_SIZE) - 1)             \
 181                     << USBA_##name##_OFFSET))                   \
 182          | USBA_BF(name, value))
 183
 184 /* Register access macros */
 185 #define usba_readl(udc, reg)                                    \
 186         __raw_readl((udc)->regs + USBA_##reg)
 187 #define usba_writel(udc, reg, value)                            \
 188         __raw_writel((value), (udc)->regs + USBA_##reg)
 189 #define usba_ep_readl(ep, reg)                                  \
 190         __raw_readl((ep)->ep_regs + USBA_EPT_##reg)
 191 #define usba_ep_writel(ep, reg, value)                          \
 192         __raw_writel((value), (ep)->ep_regs + USBA_EPT_##reg)
 193 #define usba_dma_readl(ep, reg)                                 \
 194         __raw_readl((ep)->dma_regs + USBA_DMA_##reg)
 195 #define usba_dma_writel(ep, reg, value)                         \
 196         __raw_writel((value), (ep)->dma_regs + USBA_DMA_##reg)
 197
 198 /* Calculate base address for a given endpoint or DMA controller */
 199 #define USBA_EPT_BASE(x)        (0x100 + (x) * 0x20)
 200 #define USBA_DMA_BASE(x)        (0x300 + (x) * 0x10)
 201 #define USBA_FIFO_BASE(x)       ((x) << 16)
 202
 203 /* Synth parameters */
 204 #define USBA_NR_ENDPOINTS       7
 205
 206 #define EP0_FIFO_SIZE           64
 207 #define EP0_EPT_SIZE            USBA_EPT_SIZE_64
 208 #define EP0_NR_BANKS            1
 209
 210 /*
 211  * REVISIT: Try to eliminate this value. Can we rely on req->mapped to
 212  * provide this information?
 213  */
 214 #define DMA_ADDR_INVALID (~(dma_addr_t)0)
 215
 216 #define FIFO_IOMEM_ID   0
 217 #define CTRL_IOMEM_ID   1
 218
 219 #define DBG_ERR         0x0001  /* report all error returns */
 220 #define DBG_HW          0x0002  /* debug hardware initialization */
 221 #define DBG_GADGET      0x0004  /* calls to/from gadget driver */
 222 #define DBG_INT         0x0008  /* interrupts */
 223 #define DBG_BUS         0x0010  /* report changes in bus state */
 224 #define DBG_QUEUE       0x0020  /* debug request queue processing */
 225 #define DBG_FIFO        0x0040  /* debug FIFO contents */
 226 #define DBG_DMA         0x0080  /* debug DMA handling */
 227 #define DBG_REQ         0x0100  /* print out queued request length */
 228 #define DBG_ALL         0xffff
 229 #define DBG_NONE        0x0000
 230
 231 #define DEBUG_LEVEL     (DBG_ERR)
 232
 233 #define DBG(level, fmt, ...)                                    \
 234         do {                                                    \
 235                 if ((level) & DEBUG_LEVEL)                      \
 236                         pr_debug("udc: " fmt, ## __VA_ARGS__);  \
 237         } while (0)
 238
 239 enum usba_ctrl_state {
 240         WAIT_FOR_SETUP,
 241         DATA_STAGE_IN,
 242         DATA_STAGE_OUT,
 243         STATUS_STAGE_IN,
 244         STATUS_STAGE_OUT,
 245         STATUS_STAGE_ADDR,
 246         STATUS_STAGE_TEST,
 247 };
 248 /*
 249   EP_STATE_IDLE,
 250   EP_STATE_SETUP,
 251   EP_STATE_IN_DATA,
 252   EP_STATE_OUT_DATA,
 253   EP_STATE_SET_ADDR_STATUS,
 254   EP_STATE_RX_STATUS,
 255   EP_STATE_TX_STATUS,
 256   EP_STATE_HALT,
 257 */
 258
 259 struct usba_dma_desc {
 260         dma_addr_t next;
 261         dma_addr_t addr;
 262         u32 ctrl;
 263 };
 264
 265 struct usba_ep {
 266         int                                     state;
 267         void __iomem                            *ep_regs;
 268         void __iomem                            *dma_regs;
 269         void __iomem                            *fifo;
 270         struct usb_ep                           ep;
 271         struct usba_udc                         *udc;
 272
 273         struct list_head                        queue;
 274         const struct usb_endpoint_descriptor    *desc;
 275
 276         u16                                     fifo_size;
 277         u8                                      nr_banks;
 278         u8                                      index;
 279         unsigned int                            can_dma:1;
 280         unsigned int                            can_isoc:1;
 281         unsigned int                            is_isoc:1;
 282         unsigned int                            is_in:1;
 283
 284 #ifdef CONFIG_USB_GADGET_DEBUG_FS
 285         u32                                     last_dma_status;
 286         struct dentry                           *debugfs_dir;
 287         struct dentry                           *debugfs_queue;
 288         struct dentry                           *debugfs_dma_status;
 289         struct dentry                           *debugfs_state;
 290 #endif
 291 };
 292
 293 struct usba_request {
 294         struct usb_request                      req;
 295         struct list_head                        queue;
 296
 297         u32                                     ctrl;
 298
 299         unsigned int                            submitted:1;
 300         unsigned int                            last_transaction:1;
 301         unsigned int                            using_dma:1;
 302         unsigned int                            mapped:1;
 303 };
 304
 305 struct usba_udc {
 306         /* Protect hw registers from concurrent modifications */
 307         spinlock_t lock;
 308
 309         void __iomem *regs;
 310         void __iomem *fifo;
 311
 312         struct usb_gadget gadget;
 313         struct usb_gadget_driver *driver;
 314         struct platform_device *pdev;
 315         int irq;
 316         int vbus_pin;
 317         struct clk *pclk;
 318         struct clk *hclk;
 319
 320         u16 devstatus;
 321
 322         u16 test_mode;
 323         int vbus_prev;
 324
 325 #ifdef CONFIG_USB_GADGET_DEBUG_FS
 326         struct dentry *debugfs_root;
 327         struct dentry *debugfs_regs;
 328 #endif
 329 };
 330
 331 static inline struct usba_ep *to_usba_ep(struct usb_ep *ep)
 332 {
 333         return container_of(ep, struct usba_ep, ep);
 334 }
 335
 336 static inline struct usba_request *to_usba_req(struct usb_request *req)
 337 {
 338         return container_of(req, struct usba_request, req);
 339 }
 340
 341 static inline struct usba_udc *to_usba_udc(struct usb_gadget *gadget)
 342 {
 343         return container_of(gadget, struct usba_udc, gadget);
 344 }
 345
 346 #define ep_is_control(ep)       ((ep)->index == 0)
 347 #define ep_is_idle(ep)          ((ep)->state == EP_STATE_IDLE)
 348
 349 #endif /* __LINUX_USB_GADGET_USBA_UDC_H */