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         buf_push (&usbtty_output, &c, 1);
 438         /* If \n, also do \r */
 439         if (c == '\n')
 440                 buf_push (&usbtty_output, "\r", 1);
 441
 442         /* Poll at end to handle new data... */
 443         if ((usbtty_output.size + 2) >= usbtty_output.totalsize) {
 444                 usbtty_poll ();
 445         }
 446 }
 447
 448 /* usbtty_puts() helper function for finding the next '\n' in a string */
 449 static int next_nl_pos (const char *s)
 450 {
 451         int i;
 452
 453         for (i = 0; s[i] != '\0'; i++) {
 454                 if (s[i] == '\n')
 455                         return i;
 456         }
 457         return i;
 458 }
 459
 460 /*
 461  * Output a string to the usb client port - implementing flow control
 462  */
 463
 464 static void __usbtty_puts (const char *str, int len)
 465 {
 466         int maxlen = usbtty_output.totalsize;
 467         int space, n;
 468
 469         /* break str into chunks < buffer size, if needed */
 470         while (len > 0) {
 471                 usbtty_poll ();
 472
 473                 space = maxlen - usbtty_output.size;
 474                 /* Empty buffer here, if needed, to ensure space... */
 475                 if (space) {
 476                         write_buffer (&usbtty_output);
 477
 478                         n = min(space, min(len, maxlen));
 479                         buf_push (&usbtty_output, str, n);
 480
 481                         str += n;
 482                         len -= n;
 483                 }
 484         }
 485 }
 486
 487 void usbtty_puts(struct stdio_dev *dev, const char *str)
 488 {
 489         int n;
 490         int len;
 491
 492         if (!usbtty_configured ())
 493                 return;
 494
 495         len = strlen (str);
 496         /* add '\r' for each '\n' */
 497         while (len > 0) {
 498                 n = next_nl_pos (str);
 499
 500                 if (str[n] == '\n') {
 501                         __usbtty_puts (str, n + 1);
 502                         __usbtty_puts ("\r", 1);
 503                         str += (n + 1);
 504                         len -= (n + 1);
 505                 } else {
 506                         /* No \n found.  All done. */
 507                         __usbtty_puts (str, n);
 508                         break;
 509                 }
 510         }
 511
 512         /* Poll at end to handle new data... */
 513         usbtty_poll ();
 514 }
 515
 516 /*
 517  * Initialize the usb client port.
 518  *
 519  */
 520 int drv_usbtty_init (void)
 521 {
 522         int rc;
 523         char * sn;
 524         char * tt;
 525         int snlen;
 526
 527         /* Ger seiral number */
 528         if (!(sn = getenv("serial#"))) {
 529                 sn = "000000000000";
 530         }
 531         snlen = strlen(sn);
 532         if (snlen > sizeof(serial_number) - 1) {
 533                 printf ("Warning: serial number %s is too long (%d > %lu)\n",
 534                         sn, snlen, (ulong)(sizeof(serial_number) - 1));
 535                 snlen = sizeof(serial_number) - 1;
 536         }
 537         memcpy (serial_number, sn, snlen);
 538         serial_number[snlen] = '\0';
 539
 540         /* Decide on which type of UDC device to be.
 541          */
 542
 543         if(!(tt = getenv("usbtty"))) {
 544                 tt = "generic";
 545         }
 546         usbtty_init_terminal_type(strcmp(tt,"cdc_acm"));
 547
 548         /* prepare buffers... */
 549         buf_init (&usbtty_input, USBTTY_BUFFER_SIZE);
 550         buf_init (&usbtty_output, USBTTY_BUFFER_SIZE);
 551
 552         /* Now, set up USB controller and infrastructure */
 553         udc_init ();            /* Basic USB initialization */
 554
 555         usbtty_init_strings ();
 556         usbtty_init_instances ();
 557
 558         usbtty_init_endpoints ();
 559
 560         udc_startup_events (device_instance);/* Enable dev, init udc pointers */
 561         udc_connect ();         /* Enable pullup for host detection */
 562
 563         /* Device initialization */
 564         memset (&usbttydev, 0, sizeof (usbttydev));
 565
 566         strcpy (usbttydev.name, "usbtty");
 567         usbttydev.ext = 0;      /* No extensions */
 568         usbttydev.flags = DEV_FLAGS_INPUT | DEV_FLAGS_OUTPUT;
 569         usbttydev.tstc = usbtty_tstc;   /* 'tstc' function */
 570         usbttydev.getc = usbtty_getc;   /* 'getc' function */
 571         usbttydev.putc = usbtty_putc;   /* 'putc' function */
 572         usbttydev.puts = usbtty_puts;   /* 'puts' function */
 573
 574         rc = stdio_register (&usbttydev);
 575
 576         return (rc == 0) ? 1 : rc;
 577 }
 578
 579 static void usbtty_init_strings (void)
 580 {
 581         struct usb_string_descriptor *string;
 582
 583         usbtty_string_table[STR_LANG] =
 584                 (struct usb_string_descriptor*)wstrLang;
 585
 586         string = (struct usb_string_descriptor *) wstrManufacturer;
 587         string->bLength = sizeof(wstrManufacturer);
 588         string->bDescriptorType = USB_DT_STRING;
 589         str2wide (CONFIG_USBD_MANUFACTURER, string->wData);
 590         usbtty_string_table[STR_MANUFACTURER]=string;
 591
 592
 593         string = (struct usb_string_descriptor *) wstrProduct;
 594         string->bLength = sizeof(wstrProduct);
 595         string->bDescriptorType = USB_DT_STRING;
 596         str2wide (CONFIG_USBD_PRODUCT_NAME, string->wData);
 597         usbtty_string_table[STR_PRODUCT]=string;
 598
 599
 600         string = (struct usb_string_descriptor *) wstrSerial;
 601         string->bLength = sizeof(serial_number);
 602         string->bDescriptorType = USB_DT_STRING;
 603         str2wide (serial_number, string->wData);
 604         usbtty_string_table[STR_SERIAL]=string;
 605
 606
 607         string = (struct usb_string_descriptor *) wstrConfiguration;
 608         string->bLength = sizeof(wstrConfiguration);
 609         string->bDescriptorType = USB_DT_STRING;
 610         str2wide (CONFIG_USBD_CONFIGURATION_STR, string->wData);
 611         usbtty_string_table[STR_CONFIG]=string;
 612
 613
 614         string = (struct usb_string_descriptor *) wstrDataInterface;
 615         string->bLength = sizeof(wstrDataInterface);
 616         string->bDescriptorType = USB_DT_STRING;
 617         str2wide (CONFIG_USBD_DATA_INTERFACE_STR, string->wData);
 618         usbtty_string_table[STR_DATA_INTERFACE]=string;
 619
 620         string = (struct usb_string_descriptor *) wstrCtrlInterface;
 621         string->bLength = sizeof(wstrCtrlInterface);
 622         string->bDescriptorType = USB_DT_STRING;
 623         str2wide (CONFIG_USBD_CTRL_INTERFACE_STR, string->wData);
 624         usbtty_string_table[STR_CTRL_INTERFACE]=string;
 625
 626         /* Now, initialize the string table for ep0 handling */
 627         usb_strings = usbtty_string_table;
 628 }
 629
 630 #define init_wMaxPacketSize(x)  le16_to_cpu(get_unaligned(\
 631                         &ep_descriptor_ptrs[(x) - 1]->wMaxPacketSize));
 632
 633 static void usbtty_init_instances (void)
 634 {
 635         int i;
 636
 637         /* initialize device instance */
 638         memset (device_instance, 0, sizeof (struct usb_device_instance));
 639         device_instance->device_state = STATE_INIT;
 640         device_instance->device_descriptor = &device_descriptor;
 641 #if defined(CONFIG_USBD_HS)
 642         device_instance->qualifier_descriptor = &qualifier_descriptor;
 643 #endif
 644         device_instance->event = usbtty_event_handler;
 645         device_instance->cdc_recv_setup = usbtty_cdc_setup;
 646         device_instance->bus = bus_instance;
 647         device_instance->configurations = NUM_CONFIGS;
 648         device_instance->configuration_instance_array = config_instance;
 649
 650         /* initialize bus instance */
 651         memset (bus_instance, 0, sizeof (struct usb_bus_instance));
 652         bus_instance->device = device_instance;
 653         bus_instance->endpoint_array = endpoint_instance;
 654         bus_instance->max_endpoints = 1;
 655         bus_instance->maxpacketsize = 64;
 656         bus_instance->serial_number_str = serial_number;
 657
 658         /* configuration instance */
 659         memset (config_instance, 0,
 660                 sizeof (struct usb_configuration_instance));
 661         config_instance->interfaces = interface_count;
 662         config_instance->configuration_descriptor = configuration_descriptor;
 663         config_instance->interface_instance_array = interface_instance;
 664
 665         /* interface instance */
 666         memset (interface_instance, 0,
 667                 sizeof (struct usb_interface_instance));
 668         interface_instance->alternates = 1;
 669         interface_instance->alternates_instance_array = alternate_instance;
 670
 671         /* alternates instance */
 672         memset (alternate_instance, 0,
 673                 sizeof (struct usb_alternate_instance));
 674         alternate_instance->interface_descriptor = interface_descriptors;
 675         alternate_instance->endpoints = NUM_ENDPOINTS;
 676         alternate_instance->endpoints_descriptor_array = ep_descriptor_ptrs;
 677
 678         /* endpoint instances */
 679         memset (&endpoint_instance[0], 0,
 680                 sizeof (struct usb_endpoint_instance));
 681         endpoint_instance[0].endpoint_address = 0;
 682         endpoint_instance[0].rcv_packetSize = EP0_MAX_PACKET_SIZE;
 683         endpoint_instance[0].rcv_attributes = USB_ENDPOINT_XFER_CONTROL;
 684         endpoint_instance[0].tx_packetSize = EP0_MAX_PACKET_SIZE;
 685         endpoint_instance[0].tx_attributes = USB_ENDPOINT_XFER_CONTROL;
 686         udc_setup_ep (device_instance, 0, &endpoint_instance[0]);
 687
 688         for (i = 1; i <= NUM_ENDPOINTS; i++) {
 689                 memset (&endpoint_instance[i], 0,
 690                         sizeof (struct usb_endpoint_instance));
 691
 692                 endpoint_instance[i].endpoint_address =
 693                         ep_descriptor_ptrs[i - 1]->bEndpointAddress;
 694
 695                 endpoint_instance[i].rcv_attributes =
 696                         ep_descriptor_ptrs[i - 1]->bmAttributes;
 697
 698                 endpoint_instance[i].rcv_packetSize = init_wMaxPacketSize(i);
 699
 700                 endpoint_instance[i].tx_attributes =
 701                         ep_descriptor_ptrs[i - 1]->bmAttributes;
 702
 703                 endpoint_instance[i].tx_packetSize = init_wMaxPacketSize(i);
 704
 705                 endpoint_instance[i].tx_attributes =
 706                         ep_descriptor_ptrs[i - 1]->bmAttributes;
 707
 708                 urb_link_init (&endpoint_instance[i].rcv);
 709                 urb_link_init (&endpoint_instance[i].rdy);
 710                 urb_link_init (&endpoint_instance[i].tx);
 711                 urb_link_init (&endpoint_instance[i].done);
 712
 713                 if (endpoint_instance[i].endpoint_address & USB_DIR_IN)
 714                         endpoint_instance[i].tx_urb =
 715                                 usbd_alloc_urb (device_instance,
 716                                                 &endpoint_instance[i]);
 717                 else
 718                         endpoint_instance[i].rcv_urb =
 719                                 usbd_alloc_urb (device_instance,
 720                                                 &endpoint_instance[i]);
 721         }
 722 }
 723
 724 static void usbtty_init_endpoints (void)
 725 {
 726         int i;
 727
 728         bus_instance->max_endpoints = NUM_ENDPOINTS + 1;
 729         for (i = 1; i <= NUM_ENDPOINTS; i++) {
 730                 udc_setup_ep (device_instance, i, &endpoint_instance[i]);
 731         }
 732 }
 733
 734 /* usbtty_init_terminal_type
 735  *
 736  * Do some late binding for our device type.
 737  */
 738 static void usbtty_init_terminal_type(short type)
 739 {
 740         switch(type){
 741                 /* CDC ACM */
 742                 case 0:
 743                         /* Assign endpoint descriptors */
 744                         ep_descriptor_ptrs[0] =
 745                                 &acm_configuration_descriptors[0].notification_endpoint;
 746                         ep_descriptor_ptrs[1] =
 747                                 &acm_configuration_descriptors[0].data_endpoints[0];
 748                         ep_descriptor_ptrs[2] =
 749                                 &acm_configuration_descriptors[0].data_endpoints[1];
 750
 751                         /* Enumerate Device Descriptor */
 752                         device_descriptor.bDeviceClass =
 753                                 COMMUNICATIONS_DEVICE_CLASS;
 754                         device_descriptor.idProduct =
 755                                 cpu_to_le16(CONFIG_USBD_PRODUCTID_CDCACM);
 756
 757 #if defined(CONFIG_USBD_HS)
 758                         qualifier_descriptor.bDeviceClass =
 759                                 COMMUNICATIONS_DEVICE_CLASS;
 760 #endif
 761                         /* Assign endpoint indices */
 762                         tx_endpoint = ACM_TX_ENDPOINT;
 763                         rx_endpoint = ACM_RX_ENDPOINT;
 764
 765                         /* Configuration Descriptor */
 766                         configuration_descriptor =
 767                                 (struct usb_configuration_descriptor*)
 768                                 &acm_configuration_descriptors;
 769
 770                         /* Interface count */
 771                         interface_count = NUM_ACM_INTERFACES;
 772                 break;
 773
 774                 /* BULK IN/OUT & Default */
 775                 case 1:
 776                 default:
 777                         /* Assign endpoint descriptors */
 778                         ep_descriptor_ptrs[0] =
 779                                 &gserial_configuration_descriptors[0].data_endpoints[0];
 780                         ep_descriptor_ptrs[1] =
 781                                 &gserial_configuration_descriptors[0].data_endpoints[1];
 782                         ep_descriptor_ptrs[2] =
 783                                 &gserial_configuration_descriptors[0].data_endpoints[2];
 784
 785                         /* Enumerate Device Descriptor */
 786                         device_descriptor.bDeviceClass = 0xFF;
 787                         device_descriptor.idProduct =
 788                                 cpu_to_le16(CONFIG_USBD_PRODUCTID_GSERIAL);
 789 #if defined(CONFIG_USBD_HS)
 790                         qualifier_descriptor.bDeviceClass = 0xFF;
 791 #endif
 792                         /* Assign endpoint indices */
 793                         tx_endpoint = GSERIAL_TX_ENDPOINT;
 794                         rx_endpoint = GSERIAL_RX_ENDPOINT;
 795
 796                         /* Configuration Descriptor */
 797                         configuration_descriptor =
 798                                 (struct usb_configuration_descriptor*)
 799                                 &gserial_configuration_descriptors;
 800
 801                         /* Interface count */
 802                         interface_count = NUM_GSERIAL_INTERFACES;
 803                 break;
 804         }
 805 }
 806
 807 /******************************************************************************/
 808
 809 static struct urb *next_urb (struct usb_device_instance *device,
 810                              struct usb_endpoint_instance *endpoint)
 811 {
 812         struct urb *current_urb = NULL;
 813         int space;
 814
 815         /* If there's a queue, then we should add to the last urb */
 816         if (!endpoint->tx_queue) {
 817                 current_urb = endpoint->tx_urb;
 818         } else {
 819                 /* Last urb from tx chain */
 820                 current_urb =
 821                         p2surround (struct urb, link, endpoint->tx.prev);
 822         }
 823
 824         /* Make sure this one has enough room */
 825         space = current_urb->buffer_length - current_urb->actual_length;
 826         if (space > 0) {
 827                 return current_urb;
 828         } else {                /* No space here */
 829                 /* First look at done list */
 830                 current_urb = first_urb_detached (&endpoint->done);
 831                 if (!current_urb) {
 832                         current_urb = usbd_alloc_urb (device, endpoint);
 833                 }
 834
 835                 urb_append (&endpoint->tx, current_urb);
 836                 endpoint->tx_queue++;
 837         }
 838         return current_urb;
 839 }
 840
 841 static int write_buffer (circbuf_t * buf)
 842 {
 843         if (!usbtty_configured ()) {
 844                 return 0;
 845         }
 846
 847         struct usb_endpoint_instance *endpoint =
 848                         &endpoint_instance[tx_endpoint];
 849         struct urb *current_urb = NULL;
 850
 851         current_urb = next_urb (device_instance, endpoint);
 852         /* TX data still exists - send it now
 853          */
 854         if(endpoint->sent < current_urb->actual_length){
 855                 if(udc_endpoint_write (endpoint)){
 856                         /* Write pre-empted by RX */
 857                         return -1;
 858                 }
 859         }
 860
 861         if (buf->size) {
 862                 char *dest;
 863
 864                 int space_avail;
 865                 int popnum, popped;
 866                 int total = 0;
 867
 868                 /* Break buffer into urb sized pieces,
 869                  * and link each to the endpoint
 870                  */
 871                 while (buf->size > 0) {
 872
 873                         if (!current_urb) {
 874                                 TTYERR ("current_urb is NULL, buf->size %d\n",
 875                                         buf->size);
 876                                 return total;
 877                         }
 878
 879                         dest = (char*)current_urb->buffer +
 880                                 current_urb->actual_length;
 881
 882                         space_avail =
 883                                 current_urb->buffer_length -
 884                                 current_urb->actual_length;
 885                         popnum = min(space_avail, (int)buf->size);
 886                         if (popnum == 0)
 887                                 break;
 888
 889                         popped = buf_pop (buf, dest, popnum);
 890                         if (popped == 0)
 891                                 break;
 892                         current_urb->actual_length += popped;
 893                         total += popped;
 894
 895                         /* If endpoint->last == 0, then transfers have
 896                          * not started on this endpoint
 897                          */
 898                         if (endpoint->last == 0) {
 899                                 if(udc_endpoint_write (endpoint)){
 900                                         /* Write pre-empted by RX */
 901                                         return -1;
 902                                 }
 903                         }
 904
 905                 }/* end while */
 906                 return total;
 907         }
 908
 909         return 0;
 910 }
 911
 912 static int fill_buffer (circbuf_t * buf)
 913 {
 914         struct usb_endpoint_instance *endpoint =
 915                 &endpoint_instance[rx_endpoint];
 916
 917         if (endpoint->rcv_urb && endpoint->rcv_urb->actual_length) {
 918                 unsigned int nb = 0;
 919                 char *src = (char *) endpoint->rcv_urb->buffer;
 920                 unsigned int rx_avail = buf->totalsize - buf->size;
 921
 922                 if(rx_avail >= endpoint->rcv_urb->actual_length){
 923
 924                         nb = endpoint->rcv_urb->actual_length;
 925                         buf_push (buf, src, nb);
 926                         endpoint->rcv_urb->actual_length = 0;
 927
 928                 }
 929                 return nb;
 930         }
 931         return 0;
 932 }
 933
 934 static int usbtty_configured (void)
 935 {
 936         return usbtty_configured_flag;
 937 }
 938
 939 /******************************************************************************/
 940
 941 static void usbtty_event_handler (struct usb_device_instance *device,
 942                                   usb_device_event_t event, int data)
 943 {
 944 #if defined(CONFIG_USBD_HS)
 945         int i;
 946 #endif
 947         switch (event) {
 948         case DEVICE_RESET:
 949         case DEVICE_BUS_INACTIVE:
 950                 usbtty_configured_flag = 0;
 951                 break;
 952         case DEVICE_CONFIGURED:
 953                 usbtty_configured_flag = 1;
 954                 break;
 955
 956         case DEVICE_ADDRESS_ASSIGNED:
 957 #if defined(CONFIG_USBD_HS)
 958                 /*
 959                  * is_usbd_high_speed routine needs to be defined by
 960                  * specific gadget driver
 961                  * It returns true if device enumerates at High speed
 962                  * Retuns false otherwise
 963                  */
 964                 for (i = 0; i < NUM_ENDPOINTS; i++) {
 965                         if (((ep_descriptor_ptrs[i]->bmAttributes &
 966                               USB_ENDPOINT_XFERTYPE_MASK) ==
 967                               USB_ENDPOINT_XFER_BULK)
 968                             && is_usbd_high_speed()) {
 969
 970                                 ep_descriptor_ptrs[i]->wMaxPacketSize =
 971                                         CONFIG_USBD_SERIAL_BULK_HS_PKTSIZE;
 972                         }
 973
 974                         endpoint_instance[i + 1].tx_packetSize =
 975                                 ep_descriptor_ptrs[i]->wMaxPacketSize;
 976                         endpoint_instance[i + 1].rcv_packetSize =
 977                                 ep_descriptor_ptrs[i]->wMaxPacketSize;
 978                 }
 979 #endif
 980                 usbtty_init_endpoints ();
 981
 982         default:
 983                 break;
 984         }
 985 }
 986
 987 /******************************************************************************/
 988
 989 int usbtty_cdc_setup(struct usb_device_request *request, struct urb *urb)
 990 {
 991         switch (request->bRequest){
 992
 993                 case ACM_SET_CONTROL_LINE_STATE:        /* Implies DTE ready */
 994                         break;
 995                 case ACM_SEND_ENCAPSULATED_COMMAND :    /* Required */
 996                         break;
 997                 case ACM_SET_LINE_ENCODING :            /* DTE stop/parity bits
 998                                                          * per character */
 999                         break;
1000                 case ACM_GET_ENCAPSULATED_RESPONSE :    /* request response */
1001                         break;
1002                 case ACM_GET_LINE_ENCODING :            /* request DTE rate,
1003                                                          * stop/parity bits */
1004                         memcpy (urb->buffer , &rs232_desc, sizeof(rs232_desc));
1005                         urb->actual_length = sizeof(rs232_desc);
1006
1007                         break;
1008                 default:
1009                         return 1;
1010         }
1011         return 0;
1012 }
1013
1014 /******************************************************************************/
1015
1016 /*
1017  * Since interrupt handling has not yet been implemented, we use this function
1018  * to handle polling.  This is called by the tstc,getc,putc,puts routines to
1019  * update the USB state.
1020  */
1021 void usbtty_poll (void)
1022 {
1023         /* New interrupts? */
1024         udc_irq();
1025
1026         /* Write any output data to host buffer
1027          * (do this before checking interrupts to avoid missing one)
1028          */
1029         if (usbtty_configured ()) {
1030                 write_buffer (&usbtty_output);
1031         }
1032
1033         /* New interrupts? */
1034         udc_irq();
1035
1036         /* Check for new data from host..
1037          * (do this after checking interrupts to get latest data)
1038          */
1039         if (usbtty_configured ()) {
1040                 fill_buffer (&usbtty_input);
1041         }
1042
1043         /* New interrupts? */
1044         udc_irq();
1045
1046 }