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];
140 * mv_flush_qh - flush cache over queue head
141 * @ep_num: Endpoint number
143 * This function flushes cache over QH for particular endpoint.
145 static void mv_flush_qh(int ep_num)
147 struct ept_queue_head *head = mv_get_qh(ep_num, 0);
148 const uint32_t start = (uint32_t)head;
149 const uint32_t end = start + 2 * sizeof(*head);
151 flush_dcache_range(start, end);
155 * mv_invalidate_qh - invalidate cache over queue head
156 * @ep_num: Endpoint number
158 * This function invalidates cache over QH for particular endpoint.
160 static void mv_invalidate_qh(int ep_num)
162 struct ept_queue_head *head = mv_get_qh(ep_num, 0);
163 uint32_t start = (uint32_t)head;
164 uint32_t end = start + 2 * sizeof(*head);
166 invalidate_dcache_range(start, end);
170 * mv_flush_qtd - flush cache over queue item
171 * @ep_num: Endpoint number
173 * This function flushes cache over qTD pair for particular endpoint.
175 static void mv_flush_qtd(int ep_num)
177 struct ept_queue_item *item = mv_get_qtd(ep_num, 0);
178 const uint32_t start = (uint32_t)item;
179 const uint32_t end_raw = start + 2 * sizeof(*item);
180 const uint32_t end = roundup(end_raw, ARCH_DMA_MINALIGN);
182 flush_dcache_range(start, end);
186 * mv_invalidate_qtd - invalidate cache over queue item
187 * @ep_num: Endpoint number
189 * This function invalidates cache over qTD pair for particular endpoint.
191 static void mv_invalidate_qtd(int ep_num)
193 struct ept_queue_item *item = mv_get_qtd(ep_num, 0);
194 const uint32_t start = (uint32_t)item;
195 const uint32_t end_raw = start + 2 * sizeof(*item);
196 const uint32_t end = roundup(end_raw, ARCH_DMA_MINALIGN);
198 invalidate_dcache_range(start, end);
201 static struct usb_request *
202 mv_ep_alloc_request(struct usb_ep *ep, unsigned int gfp_flags)
204 struct mv_ep *mv_ep = container_of(ep, struct mv_ep, ep);
208 static void mv_ep_free_request(struct usb_ep *ep, struct usb_request *_req)
213 static void ep_enable(int num, int in)
215 struct ept_queue_head *head;
216 struct mv_udc *udc = (struct mv_udc *)controller.ctrl->hcor;
218 head = mv_get_qh(num, in);
220 n = readl(&udc->epctrl[num]);
222 n |= (CTRL_TXE | CTRL_TXR | CTRL_TXT_BULK);
224 n |= (CTRL_RXE | CTRL_RXR | CTRL_RXT_BULK);
227 head->config = CONFIG_MAX_PKT(EP_MAX_PACKET_SIZE) | CONFIG_ZLT;
230 writel(n, &udc->epctrl[num]);
233 static int mv_ep_enable(struct usb_ep *ep,
234 const struct usb_endpoint_descriptor *desc)
236 struct mv_ep *mv_ep = container_of(ep, struct mv_ep, ep);
238 num = desc->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
239 in = (desc->bEndpointAddress & USB_DIR_IN) != 0;
245 static int mv_ep_disable(struct usb_ep *ep)
250 static int mv_ep_queue(struct usb_ep *ep,
251 struct usb_request *req, gfp_t gfp_flags)
253 struct mv_ep *mv_ep = container_of(ep, struct mv_ep, ep);
254 struct mv_udc *udc = (struct mv_udc *)controller.ctrl->hcor;
255 struct ept_queue_item *item;
256 struct ept_queue_head *head;
258 int bit, num, len, in;
259 num = mv_ep->desc->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
260 in = (mv_ep->desc->bEndpointAddress & USB_DIR_IN) != 0;
261 item = mv_get_qtd(num, in);
262 head = mv_get_qh(num, in);
263 phys = (unsigned)req->buf;
266 item->next = TERMINATE;
267 item->info = INFO_BYTES(len) | INFO_IOC | INFO_ACTIVE;
269 item->page1 = (phys & 0xfffff000) + 0x1000;
271 head->next = (unsigned) item;
274 DBG("ept%d %s queue len %x, buffer %x\n",
275 num, in ? "in" : "out", len, phys);
285 writel(bit, &udc->epprime);
290 static void handle_ep_complete(struct mv_ep *ep)
292 struct ept_queue_item *item;
294 num = ep->desc->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
295 in = (ep->desc->bEndpointAddress & USB_DIR_IN) != 0;
297 ep->desc = &ep0_out_desc;
298 item = mv_get_qtd(num, in);
299 mv_invalidate_qtd(num);
301 if (item->info & 0xff)
302 printf("EP%d/%s FAIL nfo=%x pg0=%x\n",
303 num, in ? "in" : "out", item->info, item->page0);
305 len = (item->info >> 16) & 0x7fff;
306 ep->req.length -= len;
307 DBG("ept%d %s complete %x\n",
308 num, in ? "in" : "out", len);
309 ep->req.complete(&ep->ep, &ep->req);
312 usb_ep_queue(&ep->ep, &ep->req, 0);
313 ep->desc = &ep0_in_desc;
317 #define SETUP(type, request) (((type) << 8) | (request))
319 static void handle_setup(void)
321 struct usb_request *req = &controller.ep[0].req;
322 struct mv_udc *udc = (struct mv_udc *)controller.ctrl->hcor;
323 struct ept_queue_head *head;
324 struct usb_ctrlrequest r;
326 int num, in, _num, _in, i;
328 head = mv_get_qh(0, 0); /* EP0 OUT */
331 memcpy(&r, head->setup_data, sizeof(struct usb_ctrlrequest));
332 writel(EPT_RX(0), &udc->epstat);
333 DBG("handle setup %s, %x, %x index %x value %x\n", reqname(r.bRequest),
334 r.bRequestType, r.bRequest, r.wIndex, r.wValue);
336 switch (SETUP(r.bRequestType, r.bRequest)) {
337 case SETUP(USB_RECIP_ENDPOINT, USB_REQ_CLEAR_FEATURE):
338 _num = r.wIndex & 15;
339 _in = !!(r.wIndex & 0x80);
341 if ((r.wValue == 0) && (r.wLength == 0)) {
343 for (i = 0; i < NUM_ENDPOINTS; i++) {
344 if (!controller.ep[i].desc)
346 num = controller.ep[i].desc->bEndpointAddress
347 & USB_ENDPOINT_NUMBER_MASK;
348 in = (controller.ep[i].desc->bEndpointAddress
350 if ((num == _num) && (in == _in)) {
352 usb_ep_queue(controller.gadget.ep0,
360 case SETUP(USB_RECIP_DEVICE, USB_REQ_SET_ADDRESS):
362 * write address delayed (will take effect
363 * after the next IN txn)
365 writel((r.wValue << 25) | (1 << 24), &udc->devaddr);
367 usb_ep_queue(controller.gadget.ep0, req, 0);
370 case SETUP(USB_DIR_IN | USB_RECIP_DEVICE, USB_REQ_GET_STATUS):
372 buf = (char *)req->buf;
373 buf[0] = 1 << USB_DEVICE_SELF_POWERED;
375 usb_ep_queue(controller.gadget.ep0, req, 0);
378 /* pass request up to the gadget driver */
379 if (controller.driver)
380 status = controller.driver->setup(&controller.gadget, &r);
386 DBG("STALL reqname %s type %x value %x, index %x\n",
387 reqname(r.bRequest), r.bRequestType, r.wValue, r.wIndex);
388 writel((1<<16) | (1 << 0), &udc->epctrl[0]);
391 static void stop_activity(void)
394 struct ept_queue_head *head;
395 struct mv_udc *udc = (struct mv_udc *)controller.ctrl->hcor;
396 writel(readl(&udc->epcomp), &udc->epcomp);
397 writel(readl(&udc->epstat), &udc->epstat);
398 writel(0xffffffff, &udc->epflush);
400 /* error out any pending reqs */
401 for (i = 0; i < NUM_ENDPOINTS; i++) {
403 writel(0, &udc->epctrl[i]);
404 if (controller.ep[i].desc) {
405 num = controller.ep[i].desc->bEndpointAddress
406 & USB_ENDPOINT_NUMBER_MASK;
407 in = (controller.ep[i].desc->bEndpointAddress
409 head = mv_get_qh(num, in);
410 head->info = INFO_ACTIVE;
418 struct mv_udc *udc = (struct mv_udc *)controller.ctrl->hcor;
419 unsigned n = readl(&udc->usbsts);
420 writel(n, &udc->usbsts);
423 n &= (STS_SLI | STS_URI | STS_PCI | STS_UI | STS_UEI);
428 DBG("-- reset --\n");
432 DBG("-- suspend --\n");
435 DBG("-- portchange --\n");
436 bit = (readl(&udc->portsc) >> 26) & 3;
438 controller.gadget.speed = USB_SPEED_HIGH;
439 for (i = 1; i < NUM_ENDPOINTS && n; i++)
440 if (controller.ep[i].desc)
441 controller.ep[i].ep.maxpacket = 512;
443 controller.gadget.speed = USB_SPEED_FULL;
448 printf("<UEI %x>\n", readl(&udc->epcomp));
450 if ((n & STS_UI) || (n & STS_UEI)) {
451 n = readl(&udc->epstat);
455 n = readl(&udc->epcomp);
457 writel(n, &udc->epcomp);
459 for (i = 0; i < NUM_ENDPOINTS && n; i++) {
460 if (controller.ep[i].desc) {
461 num = controller.ep[i].desc->bEndpointAddress
462 & USB_ENDPOINT_NUMBER_MASK;
463 in = (controller.ep[i].desc->bEndpointAddress
465 bit = (in) ? EPT_TX(num) : EPT_RX(num);
467 handle_ep_complete(&controller.ep[i]);
473 int usb_gadget_handle_interrupts(void)
476 struct mv_udc *udc = (struct mv_udc *)controller.ctrl->hcor;
478 value = readl(&udc->usbsts);
485 static int mv_pullup(struct usb_gadget *gadget, int is_on)
487 struct mv_udc *udc = (struct mv_udc *)controller.ctrl->hcor;
490 writel(USBCMD_ITC(MICRO_8FRAME) | USBCMD_RST, &udc->usbcmd);
493 writel((unsigned)controller.epts, &udc->epinitaddr);
495 /* select DEVICE mode */
496 writel(USBMODE_DEVICE, &udc->usbmode);
498 writel(0xffffffff, &udc->epflush);
500 /* Turn on the USB connection by enabling the pullup resistor */
501 writel(USBCMD_ITC(MICRO_8FRAME) | USBCMD_RUN, &udc->usbcmd);
504 writel(USBCMD_FS2, &udc->usbcmd);
506 if (controller.driver)
507 controller.driver->disconnect(gadget);
513 void udc_disconnect(void)
515 struct mv_udc *udc = (struct mv_udc *)controller.ctrl->hcor;
518 writel(USBCMD_FS2, &udc->usbcmd);
520 if (controller.driver)
521 controller.driver->disconnect(&controller.gadget);
524 static int mvudc_probe(void)
526 struct ept_queue_head *head;
530 const int num = 2 * NUM_ENDPOINTS;
532 const int eplist_min_align = 4096;
533 const int eplist_align = roundup(eplist_min_align, ARCH_DMA_MINALIGN);
534 const int eplist_raw_sz = num * sizeof(struct ept_queue_head);
535 const int eplist_sz = roundup(eplist_raw_sz, ARCH_DMA_MINALIGN);
537 const int ilist_align = roundup(ARCH_DMA_MINALIGN, 32);
538 const int ilist_ent_raw_sz = 2 * sizeof(struct ept_queue_item);
539 const int ilist_ent_sz = roundup(ilist_ent_raw_sz, ARCH_DMA_MINALIGN);
540 const int ilist_sz = NUM_ENDPOINTS * ilist_ent_sz;
542 /* The QH list must be aligned to 4096 bytes. */
543 controller.epts = memalign(eplist_align, eplist_sz);
544 if (!controller.epts)
546 memset(controller.epts, 0, eplist_sz);
549 * Each qTD item must be 32-byte aligned, each qTD touple must be
550 * cacheline aligned. There are two qTD items for each endpoint and
551 * only one of them is used for the endpoint at time, so we can group
554 controller.items_mem = memalign(ilist_align, ilist_sz);
555 if (!controller.items_mem) {
556 free(controller.epts);
560 for (i = 0; i < 2 * NUM_ENDPOINTS; i++) {
562 * Configure QH for each endpoint. The structure of the QH list
563 * is such that each two subsequent fields, N and N+1 where N is
564 * even, in the QH list represent QH for one endpoint. The Nth
565 * entry represents OUT configuration and the N+1th entry does
566 * represent IN configuration of the endpoint.
568 head = controller.epts + i;
570 head->config = CONFIG_MAX_PKT(EP0_MAX_PACKET_SIZE)
571 | CONFIG_ZLT | CONFIG_IOS;
573 head->config = CONFIG_MAX_PKT(EP_MAX_PACKET_SIZE)
575 head->next = TERMINATE;
578 imem = controller.items_mem + ((i >> 1) * ilist_ent_sz);
580 imem += sizeof(struct ept_queue_item);
582 controller.items[i] = (struct ept_queue_item *)imem;
590 INIT_LIST_HEAD(&controller.gadget.ep_list);
593 memcpy(&controller.ep[0].ep, &mv_ep_init[0], sizeof(*mv_ep_init));
594 controller.ep[0].desc = &ep0_in_desc;
595 controller.gadget.ep0 = &controller.ep[0].ep;
596 INIT_LIST_HEAD(&controller.gadget.ep0->ep_list);
599 for (i = 1; i < NUM_ENDPOINTS; i++) {
600 memcpy(&controller.ep[i].ep, &mv_ep_init[1],
601 sizeof(*mv_ep_init));
602 list_add_tail(&controller.ep[i].ep.ep_list,
603 &controller.gadget.ep_list);
609 int usb_gadget_register_driver(struct usb_gadget_driver *driver)
616 if (!driver->bind || !driver->setup || !driver->disconnect)
618 if (driver->speed != USB_SPEED_FULL && driver->speed != USB_SPEED_HIGH)
621 ret = usb_lowlevel_init(0, (void **)&controller.ctrl);
627 udc = (struct mv_udc *)controller.ctrl->hcor;
629 /* select ULPI phy */
630 writel(PTS(PTS_ENABLE) | PFSC, &udc->portsc);
633 ret = driver->bind(&controller.gadget);
635 DBG("driver->bind() returned %d\n", ret);
638 controller.driver = driver;
643 int usb_gadget_unregister_driver(struct usb_gadget_driver *driver)