Staging: strip: delete the driver
[linux/fpc-iii.git] / drivers / usb / serial / io_edgeport.c
blob3ef8df0ef888e9d99849953d275dfe81a6f6b47b
1 /*
2 * Edgeport USB Serial Converter driver
4 * Copyright (C) 2000 Inside Out Networks, All rights reserved.
5 * Copyright (C) 2001-2002 Greg Kroah-Hartman <greg@kroah.com>
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.
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
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>.
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 */
55 * Version Information
57 #define DRIVER_VERSION "v2.7"
58 #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com> and David Iacovelli"
59 #define DRIVER_DESC "Edgeport USB Serial Driver"
61 #define MAX_NAME_LEN 64
63 #define CHASE_TIMEOUT (5*HZ) /* 5 seconds */
64 #define OPEN_TIMEOUT (5*HZ) /* 5 seconds */
65 #define COMMAND_TIMEOUT (5*HZ) /* 5 seconds */
67 /* receive port state */
68 enum RXSTATE {
69 EXPECT_HDR1 = 0, /* Expect header byte 1 */
70 EXPECT_HDR2 = 1, /* Expect header byte 2 */
71 EXPECT_DATA = 2, /* Expect 'RxBytesRemaining' data */
72 EXPECT_HDR3 = 3, /* Expect header byte 3 (for status hdrs only) */
76 /* Transmit Fifo
77 * This Transmit queue is an extension of the edgeport Rx buffer.
78 * The maximum amount of data buffered in both the edgeport
79 * Rx buffer (maxTxCredits) and this buffer will never exceed maxTxCredits.
81 struct TxFifo {
82 unsigned int head; /* index to head pointer (write) */
83 unsigned int tail; /* index to tail pointer (read) */
84 unsigned int count; /* Bytes in queue */
85 unsigned int size; /* Max size of queue (equal to Max number of TxCredits) */
86 unsigned char *fifo; /* allocated Buffer */
89 /* This structure holds all of the local port information */
90 struct edgeport_port {
91 __u16 txCredits; /* our current credits for this port */
92 __u16 maxTxCredits; /* the max size of the port */
94 struct TxFifo txfifo; /* transmit fifo -- size will be maxTxCredits */
95 struct urb *write_urb; /* write URB for this port */
96 bool write_in_progress; /* 'true' while a write URB is outstanding */
97 spinlock_t ep_lock;
99 __u8 shadowLCR; /* last LCR value received */
100 __u8 shadowMCR; /* last MCR value received */
101 __u8 shadowMSR; /* last MSR value received */
102 __u8 shadowLSR; /* last LSR value received */
103 __u8 shadowXonChar; /* last value set as XON char in Edgeport */
104 __u8 shadowXoffChar; /* last value set as XOFF char in Edgeport */
105 __u8 validDataMask;
106 __u32 baudRate;
108 bool open;
109 bool openPending;
110 bool commandPending;
111 bool closePending;
112 bool chaseResponsePending;
114 wait_queue_head_t wait_chase; /* for handling sleeping while waiting for chase to finish */
115 wait_queue_head_t wait_open; /* for handling sleeping while waiting for open to finish */
116 wait_queue_head_t wait_command; /* for handling sleeping while waiting for command to finish */
117 wait_queue_head_t delta_msr_wait; /* for handling sleeping while waiting for msr change to happen */
119 struct async_icount icount;
120 struct usb_serial_port *port; /* loop back to the owner of this object */
124 /* This structure holds all of the individual device information */
125 struct edgeport_serial {
126 char name[MAX_NAME_LEN+2]; /* string name of this device */
128 struct edge_manuf_descriptor manuf_descriptor; /* the manufacturer descriptor */
129 struct edge_boot_descriptor boot_descriptor; /* the boot firmware descriptor */
130 struct edgeport_product_info product_info; /* Product Info */
131 struct edge_compatibility_descriptor epic_descriptor; /* Edgeport compatible descriptor */
132 int is_epic; /* flag if EPiC device or not */
134 __u8 interrupt_in_endpoint; /* the interrupt endpoint handle */
135 unsigned char *interrupt_in_buffer; /* the buffer we use for the interrupt endpoint */
136 struct urb *interrupt_read_urb; /* our interrupt urb */
138 __u8 bulk_in_endpoint; /* the bulk in endpoint handle */
139 unsigned char *bulk_in_buffer; /* the buffer we use for the bulk in endpoint */
140 struct urb *read_urb; /* our bulk read urb */
141 bool read_in_progress;
142 spinlock_t es_lock;
144 __u8 bulk_out_endpoint; /* the bulk out endpoint handle */
146 __s16 rxBytesAvail; /* the number of bytes that we need to read from this device */
148 enum RXSTATE rxState; /* the current state of the bulk receive processor */
149 __u8 rxHeader1; /* receive header byte 1 */
150 __u8 rxHeader2; /* receive header byte 2 */
151 __u8 rxHeader3; /* receive header byte 3 */
152 __u8 rxPort; /* the port that we are currently receiving data for */
153 __u8 rxStatusCode; /* the receive status code */
154 __u8 rxStatusParam; /* the receive status paramater */
155 __s16 rxBytesRemaining; /* the number of port bytes left to read */
156 struct usb_serial *serial; /* loop back to the owner of this object */
159 /* baud rate information */
160 struct divisor_table_entry {
161 __u32 BaudRate;
162 __u16 Divisor;
166 * Define table of divisors for Rev A EdgePort/4 hardware
167 * These assume a 3.6864MHz crystal, the standard /16, and
168 * MCR.7 = 0.
171 static const struct divisor_table_entry divisor_table[] = {
172 { 50, 4608},
173 { 75, 3072},
174 { 110, 2095}, /* 2094.545455 => 230450 => .0217 % over */
175 { 134, 1713}, /* 1713.011152 => 230398.5 => .00065% under */
176 { 150, 1536},
177 { 300, 768},
178 { 600, 384},
179 { 1200, 192},
180 { 1800, 128},
181 { 2400, 96},
182 { 4800, 48},
183 { 7200, 32},
184 { 9600, 24},
185 { 14400, 16},
186 { 19200, 12},
187 { 38400, 6},
188 { 57600, 4},
189 { 115200, 2},
190 { 230400, 1},
193 /* local variables */
194 static int debug;
196 static atomic_t CmdUrbs; /* Number of outstanding Command Write Urbs */
199 /* local function prototypes */
201 /* function prototypes for all URB callbacks */
202 static void edge_interrupt_callback(struct urb *urb);
203 static void edge_bulk_in_callback(struct urb *urb);
204 static void edge_bulk_out_data_callback(struct urb *urb);
205 static void edge_bulk_out_cmd_callback(struct urb *urb);
207 /* function prototypes for the usbserial callbacks */
208 static int edge_open(struct tty_struct *tty, struct usb_serial_port *port);
209 static void edge_close(struct usb_serial_port *port);
210 static int edge_write(struct tty_struct *tty, struct usb_serial_port *port,
211 const unsigned char *buf, int count);
212 static int edge_write_room(struct tty_struct *tty);
213 static int edge_chars_in_buffer(struct tty_struct *tty);
214 static void edge_throttle(struct tty_struct *tty);
215 static void edge_unthrottle(struct tty_struct *tty);
216 static void edge_set_termios(struct tty_struct *tty,
217 struct usb_serial_port *port,
218 struct ktermios *old_termios);
219 static int edge_ioctl(struct tty_struct *tty, struct file *file,
220 unsigned int cmd, unsigned long arg);
221 static void edge_break(struct tty_struct *tty, int break_state);
222 static int edge_tiocmget(struct tty_struct *tty, struct file *file);
223 static int edge_tiocmset(struct tty_struct *tty, struct file *file,
224 unsigned int set, unsigned int clear);
225 static int edge_startup(struct usb_serial *serial);
226 static void edge_disconnect(struct usb_serial *serial);
227 static void edge_release(struct usb_serial *serial);
229 #include "io_tables.h" /* all of the devices that this driver supports */
231 /* function prototypes for all of our local functions */
233 static void process_rcvd_data(struct edgeport_serial *edge_serial,
234 unsigned char *buffer, __u16 bufferLength);
235 static void process_rcvd_status(struct edgeport_serial *edge_serial,
236 __u8 byte2, __u8 byte3);
237 static void edge_tty_recv(struct device *dev, struct tty_struct *tty,
238 unsigned char *data, int length);
239 static void handle_new_msr(struct edgeport_port *edge_port, __u8 newMsr);
240 static void handle_new_lsr(struct edgeport_port *edge_port, __u8 lsrData,
241 __u8 lsr, __u8 data);
242 static int send_iosp_ext_cmd(struct edgeport_port *edge_port, __u8 command,
243 __u8 param);
244 static int calc_baud_rate_divisor(int baud_rate, int *divisor);
245 static int send_cmd_write_baud_rate(struct edgeport_port *edge_port,
246 int baudRate);
247 static void change_port_settings(struct tty_struct *tty,
248 struct edgeport_port *edge_port,
249 struct ktermios *old_termios);
250 static int send_cmd_write_uart_register(struct edgeport_port *edge_port,
251 __u8 regNum, __u8 regValue);
252 static int write_cmd_usb(struct edgeport_port *edge_port,
253 unsigned char *buffer, int writeLength);
254 static void send_more_port_data(struct edgeport_serial *edge_serial,
255 struct edgeport_port *edge_port);
257 static int sram_write(struct usb_serial *serial, __u16 extAddr, __u16 addr,
258 __u16 length, const __u8 *data);
259 static int rom_read(struct usb_serial *serial, __u16 extAddr, __u16 addr,
260 __u16 length, __u8 *data);
261 static int rom_write(struct usb_serial *serial, __u16 extAddr, __u16 addr,
262 __u16 length, const __u8 *data);
263 static void get_manufacturing_desc(struct edgeport_serial *edge_serial);
264 static void get_boot_desc(struct edgeport_serial *edge_serial);
265 static void load_application_firmware(struct edgeport_serial *edge_serial);
267 static void unicode_to_ascii(char *string, int buflen,
268 __le16 *unicode, int unicode_size);
271 /* ************************************************************************ */
272 /* ************************************************************************ */
273 /* ************************************************************************ */
274 /* ************************************************************************ */
276 /************************************************************************
278 * update_edgeport_E2PROM() Compare current versions of *
279 * Boot ROM and Manufacture *
280 * Descriptors with versions *
281 * embedded in this driver *
283 ************************************************************************/
284 static void update_edgeport_E2PROM(struct edgeport_serial *edge_serial)
286 __u32 BootCurVer;
287 __u32 BootNewVer;
288 __u8 BootMajorVersion;
289 __u8 BootMinorVersion;
290 __u16 BootBuildNumber;
291 __u32 Bootaddr;
292 const struct ihex_binrec *rec;
293 const struct firmware *fw;
294 const char *fw_name;
295 int response;
297 switch (edge_serial->product_info.iDownloadFile) {
298 case EDGE_DOWNLOAD_FILE_I930:
299 fw_name = "edgeport/boot.fw";
300 break;
301 case EDGE_DOWNLOAD_FILE_80251:
302 fw_name = "edgeport/boot2.fw";
303 break;
304 default:
305 return;
308 response = request_ihex_firmware(&fw, fw_name,
309 &edge_serial->serial->dev->dev);
310 if (response) {
311 printk(KERN_ERR "Failed to load image \"%s\" err %d\n",
312 fw_name, response);
313 return;
316 rec = (const struct ihex_binrec *)fw->data;
317 BootMajorVersion = rec->data[0];
318 BootMinorVersion = rec->data[1];
319 BootBuildNumber = (rec->data[2] << 8) | rec->data[3];
321 /* Check Boot Image Version */
322 BootCurVer = (edge_serial->boot_descriptor.MajorVersion << 24) +
323 (edge_serial->boot_descriptor.MinorVersion << 16) +
324 le16_to_cpu(edge_serial->boot_descriptor.BuildNumber);
326 BootNewVer = (BootMajorVersion << 24) +
327 (BootMinorVersion << 16) +
328 BootBuildNumber;
330 dbg("Current Boot Image version %d.%d.%d",
331 edge_serial->boot_descriptor.MajorVersion,
332 edge_serial->boot_descriptor.MinorVersion,
333 le16_to_cpu(edge_serial->boot_descriptor.BuildNumber));
336 if (BootNewVer > BootCurVer) {
337 dbg("**Update Boot Image from %d.%d.%d to %d.%d.%d",
338 edge_serial->boot_descriptor.MajorVersion,
339 edge_serial->boot_descriptor.MinorVersion,
340 le16_to_cpu(edge_serial->boot_descriptor.BuildNumber),
341 BootMajorVersion, BootMinorVersion, BootBuildNumber);
343 dbg("Downloading new Boot Image");
345 for (rec = ihex_next_binrec(rec); rec;
346 rec = ihex_next_binrec(rec)) {
347 Bootaddr = be32_to_cpu(rec->addr);
348 response = rom_write(edge_serial->serial,
349 Bootaddr >> 16,
350 Bootaddr & 0xFFFF,
351 be16_to_cpu(rec->len),
352 &rec->data[0]);
353 if (response < 0) {
354 dev_err(&edge_serial->serial->dev->dev,
355 "rom_write failed (%x, %x, %d)\n",
356 Bootaddr >> 16, Bootaddr & 0xFFFF,
357 be16_to_cpu(rec->len));
358 break;
361 } else {
362 dbg("Boot Image -- already up to date");
364 release_firmware(fw);
367 #if 0
368 /************************************************************************
370 * Get string descriptor from device
372 ************************************************************************/
373 static int get_string_desc(struct usb_device *dev, int Id,
374 struct usb_string_descriptor **pRetDesc)
376 struct usb_string_descriptor StringDesc;
377 struct usb_string_descriptor *pStringDesc;
379 dbg("%s - USB String ID = %d", __func__, Id);
381 if (!usb_get_descriptor(dev, USB_DT_STRING, Id, &StringDesc,
382 sizeof(StringDesc)))
383 return 0;
385 pStringDesc = kmalloc(StringDesc.bLength, GFP_KERNEL);
386 if (!pStringDesc)
387 return -1;
389 if (!usb_get_descriptor(dev, USB_DT_STRING, Id, pStringDesc,
390 StringDesc.bLength)) {
391 kfree(pStringDesc);
392 return -1;
395 *pRetDesc = pStringDesc;
396 return 0;
398 #endif
400 static void dump_product_info(struct edgeport_product_info *product_info)
402 /* Dump Product Info structure */
403 dbg("**Product Information:");
404 dbg(" ProductId %x", product_info->ProductId);
405 dbg(" NumPorts %d", product_info->NumPorts);
406 dbg(" ProdInfoVer %d", product_info->ProdInfoVer);
407 dbg(" IsServer %d", product_info->IsServer);
408 dbg(" IsRS232 %d", product_info->IsRS232);
409 dbg(" IsRS422 %d", product_info->IsRS422);
410 dbg(" IsRS485 %d", product_info->IsRS485);
411 dbg(" RomSize %d", product_info->RomSize);
412 dbg(" RamSize %d", product_info->RamSize);
413 dbg(" CpuRev %x", product_info->CpuRev);
414 dbg(" BoardRev %x", product_info->BoardRev);
415 dbg(" BootMajorVersion %d.%d.%d", product_info->BootMajorVersion,
416 product_info->BootMinorVersion,
417 le16_to_cpu(product_info->BootBuildNumber));
418 dbg(" FirmwareMajorVersion %d.%d.%d",
419 product_info->FirmwareMajorVersion,
420 product_info->FirmwareMinorVersion,
421 le16_to_cpu(product_info->FirmwareBuildNumber));
422 dbg(" ManufactureDescDate %d/%d/%d",
423 product_info->ManufactureDescDate[0],
424 product_info->ManufactureDescDate[1],
425 product_info->ManufactureDescDate[2]+1900);
426 dbg(" iDownloadFile 0x%x", product_info->iDownloadFile);
427 dbg(" EpicVer %d", product_info->EpicVer);
430 static void get_product_info(struct edgeport_serial *edge_serial)
432 struct edgeport_product_info *product_info = &edge_serial->product_info;
434 memset(product_info, 0, sizeof(struct edgeport_product_info));
436 product_info->ProductId = (__u16)(le16_to_cpu(edge_serial->serial->dev->descriptor.idProduct) & ~ION_DEVICE_ID_80251_NETCHIP);
437 product_info->NumPorts = edge_serial->manuf_descriptor.NumPorts;
438 product_info->ProdInfoVer = 0;
440 product_info->RomSize = edge_serial->manuf_descriptor.RomSize;
441 product_info->RamSize = edge_serial->manuf_descriptor.RamSize;
442 product_info->CpuRev = edge_serial->manuf_descriptor.CpuRev;
443 product_info->BoardRev = edge_serial->manuf_descriptor.BoardRev;
445 product_info->BootMajorVersion =
446 edge_serial->boot_descriptor.MajorVersion;
447 product_info->BootMinorVersion =
448 edge_serial->boot_descriptor.MinorVersion;
449 product_info->BootBuildNumber =
450 edge_serial->boot_descriptor.BuildNumber;
452 memcpy(product_info->ManufactureDescDate,
453 edge_serial->manuf_descriptor.DescDate,
454 sizeof(edge_serial->manuf_descriptor.DescDate));
456 /* check if this is 2nd generation hardware */
457 if (le16_to_cpu(edge_serial->serial->dev->descriptor.idProduct)
458 & ION_DEVICE_ID_80251_NETCHIP)
459 product_info->iDownloadFile = EDGE_DOWNLOAD_FILE_80251;
460 else
461 product_info->iDownloadFile = EDGE_DOWNLOAD_FILE_I930;
463 /* Determine Product type and set appropriate flags */
464 switch (DEVICE_ID_FROM_USB_PRODUCT_ID(product_info->ProductId)) {
465 case ION_DEVICE_ID_EDGEPORT_COMPATIBLE:
466 case ION_DEVICE_ID_EDGEPORT_4T:
467 case ION_DEVICE_ID_EDGEPORT_4:
468 case ION_DEVICE_ID_EDGEPORT_2:
469 case ION_DEVICE_ID_EDGEPORT_8_DUAL_CPU:
470 case ION_DEVICE_ID_EDGEPORT_8:
471 case ION_DEVICE_ID_EDGEPORT_421:
472 case ION_DEVICE_ID_EDGEPORT_21:
473 case ION_DEVICE_ID_EDGEPORT_2_DIN:
474 case ION_DEVICE_ID_EDGEPORT_4_DIN:
475 case ION_DEVICE_ID_EDGEPORT_16_DUAL_CPU:
476 product_info->IsRS232 = 1;
477 break;
479 case ION_DEVICE_ID_EDGEPORT_2I: /* Edgeport/2 RS422/RS485 */
480 product_info->IsRS422 = 1;
481 product_info->IsRS485 = 1;
482 break;
484 case ION_DEVICE_ID_EDGEPORT_8I: /* Edgeport/4 RS422 */
485 case ION_DEVICE_ID_EDGEPORT_4I: /* Edgeport/4 RS422 */
486 product_info->IsRS422 = 1;
487 break;
490 dump_product_info(product_info);
493 static int get_epic_descriptor(struct edgeport_serial *ep)
495 int result;
496 struct usb_serial *serial = ep->serial;
497 struct edgeport_product_info *product_info = &ep->product_info;
498 struct edge_compatibility_descriptor *epic = &ep->epic_descriptor;
499 struct edge_compatibility_bits *bits;
501 ep->is_epic = 0;
502 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
503 USB_REQUEST_ION_GET_EPIC_DESC,
504 0xC0, 0x00, 0x00,
505 &ep->epic_descriptor,
506 sizeof(struct edge_compatibility_descriptor),
507 300);
509 dbg("%s result = %d", __func__, result);
511 if (result > 0) {
512 ep->is_epic = 1;
513 memset(product_info, 0, sizeof(struct edgeport_product_info));
515 product_info->NumPorts = epic->NumPorts;
516 product_info->ProdInfoVer = 0;
517 product_info->FirmwareMajorVersion = epic->MajorVersion;
518 product_info->FirmwareMinorVersion = epic->MinorVersion;
519 product_info->FirmwareBuildNumber = epic->BuildNumber;
520 product_info->iDownloadFile = epic->iDownloadFile;
521 product_info->EpicVer = epic->EpicVer;
522 product_info->Epic = epic->Supports;
523 product_info->ProductId = ION_DEVICE_ID_EDGEPORT_COMPATIBLE;
524 dump_product_info(product_info);
526 bits = &ep->epic_descriptor.Supports;
527 dbg("**EPIC descriptor:");
528 dbg(" VendEnableSuspend: %s", bits->VendEnableSuspend ? "TRUE": "FALSE");
529 dbg(" IOSPOpen : %s", bits->IOSPOpen ? "TRUE": "FALSE");
530 dbg(" IOSPClose : %s", bits->IOSPClose ? "TRUE": "FALSE");
531 dbg(" IOSPChase : %s", bits->IOSPChase ? "TRUE": "FALSE");
532 dbg(" IOSPSetRxFlow : %s", bits->IOSPSetRxFlow ? "TRUE": "FALSE");
533 dbg(" IOSPSetTxFlow : %s", bits->IOSPSetTxFlow ? "TRUE": "FALSE");
534 dbg(" IOSPSetXChar : %s", bits->IOSPSetXChar ? "TRUE": "FALSE");
535 dbg(" IOSPRxCheck : %s", bits->IOSPRxCheck ? "TRUE": "FALSE");
536 dbg(" IOSPSetClrBreak : %s", bits->IOSPSetClrBreak ? "TRUE": "FALSE");
537 dbg(" IOSPWriteMCR : %s", bits->IOSPWriteMCR ? "TRUE": "FALSE");
538 dbg(" IOSPWriteLCR : %s", bits->IOSPWriteLCR ? "TRUE": "FALSE");
539 dbg(" IOSPSetBaudRate : %s", bits->IOSPSetBaudRate ? "TRUE": "FALSE");
540 dbg(" TrueEdgeport : %s", bits->TrueEdgeport ? "TRUE": "FALSE");
543 return result;
547 /************************************************************************/
548 /************************************************************************/
549 /* U S B C A L L B A C K F U N C T I O N S */
550 /* U S B C A L L B A C K F U N C T I O N S */
551 /************************************************************************/
552 /************************************************************************/
554 /*****************************************************************************
555 * edge_interrupt_callback
556 * this is the callback function for when we have received data on the
557 * interrupt endpoint.
558 *****************************************************************************/
559 static void edge_interrupt_callback(struct urb *urb)
561 struct edgeport_serial *edge_serial = urb->context;
562 struct edgeport_port *edge_port;
563 struct usb_serial_port *port;
564 struct tty_struct *tty;
565 unsigned char *data = urb->transfer_buffer;
566 int length = urb->actual_length;
567 int bytes_avail;
568 int position;
569 int txCredits;
570 int portNumber;
571 int result;
572 int status = urb->status;
574 dbg("%s", __func__);
576 switch (status) {
577 case 0:
578 /* success */
579 break;
580 case -ECONNRESET:
581 case -ENOENT:
582 case -ESHUTDOWN:
583 /* this urb is terminated, clean up */
584 dbg("%s - urb shutting down with status: %d",
585 __func__, status);
586 return;
587 default:
588 dbg("%s - nonzero urb status received: %d", __func__, status);
589 goto exit;
592 /* process this interrupt-read even if there are no ports open */
593 if (length) {
594 usb_serial_debug_data(debug, &edge_serial->serial->dev->dev,
595 __func__, length, data);
597 if (length > 1) {
598 bytes_avail = data[0] | (data[1] << 8);
599 if (bytes_avail) {
600 spin_lock(&edge_serial->es_lock);
601 edge_serial->rxBytesAvail += bytes_avail;
602 dbg("%s - bytes_avail=%d, rxBytesAvail=%d, read_in_progress=%d", __func__, bytes_avail, edge_serial->rxBytesAvail, edge_serial->read_in_progress);
604 if (edge_serial->rxBytesAvail > 0 &&
605 !edge_serial->read_in_progress) {
606 dbg("%s - posting a read", __func__);
607 edge_serial->read_in_progress = true;
609 /* we have pending bytes on the
610 bulk in pipe, send a request */
611 edge_serial->read_urb->dev = edge_serial->serial->dev;
612 result = usb_submit_urb(edge_serial->read_urb, GFP_ATOMIC);
613 if (result) {
614 dev_err(&edge_serial->serial->dev->dev, "%s - usb_submit_urb(read bulk) failed with result = %d\n", __func__, result);
615 edge_serial->read_in_progress = false;
618 spin_unlock(&edge_serial->es_lock);
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 dbg("%s - txcredits for port%d = %d",
635 __func__, portNumber,
636 edge_port->txCredits);
638 /* tell the tty driver that something
639 has changed */
640 tty = tty_port_tty_get(
641 &edge_port->port->port);
642 if (tty) {
643 tty_wakeup(tty);
644 tty_kref_put(tty);
646 /* Since we have more credit, check
647 if more data can be sent */
648 send_more_port_data(edge_serial,
649 edge_port);
652 position += 2;
653 ++portNumber;
657 exit:
658 result = usb_submit_urb(urb, GFP_ATOMIC);
659 if (result)
660 dev_err(&urb->dev->dev,
661 "%s - Error %d submitting control urb\n",
662 __func__, result);
666 /*****************************************************************************
667 * edge_bulk_in_callback
668 * this is the callback function for when we have received data on the
669 * bulk in endpoint.
670 *****************************************************************************/
671 static void edge_bulk_in_callback(struct urb *urb)
673 struct edgeport_serial *edge_serial = urb->context;
674 unsigned char *data = urb->transfer_buffer;
675 int retval;
676 __u16 raw_data_length;
677 int status = urb->status;
679 dbg("%s", __func__);
681 if (status) {
682 dbg("%s - nonzero read bulk status received: %d",
683 __func__, status);
684 edge_serial->read_in_progress = false;
685 return;
688 if (urb->actual_length == 0) {
689 dbg("%s - read bulk callback with no data", __func__);
690 edge_serial->read_in_progress = false;
691 return;
694 raw_data_length = urb->actual_length;
696 usb_serial_debug_data(debug, &edge_serial->serial->dev->dev,
697 __func__, raw_data_length, data);
699 spin_lock(&edge_serial->es_lock);
701 /* decrement our rxBytes available by the number that we just got */
702 edge_serial->rxBytesAvail -= raw_data_length;
704 dbg("%s - Received = %d, rxBytesAvail %d", __func__,
705 raw_data_length, edge_serial->rxBytesAvail);
707 process_rcvd_data(edge_serial, data, urb->actual_length);
709 /* check to see if there's any more data for us to read */
710 if (edge_serial->rxBytesAvail > 0) {
711 dbg("%s - posting a read", __func__);
712 edge_serial->read_urb->dev = edge_serial->serial->dev;
713 retval = usb_submit_urb(edge_serial->read_urb, GFP_ATOMIC);
714 if (retval) {
715 dev_err(&urb->dev->dev,
716 "%s - usb_submit_urb(read bulk) failed, "
717 "retval = %d\n", __func__, retval);
718 edge_serial->read_in_progress = false;
720 } else {
721 edge_serial->read_in_progress = false;
724 spin_unlock(&edge_serial->es_lock);
728 /*****************************************************************************
729 * edge_bulk_out_data_callback
730 * this is the callback function for when we have finished sending
731 * serial data on the bulk out endpoint.
732 *****************************************************************************/
733 static void edge_bulk_out_data_callback(struct urb *urb)
735 struct edgeport_port *edge_port = urb->context;
736 struct tty_struct *tty;
737 int status = urb->status;
739 dbg("%s", __func__);
741 if (status) {
742 dbg("%s - nonzero write bulk status received: %d",
743 __func__, status);
746 tty = tty_port_tty_get(&edge_port->port->port);
748 if (tty && edge_port->open) {
749 /* let the tty driver wakeup if it has a special
750 write_wakeup function */
751 tty_wakeup(tty);
753 tty_kref_put(tty);
755 /* Release the Write URB */
756 edge_port->write_in_progress = false;
758 /* Check if more data needs to be sent */
759 send_more_port_data((struct edgeport_serial *)
760 (usb_get_serial_data(edge_port->port->serial)), edge_port);
764 /*****************************************************************************
765 * BulkOutCmdCallback
766 * this is the callback function for when we have finished sending a
767 * command on the bulk out endpoint.
768 *****************************************************************************/
769 static void edge_bulk_out_cmd_callback(struct urb *urb)
771 struct edgeport_port *edge_port = urb->context;
772 struct tty_struct *tty;
773 int status = urb->status;
775 dbg("%s", __func__);
777 atomic_dec(&CmdUrbs);
778 dbg("%s - FREE URB %p (outstanding %d)", __func__,
779 urb, atomic_read(&CmdUrbs));
782 /* clean up the transfer buffer */
783 kfree(urb->transfer_buffer);
785 /* Free the command urb */
786 usb_free_urb(urb);
788 if (status) {
789 dbg("%s - nonzero write bulk status received: %d",
790 __func__, status);
791 return;
794 /* Get pointer to tty */
795 tty = tty_port_tty_get(&edge_port->port->port);
797 /* tell the tty driver that something has changed */
798 if (tty && edge_port->open)
799 tty_wakeup(tty);
800 tty_kref_put(tty);
802 /* we have completed the command */
803 edge_port->commandPending = false;
804 wake_up(&edge_port->wait_command);
808 /*****************************************************************************
809 * Driver tty interface functions
810 *****************************************************************************/
812 /*****************************************************************************
813 * SerialOpen
814 * this function is called by the tty driver when a port is opened
815 * If successful, we return 0
816 * Otherwise we return a negative error number.
817 *****************************************************************************/
818 static int edge_open(struct tty_struct *tty, struct usb_serial_port *port)
820 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
821 struct usb_serial *serial;
822 struct edgeport_serial *edge_serial;
823 int response;
825 dbg("%s - port %d", __func__, port->number);
827 if (edge_port == NULL)
828 return -ENODEV;
830 /* see if we've set up our endpoint info yet (can't set it up
831 in edge_startup as the structures were not set up at that time.) */
832 serial = port->serial;
833 edge_serial = usb_get_serial_data(serial);
834 if (edge_serial == NULL)
835 return -ENODEV;
836 if (edge_serial->interrupt_in_buffer == NULL) {
837 struct usb_serial_port *port0 = serial->port[0];
839 /* not set up yet, so do it now */
840 edge_serial->interrupt_in_buffer =
841 port0->interrupt_in_buffer;
842 edge_serial->interrupt_in_endpoint =
843 port0->interrupt_in_endpointAddress;
844 edge_serial->interrupt_read_urb = port0->interrupt_in_urb;
845 edge_serial->bulk_in_buffer = port0->bulk_in_buffer;
846 edge_serial->bulk_in_endpoint =
847 port0->bulk_in_endpointAddress;
848 edge_serial->read_urb = port0->read_urb;
849 edge_serial->bulk_out_endpoint =
850 port0->bulk_out_endpointAddress;
852 /* set up our interrupt urb */
853 usb_fill_int_urb(edge_serial->interrupt_read_urb,
854 serial->dev,
855 usb_rcvintpipe(serial->dev,
856 port0->interrupt_in_endpointAddress),
857 port0->interrupt_in_buffer,
858 edge_serial->interrupt_read_urb->transfer_buffer_length,
859 edge_interrupt_callback, edge_serial,
860 edge_serial->interrupt_read_urb->interval);
862 /* set up our bulk in urb */
863 usb_fill_bulk_urb(edge_serial->read_urb, serial->dev,
864 usb_rcvbulkpipe(serial->dev,
865 port0->bulk_in_endpointAddress),
866 port0->bulk_in_buffer,
867 edge_serial->read_urb->transfer_buffer_length,
868 edge_bulk_in_callback, edge_serial);
869 edge_serial->read_in_progress = false;
871 /* start interrupt read for this edgeport
872 * this interrupt will continue as long
873 * as the edgeport is connected */
874 response = usb_submit_urb(edge_serial->interrupt_read_urb,
875 GFP_KERNEL);
876 if (response) {
877 dev_err(&port->dev,
878 "%s - Error %d submitting control urb\n",
879 __func__, response);
883 /* initialize our wait queues */
884 init_waitqueue_head(&edge_port->wait_open);
885 init_waitqueue_head(&edge_port->wait_chase);
886 init_waitqueue_head(&edge_port->delta_msr_wait);
887 init_waitqueue_head(&edge_port->wait_command);
889 /* initialize our icount structure */
890 memset(&(edge_port->icount), 0x00, sizeof(edge_port->icount));
892 /* initialize our port settings */
893 edge_port->txCredits = 0; /* Can't send any data yet */
894 /* Must always set this bit to enable ints! */
895 edge_port->shadowMCR = MCR_MASTER_IE;
896 edge_port->chaseResponsePending = false;
898 /* send a open port command */
899 edge_port->openPending = true;
900 edge_port->open = false;
901 response = send_iosp_ext_cmd(edge_port, IOSP_CMD_OPEN_PORT, 0);
903 if (response < 0) {
904 dev_err(&port->dev, "%s - error sending open port command\n",
905 __func__);
906 edge_port->openPending = false;
907 return -ENODEV;
910 /* now wait for the port to be completely opened */
911 wait_event_timeout(edge_port->wait_open, !edge_port->openPending,
912 OPEN_TIMEOUT);
914 if (!edge_port->open) {
915 /* open timed out */
916 dbg("%s - open timedout", __func__);
917 edge_port->openPending = false;
918 return -ENODEV;
921 /* create the txfifo */
922 edge_port->txfifo.head = 0;
923 edge_port->txfifo.tail = 0;
924 edge_port->txfifo.count = 0;
925 edge_port->txfifo.size = edge_port->maxTxCredits;
926 edge_port->txfifo.fifo = kmalloc(edge_port->maxTxCredits, GFP_KERNEL);
928 if (!edge_port->txfifo.fifo) {
929 dbg("%s - no memory", __func__);
930 edge_close(port);
931 return -ENOMEM;
934 /* Allocate a URB for the write */
935 edge_port->write_urb = usb_alloc_urb(0, GFP_KERNEL);
936 edge_port->write_in_progress = false;
938 if (!edge_port->write_urb) {
939 dbg("%s - no memory", __func__);
940 edge_close(port);
941 return -ENOMEM;
944 dbg("%s(%d) - Initialize TX fifo to %d bytes",
945 __func__, port->number, edge_port->maxTxCredits);
947 dbg("%s exited", __func__);
949 return 0;
953 /************************************************************************
955 * block_until_chase_response
957 * This function will block the close until one of the following:
958 * 1. Response to our Chase comes from Edgeport
959 * 2. A timeout of 10 seconds without activity has expired
960 * (1K of Edgeport data @ 2400 baud ==> 4 sec to empty)
962 ************************************************************************/
963 static void block_until_chase_response(struct edgeport_port *edge_port)
965 DEFINE_WAIT(wait);
966 __u16 lastCredits;
967 int timeout = 1*HZ;
968 int loop = 10;
970 while (1) {
971 /* Save Last credits */
972 lastCredits = edge_port->txCredits;
974 /* Did we get our Chase response */
975 if (!edge_port->chaseResponsePending) {
976 dbg("%s - Got Chase Response", __func__);
978 /* did we get all of our credit back? */
979 if (edge_port->txCredits == edge_port->maxTxCredits) {
980 dbg("%s - Got all credits", __func__);
981 return;
985 /* Block the thread for a while */
986 prepare_to_wait(&edge_port->wait_chase, &wait,
987 TASK_UNINTERRUPTIBLE);
988 schedule_timeout(timeout);
989 finish_wait(&edge_port->wait_chase, &wait);
991 if (lastCredits == edge_port->txCredits) {
992 /* No activity.. count down. */
993 loop--;
994 if (loop == 0) {
995 edge_port->chaseResponsePending = false;
996 dbg("%s - Chase TIMEOUT", __func__);
997 return;
999 } else {
1000 /* Reset timeout value back to 10 seconds */
1001 dbg("%s - Last %d, Current %d", __func__,
1002 lastCredits, edge_port->txCredits);
1003 loop = 10;
1009 /************************************************************************
1011 * block_until_tx_empty
1013 * This function will block the close until one of the following:
1014 * 1. TX count are 0
1015 * 2. The edgeport has stopped
1016 * 3. A timeout of 3 seconds without activity has expired
1018 ************************************************************************/
1019 static void block_until_tx_empty(struct edgeport_port *edge_port)
1021 DEFINE_WAIT(wait);
1022 struct TxFifo *fifo = &edge_port->txfifo;
1023 __u32 lastCount;
1024 int timeout = HZ/10;
1025 int loop = 30;
1027 while (1) {
1028 /* Save Last count */
1029 lastCount = fifo->count;
1031 /* Is the Edgeport Buffer empty? */
1032 if (lastCount == 0) {
1033 dbg("%s - TX Buffer Empty", __func__);
1034 return;
1037 /* Block the thread for a while */
1038 prepare_to_wait(&edge_port->wait_chase, &wait,
1039 TASK_UNINTERRUPTIBLE);
1040 schedule_timeout(timeout);
1041 finish_wait(&edge_port->wait_chase, &wait);
1043 dbg("%s wait", __func__);
1045 if (lastCount == fifo->count) {
1046 /* No activity.. count down. */
1047 loop--;
1048 if (loop == 0) {
1049 dbg("%s - TIMEOUT", __func__);
1050 return;
1052 } else {
1053 /* Reset timeout value back to seconds */
1054 loop = 30;
1060 /*****************************************************************************
1061 * edge_close
1062 * this function is called by the tty driver when a port is closed
1063 *****************************************************************************/
1064 static void edge_close(struct usb_serial_port *port)
1066 struct edgeport_serial *edge_serial;
1067 struct edgeport_port *edge_port;
1068 int status;
1070 dbg("%s - port %d", __func__, port->number);
1072 edge_serial = usb_get_serial_data(port->serial);
1073 edge_port = usb_get_serial_port_data(port);
1074 if (edge_serial == NULL || edge_port == NULL)
1075 return;
1077 /* block until tx is empty */
1078 block_until_tx_empty(edge_port);
1080 edge_port->closePending = true;
1082 if ((!edge_serial->is_epic) ||
1083 ((edge_serial->is_epic) &&
1084 (edge_serial->epic_descriptor.Supports.IOSPChase))) {
1085 /* flush and chase */
1086 edge_port->chaseResponsePending = true;
1088 dbg("%s - Sending IOSP_CMD_CHASE_PORT", __func__);
1089 status = send_iosp_ext_cmd(edge_port, IOSP_CMD_CHASE_PORT, 0);
1090 if (status == 0)
1091 /* block until chase finished */
1092 block_until_chase_response(edge_port);
1093 else
1094 edge_port->chaseResponsePending = false;
1097 if ((!edge_serial->is_epic) ||
1098 ((edge_serial->is_epic) &&
1099 (edge_serial->epic_descriptor.Supports.IOSPClose))) {
1100 /* close the port */
1101 dbg("%s - Sending IOSP_CMD_CLOSE_PORT", __func__);
1102 send_iosp_ext_cmd(edge_port, IOSP_CMD_CLOSE_PORT, 0);
1105 /* port->close = true; */
1106 edge_port->closePending = false;
1107 edge_port->open = false;
1108 edge_port->openPending = false;
1110 usb_kill_urb(edge_port->write_urb);
1112 if (edge_port->write_urb) {
1113 /* if this urb had a transfer buffer already
1114 (old transfer) free it */
1115 kfree(edge_port->write_urb->transfer_buffer);
1116 usb_free_urb(edge_port->write_urb);
1117 edge_port->write_urb = NULL;
1119 kfree(edge_port->txfifo.fifo);
1120 edge_port->txfifo.fifo = NULL;
1122 dbg("%s exited", __func__);
1125 /*****************************************************************************
1126 * SerialWrite
1127 * this function is called by the tty driver when data should be written
1128 * to the port.
1129 * If successful, we return the number of bytes written, otherwise we
1130 * return a negative error number.
1131 *****************************************************************************/
1132 static int edge_write(struct tty_struct *tty, struct usb_serial_port *port,
1133 const unsigned char *data, int count)
1135 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1136 struct TxFifo *fifo;
1137 int copySize;
1138 int bytesleft;
1139 int firsthalf;
1140 int secondhalf;
1141 unsigned long flags;
1143 dbg("%s - port %d", __func__, port->number);
1145 if (edge_port == NULL)
1146 return -ENODEV;
1148 /* get a pointer to the Tx fifo */
1149 fifo = &edge_port->txfifo;
1151 spin_lock_irqsave(&edge_port->ep_lock, flags);
1153 /* calculate number of bytes to put in fifo */
1154 copySize = min((unsigned int)count,
1155 (edge_port->txCredits - fifo->count));
1157 dbg("%s(%d) of %d byte(s) Fifo room %d -- will copy %d bytes",
1158 __func__, port->number, count,
1159 edge_port->txCredits - fifo->count, copySize);
1161 /* catch writes of 0 bytes which the tty driver likes to give us,
1162 and when txCredits is empty */
1163 if (copySize == 0) {
1164 dbg("%s - copySize = Zero", __func__);
1165 goto finish_write;
1168 /* queue the data
1169 * since we can never overflow the buffer we do not have to check for a
1170 * full condition
1172 * the copy is done is two parts -- first fill to the end of the buffer
1173 * then copy the reset from the start of the buffer
1175 bytesleft = fifo->size - fifo->head;
1176 firsthalf = min(bytesleft, copySize);
1177 dbg("%s - copy %d bytes of %d into fifo ", __func__,
1178 firsthalf, bytesleft);
1180 /* now copy our data */
1181 memcpy(&fifo->fifo[fifo->head], data, firsthalf);
1182 usb_serial_debug_data(debug, &port->dev, __func__,
1183 firsthalf, &fifo->fifo[fifo->head]);
1185 /* update the index and size */
1186 fifo->head += firsthalf;
1187 fifo->count += firsthalf;
1189 /* wrap the index */
1190 if (fifo->head == fifo->size)
1191 fifo->head = 0;
1193 secondhalf = copySize-firsthalf;
1195 if (secondhalf) {
1196 dbg("%s - copy rest of data %d", __func__, secondhalf);
1197 memcpy(&fifo->fifo[fifo->head], &data[firsthalf], secondhalf);
1198 usb_serial_debug_data(debug, &port->dev, __func__,
1199 secondhalf, &fifo->fifo[fifo->head]);
1200 /* update the index and size */
1201 fifo->count += secondhalf;
1202 fifo->head += secondhalf;
1203 /* No need to check for wrap since we can not get to end of
1204 * the fifo in this part
1208 finish_write:
1209 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
1211 send_more_port_data((struct edgeport_serial *)
1212 usb_get_serial_data(port->serial), edge_port);
1214 dbg("%s wrote %d byte(s) TxCredits %d, Fifo %d", __func__,
1215 copySize, edge_port->txCredits, fifo->count);
1217 return copySize;
1221 /************************************************************************
1223 * send_more_port_data()
1225 * This routine attempts to write additional UART transmit data
1226 * to a port over the USB bulk pipe. It is called (1) when new
1227 * data has been written to a port's TxBuffer from higher layers
1228 * (2) when the peripheral sends us additional TxCredits indicating
1229 * that it can accept more Tx data for a given port; and (3) when
1230 * a bulk write completes successfully and we want to see if we
1231 * can transmit more.
1233 ************************************************************************/
1234 static void send_more_port_data(struct edgeport_serial *edge_serial,
1235 struct edgeport_port *edge_port)
1237 struct TxFifo *fifo = &edge_port->txfifo;
1238 struct urb *urb;
1239 unsigned char *buffer;
1240 int status;
1241 int count;
1242 int bytesleft;
1243 int firsthalf;
1244 int secondhalf;
1245 unsigned long flags;
1247 dbg("%s(%d)", __func__, edge_port->port->number);
1249 spin_lock_irqsave(&edge_port->ep_lock, flags);
1251 if (edge_port->write_in_progress ||
1252 !edge_port->open ||
1253 (fifo->count == 0)) {
1254 dbg("%s(%d) EXIT - fifo %d, PendingWrite = %d",
1255 __func__, edge_port->port->number,
1256 fifo->count, edge_port->write_in_progress);
1257 goto exit_send;
1260 /* since the amount of data in the fifo will always fit into the
1261 * edgeport buffer we do not need to check the write length
1263 * Do we have enough credits for this port to make it worthwhile
1264 * to bother queueing a write. If it's too small, say a few bytes,
1265 * it's better to wait for more credits so we can do a larger write.
1267 if (edge_port->txCredits < EDGE_FW_GET_TX_CREDITS_SEND_THRESHOLD(edge_port->maxTxCredits, EDGE_FW_BULK_MAX_PACKET_SIZE)) {
1268 dbg("%s(%d) Not enough credit - fifo %d TxCredit %d",
1269 __func__, edge_port->port->number, fifo->count,
1270 edge_port->txCredits);
1271 goto exit_send;
1274 /* lock this write */
1275 edge_port->write_in_progress = true;
1277 /* get a pointer to the write_urb */
1278 urb = edge_port->write_urb;
1280 /* make sure transfer buffer is freed */
1281 kfree(urb->transfer_buffer);
1282 urb->transfer_buffer = NULL;
1284 /* build the data header for the buffer and port that we are about
1285 to send out */
1286 count = fifo->count;
1287 buffer = kmalloc(count+2, GFP_ATOMIC);
1288 if (buffer == NULL) {
1289 dev_err(&edge_port->port->dev,
1290 "%s - no more kernel memory...\n", __func__);
1291 edge_port->write_in_progress = false;
1292 goto exit_send;
1294 buffer[0] = IOSP_BUILD_DATA_HDR1(edge_port->port->number
1295 - edge_port->port->serial->minor, count);
1296 buffer[1] = IOSP_BUILD_DATA_HDR2(edge_port->port->number
1297 - edge_port->port->serial->minor, count);
1299 /* now copy our data */
1300 bytesleft = fifo->size - fifo->tail;
1301 firsthalf = min(bytesleft, count);
1302 memcpy(&buffer[2], &fifo->fifo[fifo->tail], firsthalf);
1303 fifo->tail += firsthalf;
1304 fifo->count -= firsthalf;
1305 if (fifo->tail == fifo->size)
1306 fifo->tail = 0;
1308 secondhalf = count-firsthalf;
1309 if (secondhalf) {
1310 memcpy(&buffer[2+firsthalf], &fifo->fifo[fifo->tail],
1311 secondhalf);
1312 fifo->tail += secondhalf;
1313 fifo->count -= secondhalf;
1316 if (count)
1317 usb_serial_debug_data(debug, &edge_port->port->dev,
1318 __func__, count, &buffer[2]);
1320 /* fill up the urb with all of our data and submit it */
1321 usb_fill_bulk_urb(urb, edge_serial->serial->dev,
1322 usb_sndbulkpipe(edge_serial->serial->dev,
1323 edge_serial->bulk_out_endpoint),
1324 buffer, count+2,
1325 edge_bulk_out_data_callback, edge_port);
1327 /* decrement the number of credits we have by the number we just sent */
1328 edge_port->txCredits -= count;
1329 edge_port->icount.tx += count;
1331 urb->dev = edge_serial->serial->dev;
1332 status = usb_submit_urb(urb, GFP_ATOMIC);
1333 if (status) {
1334 /* something went wrong */
1335 dev_err(&edge_port->port->dev,
1336 "%s - usb_submit_urb(write bulk) failed, status = %d, data lost\n",
1337 __func__, status);
1338 edge_port->write_in_progress = false;
1340 /* revert the credits as something bad happened. */
1341 edge_port->txCredits += count;
1342 edge_port->icount.tx -= count;
1344 dbg("%s wrote %d byte(s) TxCredit %d, Fifo %d",
1345 __func__, count, edge_port->txCredits, fifo->count);
1347 exit_send:
1348 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
1352 /*****************************************************************************
1353 * edge_write_room
1354 * this function is called by the tty driver when it wants to know how
1355 * many bytes of data we can accept for a specific port. If successful,
1356 * we return the amount of room that we have for this port (the txCredits)
1357 * otherwise we return a negative error number.
1358 *****************************************************************************/
1359 static int edge_write_room(struct tty_struct *tty)
1361 struct usb_serial_port *port = tty->driver_data;
1362 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1363 int room;
1364 unsigned long flags;
1366 dbg("%s", __func__);
1368 if (edge_port == NULL)
1369 return 0;
1370 if (edge_port->closePending)
1371 return 0;
1373 dbg("%s - port %d", __func__, port->number);
1375 if (!edge_port->open) {
1376 dbg("%s - port not opened", __func__);
1377 return 0;
1380 /* total of both buffers is still txCredit */
1381 spin_lock_irqsave(&edge_port->ep_lock, flags);
1382 room = edge_port->txCredits - edge_port->txfifo.count;
1383 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
1385 dbg("%s - returns %d", __func__, room);
1386 return room;
1390 /*****************************************************************************
1391 * edge_chars_in_buffer
1392 * this function is called by the tty driver when it wants to know how
1393 * many bytes of data we currently have outstanding in the port (data that
1394 * has been written, but hasn't made it out the port yet)
1395 * If successful, we return the number of bytes left to be written in the
1396 * system,
1397 * Otherwise we return a negative error number.
1398 *****************************************************************************/
1399 static int edge_chars_in_buffer(struct tty_struct *tty)
1401 struct usb_serial_port *port = tty->driver_data;
1402 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1403 int num_chars;
1404 unsigned long flags;
1406 dbg("%s", __func__);
1408 if (edge_port == NULL)
1409 return 0;
1410 if (edge_port->closePending)
1411 return 0;
1413 if (!edge_port->open) {
1414 dbg("%s - port not opened", __func__);
1415 return 0;
1418 spin_lock_irqsave(&edge_port->ep_lock, flags);
1419 num_chars = edge_port->maxTxCredits - edge_port->txCredits +
1420 edge_port->txfifo.count;
1421 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
1422 if (num_chars) {
1423 dbg("%s(port %d) - returns %d", __func__,
1424 port->number, num_chars);
1427 return num_chars;
1431 /*****************************************************************************
1432 * SerialThrottle
1433 * this function is called by the tty driver when it wants to stop the data
1434 * being read from the port.
1435 *****************************************************************************/
1436 static void edge_throttle(struct tty_struct *tty)
1438 struct usb_serial_port *port = tty->driver_data;
1439 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1440 int status;
1442 dbg("%s - port %d", __func__, port->number);
1444 if (edge_port == NULL)
1445 return;
1447 if (!edge_port->open) {
1448 dbg("%s - port not opened", __func__);
1449 return;
1452 /* if we are implementing XON/XOFF, send the stop character */
1453 if (I_IXOFF(tty)) {
1454 unsigned char stop_char = STOP_CHAR(tty);
1455 status = edge_write(tty, port, &stop_char, 1);
1456 if (status <= 0)
1457 return;
1460 /* if we are implementing RTS/CTS, toggle that line */
1461 if (tty->termios->c_cflag & CRTSCTS) {
1462 edge_port->shadowMCR &= ~MCR_RTS;
1463 status = send_cmd_write_uart_register(edge_port, MCR,
1464 edge_port->shadowMCR);
1465 if (status != 0)
1466 return;
1469 return;
1473 /*****************************************************************************
1474 * edge_unthrottle
1475 * this function is called by the tty driver when it wants to resume the
1476 * data being read from the port (called after SerialThrottle is called)
1477 *****************************************************************************/
1478 static void edge_unthrottle(struct tty_struct *tty)
1480 struct usb_serial_port *port = tty->driver_data;
1481 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1482 int status;
1484 dbg("%s - port %d", __func__, port->number);
1486 if (edge_port == NULL)
1487 return;
1489 if (!edge_port->open) {
1490 dbg("%s - port not opened", __func__);
1491 return;
1494 /* if we are implementing XON/XOFF, send the start character */
1495 if (I_IXOFF(tty)) {
1496 unsigned char start_char = START_CHAR(tty);
1497 status = edge_write(tty, port, &start_char, 1);
1498 if (status <= 0)
1499 return;
1501 /* if we are implementing RTS/CTS, toggle that line */
1502 if (tty->termios->c_cflag & CRTSCTS) {
1503 edge_port->shadowMCR |= MCR_RTS;
1504 send_cmd_write_uart_register(edge_port, MCR,
1505 edge_port->shadowMCR);
1510 /*****************************************************************************
1511 * SerialSetTermios
1512 * this function is called by the tty driver when it wants to change
1513 * the termios structure
1514 *****************************************************************************/
1515 static void edge_set_termios(struct tty_struct *tty,
1516 struct usb_serial_port *port, struct ktermios *old_termios)
1518 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1519 unsigned int cflag;
1521 cflag = tty->termios->c_cflag;
1522 dbg("%s - clfag %08x iflag %08x", __func__,
1523 tty->termios->c_cflag, tty->termios->c_iflag);
1524 dbg("%s - old clfag %08x old iflag %08x", __func__,
1525 old_termios->c_cflag, old_termios->c_iflag);
1527 dbg("%s - port %d", __func__, port->number);
1529 if (edge_port == NULL)
1530 return;
1532 if (!edge_port->open) {
1533 dbg("%s - port not opened", __func__);
1534 return;
1537 /* change the port settings to the new ones specified */
1538 change_port_settings(tty, edge_port, old_termios);
1542 /*****************************************************************************
1543 * get_lsr_info - get line status register info
1545 * Purpose: Let user call ioctl() to get info when the UART physically
1546 * is emptied. On bus types like RS485, the transmitter must
1547 * release the bus after transmitting. This must be done when
1548 * the transmit shift register is empty, not be done when the
1549 * transmit holding register is empty. This functionality
1550 * allows an RS485 driver to be written in user space.
1551 *****************************************************************************/
1552 static int get_lsr_info(struct edgeport_port *edge_port,
1553 unsigned int __user *value)
1555 unsigned int result = 0;
1556 unsigned long flags;
1558 spin_lock_irqsave(&edge_port->ep_lock, flags);
1559 if (edge_port->maxTxCredits == edge_port->txCredits &&
1560 edge_port->txfifo.count == 0) {
1561 dbg("%s -- Empty", __func__);
1562 result = TIOCSER_TEMT;
1564 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
1566 if (copy_to_user(value, &result, sizeof(int)))
1567 return -EFAULT;
1568 return 0;
1571 static int edge_tiocmset(struct tty_struct *tty, struct file *file,
1572 unsigned int set, unsigned int clear)
1574 struct usb_serial_port *port = tty->driver_data;
1575 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1576 unsigned int mcr;
1578 dbg("%s - port %d", __func__, port->number);
1580 mcr = edge_port->shadowMCR;
1581 if (set & TIOCM_RTS)
1582 mcr |= MCR_RTS;
1583 if (set & TIOCM_DTR)
1584 mcr |= MCR_DTR;
1585 if (set & TIOCM_LOOP)
1586 mcr |= MCR_LOOPBACK;
1588 if (clear & TIOCM_RTS)
1589 mcr &= ~MCR_RTS;
1590 if (clear & TIOCM_DTR)
1591 mcr &= ~MCR_DTR;
1592 if (clear & TIOCM_LOOP)
1593 mcr &= ~MCR_LOOPBACK;
1595 edge_port->shadowMCR = mcr;
1597 send_cmd_write_uart_register(edge_port, MCR, edge_port->shadowMCR);
1599 return 0;
1602 static int edge_tiocmget(struct tty_struct *tty, struct file *file)
1604 struct usb_serial_port *port = tty->driver_data;
1605 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1606 unsigned int result = 0;
1607 unsigned int msr;
1608 unsigned int mcr;
1610 dbg("%s - port %d", __func__, port->number);
1612 msr = edge_port->shadowMSR;
1613 mcr = edge_port->shadowMCR;
1614 result = ((mcr & MCR_DTR) ? TIOCM_DTR: 0) /* 0x002 */
1615 | ((mcr & MCR_RTS) ? TIOCM_RTS: 0) /* 0x004 */
1616 | ((msr & EDGEPORT_MSR_CTS) ? TIOCM_CTS: 0) /* 0x020 */
1617 | ((msr & EDGEPORT_MSR_CD) ? TIOCM_CAR: 0) /* 0x040 */
1618 | ((msr & EDGEPORT_MSR_RI) ? TIOCM_RI: 0) /* 0x080 */
1619 | ((msr & EDGEPORT_MSR_DSR) ? TIOCM_DSR: 0); /* 0x100 */
1622 dbg("%s -- %x", __func__, result);
1624 return result;
1627 static int get_serial_info(struct edgeport_port *edge_port,
1628 struct serial_struct __user *retinfo)
1630 struct serial_struct tmp;
1632 if (!retinfo)
1633 return -EFAULT;
1635 memset(&tmp, 0, sizeof(tmp));
1637 tmp.type = PORT_16550A;
1638 tmp.line = edge_port->port->serial->minor;
1639 tmp.port = edge_port->port->number;
1640 tmp.irq = 0;
1641 tmp.flags = ASYNC_SKIP_TEST | ASYNC_AUTO_IRQ;
1642 tmp.xmit_fifo_size = edge_port->maxTxCredits;
1643 tmp.baud_base = 9600;
1644 tmp.close_delay = 5*HZ;
1645 tmp.closing_wait = 30*HZ;
1647 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
1648 return -EFAULT;
1649 return 0;
1654 /*****************************************************************************
1655 * SerialIoctl
1656 * this function handles any ioctl calls to the driver
1657 *****************************************************************************/
1658 static int edge_ioctl(struct tty_struct *tty, struct file *file,
1659 unsigned int cmd, unsigned long arg)
1661 struct usb_serial_port *port = tty->driver_data;
1662 DEFINE_WAIT(wait);
1663 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1664 struct async_icount cnow;
1665 struct async_icount cprev;
1666 struct serial_icounter_struct icount;
1668 dbg("%s - port %d, cmd = 0x%x", __func__, port->number, cmd);
1670 switch (cmd) {
1671 case TIOCSERGETLSR:
1672 dbg("%s (%d) TIOCSERGETLSR", __func__, port->number);
1673 return get_lsr_info(edge_port, (unsigned int __user *) arg);
1675 case TIOCGSERIAL:
1676 dbg("%s (%d) TIOCGSERIAL", __func__, port->number);
1677 return get_serial_info(edge_port, (struct serial_struct __user *) arg);
1679 case TIOCMIWAIT:
1680 dbg("%s (%d) TIOCMIWAIT", __func__, port->number);
1681 cprev = edge_port->icount;
1682 while (1) {
1683 prepare_to_wait(&edge_port->delta_msr_wait,
1684 &wait, TASK_INTERRUPTIBLE);
1685 schedule();
1686 finish_wait(&edge_port->delta_msr_wait, &wait);
1687 /* see if a signal did it */
1688 if (signal_pending(current))
1689 return -ERESTARTSYS;
1690 cnow = edge_port->icount;
1691 if (cnow.rng == cprev.rng && cnow.dsr == cprev.dsr &&
1692 cnow.dcd == cprev.dcd && cnow.cts == cprev.cts)
1693 return -EIO; /* no change => error */
1694 if (((arg & TIOCM_RNG) && (cnow.rng != cprev.rng)) ||
1695 ((arg & TIOCM_DSR) && (cnow.dsr != cprev.dsr)) ||
1696 ((arg & TIOCM_CD) && (cnow.dcd != cprev.dcd)) ||
1697 ((arg & TIOCM_CTS) && (cnow.cts != cprev.cts))) {
1698 return 0;
1700 cprev = cnow;
1702 /* NOTREACHED */
1703 break;
1705 case TIOCGICOUNT:
1706 cnow = edge_port->icount;
1707 memset(&icount, 0, sizeof(icount));
1708 icount.cts = cnow.cts;
1709 icount.dsr = cnow.dsr;
1710 icount.rng = cnow.rng;
1711 icount.dcd = cnow.dcd;
1712 icount.rx = cnow.rx;
1713 icount.tx = cnow.tx;
1714 icount.frame = cnow.frame;
1715 icount.overrun = cnow.overrun;
1716 icount.parity = cnow.parity;
1717 icount.brk = cnow.brk;
1718 icount.buf_overrun = cnow.buf_overrun;
1720 dbg("%s (%d) TIOCGICOUNT RX=%d, TX=%d",
1721 __func__, port->number, icount.rx, icount.tx);
1722 if (copy_to_user((void __user *)arg, &icount, sizeof(icount)))
1723 return -EFAULT;
1724 return 0;
1726 return -ENOIOCTLCMD;
1730 /*****************************************************************************
1731 * SerialBreak
1732 * this function sends a break to the port
1733 *****************************************************************************/
1734 static void edge_break(struct tty_struct *tty, int break_state)
1736 struct usb_serial_port *port = tty->driver_data;
1737 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1738 struct edgeport_serial *edge_serial = usb_get_serial_data(port->serial);
1739 int status;
1741 if ((!edge_serial->is_epic) ||
1742 ((edge_serial->is_epic) &&
1743 (edge_serial->epic_descriptor.Supports.IOSPChase))) {
1744 /* flush and chase */
1745 edge_port->chaseResponsePending = true;
1747 dbg("%s - Sending IOSP_CMD_CHASE_PORT", __func__);
1748 status = send_iosp_ext_cmd(edge_port, IOSP_CMD_CHASE_PORT, 0);
1749 if (status == 0) {
1750 /* block until chase finished */
1751 block_until_chase_response(edge_port);
1752 } else {
1753 edge_port->chaseResponsePending = false;
1757 if ((!edge_serial->is_epic) ||
1758 ((edge_serial->is_epic) &&
1759 (edge_serial->epic_descriptor.Supports.IOSPSetClrBreak))) {
1760 if (break_state == -1) {
1761 dbg("%s - Sending IOSP_CMD_SET_BREAK", __func__);
1762 status = send_iosp_ext_cmd(edge_port,
1763 IOSP_CMD_SET_BREAK, 0);
1764 } else {
1765 dbg("%s - Sending IOSP_CMD_CLEAR_BREAK", __func__);
1766 status = send_iosp_ext_cmd(edge_port,
1767 IOSP_CMD_CLEAR_BREAK, 0);
1769 if (status)
1770 dbg("%s - error sending break set/clear command.",
1771 __func__);
1774 return;
1778 /*****************************************************************************
1779 * process_rcvd_data
1780 * this function handles the data received on the bulk in pipe.
1781 *****************************************************************************/
1782 static void process_rcvd_data(struct edgeport_serial *edge_serial,
1783 unsigned char *buffer, __u16 bufferLength)
1785 struct usb_serial_port *port;
1786 struct edgeport_port *edge_port;
1787 struct tty_struct *tty;
1788 __u16 lastBufferLength;
1789 __u16 rxLen;
1791 dbg("%s", __func__);
1793 lastBufferLength = bufferLength + 1;
1795 while (bufferLength > 0) {
1796 /* failsafe incase we get a message that we don't understand */
1797 if (lastBufferLength == bufferLength) {
1798 dbg("%s - stuck in loop, exiting it.", __func__);
1799 break;
1801 lastBufferLength = bufferLength;
1803 switch (edge_serial->rxState) {
1804 case EXPECT_HDR1:
1805 edge_serial->rxHeader1 = *buffer;
1806 ++buffer;
1807 --bufferLength;
1809 if (bufferLength == 0) {
1810 edge_serial->rxState = EXPECT_HDR2;
1811 break;
1813 /* otherwise, drop on through */
1814 case EXPECT_HDR2:
1815 edge_serial->rxHeader2 = *buffer;
1816 ++buffer;
1817 --bufferLength;
1819 dbg("%s - Hdr1=%02X Hdr2=%02X", __func__,
1820 edge_serial->rxHeader1, edge_serial->rxHeader2);
1821 /* Process depending on whether this header is
1822 * data or status */
1824 if (IS_CMD_STAT_HDR(edge_serial->rxHeader1)) {
1825 /* Decode this status header and go to
1826 * EXPECT_HDR1 (if we can process the status
1827 * with only 2 bytes), or go to EXPECT_HDR3 to
1828 * get the third byte. */
1829 edge_serial->rxPort =
1830 IOSP_GET_HDR_PORT(edge_serial->rxHeader1);
1831 edge_serial->rxStatusCode =
1832 IOSP_GET_STATUS_CODE(
1833 edge_serial->rxHeader1);
1835 if (!IOSP_STATUS_IS_2BYTE(
1836 edge_serial->rxStatusCode)) {
1837 /* This status needs additional bytes.
1838 * Save what we have and then wait for
1839 * more data.
1841 edge_serial->rxStatusParam
1842 = edge_serial->rxHeader2;
1843 edge_serial->rxState = EXPECT_HDR3;
1844 break;
1846 /* We have all the header bytes, process the
1847 status now */
1848 process_rcvd_status(edge_serial,
1849 edge_serial->rxHeader2, 0);
1850 edge_serial->rxState = EXPECT_HDR1;
1851 break;
1852 } else {
1853 edge_serial->rxPort =
1854 IOSP_GET_HDR_PORT(edge_serial->rxHeader1);
1855 edge_serial->rxBytesRemaining =
1856 IOSP_GET_HDR_DATA_LEN(
1857 edge_serial->rxHeader1,
1858 edge_serial->rxHeader2);
1859 dbg("%s - Data for Port %u Len %u",
1860 __func__,
1861 edge_serial->rxPort,
1862 edge_serial->rxBytesRemaining);
1864 /* ASSERT(DevExt->RxPort < DevExt->NumPorts);
1865 * ASSERT(DevExt->RxBytesRemaining <
1866 * IOSP_MAX_DATA_LENGTH);
1869 if (bufferLength == 0) {
1870 edge_serial->rxState = EXPECT_DATA;
1871 break;
1873 /* Else, drop through */
1875 case EXPECT_DATA: /* Expect data */
1876 if (bufferLength < edge_serial->rxBytesRemaining) {
1877 rxLen = bufferLength;
1878 /* Expect data to start next buffer */
1879 edge_serial->rxState = EXPECT_DATA;
1880 } else {
1881 /* BufLen >= RxBytesRemaining */
1882 rxLen = edge_serial->rxBytesRemaining;
1883 /* Start another header next time */
1884 edge_serial->rxState = EXPECT_HDR1;
1887 bufferLength -= rxLen;
1888 edge_serial->rxBytesRemaining -= rxLen;
1890 /* spit this data back into the tty driver if this
1891 port is open */
1892 if (rxLen) {
1893 port = edge_serial->serial->port[
1894 edge_serial->rxPort];
1895 edge_port = usb_get_serial_port_data(port);
1896 if (edge_port->open) {
1897 tty = tty_port_tty_get(
1898 &edge_port->port->port);
1899 if (tty) {
1900 dbg("%s - Sending %d bytes to TTY for port %d",
1901 __func__, rxLen, edge_serial->rxPort);
1902 edge_tty_recv(&edge_serial->serial->dev->dev, tty, buffer, rxLen);
1903 tty_kref_put(tty);
1905 edge_port->icount.rx += rxLen;
1907 buffer += rxLen;
1909 break;
1911 case EXPECT_HDR3: /* Expect 3rd byte of status header */
1912 edge_serial->rxHeader3 = *buffer;
1913 ++buffer;
1914 --bufferLength;
1916 /* We have all the header bytes, process the
1917 status now */
1918 process_rcvd_status(edge_serial,
1919 edge_serial->rxStatusParam,
1920 edge_serial->rxHeader3);
1921 edge_serial->rxState = EXPECT_HDR1;
1922 break;
1928 /*****************************************************************************
1929 * process_rcvd_status
1930 * this function handles the any status messages received on the
1931 * bulk in pipe.
1932 *****************************************************************************/
1933 static void process_rcvd_status(struct edgeport_serial *edge_serial,
1934 __u8 byte2, __u8 byte3)
1936 struct usb_serial_port *port;
1937 struct edgeport_port *edge_port;
1938 struct tty_struct *tty;
1939 __u8 code = edge_serial->rxStatusCode;
1941 /* switch the port pointer to the one being currently talked about */
1942 port = edge_serial->serial->port[edge_serial->rxPort];
1943 edge_port = usb_get_serial_port_data(port);
1944 if (edge_port == NULL) {
1945 dev_err(&edge_serial->serial->dev->dev,
1946 "%s - edge_port == NULL for port %d\n",
1947 __func__, edge_serial->rxPort);
1948 return;
1951 dbg("%s - port %d", __func__, edge_serial->rxPort);
1953 if (code == IOSP_EXT_STATUS) {
1954 switch (byte2) {
1955 case IOSP_EXT_STATUS_CHASE_RSP:
1956 /* we want to do EXT status regardless of port
1957 * open/closed */
1958 dbg("%s - Port %u EXT CHASE_RSP Data = %02x",
1959 __func__, edge_serial->rxPort, byte3);
1960 /* Currently, the only EXT_STATUS is Chase, so process
1961 * here instead of one more call to one more subroutine
1962 * If/when more EXT_STATUS, there'll be more work to do
1963 * Also, we currently clear flag and close the port
1964 * regardless of content of above's Byte3.
1965 * We could choose to do something else when Byte3 says
1966 * Timeout on Chase from Edgeport, like wait longer in
1967 * block_until_chase_response, but for now we don't.
1969 edge_port->chaseResponsePending = false;
1970 wake_up(&edge_port->wait_chase);
1971 return;
1973 case IOSP_EXT_STATUS_RX_CHECK_RSP:
1974 dbg("%s ========== Port %u CHECK_RSP Sequence = %02x =============", __func__, edge_serial->rxPort, byte3);
1975 /* Port->RxCheckRsp = true; */
1976 return;
1980 if (code == IOSP_STATUS_OPEN_RSP) {
1981 edge_port->txCredits = GET_TX_BUFFER_SIZE(byte3);
1982 edge_port->maxTxCredits = edge_port->txCredits;
1983 dbg("%s - Port %u Open Response Inital MSR = %02x TxBufferSize = %d", __func__, edge_serial->rxPort, byte2, edge_port->txCredits);
1984 handle_new_msr(edge_port, byte2);
1986 /* send the current line settings to the port so we are
1987 in sync with any further termios calls */
1988 tty = tty_port_tty_get(&edge_port->port->port);
1989 if (tty) {
1990 change_port_settings(tty,
1991 edge_port, tty->termios);
1992 tty_kref_put(tty);
1995 /* we have completed the open */
1996 edge_port->openPending = false;
1997 edge_port->open = true;
1998 wake_up(&edge_port->wait_open);
1999 return;
2002 /* If port is closed, silently discard all rcvd status. We can
2003 * have cases where buffered status is received AFTER the close
2004 * port command is sent to the Edgeport.
2006 if (!edge_port->open || edge_port->closePending)
2007 return;
2009 switch (code) {
2010 /* Not currently sent by Edgeport */
2011 case IOSP_STATUS_LSR:
2012 dbg("%s - Port %u LSR Status = %02x",
2013 __func__, edge_serial->rxPort, byte2);
2014 handle_new_lsr(edge_port, false, byte2, 0);
2015 break;
2017 case IOSP_STATUS_LSR_DATA:
2018 dbg("%s - Port %u LSR Status = %02x, Data = %02x",
2019 __func__, edge_serial->rxPort, byte2, byte3);
2020 /* byte2 is LSR Register */
2021 /* byte3 is broken data byte */
2022 handle_new_lsr(edge_port, true, byte2, byte3);
2023 break;
2025 * case IOSP_EXT_4_STATUS:
2026 * dbg("%s - Port %u LSR Status = %02x Data = %02x",
2027 * __func__, edge_serial->rxPort, byte2, byte3);
2028 * break;
2030 case IOSP_STATUS_MSR:
2031 dbg("%s - Port %u MSR Status = %02x",
2032 __func__, edge_serial->rxPort, byte2);
2034 * Process this new modem status and generate appropriate
2035 * events, etc, based on the new status. This routine
2036 * also saves the MSR in Port->ShadowMsr.
2038 handle_new_msr(edge_port, byte2);
2039 break;
2041 default:
2042 dbg("%s - Unrecognized IOSP status code %u", __func__, code);
2043 break;
2045 return;
2049 /*****************************************************************************
2050 * edge_tty_recv
2051 * this function passes data on to the tty flip buffer
2052 *****************************************************************************/
2053 static void edge_tty_recv(struct device *dev, struct tty_struct *tty,
2054 unsigned char *data, int length)
2056 int cnt;
2058 cnt = tty_insert_flip_string(tty, data, length);
2059 if (cnt < length) {
2060 dev_err(dev, "%s - dropping data, %d bytes lost\n",
2061 __func__, length - cnt);
2063 data += cnt;
2064 length -= cnt;
2066 tty_flip_buffer_push(tty);
2070 /*****************************************************************************
2071 * handle_new_msr
2072 * this function handles any change to the msr register for a port.
2073 *****************************************************************************/
2074 static void handle_new_msr(struct edgeport_port *edge_port, __u8 newMsr)
2076 struct async_icount *icount;
2078 dbg("%s %02x", __func__, newMsr);
2080 if (newMsr & (EDGEPORT_MSR_DELTA_CTS | EDGEPORT_MSR_DELTA_DSR |
2081 EDGEPORT_MSR_DELTA_RI | EDGEPORT_MSR_DELTA_CD)) {
2082 icount = &edge_port->icount;
2084 /* update input line counters */
2085 if (newMsr & EDGEPORT_MSR_DELTA_CTS)
2086 icount->cts++;
2087 if (newMsr & EDGEPORT_MSR_DELTA_DSR)
2088 icount->dsr++;
2089 if (newMsr & EDGEPORT_MSR_DELTA_CD)
2090 icount->dcd++;
2091 if (newMsr & EDGEPORT_MSR_DELTA_RI)
2092 icount->rng++;
2093 wake_up_interruptible(&edge_port->delta_msr_wait);
2096 /* Save the new modem status */
2097 edge_port->shadowMSR = newMsr & 0xf0;
2099 return;
2103 /*****************************************************************************
2104 * handle_new_lsr
2105 * this function handles any change to the lsr register for a port.
2106 *****************************************************************************/
2107 static void handle_new_lsr(struct edgeport_port *edge_port, __u8 lsrData,
2108 __u8 lsr, __u8 data)
2110 __u8 newLsr = (__u8) (lsr & (__u8)
2111 (LSR_OVER_ERR | LSR_PAR_ERR | LSR_FRM_ERR | LSR_BREAK));
2112 struct async_icount *icount;
2114 dbg("%s - %02x", __func__, newLsr);
2116 edge_port->shadowLSR = lsr;
2118 if (newLsr & LSR_BREAK) {
2120 * Parity and Framing errors only count if they
2121 * occur exclusive of a break being
2122 * received.
2124 newLsr &= (__u8)(LSR_OVER_ERR | LSR_BREAK);
2127 /* Place LSR data byte into Rx buffer */
2128 if (lsrData) {
2129 struct tty_struct *tty =
2130 tty_port_tty_get(&edge_port->port->port);
2131 if (tty) {
2132 edge_tty_recv(&edge_port->port->dev, tty, &data, 1);
2133 tty_kref_put(tty);
2136 /* update input line counters */
2137 icount = &edge_port->icount;
2138 if (newLsr & LSR_BREAK)
2139 icount->brk++;
2140 if (newLsr & LSR_OVER_ERR)
2141 icount->overrun++;
2142 if (newLsr & LSR_PAR_ERR)
2143 icount->parity++;
2144 if (newLsr & LSR_FRM_ERR)
2145 icount->frame++;
2147 return;
2151 /****************************************************************************
2152 * sram_write
2153 * writes a number of bytes to the Edgeport device's sram starting at the
2154 * given address.
2155 * If successful returns the number of bytes written, otherwise it returns
2156 * a negative error number of the problem.
2157 ****************************************************************************/
2158 static int sram_write(struct usb_serial *serial, __u16 extAddr, __u16 addr,
2159 __u16 length, const __u8 *data)
2161 int result;
2162 __u16 current_length;
2163 unsigned char *transfer_buffer;
2165 dbg("%s - %x, %x, %d", __func__, extAddr, addr, length);
2167 transfer_buffer = kmalloc(64, GFP_KERNEL);
2168 if (!transfer_buffer) {
2169 dev_err(&serial->dev->dev, "%s - kmalloc(%d) failed.\n",
2170 __func__, 64);
2171 return -ENOMEM;
2174 /* need to split these writes up into 64 byte chunks */
2175 result = 0;
2176 while (length > 0) {
2177 if (length > 64)
2178 current_length = 64;
2179 else
2180 current_length = length;
2182 /* dbg("%s - writing %x, %x, %d", __func__,
2183 extAddr, addr, current_length); */
2184 memcpy(transfer_buffer, data, current_length);
2185 result = usb_control_msg(serial->dev,
2186 usb_sndctrlpipe(serial->dev, 0),
2187 USB_REQUEST_ION_WRITE_RAM,
2188 0x40, addr, extAddr, transfer_buffer,
2189 current_length, 300);
2190 if (result < 0)
2191 break;
2192 length -= current_length;
2193 addr += current_length;
2194 data += current_length;
2197 kfree(transfer_buffer);
2198 return result;
2202 /****************************************************************************
2203 * rom_write
2204 * writes a number of bytes to the Edgeport device's ROM starting at the
2205 * given address.
2206 * If successful returns the number of bytes written, otherwise it returns
2207 * a negative error number of the problem.
2208 ****************************************************************************/
2209 static int rom_write(struct usb_serial *serial, __u16 extAddr, __u16 addr,
2210 __u16 length, const __u8 *data)
2212 int result;
2213 __u16 current_length;
2214 unsigned char *transfer_buffer;
2216 /* dbg("%s - %x, %x, %d", __func__, extAddr, addr, length); */
2218 transfer_buffer = kmalloc(64, GFP_KERNEL);
2219 if (!transfer_buffer) {
2220 dev_err(&serial->dev->dev, "%s - kmalloc(%d) failed.\n",
2221 __func__, 64);
2222 return -ENOMEM;
2225 /* need to split these writes up into 64 byte chunks */
2226 result = 0;
2227 while (length > 0) {
2228 if (length > 64)
2229 current_length = 64;
2230 else
2231 current_length = length;
2232 /* dbg("%s - writing %x, %x, %d", __func__,
2233 extAddr, addr, current_length); */
2234 memcpy(transfer_buffer, data, current_length);
2235 result = usb_control_msg(serial->dev,
2236 usb_sndctrlpipe(serial->dev, 0),
2237 USB_REQUEST_ION_WRITE_ROM, 0x40,
2238 addr, extAddr,
2239 transfer_buffer, current_length, 300);
2240 if (result < 0)
2241 break;
2242 length -= current_length;
2243 addr += current_length;
2244 data += current_length;
2247 kfree(transfer_buffer);
2248 return result;
2252 /****************************************************************************
2253 * rom_read
2254 * reads a number of bytes from the Edgeport device starting at the given
2255 * address.
2256 * If successful returns the number of bytes read, otherwise it returns
2257 * a negative error number of the problem.
2258 ****************************************************************************/
2259 static int rom_read(struct usb_serial *serial, __u16 extAddr,
2260 __u16 addr, __u16 length, __u8 *data)
2262 int result;
2263 __u16 current_length;
2264 unsigned char *transfer_buffer;
2266 dbg("%s - %x, %x, %d", __func__, extAddr, addr, length);
2268 transfer_buffer = kmalloc(64, GFP_KERNEL);
2269 if (!transfer_buffer) {
2270 dev_err(&serial->dev->dev,
2271 "%s - kmalloc(%d) failed.\n", __func__, 64);
2272 return -ENOMEM;
2275 /* need to split these reads up into 64 byte chunks */
2276 result = 0;
2277 while (length > 0) {
2278 if (length > 64)
2279 current_length = 64;
2280 else
2281 current_length = length;
2282 /* dbg("%s - %x, %x, %d", __func__,
2283 extAddr, addr, current_length); */
2284 result = usb_control_msg(serial->dev,
2285 usb_rcvctrlpipe(serial->dev, 0),
2286 USB_REQUEST_ION_READ_ROM,
2287 0xC0, addr, extAddr, transfer_buffer,
2288 current_length, 300);
2289 if (result < 0)
2290 break;
2291 memcpy(data, transfer_buffer, current_length);
2292 length -= current_length;
2293 addr += current_length;
2294 data += current_length;
2297 kfree(transfer_buffer);
2298 return result;
2302 /****************************************************************************
2303 * send_iosp_ext_cmd
2304 * Is used to send a IOSP message to the Edgeport device
2305 ****************************************************************************/
2306 static int send_iosp_ext_cmd(struct edgeport_port *edge_port,
2307 __u8 command, __u8 param)
2309 unsigned char *buffer;
2310 unsigned char *currentCommand;
2311 int length = 0;
2312 int status = 0;
2314 dbg("%s - %d, %d", __func__, command, param);
2316 buffer = kmalloc(10, GFP_ATOMIC);
2317 if (!buffer) {
2318 dev_err(&edge_port->port->dev,
2319 "%s - kmalloc(%d) failed.\n", __func__, 10);
2320 return -ENOMEM;
2323 currentCommand = buffer;
2325 MAKE_CMD_EXT_CMD(&currentCommand, &length,
2326 edge_port->port->number - edge_port->port->serial->minor,
2327 command, param);
2329 status = write_cmd_usb(edge_port, buffer, length);
2330 if (status) {
2331 /* something bad happened, let's free up the memory */
2332 kfree(buffer);
2335 return status;
2339 /*****************************************************************************
2340 * write_cmd_usb
2341 * this function writes the given buffer out to the bulk write endpoint.
2342 *****************************************************************************/
2343 static int write_cmd_usb(struct edgeport_port *edge_port,
2344 unsigned char *buffer, int length)
2346 struct edgeport_serial *edge_serial =
2347 usb_get_serial_data(edge_port->port->serial);
2348 int status = 0;
2349 struct urb *urb;
2350 int timeout;
2352 usb_serial_debug_data(debug, &edge_port->port->dev,
2353 __func__, length, buffer);
2355 /* Allocate our next urb */
2356 urb = usb_alloc_urb(0, GFP_ATOMIC);
2357 if (!urb)
2358 return -ENOMEM;
2360 atomic_inc(&CmdUrbs);
2361 dbg("%s - ALLOCATE URB %p (outstanding %d)",
2362 __func__, urb, atomic_read(&CmdUrbs));
2364 usb_fill_bulk_urb(urb, edge_serial->serial->dev,
2365 usb_sndbulkpipe(edge_serial->serial->dev,
2366 edge_serial->bulk_out_endpoint),
2367 buffer, length, edge_bulk_out_cmd_callback, edge_port);
2369 edge_port->commandPending = true;
2370 status = usb_submit_urb(urb, GFP_ATOMIC);
2372 if (status) {
2373 /* something went wrong */
2374 dev_err(&edge_port->port->dev,
2375 "%s - usb_submit_urb(write command) failed, status = %d\n",
2376 __func__, status);
2377 usb_kill_urb(urb);
2378 usb_free_urb(urb);
2379 atomic_dec(&CmdUrbs);
2380 return status;
2383 /* wait for command to finish */
2384 timeout = COMMAND_TIMEOUT;
2385 #if 0
2386 wait_event(&edge_port->wait_command, !edge_port->commandPending);
2388 if (edge_port->commandPending) {
2389 /* command timed out */
2390 dbg("%s - command timed out", __func__);
2391 status = -EINVAL;
2393 #endif
2394 return status;
2398 /*****************************************************************************
2399 * send_cmd_write_baud_rate
2400 * this function sends the proper command to change the baud rate of the
2401 * specified port.
2402 *****************************************************************************/
2403 static int send_cmd_write_baud_rate(struct edgeport_port *edge_port,
2404 int baudRate)
2406 struct edgeport_serial *edge_serial =
2407 usb_get_serial_data(edge_port->port->serial);
2408 unsigned char *cmdBuffer;
2409 unsigned char *currCmd;
2410 int cmdLen = 0;
2411 int divisor;
2412 int status;
2413 unsigned char number =
2414 edge_port->port->number - edge_port->port->serial->minor;
2416 if (edge_serial->is_epic &&
2417 !edge_serial->epic_descriptor.Supports.IOSPSetBaudRate) {
2418 dbg("SendCmdWriteBaudRate - NOT Setting baud rate for port = %d, baud = %d",
2419 edge_port->port->number, baudRate);
2420 return 0;
2423 dbg("%s - port = %d, baud = %d", __func__,
2424 edge_port->port->number, baudRate);
2426 status = calc_baud_rate_divisor(baudRate, &divisor);
2427 if (status) {
2428 dev_err(&edge_port->port->dev, "%s - bad baud rate\n",
2429 __func__);
2430 return status;
2433 /* Alloc memory for the string of commands. */
2434 cmdBuffer = kmalloc(0x100, GFP_ATOMIC);
2435 if (!cmdBuffer) {
2436 dev_err(&edge_port->port->dev,
2437 "%s - kmalloc(%d) failed.\n", __func__, 0x100);
2438 return -ENOMEM;
2440 currCmd = cmdBuffer;
2442 /* Enable access to divisor latch */
2443 MAKE_CMD_WRITE_REG(&currCmd, &cmdLen, number, LCR, LCR_DL_ENABLE);
2445 /* Write the divisor itself */
2446 MAKE_CMD_WRITE_REG(&currCmd, &cmdLen, number, DLL, LOW8(divisor));
2447 MAKE_CMD_WRITE_REG(&currCmd, &cmdLen, number, DLM, HIGH8(divisor));
2449 /* Restore original value to disable access to divisor latch */
2450 MAKE_CMD_WRITE_REG(&currCmd, &cmdLen, number, LCR,
2451 edge_port->shadowLCR);
2453 status = write_cmd_usb(edge_port, cmdBuffer, cmdLen);
2454 if (status) {
2455 /* something bad happened, let's free up the memory */
2456 kfree(cmdBuffer);
2459 return status;
2463 /*****************************************************************************
2464 * calc_baud_rate_divisor
2465 * this function calculates the proper baud rate divisor for the specified
2466 * baud rate.
2467 *****************************************************************************/
2468 static int calc_baud_rate_divisor(int baudrate, int *divisor)
2470 int i;
2471 __u16 custom;
2474 dbg("%s - %d", __func__, baudrate);
2476 for (i = 0; i < ARRAY_SIZE(divisor_table); i++) {
2477 if (divisor_table[i].BaudRate == baudrate) {
2478 *divisor = divisor_table[i].Divisor;
2479 return 0;
2483 /* We have tried all of the standard baud rates
2484 * lets try to calculate the divisor for this baud rate
2485 * Make sure the baud rate is reasonable */
2486 if (baudrate > 50 && baudrate < 230400) {
2487 /* get divisor */
2488 custom = (__u16)((230400L + baudrate/2) / baudrate);
2490 *divisor = custom;
2492 dbg("%s - Baud %d = %d", __func__, baudrate, custom);
2493 return 0;
2496 return -1;
2500 /*****************************************************************************
2501 * send_cmd_write_uart_register
2502 * this function builds up a uart register message and sends to the device.
2503 *****************************************************************************/
2504 static int send_cmd_write_uart_register(struct edgeport_port *edge_port,
2505 __u8 regNum, __u8 regValue)
2507 struct edgeport_serial *edge_serial =
2508 usb_get_serial_data(edge_port->port->serial);
2509 unsigned char *cmdBuffer;
2510 unsigned char *currCmd;
2511 unsigned long cmdLen = 0;
2512 int status;
2514 dbg("%s - write to %s register 0x%02x",
2515 (regNum == MCR) ? "MCR" : "LCR", __func__, regValue);
2517 if (edge_serial->is_epic &&
2518 !edge_serial->epic_descriptor.Supports.IOSPWriteMCR &&
2519 regNum == MCR) {
2520 dbg("SendCmdWriteUartReg - Not writing to MCR Register");
2521 return 0;
2524 if (edge_serial->is_epic &&
2525 !edge_serial->epic_descriptor.Supports.IOSPWriteLCR &&
2526 regNum == LCR) {
2527 dbg("SendCmdWriteUartReg - Not writing to LCR Register");
2528 return 0;
2531 /* Alloc memory for the string of commands. */
2532 cmdBuffer = kmalloc(0x10, GFP_ATOMIC);
2533 if (cmdBuffer == NULL)
2534 return -ENOMEM;
2536 currCmd = cmdBuffer;
2538 /* Build a cmd in the buffer to write the given register */
2539 MAKE_CMD_WRITE_REG(&currCmd, &cmdLen,
2540 edge_port->port->number - edge_port->port->serial->minor,
2541 regNum, regValue);
2543 status = write_cmd_usb(edge_port, cmdBuffer, cmdLen);
2544 if (status) {
2545 /* something bad happened, let's free up the memory */
2546 kfree(cmdBuffer);
2549 return status;
2553 /*****************************************************************************
2554 * change_port_settings
2555 * This routine is called to set the UART on the device to match the
2556 * specified new settings.
2557 *****************************************************************************/
2559 static void change_port_settings(struct tty_struct *tty,
2560 struct edgeport_port *edge_port, struct ktermios *old_termios)
2562 struct edgeport_serial *edge_serial =
2563 usb_get_serial_data(edge_port->port->serial);
2564 int baud;
2565 unsigned cflag;
2566 __u8 mask = 0xff;
2567 __u8 lData;
2568 __u8 lParity;
2569 __u8 lStop;
2570 __u8 rxFlow;
2571 __u8 txFlow;
2572 int status;
2574 dbg("%s - port %d", __func__, edge_port->port->number);
2576 if (!edge_port->open &&
2577 !edge_port->openPending) {
2578 dbg("%s - port not opened", __func__);
2579 return;
2582 cflag = tty->termios->c_cflag;
2584 switch (cflag & CSIZE) {
2585 case CS5:
2586 lData = LCR_BITS_5; mask = 0x1f;
2587 dbg("%s - data bits = 5", __func__);
2588 break;
2589 case CS6:
2590 lData = LCR_BITS_6; mask = 0x3f;
2591 dbg("%s - data bits = 6", __func__);
2592 break;
2593 case CS7:
2594 lData = LCR_BITS_7; mask = 0x7f;
2595 dbg("%s - data bits = 7", __func__);
2596 break;
2597 default:
2598 case CS8:
2599 lData = LCR_BITS_8;
2600 dbg("%s - data bits = 8", __func__);
2601 break;
2604 lParity = LCR_PAR_NONE;
2605 if (cflag & PARENB) {
2606 if (cflag & CMSPAR) {
2607 if (cflag & PARODD) {
2608 lParity = LCR_PAR_MARK;
2609 dbg("%s - parity = mark", __func__);
2610 } else {
2611 lParity = LCR_PAR_SPACE;
2612 dbg("%s - parity = space", __func__);
2614 } else if (cflag & PARODD) {
2615 lParity = LCR_PAR_ODD;
2616 dbg("%s - parity = odd", __func__);
2617 } else {
2618 lParity = LCR_PAR_EVEN;
2619 dbg("%s - parity = even", __func__);
2621 } else {
2622 dbg("%s - parity = none", __func__);
2625 if (cflag & CSTOPB) {
2626 lStop = LCR_STOP_2;
2627 dbg("%s - stop bits = 2", __func__);
2628 } else {
2629 lStop = LCR_STOP_1;
2630 dbg("%s - stop bits = 1", __func__);
2633 /* figure out the flow control settings */
2634 rxFlow = txFlow = 0x00;
2635 if (cflag & CRTSCTS) {
2636 rxFlow |= IOSP_RX_FLOW_RTS;
2637 txFlow |= IOSP_TX_FLOW_CTS;
2638 dbg("%s - RTS/CTS is enabled", __func__);
2639 } else {
2640 dbg("%s - RTS/CTS is disabled", __func__);
2643 /* if we are implementing XON/XOFF, set the start and stop character
2644 in the device */
2645 if (I_IXOFF(tty) || I_IXON(tty)) {
2646 unsigned char stop_char = STOP_CHAR(tty);
2647 unsigned char start_char = START_CHAR(tty);
2649 if ((!edge_serial->is_epic) ||
2650 ((edge_serial->is_epic) &&
2651 (edge_serial->epic_descriptor.Supports.IOSPSetXChar))) {
2652 send_iosp_ext_cmd(edge_port,
2653 IOSP_CMD_SET_XON_CHAR, start_char);
2654 send_iosp_ext_cmd(edge_port,
2655 IOSP_CMD_SET_XOFF_CHAR, stop_char);
2658 /* if we are implementing INBOUND XON/XOFF */
2659 if (I_IXOFF(tty)) {
2660 rxFlow |= IOSP_RX_FLOW_XON_XOFF;
2661 dbg("%s - INBOUND XON/XOFF is enabled, XON = %2x, XOFF = %2x",
2662 __func__, start_char, stop_char);
2663 } else {
2664 dbg("%s - INBOUND XON/XOFF is disabled", __func__);
2667 /* if we are implementing OUTBOUND XON/XOFF */
2668 if (I_IXON(tty)) {
2669 txFlow |= IOSP_TX_FLOW_XON_XOFF;
2670 dbg("%s - OUTBOUND XON/XOFF is enabled, XON = %2x, XOFF = %2x",
2671 __func__, start_char, stop_char);
2672 } else {
2673 dbg("%s - OUTBOUND XON/XOFF is disabled", __func__);
2677 /* Set flow control to the configured value */
2678 if ((!edge_serial->is_epic) ||
2679 ((edge_serial->is_epic) &&
2680 (edge_serial->epic_descriptor.Supports.IOSPSetRxFlow)))
2681 send_iosp_ext_cmd(edge_port, IOSP_CMD_SET_RX_FLOW, rxFlow);
2682 if ((!edge_serial->is_epic) ||
2683 ((edge_serial->is_epic) &&
2684 (edge_serial->epic_descriptor.Supports.IOSPSetTxFlow)))
2685 send_iosp_ext_cmd(edge_port, IOSP_CMD_SET_TX_FLOW, txFlow);
2688 edge_port->shadowLCR &= ~(LCR_BITS_MASK | LCR_STOP_MASK | LCR_PAR_MASK);
2689 edge_port->shadowLCR |= (lData | lParity | lStop);
2691 edge_port->validDataMask = mask;
2693 /* Send the updated LCR value to the EdgePort */
2694 status = send_cmd_write_uart_register(edge_port, LCR,
2695 edge_port->shadowLCR);
2696 if (status != 0)
2697 return;
2699 /* set up the MCR register and send it to the EdgePort */
2700 edge_port->shadowMCR = MCR_MASTER_IE;
2701 if (cflag & CBAUD)
2702 edge_port->shadowMCR |= (MCR_DTR | MCR_RTS);
2704 status = send_cmd_write_uart_register(edge_port, MCR,
2705 edge_port->shadowMCR);
2706 if (status != 0)
2707 return;
2709 /* Determine divisor based on baud rate */
2710 baud = tty_get_baud_rate(tty);
2711 if (!baud) {
2712 /* pick a default, any default... */
2713 baud = 9600;
2716 dbg("%s - baud rate = %d", __func__, baud);
2717 status = send_cmd_write_baud_rate(edge_port, baud);
2718 if (status == -1) {
2719 /* Speed change was not possible - put back the old speed */
2720 baud = tty_termios_baud_rate(old_termios);
2721 tty_encode_baud_rate(tty, baud, baud);
2723 return;
2727 /****************************************************************************
2728 * unicode_to_ascii
2729 * Turns a string from Unicode into ASCII.
2730 * Doesn't do a good job with any characters that are outside the normal
2731 * ASCII range, but it's only for debugging...
2732 * NOTE: expects the unicode in LE format
2733 ****************************************************************************/
2734 static void unicode_to_ascii(char *string, int buflen,
2735 __le16 *unicode, int unicode_size)
2737 int i;
2739 if (buflen <= 0) /* never happens, but... */
2740 return;
2741 --buflen; /* space for nul */
2743 for (i = 0; i < unicode_size; i++) {
2744 if (i >= buflen)
2745 break;
2746 string[i] = (char)(le16_to_cpu(unicode[i]));
2748 string[i] = 0x00;
2752 /****************************************************************************
2753 * get_manufacturing_desc
2754 * reads in the manufacturing descriptor and stores it into the serial
2755 * structure.
2756 ****************************************************************************/
2757 static void get_manufacturing_desc(struct edgeport_serial *edge_serial)
2759 int response;
2761 dbg("getting manufacturer descriptor");
2763 response = rom_read(edge_serial->serial,
2764 (EDGE_MANUF_DESC_ADDR & 0xffff0000) >> 16,
2765 (__u16)(EDGE_MANUF_DESC_ADDR & 0x0000ffff),
2766 EDGE_MANUF_DESC_LEN,
2767 (__u8 *)(&edge_serial->manuf_descriptor));
2769 if (response < 1)
2770 dev_err(&edge_serial->serial->dev->dev,
2771 "error in getting manufacturer descriptor\n");
2772 else {
2773 char string[30];
2774 dbg("**Manufacturer Descriptor");
2775 dbg(" RomSize: %dK",
2776 edge_serial->manuf_descriptor.RomSize);
2777 dbg(" RamSize: %dK",
2778 edge_serial->manuf_descriptor.RamSize);
2779 dbg(" CpuRev: %d",
2780 edge_serial->manuf_descriptor.CpuRev);
2781 dbg(" BoardRev: %d",
2782 edge_serial->manuf_descriptor.BoardRev);
2783 dbg(" NumPorts: %d",
2784 edge_serial->manuf_descriptor.NumPorts);
2785 dbg(" DescDate: %d/%d/%d",
2786 edge_serial->manuf_descriptor.DescDate[0],
2787 edge_serial->manuf_descriptor.DescDate[1],
2788 edge_serial->manuf_descriptor.DescDate[2]+1900);
2789 unicode_to_ascii(string, sizeof(string),
2790 edge_serial->manuf_descriptor.SerialNumber,
2791 edge_serial->manuf_descriptor.SerNumLength/2);
2792 dbg(" SerialNumber: %s", string);
2793 unicode_to_ascii(string, sizeof(string),
2794 edge_serial->manuf_descriptor.AssemblyNumber,
2795 edge_serial->manuf_descriptor.AssemblyNumLength/2);
2796 dbg(" AssemblyNumber: %s", string);
2797 unicode_to_ascii(string, sizeof(string),
2798 edge_serial->manuf_descriptor.OemAssyNumber,
2799 edge_serial->manuf_descriptor.OemAssyNumLength/2);
2800 dbg(" OemAssyNumber: %s", string);
2801 dbg(" UartType: %d",
2802 edge_serial->manuf_descriptor.UartType);
2803 dbg(" IonPid: %d",
2804 edge_serial->manuf_descriptor.IonPid);
2805 dbg(" IonConfig: %d",
2806 edge_serial->manuf_descriptor.IonConfig);
2811 /****************************************************************************
2812 * get_boot_desc
2813 * reads in the bootloader descriptor and stores it into the serial
2814 * structure.
2815 ****************************************************************************/
2816 static void get_boot_desc(struct edgeport_serial *edge_serial)
2818 int response;
2820 dbg("getting boot descriptor");
2822 response = rom_read(edge_serial->serial,
2823 (EDGE_BOOT_DESC_ADDR & 0xffff0000) >> 16,
2824 (__u16)(EDGE_BOOT_DESC_ADDR & 0x0000ffff),
2825 EDGE_BOOT_DESC_LEN,
2826 (__u8 *)(&edge_serial->boot_descriptor));
2828 if (response < 1)
2829 dev_err(&edge_serial->serial->dev->dev,
2830 "error in getting boot descriptor\n");
2831 else {
2832 dbg("**Boot Descriptor:");
2833 dbg(" BootCodeLength: %d",
2834 le16_to_cpu(edge_serial->boot_descriptor.BootCodeLength));
2835 dbg(" MajorVersion: %d",
2836 edge_serial->boot_descriptor.MajorVersion);
2837 dbg(" MinorVersion: %d",
2838 edge_serial->boot_descriptor.MinorVersion);
2839 dbg(" BuildNumber: %d",
2840 le16_to_cpu(edge_serial->boot_descriptor.BuildNumber));
2841 dbg(" Capabilities: 0x%x",
2842 le16_to_cpu(edge_serial->boot_descriptor.Capabilities));
2843 dbg(" UConfig0: %d",
2844 edge_serial->boot_descriptor.UConfig0);
2845 dbg(" UConfig1: %d",
2846 edge_serial->boot_descriptor.UConfig1);
2851 /****************************************************************************
2852 * load_application_firmware
2853 * This is called to load the application firmware to the device
2854 ****************************************************************************/
2855 static void load_application_firmware(struct edgeport_serial *edge_serial)
2857 const struct ihex_binrec *rec;
2858 const struct firmware *fw;
2859 const char *fw_name;
2860 const char *fw_info;
2861 int response;
2862 __u32 Operaddr;
2863 __u16 build;
2865 switch (edge_serial->product_info.iDownloadFile) {
2866 case EDGE_DOWNLOAD_FILE_I930:
2867 fw_info = "downloading firmware version (930)";
2868 fw_name = "edgeport/down.fw";
2869 break;
2871 case EDGE_DOWNLOAD_FILE_80251:
2872 fw_info = "downloading firmware version (80251)";
2873 fw_name = "edgeport/down2.fw";
2874 break;
2876 case EDGE_DOWNLOAD_FILE_NONE:
2877 dbg("No download file specified, skipping download");
2878 return;
2880 default:
2881 return;
2884 response = request_ihex_firmware(&fw, fw_name,
2885 &edge_serial->serial->dev->dev);
2886 if (response) {
2887 printk(KERN_ERR "Failed to load image \"%s\" err %d\n",
2888 fw_name, response);
2889 return;
2892 rec = (const struct ihex_binrec *)fw->data;
2893 build = (rec->data[2] << 8) | rec->data[3];
2895 dbg("%s %d.%d.%d", fw_info, rec->data[0], rec->data[1], build);
2897 edge_serial->product_info.FirmwareMajorVersion = fw->data[0];
2898 edge_serial->product_info.FirmwareMinorVersion = fw->data[1];
2899 edge_serial->product_info.FirmwareBuildNumber = cpu_to_le16(build);
2901 for (rec = ihex_next_binrec(rec); rec;
2902 rec = ihex_next_binrec(rec)) {
2903 Operaddr = be32_to_cpu(rec->addr);
2904 response = sram_write(edge_serial->serial,
2905 Operaddr >> 16,
2906 Operaddr & 0xFFFF,
2907 be16_to_cpu(rec->len),
2908 &rec->data[0]);
2909 if (response < 0) {
2910 dev_err(&edge_serial->serial->dev->dev,
2911 "sram_write failed (%x, %x, %d)\n",
2912 Operaddr >> 16, Operaddr & 0xFFFF,
2913 be16_to_cpu(rec->len));
2914 break;
2918 dbg("sending exec_dl_code");
2919 response = usb_control_msg (edge_serial->serial->dev,
2920 usb_sndctrlpipe(edge_serial->serial->dev, 0),
2921 USB_REQUEST_ION_EXEC_DL_CODE,
2922 0x40, 0x4000, 0x0001, NULL, 0, 3000);
2924 release_firmware(fw);
2925 return;
2929 /****************************************************************************
2930 * edge_startup
2931 ****************************************************************************/
2932 static int edge_startup(struct usb_serial *serial)
2934 struct edgeport_serial *edge_serial;
2935 struct edgeport_port *edge_port;
2936 struct usb_device *dev;
2937 int i, j;
2938 int response;
2939 bool interrupt_in_found;
2940 bool bulk_in_found;
2941 bool bulk_out_found;
2942 static __u32 descriptor[3] = { EDGE_COMPATIBILITY_MASK0,
2943 EDGE_COMPATIBILITY_MASK1,
2944 EDGE_COMPATIBILITY_MASK2 };
2946 dev = serial->dev;
2948 /* create our private serial structure */
2949 edge_serial = kzalloc(sizeof(struct edgeport_serial), GFP_KERNEL);
2950 if (edge_serial == NULL) {
2951 dev_err(&serial->dev->dev, "%s - Out of memory\n", __func__);
2952 return -ENOMEM;
2954 spin_lock_init(&edge_serial->es_lock);
2955 edge_serial->serial = serial;
2956 usb_set_serial_data(serial, edge_serial);
2958 /* get the name for the device from the device */
2959 i = usb_string(dev, dev->descriptor.iManufacturer,
2960 &edge_serial->name[0], MAX_NAME_LEN+1);
2961 if (i < 0)
2962 i = 0;
2963 edge_serial->name[i++] = ' ';
2964 usb_string(dev, dev->descriptor.iProduct,
2965 &edge_serial->name[i], MAX_NAME_LEN+2 - i);
2967 dev_info(&serial->dev->dev, "%s detected\n", edge_serial->name);
2969 /* Read the epic descriptor */
2970 if (get_epic_descriptor(edge_serial) <= 0) {
2971 /* memcpy descriptor to Supports structures */
2972 memcpy(&edge_serial->epic_descriptor.Supports, descriptor,
2973 sizeof(struct edge_compatibility_bits));
2975 /* get the manufacturing descriptor for this device */
2976 get_manufacturing_desc(edge_serial);
2978 /* get the boot descriptor */
2979 get_boot_desc(edge_serial);
2981 get_product_info(edge_serial);
2984 /* set the number of ports from the manufacturing description */
2985 /* serial->num_ports = serial->product_info.NumPorts; */
2986 if ((!edge_serial->is_epic) &&
2987 (edge_serial->product_info.NumPorts != serial->num_ports)) {
2988 dev_warn(&serial->dev->dev, "Device Reported %d serial ports "
2989 "vs. core thinking we have %d ports, email "
2990 "greg@kroah.com this information.\n",
2991 edge_serial->product_info.NumPorts,
2992 serial->num_ports);
2995 dbg("%s - time 1 %ld", __func__, jiffies);
2997 /* If not an EPiC device */
2998 if (!edge_serial->is_epic) {
2999 /* now load the application firmware into this device */
3000 load_application_firmware(edge_serial);
3002 dbg("%s - time 2 %ld", __func__, jiffies);
3004 /* Check current Edgeport EEPROM and update if necessary */
3005 update_edgeport_E2PROM(edge_serial);
3007 dbg("%s - time 3 %ld", __func__, jiffies);
3009 /* set the configuration to use #1 */
3010 /* dbg("set_configuration 1"); */
3011 /* usb_set_configuration (dev, 1); */
3013 dbg(" FirmwareMajorVersion %d.%d.%d",
3014 edge_serial->product_info.FirmwareMajorVersion,
3015 edge_serial->product_info.FirmwareMinorVersion,
3016 le16_to_cpu(edge_serial->product_info.FirmwareBuildNumber));
3018 /* we set up the pointers to the endpoints in the edge_open function,
3019 * as the structures aren't created yet. */
3021 /* set up our port private structures */
3022 for (i = 0; i < serial->num_ports; ++i) {
3023 edge_port = kmalloc(sizeof(struct edgeport_port), GFP_KERNEL);
3024 if (edge_port == NULL) {
3025 dev_err(&serial->dev->dev, "%s - Out of memory\n",
3026 __func__);
3027 for (j = 0; j < i; ++j) {
3028 kfree(usb_get_serial_port_data(serial->port[j]));
3029 usb_set_serial_port_data(serial->port[j],
3030 NULL);
3032 usb_set_serial_data(serial, NULL);
3033 kfree(edge_serial);
3034 return -ENOMEM;
3036 memset(edge_port, 0, sizeof(struct edgeport_port));
3037 spin_lock_init(&edge_port->ep_lock);
3038 edge_port->port = serial->port[i];
3039 usb_set_serial_port_data(serial->port[i], edge_port);
3042 response = 0;
3044 if (edge_serial->is_epic) {
3045 /* EPIC thing, set up our interrupt polling now and our read
3046 * urb, so that the device knows it really is connected. */
3047 interrupt_in_found = bulk_in_found = bulk_out_found = false;
3048 for (i = 0; i < serial->interface->altsetting[0]
3049 .desc.bNumEndpoints; ++i) {
3050 struct usb_endpoint_descriptor *endpoint;
3051 int buffer_size;
3053 endpoint = &serial->interface->altsetting[0].
3054 endpoint[i].desc;
3055 buffer_size = le16_to_cpu(endpoint->wMaxPacketSize);
3056 if (!interrupt_in_found &&
3057 (usb_endpoint_is_int_in(endpoint))) {
3058 /* we found a interrupt in endpoint */
3059 dbg("found interrupt in");
3061 /* not set up yet, so do it now */
3062 edge_serial->interrupt_read_urb =
3063 usb_alloc_urb(0, GFP_KERNEL);
3064 if (!edge_serial->interrupt_read_urb) {
3065 dev_err(&dev->dev, "out of memory\n");
3066 return -ENOMEM;
3068 edge_serial->interrupt_in_buffer =
3069 kmalloc(buffer_size, GFP_KERNEL);
3070 if (!edge_serial->interrupt_in_buffer) {
3071 dev_err(&dev->dev, "out of memory\n");
3072 usb_free_urb(edge_serial->interrupt_read_urb);
3073 return -ENOMEM;
3075 edge_serial->interrupt_in_endpoint =
3076 endpoint->bEndpointAddress;
3078 /* set up our interrupt urb */
3079 usb_fill_int_urb(
3080 edge_serial->interrupt_read_urb,
3081 dev,
3082 usb_rcvintpipe(dev,
3083 endpoint->bEndpointAddress),
3084 edge_serial->interrupt_in_buffer,
3085 buffer_size,
3086 edge_interrupt_callback,
3087 edge_serial,
3088 endpoint->bInterval);
3090 interrupt_in_found = true;
3093 if (!bulk_in_found &&
3094 (usb_endpoint_is_bulk_in(endpoint))) {
3095 /* we found a bulk in endpoint */
3096 dbg("found bulk in");
3098 /* not set up yet, so do it now */
3099 edge_serial->read_urb =
3100 usb_alloc_urb(0, GFP_KERNEL);
3101 if (!edge_serial->read_urb) {
3102 dev_err(&dev->dev, "out of memory\n");
3103 return -ENOMEM;
3105 edge_serial->bulk_in_buffer =
3106 kmalloc(buffer_size, GFP_KERNEL);
3107 if (!edge_serial->bulk_in_buffer) {
3108 dev_err(&dev->dev, "out of memory\n");
3109 usb_free_urb(edge_serial->read_urb);
3110 return -ENOMEM;
3112 edge_serial->bulk_in_endpoint =
3113 endpoint->bEndpointAddress;
3115 /* set up our bulk in urb */
3116 usb_fill_bulk_urb(edge_serial->read_urb, dev,
3117 usb_rcvbulkpipe(dev,
3118 endpoint->bEndpointAddress),
3119 edge_serial->bulk_in_buffer,
3120 le16_to_cpu(endpoint->wMaxPacketSize),
3121 edge_bulk_in_callback,
3122 edge_serial);
3123 bulk_in_found = true;
3126 if (!bulk_out_found &&
3127 (usb_endpoint_is_bulk_out(endpoint))) {
3128 /* we found a bulk out endpoint */
3129 dbg("found bulk out");
3130 edge_serial->bulk_out_endpoint =
3131 endpoint->bEndpointAddress;
3132 bulk_out_found = true;
3136 if (!interrupt_in_found || !bulk_in_found || !bulk_out_found) {
3137 dev_err(&dev->dev, "Error - the proper endpoints "
3138 "were not found!\n");
3139 return -ENODEV;
3142 /* start interrupt read for this edgeport this interrupt will
3143 * continue as long as the edgeport is connected */
3144 response = usb_submit_urb(edge_serial->interrupt_read_urb,
3145 GFP_KERNEL);
3146 if (response)
3147 dev_err(&dev->dev,
3148 "%s - Error %d submitting control urb\n",
3149 __func__, response);
3151 return response;
3155 /****************************************************************************
3156 * edge_disconnect
3157 * This function is called whenever the device is removed from the usb bus.
3158 ****************************************************************************/
3159 static void edge_disconnect(struct usb_serial *serial)
3161 struct edgeport_serial *edge_serial = usb_get_serial_data(serial);
3163 dbg("%s", __func__);
3165 /* stop reads and writes on all ports */
3166 /* free up our endpoint stuff */
3167 if (edge_serial->is_epic) {
3168 usb_kill_urb(edge_serial->interrupt_read_urb);
3169 usb_free_urb(edge_serial->interrupt_read_urb);
3170 kfree(edge_serial->interrupt_in_buffer);
3172 usb_kill_urb(edge_serial->read_urb);
3173 usb_free_urb(edge_serial->read_urb);
3174 kfree(edge_serial->bulk_in_buffer);
3179 /****************************************************************************
3180 * edge_release
3181 * This function is called when the device structure is deallocated.
3182 ****************************************************************************/
3183 static void edge_release(struct usb_serial *serial)
3185 struct edgeport_serial *edge_serial = usb_get_serial_data(serial);
3186 int i;
3188 dbg("%s", __func__);
3190 for (i = 0; i < serial->num_ports; ++i)
3191 kfree(usb_get_serial_port_data(serial->port[i]));
3193 kfree(edge_serial);
3197 /****************************************************************************
3198 * edgeport_init
3199 * This is called by the module subsystem, or on startup to initialize us
3200 ****************************************************************************/
3201 static int __init edgeport_init(void)
3203 int retval;
3205 retval = usb_serial_register(&edgeport_2port_device);
3206 if (retval)
3207 goto failed_2port_device_register;
3208 retval = usb_serial_register(&edgeport_4port_device);
3209 if (retval)
3210 goto failed_4port_device_register;
3211 retval = usb_serial_register(&edgeport_8port_device);
3212 if (retval)
3213 goto failed_8port_device_register;
3214 retval = usb_serial_register(&epic_device);
3215 if (retval)
3216 goto failed_epic_device_register;
3217 retval = usb_register(&io_driver);
3218 if (retval)
3219 goto failed_usb_register;
3220 atomic_set(&CmdUrbs, 0);
3221 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
3222 DRIVER_DESC "\n");
3223 return 0;
3225 failed_usb_register:
3226 usb_serial_deregister(&epic_device);
3227 failed_epic_device_register:
3228 usb_serial_deregister(&edgeport_8port_device);
3229 failed_8port_device_register:
3230 usb_serial_deregister(&edgeport_4port_device);
3231 failed_4port_device_register:
3232 usb_serial_deregister(&edgeport_2port_device);
3233 failed_2port_device_register:
3234 return retval;
3238 /****************************************************************************
3239 * edgeport_exit
3240 * Called when the driver is about to be unloaded.
3241 ****************************************************************************/
3242 static void __exit edgeport_exit (void)
3244 usb_deregister(&io_driver);
3245 usb_serial_deregister(&edgeport_2port_device);
3246 usb_serial_deregister(&edgeport_4port_device);
3247 usb_serial_deregister(&edgeport_8port_device);
3248 usb_serial_deregister(&epic_device);
3251 module_init(edgeport_init);
3252 module_exit(edgeport_exit);
3254 /* Module information */
3255 MODULE_AUTHOR(DRIVER_AUTHOR);
3256 MODULE_DESCRIPTION(DRIVER_DESC);
3257 MODULE_LICENSE("GPL");
3258 MODULE_FIRMWARE("edgeport/boot.fw");
3259 MODULE_FIRMWARE("edgeport/boot2.fw");
3260 MODULE_FIRMWARE("edgeport/down.fw");
3261 MODULE_FIRMWARE("edgeport/down2.fw");
3263 module_param(debug, bool, S_IRUGO | S_IWUSR);
3264 MODULE_PARM_DESC(debug, "Debug enabled or not");