1 /*
2 * SL811HS HCD (Host Controller Driver) for USB.
3 *
4 * Copyright (C) 2004 Psion Teklogix (for NetBook PRO)
5 * Copyright (C) 2004-2005 David Brownell
6 *
7 * Periodic scheduling is based on Roman's OHCI code
8 * Copyright (C) 1999 Roman Weissgaerber
9 *
10 * The SL811HS controller handles host side USB (like the SL11H, but with
11 * another register set and SOF generation) as well as peripheral side USB
12 * (like the SL811S). This driver version doesn't implement the Gadget API
13 * for the peripheral role; or OTG (that'd need much external circuitry).
14 *
15 * For documentation, see the SL811HS spec and the "SL811HS Embedded Host"
16 * document (providing significant pieces missing from that spec); plus
17 * the SL811S spec if you want peripheral side info.
18 */
19
20 /*
21 * Status: Passed basic stress testing, works with hubs, mice, keyboards,
22 * and usb-storage.
23 *
24 * TODO:
25 * - usb suspend/resume triggered by sl811
26 * - various issues noted in the code
27 * - performance work; use both register banks; ...
28 * - use urb->iso_frame_desc[] with ISO transfers
29 */
30
31 #undef VERBOSE
32 #undef PACKET_TRACE
33
34 #include <linux/module.h>
35 #include <linux/moduleparam.h>
36 #include <linux/kernel.h>
37 #include <linux/delay.h>
38 #include <linux/ioport.h>
39 #include <linux/sched.h>
40 #include <linux/slab.h>
41 #include <linux/errno.h>
42 #include <linux/timer.h>
43 #include <linux/list.h>
44 #include <linux/interrupt.h>
45 #include <linux/usb.h>
46 #include <linux/usb/sl811.h>
47 #include <linux/usb/hcd.h>
48 #include <linux/platform_device.h>
49 #include <linux/prefetch.h>
50 #include <linux/debugfs.h>
51 #include <linux/seq_file.h>
52
53 #include <asm/io.h>
54 #include <asm/irq.h>
55 #include <asm/byteorder.h>
56 #include <asm/unaligned.h>
57
58 #include "sl811.h"
59
60
61 MODULE_DESCRIPTION("SL811HS USB Host Controller Driver");
62 MODULE_LICENSE("GPL");
63 MODULE_ALIAS("platform:sl811-hcd");
64
65 #define DRIVER_VERSION "19 May 2005"
66
67 /* for now, use only one transfer register bank */
68 #undef USE_B
69
70 // #define QUIRK2
71 #define QUIRK3
72
73 static const char hcd_name[] = "sl811-hcd";
74
75 /*-------------------------------------------------------------------------*/
76
port_power(struct sl811 * sl811,int is_on)77 static void port_power(struct sl811 *sl811, int is_on)
78 {
79 struct usb_hcd *hcd = sl811_to_hcd(sl811);
80
81 /* hub is inactive unless the port is powered */
82 if (is_on) {
83 if (sl811->port1 & USB_PORT_STAT_POWER)
84 return;
85
86 sl811->port1 = USB_PORT_STAT_POWER;
87 sl811->irq_enable = SL11H_INTMASK_INSRMV;
88 } else {
89 sl811->port1 = 0;
90 sl811->irq_enable = 0;
91 hcd->state = HC_STATE_HALT;
92 }
93 sl811->ctrl1 = 0;
94 sl811_write(sl811, SL11H_IRQ_ENABLE, 0);
95 sl811_write(sl811, SL11H_IRQ_STATUS, ~0);
96
97 if (sl811->board && sl811->board->port_power) {
98 /* switch VBUS, at 500mA unless hub power budget gets set */
99 dev_dbg(hcd->self.controller, "power %s\n",
100 is_on ? "on" : "off");
101 sl811->board->port_power(hcd->self.controller, is_on);
102 }
103
104 /* reset as thoroughly as we can */
105 if (sl811->board && sl811->board->reset)
106 sl811->board->reset(hcd->self.controller);
107 else {
108 sl811_write(sl811, SL11H_CTLREG1, SL11H_CTL1MASK_SE0);
109 mdelay(20);
110 }
111
112 sl811_write(sl811, SL11H_IRQ_ENABLE, 0);
113 sl811_write(sl811, SL11H_CTLREG1, sl811->ctrl1);
114 sl811_write(sl811, SL811HS_CTLREG2, SL811HS_CTL2_INIT);
115 sl811_write(sl811, SL11H_IRQ_ENABLE, sl811->irq_enable);
116
117 // if !is_on, put into lowpower mode now
118 }
119
120 /*-------------------------------------------------------------------------*/
121
122 /* This is a PIO-only HCD. Queueing appends URBs to the endpoint's queue,
123 * and may start I/O. Endpoint queues are scanned during completion irq
124 * handlers (one per packet: ACK, NAK, faults, etc) and urb cancellation.
125 *
126 * Using an external DMA engine to copy a packet at a time could work,
127 * though setup/teardown costs may be too big to make it worthwhile.
128 */
129
130 /* SETUP starts a new control request. Devices are not allowed to
131 * STALL or NAK these; they must cancel any pending control requests.
132 */
setup_packet(struct sl811 * sl811,struct sl811h_ep * ep,struct urb * urb,u8 bank,u8 control)133 static void setup_packet(
134 struct sl811 *sl811,
135 struct sl811h_ep *ep,
136 struct urb *urb,
137 u8 bank,
138 u8 control
139 )
140 {
141 u8 addr;
142 u8 len;
143 void __iomem *data_reg;
144
145 addr = SL811HS_PACKET_BUF(bank == 0);
146 len = sizeof(struct usb_ctrlrequest);
147 data_reg = sl811->data_reg;
148 sl811_write_buf(sl811, addr, urb->setup_packet, len);
149
150 /* autoincrementing */
151 sl811_write(sl811, bank + SL11H_BUFADDRREG, addr);
152 writeb(len, data_reg);
153 writeb(SL_SETUP /* | ep->epnum */, data_reg);
154 writeb(usb_pipedevice(urb->pipe), data_reg);
155
156 /* always OUT/data0 */
157 sl811_write(sl811, bank + SL11H_HOSTCTLREG,
158 control | SL11H_HCTLMASK_OUT);
159 ep->length = 0;
160 PACKET("SETUP qh%p\n", ep);
161 }
162
163 /* STATUS finishes control requests, often after IN or OUT data packets */
status_packet(struct sl811 * sl811,struct sl811h_ep * ep,struct urb * urb,u8 bank,u8 control)164 static void status_packet(
165 struct sl811 *sl811,
166 struct sl811h_ep *ep,
167 struct urb *urb,
168 u8 bank,
169 u8 control
170 )
171 {
172 int do_out;
173 void __iomem *data_reg;
174
175 do_out = urb->transfer_buffer_length && usb_pipein(urb->pipe);
176 data_reg = sl811->data_reg;
177
178 /* autoincrementing */
179 sl811_write(sl811, bank + SL11H_BUFADDRREG, 0);
180 writeb(0, data_reg);
181 writeb((do_out ? SL_OUT : SL_IN) /* | ep->epnum */, data_reg);
182 writeb(usb_pipedevice(urb->pipe), data_reg);
183
184 /* always data1; sometimes IN */
185 control |= SL11H_HCTLMASK_TOGGLE;
186 if (do_out)
187 control |= SL11H_HCTLMASK_OUT;
188 sl811_write(sl811, bank + SL11H_HOSTCTLREG, control);
189 ep->length = 0;
190 PACKET("STATUS%s/%s qh%p\n", ep->nak_count ? "/retry" : "",
191 do_out ? "out" : "in", ep);
192 }
193
194 /* IN packets can be used with any type of endpoint. here we just
195 * start the transfer, data from the peripheral may arrive later.
196 * urb->iso_frame_desc is currently ignored here...
197 */
in_packet(struct sl811 * sl811,struct sl811h_ep * ep,struct urb * urb,u8 bank,u8 control)198 static void in_packet(
199 struct sl811 *sl811,
200 struct sl811h_ep *ep,
201 struct urb *urb,
202 u8 bank,
203 u8 control
204 )
205 {
206 u8 addr;
207 u8 len;
208 void __iomem *data_reg;
209
210 /* avoid losing data on overflow */
211 len = ep->maxpacket;
212 addr = SL811HS_PACKET_BUF(bank == 0);
213 if (!(control & SL11H_HCTLMASK_ISOCH)
214 && usb_gettoggle(urb->dev, ep->epnum, 0))
215 control |= SL11H_HCTLMASK_TOGGLE;
216 data_reg = sl811->data_reg;
217
218 /* autoincrementing */
219 sl811_write(sl811, bank + SL11H_BUFADDRREG, addr);
220 writeb(len, data_reg);
221 writeb(SL_IN | ep->epnum, data_reg);
222 writeb(usb_pipedevice(urb->pipe), data_reg);
223
224 sl811_write(sl811, bank + SL11H_HOSTCTLREG, control);
225 ep->length = min_t(u32, len,
226 urb->transfer_buffer_length - urb->actual_length);
227 PACKET("IN%s/%d qh%p len%d\n", ep->nak_count ? "/retry" : "",
228 !!usb_gettoggle(urb->dev, ep->epnum, 0), ep, len);
229 }
230
231 /* OUT packets can be used with any type of endpoint.
232 * urb->iso_frame_desc is currently ignored here...
233 */
out_packet(struct sl811 * sl811,struct sl811h_ep * ep,struct urb * urb,u8 bank,u8 control)234 static void out_packet(
235 struct sl811 *sl811,
236 struct sl811h_ep *ep,
237 struct urb *urb,
238 u8 bank,
239 u8 control
240 )
241 {
242 void *buf;
243 u8 addr;
244 u8 len;
245 void __iomem *data_reg;
246
247 buf = urb->transfer_buffer + urb->actual_length;
248 prefetch(buf);
249
250 len = min_t(u32, ep->maxpacket,
251 urb->transfer_buffer_length - urb->actual_length);
252
253 if (!(control & SL11H_HCTLMASK_ISOCH)
254 && usb_gettoggle(urb->dev, ep->epnum, 1))
255 control |= SL11H_HCTLMASK_TOGGLE;
256 addr = SL811HS_PACKET_BUF(bank == 0);
257 data_reg = sl811->data_reg;
258
259 sl811_write_buf(sl811, addr, buf, len);
260
261 /* autoincrementing */
262 sl811_write(sl811, bank + SL11H_BUFADDRREG, addr);
263 writeb(len, data_reg);
264 writeb(SL_OUT | ep->epnum, data_reg);
265 writeb(usb_pipedevice(urb->pipe), data_reg);
266
267 sl811_write(sl811, bank + SL11H_HOSTCTLREG,
268 control | SL11H_HCTLMASK_OUT);
269 ep->length = len;
270 PACKET("OUT%s/%d qh%p len%d\n", ep->nak_count ? "/retry" : "",
271 !!usb_gettoggle(urb->dev, ep->epnum, 1), ep, len);
272 }
273
274 /*-------------------------------------------------------------------------*/
275
276 /* caller updates on-chip enables later */
277
sofirq_on(struct sl811 * sl811)278 static inline void sofirq_on(struct sl811 *sl811)
279 {
280 if (sl811->irq_enable & SL11H_INTMASK_SOFINTR)
281 return;
282 dev_dbg(sl811_to_hcd(sl811)->self.controller, "sof irq on\n");
283 sl811->irq_enable |= SL11H_INTMASK_SOFINTR;
284 }
285
sofirq_off(struct sl811 * sl811)286 static inline void sofirq_off(struct sl811 *sl811)
287 {
288 if (!(sl811->irq_enable & SL11H_INTMASK_SOFINTR))
289 return;
290 dev_dbg(sl811_to_hcd(sl811)->self.controller, "sof irq off\n");
291 sl811->irq_enable &= ~SL11H_INTMASK_SOFINTR;
292 }
293
294 /*-------------------------------------------------------------------------*/
295
296 /* pick the next endpoint for a transaction, and issue it.
297 * frames start with periodic transfers (after whatever is pending
298 * from the previous frame), and the rest of the time is async
299 * transfers, scheduled round-robin.
300 */
start(struct sl811 * sl811,u8 bank)301 static struct sl811h_ep *start(struct sl811 *sl811, u8 bank)
302 {
303 struct sl811h_ep *ep;
304 struct urb *urb;
305 int fclock;
306 u8 control;
307
308 /* use endpoint at schedule head */
309 if (sl811->next_periodic) {
310 ep = sl811->next_periodic;
311 sl811->next_periodic = ep->next;
312 } else {
313 if (sl811->next_async)
314 ep = sl811->next_async;
315 else if (!list_empty(&sl811->async))
316 ep = container_of(sl811->async.next,
317 struct sl811h_ep, schedule);
318 else {
319 /* could set up the first fullspeed periodic
320 * transfer for the next frame ...
321 */
322 return NULL;
323 }
324
325 #ifdef USE_B
326 if ((bank && sl811->active_b == ep) || sl811->active_a == ep)
327 return NULL;
328 #endif
329
330 if (ep->schedule.next == &sl811->async)
331 sl811->next_async = NULL;
332 else
333 sl811->next_async = container_of(ep->schedule.next,
334 struct sl811h_ep, schedule);
335 }
336
337 if (unlikely(list_empty(&ep->hep->urb_list))) {
338 dev_dbg(sl811_to_hcd(sl811)->self.controller,
339 "empty %p queue?\n", ep);
340 return NULL;
341 }
342
343 urb = container_of(ep->hep->urb_list.next, struct urb, urb_list);
344 control = ep->defctrl;
345
346 /* if this frame doesn't have enough time left to transfer this
347 * packet, wait till the next frame. too-simple algorithm...
348 */
349 fclock = sl811_read(sl811, SL11H_SOFTMRREG) << 6;
350 fclock -= 100; /* setup takes not much time */
351 if (urb->dev->speed == USB_SPEED_LOW) {
352 if (control & SL11H_HCTLMASK_PREAMBLE) {
353 /* also note erratum 1: some hubs won't work */
354 fclock -= 800;
355 }
356 fclock -= ep->maxpacket << 8;
357
358 /* erratum 2: AFTERSOF only works for fullspeed */
359 if (fclock < 0) {
360 if (ep->period)
361 sl811->stat_overrun++;
362 sofirq_on(sl811);
363 return NULL;
364 }
365 } else {
366 fclock -= 12000 / 19; /* 19 64byte packets/msec */
367 if (fclock < 0) {
368 if (ep->period)
369 sl811->stat_overrun++;
370 control |= SL11H_HCTLMASK_AFTERSOF;
371
372 /* throttle bulk/control irq noise */
373 } else if (ep->nak_count)
374 control |= SL11H_HCTLMASK_AFTERSOF;
375 }
376
377
378 switch (ep->nextpid) {
379 case USB_PID_IN:
380 in_packet(sl811, ep, urb, bank, control);
381 break;
382 case USB_PID_OUT:
383 out_packet(sl811, ep, urb, bank, control);
384 break;
385 case USB_PID_SETUP:
386 setup_packet(sl811, ep, urb, bank, control);
387 break;
388 case USB_PID_ACK: /* for control status */
389 status_packet(sl811, ep, urb, bank, control);
390 break;
391 default:
392 dev_dbg(sl811_to_hcd(sl811)->self.controller,
393 "bad ep%p pid %02x\n", ep, ep->nextpid);
394 ep = NULL;
395 }
396 return ep;
397 }
398
399 #define MIN_JIFFIES ((msecs_to_jiffies(2) > 1) ? msecs_to_jiffies(2) : 2)
400
start_transfer(struct sl811 * sl811)401 static inline void start_transfer(struct sl811 *sl811)
402 {
403 if (sl811->port1 & USB_PORT_STAT_SUSPEND)
404 return;
405 if (sl811->active_a == NULL) {
406 sl811->active_a = start(sl811, SL811_EP_A(SL811_HOST_BUF));
407 if (sl811->active_a != NULL)
408 sl811->jiffies_a = jiffies + MIN_JIFFIES;
409 }
410 #ifdef USE_B
411 if (sl811->active_b == NULL) {
412 sl811->active_b = start(sl811, SL811_EP_B(SL811_HOST_BUF));
413 if (sl811->active_b != NULL)
414 sl811->jiffies_b = jiffies + MIN_JIFFIES;
415 }
416 #endif
417 }
418
finish_request(struct sl811 * sl811,struct sl811h_ep * ep,struct urb * urb,int status)419 static void finish_request(
420 struct sl811 *sl811,
421 struct sl811h_ep *ep,
422 struct urb *urb,
423 int status
424 ) __releases(sl811->lock) __acquires(sl811->lock)
425 {
426 unsigned i;
427
428 if (usb_pipecontrol(urb->pipe))
429 ep->nextpid = USB_PID_SETUP;
430
431 usb_hcd_unlink_urb_from_ep(sl811_to_hcd(sl811), urb);
432 spin_unlock(&sl811->lock);
433 usb_hcd_giveback_urb(sl811_to_hcd(sl811), urb, status);
434 spin_lock(&sl811->lock);
435
436 /* leave active endpoints in the schedule */
437 if (!list_empty(&ep->hep->urb_list))
438 return;
439
440 /* async deschedule? */
441 if (!list_empty(&ep->schedule)) {
442 list_del_init(&ep->schedule);
443 if (ep == sl811->next_async)
444 sl811->next_async = NULL;
445 return;
446 }
447
448 /* periodic deschedule */
449 dev_dbg(sl811_to_hcd(sl811)->self.controller,
450 "deschedule qh%d/%p branch %d\n", ep->period, ep, ep->branch);
451 for (i = ep->branch; i < PERIODIC_SIZE; i += ep->period) {
452 struct sl811h_ep *temp;
453 struct sl811h_ep **prev = &sl811->periodic[i];
454
455 while (*prev && ((temp = *prev) != ep))
456 prev = &temp->next;
457 if (*prev)
458 *prev = ep->next;
459 sl811->load[i] -= ep->load;
460 }
461 ep->branch = PERIODIC_SIZE;
462 sl811->periodic_count--;
463 sl811_to_hcd(sl811)->self.bandwidth_allocated
464 -= ep->load / ep->period;
465 if (ep == sl811->next_periodic)
466 sl811->next_periodic = ep->next;
467
468 /* we might turn SOFs back on again for the async schedule */
469 if (sl811->periodic_count == 0)
470 sofirq_off(sl811);
471 }
472
473 static void
done(struct sl811 * sl811,struct sl811h_ep * ep,u8 bank)474 done(struct sl811 *sl811, struct sl811h_ep *ep, u8 bank)
475 {
476 u8 status;
477 struct urb *urb;
478 int urbstat = -EINPROGRESS;
479
480 if (unlikely(!ep))
481 return;
482
483 status = sl811_read(sl811, bank + SL11H_PKTSTATREG);
484
485 urb = container_of(ep->hep->urb_list.next, struct urb, urb_list);
486
487 /* we can safely ignore NAKs */
488 if (status & SL11H_STATMASK_NAK) {
489 // PACKET("...NAK_%02x qh%p\n", bank, ep);
490 if (!ep->period)
491 ep->nak_count++;
492 ep->error_count = 0;
493
494 /* ACK advances transfer, toggle, and maybe queue */
495 } else if (status & SL11H_STATMASK_ACK) {
496 struct usb_device *udev = urb->dev;
497 int len;
498 unsigned char *buf;
499
500 /* urb->iso_frame_desc is currently ignored here... */
501
502 ep->nak_count = ep->error_count = 0;
503 switch (ep->nextpid) {
504 case USB_PID_OUT:
505 // PACKET("...ACK/out_%02x qh%p\n", bank, ep);
506 urb->actual_length += ep->length;
507 usb_dotoggle(udev, ep->epnum, 1);
508 if (urb->actual_length
509 == urb->transfer_buffer_length) {
510 if (usb_pipecontrol(urb->pipe))
511 ep->nextpid = USB_PID_ACK;
512
513 /* some bulk protocols terminate OUT transfers
514 * by a short packet, using ZLPs not padding.
515 */
516 else if (ep->length < ep->maxpacket
517 || !(urb->transfer_flags
518 & URB_ZERO_PACKET))
519 urbstat = 0;
520 }
521 break;
522 case USB_PID_IN:
523 // PACKET("...ACK/in_%02x qh%p\n", bank, ep);
524 buf = urb->transfer_buffer + urb->actual_length;
525 prefetchw(buf);
526 len = ep->maxpacket - sl811_read(sl811,
527 bank + SL11H_XFERCNTREG);
528 if (len > ep->length) {
529 len = ep->length;
530 urbstat = -EOVERFLOW;
531 }
532 urb->actual_length += len;
533 sl811_read_buf(sl811, SL811HS_PACKET_BUF(bank == 0),
534 buf, len);
535 usb_dotoggle(udev, ep->epnum, 0);
536 if (urbstat == -EINPROGRESS &&
537 (len < ep->maxpacket ||
538 urb->actual_length ==
539 urb->transfer_buffer_length)) {
540 if (usb_pipecontrol(urb->pipe))
541 ep->nextpid = USB_PID_ACK;
542 else
543 urbstat = 0;
544 }
545 break;
546 case USB_PID_SETUP:
547 // PACKET("...ACK/setup_%02x qh%p\n", bank, ep);
548 if (urb->transfer_buffer_length == urb->actual_length)
549 ep->nextpid = USB_PID_ACK;
550 else if (usb_pipeout(urb->pipe)) {
551 usb_settoggle(udev, 0, 1, 1);
552 ep->nextpid = USB_PID_OUT;
553 } else {
554 usb_settoggle(udev, 0, 0, 1);
555 ep->nextpid = USB_PID_IN;
556 }
557 break;
558 case USB_PID_ACK:
559 // PACKET("...ACK/status_%02x qh%p\n", bank, ep);
560 urbstat = 0;
561 break;
562 }
563
564 /* STALL stops all transfers */
565 } else if (status & SL11H_STATMASK_STALL) {
566 PACKET("...STALL_%02x qh%p\n", bank, ep);
567 ep->nak_count = ep->error_count = 0;
568 urbstat = -EPIPE;
569
570 /* error? retry, until "3 strikes" */
571 } else if (++ep->error_count >= 3) {
572 if (status & SL11H_STATMASK_TMOUT)
573 urbstat = -ETIME;
574 else if (status & SL11H_STATMASK_OVF)
575 urbstat = -EOVERFLOW;
576 else
577 urbstat = -EPROTO;
578 ep->error_count = 0;
579 PACKET("...3STRIKES_%02x %02x qh%p stat %d\n",
580 bank, status, ep, urbstat);
581 }
582
583 if (urbstat != -EINPROGRESS || urb->unlinked)
584 finish_request(sl811, ep, urb, urbstat);
585 }
586
checkdone(struct sl811 * sl811)587 static inline u8 checkdone(struct sl811 *sl811)
588 {
589 u8 ctl;
590 u8 irqstat = 0;
591
592 if (sl811->active_a && time_before_eq(sl811->jiffies_a, jiffies)) {
593 ctl = sl811_read(sl811, SL811_EP_A(SL11H_HOSTCTLREG));
594 if (ctl & SL11H_HCTLMASK_ARM)
595 sl811_write(sl811, SL811_EP_A(SL11H_HOSTCTLREG), 0);
596 dev_dbg(sl811_to_hcd(sl811)->self.controller,
597 "%s DONE_A: ctrl %02x sts %02x\n",
598 (ctl & SL11H_HCTLMASK_ARM) ? "timeout" : "lost",
599 ctl,
600 sl811_read(sl811, SL811_EP_A(SL11H_PKTSTATREG)));
601 irqstat |= SL11H_INTMASK_DONE_A;
602 }
603 #ifdef USE_B
604 if (sl811->active_b && time_before_eq(sl811->jiffies_b, jiffies)) {
605 ctl = sl811_read(sl811, SL811_EP_B(SL11H_HOSTCTLREG));
606 if (ctl & SL11H_HCTLMASK_ARM)
607 sl811_write(sl811, SL811_EP_B(SL11H_HOSTCTLREG), 0);
608 dev_dbg(sl811_to_hcd(sl811)->self.controller,
609 "%s DONE_B: ctrl %02x sts %02x\n",
610 (ctl & SL11H_HCTLMASK_ARM) ? "timeout" : "lost",
611 ctl,
612 sl811_read(sl811, SL811_EP_B(SL11H_PKTSTATREG)));
613 irqstat |= SL11H_INTMASK_DONE_A;
614 }
615 #endif
616 return irqstat;
617 }
618
sl811h_irq(struct usb_hcd * hcd)619 static irqreturn_t sl811h_irq(struct usb_hcd *hcd)
620 {
621 struct sl811 *sl811 = hcd_to_sl811(hcd);
622 u8 irqstat;
623 irqreturn_t ret = IRQ_NONE;
624 unsigned retries = 5;
625
626 spin_lock(&sl811->lock);
627
628 retry:
629 irqstat = sl811_read(sl811, SL11H_IRQ_STATUS) & ~SL11H_INTMASK_DP;
630 if (irqstat) {
631 sl811_write(sl811, SL11H_IRQ_STATUS, irqstat);
632 irqstat &= sl811->irq_enable;
633 }
634
635 #ifdef QUIRK2
636 /* this may no longer be necessary ... */
637 if (irqstat == 0) {
638 irqstat = checkdone(sl811);
639 if (irqstat)
640 sl811->stat_lost++;
641 }
642 #endif
643
644 /* USB packets, not necessarily handled in the order they're
645 * issued ... that's fine if they're different endpoints.
646 */
647 if (irqstat & SL11H_INTMASK_DONE_A) {
648 done(sl811, sl811->active_a, SL811_EP_A(SL811_HOST_BUF));
649 sl811->active_a = NULL;
650 sl811->stat_a++;
651 }
652 #ifdef USE_B
653 if (irqstat & SL11H_INTMASK_DONE_B) {
654 done(sl811, sl811->active_b, SL811_EP_B(SL811_HOST_BUF));
655 sl811->active_b = NULL;
656 sl811->stat_b++;
657 }
658 #endif
659 if (irqstat & SL11H_INTMASK_SOFINTR) {
660 unsigned index;
661
662 index = sl811->frame++ % (PERIODIC_SIZE - 1);
663 sl811->stat_sof++;
664
665 /* be graceful about almost-inevitable periodic schedule
666 * overruns: continue the previous frame's transfers iff
667 * this one has nothing scheduled.
668 */
669 if (sl811->next_periodic) {
670 // dev_err(hcd->self.controller, "overrun to slot %d\n", index);
671 sl811->stat_overrun++;
672 }
673 if (sl811->periodic[index])
674 sl811->next_periodic = sl811->periodic[index];
675 }
676
677 /* hub_wq manages debouncing and wakeup */
678 if (irqstat & SL11H_INTMASK_INSRMV) {
679 sl811->stat_insrmv++;
680
681 /* most stats are reset for each VBUS session */
682 sl811->stat_wake = 0;
683 sl811->stat_sof = 0;
684 sl811->stat_a = 0;
685 sl811->stat_b = 0;
686 sl811->stat_lost = 0;
687
688 sl811->ctrl1 = 0;
689 sl811_write(sl811, SL11H_CTLREG1, sl811->ctrl1);
690
691 sl811->irq_enable = SL11H_INTMASK_INSRMV;
692 sl811_write(sl811, SL11H_IRQ_ENABLE, sl811->irq_enable);
693
694 /* usbcore nukes other pending transactions on disconnect */
695 if (sl811->active_a) {
696 sl811_write(sl811, SL811_EP_A(SL11H_HOSTCTLREG), 0);
697 finish_request(sl811, sl811->active_a,
698 container_of(sl811->active_a
699 ->hep->urb_list.next,
700 struct urb, urb_list),
701 -ESHUTDOWN);
702 sl811->active_a = NULL;
703 }
704 #ifdef USE_B
705 if (sl811->active_b) {
706 sl811_write(sl811, SL811_EP_B(SL11H_HOSTCTLREG), 0);
707 finish_request(sl811, sl811->active_b,
708 container_of(sl811->active_b
709 ->hep->urb_list.next,
710 struct urb, urb_list),
711 NULL, -ESHUTDOWN);
712 sl811->active_b = NULL;
713 }
714 #endif
715
716 /* port status seems weird until after reset, so
717 * force the reset and make hub_wq clean up later.
718 */
719 if (irqstat & SL11H_INTMASK_RD)
720 sl811->port1 &= ~USB_PORT_STAT_CONNECTION;
721 else
722 sl811->port1 |= USB_PORT_STAT_CONNECTION;
723
724 sl811->port1 |= USB_PORT_STAT_C_CONNECTION << 16;
725
726 } else if (irqstat & SL11H_INTMASK_RD) {
727 if (sl811->port1 & USB_PORT_STAT_SUSPEND) {
728 dev_dbg(hcd->self.controller, "wakeup\n");
729 sl811->port1 |= USB_PORT_STAT_C_SUSPEND << 16;
730 sl811->stat_wake++;
731 } else
732 irqstat &= ~SL11H_INTMASK_RD;
733 }
734
735 if (irqstat) {
736 if (sl811->port1 & USB_PORT_STAT_ENABLE)
737 start_transfer(sl811);
738 ret = IRQ_HANDLED;
739 if (retries--)
740 goto retry;
741 }
742
743 if (sl811->periodic_count == 0 && list_empty(&sl811->async))
744 sofirq_off(sl811);
745 sl811_write(sl811, SL11H_IRQ_ENABLE, sl811->irq_enable);
746
747 spin_unlock(&sl811->lock);
748
749 return ret;
750 }
751
752 /*-------------------------------------------------------------------------*/
753
754 /* usb 1.1 says max 90% of a frame is available for periodic transfers.
755 * this driver doesn't promise that much since it's got to handle an
756 * IRQ per packet; irq handling latencies also use up that time.
757 *
758 * NOTE: the periodic schedule is a sparse tree, with the load for
759 * each branch minimized. see fig 3.5 in the OHCI spec for example.
760 */
761 #define MAX_PERIODIC_LOAD 500 /* out of 1000 usec */
762
balance(struct sl811 * sl811,u16 period,u16 load)763 static int balance(struct sl811 *sl811, u16 period, u16 load)
764 {
765 int i, branch = -ENOSPC;
766
767 /* search for the least loaded schedule branch of that period
768 * which has enough bandwidth left unreserved.
769 */
770 for (i = 0; i < period ; i++) {
771 if (branch < 0 || sl811->load[branch] > sl811->load[i]) {
772 int j;
773
774 for (j = i; j < PERIODIC_SIZE; j += period) {
775 if ((sl811->load[j] + load)
776 > MAX_PERIODIC_LOAD)
777 break;
778 }
779 if (j < PERIODIC_SIZE)
780 continue;
781 branch = i;
782 }
783 }
784 return branch;
785 }
786
787 /*-------------------------------------------------------------------------*/
788
sl811h_urb_enqueue(struct usb_hcd * hcd,struct urb * urb,gfp_t mem_flags)789 static int sl811h_urb_enqueue(
790 struct usb_hcd *hcd,
791 struct urb *urb,
792 gfp_t mem_flags
793 ) {
794 struct sl811 *sl811 = hcd_to_sl811(hcd);
795 struct usb_device *udev = urb->dev;
796 unsigned int pipe = urb->pipe;
797 int is_out = !usb_pipein(pipe);
798 int type = usb_pipetype(pipe);
799 int epnum = usb_pipeendpoint(pipe);
800 struct sl811h_ep *ep = NULL;
801 unsigned long flags;
802 int i;
803 int retval;
804 struct usb_host_endpoint *hep = urb->ep;
805
806 #ifndef CONFIG_USB_SL811_HCD_ISO
807 if (type == PIPE_ISOCHRONOUS)
808 return -ENOSPC;
809 #endif
810
811 /* avoid all allocations within spinlocks */
812 if (!hep->hcpriv) {
813 ep = kzalloc(sizeof *ep, mem_flags);
814 if (ep == NULL)
815 return -ENOMEM;
816 }
817
818 spin_lock_irqsave(&sl811->lock, flags);
819
820 /* don't submit to a dead or disabled port */
821 if (!(sl811->port1 & USB_PORT_STAT_ENABLE)
822 || !HC_IS_RUNNING(hcd->state)) {
823 retval = -ENODEV;
824 kfree(ep);
825 goto fail_not_linked;
826 }
827 retval = usb_hcd_link_urb_to_ep(hcd, urb);
828 if (retval) {
829 kfree(ep);
830 goto fail_not_linked;
831 }
832
833 if (hep->hcpriv) {
834 kfree(ep);
835 ep = hep->hcpriv;
836 } else if (!ep) {
837 retval = -ENOMEM;
838 goto fail;
839
840 } else {
841 INIT_LIST_HEAD(&ep->schedule);
842 ep->udev = udev;
843 ep->epnum = epnum;
844 ep->maxpacket = usb_maxpacket(udev, urb->pipe, is_out);
845 ep->defctrl = SL11H_HCTLMASK_ARM | SL11H_HCTLMASK_ENABLE;
846 usb_settoggle(udev, epnum, is_out, 0);
847
848 if (type == PIPE_CONTROL)
849 ep->nextpid = USB_PID_SETUP;
850 else if (is_out)
851 ep->nextpid = USB_PID_OUT;
852 else
853 ep->nextpid = USB_PID_IN;
854
855 if (ep->maxpacket > H_MAXPACKET) {
856 /* iso packets up to 240 bytes could work... */
857 dev_dbg(hcd->self.controller,
858 "dev %d ep%d maxpacket %d\n", udev->devnum,
859 epnum, ep->maxpacket);
860 retval = -EINVAL;
861 kfree(ep);
862 goto fail;
863 }
864
865 if (udev->speed == USB_SPEED_LOW) {
866 /* send preamble for external hub? */
867 if (!(sl811->ctrl1 & SL11H_CTL1MASK_LSPD))
868 ep->defctrl |= SL11H_HCTLMASK_PREAMBLE;
869 }
870 switch (type) {
871 case PIPE_ISOCHRONOUS:
872 case PIPE_INTERRUPT:
873 if (urb->interval > PERIODIC_SIZE)
874 urb->interval = PERIODIC_SIZE;
875 ep->period = urb->interval;
876 ep->branch = PERIODIC_SIZE;
877 if (type == PIPE_ISOCHRONOUS)
878 ep->defctrl |= SL11H_HCTLMASK_ISOCH;
879 ep->load = usb_calc_bus_time(udev->speed, !is_out,
880 (type == PIPE_ISOCHRONOUS),
881 usb_maxpacket(udev, pipe, is_out))
882 / 1000;
883 break;
884 }
885
886 ep->hep = hep;
887 hep->hcpriv = ep;
888 }
889
890 /* maybe put endpoint into schedule */
891 switch (type) {
892 case PIPE_CONTROL:
893 case PIPE_BULK:
894 if (list_empty(&ep->schedule))
895 list_add_tail(&ep->schedule, &sl811->async);
896 break;
897 case PIPE_ISOCHRONOUS:
898 case PIPE_INTERRUPT:
899 urb->interval = ep->period;
900 if (ep->branch < PERIODIC_SIZE) {
901 /* NOTE: the phase is correct here, but the value
902 * needs offsetting by the transfer queue depth.
903 * All current drivers ignore start_frame, so this
904 * is unlikely to ever matter...
905 */
906 urb->start_frame = (sl811->frame & (PERIODIC_SIZE - 1))
907 + ep->branch;
908 break;
909 }
910
911 retval = balance(sl811, ep->period, ep->load);
912 if (retval < 0)
913 goto fail;
914 ep->branch = retval;
915 retval = 0;
916 urb->start_frame = (sl811->frame & (PERIODIC_SIZE - 1))
917 + ep->branch;
918
919 /* sort each schedule branch by period (slow before fast)
920 * to share the faster parts of the tree without needing
921 * dummy/placeholder nodes
922 */
923 dev_dbg(hcd->self.controller, "schedule qh%d/%p branch %d\n",
924 ep->period, ep, ep->branch);
925 for (i = ep->branch; i < PERIODIC_SIZE; i += ep->period) {
926 struct sl811h_ep **prev = &sl811->periodic[i];
927 struct sl811h_ep *here = *prev;
928
929 while (here && ep != here) {
930 if (ep->period > here->period)
931 break;
932 prev = &here->next;
933 here = *prev;
934 }
935 if (ep != here) {
936 ep->next = here;
937 *prev = ep;
938 }
939 sl811->load[i] += ep->load;
940 }
941 sl811->periodic_count++;
942 hcd->self.bandwidth_allocated += ep->load / ep->period;
943 sofirq_on(sl811);
944 }
945
946 urb->hcpriv = hep;
947 start_transfer(sl811);
948 sl811_write(sl811, SL11H_IRQ_ENABLE, sl811->irq_enable);
949 fail:
950 if (retval)
951 usb_hcd_unlink_urb_from_ep(hcd, urb);
952 fail_not_linked:
953 spin_unlock_irqrestore(&sl811->lock, flags);
954 return retval;
955 }
956
sl811h_urb_dequeue(struct usb_hcd * hcd,struct urb * urb,int status)957 static int sl811h_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
958 {
959 struct sl811 *sl811 = hcd_to_sl811(hcd);
960 struct usb_host_endpoint *hep;
961 unsigned long flags;
962 struct sl811h_ep *ep;
963 int retval;
964
965 spin_lock_irqsave(&sl811->lock, flags);
966 retval = usb_hcd_check_unlink_urb(hcd, urb, status);
967 if (retval)
968 goto fail;
969
970 hep = urb->hcpriv;
971 ep = hep->hcpriv;
972 if (ep) {
973 /* finish right away if this urb can't be active ...
974 * note that some drivers wrongly expect delays
975 */
976 if (ep->hep->urb_list.next != &urb->urb_list) {
977 /* not front of queue? never active */
978
979 /* for active transfers, we expect an IRQ */
980 } else if (sl811->active_a == ep) {
981 if (time_before_eq(sl811->jiffies_a, jiffies)) {
982 /* happens a lot with lowspeed?? */
983 dev_dbg(hcd->self.controller,
984 "giveup on DONE_A: ctrl %02x sts %02x\n",
985 sl811_read(sl811,
986 SL811_EP_A(SL11H_HOSTCTLREG)),
987 sl811_read(sl811,
988 SL811_EP_A(SL11H_PKTSTATREG)));
989 sl811_write(sl811, SL811_EP_A(SL11H_HOSTCTLREG),
990 0);
991 sl811->active_a = NULL;
992 } else
993 urb = NULL;
994 #ifdef USE_B
995 } else if (sl811->active_b == ep) {
996 if (time_before_eq(sl811->jiffies_a, jiffies)) {
997 /* happens a lot with lowspeed?? */
998 dev_dbg(hcd->self.controller,
999 "giveup on DONE_B: ctrl %02x sts %02x\n",
1000 sl811_read(sl811,
1001 SL811_EP_B(SL11H_HOSTCTLREG)),
1002 sl811_read(sl811,
1003 SL811_EP_B(SL11H_PKTSTATREG)));
1004 sl811_write(sl811, SL811_EP_B(SL11H_HOSTCTLREG),
1005 0);
1006 sl811->active_b = NULL;
1007 } else
1008 urb = NULL;
1009 #endif
1010 } else {
1011 /* front of queue for inactive endpoint */
1012 }
1013
1014 if (urb)
1015 finish_request(sl811, ep, urb, 0);
1016 else
1017 dev_dbg(sl811_to_hcd(sl811)->self.controller,
1018 "dequeue, urb %p active %s; wait4irq\n", urb,
1019 (sl811->active_a == ep) ? "A" : "B");
1020 } else
1021 retval = -EINVAL;
1022 fail:
1023 spin_unlock_irqrestore(&sl811->lock, flags);
1024 return retval;
1025 }
1026
1027 static void
sl811h_endpoint_disable(struct usb_hcd * hcd,struct usb_host_endpoint * hep)1028 sl811h_endpoint_disable(struct usb_hcd *hcd, struct usb_host_endpoint *hep)
1029 {
1030 struct sl811h_ep *ep = hep->hcpriv;
1031
1032 if (!ep)
1033 return;
1034
1035 /* assume we'd just wait for the irq */
1036 if (!list_empty(&hep->urb_list))
1037 msleep(3);
1038 if (!list_empty(&hep->urb_list))
1039 dev_warn(hcd->self.controller, "ep %p not empty?\n", ep);
1040
1041 kfree(ep);
1042 hep->hcpriv = NULL;
1043 }
1044
1045 static int
sl811h_get_frame(struct usb_hcd * hcd)1046 sl811h_get_frame(struct usb_hcd *hcd)
1047 {
1048 struct sl811 *sl811 = hcd_to_sl811(hcd);
1049
1050 /* wrong except while periodic transfers are scheduled;
1051 * never matches the on-the-wire frame;
1052 * subject to overruns.
1053 */
1054 return sl811->frame;
1055 }
1056
1057
1058 /*-------------------------------------------------------------------------*/
1059
1060 /* the virtual root hub timer IRQ checks for hub status */
1061 static int
sl811h_hub_status_data(struct usb_hcd * hcd,char * buf)1062 sl811h_hub_status_data(struct usb_hcd *hcd, char *buf)
1063 {
1064 struct sl811 *sl811 = hcd_to_sl811(hcd);
1065 #ifdef QUIRK3
1066 unsigned long flags;
1067
1068 /* non-SMP HACK: use root hub timer as i/o watchdog
1069 * this seems essential when SOF IRQs aren't in use...
1070 */
1071 local_irq_save(flags);
1072 if (!timer_pending(&sl811->timer)) {
1073 if (sl811h_irq( /* ~0, */ hcd) != IRQ_NONE)
1074 sl811->stat_lost++;
1075 }
1076 local_irq_restore(flags);
1077 #endif
1078
1079 if (!(sl811->port1 & (0xffff << 16)))
1080 return 0;
1081
1082 /* tell hub_wq port 1 changed */
1083 *buf = (1 << 1);
1084 return 1;
1085 }
1086
1087 static void
sl811h_hub_descriptor(struct sl811 * sl811,struct usb_hub_descriptor * desc)1088 sl811h_hub_descriptor (
1089 struct sl811 *sl811,
1090 struct usb_hub_descriptor *desc
1091 ) {
1092 u16 temp = 0;
1093
1094 desc->bDescriptorType = USB_DT_HUB;
1095 desc->bHubContrCurrent = 0;
1096
1097 desc->bNbrPorts = 1;
1098 desc->bDescLength = 9;
1099
1100 /* per-port power switching (gang of one!), or none */
1101 desc->bPwrOn2PwrGood = 0;
1102 if (sl811->board && sl811->board->port_power) {
1103 desc->bPwrOn2PwrGood = sl811->board->potpg;
1104 if (!desc->bPwrOn2PwrGood)
1105 desc->bPwrOn2PwrGood = 10;
1106 temp = HUB_CHAR_INDV_PORT_LPSM;
1107 } else
1108 temp = HUB_CHAR_NO_LPSM;
1109
1110 /* no overcurrent errors detection/handling */
1111 temp |= HUB_CHAR_NO_OCPM;
1112
1113 desc->wHubCharacteristics = cpu_to_le16(temp);
1114
1115 /* ports removable, and legacy PortPwrCtrlMask */
1116 desc->u.hs.DeviceRemovable[0] = 0 << 1;
1117 desc->u.hs.DeviceRemovable[1] = ~0;
1118 }
1119
1120 static void
sl811h_timer(unsigned long _sl811)1121 sl811h_timer(unsigned long _sl811)
1122 {
1123 struct sl811 *sl811 = (void *) _sl811;
1124 unsigned long flags;
1125 u8 irqstat;
1126 u8 signaling = sl811->ctrl1 & SL11H_CTL1MASK_FORCE;
1127 const u32 mask = USB_PORT_STAT_CONNECTION
1128 | USB_PORT_STAT_ENABLE
1129 | USB_PORT_STAT_LOW_SPEED;
1130
1131 spin_lock_irqsave(&sl811->lock, flags);
1132
1133 /* stop special signaling */
1134 sl811->ctrl1 &= ~SL11H_CTL1MASK_FORCE;
1135 sl811_write(sl811, SL11H_CTLREG1, sl811->ctrl1);
1136 udelay(3);
1137
1138 irqstat = sl811_read(sl811, SL11H_IRQ_STATUS);
1139
1140 switch (signaling) {
1141 case SL11H_CTL1MASK_SE0:
1142 dev_dbg(sl811_to_hcd(sl811)->self.controller, "end reset\n");
1143 sl811->port1 = (USB_PORT_STAT_C_RESET << 16)
1144 | USB_PORT_STAT_POWER;
1145 sl811->ctrl1 = 0;
1146 /* don't wrongly ack RD */
1147 if (irqstat & SL11H_INTMASK_INSRMV)
1148 irqstat &= ~SL11H_INTMASK_RD;
1149 break;
1150 case SL11H_CTL1MASK_K:
1151 dev_dbg(sl811_to_hcd(sl811)->self.controller, "end resume\n");
1152 sl811->port1 &= ~USB_PORT_STAT_SUSPEND;
1153 break;
1154 default:
1155 dev_dbg(sl811_to_hcd(sl811)->self.controller,
1156 "odd timer signaling: %02x\n", signaling);
1157 break;
1158 }
1159 sl811_write(sl811, SL11H_IRQ_STATUS, irqstat);
1160
1161 if (irqstat & SL11H_INTMASK_RD) {
1162 /* usbcore nukes all pending transactions on disconnect */
1163 if (sl811->port1 & USB_PORT_STAT_CONNECTION)
1164 sl811->port1 |= (USB_PORT_STAT_C_CONNECTION << 16)
1165 | (USB_PORT_STAT_C_ENABLE << 16);
1166 sl811->port1 &= ~mask;
1167 sl811->irq_enable = SL11H_INTMASK_INSRMV;
1168 } else {
1169 sl811->port1 |= mask;
1170 if (irqstat & SL11H_INTMASK_DP)
1171 sl811->port1 &= ~USB_PORT_STAT_LOW_SPEED;
1172 sl811->irq_enable = SL11H_INTMASK_INSRMV | SL11H_INTMASK_RD;
1173 }
1174
1175 if (sl811->port1 & USB_PORT_STAT_CONNECTION) {
1176 u8 ctrl2 = SL811HS_CTL2_INIT;
1177
1178 sl811->irq_enable |= SL11H_INTMASK_DONE_A;
1179 #ifdef USE_B
1180 sl811->irq_enable |= SL11H_INTMASK_DONE_B;
1181 #endif
1182 if (sl811->port1 & USB_PORT_STAT_LOW_SPEED) {
1183 sl811->ctrl1 |= SL11H_CTL1MASK_LSPD;
1184 ctrl2 |= SL811HS_CTL2MASK_DSWAP;
1185 }
1186
1187 /* start SOFs flowing, kickstarting with A registers */
1188 sl811->ctrl1 |= SL11H_CTL1MASK_SOF_ENA;
1189 sl811_write(sl811, SL11H_SOFLOWREG, 0xe0);
1190 sl811_write(sl811, SL811HS_CTLREG2, ctrl2);
1191
1192 /* autoincrementing */
1193 sl811_write(sl811, SL811_EP_A(SL11H_BUFLNTHREG), 0);
1194 writeb(SL_SOF, sl811->data_reg);
1195 writeb(0, sl811->data_reg);
1196 sl811_write(sl811, SL811_EP_A(SL11H_HOSTCTLREG),
1197 SL11H_HCTLMASK_ARM);
1198
1199 /* hub_wq provides debounce delay */
1200 } else {
1201 sl811->ctrl1 = 0;
1202 }
1203 sl811_write(sl811, SL11H_CTLREG1, sl811->ctrl1);
1204
1205 /* reenable irqs */
1206 sl811_write(sl811, SL11H_IRQ_ENABLE, sl811->irq_enable);
1207 spin_unlock_irqrestore(&sl811->lock, flags);
1208 }
1209
1210 static int
sl811h_hub_control(struct usb_hcd * hcd,u16 typeReq,u16 wValue,u16 wIndex,char * buf,u16 wLength)1211 sl811h_hub_control(
1212 struct usb_hcd *hcd,
1213 u16 typeReq,
1214 u16 wValue,
1215 u16 wIndex,
1216 char *buf,
1217 u16 wLength
1218 ) {
1219 struct sl811 *sl811 = hcd_to_sl811(hcd);
1220 int retval = 0;
1221 unsigned long flags;
1222
1223 spin_lock_irqsave(&sl811->lock, flags);
1224
1225 switch (typeReq) {
1226 case ClearHubFeature:
1227 case SetHubFeature:
1228 switch (wValue) {
1229 case C_HUB_OVER_CURRENT:
1230 case C_HUB_LOCAL_POWER:
1231 break;
1232 default:
1233 goto error;
1234 }
1235 break;
1236 case ClearPortFeature:
1237 if (wIndex != 1 || wLength != 0)
1238 goto error;
1239
1240 switch (wValue) {
1241 case USB_PORT_FEAT_ENABLE:
1242 sl811->port1 &= USB_PORT_STAT_POWER;
1243 sl811->ctrl1 = 0;
1244 sl811_write(sl811, SL11H_CTLREG1, sl811->ctrl1);
1245 sl811->irq_enable = SL11H_INTMASK_INSRMV;
1246 sl811_write(sl811, SL11H_IRQ_ENABLE,
1247 sl811->irq_enable);
1248 break;
1249 case USB_PORT_FEAT_SUSPEND:
1250 if (!(sl811->port1 & USB_PORT_STAT_SUSPEND))
1251 break;
1252
1253 /* 20 msec of resume/K signaling, other irqs blocked */
1254 dev_dbg(hcd->self.controller, "start resume...\n");
1255 sl811->irq_enable = 0;
1256 sl811_write(sl811, SL11H_IRQ_ENABLE,
1257 sl811->irq_enable);
1258 sl811->ctrl1 |= SL11H_CTL1MASK_K;
1259 sl811_write(sl811, SL11H_CTLREG1, sl811->ctrl1);
1260
1261 mod_timer(&sl811->timer, jiffies
1262 + msecs_to_jiffies(USB_RESUME_TIMEOUT));
1263 break;
1264 case USB_PORT_FEAT_POWER:
1265 port_power(sl811, 0);
1266 break;
1267 case USB_PORT_FEAT_C_ENABLE:
1268 case USB_PORT_FEAT_C_SUSPEND:
1269 case USB_PORT_FEAT_C_CONNECTION:
1270 case USB_PORT_FEAT_C_OVER_CURRENT:
1271 case USB_PORT_FEAT_C_RESET:
1272 break;
1273 default:
1274 goto error;
1275 }
1276 sl811->port1 &= ~(1 << wValue);
1277 break;
1278 case GetHubDescriptor:
1279 sl811h_hub_descriptor(sl811, (struct usb_hub_descriptor *) buf);
1280 break;
1281 case GetHubStatus:
1282 put_unaligned_le32(0, buf);
1283 break;
1284 case GetPortStatus:
1285 if (wIndex != 1)
1286 goto error;
1287 put_unaligned_le32(sl811->port1, buf);
1288
1289 if (__is_defined(VERBOSE) ||
1290 *(u16*)(buf+2)) /* only if wPortChange is interesting */
1291 dev_dbg(hcd->self.controller, "GetPortStatus %08x\n",
1292 sl811->port1);
1293 break;
1294 case SetPortFeature:
1295 if (wIndex != 1 || wLength != 0)
1296 goto error;
1297 switch (wValue) {
1298 case USB_PORT_FEAT_SUSPEND:
1299 if (sl811->port1 & USB_PORT_STAT_RESET)
1300 goto error;
1301 if (!(sl811->port1 & USB_PORT_STAT_ENABLE))
1302 goto error;
1303
1304 dev_dbg(hcd->self.controller,"suspend...\n");
1305 sl811->ctrl1 &= ~SL11H_CTL1MASK_SOF_ENA;
1306 sl811_write(sl811, SL11H_CTLREG1, sl811->ctrl1);
1307 break;
1308 case USB_PORT_FEAT_POWER:
1309 port_power(sl811, 1);
1310 break;
1311 case USB_PORT_FEAT_RESET:
1312 if (sl811->port1 & USB_PORT_STAT_SUSPEND)
1313 goto error;
1314 if (!(sl811->port1 & USB_PORT_STAT_POWER))
1315 break;
1316
1317 /* 50 msec of reset/SE0 signaling, irqs blocked */
1318 sl811->irq_enable = 0;
1319 sl811_write(sl811, SL11H_IRQ_ENABLE,
1320 sl811->irq_enable);
1321 sl811->ctrl1 = SL11H_CTL1MASK_SE0;
1322 sl811_write(sl811, SL11H_CTLREG1, sl811->ctrl1);
1323 sl811->port1 |= USB_PORT_STAT_RESET;
1324 mod_timer(&sl811->timer, jiffies
1325 + msecs_to_jiffies(50));
1326 break;
1327 default:
1328 goto error;
1329 }
1330 sl811->port1 |= 1 << wValue;
1331 break;
1332
1333 default:
1334 error:
1335 /* "protocol stall" on error */
1336 retval = -EPIPE;
1337 }
1338
1339 spin_unlock_irqrestore(&sl811->lock, flags);
1340 return retval;
1341 }
1342
1343 #ifdef CONFIG_PM
1344
1345 static int
sl811h_bus_suspend(struct usb_hcd * hcd)1346 sl811h_bus_suspend(struct usb_hcd *hcd)
1347 {
1348 // SOFs off
1349 dev_dbg(hcd->self.controller, "%s\n", __func__);
1350 return 0;
1351 }
1352
1353 static int
sl811h_bus_resume(struct usb_hcd * hcd)1354 sl811h_bus_resume(struct usb_hcd *hcd)
1355 {
1356 // SOFs on
1357 dev_dbg(hcd->self.controller, "%s\n", __func__);
1358 return 0;
1359 }
1360
1361 #else
1362
1363 #define sl811h_bus_suspend NULL
1364 #define sl811h_bus_resume NULL
1365
1366 #endif
1367
1368
1369 /*-------------------------------------------------------------------------*/
1370
dump_irq(struct seq_file * s,char * label,u8 mask)1371 static void dump_irq(struct seq_file *s, char *label, u8 mask)
1372 {
1373 seq_printf(s, "%s %02x%s%s%s%s%s%s\n", label, mask,
1374 (mask & SL11H_INTMASK_DONE_A) ? " done_a" : "",
1375 (mask & SL11H_INTMASK_DONE_B) ? " done_b" : "",
1376 (mask & SL11H_INTMASK_SOFINTR) ? " sof" : "",
1377 (mask & SL11H_INTMASK_INSRMV) ? " ins/rmv" : "",
1378 (mask & SL11H_INTMASK_RD) ? " rd" : "",
1379 (mask & SL11H_INTMASK_DP) ? " dp" : "");
1380 }
1381
sl811h_show(struct seq_file * s,void * unused)1382 static int sl811h_show(struct seq_file *s, void *unused)
1383 {
1384 struct sl811 *sl811 = s->private;
1385 struct sl811h_ep *ep;
1386 unsigned i;
1387
1388 seq_printf(s, "%s\n%s version %s\nportstatus[1] = %08x\n",
1389 sl811_to_hcd(sl811)->product_desc,
1390 hcd_name, DRIVER_VERSION,
1391 sl811->port1);
1392
1393 seq_printf(s, "insert/remove: %ld\n", sl811->stat_insrmv);
1394 seq_printf(s, "current session: done_a %ld done_b %ld "
1395 "wake %ld sof %ld overrun %ld lost %ld\n\n",
1396 sl811->stat_a, sl811->stat_b,
1397 sl811->stat_wake, sl811->stat_sof,
1398 sl811->stat_overrun, sl811->stat_lost);
1399
1400 spin_lock_irq(&sl811->lock);
1401
1402 if (sl811->ctrl1 & SL11H_CTL1MASK_SUSPEND)
1403 seq_printf(s, "(suspended)\n\n");
1404 else {
1405 u8 t = sl811_read(sl811, SL11H_CTLREG1);
1406
1407 seq_printf(s, "ctrl1 %02x%s%s%s%s\n", t,
1408 (t & SL11H_CTL1MASK_SOF_ENA) ? " sofgen" : "",
1409 ({char *s; switch (t & SL11H_CTL1MASK_FORCE) {
1410 case SL11H_CTL1MASK_NORMAL: s = ""; break;
1411 case SL11H_CTL1MASK_SE0: s = " se0/reset"; break;
1412 case SL11H_CTL1MASK_K: s = " k/resume"; break;
1413 default: s = "j"; break;
1414 } s; }),
1415 (t & SL11H_CTL1MASK_LSPD) ? " lowspeed" : "",
1416 (t & SL11H_CTL1MASK_SUSPEND) ? " suspend" : "");
1417
1418 dump_irq(s, "irq_enable",
1419 sl811_read(sl811, SL11H_IRQ_ENABLE));
1420 dump_irq(s, "irq_status",
1421 sl811_read(sl811, SL11H_IRQ_STATUS));
1422 seq_printf(s, "frame clocks remaining: %d\n",
1423 sl811_read(sl811, SL11H_SOFTMRREG) << 6);
1424 }
1425
1426 seq_printf(s, "A: qh%p ctl %02x sts %02x\n", sl811->active_a,
1427 sl811_read(sl811, SL811_EP_A(SL11H_HOSTCTLREG)),
1428 sl811_read(sl811, SL811_EP_A(SL11H_PKTSTATREG)));
1429 seq_printf(s, "B: qh%p ctl %02x sts %02x\n", sl811->active_b,
1430 sl811_read(sl811, SL811_EP_B(SL11H_HOSTCTLREG)),
1431 sl811_read(sl811, SL811_EP_B(SL11H_PKTSTATREG)));
1432 seq_printf(s, "\n");
1433 list_for_each_entry (ep, &sl811->async, schedule) {
1434 struct urb *urb;
1435
1436 seq_printf(s, "%s%sqh%p, ep%d%s, maxpacket %d"
1437 " nak %d err %d\n",
1438 (ep == sl811->active_a) ? "(A) " : "",
1439 (ep == sl811->active_b) ? "(B) " : "",
1440 ep, ep->epnum,
1441 ({ char *s; switch (ep->nextpid) {
1442 case USB_PID_IN: s = "in"; break;
1443 case USB_PID_OUT: s = "out"; break;
1444 case USB_PID_SETUP: s = "setup"; break;
1445 case USB_PID_ACK: s = "status"; break;
1446 default: s = "?"; break;
1447 } s;}),
1448 ep->maxpacket,
1449 ep->nak_count, ep->error_count);
1450 list_for_each_entry (urb, &ep->hep->urb_list, urb_list) {
1451 seq_printf(s, " urb%p, %d/%d\n", urb,
1452 urb->actual_length,
1453 urb->transfer_buffer_length);
1454 }
1455 }
1456 if (!list_empty(&sl811->async))
1457 seq_printf(s, "\n");
1458
1459 seq_printf(s, "periodic size= %d\n", PERIODIC_SIZE);
1460
1461 for (i = 0; i < PERIODIC_SIZE; i++) {
1462 ep = sl811->periodic[i];
1463 if (!ep)
1464 continue;
1465 seq_printf(s, "%2d [%3d]:\n", i, sl811->load[i]);
1466
1467 /* DUMB: prints shared entries multiple times */
1468 do {
1469 seq_printf(s,
1470 " %s%sqh%d/%p (%sdev%d ep%d%s max %d) "
1471 "err %d\n",
1472 (ep == sl811->active_a) ? "(A) " : "",
1473 (ep == sl811->active_b) ? "(B) " : "",
1474 ep->period, ep,
1475 (ep->udev->speed == USB_SPEED_FULL)
1476 ? "" : "ls ",
1477 ep->udev->devnum, ep->epnum,
1478 (ep->epnum == 0) ? ""
1479 : ((ep->nextpid == USB_PID_IN)
1480 ? "in"
1481 : "out"),
1482 ep->maxpacket, ep->error_count);
1483 ep = ep->next;
1484 } while (ep);
1485 }
1486
1487 spin_unlock_irq(&sl811->lock);
1488 seq_printf(s, "\n");
1489
1490 return 0;
1491 }
1492
sl811h_open(struct inode * inode,struct file * file)1493 static int sl811h_open(struct inode *inode, struct file *file)
1494 {
1495 return single_open(file, sl811h_show, inode->i_private);
1496 }
1497
1498 static const struct file_operations debug_ops = {
1499 .open = sl811h_open,
1500 .read = seq_read,
1501 .llseek = seq_lseek,
1502 .release = single_release,
1503 };
1504
1505 /* expect just one sl811 per system */
create_debug_file(struct sl811 * sl811)1506 static void create_debug_file(struct sl811 *sl811)
1507 {
1508 sl811->debug_file = debugfs_create_file("sl811h", S_IRUGO,
1509 usb_debug_root, sl811,
1510 &debug_ops);
1511 }
1512
remove_debug_file(struct sl811 * sl811)1513 static void remove_debug_file(struct sl811 *sl811)
1514 {
1515 debugfs_remove(sl811->debug_file);
1516 }
1517
1518 /*-------------------------------------------------------------------------*/
1519
1520 static void
sl811h_stop(struct usb_hcd * hcd)1521 sl811h_stop(struct usb_hcd *hcd)
1522 {
1523 struct sl811 *sl811 = hcd_to_sl811(hcd);
1524 unsigned long flags;
1525
1526 del_timer_sync(&hcd->rh_timer);
1527
1528 spin_lock_irqsave(&sl811->lock, flags);
1529 port_power(sl811, 0);
1530 spin_unlock_irqrestore(&sl811->lock, flags);
1531 }
1532
1533 static int
sl811h_start(struct usb_hcd * hcd)1534 sl811h_start(struct usb_hcd *hcd)
1535 {
1536 struct sl811 *sl811 = hcd_to_sl811(hcd);
1537
1538 /* chip has been reset, VBUS power is off */
1539 hcd->state = HC_STATE_RUNNING;
1540
1541 if (sl811->board) {
1542 if (!device_can_wakeup(hcd->self.controller))
1543 device_init_wakeup(hcd->self.controller,
1544 sl811->board->can_wakeup);
1545 hcd->power_budget = sl811->board->power * 2;
1546 }
1547
1548 /* enable power and interrupts */
1549 port_power(sl811, 1);
1550
1551 return 0;
1552 }
1553
1554 /*-------------------------------------------------------------------------*/
1555
1556 static struct hc_driver sl811h_hc_driver = {
1557 .description = hcd_name,
1558 .hcd_priv_size = sizeof(struct sl811),
1559
1560 /*
1561 * generic hardware linkage
1562 */
1563 .irq = sl811h_irq,
1564 .flags = HCD_USB11 | HCD_MEMORY,
1565
1566 /* Basic lifecycle operations */
1567 .start = sl811h_start,
1568 .stop = sl811h_stop,
1569
1570 /*
1571 * managing i/o requests and associated device resources
1572 */
1573 .urb_enqueue = sl811h_urb_enqueue,
1574 .urb_dequeue = sl811h_urb_dequeue,
1575 .endpoint_disable = sl811h_endpoint_disable,
1576
1577 /*
1578 * periodic schedule support
1579 */
1580 .get_frame_number = sl811h_get_frame,
1581
1582 /*
1583 * root hub support
1584 */
1585 .hub_status_data = sl811h_hub_status_data,
1586 .hub_control = sl811h_hub_control,
1587 .bus_suspend = sl811h_bus_suspend,
1588 .bus_resume = sl811h_bus_resume,
1589 };
1590
1591 /*-------------------------------------------------------------------------*/
1592
1593 static int
sl811h_remove(struct platform_device * dev)1594 sl811h_remove(struct platform_device *dev)
1595 {
1596 struct usb_hcd *hcd = platform_get_drvdata(dev);
1597 struct sl811 *sl811 = hcd_to_sl811(hcd);
1598 struct resource *res;
1599
1600 remove_debug_file(sl811);
1601 usb_remove_hcd(hcd);
1602
1603 /* some platforms may use IORESOURCE_IO */
1604 res = platform_get_resource(dev, IORESOURCE_MEM, 1);
1605 if (res)
1606 iounmap(sl811->data_reg);
1607
1608 res = platform_get_resource(dev, IORESOURCE_MEM, 0);
1609 if (res)
1610 iounmap(sl811->addr_reg);
1611
1612 usb_put_hcd(hcd);
1613 return 0;
1614 }
1615
1616 static int
sl811h_probe(struct platform_device * dev)1617 sl811h_probe(struct platform_device *dev)
1618 {
1619 struct usb_hcd *hcd;
1620 struct sl811 *sl811;
1621 struct resource *addr, *data, *ires;
1622 int irq;
1623 void __iomem *addr_reg;
1624 void __iomem *data_reg;
1625 int retval;
1626 u8 tmp, ioaddr = 0;
1627 unsigned long irqflags;
1628
1629 if (usb_disabled())
1630 return -ENODEV;
1631
1632 /* basic sanity checks first. board-specific init logic should
1633 * have initialized these three resources and probably board
1634 * specific platform_data. we don't probe for IRQs, and do only
1635 * minimal sanity checking.
1636 */
1637 ires = platform_get_resource(dev, IORESOURCE_IRQ, 0);
1638 if (dev->num_resources < 3 || !ires)
1639 return -ENODEV;
1640
1641 irq = ires->start;
1642 irqflags = ires->flags & IRQF_TRIGGER_MASK;
1643
1644 /* refuse to confuse usbcore */
1645 if (dev->dev.dma_mask) {
1646 dev_dbg(&dev->dev, "no we won't dma\n");
1647 return -EINVAL;
1648 }
1649
1650 /* the chip may be wired for either kind of addressing */
1651 addr = platform_get_resource(dev, IORESOURCE_MEM, 0);
1652 data = platform_get_resource(dev, IORESOURCE_MEM, 1);
1653 retval = -EBUSY;
1654 if (!addr || !data) {
1655 addr = platform_get_resource(dev, IORESOURCE_IO, 0);
1656 data = platform_get_resource(dev, IORESOURCE_IO, 1);
1657 if (!addr || !data)
1658 return -ENODEV;
1659 ioaddr = 1;
1660 /*
1661 * NOTE: 64-bit resource->start is getting truncated
1662 * to avoid compiler warning, assuming that ->start
1663 * is always 32-bit for this case
1664 */
1665 addr_reg = (void __iomem *) (unsigned long) addr->start;
1666 data_reg = (void __iomem *) (unsigned long) data->start;
1667 } else {
1668 addr_reg = ioremap(addr->start, 1);
1669 if (addr_reg == NULL) {
1670 retval = -ENOMEM;
1671 goto err2;
1672 }
1673
1674 data_reg = ioremap(data->start, 1);
1675 if (data_reg == NULL) {
1676 retval = -ENOMEM;
1677 goto err4;
1678 }
1679 }
1680
1681 /* allocate and initialize hcd */
1682 hcd = usb_create_hcd(&sl811h_hc_driver, &dev->dev, dev_name(&dev->dev));
1683 if (!hcd) {
1684 retval = -ENOMEM;
1685 goto err5;
1686 }
1687 hcd->rsrc_start = addr->start;
1688 sl811 = hcd_to_sl811(hcd);
1689
1690 spin_lock_init(&sl811->lock);
1691 INIT_LIST_HEAD(&sl811->async);
1692 sl811->board = dev_get_platdata(&dev->dev);
1693 setup_timer(&sl811->timer, sl811h_timer, (unsigned long)sl811);
1694 sl811->addr_reg = addr_reg;
1695 sl811->data_reg = data_reg;
1696
1697 spin_lock_irq(&sl811->lock);
1698 port_power(sl811, 0);
1699 spin_unlock_irq(&sl811->lock);
1700 msleep(200);
1701
1702 tmp = sl811_read(sl811, SL11H_HWREVREG);
1703 switch (tmp >> 4) {
1704 case 1:
1705 hcd->product_desc = "SL811HS v1.2";
1706 break;
1707 case 2:
1708 hcd->product_desc = "SL811HS v1.5";
1709 break;
1710 default:
1711 /* reject case 0, SL11S is less functional */
1712 dev_dbg(&dev->dev, "chiprev %02x\n", tmp);
1713 retval = -ENXIO;
1714 goto err6;
1715 }
1716
1717 /* The chip's IRQ is level triggered, active high. A requirement
1718 * for platform device setup is to cope with things like signal
1719 * inverters (e.g. CF is active low) or working only with edge
1720 * triggers (e.g. most ARM CPUs). Initial driver stress testing
1721 * was on a system with single edge triggering, so most sorts of
1722 * triggering arrangement should work.
1723 *
1724 * Use resource IRQ flags if set by platform device setup.
1725 */
1726 irqflags |= IRQF_SHARED;
1727 retval = usb_add_hcd(hcd, irq, irqflags);
1728 if (retval != 0)
1729 goto err6;
1730
1731 device_wakeup_enable(hcd->self.controller);
1732
1733 create_debug_file(sl811);
1734 return retval;
1735
1736 err6:
1737 usb_put_hcd(hcd);
1738 err5:
1739 if (!ioaddr)
1740 iounmap(data_reg);
1741 err4:
1742 if (!ioaddr)
1743 iounmap(addr_reg);
1744 err2:
1745 dev_dbg(&dev->dev, "init error, %d\n", retval);
1746 return retval;
1747 }
1748
1749 #ifdef CONFIG_PM
1750
1751 /* for this device there's no useful distinction between the controller
1752 * and its root hub.
1753 */
1754
1755 static int
sl811h_suspend(struct platform_device * dev,pm_message_t state)1756 sl811h_suspend(struct platform_device *dev, pm_message_t state)
1757 {
1758 struct usb_hcd *hcd = platform_get_drvdata(dev);
1759 struct sl811 *sl811 = hcd_to_sl811(hcd);
1760 int retval = 0;
1761
1762 switch (state.event) {
1763 case PM_EVENT_FREEZE:
1764 retval = sl811h_bus_suspend(hcd);
1765 break;
1766 case PM_EVENT_SUSPEND:
1767 case PM_EVENT_HIBERNATE:
1768 case PM_EVENT_PRETHAW: /* explicitly discard hw state */
1769 port_power(sl811, 0);
1770 break;
1771 }
1772 return retval;
1773 }
1774
1775 static int
sl811h_resume(struct platform_device * dev)1776 sl811h_resume(struct platform_device *dev)
1777 {
1778 struct usb_hcd *hcd = platform_get_drvdata(dev);
1779 struct sl811 *sl811 = hcd_to_sl811(hcd);
1780
1781 /* with no "check to see if VBUS is still powered" board hook,
1782 * let's assume it'd only be powered to enable remote wakeup.
1783 */
1784 if (!sl811->port1 || !device_can_wakeup(&hcd->self.root_hub->dev)) {
1785 sl811->port1 = 0;
1786 port_power(sl811, 1);
1787 usb_root_hub_lost_power(hcd->self.root_hub);
1788 return 0;
1789 }
1790
1791 return sl811h_bus_resume(hcd);
1792 }
1793
1794 #else
1795
1796 #define sl811h_suspend NULL
1797 #define sl811h_resume NULL
1798
1799 #endif
1800
1801
1802 /* this driver is exported so sl811_cs can depend on it */
1803 struct platform_driver sl811h_driver = {
1804 .probe = sl811h_probe,
1805 .remove = sl811h_remove,
1806
1807 .suspend = sl811h_suspend,
1808 .resume = sl811h_resume,
1809 .driver = {
1810 .name = (char *) hcd_name,
1811 },
1812 };
1813 EXPORT_SYMBOL(sl811h_driver);
1814
1815 module_platform_driver(sl811h_driver);
1816