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