2 * NetChip 2280 high/full speed USB device controller.
3 * Unlike many such controllers, this one talks PCI.
7 * Copyright (C) 2002 NetChip Technology, Inc. (http://www.netchip.com)
8 * Copyright (C) 2003 David Brownell
9 * Copyright (C) 2014 Ricardo Ribalda - Qtechnology/AS
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
17 #include <linux/usb/net2280.h>
18 #include <linux/usb/usb338x.h>
20 /*-------------------------------------------------------------------------*/
24 /* indexed registers [11.10] are accessed indirectly
25 * caller must own the device lock.
29 get_idx_reg (struct net2280_regs __iomem *regs, u32 index)
31 writel (index, ®s->idxaddr);
32 /* NOTE: synchs device/cpu memory views */
33 return readl (®s->idxdata);
37 set_idx_reg (struct net2280_regs __iomem *regs, u32 index, u32 value)
39 writel (index, ®s->idxaddr);
40 writel (value, ®s->idxdata);
41 /* posted, may not be visible yet */
44 #endif /* __KERNEL__ */
48 #define RETRY_COUNTER 16
49 #define FORCE_PCI_SERR 11
50 #define FORCE_PCI_INTERRUPT 10
51 #define FORCE_USB_INTERRUPT 9
52 #define FORCE_CPU_INTERRUPT 8
53 #define ILLEGAL_BYTE_ENABLES 5
55 #define FORCE_RECEIVE_ERROR 2
56 #define FORCE_TRANSMIT_CRC_ERROR 0
57 #define REG_FRAME 0x02 /* from last sof */
58 #define REG_CHIPREV 0x03 /* in bcd */
59 #define REG_HS_NAK_RATE 0x0a /* NAK per N uframes */
61 #define CHIPREV_1 0x0100
62 #define CHIPREV_1A 0x0110
65 #define DEFECT_7374_NUMBEROF_MAX_WAIT_LOOPS 200
66 #define DEFECT_7374_PROCESSOR_WAIT_TIME 10
68 /* ep0 max packet size */
69 #define EP0_SS_MAX_PACKET_SIZE 0x200
70 #define EP0_HS_MAX_PACKET_SIZE 0x40
73 /* ep a-f highspeed and fullspeed maxpacket, addresses
74 * computed from ep->num
76 #define REG_EP_MAXPKT(dev,num) (((num) + 1) * 0x10 + \
77 (((dev)->gadget.speed == USB_SPEED_HIGH) ? 0 : 1))
79 /*-------------------------------------------------------------------------*/
81 /* [8.3] for scatter/gather i/o
82 * use struct net2280_dma_regs bitfields
86 __le32 dmaaddr; /* the buffer */
87 __le32 dmadesc; /* next dma descriptor */
89 } __attribute__ ((aligned (16)));
91 /*-------------------------------------------------------------------------*/
93 /* DRIVER DATA STRUCTURES and UTILITIES */
97 struct net2280_ep_regs __iomem *cfg;
98 struct net2280_ep_regs __iomem *regs;
99 struct net2280_dma_regs __iomem *dma;
100 struct net2280_dma *dummy;
101 struct usb338x_fifo_regs __iomem *fiforegs;
102 dma_addr_t td_dma; /* of dummy */
105 unsigned is_halt:1, dma_started:1;
107 /* analogous to a host-side qh */
108 struct list_head queue;
109 const struct usb_endpoint_descriptor *desc;
112 in_fifo_validate : 1,
121 static inline void allow_status (struct net2280_ep *ep)
124 writel ( (1 << CLEAR_CONTROL_STATUS_PHASE_HANDSHAKE)
125 | (1 << CLEAR_NAK_OUT_PACKETS)
126 | (1 << CLEAR_NAK_OUT_PACKETS_MODE)
127 , &ep->regs->ep_rsp);
131 static void allow_status_338x(struct net2280_ep *ep)
134 * Control Status Phase Handshake was set by the chip when the setup
135 * packet arrived. While set, the chip automatically NAKs the host's
136 * Status Phase tokens.
138 writel(1 << CLEAR_CONTROL_STATUS_PHASE_HANDSHAKE, &ep->regs->ep_rsp);
142 /* TD 9.9 Halt Endpoint test. TD 9.22 set feature test. */
146 struct net2280_request {
147 struct usb_request req;
148 struct net2280_dma *td;
150 struct list_head queue;
156 /* each pci device provides one gadget, several endpoints */
157 struct usb_gadget gadget;
159 struct net2280_ep ep[9];
160 struct usb_gadget_driver *driver;
161 unsigned enabled : 1,
176 /* pci state used to access those endpoints */
177 struct pci_dev *pdev;
178 struct net2280_regs __iomem *regs;
179 struct net2280_usb_regs __iomem *usb;
180 struct usb338x_usb_ext_regs __iomem *usb_ext;
181 struct net2280_pci_regs __iomem *pci;
182 struct net2280_dma_regs __iomem *dma;
183 struct net2280_dep_regs __iomem *dep;
184 struct net2280_ep_regs __iomem *epregs;
185 struct usb338x_fifo_regs __iomem *fiforegs;
186 struct usb338x_ll_regs __iomem *llregs;
187 struct usb338x_ll_lfps_regs __iomem *ll_lfps_regs;
188 struct usb338x_ll_tsn_regs __iomem *ll_tsn_regs;
189 struct usb338x_ll_chi_regs __iomem *ll_chicken_reg;
190 struct usb338x_pl_regs __iomem *plregs;
192 struct pci_pool *requests;
196 static inline void set_halt (struct net2280_ep *ep)
198 /* ep0 and bulk/intr endpoints */
199 writel ( (1 << CLEAR_CONTROL_STATUS_PHASE_HANDSHAKE)
200 /* set NAK_OUT for erratum 0114 */
201 | ((ep->dev->chiprev == CHIPREV_1) << SET_NAK_OUT_PACKETS)
202 | (1 << SET_ENDPOINT_HALT)
203 , &ep->regs->ep_rsp);
206 static inline void clear_halt (struct net2280_ep *ep)
208 /* ep0 and bulk/intr endpoints */
209 writel ( (1 << CLEAR_ENDPOINT_HALT)
210 | (1 << CLEAR_ENDPOINT_TOGGLE)
211 /* unless the gadget driver left a short packet in the
212 * fifo, this reverses the erratum 0114 workaround.
214 | ((ep->dev->chiprev == CHIPREV_1) << CLEAR_NAK_OUT_PACKETS)
215 , &ep->regs->ep_rsp);
219 * FSM value for Defect 7374 (U1U2 Test) is managed in
220 * chip's SCRATCH register:
222 #define DEFECT7374_FSM_FIELD 28
224 /* Waiting for Control Read:
225 * - A transition to this state indicates a fresh USB connection,
226 * before the first Setup Packet. The connection speed is not
227 * known. Firmware is waiting for the first Control Read.
228 * - Starting state: This state can be thought of as the FSM's typical
230 * - Tip: Upon the first SS Control Read the FSM never
231 * returns to this state.
233 #define DEFECT7374_FSM_WAITING_FOR_CONTROL_READ (1 << DEFECT7374_FSM_FIELD)
235 /* Non-SS Control Read:
236 * - A transition to this state indicates detection of the first HS
237 * or FS Control Read.
238 * - Tip: Upon the first SS Control Read the FSM never
239 * returns to this state.
241 #define DEFECT7374_FSM_NON_SS_CONTROL_READ (2 << DEFECT7374_FSM_FIELD)
244 * - A transition to this state indicates detection of the
245 * first SS Control Read.
246 * - This state indicates workaround completion. Workarounds no longer
247 * need to be applied (as long as the chip remains powered up).
248 * - Tip: Once in this state the FSM state does not change (until
249 * the chip's power is lost and restored).
250 * - This can be thought of as the final state of the FSM;
251 * the FSM 'locks-up' in this state until the chip loses power.
253 #define DEFECT7374_FSM_SS_CONTROL_READ (3 << DEFECT7374_FSM_FIELD)
257 static inline void net2280_led_init (struct net2280 *dev)
259 /* LED3 (green) is on during USB activity. note erratum 0113. */
260 writel ((1 << GPIO3_LED_SELECT)
261 | (1 << GPIO3_OUTPUT_ENABLE)
262 | (1 << GPIO2_OUTPUT_ENABLE)
263 | (1 << GPIO1_OUTPUT_ENABLE)
264 | (1 << GPIO0_OUTPUT_ENABLE)
265 , &dev->regs->gpioctl);
268 /* indicate speed with bi-color LED 0/1 */
270 void net2280_led_speed (struct net2280 *dev, enum usb_device_speed speed)
272 u32 val = readl (&dev->regs->gpioctl);
274 case USB_SPEED_SUPER: /* green + red */
275 val |= (1 << GPIO0_DATA) | (1 << GPIO1_DATA);
277 case USB_SPEED_HIGH: /* green */
278 val &= ~(1 << GPIO0_DATA);
279 val |= (1 << GPIO1_DATA);
281 case USB_SPEED_FULL: /* red */
282 val &= ~(1 << GPIO1_DATA);
283 val |= (1 << GPIO0_DATA);
285 default: /* (off/black) */
286 val &= ~((1 << GPIO1_DATA) | (1 << GPIO0_DATA));
289 writel (val, &dev->regs->gpioctl);
292 /* indicate power with LED 2 */
293 static inline void net2280_led_active (struct net2280 *dev, int is_active)
295 u32 val = readl (&dev->regs->gpioctl);
297 // FIXME this LED never seems to turn on.
302 writel (val, &dev->regs->gpioctl);
304 static inline void net2280_led_shutdown (struct net2280 *dev)
306 /* turn off all four GPIO*_DATA bits */
307 writel (readl (&dev->regs->gpioctl) & ~0x0f,
308 &dev->regs->gpioctl);
313 #define net2280_led_init(dev) do { } while (0)
314 #define net2280_led_speed(dev, speed) do { } while (0)
315 #define net2280_led_shutdown(dev) do { } while (0)
319 /*-------------------------------------------------------------------------*/
321 #define xprintk(dev,level,fmt,args...) \
322 printk(level "%s %s: " fmt , driver_name , \
323 pci_name(dev->pdev) , ## args)
327 #define DEBUG(dev,fmt,args...) \
328 xprintk(dev , KERN_DEBUG , fmt , ## args)
330 #define DEBUG(dev,fmt,args...) \
337 #define VDEBUG(dev,fmt,args...) \
341 #define ERROR(dev,fmt,args...) \
342 xprintk(dev , KERN_ERR , fmt , ## args)
343 #define WARNING(dev,fmt,args...) \
344 xprintk(dev , KERN_WARNING , fmt , ## args)
345 #define INFO(dev,fmt,args...) \
346 xprintk(dev , KERN_INFO , fmt , ## args)
348 /*-------------------------------------------------------------------------*/
350 static inline void set_fifo_bytecount(struct net2280_ep *ep, unsigned count)
352 if (ep->dev->pdev->vendor == 0x17cc)
353 writeb(count, 2 + (u8 __iomem *) &ep->regs->ep_cfg);
355 u32 tmp = readl(&ep->cfg->ep_cfg) &
356 (~(0x07 << EP_FIFO_BYTE_COUNT));
357 writel(tmp | (count << EP_FIFO_BYTE_COUNT), &ep->cfg->ep_cfg);
361 static inline void start_out_naking (struct net2280_ep *ep)
363 /* NOTE: hardware races lurk here, and PING protocol issues */
364 writel ((1 << SET_NAK_OUT_PACKETS), &ep->regs->ep_rsp);
365 /* synch with device */
366 readl (&ep->regs->ep_rsp);
370 static inline void assert_out_naking (struct net2280_ep *ep, const char *where)
372 u32 tmp = readl (&ep->regs->ep_stat);
374 if ((tmp & (1 << NAK_OUT_PACKETS)) == 0) {
375 DEBUG (ep->dev, "%s %s %08x !NAK\n",
376 ep->ep.name, where, tmp);
377 writel ((1 << SET_NAK_OUT_PACKETS),
381 #define ASSERT_OUT_NAKING(ep) assert_out_naking(ep,__func__)
383 #define ASSERT_OUT_NAKING(ep) do {} while (0)
386 static inline void stop_out_naking (struct net2280_ep *ep)
390 tmp = readl (&ep->regs->ep_stat);
391 if ((tmp & (1 << NAK_OUT_PACKETS)) != 0)
392 writel ((1 << CLEAR_NAK_OUT_PACKETS), &ep->regs->ep_rsp);
395 #endif /* __KERNEL__ */