2 * Copyright 2011, Marvell Semiconductor Inc.
3 * Lei Wen <leiwen@marvell.com>
5 * SPDX-License-Identifier: GPL-2.0+
7 * Back ported to the 8xx platform (from the 8260 platform) by
8 * Murray.Jensen@cmst.csiro.au, 27-Jan-01.
17 #include <linux/types.h>
18 #include <usb/mv_udc.h>
20 #if CONFIG_USB_MAX_CONTROLLER_COUNT > 1
21 #error This driver only supports one single controller.
25 * Check if the system has too long cachelines. If the cachelines are
26 * longer then 128b, the driver will not be able flush/invalidate data
27 * cache over separate QH entries. We use 128b because one QH entry is
28 * 64b long and there are always two QH list entries for each endpoint.
30 #if ARCH_DMA_MINALIGN > 128
31 #error This driver can not work on systems with caches longer than 128b
35 #define DBG(x...) do {} while (0)
37 #define DBG(x...) printf(x)
38 static const char *reqname(unsigned r)
41 case USB_REQ_GET_STATUS: return "GET_STATUS";
42 case USB_REQ_CLEAR_FEATURE: return "CLEAR_FEATURE";
43 case USB_REQ_SET_FEATURE: return "SET_FEATURE";
44 case USB_REQ_SET_ADDRESS: return "SET_ADDRESS";
45 case USB_REQ_GET_DESCRIPTOR: return "GET_DESCRIPTOR";
46 case USB_REQ_SET_DESCRIPTOR: return "SET_DESCRIPTOR";
47 case USB_REQ_GET_CONFIGURATION: return "GET_CONFIGURATION";
48 case USB_REQ_SET_CONFIGURATION: return "SET_CONFIGURATION";
49 case USB_REQ_GET_INTERFACE: return "GET_INTERFACE";
50 case USB_REQ_SET_INTERFACE: return "SET_INTERFACE";
51 default: return "*UNKNOWN*";
56 static struct usb_endpoint_descriptor ep0_out_desc = {
57 .bLength = sizeof(struct usb_endpoint_descriptor),
58 .bDescriptorType = USB_DT_ENDPOINT,
59 .bEndpointAddress = 0,
60 .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
63 static struct usb_endpoint_descriptor ep0_in_desc = {
64 .bLength = sizeof(struct usb_endpoint_descriptor),
65 .bDescriptorType = USB_DT_ENDPOINT,
66 .bEndpointAddress = USB_DIR_IN,
67 .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
70 static int mv_pullup(struct usb_gadget *gadget, int is_on);
71 static int mv_ep_enable(struct usb_ep *ep,
72 const struct usb_endpoint_descriptor *desc);
73 static int mv_ep_disable(struct usb_ep *ep);
74 static int mv_ep_queue(struct usb_ep *ep,
75 struct usb_request *req, gfp_t gfp_flags);
76 static struct usb_request *
77 mv_ep_alloc_request(struct usb_ep *ep, unsigned int gfp_flags);
78 static void mv_ep_free_request(struct usb_ep *ep, struct usb_request *_req);
80 static struct usb_gadget_ops mv_udc_ops = {
84 static struct usb_ep_ops mv_ep_ops = {
85 .enable = mv_ep_enable,
86 .disable = mv_ep_disable,
88 .alloc_request = mv_ep_alloc_request,
89 .free_request = mv_ep_free_request,
92 /* Init values for USB endpoints. */
93 static const struct usb_ep mv_ep_init[2] = {
106 static struct mv_drv controller = {
114 * mv_get_qh() - return queue head for endpoint
115 * @ep_num: Endpoint number
116 * @dir_in: Direction of the endpoint (IN = 1, OUT = 0)
118 * This function returns the QH associated with particular endpoint
119 * and it's direction.
121 static struct ept_queue_head *mv_get_qh(int ep_num, int dir_in)
123 return &controller.epts[(ep_num * 2) + dir_in];
127 * mv_get_qtd() - return queue item for endpoint
128 * @ep_num: Endpoint number
129 * @dir_in: Direction of the endpoint (IN = 1, OUT = 0)
131 * This function returns the QH associated with particular endpoint
132 * and it's direction.
134 static struct ept_queue_item *mv_get_qtd(int ep_num, int dir_in)
136 return controller.items[(ep_num * 2) + dir_in];
139 static struct usb_request *
140 mv_ep_alloc_request(struct usb_ep *ep, unsigned int gfp_flags)
142 struct mv_ep *mv_ep = container_of(ep, struct mv_ep, ep);
146 static void mv_ep_free_request(struct usb_ep *ep, struct usb_request *_req)
151 static void ep_enable(int num, int in)
153 struct ept_queue_head *head;
154 struct mv_udc *udc = (struct mv_udc *)controller.ctrl->hcor;
156 head = mv_get_qh(num, in);
158 n = readl(&udc->epctrl[num]);
160 n |= (CTRL_TXE | CTRL_TXR | CTRL_TXT_BULK);
162 n |= (CTRL_RXE | CTRL_RXR | CTRL_RXT_BULK);
165 head->config = CONFIG_MAX_PKT(EP_MAX_PACKET_SIZE) | CONFIG_ZLT;
166 writel(n, &udc->epctrl[num]);
169 static int mv_ep_enable(struct usb_ep *ep,
170 const struct usb_endpoint_descriptor *desc)
172 struct mv_ep *mv_ep = container_of(ep, struct mv_ep, ep);
174 num = desc->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
175 in = (desc->bEndpointAddress & USB_DIR_IN) != 0;
181 static int mv_ep_disable(struct usb_ep *ep)
186 static int mv_ep_queue(struct usb_ep *ep,
187 struct usb_request *req, gfp_t gfp_flags)
189 struct mv_ep *mv_ep = container_of(ep, struct mv_ep, ep);
190 struct mv_udc *udc = (struct mv_udc *)controller.ctrl->hcor;
191 struct ept_queue_item *item;
192 struct ept_queue_head *head;
194 int bit, num, len, in;
195 num = mv_ep->desc->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
196 in = (mv_ep->desc->bEndpointAddress & USB_DIR_IN) != 0;
197 item = mv_get_qtd(num, in);
198 head = mv_get_qh(num, in);
199 phys = (unsigned)req->buf;
202 item->next = TERMINATE;
203 item->info = INFO_BYTES(len) | INFO_IOC | INFO_ACTIVE;
205 item->page1 = (phys & 0xfffff000) + 0x1000;
207 head->next = (unsigned) item;
210 DBG("ept%d %s queue len %x, buffer %x\n",
211 num, in ? "in" : "out", len, phys);
218 flush_cache(phys, len);
219 flush_cache((unsigned long)item, sizeof(struct ept_queue_item));
220 writel(bit, &udc->epprime);
225 static void handle_ep_complete(struct mv_ep *ep)
227 struct ept_queue_item *item;
229 num = ep->desc->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
230 in = (ep->desc->bEndpointAddress & USB_DIR_IN) != 0;
232 ep->desc = &ep0_out_desc;
233 item = mv_get_qtd(num, in);
235 if (item->info & 0xff)
236 printf("EP%d/%s FAIL nfo=%x pg0=%x\n",
237 num, in ? "in" : "out", item->info, item->page0);
239 len = (item->info >> 16) & 0x7fff;
240 ep->req.length -= len;
241 DBG("ept%d %s complete %x\n",
242 num, in ? "in" : "out", len);
243 ep->req.complete(&ep->ep, &ep->req);
246 usb_ep_queue(&ep->ep, &ep->req, 0);
247 ep->desc = &ep0_in_desc;
251 #define SETUP(type, request) (((type) << 8) | (request))
253 static void handle_setup(void)
255 struct usb_request *req = &controller.ep[0].req;
256 struct mv_udc *udc = (struct mv_udc *)controller.ctrl->hcor;
257 struct ept_queue_head *head;
258 struct usb_ctrlrequest r;
260 int num, in, _num, _in, i;
262 head = mv_get_qh(0, 0); /* EP0 OUT */
264 flush_cache((unsigned long)head, sizeof(struct ept_queue_head));
265 memcpy(&r, head->setup_data, sizeof(struct usb_ctrlrequest));
266 writel(EPT_RX(0), &udc->epstat);
267 DBG("handle setup %s, %x, %x index %x value %x\n", reqname(r.bRequest),
268 r.bRequestType, r.bRequest, r.wIndex, r.wValue);
270 switch (SETUP(r.bRequestType, r.bRequest)) {
271 case SETUP(USB_RECIP_ENDPOINT, USB_REQ_CLEAR_FEATURE):
272 _num = r.wIndex & 15;
273 _in = !!(r.wIndex & 0x80);
275 if ((r.wValue == 0) && (r.wLength == 0)) {
277 for (i = 0; i < NUM_ENDPOINTS; i++) {
278 if (!controller.ep[i].desc)
280 num = controller.ep[i].desc->bEndpointAddress
281 & USB_ENDPOINT_NUMBER_MASK;
282 in = (controller.ep[i].desc->bEndpointAddress
284 if ((num == _num) && (in == _in)) {
286 usb_ep_queue(controller.gadget.ep0,
294 case SETUP(USB_RECIP_DEVICE, USB_REQ_SET_ADDRESS):
296 * write address delayed (will take effect
297 * after the next IN txn)
299 writel((r.wValue << 25) | (1 << 24), &udc->devaddr);
301 usb_ep_queue(controller.gadget.ep0, req, 0);
304 case SETUP(USB_DIR_IN | USB_RECIP_DEVICE, USB_REQ_GET_STATUS):
306 buf = (char *)req->buf;
307 buf[0] = 1 << USB_DEVICE_SELF_POWERED;
309 usb_ep_queue(controller.gadget.ep0, req, 0);
312 /* pass request up to the gadget driver */
313 if (controller.driver)
314 status = controller.driver->setup(&controller.gadget, &r);
320 DBG("STALL reqname %s type %x value %x, index %x\n",
321 reqname(r.bRequest), r.bRequestType, r.wValue, r.wIndex);
322 writel((1<<16) | (1 << 0), &udc->epctrl[0]);
325 static void stop_activity(void)
328 struct ept_queue_head *head;
329 struct mv_udc *udc = (struct mv_udc *)controller.ctrl->hcor;
330 writel(readl(&udc->epcomp), &udc->epcomp);
331 writel(readl(&udc->epstat), &udc->epstat);
332 writel(0xffffffff, &udc->epflush);
334 /* error out any pending reqs */
335 for (i = 0; i < NUM_ENDPOINTS; i++) {
337 writel(0, &udc->epctrl[i]);
338 if (controller.ep[i].desc) {
339 num = controller.ep[i].desc->bEndpointAddress
340 & USB_ENDPOINT_NUMBER_MASK;
341 in = (controller.ep[i].desc->bEndpointAddress
343 head = mv_get_qh(num, in);
344 head->info = INFO_ACTIVE;
351 struct mv_udc *udc = (struct mv_udc *)controller.ctrl->hcor;
352 unsigned n = readl(&udc->usbsts);
353 writel(n, &udc->usbsts);
356 n &= (STS_SLI | STS_URI | STS_PCI | STS_UI | STS_UEI);
361 DBG("-- reset --\n");
365 DBG("-- suspend --\n");
368 DBG("-- portchange --\n");
369 bit = (readl(&udc->portsc) >> 26) & 3;
371 controller.gadget.speed = USB_SPEED_HIGH;
372 for (i = 1; i < NUM_ENDPOINTS && n; i++)
373 if (controller.ep[i].desc)
374 controller.ep[i].ep.maxpacket = 512;
376 controller.gadget.speed = USB_SPEED_FULL;
381 printf("<UEI %x>\n", readl(&udc->epcomp));
383 if ((n & STS_UI) || (n & STS_UEI)) {
384 n = readl(&udc->epstat);
388 n = readl(&udc->epcomp);
390 writel(n, &udc->epcomp);
392 for (i = 0; i < NUM_ENDPOINTS && n; i++) {
393 if (controller.ep[i].desc) {
394 num = controller.ep[i].desc->bEndpointAddress
395 & USB_ENDPOINT_NUMBER_MASK;
396 in = (controller.ep[i].desc->bEndpointAddress
398 bit = (in) ? EPT_TX(num) : EPT_RX(num);
400 handle_ep_complete(&controller.ep[i]);
406 int usb_gadget_handle_interrupts(void)
409 struct mv_udc *udc = (struct mv_udc *)controller.ctrl->hcor;
411 value = readl(&udc->usbsts);
418 static int mv_pullup(struct usb_gadget *gadget, int is_on)
420 struct mv_udc *udc = (struct mv_udc *)controller.ctrl->hcor;
423 writel(USBCMD_ITC(MICRO_8FRAME) | USBCMD_RST, &udc->usbcmd);
426 writel((unsigned)controller.epts, &udc->epinitaddr);
428 /* select DEVICE mode */
429 writel(USBMODE_DEVICE, &udc->usbmode);
431 writel(0xffffffff, &udc->epflush);
433 /* Turn on the USB connection by enabling the pullup resistor */
434 writel(USBCMD_ITC(MICRO_8FRAME) | USBCMD_RUN, &udc->usbcmd);
437 writel(USBCMD_FS2, &udc->usbcmd);
439 if (controller.driver)
440 controller.driver->disconnect(gadget);
446 void udc_disconnect(void)
448 struct mv_udc *udc = (struct mv_udc *)controller.ctrl->hcor;
451 writel(USBCMD_FS2, &udc->usbcmd);
453 if (controller.driver)
454 controller.driver->disconnect(&controller.gadget);
457 static int mvudc_probe(void)
459 struct ept_queue_head *head;
463 const int num = 2 * NUM_ENDPOINTS;
465 const int eplist_min_align = 4096;
466 const int eplist_align = roundup(eplist_min_align, ARCH_DMA_MINALIGN);
467 const int eplist_raw_sz = num * sizeof(struct ept_queue_head);
468 const int eplist_sz = roundup(eplist_raw_sz, ARCH_DMA_MINALIGN);
470 const int ilist_align = roundup(ARCH_DMA_MINALIGN, 32);
471 const int ilist_ent_raw_sz = 2 * sizeof(struct ept_queue_item);
472 const int ilist_ent_sz = roundup(ilist_ent_raw_sz, ARCH_DMA_MINALIGN);
473 const int ilist_sz = NUM_ENDPOINTS * ilist_ent_sz;
475 /* The QH list must be aligned to 4096 bytes. */
476 controller.epts = memalign(eplist_align, eplist_sz);
477 if (!controller.epts)
479 memset(controller.epts, 0, eplist_sz);
482 * Each qTD item must be 32-byte aligned, each qTD touple must be
483 * cacheline aligned. There are two qTD items for each endpoint and
484 * only one of them is used for the endpoint at time, so we can group
487 controller.items_mem = memalign(ilist_align, ilist_sz);
488 if (!controller.items_mem) {
489 free(controller.epts);
493 for (i = 0; i < 2 * NUM_ENDPOINTS; i++) {
495 * Configure QH for each endpoint. The structure of the QH list
496 * is such that each two subsequent fields, N and N+1 where N is
497 * even, in the QH list represent QH for one endpoint. The Nth
498 * entry represents OUT configuration and the N+1th entry does
499 * represent IN configuration of the endpoint.
501 head = controller.epts + i;
503 head->config = CONFIG_MAX_PKT(EP0_MAX_PACKET_SIZE)
504 | CONFIG_ZLT | CONFIG_IOS;
506 head->config = CONFIG_MAX_PKT(EP_MAX_PACKET_SIZE)
508 head->next = TERMINATE;
511 imem = controller.items_mem + ((i >> 1) * ilist_ent_sz);
513 imem += sizeof(struct ept_queue_item);
515 controller.items[i] = (struct ept_queue_item *)imem;
518 INIT_LIST_HEAD(&controller.gadget.ep_list);
521 memcpy(&controller.ep[0].ep, &mv_ep_init[0], sizeof(*mv_ep_init));
522 controller.ep[0].desc = &ep0_in_desc;
523 controller.gadget.ep0 = &controller.ep[0].ep;
524 INIT_LIST_HEAD(&controller.gadget.ep0->ep_list);
527 for (i = 1; i < NUM_ENDPOINTS; i++) {
528 memcpy(&controller.ep[i].ep, &mv_ep_init[1],
529 sizeof(*mv_ep_init));
530 list_add_tail(&controller.ep[i].ep.ep_list,
531 &controller.gadget.ep_list);
537 int usb_gadget_register_driver(struct usb_gadget_driver *driver)
544 if (!driver->bind || !driver->setup || !driver->disconnect)
546 if (driver->speed != USB_SPEED_FULL && driver->speed != USB_SPEED_HIGH)
549 ret = usb_lowlevel_init(0, (void **)&controller.ctrl);
555 udc = (struct mv_udc *)controller.ctrl->hcor;
557 /* select ULPI phy */
558 writel(PTS(PTS_ENABLE) | PFSC, &udc->portsc);
561 ret = driver->bind(&controller.gadget);
563 DBG("driver->bind() returned %d\n", ret);
566 controller.driver = driver;
571 int usb_gadget_unregister_driver(struct usb_gadget_driver *driver)