]> git.sur5r.net Git - u-boot/blob - drivers/usb/gadget/mv_udc.c
usb: mv_udc: Clean up the EP initialization
[u-boot] / drivers / usb / gadget / mv_udc.c
1 /*
2  * Copyright 2011, Marvell Semiconductor Inc.
3  * Lei Wen <leiwen@marvell.com>
4  *
5  * SPDX-License-Identifier:     GPL-2.0+
6  *
7  * Back ported to the 8xx platform (from the 8260 platform) by
8  * Murray.Jensen@cmst.csiro.au, 27-Jan-01.
9  */
10
11 #include <common.h>
12 #include <command.h>
13 #include <config.h>
14 #include <net.h>
15 #include <malloc.h>
16 #include <asm/io.h>
17 #include <linux/types.h>
18 #include <usb/mv_udc.h>
19
20 #if CONFIG_USB_MAX_CONTROLLER_COUNT > 1
21 #error This driver only supports one single controller.
22 #endif
23
24 #ifndef DEBUG
25 #define DBG(x...) do {} while (0)
26 #else
27 #define DBG(x...) printf(x)
28 static const char *reqname(unsigned r)
29 {
30         switch (r) {
31         case USB_REQ_GET_STATUS: return "GET_STATUS";
32         case USB_REQ_CLEAR_FEATURE: return "CLEAR_FEATURE";
33         case USB_REQ_SET_FEATURE: return "SET_FEATURE";
34         case USB_REQ_SET_ADDRESS: return "SET_ADDRESS";
35         case USB_REQ_GET_DESCRIPTOR: return "GET_DESCRIPTOR";
36         case USB_REQ_SET_DESCRIPTOR: return "SET_DESCRIPTOR";
37         case USB_REQ_GET_CONFIGURATION: return "GET_CONFIGURATION";
38         case USB_REQ_SET_CONFIGURATION: return "SET_CONFIGURATION";
39         case USB_REQ_GET_INTERFACE: return "GET_INTERFACE";
40         case USB_REQ_SET_INTERFACE: return "SET_INTERFACE";
41         default: return "*UNKNOWN*";
42         }
43 }
44 #endif
45
46 #define PAGE_SIZE       4096
47 #define QH_MAXNUM       32
48 static struct usb_endpoint_descriptor ep0_out_desc = {
49         .bLength = sizeof(struct usb_endpoint_descriptor),
50         .bDescriptorType = USB_DT_ENDPOINT,
51         .bEndpointAddress = 0,
52         .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
53 };
54
55 static struct usb_endpoint_descriptor ep0_in_desc = {
56         .bLength = sizeof(struct usb_endpoint_descriptor),
57         .bDescriptorType = USB_DT_ENDPOINT,
58         .bEndpointAddress = USB_DIR_IN,
59         .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
60 };
61
62 struct ept_queue_head *epts;
63 struct ept_queue_item *items[2 * NUM_ENDPOINTS];
64 static int mv_pullup(struct usb_gadget *gadget, int is_on);
65 static int mv_ep_enable(struct usb_ep *ep,
66                 const struct usb_endpoint_descriptor *desc);
67 static int mv_ep_disable(struct usb_ep *ep);
68 static int mv_ep_queue(struct usb_ep *ep,
69                 struct usb_request *req, gfp_t gfp_flags);
70 static struct usb_request *
71 mv_ep_alloc_request(struct usb_ep *ep, unsigned int gfp_flags);
72 static void mv_ep_free_request(struct usb_ep *ep, struct usb_request *_req);
73
74 static struct usb_gadget_ops mv_udc_ops = {
75         .pullup = mv_pullup,
76 };
77
78 static struct usb_ep_ops mv_ep_ops = {
79         .enable         = mv_ep_enable,
80         .disable        = mv_ep_disable,
81         .queue          = mv_ep_queue,
82         .alloc_request  = mv_ep_alloc_request,
83         .free_request   = mv_ep_free_request,
84 };
85
86 /* Init values for USB endpoints. */
87 static const struct usb_ep mv_ep_init[2] = {
88         [0] = { /* EP 0 */
89                 .maxpacket      = 64,
90                 .name           = "ep0",
91                 .ops            = &mv_ep_ops,
92         },
93         [1] = { /* EP 1..n */
94                 .maxpacket      = 512,
95                 .name           = "ep-",
96                 .ops            = &mv_ep_ops,
97         },
98 };
99
100 static struct mv_drv controller = {
101         .gadget = {
102                 .name = "mv_udc",
103         },
104 };
105
106 static struct usb_request *
107 mv_ep_alloc_request(struct usb_ep *ep, unsigned int gfp_flags)
108 {
109         struct mv_ep *mv_ep = container_of(ep, struct mv_ep, ep);
110         return &mv_ep->req;
111 }
112
113 static void mv_ep_free_request(struct usb_ep *ep, struct usb_request *_req)
114 {
115         return;
116 }
117
118 static void ep_enable(int num, int in)
119 {
120         struct ept_queue_head *head;
121         struct mv_udc *udc = controller.udc;
122         unsigned n;
123         head = epts + 2*num + in;
124
125         n = readl(&udc->epctrl[num]);
126         if (in)
127                 n |= (CTRL_TXE | CTRL_TXR | CTRL_TXT_BULK);
128         else
129                 n |= (CTRL_RXE | CTRL_RXR | CTRL_RXT_BULK);
130
131         if (num != 0)
132                 head->config = CONFIG_MAX_PKT(EP_MAX_PACKET_SIZE) | CONFIG_ZLT;
133         writel(n, &udc->epctrl[num]);
134 }
135
136 static int mv_ep_enable(struct usb_ep *ep,
137                 const struct usb_endpoint_descriptor *desc)
138 {
139         struct mv_ep *mv_ep = container_of(ep, struct mv_ep, ep);
140         int num, in;
141         num = desc->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
142         in = (desc->bEndpointAddress & USB_DIR_IN) != 0;
143         ep_enable(num, in);
144         mv_ep->desc = desc;
145         return 0;
146 }
147
148 static int mv_ep_disable(struct usb_ep *ep)
149 {
150         return 0;
151 }
152
153 static int mv_ep_queue(struct usb_ep *ep,
154                 struct usb_request *req, gfp_t gfp_flags)
155 {
156         struct mv_ep *mv_ep = container_of(ep, struct mv_ep, ep);
157         struct mv_udc *udc = controller.udc;
158         struct ept_queue_item *item;
159         struct ept_queue_head *head;
160         unsigned phys;
161         int bit, num, len, in;
162         num = mv_ep->desc->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
163         in = (mv_ep->desc->bEndpointAddress & USB_DIR_IN) != 0;
164         item = items[2 * num + in];
165         head = epts + 2 * num + in;
166         phys = (unsigned)req->buf;
167         len = req->length;
168
169         item->next = TERMINATE;
170         item->info = INFO_BYTES(len) | INFO_IOC | INFO_ACTIVE;
171         item->page0 = phys;
172         item->page1 = (phys & 0xfffff000) + 0x1000;
173
174         head->next = (unsigned) item;
175         head->info = 0;
176
177         DBG("ept%d %s queue len %x, buffer %x\n",
178                         num, in ? "in" : "out", len, phys);
179
180         if (in)
181                 bit = EPT_TX(num);
182         else
183                 bit = EPT_RX(num);
184
185         flush_cache(phys, len);
186         flush_cache((unsigned long)item, sizeof(struct ept_queue_item));
187         writel(bit, &udc->epprime);
188
189         return 0;
190 }
191
192 static void handle_ep_complete(struct mv_ep *ep)
193 {
194         struct ept_queue_item *item;
195         int num, in, len;
196         num = ep->desc->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
197         in = (ep->desc->bEndpointAddress & USB_DIR_IN) != 0;
198         if (num == 0)
199                 ep->desc = &ep0_out_desc;
200         item = items[2 * num + in];
201
202         if (item->info & 0xff)
203                 printf("EP%d/%s FAIL nfo=%x pg0=%x\n",
204                         num, in ? "in" : "out", item->info, item->page0);
205
206         len = (item->info >> 16) & 0x7fff;
207         ep->req.length -= len;
208         DBG("ept%d %s complete %x\n",
209                         num, in ? "in" : "out", len);
210         ep->req.complete(&ep->ep, &ep->req);
211         if (num == 0) {
212                 ep->req.length = 0;
213                 usb_ep_queue(&ep->ep, &ep->req, 0);
214                 ep->desc = &ep0_in_desc;
215         }
216 }
217
218 #define SETUP(type, request) (((type) << 8) | (request))
219
220 static void handle_setup(void)
221 {
222         struct usb_request *req = &controller.ep[0].req;
223         struct mv_udc *udc = controller.udc;
224         struct ept_queue_head *head;
225         struct usb_ctrlrequest r;
226         int status = 0;
227         int num, in, _num, _in, i;
228         char *buf;
229         head = epts;
230
231         flush_cache((unsigned long)head, sizeof(struct ept_queue_head));
232         memcpy(&r, head->setup_data, sizeof(struct usb_ctrlrequest));
233         writel(EPT_RX(0), &udc->epstat);
234         DBG("handle setup %s, %x, %x index %x value %x\n", reqname(r.bRequest),
235             r.bRequestType, r.bRequest, r.wIndex, r.wValue);
236
237         switch (SETUP(r.bRequestType, r.bRequest)) {
238         case SETUP(USB_RECIP_ENDPOINT, USB_REQ_CLEAR_FEATURE):
239                 _num = r.wIndex & 15;
240                 _in = !!(r.wIndex & 0x80);
241
242                 if ((r.wValue == 0) && (r.wLength == 0)) {
243                         req->length = 0;
244                         for (i = 0; i < NUM_ENDPOINTS; i++) {
245                                 if (!controller.ep[i].desc)
246                                         continue;
247                                 num = controller.ep[i].desc->bEndpointAddress
248                                                 & USB_ENDPOINT_NUMBER_MASK;
249                                 in = (controller.ep[i].desc->bEndpointAddress
250                                                 & USB_DIR_IN) != 0;
251                                 if ((num == _num) && (in == _in)) {
252                                         ep_enable(num, in);
253                                         usb_ep_queue(controller.gadget.ep0,
254                                                         req, 0);
255                                         break;
256                                 }
257                         }
258                 }
259                 return;
260
261         case SETUP(USB_RECIP_DEVICE, USB_REQ_SET_ADDRESS):
262                 /*
263                  * write address delayed (will take effect
264                  * after the next IN txn)
265                  */
266                 writel((r.wValue << 25) | (1 << 24), &udc->devaddr);
267                 req->length = 0;
268                 usb_ep_queue(controller.gadget.ep0, req, 0);
269                 return;
270
271         case SETUP(USB_DIR_IN | USB_RECIP_DEVICE, USB_REQ_GET_STATUS):
272                 req->length = 2;
273                 buf = (char *)req->buf;
274                 buf[0] = 1 << USB_DEVICE_SELF_POWERED;
275                 buf[1] = 0;
276                 usb_ep_queue(controller.gadget.ep0, req, 0);
277                 return;
278         }
279         /* pass request up to the gadget driver */
280         if (controller.driver)
281                 status = controller.driver->setup(&controller.gadget, &r);
282         else
283                 status = -ENODEV;
284
285         if (!status)
286                 return;
287         DBG("STALL reqname %s type %x value %x, index %x\n",
288             reqname(r.bRequest), r.bRequestType, r.wValue, r.wIndex);
289         writel((1<<16) | (1 << 0), &udc->epctrl[0]);
290 }
291
292 static void stop_activity(void)
293 {
294         int i, num, in;
295         struct ept_queue_head *head;
296         struct mv_udc *udc = controller.udc;
297         writel(readl(&udc->epcomp), &udc->epcomp);
298         writel(readl(&udc->epstat), &udc->epstat);
299         writel(0xffffffff, &udc->epflush);
300
301         /* error out any pending reqs */
302         for (i = 0; i < NUM_ENDPOINTS; i++) {
303                 if (i != 0)
304                         writel(0, &udc->epctrl[i]);
305                 if (controller.ep[i].desc) {
306                         num = controller.ep[i].desc->bEndpointAddress
307                                 & USB_ENDPOINT_NUMBER_MASK;
308                         in = (controller.ep[i].desc->bEndpointAddress
309                                 & USB_DIR_IN) != 0;
310                         head = epts + (num * 2) + (in);
311                         head->info = INFO_ACTIVE;
312                 }
313         }
314 }
315
316 void udc_irq(void)
317 {
318         struct mv_udc *udc = controller.udc;
319         unsigned n = readl(&udc->usbsts);
320         writel(n, &udc->usbsts);
321         int bit, i, num, in;
322
323         n &= (STS_SLI | STS_URI | STS_PCI | STS_UI | STS_UEI);
324         if (n == 0)
325                 return;
326
327         if (n & STS_URI) {
328                 DBG("-- reset --\n");
329                 stop_activity();
330         }
331         if (n & STS_SLI)
332                 DBG("-- suspend --\n");
333
334         if (n & STS_PCI) {
335                 DBG("-- portchange --\n");
336                 bit = (readl(&udc->portsc) >> 26) & 3;
337                 if (bit == 2) {
338                         controller.gadget.speed = USB_SPEED_HIGH;
339                         for (i = 1; i < NUM_ENDPOINTS && n; i++)
340                                 if (controller.ep[i].desc)
341                                         controller.ep[i].ep.maxpacket = 512;
342                 } else {
343                         controller.gadget.speed = USB_SPEED_FULL;
344                 }
345         }
346
347         if (n & STS_UEI)
348                 printf("<UEI %x>\n", readl(&udc->epcomp));
349
350         if ((n & STS_UI) || (n & STS_UEI)) {
351                 n = readl(&udc->epstat);
352                 if (n & EPT_RX(0))
353                         handle_setup();
354
355                 n = readl(&udc->epcomp);
356                 if (n != 0)
357                         writel(n, &udc->epcomp);
358
359                 for (i = 0; i < NUM_ENDPOINTS && n; i++) {
360                         if (controller.ep[i].desc) {
361                                 num = controller.ep[i].desc->bEndpointAddress
362                                         & USB_ENDPOINT_NUMBER_MASK;
363                                 in = (controller.ep[i].desc->bEndpointAddress
364                                                 & USB_DIR_IN) != 0;
365                                 bit = (in) ? EPT_TX(num) : EPT_RX(num);
366                                 if (n & bit)
367                                         handle_ep_complete(&controller.ep[i]);
368                         }
369                 }
370         }
371 }
372
373 int usb_gadget_handle_interrupts(void)
374 {
375         u32 value;
376         struct mv_udc *udc = controller.udc;
377
378         value = readl(&udc->usbsts);
379         if (value)
380                 udc_irq();
381
382         return value;
383 }
384
385 static int mv_pullup(struct usb_gadget *gadget, int is_on)
386 {
387         struct mv_udc *udc = controller.udc;
388         if (is_on) {
389                 /* RESET */
390                 writel(USBCMD_ITC(MICRO_8FRAME) | USBCMD_RST, &udc->usbcmd);
391                 udelay(200);
392
393                 writel((unsigned) epts, &udc->epinitaddr);
394
395                 /* select DEVICE mode */
396                 writel(USBMODE_DEVICE, &udc->usbmode);
397
398                 writel(0xffffffff, &udc->epflush);
399
400                 /* Turn on the USB connection by enabling the pullup resistor */
401                 writel(USBCMD_ITC(MICRO_8FRAME) | USBCMD_RUN, &udc->usbcmd);
402         } else {
403                 stop_activity();
404                 writel(USBCMD_FS2, &udc->usbcmd);
405                 udelay(800);
406                 if (controller.driver)
407                         controller.driver->disconnect(gadget);
408         }
409
410         return 0;
411 }
412
413 void udc_disconnect(void)
414 {
415         struct mv_udc *udc = controller.udc;
416         /* disable pullup */
417         stop_activity();
418         writel(USBCMD_FS2, &udc->usbcmd);
419         udelay(800);
420         if (controller.driver)
421                 controller.driver->disconnect(&controller.gadget);
422 }
423
424 static int mvudc_probe(void)
425 {
426         struct ept_queue_head *head;
427         int i;
428
429         controller.gadget.ops = &mv_udc_ops;
430         controller.udc = (struct mv_udc *)CONFIG_USB_REG_BASE;
431         epts = memalign(PAGE_SIZE, QH_MAXNUM * sizeof(struct ept_queue_head));
432         memset(epts, 0, QH_MAXNUM * sizeof(struct ept_queue_head));
433         for (i = 0; i < 2 * NUM_ENDPOINTS; i++) {
434                 /*
435                  * For item0 and item1, they are served as ep0
436                  * out&in seperately
437                  */
438                 head = epts + i;
439                 if (i < 2)
440                         head->config = CONFIG_MAX_PKT(EP0_MAX_PACKET_SIZE)
441                                 | CONFIG_ZLT | CONFIG_IOS;
442                 else
443                         head->config = CONFIG_MAX_PKT(EP_MAX_PACKET_SIZE)
444                                 | CONFIG_ZLT;
445                 head->next = TERMINATE;
446                 head->info = 0;
447
448                 items[i] = memalign(PAGE_SIZE, sizeof(struct ept_queue_item));
449         }
450
451         INIT_LIST_HEAD(&controller.gadget.ep_list);
452
453         /* Init EP 0 */
454         memcpy(&controller.ep[0].ep, &mv_ep_init[0], sizeof(*mv_ep_init));
455         controller.ep[0].desc = &ep0_in_desc;
456         controller.gadget.ep0 = &controller.ep[0].ep;
457         INIT_LIST_HEAD(&controller.gadget.ep0->ep_list);
458
459         /* Init EP 1..n */
460         for (i = 1; i < NUM_ENDPOINTS; i++) {
461                 memcpy(&controller.ep[i].ep, &mv_ep_init[1],
462                        sizeof(*mv_ep_init));
463                 list_add_tail(&controller.ep[i].ep.ep_list,
464                               &controller.gadget.ep_list);
465         }
466
467         return 0;
468 }
469
470 int usb_gadget_register_driver(struct usb_gadget_driver *driver)
471 {
472         struct mv_udc *udc = controller.udc;
473         int             retval;
474         void *ctrl;
475
476         if (!driver
477                         || driver->speed < USB_SPEED_FULL
478                         || !driver->bind
479                         || !driver->setup) {
480                 DBG("bad parameter.\n");
481                 return -EINVAL;
482         }
483
484         if (!mvudc_probe()) {
485                 usb_lowlevel_init(0, &ctrl);
486                 /* select ULPI phy */
487                 writel(PTS(PTS_ENABLE) | PFSC, &udc->portsc);
488         }
489         retval = driver->bind(&controller.gadget);
490         if (retval) {
491                 DBG("driver->bind() returned %d\n", retval);
492                 return retval;
493         }
494         controller.driver = driver;
495
496         return 0;
497 }
498
499 int usb_gadget_unregister_driver(struct usb_gadget_driver *driver)
500 {
501         return 0;
502 }