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