include/usb/omap1510_udc.h

   1 /*
   2  * (C) Copyright 2003
   3  * Gerry Hamel, geh@ti.com, Texas Instruments
   4  *
   5  * Based on
   6  * linux/drivers/usb/device/bi/omap.h
   7  * Register definitions for TI OMAP1510 USB bus interface driver
   8  *
   9  * Author: MontaVista Software, Inc.
  10  *         source@mvista.com
  11  *
  12  * 2003 (c) MontaVista Software, Inc. This file is licensed under
  13  * the terms of the GNU General Public License version 2. This program
  14  * is licensed "as is" without any warranty of any kind, whether express
  15  * or implied.
  16  */
  17
  18 #ifndef __USBDCORE_OMAP1510_H__
  19 #define __USBDCORE_OMAP1510_H__
  20
  21
  22 /*
  23  * 13.2 MPU Register Map
  24  */
  25
  26 /* Table 13-1. USB Function Module Registers (endpoint) */
  27 #define UDC_BASE                     0xFFFB4000
  28 #define UDC_OFFSET(offset)           (UDC_BASE + (offset))
  29 #define UDC_REV                      UDC_OFFSET(0x0)    /* Revision */
  30 #define UDC_EP_NUM                   UDC_OFFSET(0x4)    /* Endpoint selection */
  31 #define UDC_DATA                     UDC_OFFSET(0x08)   /* Data */
  32 #define UDC_CTRL                     UDC_OFFSET(0x0C)   /* Control */
  33 #define UDC_STAT_FLG                 UDC_OFFSET(0x10)   /* Status flag */
  34 #define UDC_RXFSTAT                  UDC_OFFSET(0x14)   /* Receive FIFO status */
  35 #define UDC_SYSCON1                  UDC_OFFSET(0x18)   /* System configuration 1 */
  36 #define UDC_SYSCON2                  UDC_OFFSET(0x1C)   /* System configuration 2 */
  37 #define UDC_DEVSTAT                  UDC_OFFSET(0x20)   /* Device status */
  38 #define UDC_SOF                      UDC_OFFSET(0x24)   /* Start of frame */
  39 #define UDC_IRQ_EN                   UDC_OFFSET(0x28)   /* Interrupt enable */
  40 #define UDC_DMA_IRQ_EN               UDC_OFFSET(0x2C)   /* DMA interrupt enable */
  41 #define UDC_IRQ_SRC                  UDC_OFFSET(0x30)   /* Interrupt source */
  42 #define UDC_EPN_STAT                 UDC_OFFSET(0x34)   /* Endpoint interrupt status */
  43 #define UDC_DMAN_STAT                UDC_OFFSET(0x3C)   /* DMA endpoint interrupt status */
  44
  45 /* IRQ_EN register fields */
  46 #define UDC_Sof_IE                   (1 << 7)   /* Start-of-frame interrupt enabled */
  47 #define UDC_EPn_RX_IE                (1 << 5)   /* Receive endpoint interrupt enabled */
  48 #define UDC_EPn_TX_IE                (1 << 4)   /* Transmit endpoint interrupt enabled */
  49 #define UDC_DS_Chg_IE                (1 << 3)   /* Device state changed interrupt enabled */
  50 #define UDC_EP0_IE                   (1 << 0)   /* EP0 transaction interrupt enabled */
  51
  52 /* IRQ_SRC register fields */
  53 #define UDC_TXn_Done                 (1 << 10)  /* Transmit DMA channel n done */
  54 #define UDC_RXn_Cnt                  (1 << 9)   /* Receive DMA channel n transactions count */
  55 #define UDC_RXn_EOT                  (1 << 8)   /* Receive DMA channel n end of transfer */
  56 #define UDC_SOF_Flg                  (1 << 7)   /* Start-of-frame interrupt flag */
  57 #define UDC_EPn_RX                   (1 << 5)   /* Endpoint n OUT transaction */
  58 #define UDC_EPn_TX                   (1 << 4)   /* Endpoint n IN transaction */
  59 #define UDC_DS_Chg                   (1 << 3)   /* Device state changed */
  60 #define UDC_Setup                    (1 << 2)   /* Setup transaction */
  61 #define UDC_EP0_RX                   (1 << 1)   /* EP0 OUT transaction */
  62 #define UDC_EP0_TX                   (1 << 0)   /* EP0 IN transaction */
  63
  64 /* DEVSTAT register fields, 14.2.9 */
  65 #define UDC_R_WK_OK                  (1 << 6)   /* Remote wakeup granted */
  66 #define UDC_USB_Reset                (1 << 5)   /* USB reset signalling is active */
  67 #define UDC_SUS                      (1 << 4)   /* Suspended state */
  68 #define UDC_CFG                      (1 << 3)   /* Configured state */
  69 #define UDC_ADD                      (1 << 2)   /* Addressed state */
  70 #define UDC_DEF                      (1 << 1)   /* Default state */
  71 #define UDC_ATT                      (1 << 0)   /* Attached state */
  72
  73 /* SYSCON1 register fields */
  74 #define UDC_Cfg_Lock                 (1 << 8)   /* Device configuration locked */
  75 #define UDC_Nak_En                   (1 << 4)   /* NAK enable */
  76 #define UDC_Self_Pwr                 (1 << 2)   /* Device is self-powered */
  77 #define UDC_Soff_Dis                 (1 << 1)   /* Shutoff disabled */
  78 #define UDC_Pullup_En                (1 << 0)   /* External pullup enabled */
  79
  80 /* SYSCON2 register fields */
  81 #define UDC_Rmt_Wkp                  (1 << 6)   /* Remote wakeup */
  82 #define UDC_Stall_Cmd                (1 << 5)   /* Stall endpoint */
  83 #define UDC_Dev_Cfg                  (1 << 3)   /* Device configured */
  84 #define UDC_Clr_Cfg                  (1 << 2)   /* Clear configured */
  85
  86 /*
  87  * Select and enable endpoints
  88  */
  89
  90 /* Table 13-1. USB Function Module Registers (endpoint configuration) */
  91 #define UDC_EPBASE                   UDC_OFFSET(0x80)   /* Endpoints base address */
  92 #define UDC_EP0                      UDC_EPBASE /* Control endpoint configuration */
  93 #define UDC_EP_RX_BASE               UDC_OFFSET(0x84)   /* Receive endpoints base address */
  94 #define UDC_EP_RX(endpoint)          (UDC_EP_RX_BASE + ((endpoint) - 1) * 4)
  95 #define UDC_EP_TX_BASE               UDC_OFFSET(0xC4)   /* Transmit endpoints base address */
  96 #define UDC_EP_TX(endpoint)          (UDC_EP_TX_BASE + ((endpoint) - 1) * 4)
  97
  98 /* EP_NUM register fields */
  99 #define UDC_Setup_Sel                (1 << 6)   /* Setup FIFO select */
 100 #define UDC_EP_Sel                   (1 << 5)   /* TX/RX FIFO select */
 101 #define UDC_EP_Dir                   (1 << 4)   /* Endpoint direction */
 102
 103 /* CTRL register fields */
 104 #define UDC_Clr_Halt                 (1 << 7)   /* Clear halt endpoint */
 105 #define UDC_Set_Halt                 (1 << 6)   /* Set halt endpoint */
 106 #define UDC_Set_FIFO_En              (1 << 2)   /* Set FIFO enable */
 107 #define UDC_Clr_EP                   (1 << 1)   /* Clear endpoint */
 108 #define UDC_Reset_EP                 (1 << 0)   /* Reset endpoint */
 109
 110 /* STAT_FLG register fields */
 111 #define UDC_Miss_In                  (1 << 14)
 112 #define UDC_Data_Flush               (1 << 13)
 113 #define UDC_ISO_Err                  (1 << 12)
 114 #define UDC_ISO_FIFO_Empty           (1 << 9)
 115 #define UDC_ISO_FIFO_Full            (1 << 8)
 116 #define UDC_EP_Halted                (1 << 6)
 117 #define UDC_STALL                    (1 << 5)
 118 #define UDC_NAK                      (1 << 4)
 119 #define UDC_ACK                      (1 << 3)
 120 #define UDC_FIFO_En                  (1 << 2)
 121 #define UDC_Non_ISO_FIFO_Empty       (1 << 1)
 122 #define UDC_Non_ISO_FIFO_Full        (1 << 0)
 123
 124 /* EPn_RX register fields */
 125 #define UDC_EPn_RX_Valid             (1 << 15)  /* valid */
 126 #define UDC_EPn_RX_Db                (1 << 14)  /* double-buffer */
 127 #define UDC_EPn_RX_Iso               (1 << 11)  /* isochronous */
 128
 129 /* EPn_TX register fields */
 130 #define UDC_EPn_TX_Valid             (1 << 15)  /* valid */
 131 #define UDC_EPn_TX_Db                (1 << 14)  /* double-buffer */
 132 #define UDC_EPn_TX_Iso               (1 << 11)  /* isochronous */
 133
 134 #define EP0_PACKETSIZE               0x40
 135
 136 /* physical to logical endpoint mapping
 137  * Physical endpoints are an index into device->bus->endpoint_array.
 138  * Logical endpoints are endpoints 0 to 15 IN and OUT as defined in
 139  * the USB specification.
 140  *
 141  *      physical ep     logical ep      direction       endpoint_address
 142  *      0               0               IN and OUT      0x00
 143  *      1 to 15         1 to 15         OUT             0x01 to 0x0f
 144  *      16 to 30        1 to 15         IN              0x81 to 0x8f
 145  */
 146 #define PHYS_EP_TO_EP_ADDR(ep) (((ep) < 16) ? (ep) : (((ep) - 15) | 0x80))
 147 #define EP_ADDR_TO_PHYS_EP(a) (((a) & 0x80) ? (((a) & ~0x80) + 15) : (a))
 148
 149 /* MOD_CONF_CTRL_0 bits (FIXME: move to board hardware.h ?) */
 150 #define CONF_MOD_USB_W2FC_VBUS_MODE_R (1 << 17)
 151
 152 /* Other registers (may be) related to USB */
 153
 154 #define CLOCK_CTRL          (0xFFFE0830)
 155 #define APLL_CTRL           (0xFFFE084C)
 156 #define DPLL_CTRL           (0xFFFE083C)
 157 #define SOFT_REQ            (0xFFFE0834)
 158 #define STATUS_REQ          (0xFFFE0840)
 159
 160 /* FUNC_MUX_CTRL_0 bits related to USB */
 161 #define UDC_VBUS_CTRL       (1 << 19)
 162 #define UDC_VBUS_MODE       (1 << 18)
 163
 164 /* OMAP Endpoint parameters */
 165 #define EP0_MAX_PACKET_SIZE 64
 166 #define UDC_OUT_ENDPOINT 2
 167 #define UDC_OUT_PACKET_SIZE 64
 168 #define UDC_IN_ENDPOINT 1
 169 #define UDC_IN_PACKET_SIZE 64
 170 #define UDC_INT_ENDPOINT 5
 171 #define UDC_INT_PACKET_SIZE     16
 172 #define UDC_BULK_PACKET_SIZE 16
 173
 174 void udc_irq (void);
 175 /* Flow control */
 176 void udc_set_nak(int epid);
 177 void udc_unset_nak (int epid);
 178
 179 /* Higher level functions for abstracting away from specific device */
 180 int udc_endpoint_write(struct usb_endpoint_instance *endpoint);
 181
 182 int  udc_init (void);
 183
 184 void udc_enable(struct usb_device_instance *device);
 185 void udc_disable(void);
 186
 187 void udc_connect(void);
 188 void udc_disconnect(void);
 189
 190 void udc_startup_events(struct usb_device_instance *device);
 191 void udc_setup_ep(struct usb_device_instance *device, unsigned int ep, struct usb_endpoint_instance *endpoint);
 192
 193 #endif