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