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