2 * bdc_udc.c - BRCM BDC USB3.0 device controller gagdet ops
4 * Copyright (C) 2014 Broadcom Corporation
6 * Author: Ashwini Pahuja
8 * Based on drivers under drivers/usb/gadget/udc/
10 * This program is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by the
12 * Free Software Foundation; either version 2 of the License, or (at your
13 * option) any later version.
16 #include <linux/module.h>
17 #include <linux/pci.h>
18 #include <linux/dma-mapping.h>
19 #include <linux/kernel.h>
20 #include <linux/delay.h>
21 #include <linux/ioport.h>
22 #include <linux/sched.h>
23 #include <linux/slab.h>
24 #include <linux/errno.h>
25 #include <linux/init.h>
26 #include <linux/timer.h>
27 #include <linux/list.h>
28 #include <linux/interrupt.h>
29 #include <linux/moduleparam.h>
30 #include <linux/device.h>
31 #include <linux/usb/ch9.h>
32 #include <linux/usb/gadget.h>
33 #include <linux/usb/otg.h>
36 #include <linux/irq.h>
37 #include <asm/unaligned.h>
38 #include <linux/platform_device.h>
45 static const struct usb_gadget_ops bdc_gadget_ops;
47 static const char * const conn_speed_str[] = {
55 /* EP0 initial descripror */
56 static struct usb_endpoint_descriptor bdc_gadget_ep0_desc = {
57 .bLength = USB_DT_ENDPOINT_SIZE,
58 .bDescriptorType = USB_DT_ENDPOINT,
59 .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
60 .bEndpointAddress = 0,
61 .wMaxPacketSize = cpu_to_le16(EP0_MAX_PKT_SIZE),
64 /* Advance the srr dqp maintained by SW */
65 static void srr_dqp_index_advc(struct bdc *bdc, u32 srr_num)
70 dev_dbg_ratelimited(bdc->dev, "srr->dqp_index:%d\n", srr->dqp_index);
72 /* rollback to 0 if we are past the last */
73 if (srr->dqp_index == NUM_SR_ENTRIES)
78 static void bdc_uspc_connected(struct bdc *bdc)
84 temp = bdc_readl(bdc->regs, BDC_USPC);
85 speed = BDC_PSP(temp);
86 dev_dbg(bdc->dev, "%s speed=%x\n", __func__, speed);
89 bdc_gadget_ep0_desc.wMaxPacketSize =
90 cpu_to_le16(EP0_MAX_PKT_SIZE);
91 bdc->gadget.ep0->maxpacket = EP0_MAX_PKT_SIZE;
92 bdc->gadget.speed = USB_SPEED_SUPER;
93 /* Enable U1T in SS mode */
94 usppms = bdc_readl(bdc->regs, BDC_USPPMS);
95 usppms &= ~BDC_U1T(0xff);
96 usppms |= BDC_U1T(U1_TIMEOUT);
97 usppms |= BDC_PORT_W1S;
98 bdc_writel(bdc->regs, BDC_USPPMS, usppms);
102 bdc_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(64);
103 bdc->gadget.ep0->maxpacket = 64;
104 bdc->gadget.speed = USB_SPEED_HIGH;
108 bdc_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(64);
109 bdc->gadget.ep0->maxpacket = 64;
110 bdc->gadget.speed = USB_SPEED_FULL;
114 bdc_gadget_ep0_desc.wMaxPacketSize = cpu_to_le16(8);
115 bdc->gadget.ep0->maxpacket = 8;
116 bdc->gadget.speed = USB_SPEED_LOW;
119 dev_err(bdc->dev, "UNDEFINED SPEED\n");
122 dev_dbg(bdc->dev, "connected at %s\n", conn_speed_str[speed]);
123 /* Now we know the speed, configure ep0 */
124 bdc->bdc_ep_array[1]->desc = &bdc_gadget_ep0_desc;
125 ret = bdc_config_ep(bdc, bdc->bdc_ep_array[1]);
127 dev_err(bdc->dev, "EP0 config failed\n");
128 bdc->bdc_ep_array[1]->usb_ep.desc = &bdc_gadget_ep0_desc;
129 bdc->bdc_ep_array[1]->flags |= BDC_EP_ENABLED;
130 usb_gadget_set_state(&bdc->gadget, USB_STATE_DEFAULT);
133 /* device got disconnected */
134 static void bdc_uspc_disconnected(struct bdc *bdc, bool reinit)
138 dev_dbg(bdc->dev, "%s\n", __func__);
140 * Only stop ep0 from here, rest of the endpoints will be disabled
141 * from gadget_disconnect
143 ep = bdc->bdc_ep_array[1];
144 if (ep && (ep->flags & BDC_EP_ENABLED))
145 /* if enabled then stop and remove requests */
148 if (bdc->gadget_driver && bdc->gadget_driver->disconnect) {
149 spin_unlock(&bdc->lock);
150 bdc->gadget_driver->disconnect(&bdc->gadget);
151 spin_lock(&bdc->lock);
153 /* Set Unknown speed */
154 bdc->gadget.speed = USB_SPEED_UNKNOWN;
155 bdc->devstatus &= DEVSTATUS_CLEAR;
156 bdc->delayed_status = false;
157 bdc->reinit = reinit;
158 bdc->test_mode = false;
159 usb_gadget_set_state(&bdc->gadget, USB_STATE_NOTATTACHED);
162 /* TNotify wkaeup timer */
163 static void bdc_func_wake_timer(struct work_struct *work)
165 struct bdc *bdc = container_of(work, struct bdc, func_wake_notify.work);
168 dev_dbg(bdc->dev, "%s\n", __func__);
169 spin_lock_irqsave(&bdc->lock, flags);
171 * Check if host has started transferring on endpoints
172 * FUNC_WAKE_ISSUED is cleared when transfer has started after resume
174 if (bdc->devstatus & FUNC_WAKE_ISSUED) {
175 dev_dbg(bdc->dev, "FUNC_WAKE_ISSUED FLAG IS STILL SET\n");
176 /* flag is still set, so again send func wake */
177 bdc_function_wake_fh(bdc, 0);
178 schedule_delayed_work(&bdc->func_wake_notify,
179 msecs_to_jiffies(BDC_TNOTIFY));
181 spin_unlock_irqrestore(&bdc->lock, flags);
184 /* handler for Link state change condition */
185 static void handle_link_state_change(struct bdc *bdc, u32 uspc)
189 dev_dbg(bdc->dev, "Link state change");
190 link_state = BDC_PST(uspc);
191 switch (link_state) {
192 case BDC_LINK_STATE_U3:
193 if ((bdc->gadget.speed != USB_SPEED_UNKNOWN) &&
194 bdc->gadget_driver->suspend) {
195 dev_dbg(bdc->dev, "Entered Suspend mode\n");
196 spin_unlock(&bdc->lock);
197 bdc->devstatus |= DEVICE_SUSPENDED;
198 bdc->gadget_driver->suspend(&bdc->gadget);
199 spin_lock(&bdc->lock);
202 case BDC_LINK_STATE_U0:
203 if (bdc->devstatus & REMOTE_WAKEUP_ISSUED) {
204 bdc->devstatus &= ~REMOTE_WAKEUP_ISSUED;
205 if (bdc->gadget.speed == USB_SPEED_SUPER) {
206 bdc_function_wake_fh(bdc, 0);
207 bdc->devstatus |= FUNC_WAKE_ISSUED;
209 * Start a Notification timer and check if the
210 * Host transferred anything on any of the EPs,
211 * if not then send function wake again every
212 * TNotification secs until host initiates
213 * transfer to BDC, USB3 spec Table 8.13
215 schedule_delayed_work(
216 &bdc->func_wake_notify,
217 msecs_to_jiffies(BDC_TNOTIFY));
218 dev_dbg(bdc->dev, "sched func_wake_notify\n");
223 case BDC_LINK_STATE_RESUME:
224 dev_dbg(bdc->dev, "Resumed from Suspend\n");
225 if (bdc->devstatus & DEVICE_SUSPENDED) {
226 bdc->gadget_driver->resume(&bdc->gadget);
227 bdc->devstatus &= ~DEVICE_SUSPENDED;
231 dev_dbg(bdc->dev, "link state:%d\n", link_state);
235 /* something changes on upstream port, handle it here */
236 void bdc_sr_uspc(struct bdc *bdc, struct bdc_sr *sreport)
240 bool connected = false;
241 bool disconn = false;
243 uspc = bdc_readl(bdc->regs, BDC_USPC);
244 dev_dbg(bdc->dev, "%s uspc=0x%08x\n", __func__, uspc);
246 /* Port connect changed */
247 if (uspc & BDC_PCC) {
248 /* Vbus not present, and not connected to Downstream port */
249 if ((uspc & BDC_VBC) && !(uspc & BDC_VBS) && !(uspc & BDC_PCS))
251 else if ((uspc & BDC_PCS) && !BDC_PST(uspc))
253 clear_flags |= BDC_PCC;
256 /* Change in VBus and VBus is present */
257 if ((uspc & BDC_VBC) && (uspc & BDC_VBS)) {
259 dev_dbg(bdc->dev, "Do a softconnect\n");
260 /* Attached state, do a softconnect */
262 usb_gadget_set_state(&bdc->gadget, USB_STATE_POWERED);
264 clear_flags |= BDC_VBC;
265 } else if ((uspc & BDC_PRS) || (uspc & BDC_PRC) || disconn) {
266 /* Hot reset, warm reset, 2.0 bus reset or disconn */
267 dev_dbg(bdc->dev, "Port reset or disconn\n");
268 bdc_uspc_disconnected(bdc, disconn);
269 clear_flags |= BDC_PRC;
270 } else if ((uspc & BDC_PSC) && (uspc & BDC_PCS)) {
271 /* Change in Link state */
272 handle_link_state_change(bdc, uspc);
273 clear_flags |= BDC_PSC;
277 * In SS we might not have PRC bit set before connection, but in 2.0
278 * the PRC bit is set before connection, so moving this condition out
279 * of bus reset to handle both SS/2.0 speeds.
282 /* This is the connect event for U0/L0 */
283 dev_dbg(bdc->dev, "Connected\n");
284 bdc_uspc_connected(bdc);
285 bdc->devstatus &= ~(DEVICE_SUSPENDED);
287 uspc = bdc_readl(bdc->regs, BDC_USPC);
288 uspc &= (~BDC_USPSC_RW);
289 dev_dbg(bdc->dev, "uspc=%x\n", uspc);
290 bdc_writel(bdc->regs, BDC_USPC, clear_flags);
293 /* Main interrupt handler for bdc */
294 static irqreturn_t bdc_udc_interrupt(int irq, void *_bdc)
296 u32 eqp_index, dqp_index, sr_type, srr_int;
297 struct bdc_sr *sreport;
298 struct bdc *bdc = _bdc;
302 spin_lock(&bdc->lock);
303 status = bdc_readl(bdc->regs, BDC_BDCSC);
304 if (!(status & BDC_GIP)) {
305 spin_unlock(&bdc->lock);
308 srr_int = bdc_readl(bdc->regs, BDC_SRRINT(0));
309 /* Check if the SRR IP bit it set? */
310 if (!(srr_int & BDC_SRR_IP)) {
311 dev_warn(bdc->dev, "Global irq pending but SRR IP is 0\n");
312 spin_unlock(&bdc->lock);
315 eqp_index = BDC_SRR_EPI(srr_int);
316 dqp_index = BDC_SRR_DPI(srr_int);
318 "%s eqp_index=%d dqp_index=%d srr.dqp_index=%d\n\n",
319 __func__, eqp_index, dqp_index, bdc->srr.dqp_index);
321 /* check for ring empty condition */
322 if (eqp_index == dqp_index) {
323 dev_dbg(bdc->dev, "SRR empty?\n");
324 spin_unlock(&bdc->lock);
328 while (bdc->srr.dqp_index != eqp_index) {
329 sreport = &bdc->srr.sr_bds[bdc->srr.dqp_index];
330 /* sreport is read before using it */
332 sr_type = le32_to_cpu(sreport->offset[3]) & BD_TYPE_BITMASK;
333 dev_dbg_ratelimited(bdc->dev, "sr_type=%d\n", sr_type);
336 bdc->sr_handler[0](bdc, sreport);
340 bdc->sr_handler[1](bdc, sreport);
343 dev_warn(bdc->dev, "SR:%d not handled\n", sr_type);
345 /* Advance the srr dqp index */
346 srr_dqp_index_advc(bdc, 0);
348 /* update the hw dequeue pointer */
349 srr_int = bdc_readl(bdc->regs, BDC_SRRINT(0));
350 srr_int &= ~BDC_SRR_DPI_MASK;
351 srr_int &= ~(BDC_SRR_RWS|BDC_SRR_RST|BDC_SRR_ISR);
352 srr_int |= ((bdc->srr.dqp_index) << 16);
353 srr_int |= BDC_SRR_IP;
354 bdc_writel(bdc->regs, BDC_SRRINT(0), srr_int);
355 srr_int = bdc_readl(bdc->regs, BDC_SRRINT(0));
357 ret = bdc_reinit(bdc);
359 dev_err(bdc->dev, "err in bdc reinit\n");
362 spin_unlock(&bdc->lock);
368 static int bdc_udc_start(struct usb_gadget *gadget,
369 struct usb_gadget_driver *driver)
371 struct bdc *bdc = gadget_to_bdc(gadget);
375 dev_dbg(bdc->dev, "%s()\n", __func__);
376 spin_lock_irqsave(&bdc->lock, flags);
377 if (bdc->gadget_driver) {
378 dev_err(bdc->dev, "%s is already bound to %s\n",
380 bdc->gadget_driver->driver.name);
385 * Run the controller from here and when BDC is connected to
386 * Host then driver will receive a USPC SR with VBUS present
387 * and then driver will do a softconnect.
391 dev_err(bdc->dev, "%s bdc run fail\n", __func__);
394 bdc->gadget_driver = driver;
395 bdc->gadget.dev.driver = &driver->driver;
397 spin_unlock_irqrestore(&bdc->lock, flags);
402 static int bdc_udc_stop(struct usb_gadget *gadget)
404 struct bdc *bdc = gadget_to_bdc(gadget);
407 dev_dbg(bdc->dev, "%s()\n", __func__);
408 spin_lock_irqsave(&bdc->lock, flags);
410 bdc->gadget_driver = NULL;
411 bdc->gadget.dev.driver = NULL;
412 spin_unlock_irqrestore(&bdc->lock, flags);
417 static int bdc_udc_pullup(struct usb_gadget *gadget, int is_on)
419 struct bdc *bdc = gadget_to_bdc(gadget);
423 dev_dbg(bdc->dev, "%s() is_on:%d\n", __func__, is_on);
427 spin_lock_irqsave(&bdc->lock, flags);
429 bdc_softdisconn(bdc);
433 * For a self powered device, we need to wait till we receive
434 * a VBUS change and Vbus present event, then if pullup flag
435 * is set, then only we present the Termintation.
439 * Check if BDC is already connected to Host i.e Vbus=1,
440 * if yes, then present TERM now, this is typical for bus
443 uspc = bdc_readl(bdc->regs, BDC_USPC);
447 spin_unlock_irqrestore(&bdc->lock, flags);
452 static int bdc_udc_set_selfpowered(struct usb_gadget *gadget,
455 struct bdc *bdc = gadget_to_bdc(gadget);
458 dev_dbg(bdc->dev, "%s()\n", __func__);
459 gadget->is_selfpowered = (is_self != 0);
460 spin_lock_irqsave(&bdc->lock, flags);
462 bdc->devstatus |= 1 << USB_DEVICE_SELF_POWERED;
464 bdc->devstatus &= ~(1 << USB_DEVICE_SELF_POWERED);
466 spin_unlock_irqrestore(&bdc->lock, flags);
471 static int bdc_udc_wakeup(struct usb_gadget *gadget)
473 struct bdc *bdc = gadget_to_bdc(gadget);
480 "%s() bdc->devstatus=%08x\n",
481 __func__, bdc->devstatus);
483 if (!(bdc->devstatus & REMOTE_WAKE_ENABLE))
486 spin_lock_irqsave(&bdc->lock, flags);
487 uspc = bdc_readl(bdc->regs, BDC_USPC);
488 link_state = BDC_PST(uspc);
489 dev_dbg(bdc->dev, "link_state =%d portsc=%x", link_state, uspc);
490 if (link_state != BDC_LINK_STATE_U3) {
492 "can't wakeup from link state %d\n",
497 if (bdc->gadget.speed == USB_SPEED_SUPER)
498 bdc->devstatus |= REMOTE_WAKEUP_ISSUED;
500 uspc &= ~BDC_PST_MASK;
501 uspc &= (~BDC_USPSC_RW);
502 uspc |= BDC_PST(BDC_LINK_STATE_U0);
504 bdc_writel(bdc->regs, BDC_USPC, uspc);
505 uspc = bdc_readl(bdc->regs, BDC_USPC);
506 link_state = BDC_PST(uspc);
507 dev_dbg(bdc->dev, "link_state =%d portsc=%x", link_state, uspc);
509 spin_unlock_irqrestore(&bdc->lock, flags);
514 static const struct usb_gadget_ops bdc_gadget_ops = {
515 .wakeup = bdc_udc_wakeup,
516 .set_selfpowered = bdc_udc_set_selfpowered,
517 .pullup = bdc_udc_pullup,
518 .udc_start = bdc_udc_start,
519 .udc_stop = bdc_udc_stop,
522 /* Init the gadget interface and register the udc */
523 int bdc_udc_init(struct bdc *bdc)
528 dev_dbg(bdc->dev, "%s()\n", __func__);
529 bdc->gadget.ops = &bdc_gadget_ops;
530 bdc->gadget.max_speed = USB_SPEED_SUPER;
531 bdc->gadget.speed = USB_SPEED_UNKNOWN;
532 bdc->gadget.dev.parent = bdc->dev;
534 bdc->gadget.sg_supported = false;
537 bdc->gadget.name = BRCM_BDC_NAME;
538 ret = devm_request_irq(bdc->dev, bdc->irq, bdc_udc_interrupt,
539 IRQF_SHARED , BRCM_BDC_NAME, bdc);
542 "failed to request irq #%d %d\n",
547 ret = bdc_init_ep(bdc);
549 dev_err(bdc->dev, "bdc init ep fail: %d\n", ret);
553 ret = usb_add_gadget_udc(bdc->dev, &bdc->gadget);
555 dev_err(bdc->dev, "failed to register udc\n");
558 usb_gadget_set_state(&bdc->gadget, USB_STATE_NOTATTACHED);
559 bdc->bdc_ep_array[1]->desc = &bdc_gadget_ep0_desc;
561 * Allocate bd list for ep0 only, ep0 will be enabled on connect
562 * status report when the speed is known
564 ret = bdc_ep_enable(bdc->bdc_ep_array[1]);
566 dev_err(bdc->dev, "fail to enable %s\n",
567 bdc->bdc_ep_array[1]->name);
570 INIT_DELAYED_WORK(&bdc->func_wake_notify, bdc_func_wake_timer);
571 /* Enable Interrupts */
572 temp = bdc_readl(bdc->regs, BDC_BDCSC);
574 bdc_writel(bdc->regs, BDC_BDCSC, temp);
577 usb_del_gadget_udc(&bdc->gadget);
584 void bdc_udc_exit(struct bdc *bdc)
588 dev_dbg(bdc->dev, "%s()\n", __func__);
589 spin_lock_irqsave(&bdc->lock, flags);
590 bdc_ep_disable(bdc->bdc_ep_array[1]);
591 spin_unlock_irqrestore(&bdc->lock, flags);
593 usb_del_gadget_udc(&bdc->gadget);