Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 1 | /* |
| 2 | * MUSB OTG driver defines |
| 3 | * |
| 4 | * Copyright 2005 Mentor Graphics Corporation |
| 5 | * Copyright (C) 2005-2006 by Texas Instruments |
| 6 | * Copyright (C) 2006-2007 Nokia Corporation |
| 7 | * |
| 8 | * This program is free software; you can redistribute it and/or |
| 9 | * modify it under the terms of the GNU General Public License |
| 10 | * version 2 as published by the Free Software Foundation. |
| 11 | * |
| 12 | * This program is distributed in the hope that it will be useful, but |
| 13 | * WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 15 | * General Public License for more details. |
| 16 | * |
| 17 | * You should have received a copy of the GNU General Public License |
| 18 | * along with this program; if not, write to the Free Software |
| 19 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA |
| 20 | * 02110-1301 USA |
| 21 | * |
| 22 | * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED |
| 23 | * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF |
| 24 | * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN |
| 25 | * NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, |
| 26 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
| 27 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF |
| 28 | * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON |
| 29 | * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| 30 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
| 31 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 32 | * |
| 33 | */ |
| 34 | |
| 35 | #ifndef __MUSB_CORE_H__ |
| 36 | #define __MUSB_CORE_H__ |
| 37 | |
| 38 | #include <linux/slab.h> |
| 39 | #include <linux/list.h> |
| 40 | #include <linux/interrupt.h> |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 41 | #include <linux/errno.h> |
David Brownell | f7f9d63 | 2009-03-31 12:32:12 -0700 | [diff] [blame] | 42 | #include <linux/timer.h> |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 43 | #include <linux/device.h> |
| 44 | #include <linux/usb/ch9.h> |
| 45 | #include <linux/usb/gadget.h> |
| 46 | #include <linux/usb.h> |
| 47 | #include <linux/usb/otg.h> |
| 48 | #include <linux/usb/musb.h> |
Kishon Vijay Abraham I | 3e3101d | 2013-09-27 11:53:30 +0530 | [diff] [blame] | 49 | #include <linux/phy/phy.h> |
Daniel Mack | 8ed1fb7 | 2013-12-18 20:23:46 +0100 | [diff] [blame] | 50 | #include <linux/workqueue.h> |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 51 | |
| 52 | struct musb; |
| 53 | struct musb_hw_ep; |
| 54 | struct musb_ep; |
| 55 | |
Cliff Cai | 0ded2f1 | 2010-01-28 20:43:44 -0500 | [diff] [blame] | 56 | /* Helper defines for struct musb->hwvers */ |
| 57 | #define MUSB_HWVERS_MAJOR(x) ((x >> 10) & 0x1f) |
| 58 | #define MUSB_HWVERS_MINOR(x) (x & 0x3ff) |
| 59 | #define MUSB_HWVERS_RC 0x8000 |
| 60 | #define MUSB_HWVERS_1300 0x52C |
| 61 | #define MUSB_HWVERS_1400 0x590 |
| 62 | #define MUSB_HWVERS_1800 0x720 |
| 63 | #define MUSB_HWVERS_1900 0x784 |
| 64 | #define MUSB_HWVERS_2000 0x800 |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 65 | |
| 66 | #include "musb_debug.h" |
| 67 | #include "musb_dma.h" |
| 68 | |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 69 | #include "musb_io.h" |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 70 | |
| 71 | #include "musb_gadget.h" |
Eric Lescouet | 27729aa | 2010-04-24 23:21:52 +0200 | [diff] [blame] | 72 | #include <linux/usb/hcd.h> |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 73 | #include "musb_host.h" |
| 74 | |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 75 | /* NOTE: otg and peripheral-only state machines start at B_IDLE. |
| 76 | * OTG or host-only go to A_IDLE when ID is sensed. |
| 77 | */ |
| 78 | #define is_peripheral_active(m) (!(m)->is_host) |
| 79 | #define is_host_active(m) ((m)->is_host) |
| 80 | |
Daniel Mack | 9ad96e6 | 2013-04-10 21:55:48 +0200 | [diff] [blame] | 81 | enum { |
| 82 | MUSB_PORT_MODE_HOST = 1, |
| 83 | MUSB_PORT_MODE_GADGET, |
| 84 | MUSB_PORT_MODE_DUAL_ROLE, |
| 85 | }; |
| 86 | |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 87 | /****************************** CONSTANTS ********************************/ |
| 88 | |
| 89 | #ifndef MUSB_C_NUM_EPS |
| 90 | #define MUSB_C_NUM_EPS ((u8)16) |
| 91 | #endif |
| 92 | |
| 93 | #ifndef MUSB_MAX_END0_PACKET |
| 94 | #define MUSB_MAX_END0_PACKET ((u16)MUSB_EP0_FIFOSIZE) |
| 95 | #endif |
| 96 | |
| 97 | /* host side ep0 states */ |
| 98 | enum musb_h_ep0_state { |
| 99 | MUSB_EP0_IDLE, |
| 100 | MUSB_EP0_START, /* expect ack of setup */ |
| 101 | MUSB_EP0_IN, /* expect IN DATA */ |
| 102 | MUSB_EP0_OUT, /* expect ack of OUT DATA */ |
| 103 | MUSB_EP0_STATUS, /* expect ack of STATUS */ |
| 104 | } __attribute__ ((packed)); |
| 105 | |
| 106 | /* peripheral side ep0 states */ |
| 107 | enum musb_g_ep0_state { |
Sergei Shtylyov | a5073b5 | 2009-03-27 12:52:43 -0700 | [diff] [blame] | 108 | MUSB_EP0_STAGE_IDLE, /* idle, waiting for SETUP */ |
| 109 | MUSB_EP0_STAGE_SETUP, /* received SETUP */ |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 110 | MUSB_EP0_STAGE_TX, /* IN data */ |
| 111 | MUSB_EP0_STAGE_RX, /* OUT data */ |
| 112 | MUSB_EP0_STAGE_STATUSIN, /* (after OUT data) */ |
| 113 | MUSB_EP0_STAGE_STATUSOUT, /* (after IN data) */ |
| 114 | MUSB_EP0_STAGE_ACKWAIT, /* after zlp, before statusin */ |
| 115 | } __attribute__ ((packed)); |
| 116 | |
David Brownell | f7f9d63 | 2009-03-31 12:32:12 -0700 | [diff] [blame] | 117 | /* |
| 118 | * OTG protocol constants. See USB OTG 1.3 spec, |
| 119 | * sections 5.5 "Device Timings" and 6.6.5 "Timers". |
| 120 | */ |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 121 | #define OTG_TIME_A_WAIT_VRISE 100 /* msec (max) */ |
David Brownell | f7f9d63 | 2009-03-31 12:32:12 -0700 | [diff] [blame] | 122 | #define OTG_TIME_A_WAIT_BCON 1100 /* min 1 second */ |
| 123 | #define OTG_TIME_A_AIDL_BDIS 200 /* min 200 msec */ |
| 124 | #define OTG_TIME_B_ASE0_BRST 100 /* min 3.125 ms */ |
| 125 | |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 126 | /****************************** FUNCTIONS ********************************/ |
| 127 | |
| 128 | #define MUSB_HST_MODE(_musb)\ |
| 129 | { (_musb)->is_host = true; } |
| 130 | #define MUSB_DEV_MODE(_musb) \ |
| 131 | { (_musb)->is_host = false; } |
| 132 | |
| 133 | #define test_devctl_hst_mode(_x) \ |
| 134 | (musb_readb((_x)->mregs, MUSB_DEVCTL)&MUSB_DEVCTL_HM) |
| 135 | |
| 136 | #define MUSB_MODE(musb) ((musb)->is_host ? "Host" : "Peripheral") |
| 137 | |
| 138 | /******************************** TYPES *************************************/ |
| 139 | |
Tony Lindgren | 5450ac8 | 2014-11-24 11:04:59 -0800 | [diff] [blame] | 140 | struct musb_io; |
| 141 | |
Felipe Balbi | 3ca8abb | 2010-10-21 13:56:40 +0300 | [diff] [blame] | 142 | /** |
| 143 | * struct musb_platform_ops - Operations passed to musb_core by HW glue layer |
Tony Lindgren | 5450ac8 | 2014-11-24 11:04:59 -0800 | [diff] [blame] | 144 | * @quirks: flags for platform specific quirks |
| 145 | * @enable: enable device |
| 146 | * @disable: disable device |
| 147 | * @ep_offset: returns the end point offset |
| 148 | * @ep_select: selects the specified end point |
| 149 | * @fifo_mode: sets the fifo mode |
| 150 | * @fifo_offset: returns the fifo offset |
| 151 | * @readb: read 8 bits |
| 152 | * @writeb: write 8 bits |
| 153 | * @readw: read 16 bits |
| 154 | * @writew: write 16 bits |
| 155 | * @readl: read 32 bits |
| 156 | * @writel: write 32 bits |
| 157 | * @read_fifo: reads the fifo |
| 158 | * @write_fifo: writes to fifo |
Tony Lindgren | 7f6283e | 2015-05-01 12:29:28 -0700 | [diff] [blame] | 159 | * @dma_init: platform specific dma init function |
| 160 | * @dma_exit: platform specific dma exit function |
Felipe Balbi | 3ca8abb | 2010-10-21 13:56:40 +0300 | [diff] [blame] | 161 | * @init: turns on clocks, sets up platform-specific registers, etc |
| 162 | * @exit: undoes @init |
Felipe Balbi | 3ca8abb | 2010-10-21 13:56:40 +0300 | [diff] [blame] | 163 | * @set_mode: forcefully changes operating mode |
Felipe Balbi | b28a643 | 2015-02-26 14:20:58 -0600 | [diff] [blame] | 164 | * @try_idle: tries to idle the IP |
| 165 | * @recover: platform-specific babble recovery |
Felipe Balbi | 3ca8abb | 2010-10-21 13:56:40 +0300 | [diff] [blame] | 166 | * @vbus_status: returns vbus status if possible |
| 167 | * @set_vbus: forces vbus status |
Mike Frysinger | 9ea3533 | 2011-06-29 16:41:48 +0300 | [diff] [blame] | 168 | * @adjust_channel_params: pre check for standard dma channel_program func |
Hans de Goede | 591fa9d | 2015-03-29 12:50:47 +0200 | [diff] [blame] | 169 | * @pre_root_reset_end: called before the root usb port reset flag gets cleared |
| 170 | * @post_root_reset_end: called after the root usb port reset flag gets cleared |
Felipe Balbi | 3ca8abb | 2010-10-21 13:56:40 +0300 | [diff] [blame] | 171 | */ |
| 172 | struct musb_platform_ops { |
Tony Lindgren | 5450ac8 | 2014-11-24 11:04:59 -0800 | [diff] [blame] | 173 | |
| 174 | #define MUSB_DMA_UX500 BIT(6) |
| 175 | #define MUSB_DMA_CPPI41 BIT(5) |
| 176 | #define MUSB_DMA_CPPI BIT(4) |
| 177 | #define MUSB_DMA_TUSB_OMAP BIT(3) |
| 178 | #define MUSB_DMA_INVENTRA BIT(2) |
| 179 | #define MUSB_IN_TUSB BIT(1) |
| 180 | #define MUSB_INDEXED_EP BIT(0) |
| 181 | u32 quirks; |
| 182 | |
Felipe Balbi | 3ca8abb | 2010-10-21 13:56:40 +0300 | [diff] [blame] | 183 | int (*init)(struct musb *musb); |
| 184 | int (*exit)(struct musb *musb); |
| 185 | |
Felipe Balbi | 3ca8abb | 2010-10-21 13:56:40 +0300 | [diff] [blame] | 186 | void (*enable)(struct musb *musb); |
| 187 | void (*disable)(struct musb *musb); |
| 188 | |
Tony Lindgren | 5450ac8 | 2014-11-24 11:04:59 -0800 | [diff] [blame] | 189 | u32 (*ep_offset)(u8 epnum, u16 offset); |
| 190 | void (*ep_select)(void __iomem *mbase, u8 epnum); |
| 191 | u16 fifo_mode; |
| 192 | u32 (*fifo_offset)(u8 epnum); |
Hans de Goede | 6cc2af6 | 2015-03-20 20:11:12 +0100 | [diff] [blame] | 193 | u32 (*busctl_offset)(u8 epnum, u16 offset); |
Tony Lindgren | 5450ac8 | 2014-11-24 11:04:59 -0800 | [diff] [blame] | 194 | u8 (*readb)(const void __iomem *addr, unsigned offset); |
| 195 | void (*writeb)(void __iomem *addr, unsigned offset, u8 data); |
| 196 | u16 (*readw)(const void __iomem *addr, unsigned offset); |
| 197 | void (*writew)(void __iomem *addr, unsigned offset, u16 data); |
| 198 | u32 (*readl)(const void __iomem *addr, unsigned offset); |
| 199 | void (*writel)(void __iomem *addr, unsigned offset, u32 data); |
| 200 | void (*read_fifo)(struct musb_hw_ep *hw_ep, u16 len, u8 *buf); |
| 201 | void (*write_fifo)(struct musb_hw_ep *hw_ep, u16 len, const u8 *buf); |
Tony Lindgren | 7f6283e | 2015-05-01 12:29:28 -0700 | [diff] [blame] | 202 | struct dma_controller * |
| 203 | (*dma_init) (struct musb *musb, void __iomem *base); |
| 204 | void (*dma_exit)(struct dma_controller *c); |
Felipe Balbi | 3ca8abb | 2010-10-21 13:56:40 +0300 | [diff] [blame] | 205 | int (*set_mode)(struct musb *musb, u8 mode); |
| 206 | void (*try_idle)(struct musb *musb, unsigned long timeout); |
Felipe Balbi | b28a643 | 2015-02-26 14:20:58 -0600 | [diff] [blame] | 207 | int (*recover)(struct musb *musb); |
Felipe Balbi | 3ca8abb | 2010-10-21 13:56:40 +0300 | [diff] [blame] | 208 | |
| 209 | int (*vbus_status)(struct musb *musb); |
| 210 | void (*set_vbus)(struct musb *musb, int on); |
Mike Frysinger | 1325430 | 2011-03-30 22:48:54 -0400 | [diff] [blame] | 211 | |
| 212 | int (*adjust_channel_params)(struct dma_channel *channel, |
| 213 | u16 packet_sz, u8 *mode, |
| 214 | dma_addr_t *dma_addr, u32 *len); |
Hans de Goede | 591fa9d | 2015-03-29 12:50:47 +0200 | [diff] [blame] | 215 | void (*pre_root_reset_end)(struct musb *musb); |
| 216 | void (*post_root_reset_end)(struct musb *musb); |
Felipe Balbi | 3ca8abb | 2010-10-21 13:56:40 +0300 | [diff] [blame] | 217 | }; |
| 218 | |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 219 | /* |
| 220 | * struct musb_hw_ep - endpoint hardware (bidirectional) |
| 221 | * |
| 222 | * Ordered slightly for better cacheline locality. |
| 223 | */ |
| 224 | struct musb_hw_ep { |
| 225 | struct musb *musb; |
| 226 | void __iomem *fifo; |
| 227 | void __iomem *regs; |
| 228 | |
Tony Lindgren | ebf3992 | 2014-11-24 11:05:06 -0800 | [diff] [blame] | 229 | #if IS_ENABLED(CONFIG_USB_MUSB_TUSB6010) |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 230 | void __iomem *conf; |
| 231 | #endif |
| 232 | |
| 233 | /* index in musb->endpoints[] */ |
| 234 | u8 epnum; |
| 235 | |
| 236 | /* hardware configuration, possibly dynamic */ |
| 237 | bool is_shared_fifo; |
| 238 | bool tx_double_buffered; |
| 239 | bool rx_double_buffered; |
| 240 | u16 max_packet_sz_tx; |
| 241 | u16 max_packet_sz_rx; |
| 242 | |
| 243 | struct dma_channel *tx_channel; |
| 244 | struct dma_channel *rx_channel; |
| 245 | |
Tony Lindgren | ebf3992 | 2014-11-24 11:05:06 -0800 | [diff] [blame] | 246 | #if IS_ENABLED(CONFIG_USB_MUSB_TUSB6010) |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 247 | /* TUSB has "asynchronous" and "synchronous" dma modes */ |
| 248 | dma_addr_t fifo_async; |
| 249 | dma_addr_t fifo_sync; |
| 250 | void __iomem *fifo_sync_va; |
| 251 | #endif |
| 252 | |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 253 | /* currently scheduled peripheral endpoint */ |
| 254 | struct musb_qh *in_qh; |
| 255 | struct musb_qh *out_qh; |
| 256 | |
| 257 | u8 rx_reinit; |
| 258 | u8 tx_reinit; |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 259 | |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 260 | /* peripheral side */ |
| 261 | struct musb_ep ep_in; /* TX */ |
| 262 | struct musb_ep ep_out; /* RX */ |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 263 | }; |
| 264 | |
Felipe Balbi | ad1adb8 | 2011-02-16 12:40:05 +0200 | [diff] [blame] | 265 | static inline struct musb_request *next_in_request(struct musb_hw_ep *hw_ep) |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 266 | { |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 267 | return next_request(&hw_ep->ep_in); |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 268 | } |
| 269 | |
Felipe Balbi | ad1adb8 | 2011-02-16 12:40:05 +0200 | [diff] [blame] | 270 | static inline struct musb_request *next_out_request(struct musb_hw_ep *hw_ep) |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 271 | { |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 272 | return next_request(&hw_ep->ep_out); |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 273 | } |
| 274 | |
Felipe Balbi | 7421107 | 2010-12-01 13:53:27 +0200 | [diff] [blame] | 275 | struct musb_csr_regs { |
| 276 | /* FIFO registers */ |
| 277 | u16 txmaxp, txcsr, rxmaxp, rxcsr; |
| 278 | u16 rxfifoadd, txfifoadd; |
| 279 | u8 txtype, txinterval, rxtype, rxinterval; |
| 280 | u8 rxfifosz, txfifosz; |
| 281 | u8 txfunaddr, txhubaddr, txhubport; |
| 282 | u8 rxfunaddr, rxhubaddr, rxhubport; |
| 283 | }; |
| 284 | |
| 285 | struct musb_context_registers { |
| 286 | |
Felipe Balbi | 7421107 | 2010-12-01 13:53:27 +0200 | [diff] [blame] | 287 | u8 power; |
Felipe Balbi | 7421107 | 2010-12-01 13:53:27 +0200 | [diff] [blame] | 288 | u8 intrusbe; |
| 289 | u16 frame; |
| 290 | u8 index, testmode; |
| 291 | |
| 292 | u8 devctl, busctl, misc; |
Hema HK | e25bec1 | 2011-09-07 09:19:24 -0700 | [diff] [blame] | 293 | u32 otg_interfsel; |
Felipe Balbi | 7421107 | 2010-12-01 13:53:27 +0200 | [diff] [blame] | 294 | |
| 295 | struct musb_csr_regs index_regs[MUSB_C_NUM_EPS]; |
| 296 | }; |
| 297 | |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 298 | /* |
| 299 | * struct musb - Driver instance data. |
| 300 | */ |
| 301 | struct musb { |
| 302 | /* device lock */ |
| 303 | spinlock_t lock; |
Felipe Balbi | 743411b | 2010-12-01 13:22:05 +0200 | [diff] [blame] | 304 | |
Tony Lindgren | 5450ac8 | 2014-11-24 11:04:59 -0800 | [diff] [blame] | 305 | struct musb_io io; |
Felipe Balbi | 743411b | 2010-12-01 13:22:05 +0200 | [diff] [blame] | 306 | const struct musb_platform_ops *ops; |
Felipe Balbi | 7421107 | 2010-12-01 13:53:27 +0200 | [diff] [blame] | 307 | struct musb_context_registers context; |
Felipe Balbi | 743411b | 2010-12-01 13:22:05 +0200 | [diff] [blame] | 308 | |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 309 | irqreturn_t (*isr)(int, void *); |
| 310 | struct work_struct irq_work; |
Daniel Mack | 8ed1fb7 | 2013-12-18 20:23:46 +0100 | [diff] [blame] | 311 | struct delayed_work deassert_reset_work; |
| 312 | struct delayed_work finish_resume_work; |
Anand Gadiyar | 32c3b94 | 2009-11-16 21:09:21 +0530 | [diff] [blame] | 313 | u16 hwvers; |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 314 | |
Sebastian Andrzej Siewior | af5ec14 | 2012-10-30 19:52:25 +0100 | [diff] [blame] | 315 | u16 intrrxe; |
Sebastian Andrzej Siewior | b18d26f | 2012-10-30 19:52:26 +0100 | [diff] [blame] | 316 | u16 intrtxe; |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 317 | /* this hub status bit is reserved by USB 2.0 and not seen by usbcore */ |
| 318 | #define MUSB_PORT_STAT_RESUME (1 << 31) |
| 319 | |
| 320 | u32 port1_status; |
| 321 | |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 322 | unsigned long rh_timer; |
| 323 | |
| 324 | enum musb_h_ep0_state ep0_stage; |
| 325 | |
| 326 | /* bulk traffic normally dedicates endpoint hardware, and each |
| 327 | * direction has its own ring of host side endpoints. |
| 328 | * we try to progress the transfer at the head of each endpoint's |
| 329 | * queue until it completes or NAKs too much; then we try the next |
| 330 | * endpoint. |
| 331 | */ |
| 332 | struct musb_hw_ep *bulk_ep; |
| 333 | |
| 334 | struct list_head control; /* of musb_qh */ |
| 335 | struct list_head in_bulk; /* of musb_qh */ |
| 336 | struct list_head out_bulk; /* of musb_qh */ |
David Brownell | f7f9d63 | 2009-03-31 12:32:12 -0700 | [diff] [blame] | 337 | |
| 338 | struct timer_list otg_timer; |
Hema HK | 594632e | 2010-12-10 18:10:51 +0530 | [diff] [blame] | 339 | struct notifier_block nb; |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 340 | |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 341 | struct dma_controller *dma_controller; |
| 342 | |
| 343 | struct device *controller; |
| 344 | void __iomem *ctrl_base; |
| 345 | void __iomem *mregs; |
| 346 | |
Tony Lindgren | ebf3992 | 2014-11-24 11:05:06 -0800 | [diff] [blame] | 347 | #if IS_ENABLED(CONFIG_USB_MUSB_TUSB6010) |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 348 | dma_addr_t async; |
| 349 | dma_addr_t sync; |
| 350 | void __iomem *sync_va; |
Matwey V. Kornilov | 8c240dc | 2014-05-16 18:19:54 +0400 | [diff] [blame] | 351 | u8 tusb_revision; |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 352 | #endif |
| 353 | |
| 354 | /* passed down from chip/board specific irq handlers */ |
| 355 | u8 int_usb; |
| 356 | u16 int_rx; |
| 357 | u16 int_tx; |
| 358 | |
Heikki Krogerus | 8675381 | 2012-02-13 13:24:02 +0200 | [diff] [blame] | 359 | struct usb_phy *xceiv; |
Kishon Vijay Abraham I | 3e3101d | 2013-09-27 11:53:30 +0530 | [diff] [blame] | 360 | struct phy *phy; |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 361 | |
| 362 | int nIrq; |
Felipe Balbi | c48a515 | 2008-11-24 13:06:53 +0200 | [diff] [blame] | 363 | unsigned irq_wake:1; |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 364 | |
| 365 | struct musb_hw_ep endpoints[MUSB_C_NUM_EPS]; |
| 366 | #define control_ep endpoints |
| 367 | |
| 368 | #define VBUSERR_RETRY_COUNT 3 |
| 369 | u16 vbuserr_retry; |
| 370 | u16 epmask; |
| 371 | u8 nr_endpoints; |
| 372 | |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 373 | int (*board_set_power)(int state); |
| 374 | |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 375 | u8 min_power; /* vbus for periph, in mA/2 */ |
| 376 | |
Daniel Mack | 9ad96e6 | 2013-04-10 21:55:48 +0200 | [diff] [blame] | 377 | int port_mode; /* MUSB_PORT_MODE_* */ |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 378 | bool is_host; |
| 379 | |
| 380 | int a_wait_bcon; /* VBUS timeout in msecs */ |
| 381 | unsigned long idle_timeout; /* Next timeout in jiffies */ |
| 382 | |
| 383 | /* active means connected and not suspended */ |
| 384 | unsigned is_active:1; |
| 385 | |
| 386 | unsigned is_multipoint:1; |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 387 | |
Ajay Kumar Gupta | a483d70 | 2009-04-03 16:16:17 -0700 | [diff] [blame] | 388 | unsigned hb_iso_rx:1; /* high bandwidth iso rx? */ |
| 389 | unsigned hb_iso_tx:1; /* high bandwidth iso tx? */ |
Ajay Kumar Gupta | 51bf0d0 | 2009-12-28 13:40:41 +0200 | [diff] [blame] | 390 | unsigned dyn_fifo:1; /* dynamic FIFO supported? */ |
Ajay Kumar Gupta | a483d70 | 2009-04-03 16:16:17 -0700 | [diff] [blame] | 391 | |
Felipe Balbi | 7ed069c | 2009-12-15 11:08:39 +0200 | [diff] [blame] | 392 | unsigned bulk_split:1; |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 393 | #define can_bulk_split(musb,type) \ |
Felipe Balbi | 7ed069c | 2009-12-15 11:08:39 +0200 | [diff] [blame] | 394 | (((type) == USB_ENDPOINT_XFER_BULK) && (musb)->bulk_split) |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 395 | |
Felipe Balbi | 7ed069c | 2009-12-15 11:08:39 +0200 | [diff] [blame] | 396 | unsigned bulk_combine:1; |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 397 | #define can_bulk_combine(musb,type) \ |
Felipe Balbi | 7ed069c | 2009-12-15 11:08:39 +0200 | [diff] [blame] | 398 | (((type) == USB_ENDPOINT_XFER_BULK) && (musb)->bulk_combine) |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 399 | |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 400 | /* is_suspended means USB B_PERIPHERAL suspend */ |
| 401 | unsigned is_suspended:1; |
Sebastian Andrzej Siewior | baadd52 | 2014-10-27 19:06:19 +0100 | [diff] [blame] | 402 | unsigned need_finish_resume :1; |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 403 | |
| 404 | /* may_wakeup means remote wakeup is enabled */ |
| 405 | unsigned may_wakeup:1; |
| 406 | |
| 407 | /* is_self_powered is reported in device status and the |
| 408 | * config descriptor. is_bus_powered means B_PERIPHERAL |
| 409 | * draws some VBUS current; both can be true. |
| 410 | */ |
| 411 | unsigned is_self_powered:1; |
| 412 | unsigned is_bus_powered:1; |
| 413 | |
| 414 | unsigned set_address:1; |
| 415 | unsigned test_mode:1; |
| 416 | unsigned softconnect:1; |
Felipe Balbi | 5990378 | 2011-02-11 10:00:02 +0200 | [diff] [blame] | 417 | |
| 418 | u8 address; |
| 419 | u8 test_mode_nr; |
| 420 | u16 ackpend; /* ep0 */ |
| 421 | enum musb_g_ep0_state ep0_state; |
| 422 | struct usb_gadget g; /* the gadget */ |
| 423 | struct usb_gadget_driver *gadget_driver; /* its driver */ |
Daniel Mack | 74c2e93 | 2013-04-10 21:55:45 +0200 | [diff] [blame] | 424 | struct usb_hcd *hcd; /* the usb hcd */ |
Felipe Balbi | 5990378 | 2011-02-11 10:00:02 +0200 | [diff] [blame] | 425 | |
Felipe Balbi | 0662481 | 2011-01-21 13:39:20 +0800 | [diff] [blame] | 426 | /* |
| 427 | * FIXME: Remove this flag. |
| 428 | * |
| 429 | * This is only added to allow Blackfin to work |
| 430 | * with current driver. For some unknown reason |
| 431 | * Blackfin doesn't work with double buffering |
| 432 | * and that's enabled by default. |
| 433 | * |
| 434 | * We added this flag to forcefully disable double |
| 435 | * buffering until we get it working. |
| 436 | */ |
Felipe Balbi | fc87e08 | 2012-04-18 13:49:20 +0300 | [diff] [blame] | 437 | unsigned double_buffer_not_ok:1; |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 438 | |
Felipe Balbi | ca6d1b1 | 2008-08-08 12:40:54 +0300 | [diff] [blame] | 439 | struct musb_hdrc_config *config; |
| 440 | |
Ajay Kumar Gupta | 8d2421e | 2012-08-31 11:09:50 +0000 | [diff] [blame] | 441 | int xceiv_old_state; |
| 442 | #ifdef CONFIG_DEBUG_FS |
| 443 | struct dentry *debugfs_root; |
| 444 | #endif |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 445 | }; |
| 446 | |
Hans de Goede | 6cc2af6 | 2015-03-20 20:11:12 +0100 | [diff] [blame] | 447 | /* This must be included after struct musb is defined */ |
| 448 | #include "musb_regs.h" |
| 449 | |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 450 | static inline struct musb *gadget_to_musb(struct usb_gadget *g) |
| 451 | { |
| 452 | return container_of(g, struct musb, g); |
| 453 | } |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 454 | |
Bryan Wu | c6cf8b0 | 2008-12-02 21:33:48 +0200 | [diff] [blame] | 455 | #ifdef CONFIG_BLACKFIN |
| 456 | static inline int musb_read_fifosize(struct musb *musb, |
| 457 | struct musb_hw_ep *hw_ep, u8 epnum) |
| 458 | { |
| 459 | musb->nr_endpoints++; |
| 460 | musb->epmask |= (1 << epnum); |
| 461 | |
| 462 | if (epnum < 5) { |
| 463 | hw_ep->max_packet_sz_tx = 128; |
| 464 | hw_ep->max_packet_sz_rx = 128; |
| 465 | } else { |
| 466 | hw_ep->max_packet_sz_tx = 1024; |
| 467 | hw_ep->max_packet_sz_rx = 1024; |
| 468 | } |
| 469 | hw_ep->is_shared_fifo = false; |
| 470 | |
| 471 | return 0; |
| 472 | } |
| 473 | |
| 474 | static inline void musb_configure_ep0(struct musb *musb) |
| 475 | { |
| 476 | musb->endpoints[0].max_packet_sz_tx = MUSB_EP0_FIFOSIZE; |
| 477 | musb->endpoints[0].max_packet_sz_rx = MUSB_EP0_FIFOSIZE; |
| 478 | musb->endpoints[0].is_shared_fifo = true; |
| 479 | } |
| 480 | |
| 481 | #else |
| 482 | |
| 483 | static inline int musb_read_fifosize(struct musb *musb, |
| 484 | struct musb_hw_ep *hw_ep, u8 epnum) |
| 485 | { |
Felipe Balbi | a156544 | 2012-08-07 14:00:50 +0300 | [diff] [blame] | 486 | void __iomem *mbase = musb->mregs; |
Bryan Wu | c6cf8b0 | 2008-12-02 21:33:48 +0200 | [diff] [blame] | 487 | u8 reg = 0; |
| 488 | |
| 489 | /* read from core using indexed model */ |
Tony Lindgren | d026e9c | 2014-11-24 11:05:03 -0800 | [diff] [blame] | 490 | reg = musb_readb(mbase, musb->io.ep_offset(epnum, MUSB_FIFOSIZE)); |
Bryan Wu | c6cf8b0 | 2008-12-02 21:33:48 +0200 | [diff] [blame] | 491 | /* 0's returned when no more endpoints */ |
| 492 | if (!reg) |
| 493 | return -ENODEV; |
| 494 | |
| 495 | musb->nr_endpoints++; |
| 496 | musb->epmask |= (1 << epnum); |
| 497 | |
| 498 | hw_ep->max_packet_sz_tx = 1 << (reg & 0x0f); |
| 499 | |
| 500 | /* shared TX/RX FIFO? */ |
| 501 | if ((reg & 0xf0) == 0xf0) { |
| 502 | hw_ep->max_packet_sz_rx = hw_ep->max_packet_sz_tx; |
| 503 | hw_ep->is_shared_fifo = true; |
| 504 | return 0; |
| 505 | } else { |
| 506 | hw_ep->max_packet_sz_rx = 1 << ((reg & 0xf0) >> 4); |
| 507 | hw_ep->is_shared_fifo = false; |
| 508 | } |
| 509 | |
| 510 | return 0; |
| 511 | } |
| 512 | |
| 513 | static inline void musb_configure_ep0(struct musb *musb) |
| 514 | { |
| 515 | musb->endpoints[0].max_packet_sz_tx = MUSB_EP0_FIFOSIZE; |
| 516 | musb->endpoints[0].max_packet_sz_rx = MUSB_EP0_FIFOSIZE; |
Giuseppe GORGOGLIONE | 3223371 | 2009-02-24 15:27:34 -0800 | [diff] [blame] | 517 | musb->endpoints[0].is_shared_fifo = true; |
Bryan Wu | c6cf8b0 | 2008-12-02 21:33:48 +0200 | [diff] [blame] | 518 | } |
| 519 | #endif /* CONFIG_BLACKFIN */ |
| 520 | |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 521 | |
| 522 | /***************************** Glue it together *****************************/ |
| 523 | |
| 524 | extern const char musb_driver_name[]; |
| 525 | |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 526 | extern void musb_stop(struct musb *musb); |
Sebastian Andrzej Siewior | 001dd84 | 2013-10-11 10:38:13 +0200 | [diff] [blame] | 527 | extern void musb_start(struct musb *musb); |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 528 | |
| 529 | extern void musb_write_fifo(struct musb_hw_ep *ep, u16 len, const u8 *src); |
| 530 | extern void musb_read_fifo(struct musb_hw_ep *ep, u16 len, u8 *dst); |
| 531 | |
| 532 | extern void musb_load_testpacket(struct musb *); |
| 533 | |
| 534 | extern irqreturn_t musb_interrupt(struct musb *); |
| 535 | |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 536 | extern void musb_hnp_stop(struct musb *musb); |
| 537 | |
Felipe Balbi | 743411b | 2010-12-01 13:22:05 +0200 | [diff] [blame] | 538 | static inline void musb_platform_set_vbus(struct musb *musb, int is_on) |
| 539 | { |
| 540 | if (musb->ops->set_vbus) |
| 541 | musb->ops->set_vbus(musb, is_on); |
| 542 | } |
| 543 | |
| 544 | static inline void musb_platform_enable(struct musb *musb) |
| 545 | { |
| 546 | if (musb->ops->enable) |
| 547 | musb->ops->enable(musb); |
| 548 | } |
| 549 | |
| 550 | static inline void musb_platform_disable(struct musb *musb) |
| 551 | { |
| 552 | if (musb->ops->disable) |
| 553 | musb->ops->disable(musb); |
| 554 | } |
| 555 | |
| 556 | static inline int musb_platform_set_mode(struct musb *musb, u8 mode) |
| 557 | { |
| 558 | if (!musb->ops->set_mode) |
| 559 | return 0; |
| 560 | |
| 561 | return musb->ops->set_mode(musb, mode); |
| 562 | } |
| 563 | |
| 564 | static inline void musb_platform_try_idle(struct musb *musb, |
| 565 | unsigned long timeout) |
| 566 | { |
| 567 | if (musb->ops->try_idle) |
| 568 | musb->ops->try_idle(musb, timeout); |
| 569 | } |
| 570 | |
Felipe Balbi | b28a643 | 2015-02-26 14:20:58 -0600 | [diff] [blame] | 571 | static inline int musb_platform_recover(struct musb *musb) |
Daniel Mack | 1e42d20 | 2014-04-02 13:58:27 +0200 | [diff] [blame] | 572 | { |
Felipe Balbi | b28a643 | 2015-02-26 14:20:58 -0600 | [diff] [blame] | 573 | if (!musb->ops->recover) |
| 574 | return 0; |
George Cherian | d871c62 | 2014-07-16 18:22:11 +0530 | [diff] [blame] | 575 | |
Felipe Balbi | b28a643 | 2015-02-26 14:20:58 -0600 | [diff] [blame] | 576 | return musb->ops->recover(musb); |
Daniel Mack | 1e42d20 | 2014-04-02 13:58:27 +0200 | [diff] [blame] | 577 | } |
| 578 | |
Felipe Balbi | 743411b | 2010-12-01 13:22:05 +0200 | [diff] [blame] | 579 | static inline int musb_platform_get_vbus_status(struct musb *musb) |
| 580 | { |
| 581 | if (!musb->ops->vbus_status) |
Roman Alyautdin | 3bbafac | 2015-10-12 17:14:32 +0300 | [diff] [blame] | 582 | return -EINVAL; |
Felipe Balbi | 743411b | 2010-12-01 13:22:05 +0200 | [diff] [blame] | 583 | |
| 584 | return musb->ops->vbus_status(musb); |
| 585 | } |
| 586 | |
| 587 | static inline int musb_platform_init(struct musb *musb) |
| 588 | { |
| 589 | if (!musb->ops->init) |
| 590 | return -EINVAL; |
| 591 | |
| 592 | return musb->ops->init(musb); |
| 593 | } |
| 594 | |
| 595 | static inline int musb_platform_exit(struct musb *musb) |
| 596 | { |
| 597 | if (!musb->ops->exit) |
| 598 | return -EINVAL; |
| 599 | |
| 600 | return musb->ops->exit(musb); |
| 601 | } |
| 602 | |
Hans de Goede | 591fa9d | 2015-03-29 12:50:47 +0200 | [diff] [blame] | 603 | static inline void musb_platform_pre_root_reset_end(struct musb *musb) |
| 604 | { |
| 605 | if (musb->ops->pre_root_reset_end) |
| 606 | musb->ops->pre_root_reset_end(musb); |
| 607 | } |
| 608 | |
| 609 | static inline void musb_platform_post_root_reset_end(struct musb *musb) |
| 610 | { |
| 611 | if (musb->ops->post_root_reset_end) |
| 612 | musb->ops->post_root_reset_end(musb); |
| 613 | } |
| 614 | |
Felipe Balbi | 550a737 | 2008-07-24 12:27:36 +0300 | [diff] [blame] | 615 | #endif /* __MUSB_CORE_H__ */ |