Linux-libre 4.10.3-gnu
[librecmc/linux-libre.git] / drivers / usb / serial / io_edgeport.c
1 /*
2  * Edgeport USB Serial Converter driver
3  *
4  * Copyright (C) 2000 Inside Out Networks, All rights reserved.
5  * Copyright (C) 2001-2002 Greg Kroah-Hartman <greg@kroah.com>
6  *
7  *      This program is free software; you can redistribute it and/or modify
8  *      it under the terms of the GNU General Public License as published by
9  *      the Free Software Foundation; either version 2 of the License, or
10  *      (at your option) any later version.
11  *
12  * Supports the following devices:
13  *      Edgeport/4
14  *      Edgeport/4t
15  *      Edgeport/2
16  *      Edgeport/4i
17  *      Edgeport/2i
18  *      Edgeport/421
19  *      Edgeport/21
20  *      Rapidport/4
21  *      Edgeport/8
22  *      Edgeport/2D8
23  *      Edgeport/4D8
24  *      Edgeport/8i
25  *
26  * For questions or problems with this driver, contact Inside Out
27  * Networks technical support, or Peter Berger <pberger@brimson.com>,
28  * or Al Borchers <alborchers@steinerpoint.com>.
29  *
30  */
31
32 #include <linux/kernel.h>
33 #include <linux/jiffies.h>
34 #include <linux/errno.h>
35 #include <linux/slab.h>
36 #include <linux/tty.h>
37 #include <linux/tty_driver.h>
38 #include <linux/tty_flip.h>
39 #include <linux/module.h>
40 #include <linux/spinlock.h>
41 #include <linux/serial.h>
42 #include <linux/ioctl.h>
43 #include <linux/wait.h>
44 #include <linux/firmware.h>
45 #include <linux/ihex.h>
46 #include <linux/uaccess.h>
47 #include <linux/usb.h>
48 #include <linux/usb/serial.h>
49 #include "io_edgeport.h"
50 #include "io_ionsp.h"           /* info for the iosp messages */
51 #include "io_16654.h"           /* 16654 UART defines */
52
53 #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com> and David Iacovelli"
54 #define DRIVER_DESC "Edgeport USB Serial Driver"
55
56 #define MAX_NAME_LEN            64
57
58 #define OPEN_TIMEOUT            (5*HZ)          /* 5 seconds */
59
60 /* receive port state */
61 enum RXSTATE {
62         EXPECT_HDR1 = 0,    /* Expect header byte 1 */
63         EXPECT_HDR2 = 1,    /* Expect header byte 2 */
64         EXPECT_DATA = 2,    /* Expect 'RxBytesRemaining' data */
65         EXPECT_HDR3 = 3,    /* Expect header byte 3 (for status hdrs only) */
66 };
67
68
69 /* Transmit Fifo
70  * This Transmit queue is an extension of the edgeport Rx buffer.
71  * The maximum amount of data buffered in both the edgeport
72  * Rx buffer (maxTxCredits) and this buffer will never exceed maxTxCredits.
73  */
74 struct TxFifo {
75         unsigned int    head;   /* index to head pointer (write) */
76         unsigned int    tail;   /* index to tail pointer (read)  */
77         unsigned int    count;  /* Bytes in queue */
78         unsigned int    size;   /* Max size of queue (equal to Max number of TxCredits) */
79         unsigned char   *fifo;  /* allocated Buffer */
80 };
81
82 /* This structure holds all of the local port information */
83 struct edgeport_port {
84         __u16                   txCredits;              /* our current credits for this port */
85         __u16                   maxTxCredits;           /* the max size of the port */
86
87         struct TxFifo           txfifo;                 /* transmit fifo -- size will be maxTxCredits */
88         struct urb              *write_urb;             /* write URB for this port */
89         bool                    write_in_progress;      /* 'true' while a write URB is outstanding */
90         spinlock_t              ep_lock;
91
92         __u8                    shadowLCR;              /* last LCR value received */
93         __u8                    shadowMCR;              /* last MCR value received */
94         __u8                    shadowMSR;              /* last MSR value received */
95         __u8                    shadowLSR;              /* last LSR value received */
96         __u8                    shadowXonChar;          /* last value set as XON char in Edgeport */
97         __u8                    shadowXoffChar;         /* last value set as XOFF char in Edgeport */
98         __u8                    validDataMask;
99         __u32                   baudRate;
100
101         bool                    open;
102         bool                    openPending;
103         bool                    commandPending;
104         bool                    closePending;
105         bool                    chaseResponsePending;
106
107         wait_queue_head_t       wait_chase;             /* for handling sleeping while waiting for chase to finish */
108         wait_queue_head_t       wait_open;              /* for handling sleeping while waiting for open to finish */
109         wait_queue_head_t       wait_command;           /* for handling sleeping while waiting for command to finish */
110
111         struct usb_serial_port  *port;                  /* loop back to the owner of this object */
112 };
113
114
115 /* This structure holds all of the individual device information */
116 struct edgeport_serial {
117         char                    name[MAX_NAME_LEN+2];           /* string name of this device */
118
119         struct edge_manuf_descriptor    manuf_descriptor;       /* the manufacturer descriptor */
120         struct edge_boot_descriptor     boot_descriptor;        /* the boot firmware descriptor */
121         struct edgeport_product_info    product_info;           /* Product Info */
122         struct edge_compatibility_descriptor epic_descriptor;   /* Edgeport compatible descriptor */
123         int                     is_epic;                        /* flag if EPiC device or not */
124
125         __u8                    interrupt_in_endpoint;          /* the interrupt endpoint handle */
126         unsigned char           *interrupt_in_buffer;           /* the buffer we use for the interrupt endpoint */
127         struct urb              *interrupt_read_urb;            /* our interrupt urb */
128
129         __u8                    bulk_in_endpoint;               /* the bulk in endpoint handle */
130         unsigned char           *bulk_in_buffer;                /* the buffer we use for the bulk in endpoint */
131         struct urb              *read_urb;                      /* our bulk read urb */
132         bool                    read_in_progress;
133         spinlock_t              es_lock;
134
135         __u8                    bulk_out_endpoint;              /* the bulk out endpoint handle */
136
137         __s16                   rxBytesAvail;                   /* the number of bytes that we need to read from this device */
138
139         enum RXSTATE            rxState;                        /* the current state of the bulk receive processor */
140         __u8                    rxHeader1;                      /* receive header byte 1 */
141         __u8                    rxHeader2;                      /* receive header byte 2 */
142         __u8                    rxHeader3;                      /* receive header byte 3 */
143         __u8                    rxPort;                         /* the port that we are currently receiving data for */
144         __u8                    rxStatusCode;                   /* the receive status code */
145         __u8                    rxStatusParam;                  /* the receive status paramater */
146         __s16                   rxBytesRemaining;               /* the number of port bytes left to read */
147         struct usb_serial       *serial;                        /* loop back to the owner of this object */
148 };
149
150 /* baud rate information */
151 struct divisor_table_entry {
152         __u32   BaudRate;
153         __u16  Divisor;
154 };
155
156 /*
157  * Define table of divisors for Rev A EdgePort/4 hardware
158  * These assume a 3.6864MHz crystal, the standard /16, and
159  * MCR.7 = 0.
160  */
161
162 static const struct divisor_table_entry divisor_table[] = {
163         {   50,         4608},
164         {   75,         3072},
165         {   110,        2095},  /* 2094.545455 => 230450   => .0217 % over */
166         {   134,        1713},  /* 1713.011152 => 230398.5 => .00065% under */
167         {   150,        1536},
168         {   300,        768},
169         {   600,        384},
170         {   1200,       192},
171         {   1800,       128},
172         {   2400,       96},
173         {   4800,       48},
174         {   7200,       32},
175         {   9600,       24},
176         {   14400,      16},
177         {   19200,      12},
178         {   38400,      6},
179         {   57600,      4},
180         {   115200,     2},
181         {   230400,     1},
182 };
183
184 /* Number of outstanding Command Write Urbs */
185 static atomic_t CmdUrbs = ATOMIC_INIT(0);
186
187
188 /* local function prototypes */
189
190 /* function prototypes for all URB callbacks */
191 static void edge_interrupt_callback(struct urb *urb);
192 static void edge_bulk_in_callback(struct urb *urb);
193 static void edge_bulk_out_data_callback(struct urb *urb);
194 static void edge_bulk_out_cmd_callback(struct urb *urb);
195
196 /* function prototypes for the usbserial callbacks */
197 static int edge_open(struct tty_struct *tty, struct usb_serial_port *port);
198 static void edge_close(struct usb_serial_port *port);
199 static int edge_write(struct tty_struct *tty, struct usb_serial_port *port,
200                                         const unsigned char *buf, int count);
201 static int edge_write_room(struct tty_struct *tty);
202 static int edge_chars_in_buffer(struct tty_struct *tty);
203 static void edge_throttle(struct tty_struct *tty);
204 static void edge_unthrottle(struct tty_struct *tty);
205 static void edge_set_termios(struct tty_struct *tty,
206                                         struct usb_serial_port *port,
207                                         struct ktermios *old_termios);
208 static int  edge_ioctl(struct tty_struct *tty,
209                                         unsigned int cmd, unsigned long arg);
210 static void edge_break(struct tty_struct *tty, int break_state);
211 static int  edge_tiocmget(struct tty_struct *tty);
212 static int  edge_tiocmset(struct tty_struct *tty,
213                                         unsigned int set, unsigned int clear);
214 static int  edge_startup(struct usb_serial *serial);
215 static void edge_disconnect(struct usb_serial *serial);
216 static void edge_release(struct usb_serial *serial);
217 static int edge_port_probe(struct usb_serial_port *port);
218 static int edge_port_remove(struct usb_serial_port *port);
219
220 #include "io_tables.h"  /* all of the devices that this driver supports */
221
222 /* function prototypes for all of our local functions */
223
224 static void  process_rcvd_data(struct edgeport_serial *edge_serial,
225                                 unsigned char *buffer, __u16 bufferLength);
226 static void process_rcvd_status(struct edgeport_serial *edge_serial,
227                                 __u8 byte2, __u8 byte3);
228 static void edge_tty_recv(struct usb_serial_port *port, unsigned char *data,
229                 int length);
230 static void handle_new_msr(struct edgeport_port *edge_port, __u8 newMsr);
231 static void handle_new_lsr(struct edgeport_port *edge_port, __u8 lsrData,
232                                 __u8 lsr, __u8 data);
233 static int  send_iosp_ext_cmd(struct edgeport_port *edge_port, __u8 command,
234                                 __u8 param);
235 static int  calc_baud_rate_divisor(struct device *dev, int baud_rate, int *divisor);
236 static int  send_cmd_write_baud_rate(struct edgeport_port *edge_port,
237                                 int baudRate);
238 static void change_port_settings(struct tty_struct *tty,
239                                 struct edgeport_port *edge_port,
240                                 struct ktermios *old_termios);
241 static int  send_cmd_write_uart_register(struct edgeport_port *edge_port,
242                                 __u8 regNum, __u8 regValue);
243 static int  write_cmd_usb(struct edgeport_port *edge_port,
244                                 unsigned char *buffer, int writeLength);
245 static void send_more_port_data(struct edgeport_serial *edge_serial,
246                                 struct edgeport_port *edge_port);
247
248 static int sram_write(struct usb_serial *serial, __u16 extAddr, __u16 addr,
249                                         __u16 length, const __u8 *data);
250 static int rom_read(struct usb_serial *serial, __u16 extAddr, __u16 addr,
251                                                 __u16 length, __u8 *data);
252 static int rom_write(struct usb_serial *serial, __u16 extAddr, __u16 addr,
253                                         __u16 length, const __u8 *data);
254 static void get_manufacturing_desc(struct edgeport_serial *edge_serial);
255 static void get_boot_desc(struct edgeport_serial *edge_serial);
256 static void load_application_firmware(struct edgeport_serial *edge_serial);
257
258 static void unicode_to_ascii(char *string, int buflen,
259                                 __le16 *unicode, int unicode_size);
260
261
262 /* ************************************************************************ */
263 /* ************************************************************************ */
264 /* ************************************************************************ */
265 /* ************************************************************************ */
266
267 /************************************************************************
268  *                                                                      *
269  * update_edgeport_E2PROM()     Compare current versions of             *
270  *                              Boot ROM and Manufacture                *
271  *                              Descriptors with versions               *
272  *                              embedded in this driver                 *
273  *                                                                      *
274  ************************************************************************/
275 static void update_edgeport_E2PROM(struct edgeport_serial *edge_serial)
276 {
277         struct device *dev = &edge_serial->serial->dev->dev;
278         __u32 BootCurVer;
279         __u32 BootNewVer;
280         __u8 BootMajorVersion;
281         __u8 BootMinorVersion;
282         __u16 BootBuildNumber;
283         __u32 Bootaddr;
284         const struct ihex_binrec *rec;
285         const struct firmware *fw;
286         const char *fw_name;
287         int response;
288
289         switch (edge_serial->product_info.iDownloadFile) {
290         case EDGE_DOWNLOAD_FILE_I930:
291                 fw_name = "/*(DEBLOBBED)*/";
292                 break;
293         case EDGE_DOWNLOAD_FILE_80251:
294                 fw_name = "/*(DEBLOBBED)*/";
295                 break;
296         default:
297                 return;
298         }
299
300         response = reject_firmware(&fw, fw_name,
301                                          &edge_serial->serial->dev->dev);
302         if (response) {
303                 dev_err(dev, "Failed to load image \"%s\" err %d\n",
304                        fw_name, response);
305                 return;
306         }
307
308         rec = (const struct ihex_binrec *)fw->data;
309         BootMajorVersion = rec->data[0];
310         BootMinorVersion = rec->data[1];
311         BootBuildNumber = (rec->data[2] << 8) | rec->data[3];
312
313         /* Check Boot Image Version */
314         BootCurVer = (edge_serial->boot_descriptor.MajorVersion << 24) +
315                      (edge_serial->boot_descriptor.MinorVersion << 16) +
316                       le16_to_cpu(edge_serial->boot_descriptor.BuildNumber);
317
318         BootNewVer = (BootMajorVersion << 24) +
319                      (BootMinorVersion << 16) +
320                       BootBuildNumber;
321
322         dev_dbg(dev, "Current Boot Image version %d.%d.%d\n",
323             edge_serial->boot_descriptor.MajorVersion,
324             edge_serial->boot_descriptor.MinorVersion,
325             le16_to_cpu(edge_serial->boot_descriptor.BuildNumber));
326
327
328         if (BootNewVer > BootCurVer) {
329                 dev_dbg(dev, "**Update Boot Image from %d.%d.%d to %d.%d.%d\n",
330                     edge_serial->boot_descriptor.MajorVersion,
331                     edge_serial->boot_descriptor.MinorVersion,
332                     le16_to_cpu(edge_serial->boot_descriptor.BuildNumber),
333                     BootMajorVersion, BootMinorVersion, BootBuildNumber);
334
335                 dev_dbg(dev, "Downloading new Boot Image\n");
336
337                 for (rec = ihex_next_binrec(rec); rec;
338                      rec = ihex_next_binrec(rec)) {
339                         Bootaddr = be32_to_cpu(rec->addr);
340                         response = rom_write(edge_serial->serial,
341                                              Bootaddr >> 16,
342                                              Bootaddr & 0xFFFF,
343                                              be16_to_cpu(rec->len),
344                                              &rec->data[0]);
345                         if (response < 0) {
346                                 dev_err(&edge_serial->serial->dev->dev,
347                                         "rom_write failed (%x, %x, %d)\n",
348                                         Bootaddr >> 16, Bootaddr & 0xFFFF,
349                                         be16_to_cpu(rec->len));
350                                 break;
351                         }
352                 }
353         } else {
354                 dev_dbg(dev, "Boot Image -- already up to date\n");
355         }
356         release_firmware(fw);
357 }
358
359 #if 0
360 /************************************************************************
361  *
362  *  Get string descriptor from device
363  *
364  ************************************************************************/
365 static int get_string_desc(struct usb_device *dev, int Id,
366                                 struct usb_string_descriptor **pRetDesc)
367 {
368         struct usb_string_descriptor StringDesc;
369         struct usb_string_descriptor *pStringDesc;
370
371         dev_dbg(&dev->dev, "%s - USB String ID = %d\n", __func__, Id);
372
373         if (!usb_get_descriptor(dev, USB_DT_STRING, Id, &StringDesc,
374                                                 sizeof(StringDesc)))
375                 return 0;
376
377         pStringDesc = kmalloc(StringDesc.bLength, GFP_KERNEL);
378         if (!pStringDesc)
379                 return -1;
380
381         if (!usb_get_descriptor(dev, USB_DT_STRING, Id, pStringDesc,
382                                                         StringDesc.bLength)) {
383                 kfree(pStringDesc);
384                 return -1;
385         }
386
387         *pRetDesc = pStringDesc;
388         return 0;
389 }
390 #endif
391
392 static void dump_product_info(struct edgeport_serial *edge_serial,
393                               struct edgeport_product_info *product_info)
394 {
395         struct device *dev = &edge_serial->serial->dev->dev;
396
397         /* Dump Product Info structure */
398         dev_dbg(dev, "**Product Information:\n");
399         dev_dbg(dev, "  ProductId             %x\n", product_info->ProductId);
400         dev_dbg(dev, "  NumPorts              %d\n", product_info->NumPorts);
401         dev_dbg(dev, "  ProdInfoVer           %d\n", product_info->ProdInfoVer);
402         dev_dbg(dev, "  IsServer              %d\n", product_info->IsServer);
403         dev_dbg(dev, "  IsRS232               %d\n", product_info->IsRS232);
404         dev_dbg(dev, "  IsRS422               %d\n", product_info->IsRS422);
405         dev_dbg(dev, "  IsRS485               %d\n", product_info->IsRS485);
406         dev_dbg(dev, "  RomSize               %d\n", product_info->RomSize);
407         dev_dbg(dev, "  RamSize               %d\n", product_info->RamSize);
408         dev_dbg(dev, "  CpuRev                %x\n", product_info->CpuRev);
409         dev_dbg(dev, "  BoardRev              %x\n", product_info->BoardRev);
410         dev_dbg(dev, "  BootMajorVersion      %d.%d.%d\n",
411                 product_info->BootMajorVersion,
412                 product_info->BootMinorVersion,
413                 le16_to_cpu(product_info->BootBuildNumber));
414         dev_dbg(dev, "  FirmwareMajorVersion  %d.%d.%d\n",
415                 product_info->FirmwareMajorVersion,
416                 product_info->FirmwareMinorVersion,
417                 le16_to_cpu(product_info->FirmwareBuildNumber));
418         dev_dbg(dev, "  ManufactureDescDate   %d/%d/%d\n",
419                 product_info->ManufactureDescDate[0],
420                 product_info->ManufactureDescDate[1],
421                 product_info->ManufactureDescDate[2]+1900);
422         dev_dbg(dev, "  iDownloadFile         0x%x\n",
423                 product_info->iDownloadFile);
424         dev_dbg(dev, "  EpicVer               %d\n", product_info->EpicVer);
425 }
426
427 static void get_product_info(struct edgeport_serial *edge_serial)
428 {
429         struct edgeport_product_info *product_info = &edge_serial->product_info;
430
431         memset(product_info, 0, sizeof(struct edgeport_product_info));
432
433         product_info->ProductId = (__u16)(le16_to_cpu(edge_serial->serial->dev->descriptor.idProduct) & ~ION_DEVICE_ID_80251_NETCHIP);
434         product_info->NumPorts = edge_serial->manuf_descriptor.NumPorts;
435         product_info->ProdInfoVer = 0;
436
437         product_info->RomSize = edge_serial->manuf_descriptor.RomSize;
438         product_info->RamSize = edge_serial->manuf_descriptor.RamSize;
439         product_info->CpuRev = edge_serial->manuf_descriptor.CpuRev;
440         product_info->BoardRev = edge_serial->manuf_descriptor.BoardRev;
441
442         product_info->BootMajorVersion =
443                                 edge_serial->boot_descriptor.MajorVersion;
444         product_info->BootMinorVersion =
445                                 edge_serial->boot_descriptor.MinorVersion;
446         product_info->BootBuildNumber =
447                                 edge_serial->boot_descriptor.BuildNumber;
448
449         memcpy(product_info->ManufactureDescDate,
450                         edge_serial->manuf_descriptor.DescDate,
451                         sizeof(edge_serial->manuf_descriptor.DescDate));
452
453         /* check if this is 2nd generation hardware */
454         if (le16_to_cpu(edge_serial->serial->dev->descriptor.idProduct)
455                                             & ION_DEVICE_ID_80251_NETCHIP)
456                 product_info->iDownloadFile = EDGE_DOWNLOAD_FILE_80251;
457         else
458                 product_info->iDownloadFile = EDGE_DOWNLOAD_FILE_I930;
459
460         /* Determine Product type and set appropriate flags */
461         switch (DEVICE_ID_FROM_USB_PRODUCT_ID(product_info->ProductId)) {
462         case ION_DEVICE_ID_EDGEPORT_COMPATIBLE:
463         case ION_DEVICE_ID_EDGEPORT_4T:
464         case ION_DEVICE_ID_EDGEPORT_4:
465         case ION_DEVICE_ID_EDGEPORT_2:
466         case ION_DEVICE_ID_EDGEPORT_8_DUAL_CPU:
467         case ION_DEVICE_ID_EDGEPORT_8:
468         case ION_DEVICE_ID_EDGEPORT_421:
469         case ION_DEVICE_ID_EDGEPORT_21:
470         case ION_DEVICE_ID_EDGEPORT_2_DIN:
471         case ION_DEVICE_ID_EDGEPORT_4_DIN:
472         case ION_DEVICE_ID_EDGEPORT_16_DUAL_CPU:
473                 product_info->IsRS232 = 1;
474                 break;
475
476         case ION_DEVICE_ID_EDGEPORT_2I: /* Edgeport/2 RS422/RS485 */
477                 product_info->IsRS422 = 1;
478                 product_info->IsRS485 = 1;
479                 break;
480
481         case ION_DEVICE_ID_EDGEPORT_8I: /* Edgeport/4 RS422 */
482         case ION_DEVICE_ID_EDGEPORT_4I: /* Edgeport/4 RS422 */
483                 product_info->IsRS422 = 1;
484                 break;
485         }
486
487         dump_product_info(edge_serial, product_info);
488 }
489
490 static int get_epic_descriptor(struct edgeport_serial *ep)
491 {
492         int result;
493         struct usb_serial *serial = ep->serial;
494         struct edgeport_product_info *product_info = &ep->product_info;
495         struct edge_compatibility_descriptor *epic = &ep->epic_descriptor;
496         struct edge_compatibility_bits *bits;
497         struct device *dev = &serial->dev->dev;
498
499         ep->is_epic = 0;
500         result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
501                                  USB_REQUEST_ION_GET_EPIC_DESC,
502                                  0xC0, 0x00, 0x00,
503                                  &ep->epic_descriptor,
504                                  sizeof(struct edge_compatibility_descriptor),
505                                  300);
506
507         if (result > 0) {
508                 ep->is_epic = 1;
509                 memset(product_info, 0, sizeof(struct edgeport_product_info));
510
511                 product_info->NumPorts = epic->NumPorts;
512                 product_info->ProdInfoVer = 0;
513                 product_info->FirmwareMajorVersion = epic->MajorVersion;
514                 product_info->FirmwareMinorVersion = epic->MinorVersion;
515                 product_info->FirmwareBuildNumber = epic->BuildNumber;
516                 product_info->iDownloadFile = epic->iDownloadFile;
517                 product_info->EpicVer = epic->EpicVer;
518                 product_info->Epic = epic->Supports;
519                 product_info->ProductId = ION_DEVICE_ID_EDGEPORT_COMPATIBLE;
520                 dump_product_info(ep, product_info);
521
522                 bits = &ep->epic_descriptor.Supports;
523                 dev_dbg(dev, "**EPIC descriptor:\n");
524                 dev_dbg(dev, "  VendEnableSuspend: %s\n", bits->VendEnableSuspend ? "TRUE": "FALSE");
525                 dev_dbg(dev, "  IOSPOpen         : %s\n", bits->IOSPOpen        ? "TRUE": "FALSE");
526                 dev_dbg(dev, "  IOSPClose        : %s\n", bits->IOSPClose       ? "TRUE": "FALSE");
527                 dev_dbg(dev, "  IOSPChase        : %s\n", bits->IOSPChase       ? "TRUE": "FALSE");
528                 dev_dbg(dev, "  IOSPSetRxFlow    : %s\n", bits->IOSPSetRxFlow   ? "TRUE": "FALSE");
529                 dev_dbg(dev, "  IOSPSetTxFlow    : %s\n", bits->IOSPSetTxFlow   ? "TRUE": "FALSE");
530                 dev_dbg(dev, "  IOSPSetXChar     : %s\n", bits->IOSPSetXChar    ? "TRUE": "FALSE");
531                 dev_dbg(dev, "  IOSPRxCheck      : %s\n", bits->IOSPRxCheck     ? "TRUE": "FALSE");
532                 dev_dbg(dev, "  IOSPSetClrBreak  : %s\n", bits->IOSPSetClrBreak ? "TRUE": "FALSE");
533                 dev_dbg(dev, "  IOSPWriteMCR     : %s\n", bits->IOSPWriteMCR    ? "TRUE": "FALSE");
534                 dev_dbg(dev, "  IOSPWriteLCR     : %s\n", bits->IOSPWriteLCR    ? "TRUE": "FALSE");
535                 dev_dbg(dev, "  IOSPSetBaudRate  : %s\n", bits->IOSPSetBaudRate ? "TRUE": "FALSE");
536                 dev_dbg(dev, "  TrueEdgeport     : %s\n", bits->TrueEdgeport    ? "TRUE": "FALSE");
537         }
538
539         return result;
540 }
541
542
543 /************************************************************************/
544 /************************************************************************/
545 /*            U S B  C A L L B A C K   F U N C T I O N S                */
546 /*            U S B  C A L L B A C K   F U N C T I O N S                */
547 /************************************************************************/
548 /************************************************************************/
549
550 /*****************************************************************************
551  * edge_interrupt_callback
552  *      this is the callback function for when we have received data on the
553  *      interrupt endpoint.
554  *****************************************************************************/
555 static void edge_interrupt_callback(struct urb *urb)
556 {
557         struct edgeport_serial *edge_serial = urb->context;
558         struct device *dev;
559         struct edgeport_port *edge_port;
560         struct usb_serial_port *port;
561         unsigned char *data = urb->transfer_buffer;
562         int length = urb->actual_length;
563         int bytes_avail;
564         int position;
565         int txCredits;
566         int portNumber;
567         int result;
568         int status = urb->status;
569
570         switch (status) {
571         case 0:
572                 /* success */
573                 break;
574         case -ECONNRESET:
575         case -ENOENT:
576         case -ESHUTDOWN:
577                 /* this urb is terminated, clean up */
578                 dev_dbg(&urb->dev->dev, "%s - urb shutting down with status: %d\n", __func__, status);
579                 return;
580         default:
581                 dev_dbg(&urb->dev->dev, "%s - nonzero urb status received: %d\n", __func__, status);
582                 goto exit;
583         }
584
585         dev = &edge_serial->serial->dev->dev;
586
587         /* process this interrupt-read even if there are no ports open */
588         if (length) {
589                 usb_serial_debug_data(dev, __func__, length, data);
590
591                 if (length > 1) {
592                         bytes_avail = data[0] | (data[1] << 8);
593                         if (bytes_avail) {
594                                 spin_lock(&edge_serial->es_lock);
595                                 edge_serial->rxBytesAvail += bytes_avail;
596                                 dev_dbg(dev,
597                                         "%s - bytes_avail=%d, rxBytesAvail=%d, read_in_progress=%d\n",
598                                         __func__, bytes_avail,
599                                         edge_serial->rxBytesAvail,
600                                         edge_serial->read_in_progress);
601
602                                 if (edge_serial->rxBytesAvail > 0 &&
603                                     !edge_serial->read_in_progress) {
604                                         dev_dbg(dev, "%s - posting a read\n", __func__);
605                                         edge_serial->read_in_progress = true;
606
607                                         /* we have pending bytes on the
608                                            bulk in pipe, send a request */
609                                         result = usb_submit_urb(edge_serial->read_urb, GFP_ATOMIC);
610                                         if (result) {
611                                                 dev_err(dev,
612                                                         "%s - usb_submit_urb(read bulk) failed with result = %d\n",
613                                                         __func__, result);
614                                                 edge_serial->read_in_progress = false;
615                                         }
616                                 }
617                                 spin_unlock(&edge_serial->es_lock);
618                         }
619                 }
620                 /* grab the txcredits for the ports if available */
621                 position = 2;
622                 portNumber = 0;
623                 while ((position < length) &&
624                                 (portNumber < edge_serial->serial->num_ports)) {
625                         txCredits = data[position] | (data[position+1] << 8);
626                         if (txCredits) {
627                                 port = edge_serial->serial->port[portNumber];
628                                 edge_port = usb_get_serial_port_data(port);
629                                 if (edge_port->open) {
630                                         spin_lock(&edge_port->ep_lock);
631                                         edge_port->txCredits += txCredits;
632                                         spin_unlock(&edge_port->ep_lock);
633                                         dev_dbg(dev, "%s - txcredits for port%d = %d\n",
634                                                 __func__, portNumber,
635                                                 edge_port->txCredits);
636
637                                         /* tell the tty driver that something
638                                            has changed */
639                                         tty_port_tty_wakeup(&edge_port->port->port);
640                                         /* Since we have more credit, check
641                                            if more data can be sent */
642                                         send_more_port_data(edge_serial,
643                                                                 edge_port);
644                                 }
645                         }
646                         position += 2;
647                         ++portNumber;
648                 }
649         }
650
651 exit:
652         result = usb_submit_urb(urb, GFP_ATOMIC);
653         if (result)
654                 dev_err(&urb->dev->dev,
655                         "%s - Error %d submitting control urb\n",
656                                                 __func__, result);
657 }
658
659
660 /*****************************************************************************
661  * edge_bulk_in_callback
662  *      this is the callback function for when we have received data on the
663  *      bulk in endpoint.
664  *****************************************************************************/
665 static void edge_bulk_in_callback(struct urb *urb)
666 {
667         struct edgeport_serial  *edge_serial = urb->context;
668         struct device *dev;
669         unsigned char           *data = urb->transfer_buffer;
670         int                     retval;
671         __u16                   raw_data_length;
672         int status = urb->status;
673
674         if (status) {
675                 dev_dbg(&urb->dev->dev, "%s - nonzero read bulk status received: %d\n",
676                         __func__, status);
677                 edge_serial->read_in_progress = false;
678                 return;
679         }
680
681         if (urb->actual_length == 0) {
682                 dev_dbg(&urb->dev->dev, "%s - read bulk callback with no data\n", __func__);
683                 edge_serial->read_in_progress = false;
684                 return;
685         }
686
687         dev = &edge_serial->serial->dev->dev;
688         raw_data_length = urb->actual_length;
689
690         usb_serial_debug_data(dev, __func__, raw_data_length, data);
691
692         spin_lock(&edge_serial->es_lock);
693
694         /* decrement our rxBytes available by the number that we just got */
695         edge_serial->rxBytesAvail -= raw_data_length;
696
697         dev_dbg(dev, "%s - Received = %d, rxBytesAvail %d\n", __func__,
698                 raw_data_length, edge_serial->rxBytesAvail);
699
700         process_rcvd_data(edge_serial, data, urb->actual_length);
701
702         /* check to see if there's any more data for us to read */
703         if (edge_serial->rxBytesAvail > 0) {
704                 dev_dbg(dev, "%s - posting a read\n", __func__);
705                 retval = usb_submit_urb(edge_serial->read_urb, GFP_ATOMIC);
706                 if (retval) {
707                         dev_err(dev,
708                                 "%s - usb_submit_urb(read bulk) failed, retval = %d\n",
709                                 __func__, retval);
710                         edge_serial->read_in_progress = false;
711                 }
712         } else {
713                 edge_serial->read_in_progress = false;
714         }
715
716         spin_unlock(&edge_serial->es_lock);
717 }
718
719
720 /*****************************************************************************
721  * edge_bulk_out_data_callback
722  *      this is the callback function for when we have finished sending
723  *      serial data on the bulk out endpoint.
724  *****************************************************************************/
725 static void edge_bulk_out_data_callback(struct urb *urb)
726 {
727         struct edgeport_port *edge_port = urb->context;
728         int status = urb->status;
729
730         if (status) {
731                 dev_dbg(&urb->dev->dev,
732                         "%s - nonzero write bulk status received: %d\n",
733                         __func__, status);
734         }
735
736         if (edge_port->open)
737                 tty_port_tty_wakeup(&edge_port->port->port);
738
739         /* Release the Write URB */
740         edge_port->write_in_progress = false;
741
742         /* Check if more data needs to be sent */
743         send_more_port_data((struct edgeport_serial *)
744                 (usb_get_serial_data(edge_port->port->serial)), edge_port);
745 }
746
747
748 /*****************************************************************************
749  * BulkOutCmdCallback
750  *      this is the callback function for when we have finished sending a
751  *      command on the bulk out endpoint.
752  *****************************************************************************/
753 static void edge_bulk_out_cmd_callback(struct urb *urb)
754 {
755         struct edgeport_port *edge_port = urb->context;
756         int status = urb->status;
757
758         atomic_dec(&CmdUrbs);
759         dev_dbg(&urb->dev->dev, "%s - FREE URB %p (outstanding %d)\n",
760                 __func__, urb, atomic_read(&CmdUrbs));
761
762
763         /* clean up the transfer buffer */
764         kfree(urb->transfer_buffer);
765
766         /* Free the command urb */
767         usb_free_urb(urb);
768
769         if (status) {
770                 dev_dbg(&urb->dev->dev,
771                         "%s - nonzero write bulk status received: %d\n",
772                         __func__, status);
773                 return;
774         }
775
776         /* tell the tty driver that something has changed */
777         if (edge_port->open)
778                 tty_port_tty_wakeup(&edge_port->port->port);
779
780         /* we have completed the command */
781         edge_port->commandPending = false;
782         wake_up(&edge_port->wait_command);
783 }
784
785
786 /*****************************************************************************
787  * Driver tty interface functions
788  *****************************************************************************/
789
790 /*****************************************************************************
791  * SerialOpen
792  *      this function is called by the tty driver when a port is opened
793  *      If successful, we return 0
794  *      Otherwise we return a negative error number.
795  *****************************************************************************/
796 static int edge_open(struct tty_struct *tty, struct usb_serial_port *port)
797 {
798         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
799         struct device *dev = &port->dev;
800         struct usb_serial *serial;
801         struct edgeport_serial *edge_serial;
802         int response;
803
804         if (edge_port == NULL)
805                 return -ENODEV;
806
807         /* see if we've set up our endpoint info yet (can't set it up
808            in edge_startup as the structures were not set up at that time.) */
809         serial = port->serial;
810         edge_serial = usb_get_serial_data(serial);
811         if (edge_serial == NULL)
812                 return -ENODEV;
813         if (edge_serial->interrupt_in_buffer == NULL) {
814                 struct usb_serial_port *port0 = serial->port[0];
815
816                 /* not set up yet, so do it now */
817                 edge_serial->interrupt_in_buffer =
818                                         port0->interrupt_in_buffer;
819                 edge_serial->interrupt_in_endpoint =
820                                         port0->interrupt_in_endpointAddress;
821                 edge_serial->interrupt_read_urb = port0->interrupt_in_urb;
822                 edge_serial->bulk_in_buffer = port0->bulk_in_buffer;
823                 edge_serial->bulk_in_endpoint =
824                                         port0->bulk_in_endpointAddress;
825                 edge_serial->read_urb = port0->read_urb;
826                 edge_serial->bulk_out_endpoint =
827                                         port0->bulk_out_endpointAddress;
828
829                 /* set up our interrupt urb */
830                 usb_fill_int_urb(edge_serial->interrupt_read_urb,
831                       serial->dev,
832                       usb_rcvintpipe(serial->dev,
833                                 port0->interrupt_in_endpointAddress),
834                       port0->interrupt_in_buffer,
835                       edge_serial->interrupt_read_urb->transfer_buffer_length,
836                       edge_interrupt_callback, edge_serial,
837                       edge_serial->interrupt_read_urb->interval);
838
839                 /* set up our bulk in urb */
840                 usb_fill_bulk_urb(edge_serial->read_urb, serial->dev,
841                         usb_rcvbulkpipe(serial->dev,
842                                 port0->bulk_in_endpointAddress),
843                         port0->bulk_in_buffer,
844                         edge_serial->read_urb->transfer_buffer_length,
845                         edge_bulk_in_callback, edge_serial);
846                 edge_serial->read_in_progress = false;
847
848                 /* start interrupt read for this edgeport
849                  * this interrupt will continue as long
850                  * as the edgeport is connected */
851                 response = usb_submit_urb(edge_serial->interrupt_read_urb,
852                                                                 GFP_KERNEL);
853                 if (response) {
854                         dev_err(dev, "%s - Error %d submitting control urb\n",
855                                 __func__, response);
856                 }
857         }
858
859         /* initialize our wait queues */
860         init_waitqueue_head(&edge_port->wait_open);
861         init_waitqueue_head(&edge_port->wait_chase);
862         init_waitqueue_head(&edge_port->wait_command);
863
864         /* initialize our port settings */
865         edge_port->txCredits = 0;       /* Can't send any data yet */
866         /* Must always set this bit to enable ints! */
867         edge_port->shadowMCR = MCR_MASTER_IE;
868         edge_port->chaseResponsePending = false;
869
870         /* send a open port command */
871         edge_port->openPending = true;
872         edge_port->open        = false;
873         response = send_iosp_ext_cmd(edge_port, IOSP_CMD_OPEN_PORT, 0);
874
875         if (response < 0) {
876                 dev_err(dev, "%s - error sending open port command\n", __func__);
877                 edge_port->openPending = false;
878                 return -ENODEV;
879         }
880
881         /* now wait for the port to be completely opened */
882         wait_event_timeout(edge_port->wait_open, !edge_port->openPending,
883                                                                 OPEN_TIMEOUT);
884
885         if (!edge_port->open) {
886                 /* open timed out */
887                 dev_dbg(dev, "%s - open timedout\n", __func__);
888                 edge_port->openPending = false;
889                 return -ENODEV;
890         }
891
892         /* create the txfifo */
893         edge_port->txfifo.head  = 0;
894         edge_port->txfifo.tail  = 0;
895         edge_port->txfifo.count = 0;
896         edge_port->txfifo.size  = edge_port->maxTxCredits;
897         edge_port->txfifo.fifo  = kmalloc(edge_port->maxTxCredits, GFP_KERNEL);
898
899         if (!edge_port->txfifo.fifo) {
900                 edge_close(port);
901                 return -ENOMEM;
902         }
903
904         /* Allocate a URB for the write */
905         edge_port->write_urb = usb_alloc_urb(0, GFP_KERNEL);
906         edge_port->write_in_progress = false;
907
908         if (!edge_port->write_urb) {
909                 edge_close(port);
910                 return -ENOMEM;
911         }
912
913         dev_dbg(dev, "%s - Initialize TX fifo to %d bytes\n",
914                 __func__, edge_port->maxTxCredits);
915
916         return 0;
917 }
918
919
920 /************************************************************************
921  *
922  * block_until_chase_response
923  *
924  *      This function will block the close until one of the following:
925  *              1. Response to our Chase comes from Edgeport
926  *              2. A timeout of 10 seconds without activity has expired
927  *                 (1K of Edgeport data @ 2400 baud ==> 4 sec to empty)
928  *
929  ************************************************************************/
930 static void block_until_chase_response(struct edgeport_port *edge_port)
931 {
932         struct device *dev = &edge_port->port->dev;
933         DEFINE_WAIT(wait);
934         __u16 lastCredits;
935         int timeout = 1*HZ;
936         int loop = 10;
937
938         while (1) {
939                 /* Save Last credits */
940                 lastCredits = edge_port->txCredits;
941
942                 /* Did we get our Chase response */
943                 if (!edge_port->chaseResponsePending) {
944                         dev_dbg(dev, "%s - Got Chase Response\n", __func__);
945
946                         /* did we get all of our credit back? */
947                         if (edge_port->txCredits == edge_port->maxTxCredits) {
948                                 dev_dbg(dev, "%s - Got all credits\n", __func__);
949                                 return;
950                         }
951                 }
952
953                 /* Block the thread for a while */
954                 prepare_to_wait(&edge_port->wait_chase, &wait,
955                                                 TASK_UNINTERRUPTIBLE);
956                 schedule_timeout(timeout);
957                 finish_wait(&edge_port->wait_chase, &wait);
958
959                 if (lastCredits == edge_port->txCredits) {
960                         /* No activity.. count down. */
961                         loop--;
962                         if (loop == 0) {
963                                 edge_port->chaseResponsePending = false;
964                                 dev_dbg(dev, "%s - Chase TIMEOUT\n", __func__);
965                                 return;
966                         }
967                 } else {
968                         /* Reset timeout value back to 10 seconds */
969                         dev_dbg(dev, "%s - Last %d, Current %d\n", __func__,
970                                         lastCredits, edge_port->txCredits);
971                         loop = 10;
972                 }
973         }
974 }
975
976
977 /************************************************************************
978  *
979  * block_until_tx_empty
980  *
981  *      This function will block the close until one of the following:
982  *              1. TX count are 0
983  *              2. The edgeport has stopped
984  *              3. A timeout of 3 seconds without activity has expired
985  *
986  ************************************************************************/
987 static void block_until_tx_empty(struct edgeport_port *edge_port)
988 {
989         struct device *dev = &edge_port->port->dev;
990         DEFINE_WAIT(wait);
991         struct TxFifo *fifo = &edge_port->txfifo;
992         __u32 lastCount;
993         int timeout = HZ/10;
994         int loop = 30;
995
996         while (1) {
997                 /* Save Last count */
998                 lastCount = fifo->count;
999
1000                 /* Is the Edgeport Buffer empty? */
1001                 if (lastCount == 0) {
1002                         dev_dbg(dev, "%s - TX Buffer Empty\n", __func__);
1003                         return;
1004                 }
1005
1006                 /* Block the thread for a while */
1007                 prepare_to_wait(&edge_port->wait_chase, &wait,
1008                                                 TASK_UNINTERRUPTIBLE);
1009                 schedule_timeout(timeout);
1010                 finish_wait(&edge_port->wait_chase, &wait);
1011
1012                 dev_dbg(dev, "%s wait\n", __func__);
1013
1014                 if (lastCount == fifo->count) {
1015                         /* No activity.. count down. */
1016                         loop--;
1017                         if (loop == 0) {
1018                                 dev_dbg(dev, "%s - TIMEOUT\n", __func__);
1019                                 return;
1020                         }
1021                 } else {
1022                         /* Reset timeout value back to seconds */
1023                         loop = 30;
1024                 }
1025         }
1026 }
1027
1028
1029 /*****************************************************************************
1030  * edge_close
1031  *      this function is called by the tty driver when a port is closed
1032  *****************************************************************************/
1033 static void edge_close(struct usb_serial_port *port)
1034 {
1035         struct edgeport_serial *edge_serial;
1036         struct edgeport_port *edge_port;
1037         int status;
1038
1039         edge_serial = usb_get_serial_data(port->serial);
1040         edge_port = usb_get_serial_port_data(port);
1041         if (edge_serial == NULL || edge_port == NULL)
1042                 return;
1043
1044         /* block until tx is empty */
1045         block_until_tx_empty(edge_port);
1046
1047         edge_port->closePending = true;
1048
1049         if (!edge_serial->is_epic ||
1050             edge_serial->epic_descriptor.Supports.IOSPChase) {
1051                 /* flush and chase */
1052                 edge_port->chaseResponsePending = true;
1053
1054                 dev_dbg(&port->dev, "%s - Sending IOSP_CMD_CHASE_PORT\n", __func__);
1055                 status = send_iosp_ext_cmd(edge_port, IOSP_CMD_CHASE_PORT, 0);
1056                 if (status == 0)
1057                         /* block until chase finished */
1058                         block_until_chase_response(edge_port);
1059                 else
1060                         edge_port->chaseResponsePending = false;
1061         }
1062
1063         if (!edge_serial->is_epic ||
1064             edge_serial->epic_descriptor.Supports.IOSPClose) {
1065                /* close the port */
1066                 dev_dbg(&port->dev, "%s - Sending IOSP_CMD_CLOSE_PORT\n", __func__);
1067                 send_iosp_ext_cmd(edge_port, IOSP_CMD_CLOSE_PORT, 0);
1068         }
1069
1070         /* port->close = true; */
1071         edge_port->closePending = false;
1072         edge_port->open = false;
1073         edge_port->openPending = false;
1074
1075         usb_kill_urb(edge_port->write_urb);
1076
1077         if (edge_port->write_urb) {
1078                 /* if this urb had a transfer buffer already
1079                                 (old transfer) free it */
1080                 kfree(edge_port->write_urb->transfer_buffer);
1081                 usb_free_urb(edge_port->write_urb);
1082                 edge_port->write_urb = NULL;
1083         }
1084         kfree(edge_port->txfifo.fifo);
1085         edge_port->txfifo.fifo = NULL;
1086 }
1087
1088 /*****************************************************************************
1089  * SerialWrite
1090  *      this function is called by the tty driver when data should be written
1091  *      to the port.
1092  *      If successful, we return the number of bytes written, otherwise we
1093  *      return a negative error number.
1094  *****************************************************************************/
1095 static int edge_write(struct tty_struct *tty, struct usb_serial_port *port,
1096                                         const unsigned char *data, int count)
1097 {
1098         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1099         struct TxFifo *fifo;
1100         int copySize;
1101         int bytesleft;
1102         int firsthalf;
1103         int secondhalf;
1104         unsigned long flags;
1105
1106         if (edge_port == NULL)
1107                 return -ENODEV;
1108
1109         /* get a pointer to the Tx fifo */
1110         fifo = &edge_port->txfifo;
1111
1112         spin_lock_irqsave(&edge_port->ep_lock, flags);
1113
1114         /* calculate number of bytes to put in fifo */
1115         copySize = min((unsigned int)count,
1116                                 (edge_port->txCredits - fifo->count));
1117
1118         dev_dbg(&port->dev, "%s of %d byte(s) Fifo room  %d -- will copy %d bytes\n",
1119                 __func__, count, edge_port->txCredits - fifo->count, copySize);
1120
1121         /* catch writes of 0 bytes which the tty driver likes to give us,
1122            and when txCredits is empty */
1123         if (copySize == 0) {
1124                 dev_dbg(&port->dev, "%s - copySize = Zero\n", __func__);
1125                 goto finish_write;
1126         }
1127
1128         /* queue the data
1129          * since we can never overflow the buffer we do not have to check for a
1130          * full condition
1131          *
1132          * the copy is done is two parts -- first fill to the end of the buffer
1133          * then copy the reset from the start of the buffer
1134          */
1135         bytesleft = fifo->size - fifo->head;
1136         firsthalf = min(bytesleft, copySize);
1137         dev_dbg(&port->dev, "%s - copy %d bytes of %d into fifo \n", __func__,
1138                 firsthalf, bytesleft);
1139
1140         /* now copy our data */
1141         memcpy(&fifo->fifo[fifo->head], data, firsthalf);
1142         usb_serial_debug_data(&port->dev, __func__, firsthalf, &fifo->fifo[fifo->head]);
1143
1144         /* update the index and size */
1145         fifo->head  += firsthalf;
1146         fifo->count += firsthalf;
1147
1148         /* wrap the index */
1149         if (fifo->head == fifo->size)
1150                 fifo->head = 0;
1151
1152         secondhalf = copySize-firsthalf;
1153
1154         if (secondhalf) {
1155                 dev_dbg(&port->dev, "%s - copy rest of data %d\n", __func__, secondhalf);
1156                 memcpy(&fifo->fifo[fifo->head], &data[firsthalf], secondhalf);
1157                 usb_serial_debug_data(&port->dev, __func__, secondhalf, &fifo->fifo[fifo->head]);
1158                 /* update the index and size */
1159                 fifo->count += secondhalf;
1160                 fifo->head  += secondhalf;
1161                 /* No need to check for wrap since we can not get to end of
1162                  * the fifo in this part
1163                  */
1164         }
1165
1166 finish_write:
1167         spin_unlock_irqrestore(&edge_port->ep_lock, flags);
1168
1169         send_more_port_data((struct edgeport_serial *)
1170                         usb_get_serial_data(port->serial), edge_port);
1171
1172         dev_dbg(&port->dev, "%s wrote %d byte(s) TxCredits %d, Fifo %d\n",
1173                 __func__, copySize, edge_port->txCredits, fifo->count);
1174
1175         return copySize;
1176 }
1177
1178
1179 /************************************************************************
1180  *
1181  * send_more_port_data()
1182  *
1183  *      This routine attempts to write additional UART transmit data
1184  *      to a port over the USB bulk pipe. It is called (1) when new
1185  *      data has been written to a port's TxBuffer from higher layers
1186  *      (2) when the peripheral sends us additional TxCredits indicating
1187  *      that it can accept more Tx data for a given port; and (3) when
1188  *      a bulk write completes successfully and we want to see if we
1189  *      can transmit more.
1190  *
1191  ************************************************************************/
1192 static void send_more_port_data(struct edgeport_serial *edge_serial,
1193                                         struct edgeport_port *edge_port)
1194 {
1195         struct TxFifo   *fifo = &edge_port->txfifo;
1196         struct device   *dev = &edge_port->port->dev;
1197         struct urb      *urb;
1198         unsigned char   *buffer;
1199         int             status;
1200         int             count;
1201         int             bytesleft;
1202         int             firsthalf;
1203         int             secondhalf;
1204         unsigned long   flags;
1205
1206         spin_lock_irqsave(&edge_port->ep_lock, flags);
1207
1208         if (edge_port->write_in_progress ||
1209             !edge_port->open             ||
1210             (fifo->count == 0)) {
1211                 dev_dbg(dev, "%s EXIT - fifo %d, PendingWrite = %d\n",
1212                         __func__, fifo->count, edge_port->write_in_progress);
1213                 goto exit_send;
1214         }
1215
1216         /* since the amount of data in the fifo will always fit into the
1217          * edgeport buffer we do not need to check the write length
1218          *
1219          * Do we have enough credits for this port to make it worthwhile
1220          * to bother queueing a write. If it's too small, say a few bytes,
1221          * it's better to wait for more credits so we can do a larger write.
1222          */
1223         if (edge_port->txCredits < EDGE_FW_GET_TX_CREDITS_SEND_THRESHOLD(edge_port->maxTxCredits, EDGE_FW_BULK_MAX_PACKET_SIZE)) {
1224                 dev_dbg(dev, "%s Not enough credit - fifo %d TxCredit %d\n",
1225                         __func__, fifo->count, edge_port->txCredits);
1226                 goto exit_send;
1227         }
1228
1229         /* lock this write */
1230         edge_port->write_in_progress = true;
1231
1232         /* get a pointer to the write_urb */
1233         urb = edge_port->write_urb;
1234
1235         /* make sure transfer buffer is freed */
1236         kfree(urb->transfer_buffer);
1237         urb->transfer_buffer = NULL;
1238
1239         /* build the data header for the buffer and port that we are about
1240            to send out */
1241         count = fifo->count;
1242         buffer = kmalloc(count+2, GFP_ATOMIC);
1243         if (!buffer) {
1244                 edge_port->write_in_progress = false;
1245                 goto exit_send;
1246         }
1247         buffer[0] = IOSP_BUILD_DATA_HDR1(edge_port->port->port_number, count);
1248         buffer[1] = IOSP_BUILD_DATA_HDR2(edge_port->port->port_number, count);
1249
1250         /* now copy our data */
1251         bytesleft =  fifo->size - fifo->tail;
1252         firsthalf = min(bytesleft, count);
1253         memcpy(&buffer[2], &fifo->fifo[fifo->tail], firsthalf);
1254         fifo->tail  += firsthalf;
1255         fifo->count -= firsthalf;
1256         if (fifo->tail == fifo->size)
1257                 fifo->tail = 0;
1258
1259         secondhalf = count-firsthalf;
1260         if (secondhalf) {
1261                 memcpy(&buffer[2+firsthalf], &fifo->fifo[fifo->tail],
1262                                                                 secondhalf);
1263                 fifo->tail  += secondhalf;
1264                 fifo->count -= secondhalf;
1265         }
1266
1267         if (count)
1268                 usb_serial_debug_data(&edge_port->port->dev, __func__, count, &buffer[2]);
1269
1270         /* fill up the urb with all of our data and submit it */
1271         usb_fill_bulk_urb(urb, edge_serial->serial->dev,
1272                         usb_sndbulkpipe(edge_serial->serial->dev,
1273                                         edge_serial->bulk_out_endpoint),
1274                         buffer, count+2,
1275                         edge_bulk_out_data_callback, edge_port);
1276
1277         /* decrement the number of credits we have by the number we just sent */
1278         edge_port->txCredits -= count;
1279         edge_port->port->icount.tx += count;
1280
1281         status = usb_submit_urb(urb, GFP_ATOMIC);
1282         if (status) {
1283                 /* something went wrong */
1284                 dev_err_console(edge_port->port,
1285                         "%s - usb_submit_urb(write bulk) failed, status = %d, data lost\n",
1286                                 __func__, status);
1287                 edge_port->write_in_progress = false;
1288
1289                 /* revert the credits as something bad happened. */
1290                 edge_port->txCredits += count;
1291                 edge_port->port->icount.tx -= count;
1292         }
1293         dev_dbg(dev, "%s wrote %d byte(s) TxCredit %d, Fifo %d\n",
1294                 __func__, count, edge_port->txCredits, fifo->count);
1295
1296 exit_send:
1297         spin_unlock_irqrestore(&edge_port->ep_lock, flags);
1298 }
1299
1300
1301 /*****************************************************************************
1302  * edge_write_room
1303  *      this function is called by the tty driver when it wants to know how
1304  *      many bytes of data we can accept for a specific port. If successful,
1305  *      we return the amount of room that we have for this port (the txCredits)
1306  *      otherwise we return a negative error number.
1307  *****************************************************************************/
1308 static int edge_write_room(struct tty_struct *tty)
1309 {
1310         struct usb_serial_port *port = tty->driver_data;
1311         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1312         int room;
1313         unsigned long flags;
1314
1315         if (edge_port == NULL)
1316                 return 0;
1317         if (edge_port->closePending)
1318                 return 0;
1319
1320         if (!edge_port->open) {
1321                 dev_dbg(&port->dev, "%s - port not opened\n", __func__);
1322                 return 0;
1323         }
1324
1325         /* total of both buffers is still txCredit */
1326         spin_lock_irqsave(&edge_port->ep_lock, flags);
1327         room = edge_port->txCredits - edge_port->txfifo.count;
1328         spin_unlock_irqrestore(&edge_port->ep_lock, flags);
1329
1330         dev_dbg(&port->dev, "%s - returns %d\n", __func__, room);
1331         return room;
1332 }
1333
1334
1335 /*****************************************************************************
1336  * edge_chars_in_buffer
1337  *      this function is called by the tty driver when it wants to know how
1338  *      many bytes of data we currently have outstanding in the port (data that
1339  *      has been written, but hasn't made it out the port yet)
1340  *      If successful, we return the number of bytes left to be written in the
1341  *      system,
1342  *      Otherwise we return a negative error number.
1343  *****************************************************************************/
1344 static int edge_chars_in_buffer(struct tty_struct *tty)
1345 {
1346         struct usb_serial_port *port = tty->driver_data;
1347         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1348         int num_chars;
1349         unsigned long flags;
1350
1351         if (edge_port == NULL)
1352                 return 0;
1353         if (edge_port->closePending)
1354                 return 0;
1355
1356         if (!edge_port->open) {
1357                 dev_dbg(&port->dev, "%s - port not opened\n", __func__);
1358                 return 0;
1359         }
1360
1361         spin_lock_irqsave(&edge_port->ep_lock, flags);
1362         num_chars = edge_port->maxTxCredits - edge_port->txCredits +
1363                                                 edge_port->txfifo.count;
1364         spin_unlock_irqrestore(&edge_port->ep_lock, flags);
1365         if (num_chars) {
1366                 dev_dbg(&port->dev, "%s - returns %d\n", __func__, num_chars);
1367         }
1368
1369         return num_chars;
1370 }
1371
1372
1373 /*****************************************************************************
1374  * SerialThrottle
1375  *      this function is called by the tty driver when it wants to stop the data
1376  *      being read from the port.
1377  *****************************************************************************/
1378 static void edge_throttle(struct tty_struct *tty)
1379 {
1380         struct usb_serial_port *port = tty->driver_data;
1381         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1382         int status;
1383
1384         if (edge_port == NULL)
1385                 return;
1386
1387         if (!edge_port->open) {
1388                 dev_dbg(&port->dev, "%s - port not opened\n", __func__);
1389                 return;
1390         }
1391
1392         /* if we are implementing XON/XOFF, send the stop character */
1393         if (I_IXOFF(tty)) {
1394                 unsigned char stop_char = STOP_CHAR(tty);
1395                 status = edge_write(tty, port, &stop_char, 1);
1396                 if (status <= 0)
1397                         return;
1398         }
1399
1400         /* if we are implementing RTS/CTS, toggle that line */
1401         if (C_CRTSCTS(tty)) {
1402                 edge_port->shadowMCR &= ~MCR_RTS;
1403                 status = send_cmd_write_uart_register(edge_port, MCR,
1404                                                         edge_port->shadowMCR);
1405                 if (status != 0)
1406                         return;
1407         }
1408 }
1409
1410
1411 /*****************************************************************************
1412  * edge_unthrottle
1413  *      this function is called by the tty driver when it wants to resume the
1414  *      data being read from the port (called after SerialThrottle is called)
1415  *****************************************************************************/
1416 static void edge_unthrottle(struct tty_struct *tty)
1417 {
1418         struct usb_serial_port *port = tty->driver_data;
1419         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1420         int status;
1421
1422         if (edge_port == NULL)
1423                 return;
1424
1425         if (!edge_port->open) {
1426                 dev_dbg(&port->dev, "%s - port not opened\n", __func__);
1427                 return;
1428         }
1429
1430         /* if we are implementing XON/XOFF, send the start character */
1431         if (I_IXOFF(tty)) {
1432                 unsigned char start_char = START_CHAR(tty);
1433                 status = edge_write(tty, port, &start_char, 1);
1434                 if (status <= 0)
1435                         return;
1436         }
1437         /* if we are implementing RTS/CTS, toggle that line */
1438         if (C_CRTSCTS(tty)) {
1439                 edge_port->shadowMCR |= MCR_RTS;
1440                 send_cmd_write_uart_register(edge_port, MCR,
1441                                                 edge_port->shadowMCR);
1442         }
1443 }
1444
1445
1446 /*****************************************************************************
1447  * SerialSetTermios
1448  *      this function is called by the tty driver when it wants to change
1449  * the termios structure
1450  *****************************************************************************/
1451 static void edge_set_termios(struct tty_struct *tty,
1452         struct usb_serial_port *port, struct ktermios *old_termios)
1453 {
1454         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1455         unsigned int cflag;
1456
1457         cflag = tty->termios.c_cflag;
1458         dev_dbg(&port->dev, "%s - clfag %08x iflag %08x\n", __func__, tty->termios.c_cflag, tty->termios.c_iflag);
1459         dev_dbg(&port->dev, "%s - old clfag %08x old iflag %08x\n", __func__, old_termios->c_cflag, old_termios->c_iflag);
1460
1461         if (edge_port == NULL)
1462                 return;
1463
1464         if (!edge_port->open) {
1465                 dev_dbg(&port->dev, "%s - port not opened\n", __func__);
1466                 return;
1467         }
1468
1469         /* change the port settings to the new ones specified */
1470         change_port_settings(tty, edge_port, old_termios);
1471 }
1472
1473
1474 /*****************************************************************************
1475  * get_lsr_info - get line status register info
1476  *
1477  * Purpose: Let user call ioctl() to get info when the UART physically
1478  *          is emptied.  On bus types like RS485, the transmitter must
1479  *          release the bus after transmitting. This must be done when
1480  *          the transmit shift register is empty, not be done when the
1481  *          transmit holding register is empty.  This functionality
1482  *          allows an RS485 driver to be written in user space.
1483  *****************************************************************************/
1484 static int get_lsr_info(struct edgeport_port *edge_port,
1485                                                 unsigned int __user *value)
1486 {
1487         unsigned int result = 0;
1488         unsigned long flags;
1489
1490         spin_lock_irqsave(&edge_port->ep_lock, flags);
1491         if (edge_port->maxTxCredits == edge_port->txCredits &&
1492             edge_port->txfifo.count == 0) {
1493                 dev_dbg(&edge_port->port->dev, "%s -- Empty\n", __func__);
1494                 result = TIOCSER_TEMT;
1495         }
1496         spin_unlock_irqrestore(&edge_port->ep_lock, flags);
1497
1498         if (copy_to_user(value, &result, sizeof(int)))
1499                 return -EFAULT;
1500         return 0;
1501 }
1502
1503 static int edge_tiocmset(struct tty_struct *tty,
1504                                         unsigned int set, unsigned int clear)
1505 {
1506         struct usb_serial_port *port = tty->driver_data;
1507         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1508         unsigned int mcr;
1509
1510         mcr = edge_port->shadowMCR;
1511         if (set & TIOCM_RTS)
1512                 mcr |= MCR_RTS;
1513         if (set & TIOCM_DTR)
1514                 mcr |= MCR_DTR;
1515         if (set & TIOCM_LOOP)
1516                 mcr |= MCR_LOOPBACK;
1517
1518         if (clear & TIOCM_RTS)
1519                 mcr &= ~MCR_RTS;
1520         if (clear & TIOCM_DTR)
1521                 mcr &= ~MCR_DTR;
1522         if (clear & TIOCM_LOOP)
1523                 mcr &= ~MCR_LOOPBACK;
1524
1525         edge_port->shadowMCR = mcr;
1526
1527         send_cmd_write_uart_register(edge_port, MCR, edge_port->shadowMCR);
1528
1529         return 0;
1530 }
1531
1532 static int edge_tiocmget(struct tty_struct *tty)
1533 {
1534         struct usb_serial_port *port = tty->driver_data;
1535         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1536         unsigned int result = 0;
1537         unsigned int msr;
1538         unsigned int mcr;
1539
1540         msr = edge_port->shadowMSR;
1541         mcr = edge_port->shadowMCR;
1542         result = ((mcr & MCR_DTR)       ? TIOCM_DTR: 0)   /* 0x002 */
1543                   | ((mcr & MCR_RTS)    ? TIOCM_RTS: 0)   /* 0x004 */
1544                   | ((msr & EDGEPORT_MSR_CTS)   ? TIOCM_CTS: 0)   /* 0x020 */
1545                   | ((msr & EDGEPORT_MSR_CD)    ? TIOCM_CAR: 0)   /* 0x040 */
1546                   | ((msr & EDGEPORT_MSR_RI)    ? TIOCM_RI:  0)   /* 0x080 */
1547                   | ((msr & EDGEPORT_MSR_DSR)   ? TIOCM_DSR: 0);  /* 0x100 */
1548
1549         return result;
1550 }
1551
1552 static int get_serial_info(struct edgeport_port *edge_port,
1553                                 struct serial_struct __user *retinfo)
1554 {
1555         struct serial_struct tmp;
1556
1557         memset(&tmp, 0, sizeof(tmp));
1558
1559         tmp.type                = PORT_16550A;
1560         tmp.line                = edge_port->port->minor;
1561         tmp.port                = edge_port->port->port_number;
1562         tmp.irq                 = 0;
1563         tmp.flags               = ASYNC_SKIP_TEST | ASYNC_AUTO_IRQ;
1564         tmp.xmit_fifo_size      = edge_port->maxTxCredits;
1565         tmp.baud_base           = 9600;
1566         tmp.close_delay         = 5*HZ;
1567         tmp.closing_wait        = 30*HZ;
1568
1569         if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
1570                 return -EFAULT;
1571         return 0;
1572 }
1573
1574
1575 /*****************************************************************************
1576  * SerialIoctl
1577  *      this function handles any ioctl calls to the driver
1578  *****************************************************************************/
1579 static int edge_ioctl(struct tty_struct *tty,
1580                                         unsigned int cmd, unsigned long arg)
1581 {
1582         struct usb_serial_port *port = tty->driver_data;
1583         DEFINE_WAIT(wait);
1584         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1585
1586         switch (cmd) {
1587         case TIOCSERGETLSR:
1588                 dev_dbg(&port->dev, "%s TIOCSERGETLSR\n", __func__);
1589                 return get_lsr_info(edge_port, (unsigned int __user *) arg);
1590
1591         case TIOCGSERIAL:
1592                 dev_dbg(&port->dev, "%s TIOCGSERIAL\n", __func__);
1593                 return get_serial_info(edge_port, (struct serial_struct __user *) arg);
1594         }
1595         return -ENOIOCTLCMD;
1596 }
1597
1598
1599 /*****************************************************************************
1600  * SerialBreak
1601  *      this function sends a break to the port
1602  *****************************************************************************/
1603 static void edge_break(struct tty_struct *tty, int break_state)
1604 {
1605         struct usb_serial_port *port = tty->driver_data;
1606         struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1607         struct edgeport_serial *edge_serial = usb_get_serial_data(port->serial);
1608         int status;
1609
1610         if (!edge_serial->is_epic ||
1611             edge_serial->epic_descriptor.Supports.IOSPChase) {
1612                 /* flush and chase */
1613                 edge_port->chaseResponsePending = true;
1614
1615                 dev_dbg(&port->dev, "%s - Sending IOSP_CMD_CHASE_PORT\n", __func__);
1616                 status = send_iosp_ext_cmd(edge_port, IOSP_CMD_CHASE_PORT, 0);
1617                 if (status == 0) {
1618                         /* block until chase finished */
1619                         block_until_chase_response(edge_port);
1620                 } else {
1621                         edge_port->chaseResponsePending = false;
1622                 }
1623         }
1624
1625         if (!edge_serial->is_epic ||
1626             edge_serial->epic_descriptor.Supports.IOSPSetClrBreak) {
1627                 if (break_state == -1) {
1628                         dev_dbg(&port->dev, "%s - Sending IOSP_CMD_SET_BREAK\n", __func__);
1629                         status = send_iosp_ext_cmd(edge_port,
1630                                                 IOSP_CMD_SET_BREAK, 0);
1631                 } else {
1632                         dev_dbg(&port->dev, "%s - Sending IOSP_CMD_CLEAR_BREAK\n", __func__);
1633                         status = send_iosp_ext_cmd(edge_port,
1634                                                 IOSP_CMD_CLEAR_BREAK, 0);
1635                 }
1636                 if (status)
1637                         dev_dbg(&port->dev, "%s - error sending break set/clear command.\n",
1638                                 __func__);
1639         }
1640 }
1641
1642
1643 /*****************************************************************************
1644  * process_rcvd_data
1645  *      this function handles the data received on the bulk in pipe.
1646  *****************************************************************************/
1647 static void process_rcvd_data(struct edgeport_serial *edge_serial,
1648                                 unsigned char *buffer, __u16 bufferLength)
1649 {
1650         struct device *dev = &edge_serial->serial->dev->dev;
1651         struct usb_serial_port *port;
1652         struct edgeport_port *edge_port;
1653         __u16 lastBufferLength;
1654         __u16 rxLen;
1655
1656         lastBufferLength = bufferLength + 1;
1657
1658         while (bufferLength > 0) {
1659                 /* failsafe incase we get a message that we don't understand */
1660                 if (lastBufferLength == bufferLength) {
1661                         dev_dbg(dev, "%s - stuck in loop, exiting it.\n", __func__);
1662                         break;
1663                 }
1664                 lastBufferLength = bufferLength;
1665
1666                 switch (edge_serial->rxState) {
1667                 case EXPECT_HDR1:
1668                         edge_serial->rxHeader1 = *buffer;
1669                         ++buffer;
1670                         --bufferLength;
1671
1672                         if (bufferLength == 0) {
1673                                 edge_serial->rxState = EXPECT_HDR2;
1674                                 break;
1675                         }
1676                         /* otherwise, drop on through */
1677                 case EXPECT_HDR2:
1678                         edge_serial->rxHeader2 = *buffer;
1679                         ++buffer;
1680                         --bufferLength;
1681
1682                         dev_dbg(dev, "%s - Hdr1=%02X Hdr2=%02X\n", __func__,
1683                                 edge_serial->rxHeader1, edge_serial->rxHeader2);
1684                         /* Process depending on whether this header is
1685                          * data or status */
1686
1687                         if (IS_CMD_STAT_HDR(edge_serial->rxHeader1)) {
1688                                 /* Decode this status header and go to
1689                                  * EXPECT_HDR1 (if we can process the status
1690                                  * with only 2 bytes), or go to EXPECT_HDR3 to
1691                                  * get the third byte. */
1692                                 edge_serial->rxPort =
1693                                     IOSP_GET_HDR_PORT(edge_serial->rxHeader1);
1694                                 edge_serial->rxStatusCode =
1695                                     IOSP_GET_STATUS_CODE(
1696                                                 edge_serial->rxHeader1);
1697
1698                                 if (!IOSP_STATUS_IS_2BYTE(
1699                                                 edge_serial->rxStatusCode)) {
1700                                         /* This status needs additional bytes.
1701                                          * Save what we have and then wait for
1702                                          * more data.
1703                                          */
1704                                         edge_serial->rxStatusParam
1705                                                 = edge_serial->rxHeader2;
1706                                         edge_serial->rxState = EXPECT_HDR3;
1707                                         break;
1708                                 }
1709                                 /* We have all the header bytes, process the
1710                                    status now */
1711                                 process_rcvd_status(edge_serial,
1712                                                 edge_serial->rxHeader2, 0);
1713                                 edge_serial->rxState = EXPECT_HDR1;
1714                                 break;
1715                         } else {
1716                                 edge_serial->rxPort =
1717                                     IOSP_GET_HDR_PORT(edge_serial->rxHeader1);
1718                                 edge_serial->rxBytesRemaining =
1719                                     IOSP_GET_HDR_DATA_LEN(
1720                                                 edge_serial->rxHeader1,
1721                                                 edge_serial->rxHeader2);
1722                                 dev_dbg(dev, "%s - Data for Port %u Len %u\n",
1723                                         __func__,
1724                                         edge_serial->rxPort,
1725                                         edge_serial->rxBytesRemaining);
1726
1727                                 /* ASSERT(DevExt->RxPort < DevExt->NumPorts);
1728                                  * ASSERT(DevExt->RxBytesRemaining <
1729                                  *              IOSP_MAX_DATA_LENGTH);
1730                                  */
1731
1732                                 if (bufferLength == 0) {
1733                                         edge_serial->rxState = EXPECT_DATA;
1734                                         break;
1735                                 }
1736                                 /* Else, drop through */
1737                         }
1738                 case EXPECT_DATA: /* Expect data */
1739                         if (bufferLength < edge_serial->rxBytesRemaining) {
1740                                 rxLen = bufferLength;
1741                                 /* Expect data to start next buffer */
1742                                 edge_serial->rxState = EXPECT_DATA;
1743                         } else {
1744                                 /* BufLen >= RxBytesRemaining */
1745                                 rxLen = edge_serial->rxBytesRemaining;
1746                                 /* Start another header next time */
1747                                 edge_serial->rxState = EXPECT_HDR1;
1748                         }
1749
1750                         bufferLength -= rxLen;
1751                         edge_serial->rxBytesRemaining -= rxLen;
1752
1753                         /* spit this data back into the tty driver if this
1754                            port is open */
1755                         if (rxLen) {
1756                                 port = edge_serial->serial->port[
1757                                                         edge_serial->rxPort];
1758                                 edge_port = usb_get_serial_port_data(port);
1759                                 if (edge_port->open) {
1760                                         dev_dbg(dev, "%s - Sending %d bytes to TTY for port %d\n",
1761                                                 __func__, rxLen,
1762                                                 edge_serial->rxPort);
1763                                         edge_tty_recv(edge_port->port, buffer,
1764                                                         rxLen);
1765                                         edge_port->port->icount.rx += rxLen;
1766                                 }
1767                                 buffer += rxLen;
1768                         }
1769                         break;
1770
1771                 case EXPECT_HDR3:       /* Expect 3rd byte of status header */
1772                         edge_serial->rxHeader3 = *buffer;
1773                         ++buffer;
1774                         --bufferLength;
1775
1776                         /* We have all the header bytes, process the
1777                            status now */
1778                         process_rcvd_status(edge_serial,
1779                                 edge_serial->rxStatusParam,
1780                                 edge_serial->rxHeader3);
1781                         edge_serial->rxState = EXPECT_HDR1;
1782                         break;
1783                 }
1784         }
1785 }
1786
1787
1788 /*****************************************************************************
1789  * process_rcvd_status
1790  *      this function handles the any status messages received on the
1791  *      bulk in pipe.
1792  *****************************************************************************/
1793 static void process_rcvd_status(struct edgeport_serial *edge_serial,
1794                                                 __u8 byte2, __u8 byte3)
1795 {
1796         struct usb_serial_port *port;
1797         struct edgeport_port *edge_port;
1798         struct tty_struct *tty;
1799         struct device *dev;
1800         __u8 code = edge_serial->rxStatusCode;
1801
1802         /* switch the port pointer to the one being currently talked about */
1803         port = edge_serial->serial->port[edge_serial->rxPort];
1804         edge_port = usb_get_serial_port_data(port);
1805         if (edge_port == NULL) {
1806                 dev_err(&edge_serial->serial->dev->dev,
1807                         "%s - edge_port == NULL for port %d\n",
1808                                         __func__, edge_serial->rxPort);
1809                 return;
1810         }
1811         dev = &port->dev;
1812
1813         if (code == IOSP_EXT_STATUS) {
1814                 switch (byte2) {
1815                 case IOSP_EXT_STATUS_CHASE_RSP:
1816                         /* we want to do EXT status regardless of port
1817                          * open/closed */
1818                         dev_dbg(dev, "%s - Port %u EXT CHASE_RSP Data = %02x\n",
1819                                 __func__, edge_serial->rxPort, byte3);
1820                         /* Currently, the only EXT_STATUS is Chase, so process
1821                          * here instead of one more call to one more subroutine
1822                          * If/when more EXT_STATUS, there'll be more work to do
1823                          * Also, we currently clear flag and close the port
1824                          * regardless of content of above's Byte3.
1825                          * We could choose to do something else when Byte3 says
1826                          * Timeout on Chase from Edgeport, like wait longer in
1827                          * block_until_chase_response, but for now we don't.
1828                          */
1829                         edge_port->chaseResponsePending = false;
1830                         wake_up(&edge_port->wait_chase);
1831                         return;
1832
1833                 case IOSP_EXT_STATUS_RX_CHECK_RSP:
1834                         dev_dbg(dev, "%s ========== Port %u CHECK_RSP Sequence = %02x =============\n",
1835                                 __func__, edge_serial->rxPort, byte3);
1836                         /* Port->RxCheckRsp = true; */
1837                         return;
1838                 }
1839         }
1840
1841         if (code == IOSP_STATUS_OPEN_RSP) {
1842                 edge_port->txCredits = GET_TX_BUFFER_SIZE(byte3);
1843                 edge_port->maxTxCredits = edge_port->txCredits;
1844                 dev_dbg(dev, "%s - Port %u Open Response Initial MSR = %02x TxBufferSize = %d\n",
1845                         __func__, edge_serial->rxPort, byte2, edge_port->txCredits);
1846                 handle_new_msr(edge_port, byte2);
1847
1848                 /* send the current line settings to the port so we are
1849                    in sync with any further termios calls */
1850                 tty = tty_port_tty_get(&edge_port->port->port);
1851                 if (tty) {
1852                         change_port_settings(tty,
1853                                 edge_port, &tty->termios);
1854                         tty_kref_put(tty);
1855                 }
1856
1857                 /* we have completed the open */
1858                 edge_port->openPending = false;
1859                 edge_port->open = true;
1860                 wake_up(&edge_port->wait_open);
1861                 return;
1862         }
1863
1864         /* If port is closed, silently discard all rcvd status. We can
1865          * have cases where buffered status is received AFTER the close
1866          * port command is sent to the Edgeport.
1867          */
1868         if (!edge_port->open || edge_port->closePending)
1869                 return;
1870
1871         switch (code) {
1872         /* Not currently sent by Edgeport */
1873         case IOSP_STATUS_LSR:
1874                 dev_dbg(dev, "%s - Port %u LSR Status = %02x\n",
1875                         __func__, edge_serial->rxPort, byte2);
1876                 handle_new_lsr(edge_port, false, byte2, 0);
1877                 break;
1878
1879         case IOSP_STATUS_LSR_DATA:
1880                 dev_dbg(dev, "%s - Port %u LSR Status = %02x, Data = %02x\n",
1881                         __func__, edge_serial->rxPort, byte2, byte3);
1882                 /* byte2 is LSR Register */
1883                 /* byte3 is broken data byte */
1884                 handle_new_lsr(edge_port, true, byte2, byte3);
1885                 break;
1886         /*
1887          *      case IOSP_EXT_4_STATUS:
1888          *              dev_dbg(dev, "%s - Port %u LSR Status = %02x Data = %02x\n",
1889          *                      __func__, edge_serial->rxPort, byte2, byte3);
1890          *              break;
1891          */
1892         case IOSP_STATUS_MSR:
1893                 dev_dbg(dev, "%s - Port %u MSR Status = %02x\n",
1894                         __func__, edge_serial->rxPort, byte2);
1895                 /*
1896                  * Process this new modem status and generate appropriate
1897                  * events, etc, based on the new status. This routine
1898                  * also saves the MSR in Port->ShadowMsr.
1899                  */
1900                 handle_new_msr(edge_port, byte2);
1901                 break;
1902
1903         default:
1904                 dev_dbg(dev, "%s - Unrecognized IOSP status code %u\n", __func__, code);
1905                 break;
1906         }
1907 }
1908
1909
1910 /*****************************************************************************
1911  * edge_tty_recv
1912  *      this function passes data on to the tty flip buffer
1913  *****************************************************************************/
1914 static void edge_tty_recv(struct usb_serial_port *port, unsigned char *data,
1915                 int length)
1916 {
1917         int cnt;
1918
1919         cnt = tty_insert_flip_string(&port->port, data, length);
1920         if (cnt < length) {
1921                 dev_err(&port->dev, "%s - dropping data, %d bytes lost\n",
1922                                 __func__, length - cnt);
1923         }
1924         data += cnt;
1925         length -= cnt;
1926
1927         tty_flip_buffer_push(&port->port);
1928 }
1929
1930
1931 /*****************************************************************************
1932  * handle_new_msr
1933  *      this function handles any change to the msr register for a port.
1934  *****************************************************************************/
1935 static void handle_new_msr(struct edgeport_port *edge_port, __u8 newMsr)
1936 {
1937         struct  async_icount *icount;
1938
1939         if (newMsr & (EDGEPORT_MSR_DELTA_CTS | EDGEPORT_MSR_DELTA_DSR |
1940                         EDGEPORT_MSR_DELTA_RI | EDGEPORT_MSR_DELTA_CD)) {
1941                 icount = &edge_port->port->icount;
1942
1943                 /* update input line counters */
1944                 if (newMsr & EDGEPORT_MSR_DELTA_CTS)
1945                         icount->cts++;
1946                 if (newMsr & EDGEPORT_MSR_DELTA_DSR)
1947                         icount->dsr++;
1948                 if (newMsr & EDGEPORT_MSR_DELTA_CD)
1949                         icount->dcd++;
1950                 if (newMsr & EDGEPORT_MSR_DELTA_RI)
1951                         icount->rng++;
1952                 wake_up_interruptible(&edge_port->port->port.delta_msr_wait);
1953         }
1954
1955         /* Save the new modem status */
1956         edge_port->shadowMSR = newMsr & 0xf0;
1957 }
1958
1959
1960 /*****************************************************************************
1961  * handle_new_lsr
1962  *      this function handles any change to the lsr register for a port.
1963  *****************************************************************************/
1964 static void handle_new_lsr(struct edgeport_port *edge_port, __u8 lsrData,
1965                                                         __u8 lsr, __u8 data)
1966 {
1967         __u8 newLsr = (__u8) (lsr & (__u8)
1968                 (LSR_OVER_ERR | LSR_PAR_ERR | LSR_FRM_ERR | LSR_BREAK));
1969         struct async_icount *icount;
1970
1971         edge_port->shadowLSR = lsr;
1972
1973         if (newLsr & LSR_BREAK) {
1974                 /*
1975                  * Parity and Framing errors only count if they
1976                  * occur exclusive of a break being
1977                  * received.
1978                  */
1979                 newLsr &= (__u8)(LSR_OVER_ERR | LSR_BREAK);
1980         }
1981
1982         /* Place LSR data byte into Rx buffer */
1983         if (lsrData)
1984                 edge_tty_recv(edge_port->port, &data, 1);
1985
1986         /* update input line counters */
1987         icount = &edge_port->port->icount;
1988         if (newLsr & LSR_BREAK)
1989                 icount->brk++;
1990         if (newLsr & LSR_OVER_ERR)
1991                 icount->overrun++;
1992         if (newLsr & LSR_PAR_ERR)
1993                 icount->parity++;
1994         if (newLsr & LSR_FRM_ERR)
1995                 icount->frame++;
1996 }
1997
1998
1999 /****************************************************************************
2000  * sram_write
2001  *      writes a number of bytes to the Edgeport device's sram starting at the
2002  *      given address.
2003  *      If successful returns the number of bytes written, otherwise it returns
2004  *      a negative error number of the problem.
2005  ****************************************************************************/
2006 static int sram_write(struct usb_serial *serial, __u16 extAddr, __u16 addr,
2007                                         __u16 length, const __u8 *data)
2008 {
2009         int result;
2010         __u16 current_length;
2011         unsigned char *transfer_buffer;
2012
2013         dev_dbg(&serial->dev->dev, "%s - %x, %x, %d\n", __func__, extAddr, addr, length);
2014
2015         transfer_buffer =  kmalloc(64, GFP_KERNEL);
2016         if (!transfer_buffer)
2017                 return -ENOMEM;
2018
2019         /* need to split these writes up into 64 byte chunks */
2020         result = 0;
2021         while (length > 0) {
2022                 if (length > 64)
2023                         current_length = 64;
2024                 else
2025                         current_length = length;
2026
2027 /*              dev_dbg(&serial->dev->dev, "%s - writing %x, %x, %d\n", __func__, extAddr, addr, current_length); */
2028                 memcpy(transfer_buffer, data, current_length);
2029                 result = usb_control_msg(serial->dev,
2030                                         usb_sndctrlpipe(serial->dev, 0),
2031                                         USB_REQUEST_ION_WRITE_RAM,
2032                                         0x40, addr, extAddr, transfer_buffer,
2033                                         current_length, 300);
2034                 if (result < 0)
2035                         break;
2036                 length -= current_length;
2037                 addr += current_length;
2038                 data += current_length;
2039         }
2040
2041         kfree(transfer_buffer);
2042         return result;
2043 }
2044
2045
2046 /****************************************************************************
2047  * rom_write
2048  *      writes a number of bytes to the Edgeport device's ROM starting at the
2049  *      given address.
2050  *      If successful returns the number of bytes written, otherwise it returns
2051  *      a negative error number of the problem.
2052  ****************************************************************************/
2053 static int rom_write(struct usb_serial *serial, __u16 extAddr, __u16 addr,
2054                                         __u16 length, const __u8 *data)
2055 {
2056         int result;
2057         __u16 current_length;
2058         unsigned char *transfer_buffer;
2059
2060         transfer_buffer =  kmalloc(64, GFP_KERNEL);
2061         if (!transfer_buffer)
2062                 return -ENOMEM;
2063
2064         /* need to split these writes up into 64 byte chunks */
2065         result = 0;
2066         while (length > 0) {
2067                 if (length > 64)
2068                         current_length = 64;
2069                 else
2070                         current_length = length;
2071                 memcpy(transfer_buffer, data, current_length);
2072                 result = usb_control_msg(serial->dev,
2073                                         usb_sndctrlpipe(serial->dev, 0),
2074                                         USB_REQUEST_ION_WRITE_ROM, 0x40,
2075                                         addr, extAddr,
2076                                         transfer_buffer, current_length, 300);
2077                 if (result < 0)
2078                         break;
2079                 length -= current_length;
2080                 addr += current_length;
2081                 data += current_length;
2082         }
2083
2084         kfree(transfer_buffer);
2085         return result;
2086 }
2087
2088
2089 /****************************************************************************
2090  * rom_read
2091  *      reads a number of bytes from the Edgeport device starting at the given
2092  *      address.
2093  *      If successful returns the number of bytes read, otherwise it returns
2094  *      a negative error number of the problem.
2095  ****************************************************************************/
2096 static int rom_read(struct usb_serial *serial, __u16 extAddr,
2097                                         __u16 addr, __u16 length, __u8 *data)
2098 {
2099         int result;
2100         __u16 current_length;
2101         unsigned char *transfer_buffer;
2102
2103         transfer_buffer =  kmalloc(64, GFP_KERNEL);
2104         if (!transfer_buffer)
2105                 return -ENOMEM;
2106
2107         /* need to split these reads up into 64 byte chunks */
2108         result = 0;
2109         while (length > 0) {
2110                 if (length > 64)
2111                         current_length = 64;
2112                 else
2113                         current_length = length;
2114                 result = usb_control_msg(serial->dev,
2115                                         usb_rcvctrlpipe(serial->dev, 0),
2116                                         USB_REQUEST_ION_READ_ROM,
2117                                         0xC0, addr, extAddr, transfer_buffer,
2118                                         current_length, 300);
2119                 if (result < 0)
2120                         break;
2121                 memcpy(data, transfer_buffer, current_length);
2122                 length -= current_length;
2123                 addr += current_length;
2124                 data += current_length;
2125         }
2126
2127         kfree(transfer_buffer);
2128         return result;
2129 }
2130
2131
2132 /****************************************************************************
2133  * send_iosp_ext_cmd
2134  *      Is used to send a IOSP message to the Edgeport device
2135  ****************************************************************************/
2136 static int send_iosp_ext_cmd(struct edgeport_port *edge_port,
2137                                                 __u8 command, __u8 param)
2138 {
2139         unsigned char   *buffer;
2140         unsigned char   *currentCommand;
2141         int             length = 0;
2142         int             status = 0;
2143
2144         buffer = kmalloc(10, GFP_ATOMIC);
2145         if (!buffer)
2146                 return -ENOMEM;
2147
2148         currentCommand = buffer;
2149
2150         MAKE_CMD_EXT_CMD(&currentCommand, &length, edge_port->port->port_number,
2151                          command, param);
2152
2153         status = write_cmd_usb(edge_port, buffer, length);
2154         if (status) {
2155                 /* something bad happened, let's free up the memory */
2156                 kfree(buffer);
2157         }
2158
2159         return status;
2160 }
2161
2162
2163 /*****************************************************************************
2164  * write_cmd_usb
2165  *      this function writes the given buffer out to the bulk write endpoint.
2166  *****************************************************************************/
2167 static int write_cmd_usb(struct edgeport_port *edge_port,
2168                                         unsigned char *buffer, int length)
2169 {
2170         struct edgeport_serial *edge_serial =
2171                                 usb_get_serial_data(edge_port->port->serial);
2172         struct device *dev = &edge_port->port->dev;
2173         int status = 0;
2174         struct urb *urb;
2175
2176         usb_serial_debug_data(dev, __func__, length, buffer);
2177
2178         /* Allocate our next urb */
2179         urb = usb_alloc_urb(0, GFP_ATOMIC);
2180         if (!urb)
2181                 return -ENOMEM;
2182
2183         atomic_inc(&CmdUrbs);
2184         dev_dbg(dev, "%s - ALLOCATE URB %p (outstanding %d)\n",
2185                 __func__, urb, atomic_read(&CmdUrbs));
2186
2187         usb_fill_bulk_urb(urb, edge_serial->serial->dev,
2188                         usb_sndbulkpipe(edge_serial->serial->dev,
2189                                         edge_serial->bulk_out_endpoint),
2190                         buffer, length, edge_bulk_out_cmd_callback, edge_port);
2191
2192         edge_port->commandPending = true;
2193         status = usb_submit_urb(urb, GFP_ATOMIC);
2194
2195         if (status) {
2196                 /* something went wrong */
2197                 dev_err(dev, "%s - usb_submit_urb(write command) failed, status = %d\n",
2198                         __func__, status);
2199                 usb_kill_urb(urb);
2200                 usb_free_urb(urb);
2201                 atomic_dec(&CmdUrbs);
2202                 return status;
2203         }
2204
2205 #if 0
2206         wait_event(&edge_port->wait_command, !edge_port->commandPending);
2207
2208         if (edge_port->commandPending) {
2209                 /* command timed out */
2210                 dev_dbg(dev, "%s - command timed out\n", __func__);
2211                 status = -EINVAL;
2212         }
2213 #endif
2214         return status;
2215 }
2216
2217
2218 /*****************************************************************************
2219  * send_cmd_write_baud_rate
2220  *      this function sends the proper command to change the baud rate of the
2221  *      specified port.
2222  *****************************************************************************/
2223 static int send_cmd_write_baud_rate(struct edgeport_port *edge_port,
2224                                                                 int baudRate)
2225 {
2226         struct edgeport_serial *edge_serial =
2227                                 usb_get_serial_data(edge_port->port->serial);
2228         struct device *dev = &edge_port->port->dev;
2229         unsigned char *cmdBuffer;
2230         unsigned char *currCmd;
2231         int cmdLen = 0;
2232         int divisor;
2233         int status;
2234         u32 number = edge_port->port->port_number;
2235
2236         if (edge_serial->is_epic &&
2237             !edge_serial->epic_descriptor.Supports.IOSPSetBaudRate) {
2238                 dev_dbg(dev, "SendCmdWriteBaudRate - NOT Setting baud rate for port, baud = %d\n",
2239                         baudRate);
2240                 return 0;
2241         }
2242
2243         dev_dbg(dev, "%s - baud = %d\n", __func__, baudRate);
2244
2245         status = calc_baud_rate_divisor(dev, baudRate, &divisor);
2246         if (status) {
2247                 dev_err(dev, "%s - bad baud rate\n", __func__);
2248                 return status;
2249         }
2250
2251         /* Alloc memory for the string of commands. */
2252         cmdBuffer =  kmalloc(0x100, GFP_ATOMIC);
2253         if (!cmdBuffer)
2254                 return -ENOMEM;
2255
2256         currCmd = cmdBuffer;
2257
2258         /* Enable access to divisor latch */
2259         MAKE_CMD_WRITE_REG(&currCmd, &cmdLen, number, LCR, LCR_DL_ENABLE);
2260
2261         /* Write the divisor itself */
2262         MAKE_CMD_WRITE_REG(&currCmd, &cmdLen, number, DLL, LOW8(divisor));
2263         MAKE_CMD_WRITE_REG(&currCmd, &cmdLen, number, DLM, HIGH8(divisor));
2264
2265         /* Restore original value to disable access to divisor latch */
2266         MAKE_CMD_WRITE_REG(&currCmd, &cmdLen, number, LCR,
2267                                                 edge_port->shadowLCR);
2268
2269         status = write_cmd_usb(edge_port, cmdBuffer, cmdLen);
2270         if (status) {
2271                 /* something bad happened, let's free up the memory */
2272                 kfree(cmdBuffer);
2273         }
2274
2275         return status;
2276 }
2277
2278
2279 /*****************************************************************************
2280  * calc_baud_rate_divisor
2281  *      this function calculates the proper baud rate divisor for the specified
2282  *      baud rate.
2283  *****************************************************************************/
2284 static int calc_baud_rate_divisor(struct device *dev, int baudrate, int *divisor)
2285 {
2286         int i;
2287         __u16 custom;
2288
2289         for (i = 0; i < ARRAY_SIZE(divisor_table); i++) {
2290                 if (divisor_table[i].BaudRate == baudrate) {
2291                         *divisor = divisor_table[i].Divisor;
2292                         return 0;
2293                 }
2294         }
2295
2296         /* We have tried all of the standard baud rates
2297          * lets try to calculate the divisor for this baud rate
2298          * Make sure the baud rate is reasonable */
2299         if (baudrate > 50 && baudrate < 230400) {
2300                 /* get divisor */
2301                 custom = (__u16)((230400L + baudrate/2) / baudrate);
2302
2303                 *divisor = custom;
2304
2305                 dev_dbg(dev, "%s - Baud %d = %d\n", __func__, baudrate, custom);
2306                 return 0;
2307         }
2308
2309         return -1;
2310 }
2311
2312
2313 /*****************************************************************************
2314  * send_cmd_write_uart_register
2315  *  this function builds up a uart register message and sends to the device.
2316  *****************************************************************************/
2317 static int send_cmd_write_uart_register(struct edgeport_port *edge_port,
2318                                                 __u8 regNum, __u8 regValue)
2319 {
2320         struct edgeport_serial *edge_serial =
2321                                 usb_get_serial_data(edge_port->port->serial);
2322         struct device *dev = &edge_port->port->dev;
2323         unsigned char *cmdBuffer;
2324         unsigned char *currCmd;
2325         unsigned long cmdLen = 0;
2326         int status;
2327
2328         dev_dbg(dev, "%s - write to %s register 0x%02x\n",
2329                 (regNum == MCR) ? "MCR" : "LCR", __func__, regValue);
2330
2331         if (edge_serial->is_epic &&
2332             !edge_serial->epic_descriptor.Supports.IOSPWriteMCR &&
2333             regNum == MCR) {
2334                 dev_dbg(dev, "SendCmdWriteUartReg - Not writing to MCR Register\n");
2335                 return 0;
2336         }
2337
2338         if (edge_serial->is_epic &&
2339             !edge_serial->epic_descriptor.Supports.IOSPWriteLCR &&
2340             regNum == LCR) {
2341                 dev_dbg(dev, "SendCmdWriteUartReg - Not writing to LCR Register\n");
2342                 return 0;
2343         }
2344
2345         /* Alloc memory for the string of commands. */
2346         cmdBuffer = kmalloc(0x10, GFP_ATOMIC);
2347         if (cmdBuffer == NULL)
2348                 return -ENOMEM;
2349
2350         currCmd = cmdBuffer;
2351
2352         /* Build a cmd in the buffer to write the given register */
2353         MAKE_CMD_WRITE_REG(&currCmd, &cmdLen, edge_port->port->port_number,
2354                            regNum, regValue);
2355
2356         status = write_cmd_usb(edge_port, cmdBuffer, cmdLen);
2357         if (status) {
2358                 /* something bad happened, let's free up the memory */
2359                 kfree(cmdBuffer);
2360         }
2361
2362         return status;
2363 }
2364
2365
2366 /*****************************************************************************
2367  * change_port_settings
2368  *      This routine is called to set the UART on the device to match the
2369  *      specified new settings.
2370  *****************************************************************************/
2371
2372 static void change_port_settings(struct tty_struct *tty,
2373         struct edgeport_port *edge_port, struct ktermios *old_termios)
2374 {
2375         struct device *dev = &edge_port->port->dev;
2376         struct edgeport_serial *edge_serial =
2377                         usb_get_serial_data(edge_port->port->serial);
2378         int baud;
2379         unsigned cflag;
2380         __u8 mask = 0xff;
2381         __u8 lData;
2382         __u8 lParity;
2383         __u8 lStop;
2384         __u8 rxFlow;
2385         __u8 txFlow;
2386         int status;
2387
2388         if (!edge_port->open &&
2389             !edge_port->openPending) {
2390                 dev_dbg(dev, "%s - port not opened\n", __func__);
2391                 return;
2392         }
2393
2394         cflag = tty->termios.c_cflag;
2395
2396         switch (cflag & CSIZE) {
2397         case CS5:
2398                 lData = LCR_BITS_5; mask = 0x1f;
2399                 dev_dbg(dev, "%s - data bits = 5\n", __func__);
2400                 break;
2401         case CS6:
2402                 lData = LCR_BITS_6; mask = 0x3f;
2403                 dev_dbg(dev, "%s - data bits = 6\n", __func__);
2404                 break;
2405         case CS7:
2406                 lData = LCR_BITS_7; mask = 0x7f;
2407                 dev_dbg(dev, "%s - data bits = 7\n", __func__);
2408                 break;
2409         default:
2410         case CS8:
2411                 lData = LCR_BITS_8;
2412                 dev_dbg(dev, "%s - data bits = 8\n", __func__);
2413                 break;
2414         }
2415
2416         lParity = LCR_PAR_NONE;
2417         if (cflag & PARENB) {
2418                 if (cflag & CMSPAR) {
2419                         if (cflag & PARODD) {
2420                                 lParity = LCR_PAR_MARK;
2421                                 dev_dbg(dev, "%s - parity = mark\n", __func__);
2422                         } else {
2423                                 lParity = LCR_PAR_SPACE;
2424                                 dev_dbg(dev, "%s - parity = space\n", __func__);
2425                         }
2426                 } else if (cflag & PARODD) {
2427                         lParity = LCR_PAR_ODD;
2428                         dev_dbg(dev, "%s - parity = odd\n", __func__);
2429                 } else {
2430                         lParity = LCR_PAR_EVEN;
2431                         dev_dbg(dev, "%s - parity = even\n", __func__);
2432                 }
2433         } else {
2434                 dev_dbg(dev, "%s - parity = none\n", __func__);
2435         }
2436
2437         if (cflag & CSTOPB) {
2438                 lStop = LCR_STOP_2;
2439                 dev_dbg(dev, "%s - stop bits = 2\n", __func__);
2440         } else {
2441                 lStop = LCR_STOP_1;
2442                 dev_dbg(dev, "%s - stop bits = 1\n", __func__);
2443         }
2444
2445         /* figure out the flow control settings */
2446         rxFlow = txFlow = 0x00;
2447         if (cflag & CRTSCTS) {
2448                 rxFlow |= IOSP_RX_FLOW_RTS;
2449                 txFlow |= IOSP_TX_FLOW_CTS;
2450                 dev_dbg(dev, "%s - RTS/CTS is enabled\n", __func__);
2451         } else {
2452                 dev_dbg(dev, "%s - RTS/CTS is disabled\n", __func__);
2453         }
2454
2455         /* if we are implementing XON/XOFF, set the start and stop character
2456            in the device */
2457         if (I_IXOFF(tty) || I_IXON(tty)) {
2458                 unsigned char stop_char  = STOP_CHAR(tty);
2459                 unsigned char start_char = START_CHAR(tty);
2460
2461                 if (!edge_serial->is_epic ||
2462                     edge_serial->epic_descriptor.Supports.IOSPSetXChar) {
2463                         send_iosp_ext_cmd(edge_port,
2464                                         IOSP_CMD_SET_XON_CHAR, start_char);
2465                         send_iosp_ext_cmd(edge_port,
2466                                         IOSP_CMD_SET_XOFF_CHAR, stop_char);
2467                 }
2468
2469                 /* if we are implementing INBOUND XON/XOFF */
2470                 if (I_IXOFF(tty)) {
2471                         rxFlow |= IOSP_RX_FLOW_XON_XOFF;
2472                         dev_dbg(dev, "%s - INBOUND XON/XOFF is enabled, XON = %2x, XOFF = %2x\n",
2473                                 __func__, start_char, stop_char);
2474                 } else {
2475                         dev_dbg(dev, "%s - INBOUND XON/XOFF is disabled\n", __func__);
2476                 }
2477
2478                 /* if we are implementing OUTBOUND XON/XOFF */
2479                 if (I_IXON(tty)) {
2480                         txFlow |= IOSP_TX_FLOW_XON_XOFF;
2481                         dev_dbg(dev, "%s - OUTBOUND XON/XOFF is enabled, XON = %2x, XOFF = %2x\n",
2482                                 __func__, start_char, stop_char);
2483                 } else {
2484                         dev_dbg(dev, "%s - OUTBOUND XON/XOFF is disabled\n", __func__);
2485                 }
2486         }
2487
2488         /* Set flow control to the configured value */
2489         if (!edge_serial->is_epic ||
2490             edge_serial->epic_descriptor.Supports.IOSPSetRxFlow)
2491                 send_iosp_ext_cmd(edge_port, IOSP_CMD_SET_RX_FLOW, rxFlow);
2492         if (!edge_serial->is_epic ||
2493             edge_serial->epic_descriptor.Supports.IOSPSetTxFlow)
2494                 send_iosp_ext_cmd(edge_port, IOSP_CMD_SET_TX_FLOW, txFlow);
2495
2496
2497         edge_port->shadowLCR &= ~(LCR_BITS_MASK | LCR_STOP_MASK | LCR_PAR_MASK);
2498         edge_port->shadowLCR |= (lData | lParity | lStop);
2499
2500         edge_port->validDataMask = mask;
2501
2502         /* Send the updated LCR value to the EdgePort */
2503         status = send_cmd_write_uart_register(edge_port, LCR,
2504                                                         edge_port->shadowLCR);
2505         if (status != 0)
2506                 return;
2507
2508         /* set up the MCR register and send it to the EdgePort */
2509         edge_port->shadowMCR = MCR_MASTER_IE;
2510         if (cflag & CBAUD)
2511                 edge_port->shadowMCR |= (MCR_DTR | MCR_RTS);
2512
2513         status = send_cmd_write_uart_register(edge_port, MCR,
2514                                                 edge_port->shadowMCR);
2515         if (status != 0)
2516                 return;
2517
2518         /* Determine divisor based on baud rate */
2519         baud = tty_get_baud_rate(tty);
2520         if (!baud) {
2521                 /* pick a default, any default... */
2522                 baud = 9600;
2523         }
2524
2525         dev_dbg(dev, "%s - baud rate = %d\n", __func__, baud);
2526         status = send_cmd_write_baud_rate(edge_port, baud);
2527         if (status == -1) {
2528                 /* Speed change was not possible - put back the old speed */
2529                 baud = tty_termios_baud_rate(old_termios);
2530                 tty_encode_baud_rate(tty, baud, baud);
2531         }
2532 }
2533
2534
2535 /****************************************************************************
2536  * unicode_to_ascii
2537  *      Turns a string from Unicode into ASCII.
2538  *      Doesn't do a good job with any characters that are outside the normal
2539  *      ASCII range, but it's only for debugging...
2540  *      NOTE: expects the unicode in LE format
2541  ****************************************************************************/
2542 static void unicode_to_ascii(char *string, int buflen,
2543                                         __le16 *unicode, int unicode_size)
2544 {
2545         int i;
2546
2547         if (buflen <= 0)        /* never happens, but... */
2548                 return;
2549         --buflen;               /* space for nul */
2550
2551         for (i = 0; i < unicode_size; i++) {
2552                 if (i >= buflen)
2553                         break;
2554                 string[i] = (char)(le16_to_cpu(unicode[i]));
2555         }
2556         string[i] = 0x00;
2557 }
2558
2559
2560 /****************************************************************************
2561  * get_manufacturing_desc
2562  *      reads in the manufacturing descriptor and stores it into the serial
2563  *      structure.
2564  ****************************************************************************/
2565 static void get_manufacturing_desc(struct edgeport_serial *edge_serial)
2566 {
2567         struct device *dev = &edge_serial->serial->dev->dev;
2568         int response;
2569
2570         dev_dbg(dev, "getting manufacturer descriptor\n");
2571
2572         response = rom_read(edge_serial->serial,
2573                                 (EDGE_MANUF_DESC_ADDR & 0xffff0000) >> 16,
2574                                 (__u16)(EDGE_MANUF_DESC_ADDR & 0x0000ffff),
2575                                 EDGE_MANUF_DESC_LEN,
2576                                 (__u8 *)(&edge_serial->manuf_descriptor));
2577
2578         if (response < 1)
2579                 dev_err(dev, "error in getting manufacturer descriptor\n");
2580         else {
2581                 char string[30];
2582                 dev_dbg(dev, "**Manufacturer Descriptor\n");
2583                 dev_dbg(dev, "  RomSize:        %dK\n",
2584                         edge_serial->manuf_descriptor.RomSize);
2585                 dev_dbg(dev, "  RamSize:        %dK\n",
2586                         edge_serial->manuf_descriptor.RamSize);
2587                 dev_dbg(dev, "  CpuRev:         %d\n",
2588                         edge_serial->manuf_descriptor.CpuRev);
2589                 dev_dbg(dev, "  BoardRev:       %d\n",
2590                         edge_serial->manuf_descriptor.BoardRev);
2591                 dev_dbg(dev, "  NumPorts:       %d\n",
2592                         edge_serial->manuf_descriptor.NumPorts);
2593                 dev_dbg(dev, "  DescDate:       %d/%d/%d\n",
2594                         edge_serial->manuf_descriptor.DescDate[0],
2595                         edge_serial->manuf_descriptor.DescDate[1],
2596                         edge_serial->manuf_descriptor.DescDate[2]+1900);
2597                 unicode_to_ascii(string, sizeof(string),
2598                         edge_serial->manuf_descriptor.SerialNumber,
2599                         edge_serial->manuf_descriptor.SerNumLength/2);
2600                 dev_dbg(dev, "  SerialNumber: %s\n", string);
2601                 unicode_to_ascii(string, sizeof(string),
2602                         edge_serial->manuf_descriptor.AssemblyNumber,
2603                         edge_serial->manuf_descriptor.AssemblyNumLength/2);
2604                 dev_dbg(dev, "  AssemblyNumber: %s\n", string);
2605                 unicode_to_ascii(string, sizeof(string),
2606                     edge_serial->manuf_descriptor.OemAssyNumber,
2607                     edge_serial->manuf_descriptor.OemAssyNumLength/2);
2608                 dev_dbg(dev, "  OemAssyNumber:  %s\n", string);
2609                 dev_dbg(dev, "  UartType:       %d\n",
2610                         edge_serial->manuf_descriptor.UartType);
2611                 dev_dbg(dev, "  IonPid:         %d\n",
2612                         edge_serial->manuf_descriptor.IonPid);
2613                 dev_dbg(dev, "  IonConfig:      %d\n",
2614                         edge_serial->manuf_descriptor.IonConfig);
2615         }
2616 }
2617
2618
2619 /****************************************************************************
2620  * get_boot_desc
2621  *      reads in the bootloader descriptor and stores it into the serial
2622  *      structure.
2623  ****************************************************************************/
2624 static void get_boot_desc(struct edgeport_serial *edge_serial)
2625 {
2626         struct device *dev = &edge_serial->serial->dev->dev;
2627         int response;
2628
2629         dev_dbg(dev, "getting boot descriptor\n");
2630
2631         response = rom_read(edge_serial->serial,
2632                                 (EDGE_BOOT_DESC_ADDR & 0xffff0000) >> 16,
2633                                 (__u16)(EDGE_BOOT_DESC_ADDR & 0x0000ffff),
2634                                 EDGE_BOOT_DESC_LEN,
2635                                 (__u8 *)(&edge_serial->boot_descriptor));
2636
2637         if (response < 1)
2638                 dev_err(dev, "error in getting boot descriptor\n");
2639         else {
2640                 dev_dbg(dev, "**Boot Descriptor:\n");
2641                 dev_dbg(dev, "  BootCodeLength: %d\n",
2642                         le16_to_cpu(edge_serial->boot_descriptor.BootCodeLength));
2643                 dev_dbg(dev, "  MajorVersion:   %d\n",
2644                         edge_serial->boot_descriptor.MajorVersion);
2645                 dev_dbg(dev, "  MinorVersion:   %d\n",
2646                         edge_serial->boot_descriptor.MinorVersion);
2647                 dev_dbg(dev, "  BuildNumber:    %d\n",
2648                         le16_to_cpu(edge_serial->boot_descriptor.BuildNumber));
2649                 dev_dbg(dev, "  Capabilities:   0x%x\n",
2650                       le16_to_cpu(edge_serial->boot_descriptor.Capabilities));
2651                 dev_dbg(dev, "  UConfig0:       %d\n",
2652                         edge_serial->boot_descriptor.UConfig0);
2653                 dev_dbg(dev, "  UConfig1:       %d\n",
2654                         edge_serial->boot_descriptor.UConfig1);
2655         }
2656 }
2657
2658
2659 /****************************************************************************
2660  * load_application_firmware
2661  *      This is called to load the application firmware to the device
2662  ****************************************************************************/
2663 static void load_application_firmware(struct edgeport_serial *edge_serial)
2664 {
2665         struct device *dev = &edge_serial->serial->dev->dev;
2666         const struct ihex_binrec *rec;
2667         const struct firmware *fw;
2668         const char *fw_name;
2669         const char *fw_info;
2670         int response;
2671         __u32 Operaddr;
2672         __u16 build;
2673
2674         switch (edge_serial->product_info.iDownloadFile) {
2675                 case EDGE_DOWNLOAD_FILE_I930:
2676                         fw_info = "downloading firmware version (930)";
2677                         fw_name = "/*(DEBLOBBED)*/";
2678                         break;
2679
2680                 case EDGE_DOWNLOAD_FILE_80251:
2681                         fw_info = "downloading firmware version (80251)";
2682                         fw_name = "/*(DEBLOBBED)*/";
2683                         break;
2684
2685                 case EDGE_DOWNLOAD_FILE_NONE:
2686                         dev_dbg(dev, "No download file specified, skipping download\n");
2687                         return;
2688
2689                 default:
2690                         return;
2691         }
2692
2693         response = reject_firmware(&fw, fw_name,
2694                                     &edge_serial->serial->dev->dev);
2695         if (response) {
2696                 dev_err(dev, "Failed to load image \"%s\" err %d\n",
2697                        fw_name, response);
2698                 return;
2699         }
2700
2701         rec = (const struct ihex_binrec *)fw->data;
2702         build = (rec->data[2] << 8) | rec->data[3];
2703
2704         dev_dbg(dev, "%s %d.%d.%d\n", fw_info, rec->data[0], rec->data[1], build);
2705
2706         edge_serial->product_info.FirmwareMajorVersion = rec->data[0];
2707         edge_serial->product_info.FirmwareMinorVersion = rec->data[1];
2708         edge_serial->product_info.FirmwareBuildNumber = cpu_to_le16(build);
2709
2710         for (rec = ihex_next_binrec(rec); rec;
2711              rec = ihex_next_binrec(rec)) {
2712                 Operaddr = be32_to_cpu(rec->addr);
2713                 response = sram_write(edge_serial->serial,
2714                                      Operaddr >> 16,
2715                                      Operaddr & 0xFFFF,
2716                                      be16_to_cpu(rec->len),
2717                                      &rec->data[0]);
2718                 if (response < 0) {
2719                         dev_err(&edge_serial->serial->dev->dev,
2720                                 "sram_write failed (%x, %x, %d)\n",
2721                                 Operaddr >> 16, Operaddr & 0xFFFF,
2722                                 be16_to_cpu(rec->len));
2723                         break;
2724                 }
2725         }
2726
2727         dev_dbg(dev, "sending exec_dl_code\n");
2728         response = usb_control_msg (edge_serial->serial->dev,
2729                                     usb_sndctrlpipe(edge_serial->serial->dev, 0),
2730                                     USB_REQUEST_ION_EXEC_DL_CODE,
2731                                     0x40, 0x4000, 0x0001, NULL, 0, 3000);
2732
2733         release_firmware(fw);
2734 }
2735
2736
2737 /****************************************************************************
2738  * edge_startup
2739  ****************************************************************************/
2740 static int edge_startup(struct usb_serial *serial)
2741 {
2742         struct edgeport_serial *edge_serial;
2743         struct usb_device *dev;
2744         struct device *ddev = &serial->dev->dev;
2745         int i;
2746         int response;
2747         bool interrupt_in_found;
2748         bool bulk_in_found;
2749         bool bulk_out_found;
2750         static __u32 descriptor[3] = {  EDGE_COMPATIBILITY_MASK0,
2751                                         EDGE_COMPATIBILITY_MASK1,
2752                                         EDGE_COMPATIBILITY_MASK2 };
2753
2754         if (serial->num_bulk_in < 1 || serial->num_interrupt_in < 1) {
2755                 dev_err(&serial->interface->dev, "missing endpoints\n");
2756                 return -ENODEV;
2757         }
2758
2759         dev = serial->dev;
2760
2761         /* create our private serial structure */
2762         edge_serial = kzalloc(sizeof(struct edgeport_serial), GFP_KERNEL);
2763         if (!edge_serial)
2764                 return -ENOMEM;
2765
2766         spin_lock_init(&edge_serial->es_lock);
2767         edge_serial->serial = serial;
2768         usb_set_serial_data(serial, edge_serial);
2769
2770         /* get the name for the device from the device */
2771         i = usb_string(dev, dev->descriptor.iManufacturer,
2772             &edge_serial->name[0], MAX_NAME_LEN+1);
2773         if (i < 0)
2774                 i = 0;
2775         edge_serial->name[i++] = ' ';
2776         usb_string(dev, dev->descriptor.iProduct,
2777             &edge_serial->name[i], MAX_NAME_LEN+2 - i);
2778
2779         dev_info(&serial->dev->dev, "%s detected\n", edge_serial->name);
2780
2781         /* Read the epic descriptor */
2782         if (get_epic_descriptor(edge_serial) <= 0) {
2783                 /* memcpy descriptor to Supports structures */
2784                 memcpy(&edge_serial->epic_descriptor.Supports, descriptor,
2785                        sizeof(struct edge_compatibility_bits));
2786
2787                 /* get the manufacturing descriptor for this device */
2788                 get_manufacturing_desc(edge_serial);
2789
2790                 /* get the boot descriptor */
2791                 get_boot_desc(edge_serial);
2792
2793                 get_product_info(edge_serial);
2794         }
2795
2796         /* set the number of ports from the manufacturing description */
2797         /* serial->num_ports = serial->product_info.NumPorts; */
2798         if ((!edge_serial->is_epic) &&
2799             (edge_serial->product_info.NumPorts != serial->num_ports)) {
2800                 dev_warn(ddev,
2801                         "Device Reported %d serial ports vs. core thinking we have %d ports, email greg@kroah.com this information.\n",
2802                          edge_serial->product_info.NumPorts,
2803                          serial->num_ports);
2804         }
2805
2806         dev_dbg(ddev, "%s - time 1 %ld\n", __func__, jiffies);
2807
2808         /* If not an EPiC device */
2809         if (!edge_serial->is_epic) {
2810                 /* now load the application firmware into this device */
2811                 load_application_firmware(edge_serial);
2812
2813                 dev_dbg(ddev, "%s - time 2 %ld\n", __func__, jiffies);
2814
2815                 /* Check current Edgeport EEPROM and update if necessary */
2816                 update_edgeport_E2PROM(edge_serial);
2817
2818                 dev_dbg(ddev, "%s - time 3 %ld\n", __func__, jiffies);
2819
2820                 /* set the configuration to use #1 */
2821 /*              dev_dbg(ddev, "set_configuration 1\n"); */
2822 /*              usb_set_configuration (dev, 1); */
2823         }
2824         dev_dbg(ddev, "  FirmwareMajorVersion  %d.%d.%d\n",
2825             edge_serial->product_info.FirmwareMajorVersion,
2826             edge_serial->product_info.FirmwareMinorVersion,
2827             le16_to_cpu(edge_serial->product_info.FirmwareBuildNumber));
2828
2829         /* we set up the pointers to the endpoints in the edge_open function,
2830          * as the structures aren't created yet. */
2831
2832         response = 0;
2833
2834         if (edge_serial->is_epic) {
2835                 /* EPIC thing, set up our interrupt polling now and our read
2836                  * urb, so that the device knows it really is connected. */
2837                 interrupt_in_found = bulk_in_found = bulk_out_found = false;
2838                 for (i = 0; i < serial->interface->altsetting[0]
2839                                                 .desc.bNumEndpoints; ++i) {
2840                         struct usb_endpoint_descriptor *endpoint;
2841                         int buffer_size;
2842
2843                         endpoint = &serial->interface->altsetting[0].
2844                                                         endpoint[i].desc;
2845                         buffer_size = usb_endpoint_maxp(endpoint);
2846                         if (!interrupt_in_found &&
2847                             (usb_endpoint_is_int_in(endpoint))) {
2848                                 /* we found a interrupt in endpoint */
2849                                 dev_dbg(ddev, "found interrupt in\n");
2850
2851                                 /* not set up yet, so do it now */
2852                                 edge_serial->interrupt_read_urb =
2853                                                 usb_alloc_urb(0, GFP_KERNEL);
2854                                 if (!edge_serial->interrupt_read_urb) {
2855                                         response = -ENOMEM;
2856                                         break;
2857                                 }
2858
2859                                 edge_serial->interrupt_in_buffer =
2860                                         kmalloc(buffer_size, GFP_KERNEL);
2861                                 if (!edge_serial->interrupt_in_buffer) {
2862                                         response = -ENOMEM;
2863                                         break;
2864                                 }
2865                                 edge_serial->interrupt_in_endpoint =
2866                                                 endpoint->bEndpointAddress;
2867
2868                                 /* set up our interrupt urb */
2869                                 usb_fill_int_urb(
2870                                         edge_serial->interrupt_read_urb,
2871                                         dev,
2872                                         usb_rcvintpipe(dev,
2873                                                 endpoint->bEndpointAddress),
2874                                         edge_serial->interrupt_in_buffer,
2875                                         buffer_size,
2876                                         edge_interrupt_callback,
2877                                         edge_serial,
2878                                         endpoint->bInterval);
2879
2880                                 interrupt_in_found = true;
2881                         }
2882
2883                         if (!bulk_in_found &&
2884                                 (usb_endpoint_is_bulk_in(endpoint))) {
2885                                 /* we found a bulk in endpoint */
2886                                 dev_dbg(ddev, "found bulk in\n");
2887
2888                                 /* not set up yet, so do it now */
2889                                 edge_serial->read_urb =
2890                                                 usb_alloc_urb(0, GFP_KERNEL);
2891                                 if (!edge_serial->read_urb) {
2892                                         response = -ENOMEM;
2893                                         break;
2894                                 }
2895
2896                                 edge_serial->bulk_in_buffer =
2897                                         kmalloc(buffer_size, GFP_KERNEL);
2898                                 if (!edge_serial->bulk_in_buffer) {
2899                                         response = -ENOMEM;
2900                                         break;
2901                                 }
2902                                 edge_serial->bulk_in_endpoint =
2903                                                 endpoint->bEndpointAddress;
2904
2905                                 /* set up our bulk in urb */
2906                                 usb_fill_bulk_urb(edge_serial->read_urb, dev,
2907                                         usb_rcvbulkpipe(dev,
2908                                                 endpoint->bEndpointAddress),
2909                                         edge_serial->bulk_in_buffer,
2910                                         usb_endpoint_maxp(endpoint),
2911                                         edge_bulk_in_callback,
2912                                         edge_serial);
2913                                 bulk_in_found = true;
2914                         }
2915
2916                         if (!bulk_out_found &&
2917                             (usb_endpoint_is_bulk_out(endpoint))) {
2918                                 /* we found a bulk out endpoint */
2919                                 dev_dbg(ddev, "found bulk out\n");
2920                                 edge_serial->bulk_out_endpoint =
2921                                                 endpoint->bEndpointAddress;
2922                                 bulk_out_found = true;
2923                         }
2924                 }
2925
2926                 if (response || !interrupt_in_found || !bulk_in_found ||
2927                                                         !bulk_out_found) {
2928                         if (!response) {
2929                                 dev_err(ddev, "expected endpoints not found\n");
2930                                 response = -ENODEV;
2931                         }
2932
2933                         usb_free_urb(edge_serial->interrupt_read_urb);
2934                         kfree(edge_serial->interrupt_in_buffer);
2935
2936                         usb_free_urb(edge_serial->read_urb);
2937                         kfree(edge_serial->bulk_in_buffer);
2938
2939                         kfree(edge_serial);
2940
2941                         return response;
2942                 }
2943
2944                 /* start interrupt read for this edgeport this interrupt will
2945                  * continue as long as the edgeport is connected */
2946                 response = usb_submit_urb(edge_serial->interrupt_read_urb,
2947                                                                 GFP_KERNEL);
2948                 if (response)
2949                         dev_err(ddev, "%s - Error %d submitting control urb\n",
2950                                 __func__, response);
2951         }
2952         return response;
2953 }
2954
2955
2956 /****************************************************************************
2957  * edge_disconnect
2958  *      This function is called whenever the device is removed from the usb bus.
2959  ****************************************************************************/
2960 static void edge_disconnect(struct usb_serial *serial)
2961 {
2962         struct edgeport_serial *edge_serial = usb_get_serial_data(serial);
2963
2964         if (edge_serial->is_epic) {
2965                 usb_kill_urb(edge_serial->interrupt_read_urb);
2966                 usb_kill_urb(edge_serial->read_urb);
2967         }
2968 }
2969
2970
2971 /****************************************************************************
2972  * edge_release
2973  *      This function is called when the device structure is deallocated.
2974  ****************************************************************************/
2975 static void edge_release(struct usb_serial *serial)
2976 {
2977         struct edgeport_serial *edge_serial = usb_get_serial_data(serial);
2978
2979         if (edge_serial->is_epic) {
2980                 usb_kill_urb(edge_serial->interrupt_read_urb);
2981                 usb_free_urb(edge_serial->interrupt_read_urb);
2982                 kfree(edge_serial->interrupt_in_buffer);
2983
2984                 usb_kill_urb(edge_serial->read_urb);
2985                 usb_free_urb(edge_serial->read_urb);
2986                 kfree(edge_serial->bulk_in_buffer);
2987         }
2988
2989         kfree(edge_serial);
2990 }
2991
2992 static int edge_port_probe(struct usb_serial_port *port)
2993 {
2994         struct edgeport_port *edge_port;
2995
2996         edge_port = kzalloc(sizeof(*edge_port), GFP_KERNEL);
2997         if (!edge_port)
2998                 return -ENOMEM;
2999
3000         spin_lock_init(&edge_port->ep_lock);
3001         edge_port->port = port;
3002
3003         usb_set_serial_port_data(port, edge_port);
3004
3005         return 0;
3006 }
3007
3008 static int edge_port_remove(struct usb_serial_port *port)
3009 {
3010         struct edgeport_port *edge_port;
3011
3012         edge_port = usb_get_serial_port_data(port);
3013         kfree(edge_port);
3014
3015         return 0;
3016 }
3017
3018 module_usb_serial_driver(serial_drivers, id_table_combined);
3019
3020 MODULE_AUTHOR(DRIVER_AUTHOR);
3021 MODULE_DESCRIPTION(DRIVER_DESC);
3022 MODULE_LICENSE("GPL");
3023 /*(DEBLOBBED)*/