Merge branch 'master' of git://git.denx.de/u-boot-rockchip
[oweals/u-boot.git] / drivers / serial / usbtty.c
1 /*
2  * (C) Copyright 2003
3  * Gerry Hamel, geh@ti.com, Texas Instruments
4  *
5  * (C) Copyright 2006
6  * Bryan O'Donoghue, bodonoghue@codehermit.ie
7  *
8  * SPDX-License-Identifier:     GPL-2.0+
9  */
10
11 #include <common.h>
12 #include <config.h>
13 #include <circbuf.h>
14 #include <stdio_dev.h>
15 #include <asm/unaligned.h>
16 #include "usbtty.h"
17 #include "usb_cdc_acm.h"
18 #include "usbdescriptors.h"
19
20 #ifdef DEBUG
21 #define TTYDBG(fmt,args...)\
22         serial_printf("[%s] %s %d: "fmt, __FILE__,__FUNCTION__,__LINE__,##args)
23 #else
24 #define TTYDBG(fmt,args...) do{}while(0)
25 #endif
26
27 #if 1
28 #define TTYERR(fmt,args...)\
29         serial_printf("ERROR![%s] %s %d: "fmt, __FILE__,__FUNCTION__,\
30         __LINE__,##args)
31 #else
32 #define TTYERR(fmt,args...) do{}while(0)
33 #endif
34
35 /*
36  * Defines
37  */
38 #define NUM_CONFIGS    1
39 #define MAX_INTERFACES 2
40 #define NUM_ENDPOINTS  3
41 #define ACM_TX_ENDPOINT 3
42 #define ACM_RX_ENDPOINT 2
43 #define GSERIAL_TX_ENDPOINT 2
44 #define GSERIAL_RX_ENDPOINT 1
45 #define NUM_ACM_INTERFACES 2
46 #define NUM_GSERIAL_INTERFACES 1
47 #define CONFIG_USBD_DATA_INTERFACE_STR "Bulk Data Interface"
48 #define CONFIG_USBD_CTRL_INTERFACE_STR "Control Interface"
49
50 /*
51  * Buffers to hold input and output data
52  */
53 #define USBTTY_BUFFER_SIZE 2048
54 static circbuf_t usbtty_input;
55 static circbuf_t usbtty_output;
56
57
58 /*
59  * Instance variables
60  */
61 static struct stdio_dev usbttydev;
62 static struct usb_device_instance device_instance[1];
63 static struct usb_bus_instance bus_instance[1];
64 static struct usb_configuration_instance config_instance[NUM_CONFIGS];
65 static struct usb_interface_instance interface_instance[MAX_INTERFACES];
66 static struct usb_alternate_instance alternate_instance[MAX_INTERFACES];
67 /* one extra for control endpoint */
68 static struct usb_endpoint_instance endpoint_instance[NUM_ENDPOINTS+1];
69
70 /*
71  * Global flag
72  */
73 int usbtty_configured_flag = 0;
74
75 /*
76  * Serial number
77  */
78 static char serial_number[16];
79
80
81 /*
82  * Descriptors, Strings, Local variables.
83  */
84
85 /* defined and used by gadget/ep0.c */
86 extern struct usb_string_descriptor **usb_strings;
87
88 /* Indicies, References */
89 static unsigned short rx_endpoint = 0;
90 static unsigned short tx_endpoint = 0;
91 static unsigned short interface_count = 0;
92 static struct usb_string_descriptor *usbtty_string_table[STR_COUNT];
93
94 /* USB Descriptor Strings */
95 static u8 wstrLang[4] = {4,USB_DT_STRING,0x9,0x4};
96 static u8 wstrManufacturer[2 + 2*(sizeof(CONFIG_USBD_MANUFACTURER)-1)];
97 static u8 wstrProduct[2 + 2*(sizeof(CONFIG_USBD_PRODUCT_NAME)-1)];
98 static u8 wstrSerial[2 + 2*(sizeof(serial_number) - 1)];
99 static u8 wstrConfiguration[2 + 2*(sizeof(CONFIG_USBD_CONFIGURATION_STR)-1)];
100 static u8 wstrDataInterface[2 + 2*(sizeof(CONFIG_USBD_DATA_INTERFACE_STR)-1)];
101 static u8 wstrCtrlInterface[2 + 2*(sizeof(CONFIG_USBD_DATA_INTERFACE_STR)-1)];
102
103 /* Standard USB Data Structures */
104 static struct usb_interface_descriptor interface_descriptors[MAX_INTERFACES];
105 static struct usb_endpoint_descriptor *ep_descriptor_ptrs[NUM_ENDPOINTS];
106 static struct usb_configuration_descriptor      *configuration_descriptor = 0;
107 static struct usb_device_descriptor device_descriptor = {
108         .bLength = sizeof(struct usb_device_descriptor),
109         .bDescriptorType =      USB_DT_DEVICE,
110         .bcdUSB =               cpu_to_le16(USB_BCD_VERSION),
111         .bDeviceSubClass =      0x00,
112         .bDeviceProtocol =      0x00,
113         .bMaxPacketSize0 =      EP0_MAX_PACKET_SIZE,
114         .idVendor =             cpu_to_le16(CONFIG_USBD_VENDORID),
115         .bcdDevice =            cpu_to_le16(USBTTY_BCD_DEVICE),
116         .iManufacturer =        STR_MANUFACTURER,
117         .iProduct =             STR_PRODUCT,
118         .iSerialNumber =        STR_SERIAL,
119         .bNumConfigurations =   NUM_CONFIGS
120 };
121
122
123 #if defined(CONFIG_USBD_HS)
124 static struct usb_qualifier_descriptor qualifier_descriptor = {
125         .bLength = sizeof(struct usb_qualifier_descriptor),
126         .bDescriptorType =      USB_DT_QUAL,
127         .bcdUSB =               cpu_to_le16(USB_BCD_VERSION),
128         .bDeviceClass =         COMMUNICATIONS_DEVICE_CLASS,
129         .bDeviceSubClass =      0x00,
130         .bDeviceProtocol =      0x00,
131         .bMaxPacketSize0 =      EP0_MAX_PACKET_SIZE,
132         .bNumConfigurations =   NUM_CONFIGS
133 };
134 #endif
135
136 /*
137  * Static CDC ACM specific descriptors
138  */
139
140 struct acm_config_desc {
141         struct usb_configuration_descriptor configuration_desc;
142
143         /* Master Interface */
144         struct usb_interface_descriptor interface_desc;
145
146         struct usb_class_header_function_descriptor usb_class_header;
147         struct usb_class_call_management_descriptor usb_class_call_mgt;
148         struct usb_class_abstract_control_descriptor usb_class_acm;
149         struct usb_class_union_function_descriptor usb_class_union;
150         struct usb_endpoint_descriptor notification_endpoint;
151
152         /* Slave Interface */
153         struct usb_interface_descriptor data_class_interface;
154         struct usb_endpoint_descriptor data_endpoints[NUM_ENDPOINTS-1];
155 } __attribute__((packed));
156
157 static struct acm_config_desc acm_configuration_descriptors[NUM_CONFIGS] = {
158         {
159                 .configuration_desc ={
160                         .bLength =
161                                 sizeof(struct usb_configuration_descriptor),
162                         .bDescriptorType = USB_DT_CONFIG,
163                         .wTotalLength =
164                                 cpu_to_le16(sizeof(struct acm_config_desc)),
165                         .bNumInterfaces = NUM_ACM_INTERFACES,
166                         .bConfigurationValue = 1,
167                         .iConfiguration = STR_CONFIG,
168                         .bmAttributes =
169                                 BMATTRIBUTE_SELF_POWERED|BMATTRIBUTE_RESERVED,
170                         .bMaxPower = USBTTY_MAXPOWER
171                 },
172                 /* Interface 1 */
173                 .interface_desc = {
174                         .bLength  = sizeof(struct usb_interface_descriptor),
175                         .bDescriptorType = USB_DT_INTERFACE,
176                         .bInterfaceNumber = 0,
177                         .bAlternateSetting = 0,
178                         .bNumEndpoints = 0x01,
179                         .bInterfaceClass =
180                                 COMMUNICATIONS_INTERFACE_CLASS_CONTROL,
181                         .bInterfaceSubClass = COMMUNICATIONS_ACM_SUBCLASS,
182                         .bInterfaceProtocol = COMMUNICATIONS_V25TER_PROTOCOL,
183                         .iInterface = STR_CTRL_INTERFACE,
184                 },
185                 .usb_class_header = {
186                         .bFunctionLength        =
187                                 sizeof(struct usb_class_header_function_descriptor),
188                         .bDescriptorType        = CS_INTERFACE,
189                         .bDescriptorSubtype     = USB_ST_HEADER,
190                         .bcdCDC = cpu_to_le16(110),
191                 },
192                 .usb_class_call_mgt = {
193                         .bFunctionLength        =
194                                 sizeof(struct usb_class_call_management_descriptor),
195                         .bDescriptorType        = CS_INTERFACE,
196                         .bDescriptorSubtype     = USB_ST_CMF,
197                         .bmCapabilities         = 0x00,
198                         .bDataInterface         = 0x01,
199                 },
200                 .usb_class_acm = {
201                         .bFunctionLength        =
202                                 sizeof(struct usb_class_abstract_control_descriptor),
203                         .bDescriptorType        = CS_INTERFACE,
204                         .bDescriptorSubtype     = USB_ST_ACMF,
205                         .bmCapabilities         = 0x00,
206                 },
207                 .usb_class_union = {
208                         .bFunctionLength        =
209                                 sizeof(struct usb_class_union_function_descriptor),
210                         .bDescriptorType        = CS_INTERFACE,
211                         .bDescriptorSubtype     = USB_ST_UF,
212                         .bMasterInterface       = 0x00,
213                         .bSlaveInterface0       = 0x01,
214                 },
215                 .notification_endpoint = {
216                         .bLength =
217                                 sizeof(struct usb_endpoint_descriptor),
218                         .bDescriptorType        = USB_DT_ENDPOINT,
219                         .bEndpointAddress       = UDC_INT_ENDPOINT | USB_DIR_IN,
220                         .bmAttributes           = USB_ENDPOINT_XFER_INT,
221                         .wMaxPacketSize
222                                 = cpu_to_le16(CONFIG_USBD_SERIAL_INT_PKTSIZE),
223                         .bInterval              = 0xFF,
224                 },
225
226                 /* Interface 2 */
227                 .data_class_interface = {
228                         .bLength                =
229                                 sizeof(struct usb_interface_descriptor),
230                         .bDescriptorType        = USB_DT_INTERFACE,
231                         .bInterfaceNumber       = 0x01,
232                         .bAlternateSetting      = 0x00,
233                         .bNumEndpoints          = 0x02,
234                         .bInterfaceClass        =
235                                 COMMUNICATIONS_INTERFACE_CLASS_DATA,
236                         .bInterfaceSubClass     = DATA_INTERFACE_SUBCLASS_NONE,
237                         .bInterfaceProtocol     = DATA_INTERFACE_PROTOCOL_NONE,
238                         .iInterface             = STR_DATA_INTERFACE,
239                 },
240                 .data_endpoints = {
241                         {
242                                 .bLength                =
243                                         sizeof(struct usb_endpoint_descriptor),
244                                 .bDescriptorType        = USB_DT_ENDPOINT,
245                                 .bEndpointAddress       = UDC_OUT_ENDPOINT | USB_DIR_OUT,
246                                 .bmAttributes           =
247                                         USB_ENDPOINT_XFER_BULK,
248                                 .wMaxPacketSize         =
249                                         cpu_to_le16(CONFIG_USBD_SERIAL_BULK_PKTSIZE),
250                                 .bInterval              = 0xFF,
251                         },
252                         {
253                                 .bLength                =
254                                         sizeof(struct usb_endpoint_descriptor),
255                                 .bDescriptorType        = USB_DT_ENDPOINT,
256                                 .bEndpointAddress       = UDC_IN_ENDPOINT | USB_DIR_IN,
257                                 .bmAttributes           =
258                                         USB_ENDPOINT_XFER_BULK,
259                                 .wMaxPacketSize         =
260                                         cpu_to_le16(CONFIG_USBD_SERIAL_BULK_PKTSIZE),
261                                 .bInterval              = 0xFF,
262                         },
263                 },
264         },
265 };
266
267 static struct rs232_emu rs232_desc={
268                 .dter           =       115200,
269                 .stop_bits      =       0x00,
270                 .parity         =       0x00,
271                 .data_bits      =       0x08
272 };
273
274
275 /*
276  * Static Generic Serial specific data
277  */
278
279
280 struct gserial_config_desc {
281
282         struct usb_configuration_descriptor configuration_desc;
283         struct usb_interface_descriptor interface_desc[NUM_GSERIAL_INTERFACES];
284         struct usb_endpoint_descriptor data_endpoints[NUM_ENDPOINTS];
285
286 } __attribute__((packed));
287
288 static struct gserial_config_desc
289 gserial_configuration_descriptors[NUM_CONFIGS] ={
290         {
291                 .configuration_desc ={
292                         .bLength = sizeof(struct usb_configuration_descriptor),
293                         .bDescriptorType = USB_DT_CONFIG,
294                         .wTotalLength =
295                                 cpu_to_le16(sizeof(struct gserial_config_desc)),
296                         .bNumInterfaces = NUM_GSERIAL_INTERFACES,
297                         .bConfigurationValue = 1,
298                         .iConfiguration = STR_CONFIG,
299                         .bmAttributes =
300                                 BMATTRIBUTE_SELF_POWERED|BMATTRIBUTE_RESERVED,
301                         .bMaxPower = USBTTY_MAXPOWER
302                 },
303                 .interface_desc = {
304                         {
305                                 .bLength  =
306                                         sizeof(struct usb_interface_descriptor),
307                                 .bDescriptorType = USB_DT_INTERFACE,
308                                 .bInterfaceNumber = 0,
309                                 .bAlternateSetting = 0,
310                                 .bNumEndpoints = NUM_ENDPOINTS,
311                                 .bInterfaceClass =
312                                         COMMUNICATIONS_INTERFACE_CLASS_VENDOR,
313                                 .bInterfaceSubClass =
314                                         COMMUNICATIONS_NO_SUBCLASS,
315                                 .bInterfaceProtocol =
316                                         COMMUNICATIONS_NO_PROTOCOL,
317                                 .iInterface = STR_DATA_INTERFACE
318                         },
319                 },
320                 .data_endpoints  = {
321                         {
322                                 .bLength =
323                                         sizeof(struct usb_endpoint_descriptor),
324                                 .bDescriptorType =      USB_DT_ENDPOINT,
325                                 .bEndpointAddress =     UDC_OUT_ENDPOINT | USB_DIR_OUT,
326                                 .bmAttributes =         USB_ENDPOINT_XFER_BULK,
327                                 .wMaxPacketSize =
328                                         cpu_to_le16(CONFIG_USBD_SERIAL_OUT_PKTSIZE),
329                                 .bInterval=             0xFF,
330                         },
331                         {
332                                 .bLength =
333                                         sizeof(struct usb_endpoint_descriptor),
334                                 .bDescriptorType =      USB_DT_ENDPOINT,
335                                 .bEndpointAddress =     UDC_IN_ENDPOINT | USB_DIR_IN,
336                                 .bmAttributes =         USB_ENDPOINT_XFER_BULK,
337                                 .wMaxPacketSize =
338                                         cpu_to_le16(CONFIG_USBD_SERIAL_IN_PKTSIZE),
339                                 .bInterval =            0xFF,
340                         },
341                         {
342                                 .bLength =
343                                         sizeof(struct usb_endpoint_descriptor),
344                                 .bDescriptorType =      USB_DT_ENDPOINT,
345                                 .bEndpointAddress =     UDC_INT_ENDPOINT | USB_DIR_IN,
346                                 .bmAttributes =         USB_ENDPOINT_XFER_INT,
347                                 .wMaxPacketSize =
348                                         cpu_to_le16(CONFIG_USBD_SERIAL_INT_PKTSIZE),
349                                 .bInterval =            0xFF,
350                         },
351                 },
352         },
353 };
354
355 /*
356  * Static Function Prototypes
357  */
358
359 static void usbtty_init_strings (void);
360 static void usbtty_init_instances (void);
361 static void usbtty_init_endpoints (void);
362 static void usbtty_init_terminal_type(short type);
363 static void usbtty_event_handler (struct usb_device_instance *device,
364                                 usb_device_event_t event, int data);
365 static int usbtty_cdc_setup(struct usb_device_request *request,
366                                 struct urb *urb);
367 static int usbtty_configured (void);
368 static int write_buffer (circbuf_t * buf);
369 static int fill_buffer (circbuf_t * buf);
370
371 void usbtty_poll (void);
372
373 /* utility function for converting char* to wide string used by USB */
374 static void str2wide (char *str, u16 * wide)
375 {
376         int i;
377         for (i = 0; i < strlen (str) && str[i]; i++){
378                 #if defined(__LITTLE_ENDIAN)
379                         wide[i] = (u16) str[i];
380                 #elif defined(__BIG_ENDIAN)
381                         wide[i] = ((u16)(str[i])<<8);
382                 #else
383                         #error "__LITTLE_ENDIAN or __BIG_ENDIAN undefined"
384                 #endif
385         }
386 }
387
388 /*
389  * Test whether a character is in the RX buffer
390  */
391
392 int usbtty_tstc(struct stdio_dev *dev)
393 {
394         struct usb_endpoint_instance *endpoint =
395                 &endpoint_instance[rx_endpoint];
396
397         /* If no input data exists, allow more RX to be accepted */
398         if(usbtty_input.size <= 0){
399                 udc_unset_nak(endpoint->endpoint_address&0x03);
400         }
401
402         usbtty_poll ();
403         return (usbtty_input.size > 0);
404 }
405
406 /*
407  * Read a single byte from the usb client port. Returns 1 on success, 0
408  * otherwise. When the function is succesfull, the character read is
409  * written into its argument c.
410  */
411
412 int usbtty_getc(struct stdio_dev *dev)
413 {
414         char c;
415         struct usb_endpoint_instance *endpoint =
416                 &endpoint_instance[rx_endpoint];
417
418         while (usbtty_input.size <= 0) {
419                 udc_unset_nak(endpoint->endpoint_address&0x03);
420                 usbtty_poll ();
421         }
422
423         buf_pop (&usbtty_input, &c, 1);
424         udc_set_nak(endpoint->endpoint_address&0x03);
425
426         return c;
427 }
428
429 /*
430  * Output a single byte to the usb client port.
431  */
432 void usbtty_putc(struct stdio_dev *dev, const char c)
433 {
434         if (!usbtty_configured ())
435                 return;
436
437         /* If \n, also do \r */
438         if (c == '\n')
439                 buf_push (&usbtty_output, "\r", 1);
440
441         buf_push(&usbtty_output, &c, 1);
442
443         /* Poll at end to handle new data... */
444         if ((usbtty_output.size + 2) >= usbtty_output.totalsize) {
445                 usbtty_poll ();
446         }
447 }
448
449 /* usbtty_puts() helper function for finding the next '\n' in a string */
450 static int next_nl_pos (const char *s)
451 {
452         int i;
453
454         for (i = 0; s[i] != '\0'; i++) {
455                 if (s[i] == '\n')
456                         return i;
457         }
458         return i;
459 }
460
461 /*
462  * Output a string to the usb client port - implementing flow control
463  */
464
465 static void __usbtty_puts (const char *str, int len)
466 {
467         int maxlen = usbtty_output.totalsize;
468         int space, n;
469
470         /* break str into chunks < buffer size, if needed */
471         while (len > 0) {
472                 usbtty_poll ();
473
474                 space = maxlen - usbtty_output.size;
475                 /* Empty buffer here, if needed, to ensure space... */
476                 if (space) {
477                         write_buffer (&usbtty_output);
478
479                         n = min(space, min(len, maxlen));
480                         buf_push (&usbtty_output, str, n);
481
482                         str += n;
483                         len -= n;
484                 }
485         }
486 }
487
488 void usbtty_puts(struct stdio_dev *dev, const char *str)
489 {
490         int n;
491         int len;
492
493         if (!usbtty_configured ())
494                 return;
495
496         len = strlen (str);
497         /* add '\r' for each '\n' */
498         while (len > 0) {
499                 n = next_nl_pos (str);
500
501                 if (str[n] == '\n') {
502                         __usbtty_puts("\r", 1);
503                         __usbtty_puts(str, n + 1);
504                         str += (n + 1);
505                         len -= (n + 1);
506                 } else {
507                         /* No \n found.  All done. */
508                         __usbtty_puts (str, n);
509                         break;
510                 }
511         }
512
513         /* Poll at end to handle new data... */
514         usbtty_poll ();
515 }
516
517 /*
518  * Initialize the usb client port.
519  *
520  */
521 int drv_usbtty_init (void)
522 {
523         int rc;
524         char * sn;
525         char * tt;
526         int snlen;
527
528         /* Ger seiral number */
529         if (!(sn = getenv("serial#"))) {
530                 sn = "000000000000";
531         }
532         snlen = strlen(sn);
533         if (snlen > sizeof(serial_number) - 1) {
534                 printf ("Warning: serial number %s is too long (%d > %lu)\n",
535                         sn, snlen, (ulong)(sizeof(serial_number) - 1));
536                 snlen = sizeof(serial_number) - 1;
537         }
538         memcpy (serial_number, sn, snlen);
539         serial_number[snlen] = '\0';
540
541         /* Decide on which type of UDC device to be.
542          */
543
544         if(!(tt = getenv("usbtty"))) {
545                 tt = "generic";
546         }
547         usbtty_init_terminal_type(strcmp(tt,"cdc_acm"));
548
549         /* prepare buffers... */
550         buf_init (&usbtty_input, USBTTY_BUFFER_SIZE);
551         buf_init (&usbtty_output, USBTTY_BUFFER_SIZE);
552
553         /* Now, set up USB controller and infrastructure */
554         udc_init ();            /* Basic USB initialization */
555
556         usbtty_init_strings ();
557         usbtty_init_instances ();
558
559         usbtty_init_endpoints ();
560
561         udc_startup_events (device_instance);/* Enable dev, init udc pointers */
562         udc_connect ();         /* Enable pullup for host detection */
563
564         /* Device initialization */
565         memset (&usbttydev, 0, sizeof (usbttydev));
566
567         strcpy (usbttydev.name, "usbtty");
568         usbttydev.ext = 0;      /* No extensions */
569         usbttydev.flags = DEV_FLAGS_INPUT | DEV_FLAGS_OUTPUT;
570         usbttydev.tstc = usbtty_tstc;   /* 'tstc' function */
571         usbttydev.getc = usbtty_getc;   /* 'getc' function */
572         usbttydev.putc = usbtty_putc;   /* 'putc' function */
573         usbttydev.puts = usbtty_puts;   /* 'puts' function */
574
575         rc = stdio_register (&usbttydev);
576
577         return (rc == 0) ? 1 : rc;
578 }
579
580 static void usbtty_init_strings (void)
581 {
582         struct usb_string_descriptor *string;
583
584         usbtty_string_table[STR_LANG] =
585                 (struct usb_string_descriptor*)wstrLang;
586
587         string = (struct usb_string_descriptor *) wstrManufacturer;
588         string->bLength = sizeof(wstrManufacturer);
589         string->bDescriptorType = USB_DT_STRING;
590         str2wide (CONFIG_USBD_MANUFACTURER, string->wData);
591         usbtty_string_table[STR_MANUFACTURER]=string;
592
593
594         string = (struct usb_string_descriptor *) wstrProduct;
595         string->bLength = sizeof(wstrProduct);
596         string->bDescriptorType = USB_DT_STRING;
597         str2wide (CONFIG_USBD_PRODUCT_NAME, string->wData);
598         usbtty_string_table[STR_PRODUCT]=string;
599
600
601         string = (struct usb_string_descriptor *) wstrSerial;
602         string->bLength = sizeof(serial_number);
603         string->bDescriptorType = USB_DT_STRING;
604         str2wide (serial_number, string->wData);
605         usbtty_string_table[STR_SERIAL]=string;
606
607
608         string = (struct usb_string_descriptor *) wstrConfiguration;
609         string->bLength = sizeof(wstrConfiguration);
610         string->bDescriptorType = USB_DT_STRING;
611         str2wide (CONFIG_USBD_CONFIGURATION_STR, string->wData);
612         usbtty_string_table[STR_CONFIG]=string;
613
614
615         string = (struct usb_string_descriptor *) wstrDataInterface;
616         string->bLength = sizeof(wstrDataInterface);
617         string->bDescriptorType = USB_DT_STRING;
618         str2wide (CONFIG_USBD_DATA_INTERFACE_STR, string->wData);
619         usbtty_string_table[STR_DATA_INTERFACE]=string;
620
621         string = (struct usb_string_descriptor *) wstrCtrlInterface;
622         string->bLength = sizeof(wstrCtrlInterface);
623         string->bDescriptorType = USB_DT_STRING;
624         str2wide (CONFIG_USBD_CTRL_INTERFACE_STR, string->wData);
625         usbtty_string_table[STR_CTRL_INTERFACE]=string;
626
627         /* Now, initialize the string table for ep0 handling */
628         usb_strings = usbtty_string_table;
629 }
630
631 #define init_wMaxPacketSize(x)  le16_to_cpu(get_unaligned(\
632                         &ep_descriptor_ptrs[(x) - 1]->wMaxPacketSize));
633
634 static void usbtty_init_instances (void)
635 {
636         int i;
637
638         /* initialize device instance */
639         memset (device_instance, 0, sizeof (struct usb_device_instance));
640         device_instance->device_state = STATE_INIT;
641         device_instance->device_descriptor = &device_descriptor;
642 #if defined(CONFIG_USBD_HS)
643         device_instance->qualifier_descriptor = &qualifier_descriptor;
644 #endif
645         device_instance->event = usbtty_event_handler;
646         device_instance->cdc_recv_setup = usbtty_cdc_setup;
647         device_instance->bus = bus_instance;
648         device_instance->configurations = NUM_CONFIGS;
649         device_instance->configuration_instance_array = config_instance;
650
651         /* initialize bus instance */
652         memset (bus_instance, 0, sizeof (struct usb_bus_instance));
653         bus_instance->device = device_instance;
654         bus_instance->endpoint_array = endpoint_instance;
655         bus_instance->max_endpoints = 1;
656         bus_instance->maxpacketsize = 64;
657         bus_instance->serial_number_str = serial_number;
658
659         /* configuration instance */
660         memset (config_instance, 0,
661                 sizeof (struct usb_configuration_instance));
662         config_instance->interfaces = interface_count;
663         config_instance->configuration_descriptor = configuration_descriptor;
664         config_instance->interface_instance_array = interface_instance;
665
666         /* interface instance */
667         memset (interface_instance, 0,
668                 sizeof (struct usb_interface_instance));
669         interface_instance->alternates = 1;
670         interface_instance->alternates_instance_array = alternate_instance;
671
672         /* alternates instance */
673         memset (alternate_instance, 0,
674                 sizeof (struct usb_alternate_instance));
675         alternate_instance->interface_descriptor = interface_descriptors;
676         alternate_instance->endpoints = NUM_ENDPOINTS;
677         alternate_instance->endpoints_descriptor_array = ep_descriptor_ptrs;
678
679         /* endpoint instances */
680         memset (&endpoint_instance[0], 0,
681                 sizeof (struct usb_endpoint_instance));
682         endpoint_instance[0].endpoint_address = 0;
683         endpoint_instance[0].rcv_packetSize = EP0_MAX_PACKET_SIZE;
684         endpoint_instance[0].rcv_attributes = USB_ENDPOINT_XFER_CONTROL;
685         endpoint_instance[0].tx_packetSize = EP0_MAX_PACKET_SIZE;
686         endpoint_instance[0].tx_attributes = USB_ENDPOINT_XFER_CONTROL;
687         udc_setup_ep (device_instance, 0, &endpoint_instance[0]);
688
689         for (i = 1; i <= NUM_ENDPOINTS; i++) {
690                 memset (&endpoint_instance[i], 0,
691                         sizeof (struct usb_endpoint_instance));
692
693                 endpoint_instance[i].endpoint_address =
694                         ep_descriptor_ptrs[i - 1]->bEndpointAddress;
695
696                 endpoint_instance[i].rcv_attributes =
697                         ep_descriptor_ptrs[i - 1]->bmAttributes;
698
699                 endpoint_instance[i].rcv_packetSize = init_wMaxPacketSize(i);
700
701                 endpoint_instance[i].tx_attributes =
702                         ep_descriptor_ptrs[i - 1]->bmAttributes;
703
704                 endpoint_instance[i].tx_packetSize = init_wMaxPacketSize(i);
705
706                 endpoint_instance[i].tx_attributes =
707                         ep_descriptor_ptrs[i - 1]->bmAttributes;
708
709                 urb_link_init (&endpoint_instance[i].rcv);
710                 urb_link_init (&endpoint_instance[i].rdy);
711                 urb_link_init (&endpoint_instance[i].tx);
712                 urb_link_init (&endpoint_instance[i].done);
713
714                 if (endpoint_instance[i].endpoint_address & USB_DIR_IN)
715                         endpoint_instance[i].tx_urb =
716                                 usbd_alloc_urb (device_instance,
717                                                 &endpoint_instance[i]);
718                 else
719                         endpoint_instance[i].rcv_urb =
720                                 usbd_alloc_urb (device_instance,
721                                                 &endpoint_instance[i]);
722         }
723 }
724
725 static void usbtty_init_endpoints (void)
726 {
727         int i;
728
729         bus_instance->max_endpoints = NUM_ENDPOINTS + 1;
730         for (i = 1; i <= NUM_ENDPOINTS; i++) {
731                 udc_setup_ep (device_instance, i, &endpoint_instance[i]);
732         }
733 }
734
735 /* usbtty_init_terminal_type
736  *
737  * Do some late binding for our device type.
738  */
739 static void usbtty_init_terminal_type(short type)
740 {
741         switch(type){
742                 /* CDC ACM */
743                 case 0:
744                         /* Assign endpoint descriptors */
745                         ep_descriptor_ptrs[0] =
746                                 &acm_configuration_descriptors[0].notification_endpoint;
747                         ep_descriptor_ptrs[1] =
748                                 &acm_configuration_descriptors[0].data_endpoints[0];
749                         ep_descriptor_ptrs[2] =
750                                 &acm_configuration_descriptors[0].data_endpoints[1];
751
752                         /* Enumerate Device Descriptor */
753                         device_descriptor.bDeviceClass =
754                                 COMMUNICATIONS_DEVICE_CLASS;
755                         device_descriptor.idProduct =
756                                 cpu_to_le16(CONFIG_USBD_PRODUCTID_CDCACM);
757
758 #if defined(CONFIG_USBD_HS)
759                         qualifier_descriptor.bDeviceClass =
760                                 COMMUNICATIONS_DEVICE_CLASS;
761 #endif
762                         /* Assign endpoint indices */
763                         tx_endpoint = ACM_TX_ENDPOINT;
764                         rx_endpoint = ACM_RX_ENDPOINT;
765
766                         /* Configuration Descriptor */
767                         configuration_descriptor =
768                                 (struct usb_configuration_descriptor*)
769                                 &acm_configuration_descriptors;
770
771                         /* Interface count */
772                         interface_count = NUM_ACM_INTERFACES;
773                 break;
774
775                 /* BULK IN/OUT & Default */
776                 case 1:
777                 default:
778                         /* Assign endpoint descriptors */
779                         ep_descriptor_ptrs[0] =
780                                 &gserial_configuration_descriptors[0].data_endpoints[0];
781                         ep_descriptor_ptrs[1] =
782                                 &gserial_configuration_descriptors[0].data_endpoints[1];
783                         ep_descriptor_ptrs[2] =
784                                 &gserial_configuration_descriptors[0].data_endpoints[2];
785
786                         /* Enumerate Device Descriptor */
787                         device_descriptor.bDeviceClass = 0xFF;
788                         device_descriptor.idProduct =
789                                 cpu_to_le16(CONFIG_USBD_PRODUCTID_GSERIAL);
790 #if defined(CONFIG_USBD_HS)
791                         qualifier_descriptor.bDeviceClass = 0xFF;
792 #endif
793                         /* Assign endpoint indices */
794                         tx_endpoint = GSERIAL_TX_ENDPOINT;
795                         rx_endpoint = GSERIAL_RX_ENDPOINT;
796
797                         /* Configuration Descriptor */
798                         configuration_descriptor =
799                                 (struct usb_configuration_descriptor*)
800                                 &gserial_configuration_descriptors;
801
802                         /* Interface count */
803                         interface_count = NUM_GSERIAL_INTERFACES;
804                 break;
805         }
806 }
807
808 /******************************************************************************/
809
810 static struct urb *next_urb (struct usb_device_instance *device,
811                              struct usb_endpoint_instance *endpoint)
812 {
813         struct urb *current_urb = NULL;
814         int space;
815
816         /* If there's a queue, then we should add to the last urb */
817         if (!endpoint->tx_queue) {
818                 current_urb = endpoint->tx_urb;
819         } else {
820                 /* Last urb from tx chain */
821                 current_urb =
822                         p2surround (struct urb, link, endpoint->tx.prev);
823         }
824
825         /* Make sure this one has enough room */
826         space = current_urb->buffer_length - current_urb->actual_length;
827         if (space > 0) {
828                 return current_urb;
829         } else {                /* No space here */
830                 /* First look at done list */
831                 current_urb = first_urb_detached (&endpoint->done);
832                 if (!current_urb) {
833                         current_urb = usbd_alloc_urb (device, endpoint);
834                 }
835
836                 urb_append (&endpoint->tx, current_urb);
837                 endpoint->tx_queue++;
838         }
839         return current_urb;
840 }
841
842 static int write_buffer (circbuf_t * buf)
843 {
844         if (!usbtty_configured ()) {
845                 return 0;
846         }
847
848         struct usb_endpoint_instance *endpoint =
849                         &endpoint_instance[tx_endpoint];
850         struct urb *current_urb = NULL;
851
852         current_urb = next_urb (device_instance, endpoint);
853
854         if (!current_urb) {
855                 TTYERR ("current_urb is NULL, buf->size %d\n",
856                 buf->size);
857                 return 0;
858         }
859
860         /* TX data still exists - send it now
861          */
862         if(endpoint->sent < current_urb->actual_length){
863                 if(udc_endpoint_write (endpoint)){
864                         /* Write pre-empted by RX */
865                         return -1;
866                 }
867         }
868
869         if (buf->size) {
870                 char *dest;
871
872                 int space_avail;
873                 int popnum, popped;
874                 int total = 0;
875
876                 /* Break buffer into urb sized pieces,
877                  * and link each to the endpoint
878                  */
879                 while (buf->size > 0) {
880
881                         dest = (char*)current_urb->buffer +
882                                 current_urb->actual_length;
883
884                         space_avail =
885                                 current_urb->buffer_length -
886                                 current_urb->actual_length;
887                         popnum = min(space_avail, (int)buf->size);
888                         if (popnum == 0)
889                                 break;
890
891                         popped = buf_pop (buf, dest, popnum);
892                         if (popped == 0)
893                                 break;
894                         current_urb->actual_length += popped;
895                         total += popped;
896
897                         /* If endpoint->last == 0, then transfers have
898                          * not started on this endpoint
899                          */
900                         if (endpoint->last == 0) {
901                                 if(udc_endpoint_write (endpoint)){
902                                         /* Write pre-empted by RX */
903                                         return -1;
904                                 }
905                         }
906
907                 }/* end while */
908                 return total;
909         }
910
911         return 0;
912 }
913
914 static int fill_buffer (circbuf_t * buf)
915 {
916         struct usb_endpoint_instance *endpoint =
917                 &endpoint_instance[rx_endpoint];
918
919         if (endpoint->rcv_urb && endpoint->rcv_urb->actual_length) {
920                 unsigned int nb = 0;
921                 char *src = (char *) endpoint->rcv_urb->buffer;
922                 unsigned int rx_avail = buf->totalsize - buf->size;
923
924                 if(rx_avail >= endpoint->rcv_urb->actual_length){
925
926                         nb = endpoint->rcv_urb->actual_length;
927                         buf_push (buf, src, nb);
928                         endpoint->rcv_urb->actual_length = 0;
929
930                 }
931                 return nb;
932         }
933         return 0;
934 }
935
936 static int usbtty_configured (void)
937 {
938         return usbtty_configured_flag;
939 }
940
941 /******************************************************************************/
942
943 static void usbtty_event_handler (struct usb_device_instance *device,
944                                   usb_device_event_t event, int data)
945 {
946 #if defined(CONFIG_USBD_HS)
947         int i;
948 #endif
949         switch (event) {
950         case DEVICE_RESET:
951         case DEVICE_BUS_INACTIVE:
952                 usbtty_configured_flag = 0;
953                 break;
954         case DEVICE_CONFIGURED:
955                 usbtty_configured_flag = 1;
956                 break;
957
958         case DEVICE_ADDRESS_ASSIGNED:
959 #if defined(CONFIG_USBD_HS)
960                 /*
961                  * is_usbd_high_speed routine needs to be defined by
962                  * specific gadget driver
963                  * It returns true if device enumerates at High speed
964                  * Retuns false otherwise
965                  */
966                 for (i = 0; i < NUM_ENDPOINTS; i++) {
967                         if (((ep_descriptor_ptrs[i]->bmAttributes &
968                               USB_ENDPOINT_XFERTYPE_MASK) ==
969                               USB_ENDPOINT_XFER_BULK)
970                             && is_usbd_high_speed()) {
971
972                                 ep_descriptor_ptrs[i]->wMaxPacketSize =
973                                         CONFIG_USBD_SERIAL_BULK_HS_PKTSIZE;
974                         }
975
976                         endpoint_instance[i + 1].tx_packetSize =
977                                 ep_descriptor_ptrs[i]->wMaxPacketSize;
978                         endpoint_instance[i + 1].rcv_packetSize =
979                                 ep_descriptor_ptrs[i]->wMaxPacketSize;
980                 }
981 #endif
982                 usbtty_init_endpoints ();
983
984         default:
985                 break;
986         }
987 }
988
989 /******************************************************************************/
990
991 int usbtty_cdc_setup(struct usb_device_request *request, struct urb *urb)
992 {
993         switch (request->bRequest){
994
995                 case ACM_SET_CONTROL_LINE_STATE:        /* Implies DTE ready */
996                         break;
997                 case ACM_SEND_ENCAPSULATED_COMMAND :    /* Required */
998                         break;
999                 case ACM_SET_LINE_ENCODING :            /* DTE stop/parity bits
1000                                                          * per character */
1001                         break;
1002                 case ACM_GET_ENCAPSULATED_RESPONSE :    /* request response */
1003                         break;
1004                 case ACM_GET_LINE_ENCODING :            /* request DTE rate,
1005                                                          * stop/parity bits */
1006                         memcpy (urb->buffer , &rs232_desc, sizeof(rs232_desc));
1007                         urb->actual_length = sizeof(rs232_desc);
1008
1009                         break;
1010                 default:
1011                         return 1;
1012         }
1013         return 0;
1014 }
1015
1016 /******************************************************************************/
1017
1018 /*
1019  * Since interrupt handling has not yet been implemented, we use this function
1020  * to handle polling.  This is called by the tstc,getc,putc,puts routines to
1021  * update the USB state.
1022  */
1023 void usbtty_poll (void)
1024 {
1025         /* New interrupts? */
1026         udc_irq();
1027
1028         /* Write any output data to host buffer
1029          * (do this before checking interrupts to avoid missing one)
1030          */
1031         if (usbtty_configured ()) {
1032                 write_buffer (&usbtty_output);
1033         }
1034
1035         /* New interrupts? */
1036         udc_irq();
1037
1038         /* Check for new data from host..
1039          * (do this after checking interrupts to get latest data)
1040          */
1041         if (usbtty_configured ()) {
1042                 fill_buffer (&usbtty_input);
1043         }
1044
1045         /* New interrupts? */
1046         udc_irq();
1047
1048 }