drivers/usb/gadget/fsl_usb2_udc.h

   1 /*
   2  * Freescale USB device/endpoint management registers
   3  */
   4 #ifndef __FSL_USB2_UDC_H
   5 #define __FSL_USB2_UDC_H
   6
   7 /* ### define USB registers here
   8  */
   9 #define USB_MAX_CTRL_PAYLOAD            64
  10 #define USB_DR_SYS_OFFSET               0x400
  11
  12  /* USB DR device mode registers (Little Endian) */
  13 struct usb_dr_device {
  14         /* Capability register */
  15         u8 res1[256];
  16         u16 caplength;          /* Capability Register Length */
  17         u16 hciversion;         /* Host Controller Interface Version */
  18         u32 hcsparams;          /* Host Controller Structural Parameters */
  19         u32 hccparams;          /* Host Controller Capability Parameters */
  20         u8 res2[20];
  21         u32 dciversion;         /* Device Controller Interface Version */
  22         u32 dccparams;          /* Device Controller Capability Parameters */
  23         u8 res3[24];
  24         /* Operation register */
  25         u32 usbcmd;             /* USB Command Register */
  26         u32 usbsts;             /* USB Status Register */
  27         u32 usbintr;            /* USB Interrupt Enable Register */
  28         u32 frindex;            /* Frame Index Register */
  29         u8 res4[4];
  30         u32 deviceaddr;         /* Device Address */
  31         u32 endpointlistaddr;   /* Endpoint List Address Register */
  32         u8 res5[4];
  33         u32 burstsize;          /* Master Interface Data Burst Size Register */
  34         u32 txttfilltuning;     /* Transmit FIFO Tuning Controls Register */
  35         u8 res6[24];
  36         u32 configflag;         /* Configure Flag Register */
  37         u32 portsc1;            /* Port 1 Status and Control Register */
  38         u8 res7[28];
  39         u32 otgsc;              /* On-The-Go Status and Control */
  40         u32 usbmode;            /* USB Mode Register */
  41         u32 endptsetupstat;     /* Endpoint Setup Status Register */
  42         u32 endpointprime;      /* Endpoint Initialization Register */
  43         u32 endptflush;         /* Endpoint Flush Register */
  44         u32 endptstatus;        /* Endpoint Status Register */
  45         u32 endptcomplete;      /* Endpoint Complete Register */
  46         u32 endptctrl[6];       /* Endpoint Control Registers */
  47 };
  48
  49  /* USB DR host mode registers (Little Endian) */
  50 struct usb_dr_host {
  51         /* Capability register */
  52         u8 res1[256];
  53         u16 caplength;          /* Capability Register Length */
  54         u16 hciversion;         /* Host Controller Interface Version */
  55         u32 hcsparams;          /* Host Controller Structural Parameters */
  56         u32 hccparams;          /* Host Controller Capability Parameters */
  57         u8 res2[20];
  58         u32 dciversion;         /* Device Controller Interface Version */
  59         u32 dccparams;          /* Device Controller Capability Parameters */
  60         u8 res3[24];
  61         /* Operation register */
  62         u32 usbcmd;             /* USB Command Register */
  63         u32 usbsts;             /* USB Status Register */
  64         u32 usbintr;            /* USB Interrupt Enable Register */
  65         u32 frindex;            /* Frame Index Register */
  66         u8 res4[4];
  67         u32 periodiclistbase;   /* Periodic Frame List Base Address Register */
  68         u32 asynclistaddr;      /* Current Asynchronous List Address Register */
  69         u8 res5[4];
  70         u32 burstsize;          /* Master Interface Data Burst Size Register */
  71         u32 txttfilltuning;     /* Transmit FIFO Tuning Controls Register */
  72         u8 res6[24];
  73         u32 configflag;         /* Configure Flag Register */
  74         u32 portsc1;            /* Port 1 Status and Control Register */
  75         u8 res7[28];
  76         u32 otgsc;              /* On-The-Go Status and Control */
  77         u32 usbmode;            /* USB Mode Register */
  78         u32 endptsetupstat;     /* Endpoint Setup Status Register */
  79         u32 endpointprime;      /* Endpoint Initialization Register */
  80         u32 endptflush;         /* Endpoint Flush Register */
  81         u32 endptstatus;        /* Endpoint Status Register */
  82         u32 endptcomplete;      /* Endpoint Complete Register */
  83         u32 endptctrl[6];       /* Endpoint Control Registers */
  84 };
  85
  86  /* non-EHCI USB system interface registers (Big Endian) */
  87 struct usb_sys_interface {
  88         u32 snoop1;
  89         u32 snoop2;
  90         u32 age_cnt_thresh;     /* Age Count Threshold Register */
  91         u32 pri_ctrl;           /* Priority Control Register */
  92         u32 si_ctrl;            /* System Interface Control Register */
  93         u8 res[236];
  94         u32 control;            /* General Purpose Control Register */
  95 };
  96
  97 /* ep0 transfer state */
  98 #define WAIT_FOR_SETUP          0
  99 #define DATA_STATE_XMIT         1
 100 #define DATA_STATE_NEED_ZLP     2
 101 #define WAIT_FOR_OUT_STATUS     3
 102 #define DATA_STATE_RECV         4
 103
 104 /* Device Controller Capability Parameter register */
 105 #define DCCPARAMS_DC                            0x00000080
 106 #define DCCPARAMS_DEN_MASK                      0x0000001f
 107
 108 /* Frame Index Register Bit Masks */
 109 #define USB_FRINDEX_MASKS                       0x3fff
 110 /* USB CMD  Register Bit Masks */
 111 #define  USB_CMD_RUN_STOP                     0x00000001
 112 #define  USB_CMD_CTRL_RESET                   0x00000002
 113 #define  USB_CMD_PERIODIC_SCHEDULE_EN         0x00000010
 114 #define  USB_CMD_ASYNC_SCHEDULE_EN            0x00000020
 115 #define  USB_CMD_INT_AA_DOORBELL              0x00000040
 116 #define  USB_CMD_ASP                          0x00000300
 117 #define  USB_CMD_ASYNC_SCH_PARK_EN            0x00000800
 118 #define  USB_CMD_SUTW                         0x00002000
 119 #define  USB_CMD_ATDTW                        0x00004000
 120 #define  USB_CMD_ITC                          0x00FF0000
 121
 122 /* bit 15,3,2 are frame list size */
 123 #define  USB_CMD_FRAME_SIZE_1024              0x00000000
 124 #define  USB_CMD_FRAME_SIZE_512               0x00000004
 125 #define  USB_CMD_FRAME_SIZE_256               0x00000008
 126 #define  USB_CMD_FRAME_SIZE_128               0x0000000C
 127 #define  USB_CMD_FRAME_SIZE_64                0x00008000
 128 #define  USB_CMD_FRAME_SIZE_32                0x00008004
 129 #define  USB_CMD_FRAME_SIZE_16                0x00008008
 130 #define  USB_CMD_FRAME_SIZE_8                 0x0000800C
 131
 132 /* bit 9-8 are async schedule park mode count */
 133 #define  USB_CMD_ASP_00                       0x00000000
 134 #define  USB_CMD_ASP_01                       0x00000100
 135 #define  USB_CMD_ASP_10                       0x00000200
 136 #define  USB_CMD_ASP_11                       0x00000300
 137 #define  USB_CMD_ASP_BIT_POS                  8
 138
 139 /* bit 23-16 are interrupt threshold control */
 140 #define  USB_CMD_ITC_NO_THRESHOLD             0x00000000
 141 #define  USB_CMD_ITC_1_MICRO_FRM              0x00010000
 142 #define  USB_CMD_ITC_2_MICRO_FRM              0x00020000
 143 #define  USB_CMD_ITC_4_MICRO_FRM              0x00040000
 144 #define  USB_CMD_ITC_8_MICRO_FRM              0x00080000
 145 #define  USB_CMD_ITC_16_MICRO_FRM             0x00100000
 146 #define  USB_CMD_ITC_32_MICRO_FRM             0x00200000
 147 #define  USB_CMD_ITC_64_MICRO_FRM             0x00400000
 148 #define  USB_CMD_ITC_BIT_POS                  16
 149
 150 /* USB STS Register Bit Masks */
 151 #define  USB_STS_INT                          0x00000001
 152 #define  USB_STS_ERR                          0x00000002
 153 #define  USB_STS_PORT_CHANGE                  0x00000004
 154 #define  USB_STS_FRM_LST_ROLL                 0x00000008
 155 #define  USB_STS_SYS_ERR                      0x00000010
 156 #define  USB_STS_IAA                          0x00000020
 157 #define  USB_STS_RESET                        0x00000040
 158 #define  USB_STS_SOF                          0x00000080
 159 #define  USB_STS_SUSPEND                      0x00000100
 160 #define  USB_STS_HC_HALTED                    0x00001000
 161 #define  USB_STS_RCL                          0x00002000
 162 #define  USB_STS_PERIODIC_SCHEDULE            0x00004000
 163 #define  USB_STS_ASYNC_SCHEDULE               0x00008000
 164
 165 /* USB INTR Register Bit Masks */
 166 #define  USB_INTR_INT_EN                      0x00000001
 167 #define  USB_INTR_ERR_INT_EN                  0x00000002
 168 #define  USB_INTR_PTC_DETECT_EN               0x00000004
 169 #define  USB_INTR_FRM_LST_ROLL_EN             0x00000008
 170 #define  USB_INTR_SYS_ERR_EN                  0x00000010
 171 #define  USB_INTR_ASYN_ADV_EN                 0x00000020
 172 #define  USB_INTR_RESET_EN                    0x00000040
 173 #define  USB_INTR_SOF_EN                      0x00000080
 174 #define  USB_INTR_DEVICE_SUSPEND              0x00000100
 175
 176 /* Device Address bit masks */
 177 #define  USB_DEVICE_ADDRESS_MASK              0xFE000000
 178 #define  USB_DEVICE_ADDRESS_BIT_POS           25
 179
 180 /* endpoint list address bit masks */
 181 #define USB_EP_LIST_ADDRESS_MASK              0xfffff800
 182
 183 /* PORTSCX  Register Bit Masks */
 184 #define  PORTSCX_CURRENT_CONNECT_STATUS       0x00000001
 185 #define  PORTSCX_CONNECT_STATUS_CHANGE        0x00000002
 186 #define  PORTSCX_PORT_ENABLE                  0x00000004
 187 #define  PORTSCX_PORT_EN_DIS_CHANGE           0x00000008
 188 #define  PORTSCX_OVER_CURRENT_ACT             0x00000010
 189 #define  PORTSCX_OVER_CURRENT_CHG             0x00000020
 190 #define  PORTSCX_PORT_FORCE_RESUME            0x00000040
 191 #define  PORTSCX_PORT_SUSPEND                 0x00000080
 192 #define  PORTSCX_PORT_RESET                   0x00000100
 193 #define  PORTSCX_LINE_STATUS_BITS             0x00000C00
 194 #define  PORTSCX_PORT_POWER                   0x00001000
 195 #define  PORTSCX_PORT_INDICTOR_CTRL           0x0000C000
 196 #define  PORTSCX_PORT_TEST_CTRL               0x000F0000
 197 #define  PORTSCX_WAKE_ON_CONNECT_EN           0x00100000
 198 #define  PORTSCX_WAKE_ON_CONNECT_DIS          0x00200000
 199 #define  PORTSCX_WAKE_ON_OVER_CURRENT         0x00400000
 200 #define  PORTSCX_PHY_LOW_POWER_SPD            0x00800000
 201 #define  PORTSCX_PORT_FORCE_FULL_SPEED        0x01000000
 202 #define  PORTSCX_PORT_SPEED_MASK              0x0C000000
 203 #define  PORTSCX_PORT_WIDTH                   0x10000000
 204 #define  PORTSCX_PHY_TYPE_SEL                 0xC0000000
 205
 206 /* bit 11-10 are line status */
 207 #define  PORTSCX_LINE_STATUS_SE0              0x00000000
 208 #define  PORTSCX_LINE_STATUS_JSTATE           0x00000400
 209 #define  PORTSCX_LINE_STATUS_KSTATE           0x00000800
 210 #define  PORTSCX_LINE_STATUS_UNDEF            0x00000C00
 211 #define  PORTSCX_LINE_STATUS_BIT_POS          10
 212
 213 /* bit 15-14 are port indicator control */
 214 #define  PORTSCX_PIC_OFF                      0x00000000
 215 #define  PORTSCX_PIC_AMBER                    0x00004000
 216 #define  PORTSCX_PIC_GREEN                    0x00008000
 217 #define  PORTSCX_PIC_UNDEF                    0x0000C000
 218 #define  PORTSCX_PIC_BIT_POS                  14
 219
 220 /* bit 19-16 are port test control */
 221 #define  PORTSCX_PTC_DISABLE                  0x00000000
 222 #define  PORTSCX_PTC_JSTATE                   0x00010000
 223 #define  PORTSCX_PTC_KSTATE                   0x00020000
 224 #define  PORTSCX_PTC_SEQNAK                   0x00030000
 225 #define  PORTSCX_PTC_PACKET                   0x00040000
 226 #define  PORTSCX_PTC_FORCE_EN                 0x00050000
 227 #define  PORTSCX_PTC_BIT_POS                  16
 228
 229 /* bit 27-26 are port speed */
 230 #define  PORTSCX_PORT_SPEED_FULL              0x00000000
 231 #define  PORTSCX_PORT_SPEED_LOW               0x04000000
 232 #define  PORTSCX_PORT_SPEED_HIGH              0x08000000
 233 #define  PORTSCX_PORT_SPEED_UNDEF             0x0C000000
 234 #define  PORTSCX_SPEED_BIT_POS                26
 235
 236 /* bit 28 is parallel transceiver width for UTMI interface */
 237 #define  PORTSCX_PTW                          0x10000000
 238 #define  PORTSCX_PTW_8BIT                     0x00000000
 239 #define  PORTSCX_PTW_16BIT                    0x10000000
 240
 241 /* bit 31-30 are port transceiver select */
 242 #define  PORTSCX_PTS_UTMI                     0x00000000
 243 #define  PORTSCX_PTS_ULPI                     0x80000000
 244 #define  PORTSCX_PTS_FSLS                     0xC0000000
 245 #define  PORTSCX_PTS_BIT_POS                  30
 246
 247 /* otgsc Register Bit Masks */
 248 #define  OTGSC_CTRL_VUSB_DISCHARGE            0x00000001
 249 #define  OTGSC_CTRL_VUSB_CHARGE               0x00000002
 250 #define  OTGSC_CTRL_OTG_TERM                  0x00000008
 251 #define  OTGSC_CTRL_DATA_PULSING              0x00000010
 252 #define  OTGSC_STS_USB_ID                     0x00000100
 253 #define  OTGSC_STS_A_VBUS_VALID               0x00000200
 254 #define  OTGSC_STS_A_SESSION_VALID            0x00000400
 255 #define  OTGSC_STS_B_SESSION_VALID            0x00000800
 256 #define  OTGSC_STS_B_SESSION_END              0x00001000
 257 #define  OTGSC_STS_1MS_TOGGLE                 0x00002000
 258 #define  OTGSC_STS_DATA_PULSING               0x00004000
 259 #define  OTGSC_INTSTS_USB_ID                  0x00010000
 260 #define  OTGSC_INTSTS_A_VBUS_VALID            0x00020000
 261 #define  OTGSC_INTSTS_A_SESSION_VALID         0x00040000
 262 #define  OTGSC_INTSTS_B_SESSION_VALID         0x00080000
 263 #define  OTGSC_INTSTS_B_SESSION_END           0x00100000
 264 #define  OTGSC_INTSTS_1MS                     0x00200000
 265 #define  OTGSC_INTSTS_DATA_PULSING            0x00400000
 266 #define  OTGSC_INTR_USB_ID                    0x01000000
 267 #define  OTGSC_INTR_A_VBUS_VALID              0x02000000
 268 #define  OTGSC_INTR_A_SESSION_VALID           0x04000000
 269 #define  OTGSC_INTR_B_SESSION_VALID           0x08000000
 270 #define  OTGSC_INTR_B_SESSION_END             0x10000000
 271 #define  OTGSC_INTR_1MS_TIMER                 0x20000000
 272 #define  OTGSC_INTR_DATA_PULSING              0x40000000
 273
 274 /* USB MODE Register Bit Masks */
 275 #define  USB_MODE_CTRL_MODE_IDLE              0x00000000
 276 #define  USB_MODE_CTRL_MODE_DEVICE            0x00000002
 277 #define  USB_MODE_CTRL_MODE_HOST              0x00000003
 278 #define  USB_MODE_CTRL_MODE_MASK              0x00000003
 279 #define  USB_MODE_CTRL_MODE_RSV               0x00000001
 280 #define  USB_MODE_ES                          0x00000004 /* Endian Select */
 281 #define  USB_MODE_SETUP_LOCK_OFF              0x00000008
 282 #define  USB_MODE_STREAM_DISABLE              0x00000010
 283 /* Endpoint Flush Register */
 284 #define EPFLUSH_TX_OFFSET                     0x00010000
 285 #define EPFLUSH_RX_OFFSET                     0x00000000
 286
 287 /* Endpoint Setup Status bit masks */
 288 #define  EP_SETUP_STATUS_MASK                 0x0000003F
 289 #define  EP_SETUP_STATUS_EP0                  0x00000001
 290
 291 /* ENDPOINTCTRLx  Register Bit Masks */
 292 #define  EPCTRL_TX_ENABLE                     0x00800000
 293 #define  EPCTRL_TX_DATA_TOGGLE_RST            0x00400000        /* Not EP0 */
 294 #define  EPCTRL_TX_DATA_TOGGLE_INH            0x00200000        /* Not EP0 */
 295 #define  EPCTRL_TX_TYPE                       0x000C0000
 296 #define  EPCTRL_TX_DATA_SOURCE                0x00020000        /* Not EP0 */
 297 #define  EPCTRL_TX_EP_STALL                   0x00010000
 298 #define  EPCTRL_RX_ENABLE                     0x00000080
 299 #define  EPCTRL_RX_DATA_TOGGLE_RST            0x00000040        /* Not EP0 */
 300 #define  EPCTRL_RX_DATA_TOGGLE_INH            0x00000020        /* Not EP0 */
 301 #define  EPCTRL_RX_TYPE                       0x0000000C
 302 #define  EPCTRL_RX_DATA_SINK                  0x00000002        /* Not EP0 */
 303 #define  EPCTRL_RX_EP_STALL                   0x00000001
 304
 305 /* bit 19-18 and 3-2 are endpoint type */
 306 #define  EPCTRL_EP_TYPE_CONTROL               0
 307 #define  EPCTRL_EP_TYPE_ISO                   1
 308 #define  EPCTRL_EP_TYPE_BULK                  2
 309 #define  EPCTRL_EP_TYPE_INTERRUPT             3
 310 #define  EPCTRL_TX_EP_TYPE_SHIFT              18
 311 #define  EPCTRL_RX_EP_TYPE_SHIFT              2
 312
 313 /* SNOOPn Register Bit Masks */
 314 #define  SNOOP_ADDRESS_MASK                   0xFFFFF000
 315 #define  SNOOP_SIZE_ZERO                      0x00      /* snooping disable */
 316 #define  SNOOP_SIZE_4KB                       0x0B      /* 4KB snoop size */
 317 #define  SNOOP_SIZE_8KB                       0x0C
 318 #define  SNOOP_SIZE_16KB                      0x0D
 319 #define  SNOOP_SIZE_32KB                      0x0E
 320 #define  SNOOP_SIZE_64KB                      0x0F
 321 #define  SNOOP_SIZE_128KB                     0x10
 322 #define  SNOOP_SIZE_256KB                     0x11
 323 #define  SNOOP_SIZE_512KB                     0x12
 324 #define  SNOOP_SIZE_1MB                       0x13
 325 #define  SNOOP_SIZE_2MB                       0x14
 326 #define  SNOOP_SIZE_4MB                       0x15
 327 #define  SNOOP_SIZE_8MB                       0x16
 328 #define  SNOOP_SIZE_16MB                      0x17
 329 #define  SNOOP_SIZE_32MB                      0x18
 330 #define  SNOOP_SIZE_64MB                      0x19
 331 #define  SNOOP_SIZE_128MB                     0x1A
 332 #define  SNOOP_SIZE_256MB                     0x1B
 333 #define  SNOOP_SIZE_512MB                     0x1C
 334 #define  SNOOP_SIZE_1GB                       0x1D
 335 #define  SNOOP_SIZE_2GB                       0x1E      /* 2GB snoop size */
 336
 337 /* pri_ctrl Register Bit Masks */
 338 #define  PRI_CTRL_PRI_LVL1                    0x0000000C
 339 #define  PRI_CTRL_PRI_LVL0                    0x00000003
 340
 341 /* si_ctrl Register Bit Masks */
 342 #define  SI_CTRL_ERR_DISABLE                  0x00000010
 343 #define  SI_CTRL_IDRC_DISABLE                 0x00000008
 344 #define  SI_CTRL_RD_SAFE_EN                   0x00000004
 345 #define  SI_CTRL_RD_PREFETCH_DISABLE          0x00000002
 346 #define  SI_CTRL_RD_PREFEFETCH_VAL            0x00000001
 347
 348 /* control Register Bit Masks */
 349 #define  USB_CTRL_IOENB                       0x00000004
 350 #define  USB_CTRL_ULPI_INT0EN                 0x00000001
 351
 352 /* Endpoint Queue Head data struct
 353  * Rem: all the variables of qh are LittleEndian Mode
 354  * and NEXT_POINTER_MASK should operate on a LittleEndian, Phy Addr
 355  */
 356 struct ep_queue_head {
 357         u32 max_pkt_length;     /* Mult(31-30) , Zlt(29) , Max Pkt len
 358                                    and IOS(15) */
 359         u32 curr_dtd_ptr;       /* Current dTD Pointer(31-5) */
 360         u32 next_dtd_ptr;       /* Next dTD Pointer(31-5), T(0) */
 361         u32 size_ioc_int_sts;   /* Total bytes (30-16), IOC (15),
 362                                    MultO(11-10), STS (7-0)  */
 363         u32 buff_ptr0;          /* Buffer pointer Page 0 (31-12) */
 364         u32 buff_ptr1;          /* Buffer pointer Page 1 (31-12) */
 365         u32 buff_ptr2;          /* Buffer pointer Page 2 (31-12) */
 366         u32 buff_ptr3;          /* Buffer pointer Page 3 (31-12) */
 367         u32 buff_ptr4;          /* Buffer pointer Page 4 (31-12) */
 368         u32 res1;
 369         u8 setup_buffer[8];     /* Setup data 8 bytes */
 370         u32 res2[4];
 371 };
 372
 373 /* Endpoint Queue Head Bit Masks */
 374 #define  EP_QUEUE_HEAD_MULT_POS               30
 375 #define  EP_QUEUE_HEAD_ZLT_SEL                0x20000000
 376 #define  EP_QUEUE_HEAD_MAX_PKT_LEN_POS        16
 377 #define  EP_QUEUE_HEAD_MAX_PKT_LEN(ep_info)   (((ep_info)>>16)&0x07ff)
 378 #define  EP_QUEUE_HEAD_IOS                    0x00008000
 379 #define  EP_QUEUE_HEAD_NEXT_TERMINATE         0x00000001
 380 #define  EP_QUEUE_HEAD_IOC                    0x00008000
 381 #define  EP_QUEUE_HEAD_MULTO                  0x00000C00
 382 #define  EP_QUEUE_HEAD_STATUS_HALT            0x00000040
 383 #define  EP_QUEUE_HEAD_STATUS_ACTIVE          0x00000080
 384 #define  EP_QUEUE_CURRENT_OFFSET_MASK         0x00000FFF
 385 #define  EP_QUEUE_HEAD_NEXT_POINTER_MASK      0xFFFFFFE0
 386 #define  EP_QUEUE_FRINDEX_MASK                0x000007FF
 387 #define  EP_MAX_LENGTH_TRANSFER               0x4000
 388
 389 /* Endpoint Transfer Descriptor data struct */
 390 /* Rem: all the variables of td are LittleEndian Mode */
 391 struct ep_td_struct {
 392         u32 next_td_ptr;        /* Next TD pointer(31-5), T(0) set
 393                                    indicate invalid */
 394         u32 size_ioc_sts;       /* Total bytes (30-16), IOC (15),
 395                                    MultO(11-10), STS (7-0)  */
 396         u32 buff_ptr0;          /* Buffer pointer Page 0 */
 397         u32 buff_ptr1;          /* Buffer pointer Page 1 */
 398         u32 buff_ptr2;          /* Buffer pointer Page 2 */
 399         u32 buff_ptr3;          /* Buffer pointer Page 3 */
 400         u32 buff_ptr4;          /* Buffer pointer Page 4 */
 401         u32 res;
 402         /* 32 bytes */
 403         dma_addr_t td_dma;      /* dma address for this td */
 404         /* virtual address of next td specified in next_td_ptr */
 405         struct ep_td_struct *next_td_virt;
 406 };
 407
 408 /* Endpoint Transfer Descriptor bit Masks */
 409 #define  DTD_NEXT_TERMINATE                   0x00000001
 410 #define  DTD_IOC                              0x00008000
 411 #define  DTD_STATUS_ACTIVE                    0x00000080
 412 #define  DTD_STATUS_HALTED                    0x00000040
 413 #define  DTD_STATUS_DATA_BUFF_ERR             0x00000020
 414 #define  DTD_STATUS_TRANSACTION_ERR           0x00000008
 415 #define  DTD_RESERVED_FIELDS                  0x80007300
 416 #define  DTD_ADDR_MASK                        0xFFFFFFE0
 417 #define  DTD_PACKET_SIZE                      0x7FFF0000
 418 #define  DTD_LENGTH_BIT_POS                   16
 419 #define  DTD_ERROR_MASK                       (DTD_STATUS_HALTED | \
 420                                                DTD_STATUS_DATA_BUFF_ERR | \
 421                                                DTD_STATUS_TRANSACTION_ERR)
 422 /* Alignment requirements; must be a power of two */
 423 #define DTD_ALIGNMENT                           0x20
 424 #define QH_ALIGNMENT                            2048
 425
 426 /* Controller dma boundary */
 427 #define UDC_DMA_BOUNDARY                        0x1000
 428
 429 /*-------------------------------------------------------------------------*/
 430
 431 /* ### driver private data
 432  */
 433 struct fsl_req {
 434         struct usb_request req;
 435         struct list_head queue;
 436         /* ep_queue() func will add
 437            a request->queue into a udc_ep->queue 'd tail */
 438         struct fsl_ep *ep;
 439         unsigned mapped:1;
 440
 441         struct ep_td_struct *head, *tail;       /* For dTD List
 442                                                    cpu endian Virtual addr */
 443         unsigned int dtd_count;
 444 };
 445
 446 #define REQ_UNCOMPLETE                  1
 447
 448 struct fsl_ep {
 449         struct usb_ep ep;
 450         struct list_head queue;
 451         struct fsl_udc *udc;
 452         struct ep_queue_head *qh;
 453         const struct usb_endpoint_descriptor *desc;
 454         struct usb_gadget *gadget;
 455
 456         char name[14];
 457         unsigned stopped:1;
 458 };
 459
 460 #define EP_DIR_IN       1
 461 #define EP_DIR_OUT      0
 462
 463 struct fsl_udc {
 464         struct usb_gadget gadget;
 465         struct usb_gadget_driver *driver;
 466         struct fsl_usb2_platform_data *pdata;
 467         struct completion *done;        /* to make sure release() is done */
 468         struct fsl_ep *eps;
 469         unsigned int max_ep;
 470         unsigned int irq;
 471
 472         struct usb_ctrlrequest local_setup_buff;
 473         spinlock_t lock;
 474         struct otg_transceiver *transceiver;
 475         unsigned softconnect:1;
 476         unsigned vbus_active:1;
 477         unsigned stopped:1;
 478         unsigned remote_wakeup:1;
 479         unsigned already_stopped:1;
 480         unsigned big_endian_desc:1;
 481
 482         struct ep_queue_head *ep_qh;    /* Endpoints Queue-Head */
 483         struct fsl_req *status_req;     /* ep0 status request */
 484         struct dma_pool *td_pool;       /* dma pool for DTD */
 485         enum fsl_usb2_phy_modes phy_mode;
 486
 487         size_t ep_qh_size;              /* size after alignment adjustment*/
 488         dma_addr_t ep_qh_dma;           /* dma address of QH */
 489
 490         u32 max_pipes;          /* Device max pipes */
 491         u32 bus_reset;          /* Device is bus resetting */
 492         u32 resume_state;       /* USB state to resume */
 493         u32 usb_state;          /* USB current state */
 494         u32 ep0_state;          /* Endpoint zero state */
 495         u32 ep0_dir;            /* Endpoint zero direction: can be
 496                                    USB_DIR_IN or USB_DIR_OUT */
 497         u8 device_address;      /* Device USB address */
 498 };
 499
 500 /*-------------------------------------------------------------------------*/
 501
 502 #ifdef DEBUG
 503 #define DBG(fmt, args...)       printk(KERN_DEBUG "[%s]  " fmt "\n", \
 504                                 __func__, ## args)
 505 #else
 506 #define DBG(fmt, args...)       do{}while(0)
 507 #endif
 508
 509 #if 0
 510 static void dump_msg(const char *label, const u8 * buf, unsigned int length)
 511 {
 512         unsigned int start, num, i;
 513         char line[52], *p;
 514
 515         if (length >= 512)
 516                 return;
 517         DBG("%s, length %u:\n", label, length);
 518         start = 0;
 519         while (length > 0) {
 520                 num = min(length, 16u);
 521                 p = line;
 522                 for (i = 0; i < num; ++i) {
 523                         if (i == 8)
 524                                 *p++ = ' ';
 525                         sprintf(p, " %02x", buf[i]);
 526                         p += 3;
 527                 }
 528                 *p = 0;
 529                 printk(KERN_DEBUG "%6x: %s\n", start, line);
 530                 buf += num;
 531                 start += num;
 532                 length -= num;
 533         }
 534 }
 535 #endif
 536
 537 #ifdef VERBOSE
 538 #define VDBG            DBG
 539 #else
 540 #define VDBG(stuff...)  do{}while(0)
 541 #endif
 542
 543 #define ERR(stuff...)           pr_err("udc: " stuff)
 544 #define WARNING(stuff...)               pr_warning("udc: " stuff)
 545 #define INFO(stuff...)          pr_info("udc: " stuff)
 546
 547 /*-------------------------------------------------------------------------*/
 548
 549 /* ### Add board specific defines here
 550  */
 551
 552 /*
 553  * ### pipe direction macro from device view
 554  */
 555 #define USB_RECV        0       /* OUT EP */
 556 #define USB_SEND        1       /* IN EP */
 557
 558 /*
 559  * ### internal used help routines.
 560  */
 561 #define ep_index(EP)            ((EP)->desc->bEndpointAddress&0xF)
 562 #define ep_maxpacket(EP)        ((EP)->ep.maxpacket)
 563 #define ep_is_in(EP)    ( (ep_index(EP) == 0) ? (EP->udc->ep0_dir == \
 564                         USB_DIR_IN ):((EP)->desc->bEndpointAddress \
 565                         & USB_DIR_IN)==USB_DIR_IN)
 566 #define get_ep_by_pipe(udc, pipe)       ((pipe == 1)? &udc->eps[0]: \
 567                                         &udc->eps[pipe])
 568 #define get_pipe_by_windex(windex)      ((windex & USB_ENDPOINT_NUMBER_MASK) \
 569                                         * 2 + ((windex & USB_DIR_IN) ? 1 : 0))
 570 #define get_pipe_by_ep(EP)      (ep_index(EP) * 2 + ep_is_in(EP))
 571
 572 struct platform_device;
 573 #ifdef CONFIG_ARCH_MXC
 574 int fsl_udc_clk_init(struct platform_device *pdev);
 575 void fsl_udc_clk_finalize(struct platform_device *pdev);
 576 void fsl_udc_clk_release(void);
 577 #else
 578 static inline int fsl_udc_clk_init(struct platform_device *pdev)
 579 {
 580         return 0;
 581 }
 582 static inline void fsl_udc_clk_finalize(struct platform_device *pdev)
 583 {
 584 }
 585 static inline void fsl_udc_clk_release(void)
 586 {
 587 }
 588 #endif
 589
 590 #endif