LXR linux/drivers/usb/gadget/udc/omap

   1/* SPDX-License-Identifier: GPL-2.0 */
   2/*
   3 * omap_udc.h -- for omap 3.2 udc, with OTG support
   4 *
   5 * 2004 (C) Texas Instruments, Inc.
   6 * 2004 (C) David Brownell
   7 */
   8
   9/*
  10 * USB device/endpoint management registers
  11 */
  12
  13#define UDC_REV                         (UDC_BASE + 0x0)        /* Revision */
  14#define UDC_EP_NUM                      (UDC_BASE + 0x4)        /* Which endpoint */
  15#       define  UDC_SETUP_SEL           (1 << 6)
  16#       define  UDC_EP_SEL              (1 << 5)
  17#       define  UDC_EP_DIR              (1 << 4)
  18        /* low 4 bits for endpoint number */
  19#define UDC_DATA                        (UDC_BASE + 0x08)       /* Endpoint FIFO */
  20#define UDC_CTRL                        (UDC_BASE + 0x0C)       /* Endpoint control */
  21#       define  UDC_CLR_HALT            (1 << 7)
  22#       define  UDC_SET_HALT            (1 << 6)
  23#       define  UDC_CLRDATA_TOGGLE      (1 << 3)
  24#       define  UDC_SET_FIFO_EN         (1 << 2)
  25#       define  UDC_CLR_EP              (1 << 1)
  26#       define  UDC_RESET_EP            (1 << 0)
  27#define UDC_STAT_FLG                    (UDC_BASE + 0x10)       /* Endpoint status */
  28#       define  UDC_NO_RXPACKET         (1 << 15)
  29#       define  UDC_MISS_IN             (1 << 14)
  30#       define  UDC_DATA_FLUSH          (1 << 13)
  31#       define  UDC_ISO_ERR             (1 << 12)
  32#       define  UDC_ISO_FIFO_EMPTY      (1 << 9)
  33#       define  UDC_ISO_FIFO_FULL       (1 << 8)
  34#       define  UDC_EP_HALTED           (1 << 6)
  35#       define  UDC_STALL               (1 << 5)
  36#       define  UDC_NAK                 (1 << 4)
  37#       define  UDC_ACK                 (1 << 3)
  38#       define  UDC_FIFO_EN             (1 << 2)
  39#       define  UDC_NON_ISO_FIFO_EMPTY  (1 << 1)
  40#       define  UDC_NON_ISO_FIFO_FULL   (1 << 0)
  41#define UDC_RXFSTAT                     (UDC_BASE + 0x14)       /* OUT bytecount */
  42#define UDC_SYSCON1                     (UDC_BASE + 0x18)       /* System config 1 */
  43#       define  UDC_CFG_LOCK            (1 << 8)
  44#       define  UDC_DATA_ENDIAN         (1 << 7)
  45#       define  UDC_DMA_ENDIAN          (1 << 6)
  46#       define  UDC_NAK_EN              (1 << 4)
  47#       define  UDC_AUTODECODE_DIS      (1 << 3)
  48#       define  UDC_SELF_PWR            (1 << 2)
  49#       define  UDC_SOFF_DIS            (1 << 1)
  50#       define  UDC_PULLUP_EN           (1 << 0)
  51#define UDC_SYSCON2                     (UDC_BASE + 0x1C)       /* System config 2 */
  52#       define  UDC_RMT_WKP             (1 << 6)
  53#       define  UDC_STALL_CMD           (1 << 5)
  54#       define  UDC_DEV_CFG             (1 << 3)
  55#       define  UDC_CLR_CFG             (1 << 2)
  56#define UDC_DEVSTAT                     (UDC_BASE + 0x20)       /* Device status */
  57#       define  UDC_B_HNP_ENABLE        (1 << 9)
  58#       define  UDC_A_HNP_SUPPORT       (1 << 8)
  59#       define  UDC_A_ALT_HNP_SUPPORT   (1 << 7)
  60#       define  UDC_R_WK_OK             (1 << 6)
  61#       define  UDC_USB_RESET           (1 << 5)
  62#       define  UDC_SUS                 (1 << 4)
  63#       define  UDC_CFG                 (1 << 3)
  64#       define  UDC_ADD                 (1 << 2)
  65#       define  UDC_DEF                 (1 << 1)
  66#       define  UDC_ATT                 (1 << 0)
  67#define UDC_SOF                         (UDC_BASE + 0x24)       /* Start of frame */
  68#       define  UDC_FT_LOCK             (1 << 12)
  69#       define  UDC_TS_OK               (1 << 11)
  70#       define  UDC_TS                  0x03ff
  71#define UDC_IRQ_EN                      (UDC_BASE + 0x28)       /* Interrupt enable */
  72#       define  UDC_SOF_IE              (1 << 7)
  73#       define  UDC_EPN_RX_IE           (1 << 5)
  74#       define  UDC_EPN_TX_IE           (1 << 4)
  75#       define  UDC_DS_CHG_IE           (1 << 3)
  76#       define  UDC_EP0_IE              (1 << 0)
  77#define UDC_DMA_IRQ_EN                  (UDC_BASE + 0x2C)       /* DMA irq enable */
  78        /* rx/tx dma channels numbered 1-3 not 0-2 */
  79#       define  UDC_TX_DONE_IE(n)       (1 << (4 * (n) - 2))
  80#       define  UDC_RX_CNT_IE(n)        (1 << (4 * (n) - 3))
  81#       define  UDC_RX_EOT_IE(n)        (1 << (4 * (n) - 4))
  82#define UDC_IRQ_SRC                     (UDC_BASE + 0x30)       /* Interrupt source */
  83#       define  UDC_TXN_DONE            (1 << 10)
  84#       define  UDC_RXN_CNT             (1 << 9)
  85#       define  UDC_RXN_EOT             (1 << 8)
  86#       define  UDC_IRQ_SOF             (1 << 7)
  87#       define  UDC_EPN_RX              (1 << 5)
  88#       define  UDC_EPN_TX              (1 << 4)
  89#       define  UDC_DS_CHG              (1 << 3)
  90#       define  UDC_SETUP               (1 << 2)
  91#       define  UDC_EP0_RX              (1 << 1)
  92#       define  UDC_EP0_TX              (1 << 0)
  93#       define  UDC_IRQ_SRC_MASK        0x7bf
  94#define UDC_EPN_STAT                    (UDC_BASE + 0x34)       /* EP irq status */
  95#define UDC_DMAN_STAT                   (UDC_BASE + 0x38)       /* DMA irq status */
  96#       define  UDC_DMA_RX_SB           (1 << 12)
  97#       define  UDC_DMA_RX_SRC(x)       (((x)>>8) & 0xf)
  98#       define  UDC_DMA_TX_SRC(x)       (((x)>>0) & 0xf)
  99
 100
 101/* DMA configuration registers:  up to three channels in each direction.  */
 102#define UDC_RXDMA_CFG                   (UDC_BASE + 0x40)       /* 3 eps for RX DMA */
 103#       define  UDC_DMA_REQ             (1 << 12)
 104#define UDC_TXDMA_CFG                   (UDC_BASE + 0x44)       /* 3 eps for TX DMA */
 105#define UDC_DATA_DMA                    (UDC_BASE + 0x48)       /* rx/tx fifo addr */
 106
 107/* rx/tx dma control, numbering channels 1-3 not 0-2 */
 108#define UDC_TXDMA(chan)                 (UDC_BASE + 0x50 - 4 + 4 * (chan))
 109#       define UDC_TXN_EOT              (1 << 15)       /* bytes vs packets */
 110#       define UDC_TXN_START            (1 << 14)       /* start transfer */
 111#       define UDC_TXN_TSC              0x03ff          /* units in xfer */
 112#define UDC_RXDMA(chan)                 (UDC_BASE + 0x60 - 4 + 4 * (chan))
 113#       define UDC_RXN_STOP             (1 << 15)       /* enable EOT irq */
 114#       define UDC_RXN_TC               0x00ff          /* packets in xfer */
 115
 116
 117/*
 118 * Endpoint configuration registers (used before CFG_LOCK is set)
 119 * UDC_EP_TX(0) is unused
 120 */
 121#define UDC_EP_RX(endpoint)             (UDC_BASE + 0x80 + (endpoint)*4)
 122#       define  UDC_EPN_RX_VALID        (1 << 15)
 123#       define  UDC_EPN_RX_DB           (1 << 14)
 124        /* buffer size in bits 13, 12 */
 125#       define  UDC_EPN_RX_ISO          (1 << 11)
 126        /* buffer pointer in low 11 bits */
 127#define UDC_EP_TX(endpoint)             (UDC_BASE + 0xc0 + (endpoint)*4)
 128        /* same bitfields as in RX */
 129
 130/*-------------------------------------------------------------------------*/
 131
 132struct omap_req {
 133        struct usb_request              req;
 134        struct list_head                queue;
 135        unsigned                        dma_bytes;
 136        unsigned                        mapped:1;
 137};
 138
 139struct omap_ep {
 140        struct usb_ep                   ep;
 141        struct list_head                queue;
 142        unsigned long                   irqs;
 143        struct list_head                iso;
 144        char                            name[14];
 145        u16                             maxpacket;
 146        u8                              bEndpointAddress;
 147        u8                              bmAttributes;
 148        unsigned                        double_buf:1;
 149        unsigned                        stopped:1;
 150        unsigned                        fnf:1;
 151        unsigned                        has_dma:1;
 152        u8                              ackwait;
 153        u8                              dma_channel;
 154        u16                             dma_counter;
 155        int                             lch;
 156        struct omap_udc                 *udc;
 157        struct timer_list               timer;
 158};
 159
 160struct omap_udc {
 161        struct usb_gadget               gadget;
 162        struct usb_gadget_driver        *driver;
 163        spinlock_t                      lock;
 164        struct omap_ep                  ep[32];
 165        u16                             devstat;
 166        u16                             clr_halt;
 167        struct usb_phy                  *transceiver;
 168        struct list_head                iso;
 169        unsigned                        softconnect:1;
 170        unsigned                        vbus_active:1;
 171        unsigned                        ep0_pending:1;
 172        unsigned                        ep0_in:1;
 173        unsigned                        ep0_set_config:1;
 174        unsigned                        ep0_reset_config:1;
 175        unsigned                        ep0_setup:1;
 176        struct completion               *done;
 177        struct clk                      *dc_clk;
 178        struct clk                      *hhc_clk;
 179        unsigned                        clk_requested:1;
 180};
 181
 182/*-------------------------------------------------------------------------*/
 183
 184#ifdef VERBOSE
 185#    define VDBG                DBG
 186#else
 187#    define VDBG(stuff...)      do{}while(0)
 188#endif
 189
 190#define ERR(stuff...)           pr_err("udc: " stuff)
 191#define WARNING(stuff...)       pr_warn("udc: " stuff)
 192#define INFO(stuff...)          pr_info("udc: " stuff)
 193#define DBG(stuff...)           pr_debug("udc: " stuff)
 194
 195/*-------------------------------------------------------------------------*/
 196
 197/* MOD_CONF_CTRL_0 */
 198#define VBUS_W2FC_1510          (1 << 17)       /* 0 gpio0, 1 dvdd2 pin */
 199
 200/* FUNC_MUX_CTRL_0 */
 201#define VBUS_CTRL_1510          (1 << 19)       /* 1 connected (software) */
 202#define VBUS_MODE_1510          (1 << 18)       /* 0 hardware, 1 software */
 203
 204#define HMC_1510        ((omap_readl(MOD_CONF_CTRL_0) >> 1) & 0x3f)
 205#define HMC_1610        (omap_readl(OTG_SYSCON_2) & 0x3f)
 206#define HMC             (cpu_is_omap15xx() ? HMC_1510 : HMC_1610)
 207
 208