Pull extend-notify-die into release branch
[linux-2.6] / drivers / usb / gadget / dummy_hcd.c
1 /*
2  * dummy_hcd.c -- Dummy/Loopback USB host and device emulator driver.
3  *
4  * Maintainer: Alan Stern <stern@rowland.harvard.edu>
5  *
6  * Copyright (C) 2003 David Brownell
7  * Copyright (C) 2003-2005 Alan Stern
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
22  */
23
24
25 /*
26  * This exposes a device side "USB gadget" API, driven by requests to a
27  * Linux-USB host controller driver.  USB traffic is simulated; there's
28  * no need for USB hardware.  Use this with two other drivers:
29  *
30  *  - Gadget driver, responding to requests (slave);
31  *  - Host-side device driver, as already familiar in Linux.
32  *
33  * Having this all in one kernel can help some stages of development,
34  * bypassing some hardware (and driver) issues.  UML could help too.
35  */
36
37 #define DEBUG
38
39 #include <linux/config.h>
40 #include <linux/module.h>
41 #include <linux/kernel.h>
42 #include <linux/delay.h>
43 #include <linux/ioport.h>
44 #include <linux/sched.h>
45 #include <linux/slab.h>
46 #include <linux/smp_lock.h>
47 #include <linux/errno.h>
48 #include <linux/init.h>
49 #include <linux/timer.h>
50 #include <linux/list.h>
51 #include <linux/interrupt.h>
52 #include <linux/platform_device.h>
53 #include <linux/usb.h>
54 #include <linux/usb_gadget.h>
55
56 #include <asm/byteorder.h>
57 #include <asm/io.h>
58 #include <asm/irq.h>
59 #include <asm/system.h>
60 #include <asm/unaligned.h>
61
62
63 #include "../core/hcd.h"
64
65
66 #define DRIVER_DESC     "USB Host+Gadget Emulator"
67 #define DRIVER_VERSION  "02 May 2005"
68
69 static const char       driver_name [] = "dummy_hcd";
70 static const char       driver_desc [] = "USB Host+Gadget Emulator";
71
72 static const char       gadget_name [] = "dummy_udc";
73
74 MODULE_DESCRIPTION (DRIVER_DESC);
75 MODULE_AUTHOR ("David Brownell");
76 MODULE_LICENSE ("GPL");
77
78 /*-------------------------------------------------------------------------*/
79
80 /* gadget side driver data structres */
81 struct dummy_ep {
82         struct list_head                queue;
83         unsigned long                   last_io;        /* jiffies timestamp */
84         struct usb_gadget               *gadget;
85         const struct usb_endpoint_descriptor *desc;
86         struct usb_ep                   ep;
87         unsigned                        halted : 1;
88         unsigned                        already_seen : 1;
89         unsigned                        setup_stage : 1;
90 };
91
92 struct dummy_request {
93         struct list_head                queue;          /* ep's requests */
94         struct usb_request              req;
95 };
96
97 static inline struct dummy_ep *usb_ep_to_dummy_ep (struct usb_ep *_ep)
98 {
99         return container_of (_ep, struct dummy_ep, ep);
100 }
101
102 static inline struct dummy_request *usb_request_to_dummy_request
103                 (struct usb_request *_req)
104 {
105         return container_of (_req, struct dummy_request, req);
106 }
107
108 /*-------------------------------------------------------------------------*/
109
110 /*
111  * Every device has ep0 for control requests, plus up to 30 more endpoints,
112  * in one of two types:
113  *
114  *   - Configurable:  direction (in/out), type (bulk, iso, etc), and endpoint
115  *     number can be changed.  Names like "ep-a" are used for this type.
116  *
117  *   - Fixed Function:  in other cases.  some characteristics may be mutable;
118  *     that'd be hardware-specific.  Names like "ep12out-bulk" are used.
119  *
120  * Gadget drivers are responsible for not setting up conflicting endpoint
121  * configurations, illegal or unsupported packet lengths, and so on.
122  */
123
124 static const char ep0name [] = "ep0";
125
126 static const char *const ep_name [] = {
127         ep0name,                                /* everyone has ep0 */
128
129         /* act like a net2280: high speed, six configurable endpoints */
130         "ep-a", "ep-b", "ep-c", "ep-d", "ep-e", "ep-f",
131
132         /* or like pxa250: fifteen fixed function endpoints */
133         "ep1in-bulk", "ep2out-bulk", "ep3in-iso", "ep4out-iso", "ep5in-int",
134         "ep6in-bulk", "ep7out-bulk", "ep8in-iso", "ep9out-iso", "ep10in-int",
135         "ep11in-bulk", "ep12out-bulk", "ep13in-iso", "ep14out-iso",
136                 "ep15in-int",
137
138         /* or like sa1100: two fixed function endpoints */
139         "ep1out-bulk", "ep2in-bulk",
140 };
141 #define DUMMY_ENDPOINTS (sizeof(ep_name)/sizeof(char *))
142
143 /*-------------------------------------------------------------------------*/
144
145 #define FIFO_SIZE               64
146
147 struct urbp {
148         struct urb              *urb;
149         struct list_head        urbp_list;
150 };
151
152
153 enum dummy_rh_state {
154         DUMMY_RH_RESET,
155         DUMMY_RH_SUSPENDED,
156         DUMMY_RH_RUNNING
157 };
158
159 struct dummy {
160         spinlock_t                      lock;
161
162         /*
163          * SLAVE/GADGET side support
164          */
165         struct dummy_ep                 ep [DUMMY_ENDPOINTS];
166         int                             address;
167         struct usb_gadget               gadget;
168         struct usb_gadget_driver        *driver;
169         struct dummy_request            fifo_req;
170         u8                              fifo_buf [FIFO_SIZE];
171         u16                             devstatus;
172         unsigned                        udc_suspended:1;
173         unsigned                        pullup:1;
174         unsigned                        active:1;
175         unsigned                        old_active:1;
176
177         /*
178          * MASTER/HOST side support
179          */
180         enum dummy_rh_state             rh_state;
181         struct timer_list               timer;
182         u32                             port_status;
183         u32                             old_status;
184         unsigned                        resuming:1;
185         unsigned long                   re_timeout;
186
187         struct usb_device               *udev;
188         struct list_head                urbp_list;
189 };
190
191 static inline struct dummy *hcd_to_dummy (struct usb_hcd *hcd)
192 {
193         return (struct dummy *) (hcd->hcd_priv);
194 }
195
196 static inline struct usb_hcd *dummy_to_hcd (struct dummy *dum)
197 {
198         return container_of((void *) dum, struct usb_hcd, hcd_priv);
199 }
200
201 static inline struct device *dummy_dev (struct dummy *dum)
202 {
203         return dummy_to_hcd(dum)->self.controller;
204 }
205
206 static inline struct device *udc_dev (struct dummy *dum)
207 {
208         return dum->gadget.dev.parent;
209 }
210
211 static inline struct dummy *ep_to_dummy (struct dummy_ep *ep)
212 {
213         return container_of (ep->gadget, struct dummy, gadget);
214 }
215
216 static inline struct dummy *gadget_to_dummy (struct usb_gadget *gadget)
217 {
218         return container_of (gadget, struct dummy, gadget);
219 }
220
221 static inline struct dummy *gadget_dev_to_dummy (struct device *dev)
222 {
223         return container_of (dev, struct dummy, gadget.dev);
224 }
225
226 static struct dummy                     *the_controller;
227
228 /*-------------------------------------------------------------------------*/
229
230 /* SLAVE/GADGET SIDE UTILITY ROUTINES */
231
232 /* called with spinlock held */
233 static void nuke (struct dummy *dum, struct dummy_ep *ep)
234 {
235         while (!list_empty (&ep->queue)) {
236                 struct dummy_request    *req;
237
238                 req = list_entry (ep->queue.next, struct dummy_request, queue);
239                 list_del_init (&req->queue);
240                 req->req.status = -ESHUTDOWN;
241
242                 spin_unlock (&dum->lock);
243                 req->req.complete (&ep->ep, &req->req);
244                 spin_lock (&dum->lock);
245         }
246 }
247
248 /* caller must hold lock */
249 static void
250 stop_activity (struct dummy *dum)
251 {
252         struct dummy_ep *ep;
253
254         /* prevent any more requests */
255         dum->address = 0;
256
257         /* The timer is left running so that outstanding URBs can fail */
258
259         /* nuke any pending requests first, so driver i/o is quiesced */
260         list_for_each_entry (ep, &dum->gadget.ep_list, ep.ep_list)
261                 nuke (dum, ep);
262
263         /* driver now does any non-usb quiescing necessary */
264 }
265
266 /* caller must hold lock */
267 static void
268 set_link_state (struct dummy *dum)
269 {
270         dum->active = 0;
271         if ((dum->port_status & USB_PORT_STAT_POWER) == 0)
272                 dum->port_status = 0;
273
274         /* UDC suspend must cause a disconnect */
275         else if (!dum->pullup || dum->udc_suspended) {
276                 dum->port_status &= ~(USB_PORT_STAT_CONNECTION |
277                                         USB_PORT_STAT_ENABLE |
278                                         USB_PORT_STAT_LOW_SPEED |
279                                         USB_PORT_STAT_HIGH_SPEED |
280                                         USB_PORT_STAT_SUSPEND);
281                 if ((dum->old_status & USB_PORT_STAT_CONNECTION) != 0)
282                         dum->port_status |= (USB_PORT_STAT_C_CONNECTION << 16);
283         } else {
284                 dum->port_status |= USB_PORT_STAT_CONNECTION;
285                 if ((dum->old_status & USB_PORT_STAT_CONNECTION) == 0)
286                         dum->port_status |= (USB_PORT_STAT_C_CONNECTION << 16);
287                 if ((dum->port_status & USB_PORT_STAT_ENABLE) == 0)
288                         dum->port_status &= ~USB_PORT_STAT_SUSPEND;
289                 else if ((dum->port_status & USB_PORT_STAT_SUSPEND) == 0 &&
290                                 dum->rh_state != DUMMY_RH_SUSPENDED)
291                         dum->active = 1;
292         }
293
294         if ((dum->port_status & USB_PORT_STAT_ENABLE) == 0 || dum->active)
295                 dum->resuming = 0;
296
297         if ((dum->port_status & USB_PORT_STAT_CONNECTION) == 0 ||
298                         (dum->port_status & USB_PORT_STAT_RESET) != 0) {
299                 if ((dum->old_status & USB_PORT_STAT_CONNECTION) != 0 &&
300                                 (dum->old_status & USB_PORT_STAT_RESET) == 0 &&
301                                 dum->driver) {
302                         stop_activity (dum);
303                         spin_unlock (&dum->lock);
304                         dum->driver->disconnect (&dum->gadget);
305                         spin_lock (&dum->lock);
306                 }
307         } else if (dum->active != dum->old_active) {
308                 if (dum->old_active && dum->driver->suspend) {
309                         spin_unlock (&dum->lock);
310                         dum->driver->suspend (&dum->gadget);
311                         spin_lock (&dum->lock);
312                 } else if (!dum->old_active && dum->driver->resume) {
313                         spin_unlock (&dum->lock);
314                         dum->driver->resume (&dum->gadget);
315                         spin_lock (&dum->lock);
316                 }
317         }
318
319         dum->old_status = dum->port_status;
320         dum->old_active = dum->active;
321 }
322
323 /*-------------------------------------------------------------------------*/
324
325 /* SLAVE/GADGET SIDE DRIVER
326  *
327  * This only tracks gadget state.  All the work is done when the host
328  * side tries some (emulated) i/o operation.  Real device controller
329  * drivers would do real i/o using dma, fifos, irqs, timers, etc.
330  */
331
332 #define is_enabled(dum) \
333         (dum->port_status & USB_PORT_STAT_ENABLE)
334
335 static int
336 dummy_enable (struct usb_ep *_ep, const struct usb_endpoint_descriptor *desc)
337 {
338         struct dummy            *dum;
339         struct dummy_ep         *ep;
340         unsigned                max;
341         int                     retval;
342
343         ep = usb_ep_to_dummy_ep (_ep);
344         if (!_ep || !desc || ep->desc || _ep->name == ep0name
345                         || desc->bDescriptorType != USB_DT_ENDPOINT)
346                 return -EINVAL;
347         dum = ep_to_dummy (ep);
348         if (!dum->driver || !is_enabled (dum))
349                 return -ESHUTDOWN;
350         max = le16_to_cpu(desc->wMaxPacketSize) & 0x3ff;
351
352         /* drivers must not request bad settings, since lower levels
353          * (hardware or its drivers) may not check.  some endpoints
354          * can't do iso, many have maxpacket limitations, etc.
355          *
356          * since this "hardware" driver is here to help debugging, we
357          * have some extra sanity checks.  (there could be more though,
358          * especially for "ep9out" style fixed function ones.)
359          */
360         retval = -EINVAL;
361         switch (desc->bmAttributes & 0x03) {
362         case USB_ENDPOINT_XFER_BULK:
363                 if (strstr (ep->ep.name, "-iso")
364                                 || strstr (ep->ep.name, "-int")) {
365                         goto done;
366                 }
367                 switch (dum->gadget.speed) {
368                 case USB_SPEED_HIGH:
369                         if (max == 512)
370                                 break;
371                         /* conserve return statements */
372                 default:
373                         switch (max) {
374                         case 8: case 16: case 32: case 64:
375                                 /* we'll fake any legal size */
376                                 break;
377                         default:
378                 case USB_SPEED_LOW:
379                                 goto done;
380                         }
381                 }
382                 break;
383         case USB_ENDPOINT_XFER_INT:
384                 if (strstr (ep->ep.name, "-iso")) /* bulk is ok */
385                         goto done;
386                 /* real hardware might not handle all packet sizes */
387                 switch (dum->gadget.speed) {
388                 case USB_SPEED_HIGH:
389                         if (max <= 1024)
390                                 break;
391                         /* save a return statement */
392                 case USB_SPEED_FULL:
393                         if (max <= 64)
394                                 break;
395                         /* save a return statement */
396                 default:
397                         if (max <= 8)
398                                 break;
399                         goto done;
400                 }
401                 break;
402         case USB_ENDPOINT_XFER_ISOC:
403                 if (strstr (ep->ep.name, "-bulk")
404                                 || strstr (ep->ep.name, "-int"))
405                         goto done;
406                 /* real hardware might not handle all packet sizes */
407                 switch (dum->gadget.speed) {
408                 case USB_SPEED_HIGH:
409                         if (max <= 1024)
410                                 break;
411                         /* save a return statement */
412                 case USB_SPEED_FULL:
413                         if (max <= 1023)
414                                 break;
415                         /* save a return statement */
416                 default:
417                         goto done;
418                 }
419                 break;
420         default:
421                 /* few chips support control except on ep0 */
422                 goto done;
423         }
424
425         _ep->maxpacket = max;
426         ep->desc = desc;
427
428         dev_dbg (udc_dev(dum), "enabled %s (ep%d%s-%s) maxpacket %d\n",
429                 _ep->name,
430                 desc->bEndpointAddress & 0x0f,
431                 (desc->bEndpointAddress & USB_DIR_IN) ? "in" : "out",
432                 ({ char *val;
433                  switch (desc->bmAttributes & 0x03) {
434                  case USB_ENDPOINT_XFER_BULK: val = "bulk"; break;
435                  case USB_ENDPOINT_XFER_ISOC: val = "iso"; break;
436                  case USB_ENDPOINT_XFER_INT: val = "intr"; break;
437                  default: val = "ctrl"; break;
438                  }; val; }),
439                 max);
440
441         /* at this point real hardware should be NAKing transfers
442          * to that endpoint, until a buffer is queued to it.
443          */
444         retval = 0;
445 done:
446         return retval;
447 }
448
449 static int dummy_disable (struct usb_ep *_ep)
450 {
451         struct dummy_ep         *ep;
452         struct dummy            *dum;
453         unsigned long           flags;
454         int                     retval;
455
456         ep = usb_ep_to_dummy_ep (_ep);
457         if (!_ep || !ep->desc || _ep->name == ep0name)
458                 return -EINVAL;
459         dum = ep_to_dummy (ep);
460
461         spin_lock_irqsave (&dum->lock, flags);
462         ep->desc = NULL;
463         retval = 0;
464         nuke (dum, ep);
465         spin_unlock_irqrestore (&dum->lock, flags);
466
467         dev_dbg (udc_dev(dum), "disabled %s\n", _ep->name);
468         return retval;
469 }
470
471 static struct usb_request *
472 dummy_alloc_request (struct usb_ep *_ep, gfp_t mem_flags)
473 {
474         struct dummy_ep         *ep;
475         struct dummy_request    *req;
476
477         if (!_ep)
478                 return NULL;
479         ep = usb_ep_to_dummy_ep (_ep);
480
481         req = kmalloc (sizeof *req, mem_flags);
482         if (!req)
483                 return NULL;
484         memset (req, 0, sizeof *req);
485         INIT_LIST_HEAD (&req->queue);
486         return &req->req;
487 }
488
489 static void
490 dummy_free_request (struct usb_ep *_ep, struct usb_request *_req)
491 {
492         struct dummy_ep         *ep;
493         struct dummy_request    *req;
494
495         ep = usb_ep_to_dummy_ep (_ep);
496         if (!ep || !_req || (!ep->desc && _ep->name != ep0name))
497                 return;
498
499         req = usb_request_to_dummy_request (_req);
500         WARN_ON (!list_empty (&req->queue));
501         kfree (req);
502 }
503
504 static void *
505 dummy_alloc_buffer (
506         struct usb_ep *_ep,
507         unsigned bytes,
508         dma_addr_t *dma,
509         gfp_t mem_flags
510 ) {
511         char                    *retval;
512         struct dummy_ep         *ep;
513         struct dummy            *dum;
514
515         ep = usb_ep_to_dummy_ep (_ep);
516         dum = ep_to_dummy (ep);
517
518         if (!dum->driver)
519                 return NULL;
520         retval = kmalloc (bytes, mem_flags);
521         *dma = (dma_addr_t) retval;
522         return retval;
523 }
524
525 static void
526 dummy_free_buffer (
527         struct usb_ep *_ep,
528         void *buf,
529         dma_addr_t dma,
530         unsigned bytes
531 ) {
532         if (bytes)
533                 kfree (buf);
534 }
535
536 static void
537 fifo_complete (struct usb_ep *ep, struct usb_request *req)
538 {
539 }
540
541 static int
542 dummy_queue (struct usb_ep *_ep, struct usb_request *_req,
543                 gfp_t mem_flags)
544 {
545         struct dummy_ep         *ep;
546         struct dummy_request    *req;
547         struct dummy            *dum;
548         unsigned long           flags;
549
550         req = usb_request_to_dummy_request (_req);
551         if (!_req || !list_empty (&req->queue) || !_req->complete)
552                 return -EINVAL;
553
554         ep = usb_ep_to_dummy_ep (_ep);
555         if (!_ep || (!ep->desc && _ep->name != ep0name))
556                 return -EINVAL;
557
558         dum = ep_to_dummy (ep);
559         if (!dum->driver || !is_enabled (dum))
560                 return -ESHUTDOWN;
561
562 #if 0
563         dev_dbg (udc_dev(dum), "ep %p queue req %p to %s, len %d buf %p\n",
564                         ep, _req, _ep->name, _req->length, _req->buf);
565 #endif
566
567         _req->status = -EINPROGRESS;
568         _req->actual = 0;
569         spin_lock_irqsave (&dum->lock, flags);
570
571         /* implement an emulated single-request FIFO */
572         if (ep->desc && (ep->desc->bEndpointAddress & USB_DIR_IN) &&
573                         list_empty (&dum->fifo_req.queue) &&
574                         list_empty (&ep->queue) &&
575                         _req->length <= FIFO_SIZE) {
576                 req = &dum->fifo_req;
577                 req->req = *_req;
578                 req->req.buf = dum->fifo_buf;
579                 memcpy (dum->fifo_buf, _req->buf, _req->length);
580                 req->req.context = dum;
581                 req->req.complete = fifo_complete;
582
583                 spin_unlock (&dum->lock);
584                 _req->actual = _req->length;
585                 _req->status = 0;
586                 _req->complete (_ep, _req);
587                 spin_lock (&dum->lock);
588         }
589         list_add_tail (&req->queue, &ep->queue);
590         spin_unlock_irqrestore (&dum->lock, flags);
591
592         /* real hardware would likely enable transfers here, in case
593          * it'd been left NAKing.
594          */
595         return 0;
596 }
597
598 static int dummy_dequeue (struct usb_ep *_ep, struct usb_request *_req)
599 {
600         struct dummy_ep         *ep;
601         struct dummy            *dum;
602         int                     retval = -EINVAL;
603         unsigned long           flags;
604         struct dummy_request    *req = NULL;
605
606         if (!_ep || !_req)
607                 return retval;
608         ep = usb_ep_to_dummy_ep (_ep);
609         dum = ep_to_dummy (ep);
610
611         if (!dum->driver)
612                 return -ESHUTDOWN;
613
614         spin_lock_irqsave (&dum->lock, flags);
615         list_for_each_entry (req, &ep->queue, queue) {
616                 if (&req->req == _req) {
617                         list_del_init (&req->queue);
618                         _req->status = -ECONNRESET;
619                         retval = 0;
620                         break;
621                 }
622         }
623         spin_unlock_irqrestore (&dum->lock, flags);
624
625         if (retval == 0) {
626                 dev_dbg (udc_dev(dum),
627                                 "dequeued req %p from %s, len %d buf %p\n",
628                                 req, _ep->name, _req->length, _req->buf);
629                 _req->complete (_ep, _req);
630         }
631         return retval;
632 }
633
634 static int
635 dummy_set_halt (struct usb_ep *_ep, int value)
636 {
637         struct dummy_ep         *ep;
638         struct dummy            *dum;
639
640         if (!_ep)
641                 return -EINVAL;
642         ep = usb_ep_to_dummy_ep (_ep);
643         dum = ep_to_dummy (ep);
644         if (!dum->driver)
645                 return -ESHUTDOWN;
646         if (!value)
647                 ep->halted = 0;
648         else if (ep->desc && (ep->desc->bEndpointAddress & USB_DIR_IN) &&
649                         !list_empty (&ep->queue))
650                 return -EAGAIN;
651         else
652                 ep->halted = 1;
653         /* FIXME clear emulated data toggle too */
654         return 0;
655 }
656
657 static const struct usb_ep_ops dummy_ep_ops = {
658         .enable         = dummy_enable,
659         .disable        = dummy_disable,
660
661         .alloc_request  = dummy_alloc_request,
662         .free_request   = dummy_free_request,
663
664         .alloc_buffer   = dummy_alloc_buffer,
665         .free_buffer    = dummy_free_buffer,
666         /* map, unmap, ... eventually hook the "generic" dma calls */
667
668         .queue          = dummy_queue,
669         .dequeue        = dummy_dequeue,
670
671         .set_halt       = dummy_set_halt,
672 };
673
674 /*-------------------------------------------------------------------------*/
675
676 /* there are both host and device side versions of this call ... */
677 static int dummy_g_get_frame (struct usb_gadget *_gadget)
678 {
679         struct timeval  tv;
680
681         do_gettimeofday (&tv);
682         return tv.tv_usec / 1000;
683 }
684
685 static int dummy_wakeup (struct usb_gadget *_gadget)
686 {
687         struct dummy    *dum;
688
689         dum = gadget_to_dummy (_gadget);
690         if (!(dum->devstatus &  ( (1 << USB_DEVICE_B_HNP_ENABLE)
691                                 | (1 << USB_DEVICE_REMOTE_WAKEUP))))
692                 return -EINVAL;
693         if ((dum->port_status & USB_PORT_STAT_CONNECTION) == 0)
694                 return -ENOLINK;
695         if ((dum->port_status & USB_PORT_STAT_SUSPEND) == 0 &&
696                          dum->rh_state != DUMMY_RH_SUSPENDED)
697                 return -EIO;
698
699         /* FIXME: What if the root hub is suspended but the port isn't? */
700
701         /* hub notices our request, issues downstream resume, etc */
702         dum->resuming = 1;
703         dum->re_timeout = jiffies + msecs_to_jiffies(20);
704         mod_timer (&dummy_to_hcd (dum)->rh_timer, dum->re_timeout);
705         return 0;
706 }
707
708 static int dummy_set_selfpowered (struct usb_gadget *_gadget, int value)
709 {
710         struct dummy    *dum;
711
712         dum = gadget_to_dummy (_gadget);
713         if (value)
714                 dum->devstatus |= (1 << USB_DEVICE_SELF_POWERED);
715         else
716                 dum->devstatus &= ~(1 << USB_DEVICE_SELF_POWERED);
717         return 0;
718 }
719
720 static int dummy_pullup (struct usb_gadget *_gadget, int value)
721 {
722         struct dummy    *dum;
723         unsigned long   flags;
724
725         dum = gadget_to_dummy (_gadget);
726         spin_lock_irqsave (&dum->lock, flags);
727         dum->pullup = (value != 0);
728         set_link_state (dum);
729         spin_unlock_irqrestore (&dum->lock, flags);
730
731         usb_hcd_poll_rh_status (dummy_to_hcd (dum));
732         return 0;
733 }
734
735 static const struct usb_gadget_ops dummy_ops = {
736         .get_frame      = dummy_g_get_frame,
737         .wakeup         = dummy_wakeup,
738         .set_selfpowered = dummy_set_selfpowered,
739         .pullup         = dummy_pullup,
740 };
741
742 /*-------------------------------------------------------------------------*/
743
744 /* "function" sysfs attribute */
745 static ssize_t
746 show_function (struct device *dev, struct device_attribute *attr, char *buf)
747 {
748         struct dummy    *dum = gadget_dev_to_dummy (dev);
749
750         if (!dum->driver || !dum->driver->function)
751                 return 0;
752         return scnprintf (buf, PAGE_SIZE, "%s\n", dum->driver->function);
753 }
754 static DEVICE_ATTR (function, S_IRUGO, show_function, NULL);
755
756 /*-------------------------------------------------------------------------*/
757
758 /*
759  * Driver registration/unregistration.
760  *
761  * This is basically hardware-specific; there's usually only one real USB
762  * device (not host) controller since that's how USB devices are intended
763  * to work.  So most implementations of these api calls will rely on the
764  * fact that only one driver will ever bind to the hardware.  But curious
765  * hardware can be built with discrete components, so the gadget API doesn't
766  * require that assumption.
767  *
768  * For this emulator, it might be convenient to create a usb slave device
769  * for each driver that registers:  just add to a big root hub.
770  */
771
772 int
773 usb_gadget_register_driver (struct usb_gadget_driver *driver)
774 {
775         struct dummy    *dum = the_controller;
776         int             retval, i;
777
778         if (!dum)
779                 return -EINVAL;
780         if (dum->driver)
781                 return -EBUSY;
782         if (!driver->bind || !driver->unbind || !driver->setup
783                         || driver->speed == USB_SPEED_UNKNOWN)
784                 return -EINVAL;
785
786         /*
787          * SLAVE side init ... the layer above hardware, which
788          * can't enumerate without help from the driver we're binding.
789          */
790
791         dum->devstatus = 0;
792
793         INIT_LIST_HEAD (&dum->gadget.ep_list);
794         for (i = 0; i < DUMMY_ENDPOINTS; i++) {
795                 struct dummy_ep *ep = &dum->ep [i];
796
797                 if (!ep_name [i])
798                         break;
799                 ep->ep.name = ep_name [i];
800                 ep->ep.ops = &dummy_ep_ops;
801                 list_add_tail (&ep->ep.ep_list, &dum->gadget.ep_list);
802                 ep->halted = ep->already_seen = ep->setup_stage = 0;
803                 ep->ep.maxpacket = ~0;
804                 ep->last_io = jiffies;
805                 ep->gadget = &dum->gadget;
806                 ep->desc = NULL;
807                 INIT_LIST_HEAD (&ep->queue);
808         }
809
810         dum->gadget.ep0 = &dum->ep [0].ep;
811         dum->ep [0].ep.maxpacket = 64;
812         list_del_init (&dum->ep [0].ep.ep_list);
813         INIT_LIST_HEAD(&dum->fifo_req.queue);
814
815         dum->driver = driver;
816         dum->gadget.dev.driver = &driver->driver;
817         dev_dbg (udc_dev(dum), "binding gadget driver '%s'\n",
818                         driver->driver.name);
819         if ((retval = driver->bind (&dum->gadget)) != 0) {
820                 dum->driver = NULL;
821                 dum->gadget.dev.driver = NULL;
822                 return retval;
823         }
824
825         driver->driver.bus = dum->gadget.dev.parent->bus;
826         driver_register (&driver->driver);
827         device_bind_driver (&dum->gadget.dev);
828
829         /* khubd will enumerate this in a while */
830         spin_lock_irq (&dum->lock);
831         dum->pullup = 1;
832         set_link_state (dum);
833         spin_unlock_irq (&dum->lock);
834
835         usb_hcd_poll_rh_status (dummy_to_hcd (dum));
836         return 0;
837 }
838 EXPORT_SYMBOL (usb_gadget_register_driver);
839
840 int
841 usb_gadget_unregister_driver (struct usb_gadget_driver *driver)
842 {
843         struct dummy    *dum = the_controller;
844         unsigned long   flags;
845
846         if (!dum)
847                 return -ENODEV;
848         if (!driver || driver != dum->driver)
849                 return -EINVAL;
850
851         dev_dbg (udc_dev(dum), "unregister gadget driver '%s'\n",
852                         driver->driver.name);
853
854         spin_lock_irqsave (&dum->lock, flags);
855         dum->pullup = 0;
856         set_link_state (dum);
857         spin_unlock_irqrestore (&dum->lock, flags);
858
859         driver->unbind (&dum->gadget);
860         dum->driver = NULL;
861
862         device_release_driver (&dum->gadget.dev);
863         driver_unregister (&driver->driver);
864
865         spin_lock_irqsave (&dum->lock, flags);
866         dum->pullup = 0;
867         set_link_state (dum);
868         spin_unlock_irqrestore (&dum->lock, flags);
869
870         usb_hcd_poll_rh_status (dummy_to_hcd (dum));
871         return 0;
872 }
873 EXPORT_SYMBOL (usb_gadget_unregister_driver);
874
875 #undef is_enabled
876
877 /* just declare this in any driver that really need it */
878 extern int net2280_set_fifo_mode (struct usb_gadget *gadget, int mode);
879
880 int net2280_set_fifo_mode (struct usb_gadget *gadget, int mode)
881 {
882         return -ENOSYS;
883 }
884 EXPORT_SYMBOL (net2280_set_fifo_mode);
885
886
887 /* The gadget structure is stored inside the hcd structure and will be
888  * released along with it. */
889 static void
890 dummy_gadget_release (struct device *dev)
891 {
892 #if 0           /* usb_bus_put isn't EXPORTed! */
893         struct dummy    *dum = gadget_dev_to_dummy (dev);
894
895         usb_bus_put (&dummy_to_hcd (dum)->self);
896 #endif
897 }
898
899 static int dummy_udc_probe (struct device *dev)
900 {
901         struct dummy    *dum = the_controller;
902         int             rc;
903
904         dum->gadget.name = gadget_name;
905         dum->gadget.ops = &dummy_ops;
906         dum->gadget.is_dualspeed = 1;
907
908         /* maybe claim OTG support, though we won't complete HNP */
909         dum->gadget.is_otg = (dummy_to_hcd(dum)->self.otg_port != 0);
910
911         strcpy (dum->gadget.dev.bus_id, "gadget");
912         dum->gadget.dev.parent = dev;
913         dum->gadget.dev.release = dummy_gadget_release;
914         rc = device_register (&dum->gadget.dev);
915         if (rc < 0)
916                 return rc;
917
918 #if 0           /* usb_bus_get isn't EXPORTed! */
919         usb_bus_get (&dummy_to_hcd (dum)->self);
920 #endif
921
922         dev_set_drvdata (dev, dum);
923         device_create_file (&dum->gadget.dev, &dev_attr_function);
924         return rc;
925 }
926
927 static int dummy_udc_remove (struct device *dev)
928 {
929         struct dummy    *dum = dev_get_drvdata (dev);
930
931         dev_set_drvdata (dev, NULL);
932         device_remove_file (&dum->gadget.dev, &dev_attr_function);
933         device_unregister (&dum->gadget.dev);
934         return 0;
935 }
936
937 static int dummy_udc_suspend (struct device *dev, pm_message_t state)
938 {
939         struct dummy    *dum = dev_get_drvdata(dev);
940
941         dev_dbg (dev, "%s\n", __FUNCTION__);
942         spin_lock_irq (&dum->lock);
943         dum->udc_suspended = 1;
944         set_link_state (dum);
945         spin_unlock_irq (&dum->lock);
946
947         dev->power.power_state = state;
948         usb_hcd_poll_rh_status (dummy_to_hcd (dum));
949         return 0;
950 }
951
952 static int dummy_udc_resume (struct device *dev)
953 {
954         struct dummy    *dum = dev_get_drvdata(dev);
955
956         dev_dbg (dev, "%s\n", __FUNCTION__);
957         spin_lock_irq (&dum->lock);
958         dum->udc_suspended = 0;
959         set_link_state (dum);
960         spin_unlock_irq (&dum->lock);
961
962         dev->power.power_state = PMSG_ON;
963         usb_hcd_poll_rh_status (dummy_to_hcd (dum));
964         return 0;
965 }
966
967 static struct device_driver dummy_udc_driver = {
968         .name           = (char *) gadget_name,
969         .owner          = THIS_MODULE,
970         .bus            = &platform_bus_type,
971         .probe          = dummy_udc_probe,
972         .remove         = dummy_udc_remove,
973         .suspend        = dummy_udc_suspend,
974         .resume         = dummy_udc_resume,
975 };
976
977 /*-------------------------------------------------------------------------*/
978
979 /* MASTER/HOST SIDE DRIVER
980  *
981  * this uses the hcd framework to hook up to host side drivers.
982  * its root hub will only have one device, otherwise it acts like
983  * a normal host controller.
984  *
985  * when urbs are queued, they're just stuck on a list that we
986  * scan in a timer callback.  that callback connects writes from
987  * the host with reads from the device, and so on, based on the
988  * usb 2.0 rules.
989  */
990
991 static int dummy_urb_enqueue (
992         struct usb_hcd                  *hcd,
993         struct usb_host_endpoint        *ep,
994         struct urb                      *urb,
995         gfp_t                           mem_flags
996 ) {
997         struct dummy    *dum;
998         struct urbp     *urbp;
999         unsigned long   flags;
1000
1001         if (!urb->transfer_buffer && urb->transfer_buffer_length)
1002                 return -EINVAL;
1003
1004         urbp = kmalloc (sizeof *urbp, mem_flags);
1005         if (!urbp)
1006                 return -ENOMEM;
1007         urbp->urb = urb;
1008
1009         dum = hcd_to_dummy (hcd);
1010         spin_lock_irqsave (&dum->lock, flags);
1011
1012         if (!dum->udev) {
1013                 dum->udev = urb->dev;
1014                 usb_get_dev (dum->udev);
1015         } else if (unlikely (dum->udev != urb->dev))
1016                 dev_err (dummy_dev(dum), "usb_device address has changed!\n");
1017
1018         list_add_tail (&urbp->urbp_list, &dum->urbp_list);
1019         urb->hcpriv = urbp;
1020         if (usb_pipetype (urb->pipe) == PIPE_CONTROL)
1021                 urb->error_count = 1;           /* mark as a new urb */
1022
1023         /* kick the scheduler, it'll do the rest */
1024         if (!timer_pending (&dum->timer))
1025                 mod_timer (&dum->timer, jiffies + 1);
1026
1027         spin_unlock_irqrestore (&dum->lock, flags);
1028         return 0;
1029 }
1030
1031 static int dummy_urb_dequeue (struct usb_hcd *hcd, struct urb *urb)
1032 {
1033         struct dummy    *dum;
1034         unsigned long   flags;
1035
1036         /* giveback happens automatically in timer callback,
1037          * so make sure the callback happens */
1038         dum = hcd_to_dummy (hcd);
1039         spin_lock_irqsave (&dum->lock, flags);
1040         if (dum->rh_state != DUMMY_RH_RUNNING && !list_empty(&dum->urbp_list))
1041                 mod_timer (&dum->timer, jiffies);
1042         spin_unlock_irqrestore (&dum->lock, flags);
1043         return 0;
1044 }
1045
1046 static void maybe_set_status (struct urb *urb, int status)
1047 {
1048         spin_lock (&urb->lock);
1049         if (urb->status == -EINPROGRESS)
1050                 urb->status = status;
1051         spin_unlock (&urb->lock);
1052 }
1053
1054 /* transfer up to a frame's worth; caller must own lock */
1055 static int
1056 transfer (struct dummy *dum, struct urb *urb, struct dummy_ep *ep, int limit)
1057 {
1058         struct dummy_request    *req;
1059
1060 top:
1061         /* if there's no request queued, the device is NAKing; return */
1062         list_for_each_entry (req, &ep->queue, queue) {
1063                 unsigned        host_len, dev_len, len;
1064                 int             is_short, to_host;
1065                 int             rescan = 0;
1066
1067                 /* 1..N packets of ep->ep.maxpacket each ... the last one
1068                  * may be short (including zero length).
1069                  *
1070                  * writer can send a zlp explicitly (length 0) or implicitly
1071                  * (length mod maxpacket zero, and 'zero' flag); they always
1072                  * terminate reads.
1073                  */
1074                 host_len = urb->transfer_buffer_length - urb->actual_length;
1075                 dev_len = req->req.length - req->req.actual;
1076                 len = min (host_len, dev_len);
1077
1078                 /* FIXME update emulated data toggle too */
1079
1080                 to_host = usb_pipein (urb->pipe);
1081                 if (unlikely (len == 0))
1082                         is_short = 1;
1083                 else {
1084                         char            *ubuf, *rbuf;
1085
1086                         /* not enough bandwidth left? */
1087                         if (limit < ep->ep.maxpacket && limit < len)
1088                                 break;
1089                         len = min (len, (unsigned) limit);
1090                         if (len == 0)
1091                                 break;
1092
1093                         /* use an extra pass for the final short packet */
1094                         if (len > ep->ep.maxpacket) {
1095                                 rescan = 1;
1096                                 len -= (len % ep->ep.maxpacket);
1097                         }
1098                         is_short = (len % ep->ep.maxpacket) != 0;
1099
1100                         /* else transfer packet(s) */
1101                         ubuf = urb->transfer_buffer + urb->actual_length;
1102                         rbuf = req->req.buf + req->req.actual;
1103                         if (to_host)
1104                                 memcpy (ubuf, rbuf, len);
1105                         else
1106                                 memcpy (rbuf, ubuf, len);
1107                         ep->last_io = jiffies;
1108
1109                         limit -= len;
1110                         urb->actual_length += len;
1111                         req->req.actual += len;
1112                 }
1113
1114                 /* short packets terminate, maybe with overflow/underflow.
1115                  * it's only really an error to write too much.
1116                  *
1117                  * partially filling a buffer optionally blocks queue advances
1118                  * (so completion handlers can clean up the queue) but we don't
1119                  * need to emulate such data-in-flight.  so we only show part
1120                  * of the URB_SHORT_NOT_OK effect: completion status.
1121                  */
1122                 if (is_short) {
1123                         if (host_len == dev_len) {
1124                                 req->req.status = 0;
1125                                 maybe_set_status (urb, 0);
1126                         } else if (to_host) {
1127                                 req->req.status = 0;
1128                                 if (dev_len > host_len)
1129                                         maybe_set_status (urb, -EOVERFLOW);
1130                                 else
1131                                         maybe_set_status (urb,
1132                                                 (urb->transfer_flags
1133                                                         & URB_SHORT_NOT_OK)
1134                                                 ? -EREMOTEIO : 0);
1135                         } else if (!to_host) {
1136                                 maybe_set_status (urb, 0);
1137                                 if (host_len > dev_len)
1138                                         req->req.status = -EOVERFLOW;
1139                                 else
1140                                         req->req.status = 0;
1141                         }
1142
1143                 /* many requests terminate without a short packet */
1144                 } else {
1145                         if (req->req.length == req->req.actual
1146                                         && !req->req.zero)
1147                                 req->req.status = 0;
1148                         if (urb->transfer_buffer_length == urb->actual_length
1149                                         && !(urb->transfer_flags
1150                                                 & URB_ZERO_PACKET)) {
1151                                 maybe_set_status (urb, 0);
1152                         }
1153                 }
1154
1155                 /* device side completion --> continuable */
1156                 if (req->req.status != -EINPROGRESS) {
1157                         list_del_init (&req->queue);
1158
1159                         spin_unlock (&dum->lock);
1160                         req->req.complete (&ep->ep, &req->req);
1161                         spin_lock (&dum->lock);
1162
1163                         /* requests might have been unlinked... */
1164                         rescan = 1;
1165                 }
1166
1167                 /* host side completion --> terminate */
1168                 if (urb->status != -EINPROGRESS)
1169                         break;
1170
1171                 /* rescan to continue with any other queued i/o */
1172                 if (rescan)
1173                         goto top;
1174         }
1175         return limit;
1176 }
1177
1178 static int periodic_bytes (struct dummy *dum, struct dummy_ep *ep)
1179 {
1180         int     limit = ep->ep.maxpacket;
1181
1182         if (dum->gadget.speed == USB_SPEED_HIGH) {
1183                 int     tmp;
1184
1185                 /* high bandwidth mode */
1186                 tmp = le16_to_cpu(ep->desc->wMaxPacketSize);
1187                 tmp = (tmp >> 11) & 0x03;
1188                 tmp *= 8 /* applies to entire frame */;
1189                 limit += limit * tmp;
1190         }
1191         return limit;
1192 }
1193
1194 #define is_active(dum)  ((dum->port_status & \
1195                 (USB_PORT_STAT_CONNECTION | USB_PORT_STAT_ENABLE | \
1196                         USB_PORT_STAT_SUSPEND)) \
1197                 == (USB_PORT_STAT_CONNECTION | USB_PORT_STAT_ENABLE))
1198
1199 static struct dummy_ep *find_endpoint (struct dummy *dum, u8 address)
1200 {
1201         int             i;
1202
1203         if (!is_active (dum))
1204                 return NULL;
1205         if ((address & ~USB_DIR_IN) == 0)
1206                 return &dum->ep [0];
1207         for (i = 1; i < DUMMY_ENDPOINTS; i++) {
1208                 struct dummy_ep *ep = &dum->ep [i];
1209
1210                 if (!ep->desc)
1211                         continue;
1212                 if (ep->desc->bEndpointAddress == address)
1213                         return ep;
1214         }
1215         return NULL;
1216 }
1217
1218 #undef is_active
1219
1220 #define Dev_Request     (USB_TYPE_STANDARD | USB_RECIP_DEVICE)
1221 #define Dev_InRequest   (Dev_Request | USB_DIR_IN)
1222 #define Intf_Request    (USB_TYPE_STANDARD | USB_RECIP_INTERFACE)
1223 #define Intf_InRequest  (Intf_Request | USB_DIR_IN)
1224 #define Ep_Request      (USB_TYPE_STANDARD | USB_RECIP_ENDPOINT)
1225 #define Ep_InRequest    (Ep_Request | USB_DIR_IN)
1226
1227 /* drive both sides of the transfers; looks like irq handlers to
1228  * both drivers except the callbacks aren't in_irq().
1229  */
1230 static void dummy_timer (unsigned long _dum)
1231 {
1232         struct dummy            *dum = (struct dummy *) _dum;
1233         struct urbp             *urbp, *tmp;
1234         unsigned long           flags;
1235         int                     limit, total;
1236         int                     i;
1237
1238         /* simplistic model for one frame's bandwidth */
1239         switch (dum->gadget.speed) {
1240         case USB_SPEED_LOW:
1241                 total = 8/*bytes*/ * 12/*packets*/;
1242                 break;
1243         case USB_SPEED_FULL:
1244                 total = 64/*bytes*/ * 19/*packets*/;
1245                 break;
1246         case USB_SPEED_HIGH:
1247                 total = 512/*bytes*/ * 13/*packets*/ * 8/*uframes*/;
1248                 break;
1249         default:
1250                 dev_err (dummy_dev(dum), "bogus device speed\n");
1251                 return;
1252         }
1253
1254         /* FIXME if HZ != 1000 this will probably misbehave ... */
1255
1256         /* look at each urb queued by the host side driver */
1257         spin_lock_irqsave (&dum->lock, flags);
1258
1259         if (!dum->udev) {
1260                 dev_err (dummy_dev(dum),
1261                                 "timer fired with no URBs pending?\n");
1262                 spin_unlock_irqrestore (&dum->lock, flags);
1263                 return;
1264         }
1265
1266         for (i = 0; i < DUMMY_ENDPOINTS; i++) {
1267                 if (!ep_name [i])
1268                         break;
1269                 dum->ep [i].already_seen = 0;
1270         }
1271
1272 restart:
1273         list_for_each_entry_safe (urbp, tmp, &dum->urbp_list, urbp_list) {
1274                 struct urb              *urb;
1275                 struct dummy_request    *req;
1276                 u8                      address;
1277                 struct dummy_ep         *ep = NULL;
1278                 int                     type;
1279
1280                 urb = urbp->urb;
1281                 if (urb->status != -EINPROGRESS) {
1282                         /* likely it was just unlinked */
1283                         goto return_urb;
1284                 } else if (dum->rh_state != DUMMY_RH_RUNNING)
1285                         continue;
1286                 type = usb_pipetype (urb->pipe);
1287
1288                 /* used up this frame's non-periodic bandwidth?
1289                  * FIXME there's infinite bandwidth for control and
1290                  * periodic transfers ... unrealistic.
1291                  */
1292                 if (total <= 0 && type == PIPE_BULK)
1293                         continue;
1294
1295                 /* find the gadget's ep for this request (if configured) */
1296                 address = usb_pipeendpoint (urb->pipe);
1297                 if (usb_pipein (urb->pipe))
1298                         address |= USB_DIR_IN;
1299                 ep = find_endpoint(dum, address);
1300                 if (!ep) {
1301                         /* set_configuration() disagreement */
1302                         dev_dbg (dummy_dev(dum),
1303                                 "no ep configured for urb %p\n",
1304                                 urb);
1305                         maybe_set_status (urb, -EPROTO);
1306                         goto return_urb;
1307                 }
1308
1309                 if (ep->already_seen)
1310                         continue;
1311                 ep->already_seen = 1;
1312                 if (ep == &dum->ep [0] && urb->error_count) {
1313                         ep->setup_stage = 1;    /* a new urb */
1314                         urb->error_count = 0;
1315                 }
1316                 if (ep->halted && !ep->setup_stage) {
1317                         /* NOTE: must not be iso! */
1318                         dev_dbg (dummy_dev(dum), "ep %s halted, urb %p\n",
1319                                         ep->ep.name, urb);
1320                         maybe_set_status (urb, -EPIPE);
1321                         goto return_urb;
1322                 }
1323                 /* FIXME make sure both ends agree on maxpacket */
1324
1325                 /* handle control requests */
1326                 if (ep == &dum->ep [0] && ep->setup_stage) {
1327                         struct usb_ctrlrequest          setup;
1328                         int                             value = 1;
1329                         struct dummy_ep                 *ep2;
1330                         unsigned                        w_index;
1331                         unsigned                        w_value;
1332
1333                         setup = *(struct usb_ctrlrequest*) urb->setup_packet;
1334                         w_index = le16_to_cpu(setup.wIndex);
1335                         w_value = le16_to_cpu(setup.wValue);
1336                         if (le16_to_cpu(setup.wLength) !=
1337                                         urb->transfer_buffer_length) {
1338                                 maybe_set_status (urb, -EOVERFLOW);
1339                                 goto return_urb;
1340                         }
1341
1342                         /* paranoia, in case of stale queued data */
1343                         list_for_each_entry (req, &ep->queue, queue) {
1344                                 list_del_init (&req->queue);
1345                                 req->req.status = -EOVERFLOW;
1346                                 dev_dbg (udc_dev(dum), "stale req = %p\n",
1347                                                 req);
1348
1349                                 spin_unlock (&dum->lock);
1350                                 req->req.complete (&ep->ep, &req->req);
1351                                 spin_lock (&dum->lock);
1352                                 ep->already_seen = 0;
1353                                 goto restart;
1354                         }
1355
1356                         /* gadget driver never sees set_address or operations
1357                          * on standard feature flags.  some hardware doesn't
1358                          * even expose them.
1359                          */
1360                         ep->last_io = jiffies;
1361                         ep->setup_stage = 0;
1362                         ep->halted = 0;
1363                         switch (setup.bRequest) {
1364                         case USB_REQ_SET_ADDRESS:
1365                                 if (setup.bRequestType != Dev_Request)
1366                                         break;
1367                                 dum->address = w_value;
1368                                 maybe_set_status (urb, 0);
1369                                 dev_dbg (udc_dev(dum), "set_address = %d\n",
1370                                                 w_value);
1371                                 value = 0;
1372                                 break;
1373                         case USB_REQ_SET_FEATURE:
1374                                 if (setup.bRequestType == Dev_Request) {
1375                                         value = 0;
1376                                         switch (w_value) {
1377                                         case USB_DEVICE_REMOTE_WAKEUP:
1378                                                 break;
1379                                         case USB_DEVICE_B_HNP_ENABLE:
1380                                                 dum->gadget.b_hnp_enable = 1;
1381                                                 break;
1382                                         case USB_DEVICE_A_HNP_SUPPORT:
1383                                                 dum->gadget.a_hnp_support = 1;
1384                                                 break;
1385                                         case USB_DEVICE_A_ALT_HNP_SUPPORT:
1386                                                 dum->gadget.a_alt_hnp_support
1387                                                         = 1;
1388                                                 break;
1389                                         default:
1390                                                 value = -EOPNOTSUPP;
1391                                         }
1392                                         if (value == 0) {
1393                                                 dum->devstatus |=
1394                                                         (1 << w_value);
1395                                                 maybe_set_status (urb, 0);
1396                                         }
1397
1398                                 } else if (setup.bRequestType == Ep_Request) {
1399                                         // endpoint halt
1400                                         ep2 = find_endpoint (dum, w_index);
1401                                         if (!ep2) {
1402                                                 value = -EOPNOTSUPP;
1403                                                 break;
1404                                         }
1405                                         ep2->halted = 1;
1406                                         value = 0;
1407                                         maybe_set_status (urb, 0);
1408                                 }
1409                                 break;
1410                         case USB_REQ_CLEAR_FEATURE:
1411                                 if (setup.bRequestType == Dev_Request) {
1412                                         switch (w_value) {
1413                                         case USB_DEVICE_REMOTE_WAKEUP:
1414                                                 dum->devstatus &= ~(1 <<
1415                                                         USB_DEVICE_REMOTE_WAKEUP);
1416                                                 value = 0;
1417                                                 maybe_set_status (urb, 0);
1418                                                 break;
1419                                         default:
1420                                                 value = -EOPNOTSUPP;
1421                                                 break;
1422                                         }
1423                                 } else if (setup.bRequestType == Ep_Request) {
1424                                         // endpoint halt
1425                                         ep2 = find_endpoint (dum, w_index);
1426                                         if (!ep2) {
1427                                                 value = -EOPNOTSUPP;
1428                                                 break;
1429                                         }
1430                                         ep2->halted = 0;
1431                                         value = 0;
1432                                         maybe_set_status (urb, 0);
1433                                 }
1434                                 break;
1435                         case USB_REQ_GET_STATUS:
1436                                 if (setup.bRequestType == Dev_InRequest
1437                                                 || setup.bRequestType
1438                                                         == Intf_InRequest
1439                                                 || setup.bRequestType
1440                                                         == Ep_InRequest
1441                                                 ) {
1442                                         char *buf;
1443
1444                                         // device: remote wakeup, selfpowered
1445                                         // interface: nothing
1446                                         // endpoint: halt
1447                                         buf = (char *)urb->transfer_buffer;
1448                                         if (urb->transfer_buffer_length > 0) {
1449                                                 if (setup.bRequestType ==
1450                                                                 Ep_InRequest) {
1451         ep2 = find_endpoint (dum, w_index);
1452         if (!ep2) {
1453                 value = -EOPNOTSUPP;
1454                 break;
1455         }
1456         buf [0] = ep2->halted;
1457                                                 } else if (setup.bRequestType ==
1458                                                                 Dev_InRequest) {
1459                                                         buf [0] = (u8)
1460                                                                 dum->devstatus;
1461                                                 } else
1462                                                         buf [0] = 0;
1463                                         }
1464                                         if (urb->transfer_buffer_length > 1)
1465                                                 buf [1] = 0;
1466                                         urb->actual_length = min (2,
1467                                                 urb->transfer_buffer_length);
1468                                         value = 0;
1469                                         maybe_set_status (urb, 0);
1470                                 }
1471                                 break;
1472                         }
1473
1474                         /* gadget driver handles all other requests.  block
1475                          * until setup() returns; no reentrancy issues etc.
1476                          */
1477                         if (value > 0) {
1478                                 spin_unlock (&dum->lock);
1479                                 value = dum->driver->setup (&dum->gadget,
1480                                                 &setup);
1481                                 spin_lock (&dum->lock);
1482
1483                                 if (value >= 0) {
1484                                         /* no delays (max 64KB data stage) */
1485                                         limit = 64*1024;
1486                                         goto treat_control_like_bulk;
1487                                 }
1488                                 /* error, see below */
1489                         }
1490
1491                         if (value < 0) {
1492                                 if (value != -EOPNOTSUPP)
1493                                         dev_dbg (udc_dev(dum),
1494                                                 "setup --> %d\n",
1495                                                 value);
1496                                 maybe_set_status (urb, -EPIPE);
1497                                 urb->actual_length = 0;
1498                         }
1499
1500                         goto return_urb;
1501                 }
1502
1503                 /* non-control requests */
1504                 limit = total;
1505                 switch (usb_pipetype (urb->pipe)) {
1506                 case PIPE_ISOCHRONOUS:
1507                         /* FIXME is it urb->interval since the last xfer?
1508                          * use urb->iso_frame_desc[i].
1509                          * complete whether or not ep has requests queued.
1510                          * report random errors, to debug drivers.
1511                          */
1512                         limit = max (limit, periodic_bytes (dum, ep));
1513                         maybe_set_status (urb, -ENOSYS);
1514                         break;
1515
1516                 case PIPE_INTERRUPT:
1517                         /* FIXME is it urb->interval since the last xfer?
1518                          * this almost certainly polls too fast.
1519                          */
1520                         limit = max (limit, periodic_bytes (dum, ep));
1521                         /* FALLTHROUGH */
1522
1523                 // case PIPE_BULK:  case PIPE_CONTROL:
1524                 default:
1525                 treat_control_like_bulk:
1526                         ep->last_io = jiffies;
1527                         total = transfer (dum, urb, ep, limit);
1528                         break;
1529                 }
1530
1531                 /* incomplete transfer? */
1532                 if (urb->status == -EINPROGRESS)
1533                         continue;
1534
1535 return_urb:
1536                 urb->hcpriv = NULL;
1537                 list_del (&urbp->urbp_list);
1538                 kfree (urbp);
1539                 if (ep)
1540                         ep->already_seen = ep->setup_stage = 0;
1541
1542                 spin_unlock (&dum->lock);
1543                 usb_hcd_giveback_urb (dummy_to_hcd(dum), urb, NULL);
1544                 spin_lock (&dum->lock);
1545
1546                 goto restart;
1547         }
1548
1549         if (list_empty (&dum->urbp_list)) {
1550                 usb_put_dev (dum->udev);
1551                 dum->udev = NULL;
1552         } else if (dum->rh_state == DUMMY_RH_RUNNING) {
1553                 /* want a 1 msec delay here */
1554                 mod_timer (&dum->timer, jiffies + msecs_to_jiffies(1));
1555         }
1556
1557         spin_unlock_irqrestore (&dum->lock, flags);
1558 }
1559
1560 /*-------------------------------------------------------------------------*/
1561
1562 #define PORT_C_MASK \
1563         ((USB_PORT_STAT_C_CONNECTION \
1564         | USB_PORT_STAT_C_ENABLE \
1565         | USB_PORT_STAT_C_SUSPEND \
1566         | USB_PORT_STAT_C_OVERCURRENT \
1567         | USB_PORT_STAT_C_RESET) << 16)
1568
1569 static int dummy_hub_status (struct usb_hcd *hcd, char *buf)
1570 {
1571         struct dummy            *dum;
1572         unsigned long           flags;
1573         int                     retval = 0;
1574
1575         dum = hcd_to_dummy (hcd);
1576
1577         spin_lock_irqsave (&dum->lock, flags);
1578         if (hcd->state != HC_STATE_RUNNING)
1579                 goto done;
1580
1581         if (dum->resuming && time_after_eq (jiffies, dum->re_timeout)) {
1582                 dum->port_status |= (USB_PORT_STAT_C_SUSPEND << 16);
1583                 dum->port_status &= ~USB_PORT_STAT_SUSPEND;
1584                 set_link_state (dum);
1585         }
1586
1587         if ((dum->port_status & PORT_C_MASK) != 0) {
1588                 *buf = (1 << 1);
1589                 dev_dbg (dummy_dev(dum), "port status 0x%08x has changes\n",
1590                                 dum->port_status);
1591                 retval = 1;
1592                 if (dum->rh_state == DUMMY_RH_SUSPENDED)
1593                         usb_hcd_resume_root_hub (hcd);
1594         }
1595 done:
1596         spin_unlock_irqrestore (&dum->lock, flags);
1597         return retval;
1598 }
1599
1600 static inline void
1601 hub_descriptor (struct usb_hub_descriptor *desc)
1602 {
1603         memset (desc, 0, sizeof *desc);
1604         desc->bDescriptorType = 0x29;
1605         desc->bDescLength = 9;
1606         desc->wHubCharacteristics = (__force __u16)
1607                         (__constant_cpu_to_le16 (0x0001));
1608         desc->bNbrPorts = 1;
1609         desc->bitmap [0] = 0xff;
1610         desc->bitmap [1] = 0xff;
1611 }
1612
1613 static int dummy_hub_control (
1614         struct usb_hcd  *hcd,
1615         u16             typeReq,
1616         u16             wValue,
1617         u16             wIndex,
1618         char            *buf,
1619         u16             wLength
1620 ) {
1621         struct dummy    *dum;
1622         int             retval = 0;
1623         unsigned long   flags;
1624
1625         if (hcd->state != HC_STATE_RUNNING)
1626                 return -ETIMEDOUT;
1627
1628         dum = hcd_to_dummy (hcd);
1629         spin_lock_irqsave (&dum->lock, flags);
1630         switch (typeReq) {
1631         case ClearHubFeature:
1632                 break;
1633         case ClearPortFeature:
1634                 switch (wValue) {
1635                 case USB_PORT_FEAT_SUSPEND:
1636                         if (dum->port_status & USB_PORT_STAT_SUSPEND) {
1637                                 /* 20msec resume signaling */
1638                                 dum->resuming = 1;
1639                                 dum->re_timeout = jiffies +
1640                                                 msecs_to_jiffies(20);
1641                         }
1642                         break;
1643                 case USB_PORT_FEAT_POWER:
1644                         if (dum->port_status & USB_PORT_STAT_POWER)
1645                                 dev_dbg (dummy_dev(dum), "power-off\n");
1646                         /* FALLS THROUGH */
1647                 default:
1648                         dum->port_status &= ~(1 << wValue);
1649                         set_link_state (dum);
1650                 }
1651                 break;
1652         case GetHubDescriptor:
1653                 hub_descriptor ((struct usb_hub_descriptor *) buf);
1654                 break;
1655         case GetHubStatus:
1656                 *(__le32 *) buf = __constant_cpu_to_le32 (0);
1657                 break;
1658         case GetPortStatus:
1659                 if (wIndex != 1)
1660                         retval = -EPIPE;
1661
1662                 /* whoever resets or resumes must GetPortStatus to
1663                  * complete it!!
1664                  */
1665                 if (dum->resuming &&
1666                                 time_after_eq (jiffies, dum->re_timeout)) {
1667                         dum->port_status |= (USB_PORT_STAT_C_SUSPEND << 16);
1668                         dum->port_status &= ~USB_PORT_STAT_SUSPEND;
1669                 }
1670                 if ((dum->port_status & USB_PORT_STAT_RESET) != 0 &&
1671                                 time_after_eq (jiffies, dum->re_timeout)) {
1672                         dum->port_status |= (USB_PORT_STAT_C_RESET << 16);
1673                         dum->port_status &= ~USB_PORT_STAT_RESET;
1674                         if (dum->pullup) {
1675                                 dum->port_status |= USB_PORT_STAT_ENABLE;
1676                                 /* give it the best speed we agree on */
1677                                 dum->gadget.speed = dum->driver->speed;
1678                                 dum->gadget.ep0->maxpacket = 64;
1679                                 switch (dum->gadget.speed) {
1680                                 case USB_SPEED_HIGH:
1681                                         dum->port_status |=
1682                                                 USB_PORT_STAT_HIGH_SPEED;
1683                                         break;
1684                                 case USB_SPEED_LOW:
1685                                         dum->gadget.ep0->maxpacket = 8;
1686                                         dum->port_status |=
1687                                                 USB_PORT_STAT_LOW_SPEED;
1688                                         break;
1689                                 default:
1690                                         dum->gadget.speed = USB_SPEED_FULL;
1691                                         break;
1692                                 }
1693                         }
1694                 }
1695                 set_link_state (dum);
1696                 ((__le16 *) buf)[0] = cpu_to_le16 (dum->port_status);
1697                 ((__le16 *) buf)[1] = cpu_to_le16 (dum->port_status >> 16);
1698                 break;
1699         case SetHubFeature:
1700                 retval = -EPIPE;
1701                 break;
1702         case SetPortFeature:
1703                 switch (wValue) {
1704                 case USB_PORT_FEAT_SUSPEND:
1705                         if (dum->active) {
1706                                 dum->port_status |= USB_PORT_STAT_SUSPEND;
1707
1708                                 /* HNP would happen here; for now we
1709                                  * assume b_bus_req is always true.
1710                                  */
1711                                 set_link_state (dum);
1712                                 if (((1 << USB_DEVICE_B_HNP_ENABLE)
1713                                                 & dum->devstatus) != 0)
1714                                         dev_dbg (dummy_dev(dum),
1715                                                         "no HNP yet!\n");
1716                         }
1717                         break;
1718                 case USB_PORT_FEAT_POWER:
1719                         dum->port_status |= USB_PORT_STAT_POWER;
1720                         set_link_state (dum);
1721                         break;
1722                 case USB_PORT_FEAT_RESET:
1723                         /* if it's already enabled, disable */
1724                         dum->port_status &= ~(USB_PORT_STAT_ENABLE
1725                                         | USB_PORT_STAT_LOW_SPEED
1726                                         | USB_PORT_STAT_HIGH_SPEED);
1727                         dum->devstatus = 0;
1728                         /* 50msec reset signaling */
1729                         dum->re_timeout = jiffies + msecs_to_jiffies(50);
1730                         /* FALLS THROUGH */
1731                 default:
1732                         if ((dum->port_status & USB_PORT_STAT_POWER) != 0) {
1733                                 dum->port_status |= (1 << wValue);
1734                                 set_link_state (dum);
1735                         }
1736                 }
1737                 break;
1738
1739         default:
1740                 dev_dbg (dummy_dev(dum),
1741                         "hub control req%04x v%04x i%04x l%d\n",
1742                         typeReq, wValue, wIndex, wLength);
1743
1744                 /* "protocol stall" on error */
1745                 retval = -EPIPE;
1746         }
1747         spin_unlock_irqrestore (&dum->lock, flags);
1748
1749         if ((dum->port_status & PORT_C_MASK) != 0)
1750                 usb_hcd_poll_rh_status (hcd);
1751         return retval;
1752 }
1753
1754 static int dummy_bus_suspend (struct usb_hcd *hcd)
1755 {
1756         struct dummy *dum = hcd_to_dummy (hcd);
1757
1758         spin_lock_irq (&dum->lock);
1759         dum->rh_state = DUMMY_RH_SUSPENDED;
1760         set_link_state (dum);
1761         spin_unlock_irq (&dum->lock);
1762         return 0;
1763 }
1764
1765 static int dummy_bus_resume (struct usb_hcd *hcd)
1766 {
1767         struct dummy *dum = hcd_to_dummy (hcd);
1768
1769         spin_lock_irq (&dum->lock);
1770         dum->rh_state = DUMMY_RH_RUNNING;
1771         set_link_state (dum);
1772         if (!list_empty(&dum->urbp_list))
1773                 mod_timer (&dum->timer, jiffies);
1774         spin_unlock_irq (&dum->lock);
1775         return 0;
1776 }
1777
1778 /*-------------------------------------------------------------------------*/
1779
1780 static inline ssize_t
1781 show_urb (char *buf, size_t size, struct urb *urb)
1782 {
1783         int ep = usb_pipeendpoint (urb->pipe);
1784
1785         return snprintf (buf, size,
1786                 "urb/%p %s ep%d%s%s len %d/%d\n",
1787                 urb,
1788                 ({ char *s;
1789                  switch (urb->dev->speed) {
1790                  case USB_SPEED_LOW:    s = "ls"; break;
1791                  case USB_SPEED_FULL:   s = "fs"; break;
1792                  case USB_SPEED_HIGH:   s = "hs"; break;
1793                  default:               s = "?"; break;
1794                  }; s; }),
1795                 ep, ep ? (usb_pipein (urb->pipe) ? "in" : "out") : "",
1796                 ({ char *s; \
1797                  switch (usb_pipetype (urb->pipe)) { \
1798                  case PIPE_CONTROL:     s = ""; break; \
1799                  case PIPE_BULK:        s = "-bulk"; break; \
1800                  case PIPE_INTERRUPT:   s = "-int"; break; \
1801                  default:               s = "-iso"; break; \
1802                 }; s;}),
1803                 urb->actual_length, urb->transfer_buffer_length);
1804 }
1805
1806 static ssize_t
1807 show_urbs (struct device *dev, struct device_attribute *attr, char *buf)
1808 {
1809         struct usb_hcd          *hcd = dev_get_drvdata (dev);
1810         struct dummy            *dum = hcd_to_dummy (hcd);
1811         struct urbp             *urbp;
1812         size_t                  size = 0;
1813         unsigned long           flags;
1814
1815         spin_lock_irqsave (&dum->lock, flags);
1816         list_for_each_entry (urbp, &dum->urbp_list, urbp_list) {
1817                 size_t          temp;
1818
1819                 temp = show_urb (buf, PAGE_SIZE - size, urbp->urb);
1820                 buf += temp;
1821                 size += temp;
1822         }
1823         spin_unlock_irqrestore (&dum->lock, flags);
1824
1825         return size;
1826 }
1827 static DEVICE_ATTR (urbs, S_IRUGO, show_urbs, NULL);
1828
1829 static int dummy_start (struct usb_hcd *hcd)
1830 {
1831         struct dummy            *dum;
1832
1833         dum = hcd_to_dummy (hcd);
1834
1835         /*
1836          * MASTER side init ... we emulate a root hub that'll only ever
1837          * talk to one device (the slave side).  Also appears in sysfs,
1838          * just like more familiar pci-based HCDs.
1839          */
1840         spin_lock_init (&dum->lock);
1841         init_timer (&dum->timer);
1842         dum->timer.function = dummy_timer;
1843         dum->timer.data = (unsigned long) dum;
1844         dum->rh_state = DUMMY_RH_RUNNING;
1845
1846         INIT_LIST_HEAD (&dum->urbp_list);
1847
1848         /* only show a low-power port: just 8mA */
1849         hcd->power_budget = 8;
1850         hcd->state = HC_STATE_RUNNING;
1851         hcd->uses_new_polling = 1;
1852
1853 #ifdef CONFIG_USB_OTG
1854         hcd->self.otg_port = 1;
1855 #endif
1856
1857         /* FIXME 'urbs' should be a per-device thing, maybe in usbcore */
1858         device_create_file (dummy_dev(dum), &dev_attr_urbs);
1859         return 0;
1860 }
1861
1862 static void dummy_stop (struct usb_hcd *hcd)
1863 {
1864         struct dummy            *dum;
1865
1866         dum = hcd_to_dummy (hcd);
1867
1868         device_remove_file (dummy_dev(dum), &dev_attr_urbs);
1869         usb_gadget_unregister_driver (dum->driver);
1870         dev_info (dummy_dev(dum), "stopped\n");
1871 }
1872
1873 /*-------------------------------------------------------------------------*/
1874
1875 static int dummy_h_get_frame (struct usb_hcd *hcd)
1876 {
1877         return dummy_g_get_frame (NULL);
1878 }
1879
1880 static const struct hc_driver dummy_hcd = {
1881         .description =          (char *) driver_name,
1882         .product_desc =         "Dummy host controller",
1883         .hcd_priv_size =        sizeof(struct dummy),
1884
1885         .flags =                HCD_USB2,
1886
1887         .start =                dummy_start,
1888         .stop =                 dummy_stop,
1889
1890         .urb_enqueue =          dummy_urb_enqueue,
1891         .urb_dequeue =          dummy_urb_dequeue,
1892
1893         .get_frame_number =     dummy_h_get_frame,
1894
1895         .hub_status_data =      dummy_hub_status,
1896         .hub_control =          dummy_hub_control,
1897         .bus_suspend =          dummy_bus_suspend,
1898         .bus_resume =           dummy_bus_resume,
1899 };
1900
1901 static int dummy_hcd_probe (struct device *dev)
1902 {
1903         struct usb_hcd          *hcd;
1904         int                     retval;
1905
1906         dev_info (dev, "%s, driver " DRIVER_VERSION "\n", driver_desc);
1907
1908         hcd = usb_create_hcd (&dummy_hcd, dev, dev->bus_id);
1909         if (!hcd)
1910                 return -ENOMEM;
1911         the_controller = hcd_to_dummy (hcd);
1912
1913         retval = usb_add_hcd(hcd, 0, 0);
1914         if (retval != 0) {
1915                 usb_put_hcd (hcd);
1916                 the_controller = NULL;
1917         }
1918         return retval;
1919 }
1920
1921 static int dummy_hcd_remove (struct device *dev)
1922 {
1923         struct usb_hcd          *hcd;
1924
1925         hcd = dev_get_drvdata (dev);
1926         usb_remove_hcd (hcd);
1927         usb_put_hcd (hcd);
1928         the_controller = NULL;
1929         return 0;
1930 }
1931
1932 static int dummy_hcd_suspend (struct device *dev, pm_message_t state)
1933 {
1934         struct usb_hcd          *hcd;
1935
1936         dev_dbg (dev, "%s\n", __FUNCTION__);
1937         hcd = dev_get_drvdata (dev);
1938
1939         hcd->state = HC_STATE_SUSPENDED;
1940         return 0;
1941 }
1942
1943 static int dummy_hcd_resume (struct device *dev)
1944 {
1945         struct usb_hcd          *hcd;
1946
1947         dev_dbg (dev, "%s\n", __FUNCTION__);
1948         hcd = dev_get_drvdata (dev);
1949         hcd->state = HC_STATE_RUNNING;
1950
1951         usb_hcd_poll_rh_status (hcd);
1952         return 0;
1953 }
1954
1955 static struct device_driver dummy_hcd_driver = {
1956         .name           = (char *) driver_name,
1957         .owner          = THIS_MODULE,
1958         .bus            = &platform_bus_type,
1959         .probe          = dummy_hcd_probe,
1960         .remove         = dummy_hcd_remove,
1961         .suspend        = dummy_hcd_suspend,
1962         .resume         = dummy_hcd_resume,
1963 };
1964
1965 /*-------------------------------------------------------------------------*/
1966
1967 /* These don't need to do anything because the pdev structures are
1968  * statically allocated. */
1969 static void
1970 dummy_udc_release (struct device *dev) {}
1971
1972 static void
1973 dummy_hcd_release (struct device *dev) {}
1974
1975 static struct platform_device           the_udc_pdev = {
1976         .name           = (char *) gadget_name,
1977         .id             = -1,
1978         .dev            = {
1979                 .release        = dummy_udc_release,
1980         },
1981 };
1982
1983 static struct platform_device           the_hcd_pdev = {
1984         .name           = (char *) driver_name,
1985         .id             = -1,
1986         .dev            = {
1987                 .release        = dummy_hcd_release,
1988         },
1989 };
1990
1991 static int __init init (void)
1992 {
1993         int     retval;
1994
1995         if (usb_disabled ())
1996                 return -ENODEV;
1997
1998         retval = driver_register (&dummy_hcd_driver);
1999         if (retval < 0)
2000                 return retval;
2001
2002         retval = driver_register (&dummy_udc_driver);
2003         if (retval < 0)
2004                 goto err_register_udc_driver;
2005
2006         retval = platform_device_register (&the_hcd_pdev);
2007         if (retval < 0)
2008                 goto err_register_hcd;
2009
2010         retval = platform_device_register (&the_udc_pdev);
2011         if (retval < 0)
2012                 goto err_register_udc;
2013         return retval;
2014
2015 err_register_udc:
2016         platform_device_unregister (&the_hcd_pdev);
2017 err_register_hcd:
2018         driver_unregister (&dummy_udc_driver);
2019 err_register_udc_driver:
2020         driver_unregister (&dummy_hcd_driver);
2021         return retval;
2022 }
2023 module_init (init);
2024
2025 static void __exit cleanup (void)
2026 {
2027         platform_device_unregister (&the_udc_pdev);
2028         platform_device_unregister (&the_hcd_pdev);
2029         driver_unregister (&dummy_udc_driver);
2030         driver_unregister (&dummy_hcd_driver);
2031 }
2032 module_exit (cleanup);