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:
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/config.h>
33 #include <linux/kernel.h>
34 #include <linux/jiffies.h>
35 #include <linux/errno.h>
36 #include <linux/init.h>
37 #include <linux/slab.h>
38 #include <linux/tty.h>
39 #include <linux/tty_driver.h>
40 #include <linux/tty_flip.h>
41 #include <linux/module.h>
42 #include <linux/spinlock.h>
43 #include <linux/serial.h>
44 #include <linux/ioctl.h>
45 #include <linux/wait.h>
46 #include <asm/uaccess.h>
47 #include <linux/usb.h>
48 #include "usb-serial.h"
49 #include "io_edgeport.h"
50 #include "io_ionsp.h" /* info for the iosp messages */
51 #include "io_16654.h" /* 16654 UART defines */
56 #define DRIVER_VERSION "v2.7"
57 #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com> and David Iacovelli"
58 #define DRIVER_DESC "Edgeport USB Serial Driver"
60 /* First, the latest boot code - for first generation edgeports */
61 #define IMAGE_ARRAY_NAME BootCodeImage_GEN1
62 #define IMAGE_VERSION_NAME BootCodeImageVersion_GEN1
63 #include "io_fw_boot.h" /* the bootloader firmware to download to a device, if it needs it */
65 /* for second generation edgeports */
66 #define IMAGE_ARRAY_NAME BootCodeImage_GEN2
67 #define IMAGE_VERSION_NAME BootCodeImageVersion_GEN2
68 #include "io_fw_boot2.h" /* the bootloader firmware to download to a device, if it needs it */
70 /* Then finally the main run-time operational code - for first generation edgeports */
71 #define IMAGE_ARRAY_NAME OperationalCodeImage_GEN1
72 #define IMAGE_VERSION_NAME OperationalCodeImageVersion_GEN1
73 #include "io_fw_down.h" /* Define array OperationalCodeImage[] */
75 /* for second generation edgeports */
76 #define IMAGE_ARRAY_NAME OperationalCodeImage_GEN2
77 #define IMAGE_VERSION_NAME OperationalCodeImageVersion_GEN2
78 #include "io_fw_down2.h" /* Define array OperationalCodeImage[] */
80 #define MAX_NAME_LEN 64
82 #define CHASE_TIMEOUT (5*HZ) /* 5 seconds */
83 #define OPEN_TIMEOUT (5*HZ) /* 5 seconds */
84 #define COMMAND_TIMEOUT (5*HZ) /* 5 seconds */
86 /* receive port state */
88 EXPECT_HDR1 = 0, /* Expect header byte 1 */
89 EXPECT_HDR2 = 1, /* Expect header byte 2 */
90 EXPECT_DATA = 2, /* Expect 'RxBytesRemaining' data */
91 EXPECT_HDR3 = 3, /* Expect header byte 3 (for status hdrs only) */
96 * This Transmit queue is an extension of the edgeport Rx buffer.
97 * The maximum amount of data buffered in both the edgeport
98 * Rx buffer (maxTxCredits) and this buffer will never exceed maxTxCredits.
101 unsigned int head; /* index to head pointer (write) */
102 unsigned int tail; /* index to tail pointer (read) */
103 unsigned int count; /* Bytes in queue */
104 unsigned int size; /* Max size of queue (equal to Max number of TxCredits) */
105 unsigned char *fifo; /* allocated Buffer */
108 /* This structure holds all of the local port information */
109 struct edgeport_port {
110 __u16 txCredits; /* our current credits for this port */
111 __u16 maxTxCredits; /* the max size of the port */
113 struct TxFifo txfifo; /* transmit fifo -- size will be maxTxCredits */
114 struct urb *write_urb; /* write URB for this port */
115 char write_in_progress; /* TRUE while a write URB is outstanding */
118 __u8 shadowLCR; /* last LCR value received */
119 __u8 shadowMCR; /* last MCR value received */
120 __u8 shadowMSR; /* last MSR value received */
121 __u8 shadowLSR; /* last LSR value received */
122 __u8 shadowXonChar; /* last value set as XON char in Edgeport */
123 __u8 shadowXoffChar; /* last value set as XOFF char in Edgeport */
131 char chaseResponsePending;
133 wait_queue_head_t wait_chase; /* for handling sleeping while waiting for chase to finish */
134 wait_queue_head_t wait_open; /* for handling sleeping while waiting for open to finish */
135 wait_queue_head_t wait_command; /* for handling sleeping while waiting for command to finish */
136 wait_queue_head_t delta_msr_wait; /* for handling sleeping while waiting for msr change to happen */
138 struct async_icount icount;
139 struct usb_serial_port *port; /* loop back to the owner of this object */
143 /* This structure holds all of the individual device information */
144 struct edgeport_serial {
145 char name[MAX_NAME_LEN+2]; /* string name of this device */
147 struct edge_manuf_descriptor manuf_descriptor; /* the manufacturer descriptor */
148 struct edge_boot_descriptor boot_descriptor; /* the boot firmware descriptor */
149 struct edgeport_product_info product_info; /* Product Info */
151 __u8 interrupt_in_endpoint; /* the interrupt endpoint handle */
152 unsigned char * interrupt_in_buffer; /* the buffer we use for the interrupt endpoint */
153 struct urb * interrupt_read_urb; /* our interrupt urb */
155 __u8 bulk_in_endpoint; /* the bulk in endpoint handle */
156 unsigned char * bulk_in_buffer; /* the buffer we use for the bulk in endpoint */
157 struct urb * read_urb; /* our bulk read urb */
158 int read_in_progress;
161 __u8 bulk_out_endpoint; /* the bulk out endpoint handle */
163 __s16 rxBytesAvail; /* the number of bytes that we need to read from this device */
165 enum RXSTATE rxState; /* the current state of the bulk receive processor */
166 __u8 rxHeader1; /* receive header byte 1 */
167 __u8 rxHeader2; /* receive header byte 2 */
168 __u8 rxHeader3; /* receive header byte 3 */
169 __u8 rxPort; /* the port that we are currently receiving data for */
170 __u8 rxStatusCode; /* the receive status code */
171 __u8 rxStatusParam; /* the receive status paramater */
172 __s16 rxBytesRemaining; /* the number of port bytes left to read */
173 struct usb_serial *serial; /* loop back to the owner of this object */
176 /* baud rate information */
177 struct divisor_table_entry {
183 // Define table of divisors for Rev A EdgePort/4 hardware
184 // These assume a 3.6864MHz crystal, the standard /16, and
187 static const struct divisor_table_entry divisor_table[] = {
190 { 110, 2095}, /* 2094.545455 => 230450 => .0217 % over */
191 { 134, 1713}, /* 1713.011152 => 230398.5 => .00065% under */
209 /* local variables */
212 static int low_latency = 1; /* tty low latency flag, on by default */
214 static int CmdUrbs = 0; /* Number of outstanding Command Write Urbs */
217 /* local function prototypes */
219 /* function prototypes for all URB callbacks */
220 static void edge_interrupt_callback (struct urb *urb, struct pt_regs *regs);
221 static void edge_bulk_in_callback (struct urb *urb, struct pt_regs *regs);
222 static void edge_bulk_out_data_callback (struct urb *urb, struct pt_regs *regs);
223 static void edge_bulk_out_cmd_callback (struct urb *urb, struct pt_regs *regs);
225 /* function prototypes for the usbserial callbacks */
226 static int edge_open (struct usb_serial_port *port, struct file *filp);
227 static void edge_close (struct usb_serial_port *port, struct file *filp);
228 static int edge_write (struct usb_serial_port *port, const unsigned char *buf, int count);
229 static int edge_write_room (struct usb_serial_port *port);
230 static int edge_chars_in_buffer (struct usb_serial_port *port);
231 static void edge_throttle (struct usb_serial_port *port);
232 static void edge_unthrottle (struct usb_serial_port *port);
233 static void edge_set_termios (struct usb_serial_port *port, struct termios *old_termios);
234 static int edge_ioctl (struct usb_serial_port *port, struct file *file, unsigned int cmd, unsigned long arg);
235 static void edge_break (struct usb_serial_port *port, int break_state);
236 static int edge_tiocmget (struct usb_serial_port *port, struct file *file);
237 static int edge_tiocmset (struct usb_serial_port *port, struct file *file, unsigned int set, unsigned int clear);
238 static int edge_startup (struct usb_serial *serial);
239 static void edge_shutdown (struct usb_serial *serial);
242 #include "io_tables.h" /* all of the devices that this driver supports */
244 static struct usb_driver io_driver = {
245 .name = "io_edgeport",
246 .probe = usb_serial_probe,
247 .disconnect = usb_serial_disconnect,
248 .id_table = id_table_combined,
252 /* function prototypes for all of our local functions */
253 static void process_rcvd_data (struct edgeport_serial *edge_serial, unsigned char *buffer, __u16 bufferLength);
254 static void process_rcvd_status (struct edgeport_serial *edge_serial, __u8 byte2, __u8 byte3);
255 static void edge_tty_recv (struct device *dev, struct tty_struct *tty, unsigned char *data, int length);
256 static void handle_new_msr (struct edgeport_port *edge_port, __u8 newMsr);
257 static void handle_new_lsr (struct edgeport_port *edge_port, __u8 lsrData, __u8 lsr, __u8 data);
258 static int send_iosp_ext_cmd (struct edgeport_port *edge_port, __u8 command, __u8 param);
259 static int calc_baud_rate_divisor (int baud_rate, int *divisor);
260 static int send_cmd_write_baud_rate (struct edgeport_port *edge_port, int baudRate);
261 static void change_port_settings (struct edgeport_port *edge_port, struct termios *old_termios);
262 static int send_cmd_write_uart_register (struct edgeport_port *edge_port, __u8 regNum, __u8 regValue);
263 static int write_cmd_usb (struct edgeport_port *edge_port, unsigned char *buffer, int writeLength);
264 static void send_more_port_data (struct edgeport_serial *edge_serial, struct edgeport_port *edge_port);
266 static int sram_write (struct usb_serial *serial, __u16 extAddr, __u16 addr, __u16 length, __u8 *data);
267 static int rom_read (struct usb_serial *serial, __u16 extAddr, __u16 addr, __u16 length, __u8 *data);
268 static int rom_write (struct usb_serial *serial, __u16 extAddr, __u16 addr, __u16 length, __u8 *data);
269 static void get_manufacturing_desc (struct edgeport_serial *edge_serial);
270 static void get_boot_desc (struct edgeport_serial *edge_serial);
271 static void load_application_firmware (struct edgeport_serial *edge_serial);
273 static void unicode_to_ascii(char *string, int buflen, __le16 *unicode, int unicode_size);
276 // ************************************************************************
277 // ************************************************************************
278 // ************************************************************************
279 // ************************************************************************
281 /************************************************************************
283 * update_edgeport_E2PROM() Compare current versions of *
284 * Boot ROM and Manufacture *
285 * Descriptors with versions *
286 * embedded in this driver *
288 ************************************************************************/
289 static void update_edgeport_E2PROM (struct edgeport_serial *edge_serial)
293 __u8 BootMajorVersion;
294 __u8 BootMinorVersion;
295 __le16 BootBuildNumber;
298 struct edge_firmware_image_record *record;
299 unsigned char *firmware;
303 switch (edge_serial->product_info.iDownloadFile) {
304 case EDGE_DOWNLOAD_FILE_I930:
305 BootMajorVersion = BootCodeImageVersion_GEN1.MajorVersion;
306 BootMinorVersion = BootCodeImageVersion_GEN1.MinorVersion;
307 BootBuildNumber = cpu_to_le16(BootCodeImageVersion_GEN1.BuildNumber);
308 BootImage = &BootCodeImage_GEN1[0];
309 BootSize = sizeof( BootCodeImage_GEN1 );
312 case EDGE_DOWNLOAD_FILE_80251:
313 BootMajorVersion = BootCodeImageVersion_GEN2.MajorVersion;
314 BootMinorVersion = BootCodeImageVersion_GEN2.MinorVersion;
315 BootBuildNumber = cpu_to_le16(BootCodeImageVersion_GEN2.BuildNumber);
316 BootImage = &BootCodeImage_GEN2[0];
317 BootSize = sizeof( BootCodeImage_GEN2 );
324 // Check Boot Image Version
325 BootCurVer = (edge_serial->boot_descriptor.MajorVersion << 24) +
326 (edge_serial->boot_descriptor.MinorVersion << 16) +
327 le16_to_cpu(edge_serial->boot_descriptor.BuildNumber);
329 BootNewVer = (BootMajorVersion << 24) +
330 (BootMinorVersion << 16) +
331 le16_to_cpu(BootBuildNumber);
333 dbg("Current Boot Image version %d.%d.%d",
334 edge_serial->boot_descriptor.MajorVersion,
335 edge_serial->boot_descriptor.MinorVersion,
336 le16_to_cpu(edge_serial->boot_descriptor.BuildNumber));
339 if (BootNewVer > BootCurVer) {
340 dbg("**Update Boot Image from %d.%d.%d to %d.%d.%d",
341 edge_serial->boot_descriptor.MajorVersion,
342 edge_serial->boot_descriptor.MinorVersion,
343 le16_to_cpu(edge_serial->boot_descriptor.BuildNumber),
346 le16_to_cpu(BootBuildNumber));
349 dbg("Downloading new Boot Image");
351 firmware = BootImage;
354 record = (struct edge_firmware_image_record *)firmware;
355 response = rom_write (edge_serial->serial, le16_to_cpu(record->ExtAddr), le16_to_cpu(record->Addr), le16_to_cpu(record->Len), &record->Data[0]);
357 dev_err(&edge_serial->serial->dev->dev, "rom_write failed (%x, %x, %d)\n", le16_to_cpu(record->ExtAddr), le16_to_cpu(record->Addr), le16_to_cpu(record->Len));
360 firmware += sizeof (struct edge_firmware_image_record) + le16_to_cpu(record->Len);
361 if (firmware >= &BootImage[BootSize]) {
366 dbg("Boot Image -- already up to date");
371 /************************************************************************
373 * Get string descriptor from device *
375 ************************************************************************/
376 static int get_string (struct usb_device *dev, int Id, char *string, int buflen)
378 struct usb_string_descriptor StringDesc;
379 struct usb_string_descriptor *pStringDesc;
381 dbg("%s - USB String ID = %d", __FUNCTION__, Id );
383 if (!usb_get_descriptor(dev, USB_DT_STRING, Id, &StringDesc, sizeof(StringDesc))) {
387 pStringDesc = kmalloc (StringDesc.bLength, GFP_KERNEL);
393 if (!usb_get_descriptor(dev, USB_DT_STRING, Id, pStringDesc, StringDesc.bLength )) {
398 unicode_to_ascii(string, buflen, pStringDesc->wData, pStringDesc->bLength/2);
401 return strlen(string);
406 /************************************************************************
408 * Get string descriptor from device
410 ************************************************************************/
411 static int get_string_desc (struct usb_device *dev, int Id, struct usb_string_descriptor **pRetDesc)
413 struct usb_string_descriptor StringDesc;
414 struct usb_string_descriptor *pStringDesc;
416 dbg("%s - USB String ID = %d", __FUNCTION__, Id );
418 if (!usb_get_descriptor(dev, USB_DT_STRING, Id, &StringDesc, sizeof(StringDesc))) {
422 pStringDesc = kmalloc (StringDesc.bLength, GFP_KERNEL);
428 if (!usb_get_descriptor(dev, USB_DT_STRING, Id, pStringDesc, StringDesc.bLength )) {
433 *pRetDesc = pStringDesc;
438 static void get_product_info(struct edgeport_serial *edge_serial)
440 struct edgeport_product_info *product_info = &edge_serial->product_info;
442 memset (product_info, 0, sizeof(struct edgeport_product_info));
444 product_info->ProductId = (__u16)(le16_to_cpu(edge_serial->serial->dev->descriptor.idProduct) & ~ION_DEVICE_ID_80251_NETCHIP);
445 product_info->NumPorts = edge_serial->manuf_descriptor.NumPorts;
446 product_info->ProdInfoVer = 0;
448 product_info->RomSize = edge_serial->manuf_descriptor.RomSize;
449 product_info->RamSize = edge_serial->manuf_descriptor.RamSize;
450 product_info->CpuRev = edge_serial->manuf_descriptor.CpuRev;
451 product_info->BoardRev = edge_serial->manuf_descriptor.BoardRev;
453 product_info->BootMajorVersion = edge_serial->boot_descriptor.MajorVersion;
454 product_info->BootMinorVersion = edge_serial->boot_descriptor.MinorVersion;
455 product_info->BootBuildNumber = edge_serial->boot_descriptor.BuildNumber;
457 memcpy(product_info->ManufactureDescDate, edge_serial->manuf_descriptor.DescDate, sizeof(edge_serial->manuf_descriptor.DescDate));
459 // check if this is 2nd generation hardware
460 if (le16_to_cpu(edge_serial->serial->dev->descriptor.idProduct) & ION_DEVICE_ID_80251_NETCHIP) {
461 product_info->FirmwareMajorVersion = OperationalCodeImageVersion_GEN2.MajorVersion;
462 product_info->FirmwareMinorVersion = OperationalCodeImageVersion_GEN2.MinorVersion;
463 product_info->FirmwareBuildNumber = cpu_to_le16(OperationalCodeImageVersion_GEN2.BuildNumber);
464 product_info->iDownloadFile = EDGE_DOWNLOAD_FILE_80251;
466 product_info->FirmwareMajorVersion = OperationalCodeImageVersion_GEN1.MajorVersion;
467 product_info->FirmwareMinorVersion = OperationalCodeImageVersion_GEN1.MinorVersion;
468 product_info->FirmwareBuildNumber = cpu_to_le16(OperationalCodeImageVersion_GEN1.BuildNumber);
469 product_info->iDownloadFile = EDGE_DOWNLOAD_FILE_I930;
472 // Determine Product type and set appropriate flags
473 switch (DEVICE_ID_FROM_USB_PRODUCT_ID(product_info->ProductId)) {
474 case ION_DEVICE_ID_EDGEPORT_COMPATIBLE:
475 case ION_DEVICE_ID_EDGEPORT_4T:
476 case ION_DEVICE_ID_EDGEPORT_4:
477 case ION_DEVICE_ID_EDGEPORT_2:
478 case ION_DEVICE_ID_EDGEPORT_8_DUAL_CPU:
479 case ION_DEVICE_ID_EDGEPORT_8:
480 case ION_DEVICE_ID_EDGEPORT_421:
481 case ION_DEVICE_ID_EDGEPORT_21:
482 case ION_DEVICE_ID_EDGEPORT_2_DIN:
483 case ION_DEVICE_ID_EDGEPORT_4_DIN:
484 case ION_DEVICE_ID_EDGEPORT_16_DUAL_CPU:
485 product_info->IsRS232 = 1;
488 case ION_DEVICE_ID_EDGEPORT_2I: // Edgeport/2 RS422/RS485
489 product_info->IsRS422 = 1;
490 product_info->IsRS485 = 1;
493 case ION_DEVICE_ID_EDGEPORT_8I: // Edgeport/4 RS422
494 case ION_DEVICE_ID_EDGEPORT_4I: // Edgeport/4 RS422
495 product_info->IsRS422 = 1;
499 // Dump Product Info structure
500 dbg("**Product Information:");
501 dbg(" ProductId %x", product_info->ProductId );
502 dbg(" NumPorts %d", product_info->NumPorts );
503 dbg(" ProdInfoVer %d", product_info->ProdInfoVer );
504 dbg(" IsServer %d", product_info->IsServer);
505 dbg(" IsRS232 %d", product_info->IsRS232 );
506 dbg(" IsRS422 %d", product_info->IsRS422 );
507 dbg(" IsRS485 %d", product_info->IsRS485 );
508 dbg(" RomSize %d", product_info->RomSize );
509 dbg(" RamSize %d", product_info->RamSize );
510 dbg(" CpuRev %x", product_info->CpuRev );
511 dbg(" BoardRev %x", product_info->BoardRev);
512 dbg(" BootMajorVersion %d.%d.%d", product_info->BootMajorVersion,
513 product_info->BootMinorVersion,
514 le16_to_cpu(product_info->BootBuildNumber));
515 dbg(" FirmwareMajorVersion %d.%d.%d", product_info->FirmwareMajorVersion,
516 product_info->FirmwareMinorVersion,
517 le16_to_cpu(product_info->FirmwareBuildNumber));
518 dbg(" ManufactureDescDate %d/%d/%d", product_info->ManufactureDescDate[0],
519 product_info->ManufactureDescDate[1],
520 product_info->ManufactureDescDate[2]+1900);
521 dbg(" iDownloadFile 0x%x", product_info->iDownloadFile);
526 /************************************************************************/
527 /************************************************************************/
528 /* U S B C A L L B A C K F U N C T I O N S */
529 /* U S B C A L L B A C K F U N C T I O N S */
530 /************************************************************************/
531 /************************************************************************/
533 /*****************************************************************************
534 * edge_interrupt_callback
535 * this is the callback function for when we have received data on the
536 * interrupt endpoint.
537 *****************************************************************************/
538 static void edge_interrupt_callback (struct urb *urb, struct pt_regs *regs)
540 struct edgeport_serial *edge_serial = (struct edgeport_serial *)urb->context;
541 struct edgeport_port *edge_port;
542 struct usb_serial_port *port;
543 unsigned char *data = urb->transfer_buffer;
544 int length = urb->actual_length;
551 dbg("%s", __FUNCTION__);
553 switch (urb->status) {
560 /* this urb is terminated, clean up */
561 dbg("%s - urb shutting down with status: %d", __FUNCTION__, urb->status);
564 dbg("%s - nonzero urb status received: %d", __FUNCTION__, urb->status);
568 // process this interrupt-read even if there are no ports open
570 usb_serial_debug_data(debug, &edge_serial->serial->dev->dev, __FUNCTION__, length, data);
573 bytes_avail = data[0] | (data[1] << 8);
575 spin_lock(&edge_serial->es_lock);
576 edge_serial->rxBytesAvail += bytes_avail;
577 dbg("%s - bytes_avail=%d, rxBytesAvail=%d, read_in_progress=%d", __FUNCTION__, bytes_avail, edge_serial->rxBytesAvail, edge_serial->read_in_progress);
579 if (edge_serial->rxBytesAvail > 0 &&
580 !edge_serial->read_in_progress) {
581 dbg("%s - posting a read", __FUNCTION__);
582 edge_serial->read_in_progress = TRUE;
584 /* we have pending bytes on the bulk in pipe, send a request */
585 edge_serial->read_urb->dev = edge_serial->serial->dev;
586 result = usb_submit_urb(edge_serial->read_urb, GFP_ATOMIC);
588 dev_err(&edge_serial->serial->dev->dev, "%s - usb_submit_urb(read bulk) failed with result = %d\n", __FUNCTION__, result);
589 edge_serial->read_in_progress = FALSE;
592 spin_unlock(&edge_serial->es_lock);
595 /* grab the txcredits for the ports if available */
598 while ((position < length) && (portNumber < edge_serial->serial->num_ports)) {
599 txCredits = data[position] | (data[position+1] << 8);
601 port = edge_serial->serial->port[portNumber];
602 edge_port = usb_get_serial_port_data(port);
603 if (edge_port->open) {
604 spin_lock(&edge_port->ep_lock);
605 edge_port->txCredits += txCredits;
606 spin_unlock(&edge_port->ep_lock);
607 dbg("%s - txcredits for port%d = %d", __FUNCTION__, portNumber, edge_port->txCredits);
609 /* tell the tty driver that something has changed */
610 if (edge_port->port->tty)
611 tty_wakeup(edge_port->port->tty);
613 // Since we have more credit, check if more data can be sent
614 send_more_port_data(edge_serial, edge_port);
623 result = usb_submit_urb (urb, GFP_ATOMIC);
625 dev_err(&urb->dev->dev, "%s - Error %d submitting control urb\n", __FUNCTION__, result);
630 /*****************************************************************************
631 * edge_bulk_in_callback
632 * this is the callback function for when we have received data on the
634 *****************************************************************************/
635 static void edge_bulk_in_callback (struct urb *urb, struct pt_regs *regs)
637 struct edgeport_serial *edge_serial = (struct edgeport_serial *)urb->context;
638 unsigned char *data = urb->transfer_buffer;
640 __u16 raw_data_length;
642 dbg("%s", __FUNCTION__);
645 dbg("%s - nonzero read bulk status received: %d", __FUNCTION__, urb->status);
646 edge_serial->read_in_progress = FALSE;
650 if (urb->actual_length == 0) {
651 dbg("%s - read bulk callback with no data", __FUNCTION__);
652 edge_serial->read_in_progress = FALSE;
656 raw_data_length = urb->actual_length;
658 usb_serial_debug_data(debug, &edge_serial->serial->dev->dev, __FUNCTION__, raw_data_length, data);
660 spin_lock(&edge_serial->es_lock);
662 /* decrement our rxBytes available by the number that we just got */
663 edge_serial->rxBytesAvail -= raw_data_length;
665 dbg("%s - Received = %d, rxBytesAvail %d", __FUNCTION__, raw_data_length, edge_serial->rxBytesAvail);
667 process_rcvd_data (edge_serial, data, urb->actual_length);
669 /* check to see if there's any more data for us to read */
670 if (edge_serial->rxBytesAvail > 0) {
671 dbg("%s - posting a read", __FUNCTION__);
672 edge_serial->read_urb->dev = edge_serial->serial->dev;
673 status = usb_submit_urb(edge_serial->read_urb, GFP_ATOMIC);
675 dev_err(&urb->dev->dev, "%s - usb_submit_urb(read bulk) failed, status = %d\n", __FUNCTION__, status);
676 edge_serial->read_in_progress = FALSE;
679 edge_serial->read_in_progress = FALSE;
682 spin_unlock(&edge_serial->es_lock);
686 /*****************************************************************************
687 * edge_bulk_out_data_callback
688 * this is the callback function for when we have finished sending serial data
689 * on the bulk out endpoint.
690 *****************************************************************************/
691 static void edge_bulk_out_data_callback (struct urb *urb, struct pt_regs *regs)
693 struct edgeport_port *edge_port = (struct edgeport_port *)urb->context;
694 struct tty_struct *tty;
696 dbg("%s", __FUNCTION__);
699 dbg("%s - nonzero write bulk status received: %d", __FUNCTION__, urb->status);
702 tty = edge_port->port->tty;
704 if (tty && edge_port->open) {
705 /* let the tty driver wakeup if it has a special write_wakeup function */
709 // Release the Write URB
710 edge_port->write_in_progress = FALSE;
712 // Check if more data needs to be sent
713 send_more_port_data((struct edgeport_serial *)(usb_get_serial_data(edge_port->port->serial)), edge_port);
717 /*****************************************************************************
719 * this is the callback function for when we have finished sending a command
720 * on the bulk out endpoint.
721 *****************************************************************************/
722 static void edge_bulk_out_cmd_callback (struct urb *urb, struct pt_regs *regs)
724 struct edgeport_port *edge_port = (struct edgeport_port *)urb->context;
725 struct tty_struct *tty;
726 int status = urb->status;
728 dbg("%s", __FUNCTION__);
731 dbg("%s - FREE URB %p (outstanding %d)", __FUNCTION__, urb, CmdUrbs);
734 /* clean up the transfer buffer */
735 kfree(urb->transfer_buffer);
737 /* Free the command urb */
741 dbg("%s - nonzero write bulk status received: %d", __FUNCTION__, status);
745 /* Get pointer to tty */
746 tty = edge_port->port->tty;
748 /* tell the tty driver that something has changed */
749 if (tty && edge_port->open)
752 /* we have completed the command */
753 edge_port->commandPending = FALSE;
754 wake_up(&edge_port->wait_command);
758 /*****************************************************************************
759 * Driver tty interface functions
760 *****************************************************************************/
762 /*****************************************************************************
764 * this function is called by the tty driver when a port is opened
765 * If successful, we return 0
766 * Otherwise we return a negative error number.
767 *****************************************************************************/
768 static int edge_open (struct usb_serial_port *port, struct file * filp)
770 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
771 struct usb_serial *serial;
772 struct edgeport_serial *edge_serial;
775 dbg("%s - port %d", __FUNCTION__, port->number);
777 if (edge_port == NULL)
781 port->tty->low_latency = low_latency;
783 /* see if we've set up our endpoint info yet (can't set it up in edge_startup
784 as the structures were not set up at that time.) */
785 serial = port->serial;
786 edge_serial = usb_get_serial_data(serial);
787 if (edge_serial == NULL) {
790 if (edge_serial->interrupt_in_buffer == NULL) {
791 struct usb_serial_port *port0 = serial->port[0];
793 /* not set up yet, so do it now */
794 edge_serial->interrupt_in_buffer = port0->interrupt_in_buffer;
795 edge_serial->interrupt_in_endpoint = port0->interrupt_in_endpointAddress;
796 edge_serial->interrupt_read_urb = port0->interrupt_in_urb;
797 edge_serial->bulk_in_buffer = port0->bulk_in_buffer;
798 edge_serial->bulk_in_endpoint = port0->bulk_in_endpointAddress;
799 edge_serial->read_urb = port0->read_urb;
800 edge_serial->bulk_out_endpoint = port0->bulk_out_endpointAddress;
802 /* set up our interrupt urb */
803 usb_fill_int_urb(edge_serial->interrupt_read_urb,
805 usb_rcvintpipe(serial->dev,
806 port0->interrupt_in_endpointAddress),
807 port0->interrupt_in_buffer,
808 edge_serial->interrupt_read_urb->transfer_buffer_length,
809 edge_interrupt_callback, edge_serial,
810 edge_serial->interrupt_read_urb->interval);
812 /* set up our bulk in urb */
813 usb_fill_bulk_urb(edge_serial->read_urb, serial->dev,
814 usb_rcvbulkpipe(serial->dev,
815 port0->bulk_in_endpointAddress),
816 port0->bulk_in_buffer,
817 edge_serial->read_urb->transfer_buffer_length,
818 edge_bulk_in_callback, edge_serial);
819 edge_serial->read_in_progress = FALSE;
821 /* start interrupt read for this edgeport
822 * this interrupt will continue as long as the edgeport is connected */
823 response = usb_submit_urb (edge_serial->interrupt_read_urb, GFP_KERNEL);
825 dev_err(&port->dev, "%s - Error %d submitting control urb\n", __FUNCTION__, response);
829 /* initialize our wait queues */
830 init_waitqueue_head(&edge_port->wait_open);
831 init_waitqueue_head(&edge_port->wait_chase);
832 init_waitqueue_head(&edge_port->delta_msr_wait);
833 init_waitqueue_head(&edge_port->wait_command);
835 /* initialize our icount structure */
836 memset (&(edge_port->icount), 0x00, sizeof(edge_port->icount));
838 /* initialize our port settings */
839 edge_port->txCredits = 0; /* Can't send any data yet */
840 edge_port->shadowMCR = MCR_MASTER_IE; /* Must always set this bit to enable ints! */
841 edge_port->chaseResponsePending = FALSE;
843 /* send a open port command */
844 edge_port->openPending = TRUE;
845 edge_port->open = FALSE;
846 response = send_iosp_ext_cmd (edge_port, IOSP_CMD_OPEN_PORT, 0);
849 dev_err(&port->dev, "%s - error sending open port command\n", __FUNCTION__);
850 edge_port->openPending = FALSE;
854 /* now wait for the port to be completely opened */
855 wait_event_timeout(edge_port->wait_open, (edge_port->openPending != TRUE), OPEN_TIMEOUT);
857 if (edge_port->open == FALSE) {
859 dbg("%s - open timedout", __FUNCTION__);
860 edge_port->openPending = FALSE;
864 /* create the txfifo */
865 edge_port->txfifo.head = 0;
866 edge_port->txfifo.tail = 0;
867 edge_port->txfifo.count = 0;
868 edge_port->txfifo.size = edge_port->maxTxCredits;
869 edge_port->txfifo.fifo = kmalloc (edge_port->maxTxCredits, GFP_KERNEL);
871 if (!edge_port->txfifo.fifo) {
872 dbg("%s - no memory", __FUNCTION__);
873 edge_close (port, filp);
877 /* Allocate a URB for the write */
878 edge_port->write_urb = usb_alloc_urb (0, GFP_KERNEL);
879 edge_port->write_in_progress = FALSE;
881 if (!edge_port->write_urb) {
882 dbg("%s - no memory", __FUNCTION__);
883 edge_close (port, filp);
887 dbg("%s(%d) - Initialize TX fifo to %d bytes", __FUNCTION__, port->number, edge_port->maxTxCredits);
889 dbg("%s exited", __FUNCTION__);
895 /************************************************************************
897 * block_until_chase_response
899 * This function will block the close until one of the following:
900 * 1. Response to our Chase comes from Edgeport
901 * 2. A timout of 10 seconds without activity has expired
902 * (1K of Edgeport data @ 2400 baud ==> 4 sec to empty)
904 ************************************************************************/
905 static void block_until_chase_response(struct edgeport_port *edge_port)
914 lastCredits = edge_port->txCredits;
916 // Did we get our Chase response
917 if (edge_port->chaseResponsePending == FALSE) {
918 dbg("%s - Got Chase Response", __FUNCTION__);
920 // did we get all of our credit back?
921 if (edge_port->txCredits == edge_port->maxTxCredits ) {
922 dbg("%s - Got all credits", __FUNCTION__);
927 // Block the thread for a while
928 prepare_to_wait(&edge_port->wait_chase, &wait, TASK_UNINTERRUPTIBLE);
929 schedule_timeout(timeout);
930 finish_wait(&edge_port->wait_chase, &wait);
932 if (lastCredits == edge_port->txCredits) {
933 // No activity.. count down.
936 edge_port->chaseResponsePending = FALSE;
937 dbg("%s - Chase TIMEOUT", __FUNCTION__);
941 // Reset timout value back to 10 seconds
942 dbg("%s - Last %d, Current %d", __FUNCTION__, lastCredits, edge_port->txCredits);
949 /************************************************************************
951 * block_until_tx_empty
953 * This function will block the close until one of the following:
955 * 2. The edgeport has stopped
956 * 3. A timout of 3 seconds without activity has expired
958 ************************************************************************/
959 static void block_until_tx_empty (struct edgeport_port *edge_port)
962 struct TxFifo *fifo = &edge_port->txfifo;
969 lastCount = fifo->count;
971 // Is the Edgeport Buffer empty?
972 if (lastCount == 0) {
973 dbg("%s - TX Buffer Empty", __FUNCTION__);
977 // Block the thread for a while
978 prepare_to_wait (&edge_port->wait_chase, &wait, TASK_UNINTERRUPTIBLE);
979 schedule_timeout(timeout);
980 finish_wait(&edge_port->wait_chase, &wait);
982 dbg("%s wait", __FUNCTION__);
984 if (lastCount == fifo->count) {
985 // No activity.. count down.
988 dbg("%s - TIMEOUT", __FUNCTION__);
992 // Reset timout value back to seconds
999 /*****************************************************************************
1001 * this function is called by the tty driver when a port is closed
1002 *****************************************************************************/
1003 static void edge_close (struct usb_serial_port *port, struct file * filp)
1005 struct edgeport_serial *edge_serial;
1006 struct edgeport_port *edge_port;
1009 dbg("%s - port %d", __FUNCTION__, port->number);
1011 edge_serial = usb_get_serial_data(port->serial);
1012 edge_port = usb_get_serial_port_data(port);
1013 if ((edge_serial == NULL) || (edge_port == NULL))
1016 // block until tx is empty
1017 block_until_tx_empty(edge_port);
1019 edge_port->closePending = TRUE;
1021 /* flush and chase */
1022 edge_port->chaseResponsePending = TRUE;
1024 dbg("%s - Sending IOSP_CMD_CHASE_PORT", __FUNCTION__);
1025 status = send_iosp_ext_cmd (edge_port, IOSP_CMD_CHASE_PORT, 0);
1027 // block until chase finished
1028 block_until_chase_response(edge_port);
1030 edge_port->chaseResponsePending = FALSE;
1033 /* close the port */
1034 dbg("%s - Sending IOSP_CMD_CLOSE_PORT", __FUNCTION__);
1035 send_iosp_ext_cmd (edge_port, IOSP_CMD_CLOSE_PORT, 0);
1037 //port->close = TRUE;
1038 edge_port->closePending = FALSE;
1039 edge_port->open = FALSE;
1040 edge_port->openPending = FALSE;
1042 if (edge_port->write_urb) {
1043 usb_kill_urb(edge_port->write_urb);
1046 if (edge_port->write_urb) {
1047 /* if this urb had a transfer buffer already (old transfer) free it */
1048 kfree(edge_port->write_urb->transfer_buffer);
1049 usb_free_urb(edge_port->write_urb);
1050 edge_port->write_urb = NULL;
1052 kfree(edge_port->txfifo.fifo);
1053 edge_port->txfifo.fifo = NULL;
1055 dbg("%s exited", __FUNCTION__);
1058 /*****************************************************************************
1060 * this function is called by the tty driver when data should be written to
1062 * If successful, we return the number of bytes written, otherwise we return
1063 * a negative error number.
1064 *****************************************************************************/
1065 static int edge_write (struct usb_serial_port *port, const unsigned char *data, int count)
1067 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1068 struct TxFifo *fifo;
1073 unsigned long flags;
1075 dbg("%s - port %d", __FUNCTION__, port->number);
1077 if (edge_port == NULL)
1080 // get a pointer to the Tx fifo
1081 fifo = &edge_port->txfifo;
1083 spin_lock_irqsave(&edge_port->ep_lock, flags);
1085 // calculate number of bytes to put in fifo
1086 copySize = min ((unsigned int)count, (edge_port->txCredits - fifo->count));
1088 dbg("%s(%d) of %d byte(s) Fifo room %d -- will copy %d bytes", __FUNCTION__,
1089 port->number, count, edge_port->txCredits - fifo->count, copySize);
1091 /* catch writes of 0 bytes which the tty driver likes to give us, and when txCredits is empty */
1092 if (copySize == 0) {
1093 dbg("%s - copySize = Zero", __FUNCTION__);
1098 // since we can never overflow the buffer we do not have to check for full condition
1100 // the copy is done is two parts -- first fill to the end of the buffer
1101 // then copy the reset from the start of the buffer
1103 bytesleft = fifo->size - fifo->head;
1104 firsthalf = min (bytesleft, copySize);
1105 dbg("%s - copy %d bytes of %d into fifo ", __FUNCTION__, firsthalf, bytesleft);
1107 /* now copy our data */
1108 memcpy(&fifo->fifo[fifo->head], data, firsthalf);
1109 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, firsthalf, &fifo->fifo[fifo->head]);
1111 // update the index and size
1112 fifo->head += firsthalf;
1113 fifo->count += firsthalf;
1116 if (fifo->head == fifo->size) {
1120 secondhalf = copySize-firsthalf;
1123 dbg("%s - copy rest of data %d", __FUNCTION__, secondhalf);
1124 memcpy(&fifo->fifo[fifo->head], &data[firsthalf], secondhalf);
1125 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, secondhalf, &fifo->fifo[fifo->head]);
1126 // update the index and size
1127 fifo->count += secondhalf;
1128 fifo->head += secondhalf;
1129 // No need to check for wrap since we can not get to end of fifo in this part
1133 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
1135 send_more_port_data((struct edgeport_serial *)usb_get_serial_data(port->serial), edge_port);
1137 dbg("%s wrote %d byte(s) TxCredits %d, Fifo %d", __FUNCTION__, copySize, edge_port->txCredits, fifo->count);
1143 /************************************************************************
1145 * send_more_port_data()
1147 * This routine attempts to write additional UART transmit data
1148 * to a port over the USB bulk pipe. It is called (1) when new
1149 * data has been written to a port's TxBuffer from higher layers
1150 * (2) when the peripheral sends us additional TxCredits indicating
1151 * that it can accept more Tx data for a given port; and (3) when
1152 * a bulk write completes successfully and we want to see if we
1153 * can transmit more.
1155 ************************************************************************/
1156 static void send_more_port_data(struct edgeport_serial *edge_serial, struct edgeport_port *edge_port)
1158 struct TxFifo *fifo = &edge_port->txfifo;
1160 unsigned char *buffer;
1166 unsigned long flags;
1168 dbg("%s(%d)", __FUNCTION__, edge_port->port->number);
1170 spin_lock_irqsave(&edge_port->ep_lock, flags);
1172 if (edge_port->write_in_progress ||
1174 (fifo->count == 0)) {
1175 dbg("%s(%d) EXIT - fifo %d, PendingWrite = %d", __FUNCTION__, edge_port->port->number, fifo->count, edge_port->write_in_progress);
1179 // since the amount of data in the fifo will always fit into the
1180 // edgeport buffer we do not need to check the write length
1182 // Do we have enough credits for this port to make it worthwhile
1183 // to bother queueing a write. If it's too small, say a few bytes,
1184 // it's better to wait for more credits so we can do a larger
1186 if (edge_port->txCredits < EDGE_FW_GET_TX_CREDITS_SEND_THRESHOLD(edge_port->maxTxCredits,EDGE_FW_BULK_MAX_PACKET_SIZE)) {
1187 dbg("%s(%d) Not enough credit - fifo %d TxCredit %d", __FUNCTION__, edge_port->port->number, fifo->count, edge_port->txCredits );
1192 edge_port->write_in_progress = TRUE;
1194 // get a pointer to the write_urb
1195 urb = edge_port->write_urb;
1197 /* make sure transfer buffer is freed */
1198 kfree(urb->transfer_buffer);
1199 urb->transfer_buffer = NULL;
1201 /* build the data header for the buffer and port that we are about to send out */
1202 count = fifo->count;
1203 buffer = kmalloc (count+2, GFP_ATOMIC);
1204 if (buffer == NULL) {
1205 dev_err(&edge_port->port->dev, "%s - no more kernel memory...\n", __FUNCTION__);
1206 edge_port->write_in_progress = FALSE;
1209 buffer[0] = IOSP_BUILD_DATA_HDR1 (edge_port->port->number - edge_port->port->serial->minor, count);
1210 buffer[1] = IOSP_BUILD_DATA_HDR2 (edge_port->port->number - edge_port->port->serial->minor, count);
1212 /* now copy our data */
1213 bytesleft = fifo->size - fifo->tail;
1214 firsthalf = min (bytesleft, count);
1215 memcpy(&buffer[2], &fifo->fifo[fifo->tail], firsthalf);
1216 fifo->tail += firsthalf;
1217 fifo->count -= firsthalf;
1218 if (fifo->tail == fifo->size) {
1222 secondhalf = count-firsthalf;
1224 memcpy(&buffer[2+firsthalf], &fifo->fifo[fifo->tail], secondhalf);
1225 fifo->tail += secondhalf;
1226 fifo->count -= secondhalf;
1230 usb_serial_debug_data(debug, &edge_port->port->dev, __FUNCTION__, count, &buffer[2]);
1232 /* fill up the urb with all of our data and submit it */
1233 usb_fill_bulk_urb (urb, edge_serial->serial->dev,
1234 usb_sndbulkpipe(edge_serial->serial->dev, edge_serial->bulk_out_endpoint),
1235 buffer, count+2, edge_bulk_out_data_callback, edge_port);
1237 /* decrement the number of credits we have by the number we just sent */
1238 edge_port->txCredits -= count;
1239 edge_port->icount.tx += count;
1241 urb->dev = edge_serial->serial->dev;
1242 status = usb_submit_urb(urb, GFP_ATOMIC);
1244 /* something went wrong */
1245 dev_err(&edge_port->port->dev, "%s - usb_submit_urb(write bulk) failed, status = %d, data lost\n", __FUNCTION__, status);
1246 edge_port->write_in_progress = FALSE;
1248 /* revert the credits as something bad happened. */
1249 edge_port->txCredits += count;
1250 edge_port->icount.tx -= count;
1252 dbg("%s wrote %d byte(s) TxCredit %d, Fifo %d", __FUNCTION__, count, edge_port->txCredits, fifo->count);
1255 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
1259 /*****************************************************************************
1261 * this function is called by the tty driver when it wants to know how many
1262 * bytes of data we can accept for a specific port.
1263 * If successful, we return the amount of room that we have for this port
1265 * Otherwise we return a negative error number.
1266 *****************************************************************************/
1267 static int edge_write_room (struct usb_serial_port *port)
1269 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1271 unsigned long flags;
1273 dbg("%s", __FUNCTION__);
1275 if (edge_port == NULL)
1277 if (edge_port->closePending == TRUE)
1280 dbg("%s - port %d", __FUNCTION__, port->number);
1282 if (!edge_port->open) {
1283 dbg("%s - port not opened", __FUNCTION__);
1287 // total of both buffers is still txCredit
1288 spin_lock_irqsave(&edge_port->ep_lock, flags);
1289 room = edge_port->txCredits - edge_port->txfifo.count;
1290 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
1292 dbg("%s - returns %d", __FUNCTION__, room);
1297 /*****************************************************************************
1298 * edge_chars_in_buffer
1299 * this function is called by the tty driver when it wants to know how many
1300 * bytes of data we currently have outstanding in the port (data that has
1301 * been written, but hasn't made it out the port yet)
1302 * If successful, we return the number of bytes left to be written in the
1304 * Otherwise we return a negative error number.
1305 *****************************************************************************/
1306 static int edge_chars_in_buffer (struct usb_serial_port *port)
1308 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1310 unsigned long flags;
1312 dbg("%s", __FUNCTION__);
1314 if (edge_port == NULL)
1316 if (edge_port->closePending == TRUE)
1319 if (!edge_port->open) {
1320 dbg("%s - port not opened", __FUNCTION__);
1324 spin_lock_irqsave(&edge_port->ep_lock, flags);
1325 num_chars = edge_port->maxTxCredits - edge_port->txCredits + edge_port->txfifo.count;
1326 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
1328 dbg("%s(port %d) - returns %d", __FUNCTION__, port->number, num_chars);
1335 /*****************************************************************************
1337 * this function is called by the tty driver when it wants to stop the data
1338 * being read from the port.
1339 *****************************************************************************/
1340 static void edge_throttle (struct usb_serial_port *port)
1342 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1343 struct tty_struct *tty;
1346 dbg("%s - port %d", __FUNCTION__, port->number);
1348 if (edge_port == NULL)
1351 if (!edge_port->open) {
1352 dbg("%s - port not opened", __FUNCTION__);
1358 dbg ("%s - no tty available", __FUNCTION__);
1362 /* if we are implementing XON/XOFF, send the stop character */
1364 unsigned char stop_char = STOP_CHAR(tty);
1365 status = edge_write (port, &stop_char, 1);
1371 /* if we are implementing RTS/CTS, toggle that line */
1372 if (tty->termios->c_cflag & CRTSCTS) {
1373 edge_port->shadowMCR &= ~MCR_RTS;
1374 status = send_cmd_write_uart_register(edge_port, MCR, edge_port->shadowMCR);
1384 /*****************************************************************************
1386 * this function is called by the tty driver when it wants to resume the data
1387 * being read from the port (called after SerialThrottle is called)
1388 *****************************************************************************/
1389 static void edge_unthrottle (struct usb_serial_port *port)
1391 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1392 struct tty_struct *tty;
1395 dbg("%s - port %d", __FUNCTION__, port->number);
1397 if (edge_port == NULL)
1400 if (!edge_port->open) {
1401 dbg("%s - port not opened", __FUNCTION__);
1407 dbg ("%s - no tty available", __FUNCTION__);
1411 /* if we are implementing XON/XOFF, send the start character */
1413 unsigned char start_char = START_CHAR(tty);
1414 status = edge_write (port, &start_char, 1);
1420 /* if we are implementing RTS/CTS, toggle that line */
1421 if (tty->termios->c_cflag & CRTSCTS) {
1422 edge_port->shadowMCR |= MCR_RTS;
1423 status = send_cmd_write_uart_register(edge_port, MCR, edge_port->shadowMCR);
1433 /*****************************************************************************
1435 * this function is called by the tty driver when it wants to change the termios structure
1436 *****************************************************************************/
1437 static void edge_set_termios (struct usb_serial_port *port, struct termios *old_termios)
1439 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1440 struct tty_struct *tty = port->tty;
1443 if (!port->tty || !port->tty->termios) {
1444 dbg ("%s - no tty or termios", __FUNCTION__);
1448 cflag = tty->termios->c_cflag;
1449 /* check that they really want us to change something */
1451 if (cflag == old_termios->c_cflag &&
1452 tty->termios->c_iflag == old_termios->c_iflag) {
1453 dbg("%s - nothing to change", __FUNCTION__);
1458 dbg("%s - clfag %08x iflag %08x", __FUNCTION__,
1459 tty->termios->c_cflag, tty->termios->c_iflag);
1461 dbg("%s - old clfag %08x old iflag %08x", __FUNCTION__,
1462 old_termios->c_cflag, old_termios->c_iflag);
1465 dbg("%s - port %d", __FUNCTION__, port->number);
1467 if (edge_port == NULL)
1470 if (!edge_port->open) {
1471 dbg("%s - port not opened", __FUNCTION__);
1475 /* change the port settings to the new ones specified */
1476 change_port_settings (edge_port, old_termios);
1482 /*****************************************************************************
1483 * get_lsr_info - get line status register info
1485 * Purpose: Let user call ioctl() to get info when the UART physically
1486 * is emptied. On bus types like RS485, the transmitter must
1487 * release the bus after transmitting. This must be done when
1488 * the transmit shift register is empty, not be done when the
1489 * transmit holding register is empty. This functionality
1490 * allows an RS485 driver to be written in user space.
1491 *****************************************************************************/
1492 static int get_lsr_info(struct edgeport_port *edge_port, unsigned int __user *value)
1494 unsigned int result = 0;
1495 unsigned long flags;
1497 spin_lock_irqsave(&edge_port->ep_lock, flags);
1498 if (edge_port->maxTxCredits == edge_port->txCredits &&
1499 edge_port->txfifo.count == 0) {
1500 dbg("%s -- Empty", __FUNCTION__);
1501 result = TIOCSER_TEMT;
1503 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
1505 if (copy_to_user(value, &result, sizeof(int)))
1510 static int get_number_bytes_avail(struct edgeport_port *edge_port, unsigned int __user *value)
1512 unsigned int result = 0;
1513 struct tty_struct *tty = edge_port->port->tty;
1516 return -ENOIOCTLCMD;
1518 result = tty->read_cnt;
1520 dbg("%s(%d) = %d", __FUNCTION__, edge_port->port->number, result);
1521 if (copy_to_user(value, &result, sizeof(int)))
1524 return -ENOIOCTLCMD;
1527 static int edge_tiocmset (struct usb_serial_port *port, struct file *file, unsigned int set, unsigned int clear)
1529 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1532 dbg("%s - port %d", __FUNCTION__, port->number);
1534 mcr = edge_port->shadowMCR;
1535 if (set & TIOCM_RTS)
1537 if (set & TIOCM_DTR)
1539 if (set & TIOCM_LOOP)
1540 mcr |= MCR_LOOPBACK;
1542 if (clear & TIOCM_RTS)
1544 if (clear & TIOCM_DTR)
1546 if (clear & TIOCM_LOOP)
1547 mcr &= ~MCR_LOOPBACK;
1549 edge_port->shadowMCR = mcr;
1551 send_cmd_write_uart_register(edge_port, MCR, edge_port->shadowMCR);
1556 static int edge_tiocmget(struct usb_serial_port *port, struct file *file)
1558 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1559 unsigned int result = 0;
1563 dbg("%s - port %d", __FUNCTION__, port->number);
1565 msr = edge_port->shadowMSR;
1566 mcr = edge_port->shadowMCR;
1567 result = ((mcr & MCR_DTR) ? TIOCM_DTR: 0) /* 0x002 */
1568 | ((mcr & MCR_RTS) ? TIOCM_RTS: 0) /* 0x004 */
1569 | ((msr & EDGEPORT_MSR_CTS) ? TIOCM_CTS: 0) /* 0x020 */
1570 | ((msr & EDGEPORT_MSR_CD) ? TIOCM_CAR: 0) /* 0x040 */
1571 | ((msr & EDGEPORT_MSR_RI) ? TIOCM_RI: 0) /* 0x080 */
1572 | ((msr & EDGEPORT_MSR_DSR) ? TIOCM_DSR: 0); /* 0x100 */
1575 dbg("%s -- %x", __FUNCTION__, result);
1580 static int get_serial_info(struct edgeport_port *edge_port, struct serial_struct __user *retinfo)
1582 struct serial_struct tmp;
1587 memset(&tmp, 0, sizeof(tmp));
1589 tmp.type = PORT_16550A;
1590 tmp.line = edge_port->port->serial->minor;
1591 tmp.port = edge_port->port->number;
1593 tmp.flags = ASYNC_SKIP_TEST | ASYNC_AUTO_IRQ;
1594 tmp.xmit_fifo_size = edge_port->maxTxCredits;
1595 tmp.baud_base = 9600;
1596 tmp.close_delay = 5*HZ;
1597 tmp.closing_wait = 30*HZ;
1598 // tmp.custom_divisor = state->custom_divisor;
1599 // tmp.hub6 = state->hub6;
1600 // tmp.io_type = state->io_type;
1602 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
1609 /*****************************************************************************
1611 * this function handles any ioctl calls to the driver
1612 *****************************************************************************/
1613 static int edge_ioctl (struct usb_serial_port *port, struct file *file, unsigned int cmd, unsigned long arg)
1616 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1617 struct async_icount cnow;
1618 struct async_icount cprev;
1619 struct serial_icounter_struct icount;
1621 dbg("%s - port %d, cmd = 0x%x", __FUNCTION__, port->number, cmd);
1624 // return number of bytes available
1626 dbg("%s (%d) TIOCINQ", __FUNCTION__, port->number);
1627 return get_number_bytes_avail(edge_port, (unsigned int __user *) arg);
1631 dbg("%s (%d) TIOCSERGETLSR", __FUNCTION__, port->number);
1632 return get_lsr_info(edge_port, (unsigned int __user *) arg);
1636 dbg("%s (%d) TIOCGSERIAL", __FUNCTION__, port->number);
1637 return get_serial_info(edge_port, (struct serial_struct __user *) arg);
1640 dbg("%s (%d) TIOCSSERIAL", __FUNCTION__, port->number);
1644 dbg("%s (%d) TIOCMIWAIT", __FUNCTION__, port->number);
1645 cprev = edge_port->icount;
1647 prepare_to_wait(&edge_port->delta_msr_wait, &wait, TASK_INTERRUPTIBLE);
1649 finish_wait(&edge_port->delta_msr_wait, &wait);
1650 /* see if a signal did it */
1651 if (signal_pending(current))
1652 return -ERESTARTSYS;
1653 cnow = edge_port->icount;
1654 if (cnow.rng == cprev.rng && cnow.dsr == cprev.dsr &&
1655 cnow.dcd == cprev.dcd && cnow.cts == cprev.cts)
1656 return -EIO; /* no change => error */
1657 if (((arg & TIOCM_RNG) && (cnow.rng != cprev.rng)) ||
1658 ((arg & TIOCM_DSR) && (cnow.dsr != cprev.dsr)) ||
1659 ((arg & TIOCM_CD) && (cnow.dcd != cprev.dcd)) ||
1660 ((arg & TIOCM_CTS) && (cnow.cts != cprev.cts)) ) {
1669 cnow = edge_port->icount;
1670 memset(&icount, 0, sizeof(icount));
1671 icount.cts = cnow.cts;
1672 icount.dsr = cnow.dsr;
1673 icount.rng = cnow.rng;
1674 icount.dcd = cnow.dcd;
1675 icount.rx = cnow.rx;
1676 icount.tx = cnow.tx;
1677 icount.frame = cnow.frame;
1678 icount.overrun = cnow.overrun;
1679 icount.parity = cnow.parity;
1680 icount.brk = cnow.brk;
1681 icount.buf_overrun = cnow.buf_overrun;
1683 dbg("%s (%d) TIOCGICOUNT RX=%d, TX=%d", __FUNCTION__, port->number, icount.rx, icount.tx );
1684 if (copy_to_user((void __user *)arg, &icount, sizeof(icount)))
1689 return -ENOIOCTLCMD;
1693 /*****************************************************************************
1695 * this function sends a break to the port
1696 *****************************************************************************/
1697 static void edge_break (struct usb_serial_port *port, int break_state)
1699 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1702 /* flush and chase */
1703 edge_port->chaseResponsePending = TRUE;
1705 dbg("%s - Sending IOSP_CMD_CHASE_PORT", __FUNCTION__);
1706 status = send_iosp_ext_cmd (edge_port, IOSP_CMD_CHASE_PORT, 0);
1708 // block until chase finished
1709 block_until_chase_response(edge_port);
1711 edge_port->chaseResponsePending = FALSE;
1714 if (break_state == -1) {
1715 dbg("%s - Sending IOSP_CMD_SET_BREAK", __FUNCTION__);
1716 status = send_iosp_ext_cmd (edge_port, IOSP_CMD_SET_BREAK, 0);
1718 dbg("%s - Sending IOSP_CMD_CLEAR_BREAK", __FUNCTION__);
1719 status = send_iosp_ext_cmd (edge_port, IOSP_CMD_CLEAR_BREAK, 0);
1722 dbg("%s - error sending break set/clear command.", __FUNCTION__);
1729 /*****************************************************************************
1731 * this function handles the data received on the bulk in pipe.
1732 *****************************************************************************/
1733 static void process_rcvd_data (struct edgeport_serial *edge_serial, unsigned char * buffer, __u16 bufferLength)
1735 struct usb_serial_port *port;
1736 struct edgeport_port *edge_port;
1737 struct tty_struct *tty;
1738 __u16 lastBufferLength;
1741 dbg("%s", __FUNCTION__);
1743 lastBufferLength = bufferLength + 1;
1745 while (bufferLength > 0) {
1746 /* failsafe incase we get a message that we don't understand */
1747 if (lastBufferLength == bufferLength) {
1748 dbg("%s - stuck in loop, exiting it.", __FUNCTION__);
1751 lastBufferLength = bufferLength;
1753 switch (edge_serial->rxState) {
1755 edge_serial->rxHeader1 = *buffer;
1759 if (bufferLength == 0) {
1760 edge_serial->rxState = EXPECT_HDR2;
1763 /* otherwise, drop on through */
1766 edge_serial->rxHeader2 = *buffer;
1770 dbg("%s - Hdr1=%02X Hdr2=%02X", __FUNCTION__, edge_serial->rxHeader1, edge_serial->rxHeader2);
1772 // Process depending on whether this header is
1775 if (IS_CMD_STAT_HDR(edge_serial->rxHeader1)) {
1776 // Decode this status header and goto EXPECT_HDR1 (if we
1777 // can process the status with only 2 bytes), or goto
1778 // EXPECT_HDR3 to get the third byte.
1780 edge_serial->rxPort = IOSP_GET_HDR_PORT(edge_serial->rxHeader1);
1781 edge_serial->rxStatusCode = IOSP_GET_STATUS_CODE(edge_serial->rxHeader1);
1783 if (!IOSP_STATUS_IS_2BYTE(edge_serial->rxStatusCode)) {
1784 // This status needs additional bytes. Save what we have
1785 // and then wait for more data.
1786 edge_serial->rxStatusParam = edge_serial->rxHeader2;
1788 edge_serial->rxState = EXPECT_HDR3;
1792 // We have all the header bytes, process the status now
1793 process_rcvd_status (edge_serial, edge_serial->rxHeader2, 0);
1794 edge_serial->rxState = EXPECT_HDR1;
1797 edge_serial->rxPort = IOSP_GET_HDR_PORT(edge_serial->rxHeader1);
1798 edge_serial->rxBytesRemaining = IOSP_GET_HDR_DATA_LEN(edge_serial->rxHeader1, edge_serial->rxHeader2);
1800 dbg("%s - Data for Port %u Len %u", __FUNCTION__, edge_serial->rxPort, edge_serial->rxBytesRemaining);
1802 //ASSERT( DevExt->RxPort < DevExt->NumPorts );
1803 //ASSERT( DevExt->RxBytesRemaining < IOSP_MAX_DATA_LENGTH );
1805 if (bufferLength == 0 ) {
1806 edge_serial->rxState = EXPECT_DATA;
1809 // Else, drop through
1812 case EXPECT_DATA: // Expect data
1814 if (bufferLength < edge_serial->rxBytesRemaining) {
1815 rxLen = bufferLength;
1816 edge_serial->rxState = EXPECT_DATA; // Expect data to start next buffer
1818 // BufLen >= RxBytesRemaining
1819 rxLen = edge_serial->rxBytesRemaining;
1820 edge_serial->rxState = EXPECT_HDR1; // Start another header next time
1823 bufferLength -= rxLen;
1824 edge_serial->rxBytesRemaining -= rxLen;
1826 /* spit this data back into the tty driver if this port is open */
1828 port = edge_serial->serial->port[edge_serial->rxPort];
1829 edge_port = usb_get_serial_port_data(port);
1830 if (edge_port->open) {
1831 tty = edge_port->port->tty;
1833 dbg("%s - Sending %d bytes to TTY for port %d", __FUNCTION__, rxLen, edge_serial->rxPort);
1834 edge_tty_recv(&edge_serial->serial->dev->dev, tty, buffer, rxLen);
1836 edge_port->icount.rx += rxLen;
1843 case EXPECT_HDR3: // Expect 3rd byte of status header
1844 edge_serial->rxHeader3 = *buffer;
1848 // We have all the header bytes, process the status now
1849 process_rcvd_status (edge_serial, edge_serial->rxStatusParam, edge_serial->rxHeader3);
1850 edge_serial->rxState = EXPECT_HDR1;
1858 /*****************************************************************************
1859 * process_rcvd_status
1860 * this function handles the any status messages received on the bulk in pipe.
1861 *****************************************************************************/
1862 static void process_rcvd_status (struct edgeport_serial *edge_serial, __u8 byte2, __u8 byte3)
1864 struct usb_serial_port *port;
1865 struct edgeport_port *edge_port;
1866 __u8 code = edge_serial->rxStatusCode;
1868 /* switch the port pointer to the one being currently talked about */
1869 port = edge_serial->serial->port[edge_serial->rxPort];
1870 edge_port = usb_get_serial_port_data(port);
1871 if (edge_port == NULL) {
1872 dev_err(&edge_serial->serial->dev->dev, "%s - edge_port == NULL for port %d\n", __FUNCTION__, edge_serial->rxPort);
1876 dbg("%s - port %d", __FUNCTION__, edge_serial->rxPort);
1878 if (code == IOSP_EXT_STATUS) {
1880 case IOSP_EXT_STATUS_CHASE_RSP:
1881 // we want to do EXT status regardless of port open/closed
1882 dbg("%s - Port %u EXT CHASE_RSP Data = %02x", __FUNCTION__, edge_serial->rxPort, byte3 );
1883 // Currently, the only EXT_STATUS is Chase, so process here instead of one more call
1884 // to one more subroutine. If/when more EXT_STATUS, there'll be more work to do.
1885 // Also, we currently clear flag and close the port regardless of content of above's Byte3.
1886 // We could choose to do something else when Byte3 says Timeout on Chase from Edgeport,
1887 // like wait longer in block_until_chase_response, but for now we don't.
1888 edge_port->chaseResponsePending = FALSE;
1889 wake_up (&edge_port->wait_chase);
1892 case IOSP_EXT_STATUS_RX_CHECK_RSP:
1893 dbg("%s ========== Port %u CHECK_RSP Sequence = %02x =============\n", __FUNCTION__, edge_serial->rxPort, byte3 );
1894 //Port->RxCheckRsp = TRUE;
1899 if (code == IOSP_STATUS_OPEN_RSP) {
1900 edge_port->txCredits = GET_TX_BUFFER_SIZE(byte3);
1901 edge_port->maxTxCredits = edge_port->txCredits;
1902 dbg("%s - Port %u Open Response Inital MSR = %02x TxBufferSize = %d", __FUNCTION__, edge_serial->rxPort, byte2, edge_port->txCredits);
1903 handle_new_msr (edge_port, byte2);
1905 /* send the current line settings to the port so we are in sync with any further termios calls */
1906 if (edge_port->port->tty)
1907 change_port_settings (edge_port, edge_port->port->tty->termios);
1909 /* we have completed the open */
1910 edge_port->openPending = FALSE;
1911 edge_port->open = TRUE;
1912 wake_up(&edge_port->wait_open);
1916 // If port is closed, silently discard all rcvd status. We can
1917 // have cases where buffered status is received AFTER the close
1918 // port command is sent to the Edgeport.
1919 if ((!edge_port->open ) || (edge_port->closePending)) {
1924 // Not currently sent by Edgeport
1925 case IOSP_STATUS_LSR:
1926 dbg("%s - Port %u LSR Status = %02x", __FUNCTION__, edge_serial->rxPort, byte2);
1927 handle_new_lsr (edge_port, FALSE, byte2, 0);
1930 case IOSP_STATUS_LSR_DATA:
1931 dbg("%s - Port %u LSR Status = %02x, Data = %02x", __FUNCTION__, edge_serial->rxPort, byte2, byte3);
1932 // byte2 is LSR Register
1933 // byte3 is broken data byte
1934 handle_new_lsr (edge_port, TRUE, byte2, byte3);
1937 // case IOSP_EXT_4_STATUS:
1938 // dbg("%s - Port %u LSR Status = %02x Data = %02x", __FUNCTION__, edge_serial->rxPort, byte2, byte3);
1941 case IOSP_STATUS_MSR:
1942 dbg("%s - Port %u MSR Status = %02x", __FUNCTION__, edge_serial->rxPort, byte2);
1944 // Process this new modem status and generate appropriate
1945 // events, etc, based on the new status. This routine
1946 // also saves the MSR in Port->ShadowMsr.
1947 handle_new_msr(edge_port, byte2);
1951 dbg("%s - Unrecognized IOSP status code %u\n", __FUNCTION__, code);
1959 /*****************************************************************************
1961 * this function passes data on to the tty flip buffer
1962 *****************************************************************************/
1963 static void edge_tty_recv(struct device *dev, struct tty_struct *tty, unsigned char *data, int length)
1968 cnt = tty_buffer_request_room(tty, length);
1970 dev_err(dev, "%s - dropping data, %d bytes lost\n",
1971 __FUNCTION__, length - cnt);
1975 tty_insert_flip_string(tty, data, cnt);
1978 } while (length > 0);
1980 tty_flip_buffer_push(tty);
1984 /*****************************************************************************
1986 * this function handles any change to the msr register for a port.
1987 *****************************************************************************/
1988 static void handle_new_msr(struct edgeport_port *edge_port, __u8 newMsr)
1990 struct async_icount *icount;
1992 dbg("%s %02x", __FUNCTION__, newMsr);
1994 if (newMsr & (EDGEPORT_MSR_DELTA_CTS | EDGEPORT_MSR_DELTA_DSR | EDGEPORT_MSR_DELTA_RI | EDGEPORT_MSR_DELTA_CD)) {
1995 icount = &edge_port->icount;
1997 /* update input line counters */
1998 if (newMsr & EDGEPORT_MSR_DELTA_CTS) {
2001 if (newMsr & EDGEPORT_MSR_DELTA_DSR) {
2004 if (newMsr & EDGEPORT_MSR_DELTA_CD) {
2007 if (newMsr & EDGEPORT_MSR_DELTA_RI) {
2010 wake_up_interruptible(&edge_port->delta_msr_wait);
2013 /* Save the new modem status */
2014 edge_port->shadowMSR = newMsr & 0xf0;
2020 /*****************************************************************************
2022 * this function handles any change to the lsr register for a port.
2023 *****************************************************************************/
2024 static void handle_new_lsr(struct edgeport_port *edge_port, __u8 lsrData, __u8 lsr, __u8 data)
2026 __u8 newLsr = (__u8)(lsr & (__u8)(LSR_OVER_ERR | LSR_PAR_ERR | LSR_FRM_ERR | LSR_BREAK));
2027 struct async_icount *icount;
2029 dbg("%s - %02x", __FUNCTION__, newLsr);
2031 edge_port->shadowLSR = lsr;
2033 if (newLsr & LSR_BREAK) {
2035 // Parity and Framing errors only count if they
2036 // occur exclusive of a break being
2039 newLsr &= (__u8)(LSR_OVER_ERR | LSR_BREAK);
2042 /* Place LSR data byte into Rx buffer */
2043 if (lsrData && edge_port->port->tty)
2044 edge_tty_recv(&edge_port->port->dev, edge_port->port->tty, &data, 1);
2046 /* update input line counters */
2047 icount = &edge_port->icount;
2048 if (newLsr & LSR_BREAK) {
2051 if (newLsr & LSR_OVER_ERR) {
2054 if (newLsr & LSR_PAR_ERR) {
2057 if (newLsr & LSR_FRM_ERR) {
2065 /****************************************************************************
2067 * writes a number of bytes to the Edgeport device's sram starting at the
2069 * If successful returns the number of bytes written, otherwise it returns
2070 * a negative error number of the problem.
2071 ****************************************************************************/
2072 static int sram_write (struct usb_serial *serial, __u16 extAddr, __u16 addr, __u16 length, __u8 *data)
2075 __u16 current_length;
2076 unsigned char *transfer_buffer;
2078 dbg("%s - %x, %x, %d", __FUNCTION__, extAddr, addr, length);
2080 transfer_buffer = kmalloc (64, GFP_KERNEL);
2081 if (!transfer_buffer) {
2082 dev_err(&serial->dev->dev, "%s - kmalloc(%d) failed.\n", __FUNCTION__, 64);
2086 /* need to split these writes up into 64 byte chunks */
2088 while (length > 0) {
2090 current_length = 64;
2092 current_length = length;
2094 // dbg("%s - writing %x, %x, %d", __FUNCTION__, extAddr, addr, current_length);
2095 memcpy (transfer_buffer, data, current_length);
2096 result = usb_control_msg (serial->dev, usb_sndctrlpipe(serial->dev, 0), USB_REQUEST_ION_WRITE_RAM,
2097 0x40, addr, extAddr, transfer_buffer, current_length, 300);
2100 length -= current_length;
2101 addr += current_length;
2102 data += current_length;
2105 kfree (transfer_buffer);
2110 /****************************************************************************
2112 * writes a number of bytes to the Edgeport device's ROM starting at the
2114 * If successful returns the number of bytes written, otherwise it returns
2115 * a negative error number of the problem.
2116 ****************************************************************************/
2117 static int rom_write (struct usb_serial *serial, __u16 extAddr, __u16 addr, __u16 length, __u8 *data)
2120 __u16 current_length;
2121 unsigned char *transfer_buffer;
2123 // dbg("%s - %x, %x, %d", __FUNCTION__, extAddr, addr, length);
2125 transfer_buffer = kmalloc (64, GFP_KERNEL);
2126 if (!transfer_buffer) {
2127 dev_err(&serial->dev->dev, "%s - kmalloc(%d) failed.\n", __FUNCTION__, 64);
2131 /* need to split these writes up into 64 byte chunks */
2133 while (length > 0) {
2135 current_length = 64;
2137 current_length = length;
2139 // dbg("%s - writing %x, %x, %d", __FUNCTION__, extAddr, addr, current_length);
2140 memcpy (transfer_buffer, data, current_length);
2141 result = usb_control_msg (serial->dev, usb_sndctrlpipe(serial->dev, 0), USB_REQUEST_ION_WRITE_ROM,
2142 0x40, addr, extAddr, transfer_buffer, current_length, 300);
2145 length -= current_length;
2146 addr += current_length;
2147 data += current_length;
2150 kfree (transfer_buffer);
2155 /****************************************************************************
2157 * reads a number of bytes from the Edgeport device starting at the given
2159 * If successful returns the number of bytes read, otherwise it returns
2160 * a negative error number of the problem.
2161 ****************************************************************************/
2162 static int rom_read (struct usb_serial *serial, __u16 extAddr, __u16 addr, __u16 length, __u8 *data)
2165 __u16 current_length;
2166 unsigned char *transfer_buffer;
2168 dbg("%s - %x, %x, %d", __FUNCTION__, extAddr, addr, length);
2170 transfer_buffer = kmalloc (64, GFP_KERNEL);
2171 if (!transfer_buffer) {
2172 dev_err(&serial->dev->dev, "%s - kmalloc(%d) failed.\n", __FUNCTION__, 64);
2176 /* need to split these reads up into 64 byte chunks */
2178 while (length > 0) {
2180 current_length = 64;
2182 current_length = length;
2184 // dbg("%s - %x, %x, %d", __FUNCTION__, extAddr, addr, current_length);
2185 result = usb_control_msg (serial->dev, usb_rcvctrlpipe(serial->dev, 0), USB_REQUEST_ION_READ_ROM,
2186 0xC0, addr, extAddr, transfer_buffer, current_length, 300);
2189 memcpy (data, transfer_buffer, current_length);
2190 length -= current_length;
2191 addr += current_length;
2192 data += current_length;
2195 kfree (transfer_buffer);
2200 /****************************************************************************
2202 * Is used to send a IOSP message to the Edgeport device
2203 ****************************************************************************/
2204 static int send_iosp_ext_cmd (struct edgeport_port *edge_port, __u8 command, __u8 param)
2206 unsigned char *buffer;
2207 unsigned char *currentCommand;
2211 dbg("%s - %d, %d", __FUNCTION__, command, param);
2213 buffer = kmalloc (10, GFP_ATOMIC);
2215 dev_err(&edge_port->port->dev, "%s - kmalloc(%d) failed.\n", __FUNCTION__, 10);
2219 currentCommand = buffer;
2221 MAKE_CMD_EXT_CMD (¤tCommand, &length,
2222 edge_port->port->number - edge_port->port->serial->minor,
2225 status = write_cmd_usb (edge_port, buffer, length);
2227 /* something bad happened, let's free up the memory */
2235 /*****************************************************************************
2237 * this function writes the given buffer out to the bulk write endpoint.
2238 *****************************************************************************/
2239 static int write_cmd_usb (struct edgeport_port *edge_port, unsigned char *buffer, int length)
2241 struct edgeport_serial *edge_serial = usb_get_serial_data(edge_port->port->serial);
2246 usb_serial_debug_data(debug, &edge_port->port->dev, __FUNCTION__, length, buffer);
2248 /* Allocate our next urb */
2249 urb = usb_alloc_urb (0, GFP_ATOMIC);
2254 dbg("%s - ALLOCATE URB %p (outstanding %d)", __FUNCTION__, urb, CmdUrbs);
2256 usb_fill_bulk_urb (urb, edge_serial->serial->dev,
2257 usb_sndbulkpipe(edge_serial->serial->dev, edge_serial->bulk_out_endpoint),
2258 buffer, length, edge_bulk_out_cmd_callback, edge_port);
2260 edge_port->commandPending = TRUE;
2261 status = usb_submit_urb(urb, GFP_ATOMIC);
2264 /* something went wrong */
2265 dev_err(&edge_port->port->dev, "%s - usb_submit_urb(write command) failed, status = %d\n", __FUNCTION__, status);
2272 // wait for command to finish
2273 timeout = COMMAND_TIMEOUT;
2275 wait_event (&edge_port->wait_command, (edge_port->commandPending == FALSE));
2277 if (edge_port->commandPending == TRUE) {
2278 /* command timed out */
2279 dbg("%s - command timed out", __FUNCTION__);
2287 /*****************************************************************************
2288 * send_cmd_write_baud_rate
2289 * this function sends the proper command to change the baud rate of the
2291 *****************************************************************************/
2292 static int send_cmd_write_baud_rate (struct edgeport_port *edge_port, int baudRate)
2294 unsigned char *cmdBuffer;
2295 unsigned char *currCmd;
2299 unsigned char number = edge_port->port->number - edge_port->port->serial->minor;
2301 dbg("%s - port = %d, baud = %d", __FUNCTION__, edge_port->port->number, baudRate);
2303 status = calc_baud_rate_divisor (baudRate, &divisor);
2305 dev_err(&edge_port->port->dev, "%s - bad baud rate\n", __FUNCTION__);
2309 // Alloc memory for the string of commands.
2310 cmdBuffer = kmalloc (0x100, GFP_ATOMIC);
2312 dev_err(&edge_port->port->dev, "%s - kmalloc(%d) failed.\n", __FUNCTION__, 0x100);
2315 currCmd = cmdBuffer;
2317 // Enable access to divisor latch
2318 MAKE_CMD_WRITE_REG( &currCmd, &cmdLen, number, LCR, LCR_DL_ENABLE );
2320 // Write the divisor itself
2321 MAKE_CMD_WRITE_REG( &currCmd, &cmdLen, number, DLL, LOW8 (divisor) );
2322 MAKE_CMD_WRITE_REG( &currCmd, &cmdLen, number, DLM, HIGH8(divisor) );
2324 // Restore original value to disable access to divisor latch
2325 MAKE_CMD_WRITE_REG( &currCmd, &cmdLen, number, LCR, edge_port->shadowLCR);
2327 status = write_cmd_usb(edge_port, cmdBuffer, cmdLen );
2329 /* something bad happened, let's free up the memory */
2337 /*****************************************************************************
2338 * calc_baud_rate_divisor
2339 * this function calculates the proper baud rate divisor for the specified
2341 *****************************************************************************/
2342 static int calc_baud_rate_divisor (int baudrate, int *divisor)
2348 dbg("%s - %d", __FUNCTION__, baudrate);
2350 for (i = 0; i < ARRAY_SIZE(divisor_table); i++) {
2351 if ( divisor_table[i].BaudRate == baudrate ) {
2352 *divisor = divisor_table[i].Divisor;
2357 // We have tried all of the standard baud rates
2358 // lets try to calculate the divisor for this baud rate
2359 // Make sure the baud rate is reasonable
2360 if (baudrate > 50 && baudrate < 230400) {
2362 custom = (__u16)((230400L + baudrate/2) / baudrate);
2366 dbg("%s - Baud %d = %d\n", __FUNCTION__, baudrate, custom);
2374 /*****************************************************************************
2375 * send_cmd_write_uart_register
2376 * this function builds up a uart register message and sends to to the device.
2377 *****************************************************************************/
2378 static int send_cmd_write_uart_register (struct edgeport_port *edge_port, __u8 regNum, __u8 regValue)
2380 unsigned char *cmdBuffer;
2381 unsigned char *currCmd;
2382 unsigned long cmdLen = 0;
2385 dbg("%s - write to %s register 0x%02x", (regNum == MCR) ? "MCR" : "LCR", __FUNCTION__, regValue);
2387 // Alloc memory for the string of commands.
2388 cmdBuffer = kmalloc (0x10, GFP_ATOMIC);
2389 if (cmdBuffer == NULL ) {
2393 currCmd = cmdBuffer;
2395 // Build a cmd in the buffer to write the given register
2396 MAKE_CMD_WRITE_REG (&currCmd, &cmdLen,
2397 edge_port->port->number - edge_port->port->serial->minor,
2400 status = write_cmd_usb(edge_port, cmdBuffer, cmdLen);
2402 /* something bad happened, let's free up the memory */
2410 /*****************************************************************************
2411 * change_port_settings
2412 * This routine is called to set the UART on the device to match the specified
2414 *****************************************************************************/
2418 static void change_port_settings (struct edgeport_port *edge_port, struct termios *old_termios)
2420 struct tty_struct *tty;
2431 dbg("%s - port %d", __FUNCTION__, edge_port->port->number);
2433 if ((!edge_port->open) &&
2434 (!edge_port->openPending)) {
2435 dbg("%s - port not opened", __FUNCTION__);
2439 tty = edge_port->port->tty;
2442 dbg("%s - no tty structures", __FUNCTION__);
2446 cflag = tty->termios->c_cflag;
2448 switch (cflag & CSIZE) {
2449 case CS5: lData = LCR_BITS_5; mask = 0x1f; dbg("%s - data bits = 5", __FUNCTION__); break;
2450 case CS6: lData = LCR_BITS_6; mask = 0x3f; dbg("%s - data bits = 6", __FUNCTION__); break;
2451 case CS7: lData = LCR_BITS_7; mask = 0x7f; dbg("%s - data bits = 7", __FUNCTION__); break;
2453 case CS8: lData = LCR_BITS_8; dbg("%s - data bits = 8", __FUNCTION__); break;
2456 lParity = LCR_PAR_NONE;
2457 if (cflag & PARENB) {
2458 if (cflag & CMSPAR) {
2459 if (cflag & PARODD) {
2460 lParity = LCR_PAR_MARK;
2461 dbg("%s - parity = mark", __FUNCTION__);
2463 lParity = LCR_PAR_SPACE;
2464 dbg("%s - parity = space", __FUNCTION__);
2466 } else if (cflag & PARODD) {
2467 lParity = LCR_PAR_ODD;
2468 dbg("%s - parity = odd", __FUNCTION__);
2470 lParity = LCR_PAR_EVEN;
2471 dbg("%s - parity = even", __FUNCTION__);
2474 dbg("%s - parity = none", __FUNCTION__);
2477 if (cflag & CSTOPB) {
2479 dbg("%s - stop bits = 2", __FUNCTION__);
2482 dbg("%s - stop bits = 1", __FUNCTION__);
2485 /* figure out the flow control settings */
2486 rxFlow = txFlow = 0x00;
2487 if (cflag & CRTSCTS) {
2488 rxFlow |= IOSP_RX_FLOW_RTS;
2489 txFlow |= IOSP_TX_FLOW_CTS;
2490 dbg("%s - RTS/CTS is enabled", __FUNCTION__);
2492 dbg("%s - RTS/CTS is disabled", __FUNCTION__);
2495 /* if we are implementing XON/XOFF, set the start and stop character in the device */
2496 if (I_IXOFF(tty) || I_IXON(tty)) {
2497 unsigned char stop_char = STOP_CHAR(tty);
2498 unsigned char start_char = START_CHAR(tty);
2500 send_iosp_ext_cmd (edge_port, IOSP_CMD_SET_XON_CHAR, start_char);
2501 send_iosp_ext_cmd (edge_port, IOSP_CMD_SET_XOFF_CHAR, stop_char);
2503 /* if we are implementing INBOUND XON/XOFF */
2505 rxFlow |= IOSP_RX_FLOW_XON_XOFF;
2506 dbg("%s - INBOUND XON/XOFF is enabled, XON = %2x, XOFF = %2x", __FUNCTION__, start_char, stop_char);
2508 dbg("%s - INBOUND XON/XOFF is disabled", __FUNCTION__);
2511 /* if we are implementing OUTBOUND XON/XOFF */
2513 txFlow |= IOSP_TX_FLOW_XON_XOFF;
2514 dbg("%s - OUTBOUND XON/XOFF is enabled, XON = %2x, XOFF = %2x", __FUNCTION__, start_char, stop_char);
2516 dbg("%s - OUTBOUND XON/XOFF is disabled", __FUNCTION__);
2520 /* Set flow control to the configured value */
2521 send_iosp_ext_cmd (edge_port, IOSP_CMD_SET_RX_FLOW, rxFlow);
2522 send_iosp_ext_cmd (edge_port, IOSP_CMD_SET_TX_FLOW, txFlow);
2525 edge_port->shadowLCR &= ~(LCR_BITS_MASK | LCR_STOP_MASK | LCR_PAR_MASK);
2526 edge_port->shadowLCR |= (lData | lParity | lStop);
2528 edge_port->validDataMask = mask;
2530 /* Send the updated LCR value to the EdgePort */
2531 status = send_cmd_write_uart_register(edge_port, LCR, edge_port->shadowLCR);
2536 /* set up the MCR register and send it to the EdgePort */
2537 edge_port->shadowMCR = MCR_MASTER_IE;
2538 if (cflag & CBAUD) {
2539 edge_port->shadowMCR |= (MCR_DTR | MCR_RTS);
2541 status = send_cmd_write_uart_register(edge_port, MCR, edge_port->shadowMCR);
2546 /* Determine divisor based on baud rate */
2547 baud = tty_get_baud_rate(tty);
2549 /* pick a default, any default... */
2553 dbg("%s - baud rate = %d", __FUNCTION__, baud);
2554 status = send_cmd_write_baud_rate (edge_port, baud);
2560 /****************************************************************************
2562 * Turns a string from Unicode into ASCII.
2563 * Doesn't do a good job with any characters that are outside the normal
2564 * ASCII range, but it's only for debugging...
2565 * NOTE: expects the unicode in LE format
2566 ****************************************************************************/
2567 static void unicode_to_ascii(char *string, int buflen, __le16 *unicode, int unicode_size)
2571 if (buflen <= 0) /* never happens, but... */
2573 --buflen; /* space for nul */
2575 for (i = 0; i < unicode_size; i++) {
2578 string[i] = (char)(le16_to_cpu(unicode[i]));
2584 /****************************************************************************
2585 * get_manufacturing_desc
2586 * reads in the manufacturing descriptor and stores it into the serial
2588 ****************************************************************************/
2589 static void get_manufacturing_desc (struct edgeport_serial *edge_serial)
2593 dbg("getting manufacturer descriptor");
2595 response = rom_read (edge_serial->serial, (EDGE_MANUF_DESC_ADDR & 0xffff0000) >> 16,
2596 (__u16)(EDGE_MANUF_DESC_ADDR & 0x0000ffff), EDGE_MANUF_DESC_LEN,
2597 (__u8 *)(&edge_serial->manuf_descriptor));
2600 dev_err(&edge_serial->serial->dev->dev, "error in getting manufacturer descriptor\n");
2603 dbg("**Manufacturer Descriptor");
2604 dbg(" RomSize: %dK", edge_serial->manuf_descriptor.RomSize);
2605 dbg(" RamSize: %dK", edge_serial->manuf_descriptor.RamSize);
2606 dbg(" CpuRev: %d", edge_serial->manuf_descriptor.CpuRev);
2607 dbg(" BoardRev: %d", edge_serial->manuf_descriptor.BoardRev);
2608 dbg(" NumPorts: %d", edge_serial->manuf_descriptor.NumPorts);
2609 dbg(" DescDate: %d/%d/%d", edge_serial->manuf_descriptor.DescDate[0], edge_serial->manuf_descriptor.DescDate[1], edge_serial->manuf_descriptor.DescDate[2]+1900);
2610 unicode_to_ascii(string, sizeof(string),
2611 edge_serial->manuf_descriptor.SerialNumber,
2612 edge_serial->manuf_descriptor.SerNumLength/2);
2613 dbg(" SerialNumber: %s", string);
2614 unicode_to_ascii(string, sizeof(string),
2615 edge_serial->manuf_descriptor.AssemblyNumber,
2616 edge_serial->manuf_descriptor.AssemblyNumLength/2);
2617 dbg(" AssemblyNumber: %s", string);
2618 unicode_to_ascii(string, sizeof(string),
2619 edge_serial->manuf_descriptor.OemAssyNumber,
2620 edge_serial->manuf_descriptor.OemAssyNumLength/2);
2621 dbg(" OemAssyNumber: %s", string);
2622 dbg(" UartType: %d", edge_serial->manuf_descriptor.UartType);
2623 dbg(" IonPid: %d", edge_serial->manuf_descriptor.IonPid);
2624 dbg(" IonConfig: %d", edge_serial->manuf_descriptor.IonConfig);
2629 /****************************************************************************
2631 * reads in the bootloader descriptor and stores it into the serial
2633 ****************************************************************************/
2634 static void get_boot_desc (struct edgeport_serial *edge_serial)
2638 dbg("getting boot descriptor");
2640 response = rom_read (edge_serial->serial, (EDGE_BOOT_DESC_ADDR & 0xffff0000) >> 16,
2641 (__u16)(EDGE_BOOT_DESC_ADDR & 0x0000ffff), EDGE_BOOT_DESC_LEN,
2642 (__u8 *)(&edge_serial->boot_descriptor));
2645 dev_err(&edge_serial->serial->dev->dev, "error in getting boot descriptor\n");
2647 dbg("**Boot Descriptor:");
2648 dbg(" BootCodeLength: %d", le16_to_cpu(edge_serial->boot_descriptor.BootCodeLength));
2649 dbg(" MajorVersion: %d", edge_serial->boot_descriptor.MajorVersion);
2650 dbg(" MinorVersion: %d", edge_serial->boot_descriptor.MinorVersion);
2651 dbg(" BuildNumber: %d", le16_to_cpu(edge_serial->boot_descriptor.BuildNumber));
2652 dbg(" Capabilities: 0x%x", le16_to_cpu(edge_serial->boot_descriptor.Capabilities));
2653 dbg(" UConfig0: %d", edge_serial->boot_descriptor.UConfig0);
2654 dbg(" UConfig1: %d", edge_serial->boot_descriptor.UConfig1);
2659 /****************************************************************************
2660 * load_application_firmware
2661 * This is called to load the application firmware to the device
2662 ****************************************************************************/
2663 static void load_application_firmware (struct edgeport_serial *edge_serial)
2665 struct edge_firmware_image_record *record;
2666 unsigned char *firmware;
2667 unsigned char *FirmwareImage;
2672 switch (edge_serial->product_info.iDownloadFile) {
2673 case EDGE_DOWNLOAD_FILE_I930:
2674 dbg("downloading firmware version (930) %d.%d.%d",
2675 OperationalCodeImageVersion_GEN1.MajorVersion,
2676 OperationalCodeImageVersion_GEN1.MinorVersion,
2677 OperationalCodeImageVersion_GEN1.BuildNumber);
2678 firmware = &OperationalCodeImage_GEN1[0];
2679 FirmwareImage = &OperationalCodeImage_GEN1[0];
2680 ImageSize = sizeof(OperationalCodeImage_GEN1);
2683 case EDGE_DOWNLOAD_FILE_80251:
2684 dbg("downloading firmware version (80251) %d.%d.%d",
2685 OperationalCodeImageVersion_GEN2.MajorVersion,
2686 OperationalCodeImageVersion_GEN2.MinorVersion,
2687 OperationalCodeImageVersion_GEN2.BuildNumber);
2688 firmware = &OperationalCodeImage_GEN2[0];
2689 FirmwareImage = &OperationalCodeImage_GEN2[0];
2690 ImageSize = sizeof(OperationalCodeImage_GEN2);
2693 case EDGE_DOWNLOAD_FILE_NONE:
2694 dbg ("No download file specified, skipping download\n");
2703 record = (struct edge_firmware_image_record *)firmware;
2704 response = sram_write (edge_serial->serial, le16_to_cpu(record->ExtAddr), le16_to_cpu(record->Addr), le16_to_cpu(record->Len), &record->Data[0]);
2706 dev_err(&edge_serial->serial->dev->dev, "sram_write failed (%x, %x, %d)\n", le16_to_cpu(record->ExtAddr), le16_to_cpu(record->Addr), le16_to_cpu(record->Len));
2709 firmware += sizeof (struct edge_firmware_image_record) + le16_to_cpu(record->Len);
2710 if (firmware >= &FirmwareImage[ImageSize]) {
2715 dbg("sending exec_dl_code");
2716 response = usb_control_msg (edge_serial->serial->dev,
2717 usb_sndctrlpipe(edge_serial->serial->dev, 0),
2718 USB_REQUEST_ION_EXEC_DL_CODE,
2719 0x40, 0x4000, 0x0001, NULL, 0, 3000);
2725 /****************************************************************************
2727 ****************************************************************************/
2728 static int edge_startup (struct usb_serial *serial)
2730 struct edgeport_serial *edge_serial;
2731 struct edgeport_port *edge_port;
2732 struct usb_device *dev;
2737 /* create our private serial structure */
2738 edge_serial = kzalloc(sizeof(struct edgeport_serial), GFP_KERNEL);
2739 if (edge_serial == NULL) {
2740 dev_err(&serial->dev->dev, "%s - Out of memory\n", __FUNCTION__);
2743 spin_lock_init(&edge_serial->es_lock);
2744 edge_serial->serial = serial;
2745 usb_set_serial_data(serial, edge_serial);
2747 /* get the name for the device from the device */
2748 i = get_string(dev, dev->descriptor.iManufacturer,
2749 &edge_serial->name[0], MAX_NAME_LEN+1);
2750 edge_serial->name[i++] = ' ';
2751 get_string(dev, dev->descriptor.iProduct,
2752 &edge_serial->name[i], MAX_NAME_LEN+2 - i);
2754 dev_info(&serial->dev->dev, "%s detected\n", edge_serial->name);
2756 /* get the manufacturing descriptor for this device */
2757 get_manufacturing_desc (edge_serial);
2759 /* get the boot descriptor */
2760 get_boot_desc (edge_serial);
2762 get_product_info(edge_serial);
2764 /* set the number of ports from the manufacturing description */
2765 /* serial->num_ports = serial->product_info.NumPorts; */
2766 if (edge_serial->product_info.NumPorts != serial->num_ports) {
2767 warn("%s - Device Reported %d serial ports vs core "
2768 "thinking we have %d ports, email greg@kroah.com this info.",
2769 __FUNCTION__, edge_serial->product_info.NumPorts,
2773 dbg("%s - time 1 %ld", __FUNCTION__, jiffies);
2775 /* now load the application firmware into this device */
2776 load_application_firmware (edge_serial);
2778 dbg("%s - time 2 %ld", __FUNCTION__, jiffies);
2780 /* Check current Edgeport EEPROM and update if necessary */
2781 update_edgeport_E2PROM (edge_serial);
2783 dbg("%s - time 3 %ld", __FUNCTION__, jiffies);
2785 /* set the configuration to use #1 */
2786 // dbg("set_configuration 1");
2787 // usb_set_configuration (dev, 1);
2789 /* we set up the pointers to the endpoints in the edge_open function,
2790 * as the structures aren't created yet. */
2792 /* set up our port private structures */
2793 for (i = 0; i < serial->num_ports; ++i) {
2794 edge_port = kmalloc (sizeof(struct edgeport_port), GFP_KERNEL);
2795 if (edge_port == NULL) {
2796 dev_err(&serial->dev->dev, "%s - Out of memory\n", __FUNCTION__);
2797 for (j = 0; j < i; ++j) {
2798 kfree (usb_get_serial_port_data(serial->port[j]));
2799 usb_set_serial_port_data(serial->port[j], NULL);
2801 usb_set_serial_data(serial, NULL);
2805 memset (edge_port, 0, sizeof(struct edgeport_port));
2806 spin_lock_init(&edge_port->ep_lock);
2807 edge_port->port = serial->port[i];
2808 usb_set_serial_port_data(serial->port[i], edge_port);
2815 /****************************************************************************
2817 * This function is called whenever the device is removed from the usb bus.
2818 ****************************************************************************/
2819 static void edge_shutdown (struct usb_serial *serial)
2823 dbg("%s", __FUNCTION__);
2825 /* stop reads and writes on all ports */
2826 for (i=0; i < serial->num_ports; ++i) {
2827 kfree (usb_get_serial_port_data(serial->port[i]));
2828 usb_set_serial_port_data(serial->port[i], NULL);
2830 kfree (usb_get_serial_data(serial));
2831 usb_set_serial_data(serial, NULL);
2835 /****************************************************************************
2837 * This is called by the module subsystem, or on startup to initialize us
2838 ****************************************************************************/
2839 static int __init edgeport_init(void)
2843 retval = usb_serial_register(&edgeport_2port_device);
2845 goto failed_2port_device_register;
2846 retval = usb_serial_register(&edgeport_4port_device);
2848 goto failed_4port_device_register;
2849 retval = usb_serial_register(&edgeport_8port_device);
2851 goto failed_8port_device_register;
2852 retval = usb_register(&io_driver);
2854 goto failed_usb_register;
2855 info(DRIVER_DESC " " DRIVER_VERSION);
2858 failed_usb_register:
2859 usb_serial_deregister(&edgeport_8port_device);
2860 failed_8port_device_register:
2861 usb_serial_deregister(&edgeport_4port_device);
2862 failed_4port_device_register:
2863 usb_serial_deregister(&edgeport_2port_device);
2864 failed_2port_device_register:
2869 /****************************************************************************
2871 * Called when the driver is about to be unloaded.
2872 ****************************************************************************/
2873 static void __exit edgeport_exit (void)
2875 usb_deregister (&io_driver);
2876 usb_serial_deregister (&edgeport_2port_device);
2877 usb_serial_deregister (&edgeport_4port_device);
2878 usb_serial_deregister (&edgeport_8port_device);
2881 module_init(edgeport_init);
2882 module_exit(edgeport_exit);
2884 /* Module information */
2885 MODULE_AUTHOR( DRIVER_AUTHOR );
2886 MODULE_DESCRIPTION( DRIVER_DESC );
2887 MODULE_LICENSE("GPL");
2889 module_param(debug, bool, S_IRUGO | S_IWUSR);
2890 MODULE_PARM_DESC(debug, "Debug enabled or not");
2892 module_param(low_latency, bool, S_IRUGO | S_IWUSR);
2893 MODULE_PARM_DESC(low_latency, "Low latency enabled or not");