2 * Driver for the NXP ISP1760 chip
4 * However, the code might contain some bugs. What doesn't work for sure is:
7 e The interrupt line is configured as active low, level.
9 * (c) 2007 Sebastian Siewior <bigeasy@linutronix.de>
12 #include <linux/module.h>
13 #include <linux/kernel.h>
14 #include <linux/slab.h>
15 #include <linux/list.h>
16 #include <linux/usb.h>
17 #include <linux/usb/hcd.h>
18 #include <linux/debugfs.h>
19 #include <linux/uaccess.h>
22 #include <asm/unaligned.h>
23 #include <asm/cacheflush.h>
25 #include "isp1760-hcd.h"
27 static struct kmem_cache *qtd_cachep;
28 static struct kmem_cache *qh_cachep;
33 struct inter_packet_info atl_ints[32];
34 struct inter_packet_info int_ints[32];
35 struct memory_chunk memory_pool[BLOCKS];
37 /* periodic schedule support */
38 #define DEFAULT_I_TDPS 1024
39 unsigned periodic_size;
41 unsigned long reset_done;
42 unsigned long next_statechange;
43 unsigned int devflags;
46 static inline struct isp1760_hcd *hcd_to_priv(struct usb_hcd *hcd)
48 return (struct isp1760_hcd *) (hcd->hcd_priv);
50 static inline struct usb_hcd *priv_to_hcd(struct isp1760_hcd *priv)
52 return container_of((void *) priv, struct usb_hcd, hcd_priv);
55 /* Section 2.2 Host Controller Capability Registers */
56 #define HC_LENGTH(p) (((p)>>00)&0x00ff) /* bits 7:0 */
57 #define HC_VERSION(p) (((p)>>16)&0xffff) /* bits 31:16 */
58 #define HCS_INDICATOR(p) ((p)&(1 << 16)) /* true: has port indicators */
59 #define HCS_PPC(p) ((p)&(1 << 4)) /* true: port power control */
60 #define HCS_N_PORTS(p) (((p)>>0)&0xf) /* bits 3:0, ports on HC */
61 #define HCC_ISOC_CACHE(p) ((p)&(1 << 7)) /* true: can cache isoc frame */
62 #define HCC_ISOC_THRES(p) (((p)>>4)&0x7) /* bits 6:4, uframes cached */
64 /* Section 2.3 Host Controller Operational Registers */
65 #define CMD_LRESET (1<<7) /* partial reset (no ports, etc) */
66 #define CMD_RESET (1<<1) /* reset HC not bus */
67 #define CMD_RUN (1<<0) /* start/stop HC */
68 #define STS_PCD (1<<2) /* port change detect */
69 #define FLAG_CF (1<<0) /* true: we'll support "high speed" */
71 #define PORT_OWNER (1<<13) /* true: companion hc owns this port */
72 #define PORT_POWER (1<<12) /* true: has power (see PPC) */
73 #define PORT_USB11(x) (((x) & (3 << 10)) == (1 << 10)) /* USB 1.1 device */
74 #define PORT_RESET (1<<8) /* reset port */
75 #define PORT_SUSPEND (1<<7) /* suspend port */
76 #define PORT_RESUME (1<<6) /* resume it */
77 #define PORT_PE (1<<2) /* port enable */
78 #define PORT_CSC (1<<1) /* connect status change */
79 #define PORT_CONNECT (1<<0) /* device connected */
80 #define PORT_RWC_BITS (PORT_CSC)
83 struct isp1760_qtd *hw_next;
88 /* the rest is HCD-private */
89 struct list_head qtd_list;
95 #define URB_COMPLETE_NOTIFY (1 << 0)
96 #define URB_ENQUEUED (1 << 1)
97 #define URB_TYPE_ATL (1 << 2)
98 #define URB_TYPE_INT (1 << 3)
102 /* first part defined by EHCI spec */
103 struct list_head qtd_list;
104 struct isp1760_hcd *priv;
106 /* periodic schedule info */
107 unsigned short period; /* polling interval */
108 struct usb_device *dev;
114 #define ehci_port_speed(priv, portsc) USB_PORT_STAT_HIGH_SPEED
116 static unsigned int isp1760_readl(__u32 __iomem *regs)
121 static void isp1760_writel(const unsigned int val, __u32 __iomem *regs)
127 * The next two copy via MMIO data to/from the device. memcpy_{to|from}io()
128 * doesn't quite work because some people have to enforce 32-bit access
130 static void priv_read_copy(struct isp1760_hcd *priv, u32 *src,
131 __u32 __iomem *dst, u32 len)
137 printk(KERN_ERR "ERROR: buffer: %p len: %d\n", src, len);
142 *src = __raw_readl(dst);
151 /* in case we have 3, 2 or 1 by left. The dst buffer may not be fully
154 val = isp1760_readl(dst);
166 static void priv_write_copy(const struct isp1760_hcd *priv, const u32 *src,
167 __u32 __iomem *dst, u32 len)
170 __raw_writel(*src, dst);
178 /* in case we have 3, 2 or 1 by left. The buffer is allocated and the
179 * extra bytes should not be read by the HW
182 __raw_writel(*src, dst);
185 /* memory management of the 60kb on the chip from 0x1000 to 0xffff */
186 static void init_memory(struct isp1760_hcd *priv)
192 for (i = 0; i < BLOCK_1_NUM; i++) {
193 priv->memory_pool[i].start = payload;
194 priv->memory_pool[i].size = BLOCK_1_SIZE;
195 priv->memory_pool[i].free = 1;
196 payload += priv->memory_pool[i].size;
200 for (i = BLOCK_1_NUM; i < BLOCK_1_NUM + BLOCK_2_NUM; i++) {
201 priv->memory_pool[i].start = payload;
202 priv->memory_pool[i].size = BLOCK_2_SIZE;
203 priv->memory_pool[i].free = 1;
204 payload += priv->memory_pool[i].size;
208 for (i = BLOCK_1_NUM + BLOCK_2_NUM; i < BLOCKS; i++) {
209 priv->memory_pool[i].start = payload;
210 priv->memory_pool[i].size = BLOCK_3_SIZE;
211 priv->memory_pool[i].free = 1;
212 payload += priv->memory_pool[i].size;
215 BUG_ON(payload - priv->memory_pool[i - 1].size > PAYLOAD_SIZE);
218 static u32 alloc_mem(struct isp1760_hcd *priv, u32 size)
223 return ISP1760_NULL_POINTER;
225 for (i = 0; i < BLOCKS; i++) {
226 if (priv->memory_pool[i].size >= size &&
227 priv->memory_pool[i].free) {
229 priv->memory_pool[i].free = 0;
230 return priv->memory_pool[i].start;
234 printk(KERN_ERR "ISP1760 MEM: can not allocate %d bytes of memory\n",
236 printk(KERN_ERR "Current memory map:\n");
237 for (i = 0; i < BLOCKS; i++) {
238 printk(KERN_ERR "Pool %2d size %4d status: %d\n",
239 i, priv->memory_pool[i].size,
240 priv->memory_pool[i].free);
242 /* XXX maybe -ENOMEM could be possible */
247 static void free_mem(struct isp1760_hcd *priv, u32 mem)
251 if (mem == ISP1760_NULL_POINTER)
254 for (i = 0; i < BLOCKS; i++) {
255 if (priv->memory_pool[i].start == mem) {
257 BUG_ON(priv->memory_pool[i].free);
259 priv->memory_pool[i].free = 1;
264 printk(KERN_ERR "Trying to free not-here-allocated memory :%08x\n",
269 static void isp1760_init_regs(struct usb_hcd *hcd)
271 isp1760_writel(0, hcd->regs + HC_BUFFER_STATUS_REG);
272 isp1760_writel(NO_TRANSFER_ACTIVE, hcd->regs +
273 HC_ATL_PTD_SKIPMAP_REG);
274 isp1760_writel(NO_TRANSFER_ACTIVE, hcd->regs +
275 HC_INT_PTD_SKIPMAP_REG);
276 isp1760_writel(NO_TRANSFER_ACTIVE, hcd->regs +
277 HC_ISO_PTD_SKIPMAP_REG);
279 isp1760_writel(~NO_TRANSFER_ACTIVE, hcd->regs +
280 HC_ATL_PTD_DONEMAP_REG);
281 isp1760_writel(~NO_TRANSFER_ACTIVE, hcd->regs +
282 HC_INT_PTD_DONEMAP_REG);
283 isp1760_writel(~NO_TRANSFER_ACTIVE, hcd->regs +
284 HC_ISO_PTD_DONEMAP_REG);
287 static int handshake(struct isp1760_hcd *priv, void __iomem *ptr,
288 u32 mask, u32 done, int usec)
293 result = isp1760_readl(ptr);
305 /* reset a non-running (STS_HALT == 1) controller */
306 static int ehci_reset(struct isp1760_hcd *priv)
309 struct usb_hcd *hcd = priv_to_hcd(priv);
310 u32 command = isp1760_readl(hcd->regs + HC_USBCMD);
312 command |= CMD_RESET;
313 isp1760_writel(command, hcd->regs + HC_USBCMD);
314 hcd->state = HC_STATE_HALT;
315 priv->next_statechange = jiffies;
316 retval = handshake(priv, hcd->regs + HC_USBCMD,
317 CMD_RESET, 0, 250 * 1000);
321 static void qh_destroy(struct isp1760_qh *qh)
323 BUG_ON(!list_empty(&qh->qtd_list));
324 kmem_cache_free(qh_cachep, qh);
327 static struct isp1760_qh *isp1760_qh_alloc(struct isp1760_hcd *priv,
330 struct isp1760_qh *qh;
332 qh = kmem_cache_zalloc(qh_cachep, flags);
336 INIT_LIST_HEAD(&qh->qtd_list);
341 /* magic numbers that can affect system performance */
342 #define EHCI_TUNE_CERR 3 /* 0-3 qtd retries; 0 == don't stop */
343 #define EHCI_TUNE_RL_HS 4 /* nak throttle; see 4.9 */
344 #define EHCI_TUNE_RL_TT 0
345 #define EHCI_TUNE_MULT_HS 1 /* 1-3 transactions/uframe; 4.10.3 */
346 #define EHCI_TUNE_MULT_TT 1
347 #define EHCI_TUNE_FLS 2 /* (small) 256 frame schedule */
349 /* one-time init, only for memory state */
350 static int priv_init(struct usb_hcd *hcd)
352 struct isp1760_hcd *priv = hcd_to_priv(hcd);
355 spin_lock_init(&priv->lock);
358 * hw default: 1K periodic list heads, one per frame.
359 * periodic_size can shrink by USBCMD update if hcc_params allows.
361 priv->periodic_size = DEFAULT_I_TDPS;
363 /* controllers may cache some of the periodic schedule ... */
364 hcc_params = isp1760_readl(hcd->regs + HC_HCCPARAMS);
365 /* full frame cache */
366 if (HCC_ISOC_CACHE(hcc_params))
368 else /* N microframes cached */
369 priv->i_thresh = 2 + HCC_ISOC_THRES(hcc_params);
374 static int isp1760_hc_setup(struct usb_hcd *hcd)
376 struct isp1760_hcd *priv = hcd_to_priv(hcd);
380 /* Setup HW Mode Control: This assumes a level active-low interrupt */
381 hwmode = HW_DATA_BUS_32BIT;
383 if (priv->devflags & ISP1760_FLAG_BUS_WIDTH_16)
384 hwmode &= ~HW_DATA_BUS_32BIT;
385 if (priv->devflags & ISP1760_FLAG_ANALOG_OC)
386 hwmode |= HW_ANA_DIGI_OC;
387 if (priv->devflags & ISP1760_FLAG_DACK_POL_HIGH)
388 hwmode |= HW_DACK_POL_HIGH;
389 if (priv->devflags & ISP1760_FLAG_DREQ_POL_HIGH)
390 hwmode |= HW_DREQ_POL_HIGH;
391 if (priv->devflags & ISP1760_FLAG_INTR_POL_HIGH)
392 hwmode |= HW_INTR_HIGH_ACT;
393 if (priv->devflags & ISP1760_FLAG_INTR_EDGE_TRIG)
394 hwmode |= HW_INTR_EDGE_TRIG;
397 * We have to set this first in case we're in 16-bit mode.
398 * Write it twice to ensure correct upper bits if switching
401 isp1760_writel(hwmode, hcd->regs + HC_HW_MODE_CTRL);
402 isp1760_writel(hwmode, hcd->regs + HC_HW_MODE_CTRL);
404 isp1760_writel(0xdeadbabe, hcd->regs + HC_SCRATCH_REG);
405 /* Change bus pattern */
406 scratch = isp1760_readl(hcd->regs + HC_CHIP_ID_REG);
407 scratch = isp1760_readl(hcd->regs + HC_SCRATCH_REG);
408 if (scratch != 0xdeadbabe) {
409 printk(KERN_ERR "ISP1760: Scratch test failed.\n");
414 isp1760_init_regs(hcd);
417 isp1760_writel(SW_RESET_RESET_ALL, hcd->regs + HC_RESET_REG);
420 isp1760_writel(SW_RESET_RESET_HC, hcd->regs + HC_RESET_REG);
423 result = ehci_reset(priv);
429 isp1760_info(priv, "bus width: %d, oc: %s\n",
430 (priv->devflags & ISP1760_FLAG_BUS_WIDTH_16) ?
431 16 : 32, (priv->devflags & ISP1760_FLAG_ANALOG_OC) ?
432 "analog" : "digital");
435 isp1760_writel(hwmode | ALL_ATX_RESET, hcd->regs + HC_HW_MODE_CTRL);
437 isp1760_writel(hwmode, hcd->regs + HC_HW_MODE_CTRL);
439 isp1760_writel(INTERRUPT_ENABLE_MASK, hcd->regs + HC_INTERRUPT_REG);
440 isp1760_writel(INTERRUPT_ENABLE_MASK, hcd->regs + HC_INTERRUPT_ENABLE);
443 * PORT 1 Control register of the ISP1760 is the OTG control
444 * register on ISP1761. Since there is no OTG or device controller
445 * support in this driver, we use port 1 as a "normal" USB host port on
448 isp1760_writel(PORT1_POWER | PORT1_INIT2,
449 hcd->regs + HC_PORT1_CTRL);
452 priv->hcs_params = isp1760_readl(hcd->regs + HC_HCSPARAMS);
454 return priv_init(hcd);
457 static void isp1760_init_maps(struct usb_hcd *hcd)
459 /*set last maps, for iso its only 1, else 32 tds bitmap*/
460 isp1760_writel(0x80000000, hcd->regs + HC_ATL_PTD_LASTPTD_REG);
461 isp1760_writel(0x80000000, hcd->regs + HC_INT_PTD_LASTPTD_REG);
462 isp1760_writel(0x00000001, hcd->regs + HC_ISO_PTD_LASTPTD_REG);
465 static void isp1760_enable_interrupts(struct usb_hcd *hcd)
467 isp1760_writel(0, hcd->regs + HC_ATL_IRQ_MASK_AND_REG);
468 isp1760_writel(0, hcd->regs + HC_ATL_IRQ_MASK_OR_REG);
469 isp1760_writel(0, hcd->regs + HC_INT_IRQ_MASK_AND_REG);
470 isp1760_writel(0, hcd->regs + HC_INT_IRQ_MASK_OR_REG);
471 isp1760_writel(0, hcd->regs + HC_ISO_IRQ_MASK_AND_REG);
472 isp1760_writel(0xffffffff, hcd->regs + HC_ISO_IRQ_MASK_OR_REG);
476 static int isp1760_run(struct usb_hcd *hcd)
478 struct isp1760_hcd *priv = hcd_to_priv(hcd);
484 hcd->uses_new_polling = 1;
487 hcd->state = HC_STATE_RUNNING;
488 isp1760_enable_interrupts(hcd);
489 temp = isp1760_readl(hcd->regs + HC_HW_MODE_CTRL);
490 isp1760_writel(temp | HW_GLOBAL_INTR_EN, hcd->regs + HC_HW_MODE_CTRL);
492 command = isp1760_readl(hcd->regs + HC_USBCMD);
493 command &= ~(CMD_LRESET|CMD_RESET);
495 isp1760_writel(command, hcd->regs + HC_USBCMD);
497 retval = handshake(priv, hcd->regs + HC_USBCMD, CMD_RUN, CMD_RUN,
504 * Spec says to write FLAG_CF as last config action, priv code grabs
505 * the semaphore while doing so.
507 down_write(&ehci_cf_port_reset_rwsem);
508 isp1760_writel(FLAG_CF, hcd->regs + HC_CONFIGFLAG);
510 retval = handshake(priv, hcd->regs + HC_CONFIGFLAG, FLAG_CF, FLAG_CF,
512 up_write(&ehci_cf_port_reset_rwsem);
516 chipid = isp1760_readl(hcd->regs + HC_CHIP_ID_REG);
517 isp1760_info(priv, "USB ISP %04x HW rev. %d started\n", chipid & 0xffff,
520 /* PTD Register Init Part 2, Step 28 */
522 isp1760_init_maps(hcd);
524 /* GRR this is run-once init(), being done every time the HC starts.
525 * So long as they're part of class devices, we can't do it init()
526 * since the class device isn't created that early.
531 static u32 base_to_chip(u32 base)
533 return ((base - 0x400) >> 3);
536 static void transform_into_atl(struct isp1760_hcd *priv, struct isp1760_qh *qh,
537 struct isp1760_qtd *qtd, struct urb *urb,
538 u32 payload, struct ptd *ptd)
548 u32 nak = NAK_COUNTER;
550 /* according to 3.6.2, max packet len can not be > 0x400 */
551 maxpacket = usb_maxpacket(urb->dev, urb->pipe, usb_pipeout(urb->pipe));
552 multi = 1 + ((maxpacket >> 11) & 0x3);
557 dw0 |= PTD_LENGTH(qtd->length);
558 dw0 |= PTD_MAXPACKET(maxpacket);
559 dw0 |= PTD_ENDPOINT(usb_pipeendpoint(urb->pipe));
560 dw1 = usb_pipeendpoint(urb->pipe) >> 1;
563 dw1 |= PTD_DEVICE_ADDR(usb_pipedevice(urb->pipe));
565 pid_code = qtd->packet_type;
566 dw1 |= PTD_PID_TOKEN(pid_code);
568 if (usb_pipebulk(urb->pipe))
569 dw1 |= PTD_TRANS_BULK;
570 else if (usb_pipeint(urb->pipe))
571 dw1 |= PTD_TRANS_INT;
573 if (urb->dev->speed != USB_SPEED_HIGH) {
574 /* split transaction */
576 dw1 |= PTD_TRANS_SPLIT;
577 if (urb->dev->speed == USB_SPEED_LOW)
578 dw1 |= PTD_SE_USB_LOSPEED;
580 dw1 |= PTD_PORT_NUM(urb->dev->ttport);
581 dw1 |= PTD_HUB_NUM(urb->dev->tt->hub->devnum);
583 /* SE bit for Split INT transfers */
584 if (usb_pipeint(urb->pipe) &&
585 (urb->dev->speed == USB_SPEED_LOW))
592 dw0 |= PTD_MULTI(multi);
593 if (usb_pipecontrol(urb->pipe) || usb_pipebulk(urb->pipe))
600 dw2 |= PTD_DATA_START_ADDR(base_to_chip(payload));
601 dw2 |= PTD_RL_CNT(rl);
602 dw3 |= PTD_NAC_CNT(nak);
605 if (usb_pipecontrol(urb->pipe))
606 dw3 |= PTD_DATA_TOGGLE(qtd->toggle);
613 dw3 |= PTD_CERR(ERR_COUNTER);
615 memset(ptd, 0, sizeof(*ptd));
617 ptd->dw0 = cpu_to_le32(dw0);
618 ptd->dw1 = cpu_to_le32(dw1);
619 ptd->dw2 = cpu_to_le32(dw2);
620 ptd->dw3 = cpu_to_le32(dw3);
623 static void transform_add_int(struct isp1760_hcd *priv, struct isp1760_qh *qh,
624 struct isp1760_qtd *qtd, struct urb *urb,
625 u32 payload, struct ptd *ptd)
634 maxpacket = usb_maxpacket(urb->dev, urb->pipe, usb_pipeout(urb->pipe));
635 multi = 1 + ((maxpacket >> 11) & 0x3);
637 /* length of the data per uframe */
638 maxpacket = multi * maxpacket;
640 numberofusofs = urb->transfer_buffer_length / maxpacket;
641 if (urb->transfer_buffer_length % maxpacket)
646 for (i = 0; i < numberofusofs; i++) {
651 if (urb->dev->speed != USB_SPEED_HIGH) {
653 ptd->dw5 = cpu_to_le32(0x1c);
655 if (qh->period >= 32)
656 period = qh->period / 2;
663 period = qh->period/8;
670 if (qh->period >= 8) {
671 /* millisecond period */
672 period = (period << 3);
674 /* usof based tranmsfers */
675 /* minimum 4 usofs */
680 ptd->dw2 |= cpu_to_le32(period);
681 ptd->dw4 = cpu_to_le32(usof);
684 static void transform_into_int(struct isp1760_hcd *priv, struct isp1760_qh *qh,
685 struct isp1760_qtd *qtd, struct urb *urb,
686 u32 payload, struct ptd *ptd)
688 transform_into_atl(priv, qh, qtd, urb, payload, ptd);
689 transform_add_int(priv, qh, qtd, urb, payload, ptd);
692 static int qtd_fill(struct isp1760_qtd *qtd, void *databuffer, size_t len,
697 qtd->data_buffer = databuffer;
698 qtd->packet_type = GET_QTD_TOKEN_TYPE(token);
699 qtd->toggle = GET_DATA_TOGGLE(token);
701 if (len > HC_ATL_PL_SIZE)
702 count = HC_ATL_PL_SIZE;
710 static int check_error(struct ptd *ptd)
715 dw3 = le32_to_cpu(ptd->dw3);
716 if (dw3 & DW3_HALT_BIT) {
719 if (dw3 & DW3_ERROR_BIT)
720 pr_err("error bit is set in DW3\n");
723 if (dw3 & DW3_QTD_ACTIVE) {
724 printk(KERN_ERR "transfer active bit is set DW3\n");
725 printk(KERN_ERR "nak counter: %d, rl: %d\n", (dw3 >> 19) & 0xf,
726 (le32_to_cpu(ptd->dw2) >> 25) & 0xf);
732 static void check_int_err_status(u32 dw4)
738 for (i = 0; i < 8; i++) {
741 printk(KERN_ERR "ERROR: under run , %d\n", i);
745 printk(KERN_ERR "ERROR: transaction error, %d\n", i);
749 printk(KERN_ERR "ERROR: babble error, %d\n", i);
756 static void enqueue_one_qtd(struct isp1760_qtd *qtd, struct isp1760_hcd *priv,
760 struct usb_hcd *hcd = priv_to_hcd(priv);
762 token = qtd->packet_type;
764 if (qtd->length && (qtd->length <= HC_ATL_PL_SIZE)) {
770 priv_write_copy(priv, qtd->data_buffer,
777 static void enqueue_one_atl_qtd(u32 atl_regs, u32 payload,
778 struct isp1760_hcd *priv, struct isp1760_qh *qh,
779 struct urb *urb, u32 slot, struct isp1760_qtd *qtd)
782 struct usb_hcd *hcd = priv_to_hcd(priv);
784 transform_into_atl(priv, qh, qtd, urb, payload, &ptd);
785 priv_write_copy(priv, (u32 *)&ptd, hcd->regs + atl_regs, sizeof(ptd));
786 enqueue_one_qtd(qtd, priv, payload);
788 priv->atl_ints[slot].urb = urb;
789 priv->atl_ints[slot].qh = qh;
790 priv->atl_ints[slot].qtd = qtd;
791 priv->atl_ints[slot].data_buffer = qtd->data_buffer;
792 priv->atl_ints[slot].payload = payload;
793 qtd->status |= URB_ENQUEUED | URB_TYPE_ATL;
794 qtd->status |= slot << 16;
797 static void enqueue_one_int_qtd(u32 int_regs, u32 payload,
798 struct isp1760_hcd *priv, struct isp1760_qh *qh,
799 struct urb *urb, u32 slot, struct isp1760_qtd *qtd)
802 struct usb_hcd *hcd = priv_to_hcd(priv);
804 transform_into_int(priv, qh, qtd, urb, payload, &ptd);
805 priv_write_copy(priv, (u32 *)&ptd, hcd->regs + int_regs, sizeof(ptd));
806 enqueue_one_qtd(qtd, priv, payload);
808 priv->int_ints[slot].urb = urb;
809 priv->int_ints[slot].qh = qh;
810 priv->int_ints[slot].qtd = qtd;
811 priv->int_ints[slot].data_buffer = qtd->data_buffer;
812 priv->int_ints[slot].payload = payload;
813 qtd->status |= URB_ENQUEUED | URB_TYPE_INT;
814 qtd->status |= slot << 16;
817 static void enqueue_an_ATL_packet(struct usb_hcd *hcd, struct isp1760_qh *qh,
818 struct isp1760_qtd *qtd)
820 struct isp1760_hcd *priv = hcd_to_priv(hcd);
821 u32 skip_map, or_map;
824 u32 atl_regs, payload;
828 * When this function is called from the interrupt handler to enqueue
829 * a follow-up packet, the SKIP register gets written and read back
830 * almost immediately. With ISP1761, this register requires a delay of
831 * 195ns between a write and subsequent read (see section 15.1.1.3).
834 skip_map = isp1760_readl(hcd->regs + HC_ATL_PTD_SKIPMAP_REG);
837 slot = __ffs(skip_map);
838 queue_entry = 1 << slot;
840 atl_regs = ATL_REGS_OFFSET + slot * sizeof(struct ptd);
842 payload = alloc_mem(priv, qtd->length);
844 enqueue_one_atl_qtd(atl_regs, payload, priv, qh, qtd->urb, slot, qtd);
846 or_map = isp1760_readl(hcd->regs + HC_ATL_IRQ_MASK_OR_REG);
847 or_map |= queue_entry;
848 isp1760_writel(or_map, hcd->regs + HC_ATL_IRQ_MASK_OR_REG);
850 skip_map &= ~queue_entry;
851 isp1760_writel(skip_map, hcd->regs + HC_ATL_PTD_SKIPMAP_REG);
853 buffstatus = isp1760_readl(hcd->regs + HC_BUFFER_STATUS_REG);
854 buffstatus |= ATL_BUFFER;
855 isp1760_writel(buffstatus, hcd->regs + HC_BUFFER_STATUS_REG);
858 static void enqueue_an_INT_packet(struct usb_hcd *hcd, struct isp1760_qh *qh,
859 struct isp1760_qtd *qtd)
861 struct isp1760_hcd *priv = hcd_to_priv(hcd);
862 u32 skip_map, or_map;
865 u32 int_regs, payload;
869 * When this function is called from the interrupt handler to enqueue
870 * a follow-up packet, the SKIP register gets written and read back
871 * almost immediately. With ISP1761, this register requires a delay of
872 * 195ns between a write and subsequent read (see section 15.1.1.3).
875 skip_map = isp1760_readl(hcd->regs + HC_INT_PTD_SKIPMAP_REG);
878 slot = __ffs(skip_map);
879 queue_entry = 1 << slot;
881 int_regs = INT_REGS_OFFSET + slot * sizeof(struct ptd);
883 payload = alloc_mem(priv, qtd->length);
885 enqueue_one_int_qtd(int_regs, payload, priv, qh, qtd->urb, slot, qtd);
887 or_map = isp1760_readl(hcd->regs + HC_INT_IRQ_MASK_OR_REG);
888 or_map |= queue_entry;
889 isp1760_writel(or_map, hcd->regs + HC_INT_IRQ_MASK_OR_REG);
891 skip_map &= ~queue_entry;
892 isp1760_writel(skip_map, hcd->regs + HC_INT_PTD_SKIPMAP_REG);
894 buffstatus = isp1760_readl(hcd->regs + HC_BUFFER_STATUS_REG);
895 buffstatus |= INT_BUFFER;
896 isp1760_writel(buffstatus, hcd->regs + HC_BUFFER_STATUS_REG);
899 static void isp1760_urb_done(struct isp1760_hcd *priv, struct urb *urb, int status)
900 __releases(priv->lock)
901 __acquires(priv->lock)
903 if (!urb->unlinked) {
904 if (status == -EINPROGRESS)
908 if (usb_pipein(urb->pipe) && usb_pipetype(urb->pipe) != PIPE_CONTROL) {
910 for (ptr = urb->transfer_buffer;
911 ptr < urb->transfer_buffer + urb->transfer_buffer_length;
913 flush_dcache_page(virt_to_page(ptr));
916 /* complete() can reenter this HCD */
917 usb_hcd_unlink_urb_from_ep(priv_to_hcd(priv), urb);
918 spin_unlock(&priv->lock);
919 usb_hcd_giveback_urb(priv_to_hcd(priv), urb, status);
920 spin_lock(&priv->lock);
923 static void isp1760_qtd_free(struct isp1760_qtd *qtd)
925 kmem_cache_free(qtd_cachep, qtd);
928 static struct isp1760_qtd *clean_this_qtd(struct isp1760_qtd *qtd)
930 struct isp1760_qtd *tmp_qtd;
932 tmp_qtd = qtd->hw_next;
933 list_del(&qtd->qtd_list);
934 isp1760_qtd_free(qtd);
939 * Remove this QTD from the QH list and free its memory. If this QTD
940 * isn't the last one than remove also his successor(s).
941 * Returns the QTD which is part of an new URB and should be enqueued.
943 static struct isp1760_qtd *clean_up_qtdlist(struct isp1760_qtd *qtd)
945 struct isp1760_qtd *tmp_qtd;
949 tmp_qtd = qtd->hw_next;
950 last_one = qtd->status & URB_COMPLETE_NOTIFY;
951 list_del(&qtd->qtd_list);
952 isp1760_qtd_free(qtd);
954 } while (!last_one && qtd);
959 static void do_atl_int(struct usb_hcd *usb_hcd)
961 struct isp1760_hcd *priv = hcd_to_priv(usb_hcd);
962 u32 done_map, skip_map;
964 struct urb *urb = NULL;
971 u32 status = -EINVAL;
973 struct isp1760_qtd *qtd;
974 struct isp1760_qh *qh;
978 done_map = isp1760_readl(usb_hcd->regs +
979 HC_ATL_PTD_DONEMAP_REG);
980 skip_map = isp1760_readl(usb_hcd->regs +
981 HC_ATL_PTD_SKIPMAP_REG);
983 or_map = isp1760_readl(usb_hcd->regs + HC_ATL_IRQ_MASK_OR_REG);
985 isp1760_writel(or_map, usb_hcd->regs + HC_ATL_IRQ_MASK_OR_REG);
987 atl_regs_base = ATL_REGS_OFFSET;
995 queue_entry = __ffs(done_map);
996 done_map &= ~(1 << queue_entry);
997 skip_map |= 1 << queue_entry;
999 atl_regs = atl_regs_base + queue_entry * sizeof(struct ptd);
1001 urb = priv->atl_ints[queue_entry].urb;
1002 qtd = priv->atl_ints[queue_entry].qtd;
1003 qh = priv->atl_ints[queue_entry].qh;
1004 payload = priv->atl_ints[queue_entry].payload;
1007 printk(KERN_ERR "qh is 0\n");
1010 isp1760_writel(atl_regs + ISP_BANK(0), usb_hcd->regs +
1012 isp1760_writel(payload + ISP_BANK(1), usb_hcd->regs +
1015 * write bank1 address twice to ensure the 90ns delay (time
1016 * between BANK0 write and the priv_read_copy() call is at
1017 * least 3*t_WHWL + 2*t_w11 = 3*25ns + 2*17ns = 109ns)
1019 isp1760_writel(payload + ISP_BANK(1), usb_hcd->regs +
1022 priv_read_copy(priv, (u32 *)&ptd, usb_hcd->regs + atl_regs +
1023 ISP_BANK(0), sizeof(ptd));
1025 dw1 = le32_to_cpu(ptd.dw1);
1026 dw2 = le32_to_cpu(ptd.dw2);
1027 dw3 = le32_to_cpu(ptd.dw3);
1028 rl = (dw2 >> 25) & 0x0f;
1029 nakcount = (dw3 >> 19) & 0xf;
1031 /* Transfer Error, *but* active and no HALT -> reload */
1032 if ((dw3 & DW3_ERROR_BIT) && (dw3 & DW3_QTD_ACTIVE) &&
1033 !(dw3 & DW3_HALT_BIT)) {
1035 /* according to ppriv code, we have to
1036 * reload this one if trasfered bytes != requested bytes
1037 * else act like everything went smooth..
1038 * XXX This just doesn't feel right and hasn't
1042 length = PTD_XFERRED_LENGTH(dw3);
1043 printk(KERN_ERR "Should reload now.... transfered %d "
1044 "of %zu\n", length, qtd->length);
1048 if (!nakcount && (dw3 & DW3_QTD_ACTIVE)) {
1052 * NAKs are handled in HW by the chip. Usually if the
1053 * device is not able to send data fast enough.
1054 * This happens mostly on slower hardware.
1056 printk(KERN_NOTICE "Reloading ptd %p/%p... qh %p read: "
1057 "%d of %zu done: %08x cur: %08x\n", qtd,
1058 urb, qh, PTD_XFERRED_LENGTH(dw3),
1059 qtd->length, done_map,
1060 (1 << queue_entry));
1062 /* RL counter = ERR counter */
1063 dw3 &= ~(0xf << 19);
1065 dw3 &= ~(3 << (55 - 32));
1066 dw3 |= ERR_COUNTER << (55 - 32);
1069 * It is not needed to write skip map back because it
1070 * is unchanged. Just make sure that this entry is
1071 * unskipped once it gets written to the HW.
1073 skip_map &= ~(1 << queue_entry);
1074 or_map = isp1760_readl(usb_hcd->regs +
1075 HC_ATL_IRQ_MASK_OR_REG);
1076 or_map |= 1 << queue_entry;
1077 isp1760_writel(or_map, usb_hcd->regs +
1078 HC_ATL_IRQ_MASK_OR_REG);
1080 ptd.dw3 = cpu_to_le32(dw3);
1081 priv_write_copy(priv, (u32 *)&ptd, usb_hcd->regs +
1082 atl_regs, sizeof(ptd));
1084 ptd.dw0 |= cpu_to_le32(PTD_VALID);
1085 priv_write_copy(priv, (u32 *)&ptd, usb_hcd->regs +
1086 atl_regs, sizeof(ptd));
1088 buffstatus = isp1760_readl(usb_hcd->regs +
1089 HC_BUFFER_STATUS_REG);
1090 buffstatus |= ATL_BUFFER;
1091 isp1760_writel(buffstatus, usb_hcd->regs +
1092 HC_BUFFER_STATUS_REG);
1096 error = check_error(&ptd);
1099 priv->atl_ints[queue_entry].qh->toggle = 0;
1100 priv->atl_ints[queue_entry].qh->ping = 0;
1101 urb->status = -EPIPE;
1104 printk(KERN_ERR "Error in %s().\n", __func__);
1105 printk(KERN_ERR "IN dw0: %08x dw1: %08x dw2: %08x "
1106 "dw3: %08x dw4: %08x dw5: %08x dw6: "
1108 ptd.dw0, ptd.dw1, ptd.dw2, ptd.dw3,
1109 ptd.dw4, ptd.dw5, ptd.dw6, ptd.dw7);
1112 if (usb_pipetype(urb->pipe) == PIPE_BULK) {
1113 priv->atl_ints[queue_entry].qh->toggle = dw3 &
1115 priv->atl_ints[queue_entry].qh->ping = dw3 &
1120 length = PTD_XFERRED_LENGTH(dw3);
1122 switch (DW1_GET_PID(dw1)) {
1124 priv_read_copy(priv,
1125 priv->atl_ints[queue_entry].data_buffer,
1126 usb_hcd->regs + payload + ISP_BANK(1),
1131 urb->actual_length += length;
1138 priv->atl_ints[queue_entry].data_buffer = NULL;
1139 priv->atl_ints[queue_entry].urb = NULL;
1140 priv->atl_ints[queue_entry].qtd = NULL;
1141 priv->atl_ints[queue_entry].qh = NULL;
1143 free_mem(priv, payload);
1145 isp1760_writel(skip_map, usb_hcd->regs +
1146 HC_ATL_PTD_SKIPMAP_REG);
1148 if (urb->status == -EPIPE) {
1149 /* HALT was received */
1151 qtd = clean_up_qtdlist(qtd);
1152 isp1760_urb_done(priv, urb, urb->status);
1154 } else if (usb_pipebulk(urb->pipe) && (length < qtd->length)) {
1155 /* short BULK received */
1157 if (urb->transfer_flags & URB_SHORT_NOT_OK) {
1158 urb->status = -EREMOTEIO;
1159 isp1760_dbg(priv, "short bulk, %d instead %zu "
1160 "with URB_SHORT_NOT_OK flag.\n",
1161 length, qtd->length);
1164 if (urb->status == -EINPROGRESS)
1167 qtd = clean_up_qtdlist(qtd);
1169 isp1760_urb_done(priv, urb, urb->status);
1171 } else if (qtd->status & URB_COMPLETE_NOTIFY) {
1172 /* that was the last qtd of that URB */
1174 if (urb->status == -EINPROGRESS)
1177 qtd = clean_this_qtd(qtd);
1178 isp1760_urb_done(priv, urb, urb->status);
1181 /* next QTD of this URB */
1183 qtd = clean_this_qtd(qtd);
1188 enqueue_an_ATL_packet(usb_hcd, qh, qtd);
1190 skip_map = isp1760_readl(usb_hcd->regs +
1191 HC_ATL_PTD_SKIPMAP_REG);
1195 static void do_intl_int(struct usb_hcd *usb_hcd)
1197 struct isp1760_hcd *priv = hcd_to_priv(usb_hcd);
1198 u32 done_map, skip_map;
1200 struct urb *urb = NULL;
1208 struct isp1760_qtd *qtd;
1209 struct isp1760_qh *qh;
1211 done_map = isp1760_readl(usb_hcd->regs +
1212 HC_INT_PTD_DONEMAP_REG);
1213 skip_map = isp1760_readl(usb_hcd->regs +
1214 HC_INT_PTD_SKIPMAP_REG);
1216 or_map = isp1760_readl(usb_hcd->regs + HC_INT_IRQ_MASK_OR_REG);
1217 or_map &= ~done_map;
1218 isp1760_writel(or_map, usb_hcd->regs + HC_INT_IRQ_MASK_OR_REG);
1220 int_regs_base = INT_REGS_OFFSET;
1226 queue_entry = __ffs(done_map);
1227 done_map &= ~(1 << queue_entry);
1228 skip_map |= 1 << queue_entry;
1230 int_regs = int_regs_base + queue_entry * sizeof(struct ptd);
1231 urb = priv->int_ints[queue_entry].urb;
1232 qtd = priv->int_ints[queue_entry].qtd;
1233 qh = priv->int_ints[queue_entry].qh;
1234 payload = priv->int_ints[queue_entry].payload;
1237 printk(KERN_ERR "(INT) qh is 0\n");
1241 isp1760_writel(int_regs + ISP_BANK(0), usb_hcd->regs +
1243 isp1760_writel(payload + ISP_BANK(1), usb_hcd->regs +
1246 * write bank1 address twice to ensure the 90ns delay (time
1247 * between BANK0 write and the priv_read_copy() call is at
1248 * least 3*t_WHWL + 2*t_w11 = 3*25ns + 2*17ns = 92ns)
1250 isp1760_writel(payload + ISP_BANK(1), usb_hcd->regs +
1253 priv_read_copy(priv, (u32 *)&ptd, usb_hcd->regs + int_regs +
1254 ISP_BANK(0), sizeof(ptd));
1255 dw1 = le32_to_cpu(ptd.dw1);
1256 dw3 = le32_to_cpu(ptd.dw3);
1257 check_int_err_status(le32_to_cpu(ptd.dw4));
1259 error = check_error(&ptd);
1262 printk(KERN_ERR "Error in %s().\n", __func__);
1263 printk(KERN_ERR "IN dw0: %08x dw1: %08x dw2: %08x "
1264 "dw3: %08x dw4: %08x dw5: %08x dw6: "
1266 ptd.dw0, ptd.dw1, ptd.dw2, ptd.dw3,
1267 ptd.dw4, ptd.dw5, ptd.dw6, ptd.dw7);
1269 urb->status = -EPIPE;
1270 priv->int_ints[queue_entry].qh->toggle = 0;
1271 priv->int_ints[queue_entry].qh->ping = 0;
1274 priv->int_ints[queue_entry].qh->toggle =
1276 priv->int_ints[queue_entry].qh->ping = dw3 & (1 << 26);
1279 if (urb->dev->speed != USB_SPEED_HIGH)
1280 length = PTD_XFERRED_LENGTH_LO(dw3);
1282 length = PTD_XFERRED_LENGTH(dw3);
1285 switch (DW1_GET_PID(dw1)) {
1287 priv_read_copy(priv,
1288 priv->int_ints[queue_entry].data_buffer,
1289 usb_hcd->regs + payload + ISP_BANK(1),
1293 urb->actual_length += length;
1300 priv->int_ints[queue_entry].data_buffer = NULL;
1301 priv->int_ints[queue_entry].urb = NULL;
1302 priv->int_ints[queue_entry].qtd = NULL;
1303 priv->int_ints[queue_entry].qh = NULL;
1305 isp1760_writel(skip_map, usb_hcd->regs +
1306 HC_INT_PTD_SKIPMAP_REG);
1307 free_mem(priv, payload);
1309 if (urb->status == -EPIPE) {
1312 qtd = clean_up_qtdlist(qtd);
1313 isp1760_urb_done(priv, urb, urb->status);
1315 } else if (qtd->status & URB_COMPLETE_NOTIFY) {
1317 if (urb->status == -EINPROGRESS)
1320 qtd = clean_this_qtd(qtd);
1321 isp1760_urb_done(priv, urb, urb->status);
1324 /* next QTD of this URB */
1326 qtd = clean_this_qtd(qtd);
1331 enqueue_an_INT_packet(usb_hcd, qh, qtd);
1333 skip_map = isp1760_readl(usb_hcd->regs +
1334 HC_INT_PTD_SKIPMAP_REG);
1338 #define max_packet(wMaxPacketSize) ((wMaxPacketSize) & 0x07ff)
1339 static struct isp1760_qh *qh_make(struct isp1760_hcd *priv, struct urb *urb,
1342 struct isp1760_qh *qh;
1345 qh = isp1760_qh_alloc(priv, flags);
1350 * init endpoint/device data for this QH
1352 is_input = usb_pipein(urb->pipe);
1353 type = usb_pipetype(urb->pipe);
1355 if (type == PIPE_INTERRUPT) {
1357 if (urb->dev->speed == USB_SPEED_HIGH) {
1359 qh->period = urb->interval >> 3;
1360 if (qh->period == 0 && urb->interval != 1) {
1361 /* NOTE interval 2 or 4 uframes could work.
1362 * But interval 1 scheduling is simpler, and
1363 * includes high bandwidth.
1365 printk(KERN_ERR "intr period %d uframes, NYET!",
1371 qh->period = urb->interval;
1375 /* support for tt scheduling, and access to toggles */
1378 if (!usb_pipecontrol(urb->pipe))
1379 usb_settoggle(urb->dev, usb_pipeendpoint(urb->pipe), !is_input,
1385 * For control/bulk/interrupt, return QH with these TDs appended.
1386 * Allocates and initializes the QH if necessary.
1387 * Returns null if it can't allocate a QH it needs to.
1388 * If the QH has TDs (urbs) already, that's great.
1390 static struct isp1760_qh *qh_append_tds(struct isp1760_hcd *priv,
1391 struct urb *urb, struct list_head *qtd_list, int epnum,
1394 struct isp1760_qh *qh;
1395 struct isp1760_qtd *qtd;
1396 struct isp1760_qtd *prev_qtd;
1398 qh = (struct isp1760_qh *)*ptr;
1400 /* can't sleep here, we have priv->lock... */
1401 qh = qh_make(priv, urb, GFP_ATOMIC);
1407 qtd = list_entry(qtd_list->next, struct isp1760_qtd,
1409 if (!list_empty(&qh->qtd_list))
1410 prev_qtd = list_entry(qh->qtd_list.prev,
1411 struct isp1760_qtd, qtd_list);
1415 list_splice(qtd_list, qh->qtd_list.prev);
1417 BUG_ON(prev_qtd->hw_next);
1418 prev_qtd->hw_next = qtd;
1425 static void qtd_list_free(struct isp1760_hcd *priv, struct urb *urb,
1426 struct list_head *qtd_list)
1428 struct list_head *entry, *temp;
1430 list_for_each_safe(entry, temp, qtd_list) {
1431 struct isp1760_qtd *qtd;
1433 qtd = list_entry(entry, struct isp1760_qtd, qtd_list);
1434 list_del(&qtd->qtd_list);
1435 isp1760_qtd_free(qtd);
1439 static int isp1760_prepare_enqueue(struct isp1760_hcd *priv, struct urb *urb,
1440 struct list_head *qtd_list, gfp_t mem_flags, packet_enqueue *p)
1442 struct isp1760_qtd *qtd;
1444 unsigned long flags;
1445 struct isp1760_qh *qh = NULL;
1449 qtd = list_entry(qtd_list->next, struct isp1760_qtd, qtd_list);
1450 epnum = urb->ep->desc.bEndpointAddress;
1452 spin_lock_irqsave(&priv->lock, flags);
1453 if (!test_bit(HCD_FLAG_HW_ACCESSIBLE, &priv_to_hcd(priv)->flags)) {
1457 rc = usb_hcd_link_urb_to_ep(priv_to_hcd(priv), urb);
1461 qh = urb->ep->hcpriv;
1463 qh_busy = !list_empty(&qh->qtd_list);
1467 qh = qh_append_tds(priv, urb, qtd_list, epnum, &urb->ep->hcpriv);
1469 usb_hcd_unlink_urb_from_ep(priv_to_hcd(priv), urb);
1475 p(priv_to_hcd(priv), qh, qtd);
1478 spin_unlock_irqrestore(&priv->lock, flags);
1480 qtd_list_free(priv, urb, qtd_list);
1484 static struct isp1760_qtd *isp1760_qtd_alloc(struct isp1760_hcd *priv,
1487 struct isp1760_qtd *qtd;
1489 qtd = kmem_cache_zalloc(qtd_cachep, flags);
1491 INIT_LIST_HEAD(&qtd->qtd_list);
1497 * create a list of filled qtds for this URB; won't link into qh.
1499 static struct list_head *qh_urb_transaction(struct isp1760_hcd *priv,
1500 struct urb *urb, struct list_head *head, gfp_t flags)
1502 struct isp1760_qtd *qtd, *qtd_prev;
1509 * URBs map to sequences of QTDs: one logical transaction
1511 qtd = isp1760_qtd_alloc(priv, flags);
1515 list_add_tail(&qtd->qtd_list, head);
1517 urb->status = -EINPROGRESS;
1520 /* for split transactions, SplitXState initialized to zero */
1522 len = urb->transfer_buffer_length;
1523 is_input = usb_pipein(urb->pipe);
1524 if (usb_pipecontrol(urb->pipe)) {
1526 qtd_fill(qtd, urb->setup_packet,
1527 sizeof(struct usb_ctrlrequest),
1530 /* ... and always at least one more pid */
1531 token ^= DATA_TOGGLE;
1533 qtd = isp1760_qtd_alloc(priv, flags);
1537 qtd_prev->hw_next = qtd;
1538 list_add_tail(&qtd->qtd_list, head);
1540 /* for zero length DATA stages, STATUS is always IN */
1546 * data transfer stage: buffer setup
1548 buf = urb->transfer_buffer;
1555 maxpacket = max_packet(usb_maxpacket(urb->dev, urb->pipe, !is_input));
1558 * buffer gets wrapped in one or more qtds;
1559 * last one may be "short" (including zero len)
1560 * and may serve as a control status ack
1566 /* XXX This looks like usb storage / SCSI bug */
1567 printk(KERN_ERR "buf is null, dma is %08lx len is %d\n",
1568 (long unsigned)urb->transfer_dma, len);
1572 this_qtd_len = qtd_fill(qtd, buf, len, token);
1573 len -= this_qtd_len;
1574 buf += this_qtd_len;
1576 /* qh makes control packets use qtd toggle; maybe switch it */
1577 if ((maxpacket & (this_qtd_len + (maxpacket - 1))) == 0)
1578 token ^= DATA_TOGGLE;
1584 qtd = isp1760_qtd_alloc(priv, flags);
1588 qtd_prev->hw_next = qtd;
1589 list_add_tail(&qtd->qtd_list, head);
1593 * control requests may need a terminating data "status" ack;
1594 * bulk ones may need a terminating short packet (zero length).
1596 if (urb->transfer_buffer_length != 0) {
1599 if (usb_pipecontrol(urb->pipe)) {
1601 /* "in" <--> "out" */
1604 token |= DATA_TOGGLE;
1605 } else if (usb_pipebulk(urb->pipe)
1606 && (urb->transfer_flags & URB_ZERO_PACKET)
1607 && !(urb->transfer_buffer_length % maxpacket)) {
1612 qtd = isp1760_qtd_alloc(priv, flags);
1616 qtd_prev->hw_next = qtd;
1617 list_add_tail(&qtd->qtd_list, head);
1619 /* never any data in such packets */
1620 qtd_fill(qtd, NULL, 0, token);
1624 qtd->status = URB_COMPLETE_NOTIFY;
1628 qtd_list_free(priv, urb, head);
1632 static int isp1760_urb_enqueue(struct usb_hcd *hcd, struct urb *urb,
1635 struct isp1760_hcd *priv = hcd_to_priv(hcd);
1636 struct list_head qtd_list;
1639 INIT_LIST_HEAD(&qtd_list);
1641 switch (usb_pipetype(urb->pipe)) {
1645 if (!qh_urb_transaction(priv, urb, &qtd_list, mem_flags))
1647 pe = enqueue_an_ATL_packet;
1650 case PIPE_INTERRUPT:
1651 if (!qh_urb_transaction(priv, urb, &qtd_list, mem_flags))
1653 pe = enqueue_an_INT_packet;
1656 case PIPE_ISOCHRONOUS:
1657 printk(KERN_ERR "PIPE_ISOCHRONOUS ain't supported\n");
1662 return isp1760_prepare_enqueue(priv, urb, &qtd_list, mem_flags, pe);
1665 static int isp1760_urb_dequeue(struct usb_hcd *hcd, struct urb *urb,
1668 struct isp1760_hcd *priv = hcd_to_priv(hcd);
1669 struct inter_packet_info *ints;
1671 u32 reg_base, or_reg, skip_reg;
1672 unsigned long flags;
1676 switch (usb_pipetype(urb->pipe)) {
1677 case PIPE_ISOCHRONOUS:
1681 case PIPE_INTERRUPT:
1682 ints = priv->int_ints;
1683 reg_base = INT_REGS_OFFSET;
1684 or_reg = HC_INT_IRQ_MASK_OR_REG;
1685 skip_reg = HC_INT_PTD_SKIPMAP_REG;
1686 pe = enqueue_an_INT_packet;
1690 ints = priv->atl_ints;
1691 reg_base = ATL_REGS_OFFSET;
1692 or_reg = HC_ATL_IRQ_MASK_OR_REG;
1693 skip_reg = HC_ATL_PTD_SKIPMAP_REG;
1694 pe = enqueue_an_ATL_packet;
1698 memset(&ptd, 0, sizeof(ptd));
1699 spin_lock_irqsave(&priv->lock, flags);
1701 for (i = 0; i < 32; i++) {
1702 if (ints->urb == urb) {
1705 struct isp1760_qtd *qtd;
1706 struct isp1760_qh *qh = ints->qh;
1708 skip_map = isp1760_readl(hcd->regs + skip_reg);
1710 isp1760_writel(skip_map, hcd->regs + skip_reg);
1712 or_map = isp1760_readl(hcd->regs + or_reg);
1713 or_map &= ~(1 << i);
1714 isp1760_writel(or_map, hcd->regs + or_reg);
1716 priv_write_copy(priv, (u32 *)&ptd, hcd->regs + reg_base
1717 + i * sizeof(ptd), sizeof(ptd));
1719 qtd = clean_up_qtdlist(qtd);
1721 free_mem(priv, ints->payload);
1726 ints->data_buffer = NULL;
1729 isp1760_urb_done(priv, urb, status);
1734 } else if (ints->qtd) {
1735 struct isp1760_qtd *qtd, *prev_qtd = ints->qtd;
1737 for (qtd = ints->qtd->hw_next; qtd; qtd = qtd->hw_next) {
1738 if (qtd->urb == urb) {
1739 prev_qtd->hw_next = clean_up_qtdlist(qtd);
1740 isp1760_urb_done(priv, urb, status);
1745 /* we found the urb before the end of the list */
1752 spin_unlock_irqrestore(&priv->lock, flags);
1756 static irqreturn_t isp1760_irq(struct usb_hcd *usb_hcd)
1758 struct isp1760_hcd *priv = hcd_to_priv(usb_hcd);
1760 irqreturn_t irqret = IRQ_NONE;
1762 spin_lock(&priv->lock);
1764 if (!(usb_hcd->state & HC_STATE_RUNNING))
1767 imask = isp1760_readl(usb_hcd->regs + HC_INTERRUPT_REG);
1768 if (unlikely(!imask))
1771 isp1760_writel(imask, usb_hcd->regs + HC_INTERRUPT_REG);
1772 if (imask & HC_ATL_INT)
1773 do_atl_int(usb_hcd);
1775 if (imask & HC_INTL_INT)
1776 do_intl_int(usb_hcd);
1778 irqret = IRQ_HANDLED;
1780 spin_unlock(&priv->lock);
1784 static int isp1760_hub_status_data(struct usb_hcd *hcd, char *buf)
1786 struct isp1760_hcd *priv = hcd_to_priv(hcd);
1787 u32 temp, status = 0;
1790 unsigned long flags;
1792 /* if !USB_SUSPEND, root hub timers won't get shut down ... */
1793 if (!HC_IS_RUNNING(hcd->state))
1796 /* init status to no-changes */
1800 spin_lock_irqsave(&priv->lock, flags);
1801 temp = isp1760_readl(hcd->regs + HC_PORTSC1);
1803 if (temp & PORT_OWNER) {
1804 if (temp & PORT_CSC) {
1806 isp1760_writel(temp, hcd->regs + HC_PORTSC1);
1812 * Return status information even for ports with OWNER set.
1813 * Otherwise khubd wouldn't see the disconnect event when a
1814 * high-speed device is switched over to the companion
1815 * controller by the user.
1818 if ((temp & mask) != 0
1819 || ((temp & PORT_RESUME) != 0
1820 && time_after_eq(jiffies,
1821 priv->reset_done))) {
1822 buf [0] |= 1 << (0 + 1);
1825 /* FIXME autosuspend idle root hubs */
1827 spin_unlock_irqrestore(&priv->lock, flags);
1828 return status ? retval : 0;
1831 static void isp1760_hub_descriptor(struct isp1760_hcd *priv,
1832 struct usb_hub_descriptor *desc)
1834 int ports = HCS_N_PORTS(priv->hcs_params);
1837 desc->bDescriptorType = 0x29;
1838 /* priv 1.0, 2.3.9 says 20ms max */
1839 desc->bPwrOn2PwrGood = 10;
1840 desc->bHubContrCurrent = 0;
1842 desc->bNbrPorts = ports;
1843 temp = 1 + (ports / 8);
1844 desc->bDescLength = 7 + 2 * temp;
1846 /* two bitmaps: ports removable, and usb 1.0 legacy PortPwrCtrlMask */
1847 memset(&desc->bitmap[0], 0, temp);
1848 memset(&desc->bitmap[temp], 0xff, temp);
1850 /* per-port overcurrent reporting */
1852 if (HCS_PPC(priv->hcs_params))
1853 /* per-port power control */
1856 /* no power switching */
1858 desc->wHubCharacteristics = cpu_to_le16(temp);
1861 #define PORT_WAKE_BITS (PORT_WKOC_E|PORT_WKDISC_E|PORT_WKCONN_E)
1863 static int check_reset_complete(struct isp1760_hcd *priv, int index,
1864 u32 __iomem *status_reg, int port_status)
1866 if (!(port_status & PORT_CONNECT))
1869 /* if reset finished and it's still not enabled -- handoff */
1870 if (!(port_status & PORT_PE)) {
1872 printk(KERN_ERR "port %d full speed --> companion\n",
1875 port_status |= PORT_OWNER;
1876 port_status &= ~PORT_RWC_BITS;
1877 isp1760_writel(port_status, status_reg);
1880 printk(KERN_ERR "port %d high speed\n", index + 1);
1885 static int isp1760_hub_control(struct usb_hcd *hcd, u16 typeReq,
1886 u16 wValue, u16 wIndex, char *buf, u16 wLength)
1888 struct isp1760_hcd *priv = hcd_to_priv(hcd);
1889 int ports = HCS_N_PORTS(priv->hcs_params);
1890 u32 __iomem *status_reg = hcd->regs + HC_PORTSC1;
1892 unsigned long flags;
1897 * FIXME: support SetPortFeatures USB_PORT_FEAT_INDICATOR.
1898 * HCS_INDICATOR may say we can change LEDs to off/amber/green.
1899 * (track current state ourselves) ... blink for diagnostics,
1900 * power, "this is the one", etc. EHCI spec supports this.
1903 spin_lock_irqsave(&priv->lock, flags);
1905 case ClearHubFeature:
1907 case C_HUB_LOCAL_POWER:
1908 case C_HUB_OVER_CURRENT:
1909 /* no hub-wide feature/status flags */
1915 case ClearPortFeature:
1916 if (!wIndex || wIndex > ports)
1919 temp = isp1760_readl(status_reg);
1922 * Even if OWNER is set, so the port is owned by the
1923 * companion controller, khubd needs to be able to clear
1924 * the port-change status bits (especially
1925 * USB_PORT_STAT_C_CONNECTION).
1929 case USB_PORT_FEAT_ENABLE:
1930 isp1760_writel(temp & ~PORT_PE, status_reg);
1932 case USB_PORT_FEAT_C_ENABLE:
1935 case USB_PORT_FEAT_SUSPEND:
1936 if (temp & PORT_RESET)
1939 if (temp & PORT_SUSPEND) {
1940 if ((temp & PORT_PE) == 0)
1942 /* resume signaling for 20 msec */
1943 temp &= ~(PORT_RWC_BITS);
1944 isp1760_writel(temp | PORT_RESUME,
1946 priv->reset_done = jiffies +
1947 msecs_to_jiffies(20);
1950 case USB_PORT_FEAT_C_SUSPEND:
1951 /* we auto-clear this feature */
1953 case USB_PORT_FEAT_POWER:
1954 if (HCS_PPC(priv->hcs_params))
1955 isp1760_writel(temp & ~PORT_POWER, status_reg);
1957 case USB_PORT_FEAT_C_CONNECTION:
1958 isp1760_writel(temp | PORT_CSC,
1961 case USB_PORT_FEAT_C_OVER_CURRENT:
1964 case USB_PORT_FEAT_C_RESET:
1965 /* GetPortStatus clears reset */
1970 isp1760_readl(hcd->regs + HC_USBCMD);
1972 case GetHubDescriptor:
1973 isp1760_hub_descriptor(priv, (struct usb_hub_descriptor *)
1977 /* no hub-wide feature/status flags */
1981 if (!wIndex || wIndex > ports)
1985 temp = isp1760_readl(status_reg);
1987 /* wPortChange bits */
1988 if (temp & PORT_CSC)
1989 status |= USB_PORT_STAT_C_CONNECTION << 16;
1992 /* whoever resumes must GetPortStatus to complete it!! */
1993 if (temp & PORT_RESUME) {
1994 printk(KERN_ERR "Port resume should be skipped.\n");
1996 /* Remote Wakeup received? */
1997 if (!priv->reset_done) {
1998 /* resume signaling for 20 msec */
1999 priv->reset_done = jiffies
2000 + msecs_to_jiffies(20);
2001 /* check the port again */
2002 mod_timer(&priv_to_hcd(priv)->rh_timer,
2006 /* resume completed? */
2007 else if (time_after_eq(jiffies,
2008 priv->reset_done)) {
2009 status |= USB_PORT_STAT_C_SUSPEND << 16;
2010 priv->reset_done = 0;
2012 /* stop resume signaling */
2013 temp = isp1760_readl(status_reg);
2015 temp & ~(PORT_RWC_BITS | PORT_RESUME),
2017 retval = handshake(priv, status_reg,
2018 PORT_RESUME, 0, 2000 /* 2msec */);
2021 "port %d resume error %d\n",
2022 wIndex + 1, retval);
2025 temp &= ~(PORT_SUSPEND|PORT_RESUME|(3<<10));
2029 /* whoever resets must GetPortStatus to complete it!! */
2030 if ((temp & PORT_RESET)
2031 && time_after_eq(jiffies,
2032 priv->reset_done)) {
2033 status |= USB_PORT_STAT_C_RESET << 16;
2034 priv->reset_done = 0;
2036 /* force reset to complete */
2037 isp1760_writel(temp & ~PORT_RESET,
2039 /* REVISIT: some hardware needs 550+ usec to clear
2040 * this bit; seems too long to spin routinely...
2042 retval = handshake(priv, status_reg,
2043 PORT_RESET, 0, 750);
2045 isp1760_err(priv, "port %d reset error %d\n",
2046 wIndex + 1, retval);
2050 /* see what we found out */
2051 temp = check_reset_complete(priv, wIndex, status_reg,
2052 isp1760_readl(status_reg));
2055 * Even if OWNER is set, there's no harm letting khubd
2056 * see the wPortStatus values (they should all be 0 except
2057 * for PORT_POWER anyway).
2060 if (temp & PORT_OWNER)
2061 printk(KERN_ERR "Warning: PORT_OWNER is set\n");
2063 if (temp & PORT_CONNECT) {
2064 status |= USB_PORT_STAT_CONNECTION;
2065 /* status may be from integrated TT */
2066 status |= ehci_port_speed(priv, temp);
2069 status |= USB_PORT_STAT_ENABLE;
2070 if (temp & (PORT_SUSPEND|PORT_RESUME))
2071 status |= USB_PORT_STAT_SUSPEND;
2072 if (temp & PORT_RESET)
2073 status |= USB_PORT_STAT_RESET;
2074 if (temp & PORT_POWER)
2075 status |= USB_PORT_STAT_POWER;
2077 put_unaligned(cpu_to_le32(status), (__le32 *) buf);
2081 case C_HUB_LOCAL_POWER:
2082 case C_HUB_OVER_CURRENT:
2083 /* no hub-wide feature/status flags */
2089 case SetPortFeature:
2090 selector = wIndex >> 8;
2092 if (!wIndex || wIndex > ports)
2095 temp = isp1760_readl(status_reg);
2096 if (temp & PORT_OWNER)
2099 /* temp &= ~PORT_RWC_BITS; */
2101 case USB_PORT_FEAT_ENABLE:
2102 isp1760_writel(temp | PORT_PE, status_reg);
2105 case USB_PORT_FEAT_SUSPEND:
2106 if ((temp & PORT_PE) == 0
2107 || (temp & PORT_RESET) != 0)
2110 isp1760_writel(temp | PORT_SUSPEND, status_reg);
2112 case USB_PORT_FEAT_POWER:
2113 if (HCS_PPC(priv->hcs_params))
2114 isp1760_writel(temp | PORT_POWER,
2117 case USB_PORT_FEAT_RESET:
2118 if (temp & PORT_RESUME)
2120 /* line status bits may report this as low speed,
2121 * which can be fine if this root hub has a
2122 * transaction translator built in.
2124 if ((temp & (PORT_PE|PORT_CONNECT)) == PORT_CONNECT
2125 && PORT_USB11(temp)) {
2132 * caller must wait, then call GetPortStatus
2133 * usb 2.0 spec says 50 ms resets on root
2135 priv->reset_done = jiffies +
2136 msecs_to_jiffies(50);
2138 isp1760_writel(temp, status_reg);
2143 isp1760_readl(hcd->regs + HC_USBCMD);
2148 /* "stall" on error */
2151 spin_unlock_irqrestore(&priv->lock, flags);
2155 static void isp1760_endpoint_disable(struct usb_hcd *usb_hcd,
2156 struct usb_host_endpoint *ep)
2158 struct isp1760_hcd *priv = hcd_to_priv(usb_hcd);
2159 struct isp1760_qh *qh;
2160 struct isp1760_qtd *qtd;
2161 unsigned long flags;
2163 spin_lock_irqsave(&priv->lock, flags);
2170 /* more than entry might get removed */
2171 if (list_empty(&qh->qtd_list))
2174 qtd = list_first_entry(&qh->qtd_list, struct isp1760_qtd,
2177 if (qtd->status & URB_ENQUEUED) {
2179 spin_unlock_irqrestore(&priv->lock, flags);
2180 isp1760_urb_dequeue(usb_hcd, qtd->urb, -ECONNRESET);
2181 spin_lock_irqsave(&priv->lock, flags);
2186 clean_up_qtdlist(qtd);
2187 isp1760_urb_done(priv, urb, -ECONNRESET);
2192 /* remove requests and leak them.
2193 * ATL are pretty fast done, INT could take a while...
2194 * The latter shoule be removed
2197 spin_unlock_irqrestore(&priv->lock, flags);
2200 static int isp1760_get_frame(struct usb_hcd *hcd)
2202 struct isp1760_hcd *priv = hcd_to_priv(hcd);
2205 fr = isp1760_readl(hcd->regs + HC_FRINDEX);
2206 return (fr >> 3) % priv->periodic_size;
2209 static void isp1760_stop(struct usb_hcd *hcd)
2211 struct isp1760_hcd *priv = hcd_to_priv(hcd);
2214 isp1760_hub_control(hcd, ClearPortFeature, USB_PORT_FEAT_POWER, 1,
2218 spin_lock_irq(&priv->lock);
2221 temp = isp1760_readl(hcd->regs + HC_HW_MODE_CTRL);
2222 isp1760_writel(temp &= ~HW_GLOBAL_INTR_EN, hcd->regs + HC_HW_MODE_CTRL);
2223 spin_unlock_irq(&priv->lock);
2225 isp1760_writel(0, hcd->regs + HC_CONFIGFLAG);
2228 static void isp1760_shutdown(struct usb_hcd *hcd)
2233 temp = isp1760_readl(hcd->regs + HC_HW_MODE_CTRL);
2234 isp1760_writel(temp &= ~HW_GLOBAL_INTR_EN, hcd->regs + HC_HW_MODE_CTRL);
2236 command = isp1760_readl(hcd->regs + HC_USBCMD);
2237 command &= ~CMD_RUN;
2238 isp1760_writel(command, hcd->regs + HC_USBCMD);
2241 static const struct hc_driver isp1760_hc_driver = {
2242 .description = "isp1760-hcd",
2243 .product_desc = "NXP ISP1760 USB Host Controller",
2244 .hcd_priv_size = sizeof(struct isp1760_hcd),
2246 .flags = HCD_MEMORY | HCD_USB2,
2247 .reset = isp1760_hc_setup,
2248 .start = isp1760_run,
2249 .stop = isp1760_stop,
2250 .shutdown = isp1760_shutdown,
2251 .urb_enqueue = isp1760_urb_enqueue,
2252 .urb_dequeue = isp1760_urb_dequeue,
2253 .endpoint_disable = isp1760_endpoint_disable,
2254 .get_frame_number = isp1760_get_frame,
2255 .hub_status_data = isp1760_hub_status_data,
2256 .hub_control = isp1760_hub_control,
2259 int __init init_kmem_once(void)
2261 qtd_cachep = kmem_cache_create("isp1760_qtd",
2262 sizeof(struct isp1760_qtd), 0, SLAB_TEMPORARY |
2263 SLAB_MEM_SPREAD, NULL);
2268 qh_cachep = kmem_cache_create("isp1760_qh", sizeof(struct isp1760_qh),
2269 0, SLAB_TEMPORARY | SLAB_MEM_SPREAD, NULL);
2272 kmem_cache_destroy(qtd_cachep);
2279 void deinit_kmem_cache(void)
2281 kmem_cache_destroy(qtd_cachep);
2282 kmem_cache_destroy(qh_cachep);
2285 struct usb_hcd *isp1760_register(phys_addr_t res_start, resource_size_t res_len,
2286 int irq, unsigned long irqflags,
2287 struct device *dev, const char *busname,
2288 unsigned int devflags)
2290 struct usb_hcd *hcd;
2291 struct isp1760_hcd *priv;
2295 return ERR_PTR(-ENODEV);
2297 /* prevent usb-core allocating DMA pages */
2298 dev->dma_mask = NULL;
2300 hcd = usb_create_hcd(&isp1760_hc_driver, dev, dev_name(dev));
2302 return ERR_PTR(-ENOMEM);
2304 priv = hcd_to_priv(hcd);
2305 priv->devflags = devflags;
2307 hcd->regs = ioremap(res_start, res_len);
2314 hcd->rsrc_start = res_start;
2315 hcd->rsrc_len = res_len;
2317 ret = usb_add_hcd(hcd, irq, irqflags);
2329 return ERR_PTR(ret);
2332 MODULE_DESCRIPTION("Driver for the ISP1760 USB-controller from NXP");
2333 MODULE_AUTHOR("Sebastian Siewior <bigeasy@linuxtronix.de>");
2334 MODULE_LICENSE("GPL v2");