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.
28 static inline u32
get_idx_reg(struct net2280_regs __iomem
*regs
, u32 index
)
30 writel(index
, ®s
->idxaddr
);
31 /* NOTE: synchs device/cpu memory views */
32 return readl(®s
->idxdata
);
36 set_idx_reg(struct net2280_regs __iomem
*regs
, u32 index
, u32 value
)
38 writel(index
, ®s
->idxaddr
);
39 writel(value
, ®s
->idxdata
);
40 /* posted, may not be visible yet */
43 #endif /* __KERNEL__ */
45 #define PCI_VENDOR_ID_PLX_LEGACY 0x17cc
47 #define PLX_LEGACY BIT(0)
48 #define PLX_2280 BIT(1)
49 #define PLX_SUPERSPEED BIT(2)
52 #define RETRY_COUNTER 16
53 #define FORCE_PCI_SERR 11
54 #define FORCE_PCI_INTERRUPT 10
55 #define FORCE_USB_INTERRUPT 9
56 #define FORCE_CPU_INTERRUPT 8
57 #define ILLEGAL_BYTE_ENABLES 5
59 #define FORCE_RECEIVE_ERROR 2
60 #define FORCE_TRANSMIT_CRC_ERROR 0
61 #define REG_FRAME 0x02 /* from last sof */
62 #define REG_CHIPREV 0x03 /* in bcd */
63 #define REG_HS_NAK_RATE 0x0a /* NAK per N uframes */
65 #define CHIPREV_1 0x0100
66 #define CHIPREV_1A 0x0110
69 #define DEFECT_7374_NUMBEROF_MAX_WAIT_LOOPS 200
70 #define DEFECT_7374_PROCESSOR_WAIT_TIME 10
72 /* ep0 max packet size */
73 #define EP0_SS_MAX_PACKET_SIZE 0x200
74 #define EP0_HS_MAX_PACKET_SIZE 0x40
77 /*-------------------------------------------------------------------------*/
79 /* [8.3] for scatter/gather i/o
80 * use struct net2280_dma_regs bitfields
84 __le32 dmaaddr
; /* the buffer */
85 __le32 dmadesc
; /* next dma descriptor */
89 /*-------------------------------------------------------------------------*/
91 /* DRIVER DATA STRUCTURES and UTILITIES */
95 struct net2280_ep_regs __iomem
*cfg
;
96 struct net2280_ep_regs __iomem
*regs
;
97 struct net2280_dma_regs __iomem
*dma
;
98 struct net2280_dma
*dummy
;
99 dma_addr_t td_dma
; /* of dummy */
103 /* analogous to a host-side qh */
104 struct list_head queue
;
105 const struct usb_endpoint_descriptor
*desc
;
108 in_fifo_validate
: 1,
117 static inline void allow_status(struct net2280_ep
*ep
)
120 writel(BIT(CLEAR_CONTROL_STATUS_PHASE_HANDSHAKE
) |
121 BIT(CLEAR_NAK_OUT_PACKETS
) |
122 BIT(CLEAR_NAK_OUT_PACKETS_MODE
),
127 static inline void allow_status_338x(struct net2280_ep
*ep
)
130 * Control Status Phase Handshake was set by the chip when the setup
131 * packet arrived. While set, the chip automatically NAKs the host's
132 * Status Phase tokens.
134 writel(BIT(CLEAR_CONTROL_STATUS_PHASE_HANDSHAKE
), &ep
->regs
->ep_rsp
);
138 /* TD 9.9 Halt Endpoint test. TD 9.22 set feature test. */
142 struct net2280_request
{
143 struct usb_request req
;
144 struct net2280_dma
*td
;
146 struct list_head queue
;
152 /* each pci device provides one gadget, several endpoints */
153 struct usb_gadget gadget
;
155 struct net2280_ep ep
[9];
156 struct usb_gadget_driver
*driver
;
157 unsigned enabled
: 1,
171 kernel_ulong_t quirks
;
174 /* pci state used to access those endpoints */
175 struct pci_dev
*pdev
;
176 struct net2280_regs __iomem
*regs
;
177 struct net2280_usb_regs __iomem
*usb
;
178 struct usb338x_usb_ext_regs __iomem
*usb_ext
;
179 struct net2280_pci_regs __iomem
*pci
;
180 struct net2280_dma_regs __iomem
*dma
;
181 struct net2280_dep_regs __iomem
*dep
;
182 struct net2280_ep_regs __iomem
*epregs
;
183 struct usb338x_ll_regs __iomem
*llregs
;
184 struct usb338x_ll_lfps_regs __iomem
*ll_lfps_regs
;
185 struct usb338x_ll_tsn_regs __iomem
*ll_tsn_regs
;
186 struct usb338x_ll_chi_regs __iomem
*ll_chicken_reg
;
187 struct usb338x_pl_regs __iomem
*plregs
;
189 struct pci_pool
*requests
;
193 static inline void set_halt(struct net2280_ep
*ep
)
195 /* ep0 and bulk/intr endpoints */
196 writel(BIT(CLEAR_CONTROL_STATUS_PHASE_HANDSHAKE
) |
197 /* set NAK_OUT for erratum 0114 */
198 ((ep
->dev
->chiprev
== CHIPREV_1
) << SET_NAK_OUT_PACKETS
) |
199 BIT(SET_ENDPOINT_HALT
),
203 static inline void clear_halt(struct net2280_ep
*ep
)
205 /* ep0 and bulk/intr endpoints */
206 writel(BIT(CLEAR_ENDPOINT_HALT
) |
207 BIT(CLEAR_ENDPOINT_TOGGLE
) |
209 * unless the gadget driver left a short packet in the
210 * fifo, this reverses the erratum 0114 workaround.
212 ((ep
->dev
->chiprev
== CHIPREV_1
) << CLEAR_NAK_OUT_PACKETS
),
217 * FSM value for Defect 7374 (U1U2 Test) is managed in
218 * chip's SCRATCH register:
220 #define DEFECT7374_FSM_FIELD 28
222 /* Waiting for Control Read:
223 * - A transition to this state indicates a fresh USB connection,
224 * before the first Setup Packet. The connection speed is not
225 * known. Firmware is waiting for the first Control Read.
226 * - Starting state: This state can be thought of as the FSM's typical
228 * - Tip: Upon the first SS Control Read the FSM never
229 * returns to this state.
231 #define DEFECT7374_FSM_WAITING_FOR_CONTROL_READ BIT(DEFECT7374_FSM_FIELD)
233 /* Non-SS Control Read:
234 * - A transition to this state indicates detection of the first HS
235 * or FS Control Read.
236 * - Tip: Upon the first SS Control Read the FSM never
237 * returns to this state.
239 #define DEFECT7374_FSM_NON_SS_CONTROL_READ (2 << DEFECT7374_FSM_FIELD)
242 * - A transition to this state indicates detection of the
243 * first SS Control Read.
244 * - This state indicates workaround completion. Workarounds no longer
245 * need to be applied (as long as the chip remains powered up).
246 * - Tip: Once in this state the FSM state does not change (until
247 * the chip's power is lost and restored).
248 * - This can be thought of as the final state of the FSM;
249 * the FSM 'locks-up' in this state until the chip loses power.
251 #define DEFECT7374_FSM_SS_CONTROL_READ (3 << DEFECT7374_FSM_FIELD)
255 static inline void net2280_led_init(struct net2280
*dev
)
257 /* LED3 (green) is on during USB activity. note erratum 0113. */
258 writel(BIT(GPIO3_LED_SELECT
) |
259 BIT(GPIO3_OUTPUT_ENABLE
) |
260 BIT(GPIO2_OUTPUT_ENABLE
) |
261 BIT(GPIO1_OUTPUT_ENABLE
) |
262 BIT(GPIO0_OUTPUT_ENABLE
),
263 &dev
->regs
->gpioctl
);
266 /* indicate speed with bi-color LED 0/1 */
268 void net2280_led_speed(struct net2280
*dev
, enum usb_device_speed speed
)
270 u32 val
= readl(&dev
->regs
->gpioctl
);
272 case USB_SPEED_SUPER
: /* green + red */
273 val
|= BIT(GPIO0_DATA
) | BIT(GPIO1_DATA
);
275 case USB_SPEED_HIGH
: /* green */
276 val
&= ~BIT(GPIO0_DATA
);
277 val
|= BIT(GPIO1_DATA
);
279 case USB_SPEED_FULL
: /* red */
280 val
&= ~BIT(GPIO1_DATA
);
281 val
|= BIT(GPIO0_DATA
);
283 default: /* (off/black) */
284 val
&= ~(BIT(GPIO1_DATA
) | BIT(GPIO0_DATA
));
287 writel(val
, &dev
->regs
->gpioctl
);
290 /* indicate power with LED 2 */
291 static inline void net2280_led_active(struct net2280
*dev
, int is_active
)
293 u32 val
= readl(&dev
->regs
->gpioctl
);
295 /* FIXME this LED never seems to turn on.*/
300 writel(val
, &dev
->regs
->gpioctl
);
303 static inline void net2280_led_shutdown(struct net2280
*dev
)
305 /* turn off all four GPIO*_DATA bits */
306 writel(readl(&dev
->regs
->gpioctl
) & ~0x0f,
307 &dev
->regs
->gpioctl
);
312 #define net2280_led_init(dev) do { } while (0)
313 #define net2280_led_speed(dev, speed) do { } while (0)
314 #define net2280_led_shutdown(dev) do { } while (0)
318 /*-------------------------------------------------------------------------*/
320 #define ep_dbg(ndev, fmt, args...) \
321 dev_dbg((&((ndev)->pdev->dev)), fmt, ##args)
323 #define ep_vdbg(ndev, fmt, args...) \
324 dev_vdbg((&((ndev)->pdev->dev)), fmt, ##args)
326 #define ep_info(ndev, fmt, args...) \
327 dev_info((&((ndev)->pdev->dev)), fmt, ##args)
329 #define ep_warn(ndev, fmt, args...) \
330 dev_warn((&((ndev)->pdev->dev)), fmt, ##args)
332 #define ep_err(ndev, fmt, args...) \
333 dev_err((&((ndev)->pdev->dev)), fmt, ##args)
335 /*-------------------------------------------------------------------------*/
337 static inline void set_fifo_bytecount(struct net2280_ep
*ep
, unsigned count
)
339 if (ep
->dev
->pdev
->vendor
== 0x17cc)
340 writeb(count
, 2 + (u8 __iomem
*) &ep
->regs
->ep_cfg
);
342 u32 tmp
= readl(&ep
->cfg
->ep_cfg
) &
343 (~(0x07 << EP_FIFO_BYTE_COUNT
));
344 writel(tmp
| (count
<< EP_FIFO_BYTE_COUNT
), &ep
->cfg
->ep_cfg
);
348 static inline void start_out_naking(struct net2280_ep
*ep
)
350 /* NOTE: hardware races lurk here, and PING protocol issues */
351 writel(BIT(SET_NAK_OUT_PACKETS
), &ep
->regs
->ep_rsp
);
352 /* synch with device */
353 readl(&ep
->regs
->ep_rsp
);
356 static inline void stop_out_naking(struct net2280_ep
*ep
)
360 tmp
= readl(&ep
->regs
->ep_stat
);
361 if ((tmp
& BIT(NAK_OUT_PACKETS
)) != 0)
362 writel(BIT(CLEAR_NAK_OUT_PACKETS
), &ep
->regs
->ep_rsp
);
366 static inline void set_max_speed(struct net2280_ep
*ep
, u32 max
)
369 static const u32 ep_enhanced
[9] = { 0x10, 0x60, 0x30, 0x80,
370 0x50, 0x20, 0x70, 0x40, 0x90 };
372 if (ep
->dev
->enhanced_mode
)
373 reg
= ep_enhanced
[ep
->num
];
375 reg
= (ep
->num
+ 1) * 0x10;
376 if (ep
->dev
->gadget
.speed
!= USB_SPEED_HIGH
)
380 set_idx_reg(ep
->dev
->regs
, reg
, max
);
383 #endif /* __KERNEL__ */