1 // SPDX-License-Identifier: GPL-2.0+
3 * Edgeport USB Serial Converter driver
5 * Copyright (C) 2000 Inside Out Networks, All rights reserved.
6 * Copyright (C) 2001-2002 Greg Kroah-Hartman <greg@kroah.com>
8 * Supports the following devices:
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>.
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 */
49 #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com> and David Iacovelli"
50 #define DRIVER_DESC "Edgeport USB Serial Driver"
52 #define MAX_NAME_LEN 64
54 #define OPEN_TIMEOUT (5*HZ) /* 5 seconds */
56 static 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
) },
65 static 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
) },
79 static 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
) },
89 static 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
) },
101 /* Devices that this driver supports */
102 static 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 */
135 MODULE_DEVICE_TABLE(usb
, id_table_combined
);
138 /* receive port state */
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) */
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.
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 */
160 /* This structure holds all of the local port information */
161 struct edgeport_port
{
162 __u16 txCredits
; /* our current credits for this port */
163 __u16 maxTxCredits
; /* the max size of the port */
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 */
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 */
183 bool chaseResponsePending
;
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 */
189 struct usb_serial_port
*port
; /* loop back to the owner of this object */
193 /* This structure holds all of the individual device information */
194 struct edgeport_serial
{
195 char name
[MAX_NAME_LEN
+2]; /* string name of this device */
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 */
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 */
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
;
213 __u8 bulk_out_endpoint
; /* the bulk out endpoint handle */
215 __s16 rxBytesAvail
; /* the number of bytes that we need to read from this device */
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 parameter */
224 __s16 rxBytesRemaining
; /* the number of port bytes left to read */
225 struct usb_serial
*serial
; /* loop back to the owner of this object */
228 /* baud rate information */
229 struct divisor_table_entry
{
235 * Define table of divisors for Rev A EdgePort/4 hardware
236 * These assume a 3.6864MHz crystal, the standard /16, and
240 static const struct divisor_table_entry divisor_table
[] = {
243 { 110, 2095}, /* 2094.545455 => 230450 => .0217 % over */
244 { 134, 1713}, /* 1713.011152 => 230398.5 => .00065% under */
262 /* Number of outstanding Command Write Urbs */
263 static atomic_t CmdUrbs
= ATOMIC_INIT(0);
266 /* function prototypes */
268 static void edge_close(struct usb_serial_port
*port
);
270 static void process_rcvd_data(struct edgeport_serial
*edge_serial
,
271 unsigned char *buffer
, __u16 bufferLength
);
272 static void process_rcvd_status(struct edgeport_serial
*edge_serial
,
273 __u8 byte2
, __u8 byte3
);
274 static void edge_tty_recv(struct usb_serial_port
*port
, unsigned char *data
,
276 static void handle_new_msr(struct edgeport_port
*edge_port
, __u8 newMsr
);
277 static void handle_new_lsr(struct edgeport_port
*edge_port
, __u8 lsrData
,
278 __u8 lsr
, __u8 data
);
279 static int send_iosp_ext_cmd(struct edgeport_port
*edge_port
, __u8 command
,
281 static int calc_baud_rate_divisor(struct device
*dev
, int baud_rate
, int *divisor
);
282 static void change_port_settings(struct tty_struct
*tty
,
283 struct edgeport_port
*edge_port
,
284 const struct ktermios
*old_termios
);
285 static int send_cmd_write_uart_register(struct edgeport_port
*edge_port
,
286 __u8 regNum
, __u8 regValue
);
287 static int write_cmd_usb(struct edgeport_port
*edge_port
,
288 unsigned char *buffer
, int writeLength
);
289 static void send_more_port_data(struct edgeport_serial
*edge_serial
,
290 struct edgeport_port
*edge_port
);
292 static int rom_write(struct usb_serial
*serial
, __u16 extAddr
, __u16 addr
,
293 __u16 length
, const __u8
*data
);
295 /* ************************************************************************ */
296 /* ************************************************************************ */
297 /* ************************************************************************ */
298 /* ************************************************************************ */
300 /************************************************************************
302 * update_edgeport_E2PROM() Compare current versions of *
303 * Boot ROM and Manufacture *
304 * Descriptors with versions *
305 * embedded in this driver *
307 ************************************************************************/
308 static void update_edgeport_E2PROM(struct edgeport_serial
*edge_serial
)
310 struct device
*dev
= &edge_serial
->serial
->dev
->dev
;
313 __u8 BootMajorVersion
;
314 __u8 BootMinorVersion
;
315 __u16 BootBuildNumber
;
317 const struct ihex_binrec
*rec
;
318 const struct firmware
*fw
;
322 switch (edge_serial
->product_info
.iDownloadFile
) {
323 case EDGE_DOWNLOAD_FILE_I930
:
324 fw_name
= "edgeport/boot.fw";
326 case EDGE_DOWNLOAD_FILE_80251
:
327 fw_name
= "edgeport/boot2.fw";
333 response
= request_ihex_firmware(&fw
, fw_name
,
334 &edge_serial
->serial
->dev
->dev
);
336 dev_err(dev
, "Failed to load image \"%s\" err %d\n",
341 rec
= (const struct ihex_binrec
*)fw
->data
;
342 BootMajorVersion
= rec
->data
[0];
343 BootMinorVersion
= rec
->data
[1];
344 BootBuildNumber
= (rec
->data
[2] << 8) | rec
->data
[3];
346 /* Check Boot Image Version */
347 BootCurVer
= (edge_serial
->boot_descriptor
.MajorVersion
<< 24) +
348 (edge_serial
->boot_descriptor
.MinorVersion
<< 16) +
349 le16_to_cpu(edge_serial
->boot_descriptor
.BuildNumber
);
351 BootNewVer
= (BootMajorVersion
<< 24) +
352 (BootMinorVersion
<< 16) +
355 dev_dbg(dev
, "Current Boot Image version %d.%d.%d\n",
356 edge_serial
->boot_descriptor
.MajorVersion
,
357 edge_serial
->boot_descriptor
.MinorVersion
,
358 le16_to_cpu(edge_serial
->boot_descriptor
.BuildNumber
));
361 if (BootNewVer
> BootCurVer
) {
362 dev_dbg(dev
, "**Update Boot Image from %d.%d.%d to %d.%d.%d\n",
363 edge_serial
->boot_descriptor
.MajorVersion
,
364 edge_serial
->boot_descriptor
.MinorVersion
,
365 le16_to_cpu(edge_serial
->boot_descriptor
.BuildNumber
),
366 BootMajorVersion
, BootMinorVersion
, BootBuildNumber
);
368 dev_dbg(dev
, "Downloading new Boot Image\n");
370 for (rec
= ihex_next_binrec(rec
); rec
;
371 rec
= ihex_next_binrec(rec
)) {
372 Bootaddr
= be32_to_cpu(rec
->addr
);
373 response
= rom_write(edge_serial
->serial
,
376 be16_to_cpu(rec
->len
),
379 dev_err(&edge_serial
->serial
->dev
->dev
,
380 "rom_write failed (%x, %x, %d)\n",
381 Bootaddr
>> 16, Bootaddr
& 0xFFFF,
382 be16_to_cpu(rec
->len
));
387 dev_dbg(dev
, "Boot Image -- already up to date\n");
389 release_firmware(fw
);
392 static void dump_product_info(struct edgeport_serial
*edge_serial
,
393 struct edgeport_product_info
*product_info
)
395 struct device
*dev
= &edge_serial
->serial
->dev
->dev
;
397 /* Dump Product Info structure */
398 dev_dbg(dev
, "**Product Information:\n");
399 dev_dbg(dev
, " ProductId %x\n", product_info
->ProductId
);
400 dev_dbg(dev
, " NumPorts %d\n", product_info
->NumPorts
);
401 dev_dbg(dev
, " ProdInfoVer %d\n", product_info
->ProdInfoVer
);
402 dev_dbg(dev
, " IsServer %d\n", product_info
->IsServer
);
403 dev_dbg(dev
, " IsRS232 %d\n", product_info
->IsRS232
);
404 dev_dbg(dev
, " IsRS422 %d\n", product_info
->IsRS422
);
405 dev_dbg(dev
, " IsRS485 %d\n", product_info
->IsRS485
);
406 dev_dbg(dev
, " RomSize %d\n", product_info
->RomSize
);
407 dev_dbg(dev
, " RamSize %d\n", product_info
->RamSize
);
408 dev_dbg(dev
, " CpuRev %x\n", product_info
->CpuRev
);
409 dev_dbg(dev
, " BoardRev %x\n", product_info
->BoardRev
);
410 dev_dbg(dev
, " BootMajorVersion %d.%d.%d\n",
411 product_info
->BootMajorVersion
,
412 product_info
->BootMinorVersion
,
413 le16_to_cpu(product_info
->BootBuildNumber
));
414 dev_dbg(dev
, " FirmwareMajorVersion %d.%d.%d\n",
415 product_info
->FirmwareMajorVersion
,
416 product_info
->FirmwareMinorVersion
,
417 le16_to_cpu(product_info
->FirmwareBuildNumber
));
418 dev_dbg(dev
, " ManufactureDescDate %d/%d/%d\n",
419 product_info
->ManufactureDescDate
[0],
420 product_info
->ManufactureDescDate
[1],
421 product_info
->ManufactureDescDate
[2]+1900);
422 dev_dbg(dev
, " iDownloadFile 0x%x\n",
423 product_info
->iDownloadFile
);
424 dev_dbg(dev
, " EpicVer %d\n", product_info
->EpicVer
);
427 static void get_product_info(struct edgeport_serial
*edge_serial
)
429 struct edgeport_product_info
*product_info
= &edge_serial
->product_info
;
431 memset(product_info
, 0, sizeof(struct edgeport_product_info
));
433 product_info
->ProductId
= (__u16
)(le16_to_cpu(edge_serial
->serial
->dev
->descriptor
.idProduct
) & ~ION_DEVICE_ID_80251_NETCHIP
);
434 product_info
->NumPorts
= edge_serial
->manuf_descriptor
.NumPorts
;
435 product_info
->ProdInfoVer
= 0;
437 product_info
->RomSize
= edge_serial
->manuf_descriptor
.RomSize
;
438 product_info
->RamSize
= edge_serial
->manuf_descriptor
.RamSize
;
439 product_info
->CpuRev
= edge_serial
->manuf_descriptor
.CpuRev
;
440 product_info
->BoardRev
= edge_serial
->manuf_descriptor
.BoardRev
;
442 product_info
->BootMajorVersion
=
443 edge_serial
->boot_descriptor
.MajorVersion
;
444 product_info
->BootMinorVersion
=
445 edge_serial
->boot_descriptor
.MinorVersion
;
446 product_info
->BootBuildNumber
=
447 edge_serial
->boot_descriptor
.BuildNumber
;
449 memcpy(product_info
->ManufactureDescDate
,
450 edge_serial
->manuf_descriptor
.DescDate
,
451 sizeof(edge_serial
->manuf_descriptor
.DescDate
));
453 /* check if this is 2nd generation hardware */
454 if (le16_to_cpu(edge_serial
->serial
->dev
->descriptor
.idProduct
)
455 & ION_DEVICE_ID_80251_NETCHIP
)
456 product_info
->iDownloadFile
= EDGE_DOWNLOAD_FILE_80251
;
458 product_info
->iDownloadFile
= EDGE_DOWNLOAD_FILE_I930
;
460 /* Determine Product type and set appropriate flags */
461 switch (DEVICE_ID_FROM_USB_PRODUCT_ID(product_info
->ProductId
)) {
462 case ION_DEVICE_ID_EDGEPORT_COMPATIBLE
:
463 case ION_DEVICE_ID_EDGEPORT_4T
:
464 case ION_DEVICE_ID_EDGEPORT_4
:
465 case ION_DEVICE_ID_EDGEPORT_2
:
466 case ION_DEVICE_ID_EDGEPORT_8_DUAL_CPU
:
467 case ION_DEVICE_ID_EDGEPORT_8
:
468 case ION_DEVICE_ID_EDGEPORT_421
:
469 case ION_DEVICE_ID_EDGEPORT_21
:
470 case ION_DEVICE_ID_EDGEPORT_2_DIN
:
471 case ION_DEVICE_ID_EDGEPORT_4_DIN
:
472 case ION_DEVICE_ID_EDGEPORT_16_DUAL_CPU
:
473 product_info
->IsRS232
= 1;
476 case ION_DEVICE_ID_EDGEPORT_2I
: /* Edgeport/2 RS422/RS485 */
477 product_info
->IsRS422
= 1;
478 product_info
->IsRS485
= 1;
481 case ION_DEVICE_ID_EDGEPORT_8I
: /* Edgeport/4 RS422 */
482 case ION_DEVICE_ID_EDGEPORT_4I
: /* Edgeport/4 RS422 */
483 product_info
->IsRS422
= 1;
487 dump_product_info(edge_serial
, product_info
);
490 static int get_epic_descriptor(struct edgeport_serial
*ep
)
493 struct usb_serial
*serial
= ep
->serial
;
494 struct edgeport_product_info
*product_info
= &ep
->product_info
;
495 struct edge_compatibility_descriptor
*epic
;
496 struct edge_compatibility_bits
*bits
;
497 struct device
*dev
= &serial
->dev
->dev
;
501 epic
= kmalloc(sizeof(*epic
), GFP_KERNEL
);
505 result
= usb_control_msg(serial
->dev
, usb_rcvctrlpipe(serial
->dev
, 0),
506 USB_REQUEST_ION_GET_EPIC_DESC
,
510 if (result
== sizeof(*epic
)) {
512 memcpy(&ep
->epic_descriptor
, epic
, sizeof(*epic
));
513 memset(product_info
, 0, sizeof(struct edgeport_product_info
));
515 product_info
->NumPorts
= epic
->NumPorts
;
516 product_info
->ProdInfoVer
= 0;
517 product_info
->FirmwareMajorVersion
= epic
->MajorVersion
;
518 product_info
->FirmwareMinorVersion
= epic
->MinorVersion
;
519 product_info
->FirmwareBuildNumber
= epic
->BuildNumber
;
520 product_info
->iDownloadFile
= epic
->iDownloadFile
;
521 product_info
->EpicVer
= epic
->EpicVer
;
522 product_info
->Epic
= epic
->Supports
;
523 product_info
->ProductId
= ION_DEVICE_ID_EDGEPORT_COMPATIBLE
;
524 dump_product_info(ep
, product_info
);
526 bits
= &ep
->epic_descriptor
.Supports
;
527 dev_dbg(dev
, "**EPIC descriptor:\n");
528 dev_dbg(dev
, " VendEnableSuspend: %s\n", bits
->VendEnableSuspend
? "TRUE": "FALSE");
529 dev_dbg(dev
, " IOSPOpen : %s\n", bits
->IOSPOpen
? "TRUE": "FALSE");
530 dev_dbg(dev
, " IOSPClose : %s\n", bits
->IOSPClose
? "TRUE": "FALSE");
531 dev_dbg(dev
, " IOSPChase : %s\n", bits
->IOSPChase
? "TRUE": "FALSE");
532 dev_dbg(dev
, " IOSPSetRxFlow : %s\n", bits
->IOSPSetRxFlow
? "TRUE": "FALSE");
533 dev_dbg(dev
, " IOSPSetTxFlow : %s\n", bits
->IOSPSetTxFlow
? "TRUE": "FALSE");
534 dev_dbg(dev
, " IOSPSetXChar : %s\n", bits
->IOSPSetXChar
? "TRUE": "FALSE");
535 dev_dbg(dev
, " IOSPRxCheck : %s\n", bits
->IOSPRxCheck
? "TRUE": "FALSE");
536 dev_dbg(dev
, " IOSPSetClrBreak : %s\n", bits
->IOSPSetClrBreak
? "TRUE": "FALSE");
537 dev_dbg(dev
, " IOSPWriteMCR : %s\n", bits
->IOSPWriteMCR
? "TRUE": "FALSE");
538 dev_dbg(dev
, " IOSPWriteLCR : %s\n", bits
->IOSPWriteLCR
? "TRUE": "FALSE");
539 dev_dbg(dev
, " IOSPSetBaudRate : %s\n", bits
->IOSPSetBaudRate
? "TRUE": "FALSE");
540 dev_dbg(dev
, " TrueEdgeport : %s\n", bits
->TrueEdgeport
? "TRUE": "FALSE");
543 } else if (result
>= 0) {
544 dev_warn(&serial
->interface
->dev
, "short epic descriptor received: %d\n",
555 /************************************************************************/
556 /************************************************************************/
557 /* U S B C A L L B A C K F U N C T I O N S */
558 /* U S B C A L L B A C K F U N C T I O N S */
559 /************************************************************************/
560 /************************************************************************/
562 /*****************************************************************************
563 * edge_interrupt_callback
564 * this is the callback function for when we have received data on the
565 * interrupt endpoint.
566 *****************************************************************************/
567 static void edge_interrupt_callback(struct urb
*urb
)
569 struct edgeport_serial
*edge_serial
= urb
->context
;
571 struct edgeport_port
*edge_port
;
572 struct usb_serial_port
*port
;
573 unsigned char *data
= urb
->transfer_buffer
;
574 int length
= urb
->actual_length
;
581 int status
= urb
->status
;
590 /* this urb is terminated, clean up */
591 dev_dbg(&urb
->dev
->dev
, "%s - urb shutting down with status: %d\n", __func__
, status
);
594 dev_dbg(&urb
->dev
->dev
, "%s - nonzero urb status received: %d\n", __func__
, status
);
598 dev
= &edge_serial
->serial
->dev
->dev
;
600 /* process this interrupt-read even if there are no ports open */
602 usb_serial_debug_data(dev
, __func__
, length
, data
);
605 bytes_avail
= data
[0] | (data
[1] << 8);
607 spin_lock_irqsave(&edge_serial
->es_lock
, flags
);
608 edge_serial
->rxBytesAvail
+= bytes_avail
;
610 "%s - bytes_avail=%d, rxBytesAvail=%d, read_in_progress=%d\n",
611 __func__
, bytes_avail
,
612 edge_serial
->rxBytesAvail
,
613 edge_serial
->read_in_progress
);
615 if (edge_serial
->rxBytesAvail
> 0 &&
616 !edge_serial
->read_in_progress
) {
617 dev_dbg(dev
, "%s - posting a read\n", __func__
);
618 edge_serial
->read_in_progress
= true;
620 /* we have pending bytes on the
621 bulk in pipe, send a request */
622 result
= usb_submit_urb(edge_serial
->read_urb
, GFP_ATOMIC
);
625 "%s - usb_submit_urb(read bulk) failed with result = %d\n",
627 edge_serial
->read_in_progress
= false;
630 spin_unlock_irqrestore(&edge_serial
->es_lock
,
634 /* grab the txcredits for the ports if available */
637 while ((position
< length
- 1) &&
638 (portNumber
< edge_serial
->serial
->num_ports
)) {
639 txCredits
= data
[position
] | (data
[position
+1] << 8);
641 port
= edge_serial
->serial
->port
[portNumber
];
642 edge_port
= usb_get_serial_port_data(port
);
643 if (edge_port
&& edge_port
->open
) {
644 spin_lock_irqsave(&edge_port
->ep_lock
,
646 edge_port
->txCredits
+= txCredits
;
647 spin_unlock_irqrestore(&edge_port
->ep_lock
,
649 dev_dbg(dev
, "%s - txcredits for port%d = %d\n",
650 __func__
, portNumber
,
651 edge_port
->txCredits
);
653 /* tell the tty driver that something
655 tty_port_tty_wakeup(&edge_port
->port
->port
);
656 /* Since we have more credit, check
657 if more data can be sent */
658 send_more_port_data(edge_serial
,
668 result
= usb_submit_urb(urb
, GFP_ATOMIC
);
670 dev_err(&urb
->dev
->dev
,
671 "%s - Error %d submitting control urb\n",
676 /*****************************************************************************
677 * edge_bulk_in_callback
678 * this is the callback function for when we have received data on the
680 *****************************************************************************/
681 static void edge_bulk_in_callback(struct urb
*urb
)
683 struct edgeport_serial
*edge_serial
= urb
->context
;
685 unsigned char *data
= urb
->transfer_buffer
;
687 __u16 raw_data_length
;
688 int status
= urb
->status
;
692 dev_dbg(&urb
->dev
->dev
, "%s - nonzero read bulk status received: %d\n",
694 edge_serial
->read_in_progress
= false;
698 if (urb
->actual_length
== 0) {
699 dev_dbg(&urb
->dev
->dev
, "%s - read bulk callback with no data\n", __func__
);
700 edge_serial
->read_in_progress
= false;
704 dev
= &edge_serial
->serial
->dev
->dev
;
705 raw_data_length
= urb
->actual_length
;
707 usb_serial_debug_data(dev
, __func__
, raw_data_length
, data
);
709 spin_lock_irqsave(&edge_serial
->es_lock
, flags
);
711 /* decrement our rxBytes available by the number that we just got */
712 edge_serial
->rxBytesAvail
-= raw_data_length
;
714 dev_dbg(dev
, "%s - Received = %d, rxBytesAvail %d\n", __func__
,
715 raw_data_length
, edge_serial
->rxBytesAvail
);
717 process_rcvd_data(edge_serial
, data
, urb
->actual_length
);
719 /* check to see if there's any more data for us to read */
720 if (edge_serial
->rxBytesAvail
> 0) {
721 dev_dbg(dev
, "%s - posting a read\n", __func__
);
722 retval
= usb_submit_urb(edge_serial
->read_urb
, GFP_ATOMIC
);
725 "%s - usb_submit_urb(read bulk) failed, retval = %d\n",
727 edge_serial
->read_in_progress
= false;
730 edge_serial
->read_in_progress
= false;
733 spin_unlock_irqrestore(&edge_serial
->es_lock
, flags
);
737 /*****************************************************************************
738 * edge_bulk_out_data_callback
739 * this is the callback function for when we have finished sending
740 * serial data on the bulk out endpoint.
741 *****************************************************************************/
742 static void edge_bulk_out_data_callback(struct urb
*urb
)
744 struct edgeport_port
*edge_port
= urb
->context
;
745 int status
= urb
->status
;
748 dev_dbg(&urb
->dev
->dev
,
749 "%s - nonzero write bulk status received: %d\n",
754 tty_port_tty_wakeup(&edge_port
->port
->port
);
756 /* Release the Write URB */
757 edge_port
->write_in_progress
= false;
759 /* Check if more data needs to be sent */
760 send_more_port_data((struct edgeport_serial
*)
761 (usb_get_serial_data(edge_port
->port
->serial
)), edge_port
);
765 /*****************************************************************************
767 * this is the callback function for when we have finished sending a
768 * command on the bulk out endpoint.
769 *****************************************************************************/
770 static void edge_bulk_out_cmd_callback(struct urb
*urb
)
772 struct edgeport_port
*edge_port
= urb
->context
;
773 struct device
*dev
= &urb
->dev
->dev
;
774 int status
= urb
->status
;
776 atomic_dec(&CmdUrbs
);
777 dev_dbg(dev
, "%s - FREE URB %p (outstanding %d)\n", __func__
, urb
,
778 atomic_read(&CmdUrbs
));
781 /* clean up the transfer buffer */
782 kfree(urb
->transfer_buffer
);
784 /* Free the command urb */
788 dev_dbg(dev
, "%s - nonzero write bulk status received: %d\n",
793 /* tell the tty driver that something has changed */
795 tty_port_tty_wakeup(&edge_port
->port
->port
);
797 /* we have completed the command */
798 edge_port
->commandPending
= false;
799 wake_up(&edge_port
->wait_command
);
803 /*****************************************************************************
804 * Driver tty interface functions
805 *****************************************************************************/
807 /*****************************************************************************
809 * this function is called by the tty driver when a port is opened
810 * If successful, we return 0
811 * Otherwise we return a negative error number.
812 *****************************************************************************/
813 static int edge_open(struct tty_struct
*tty
, struct usb_serial_port
*port
)
815 struct edgeport_port
*edge_port
= usb_get_serial_port_data(port
);
816 struct device
*dev
= &port
->dev
;
817 struct usb_serial
*serial
;
818 struct edgeport_serial
*edge_serial
;
821 if (edge_port
== NULL
)
824 /* see if we've set up our endpoint info yet (can't set it up
825 in edge_startup as the structures were not set up at that time.) */
826 serial
= port
->serial
;
827 edge_serial
= usb_get_serial_data(serial
);
828 if (edge_serial
== NULL
)
830 if (edge_serial
->interrupt_in_buffer
== NULL
) {
831 struct usb_serial_port
*port0
= serial
->port
[0];
833 /* not set up yet, so do it now */
834 edge_serial
->interrupt_in_buffer
=
835 port0
->interrupt_in_buffer
;
836 edge_serial
->interrupt_in_endpoint
=
837 port0
->interrupt_in_endpointAddress
;
838 edge_serial
->interrupt_read_urb
= port0
->interrupt_in_urb
;
839 edge_serial
->bulk_in_buffer
= port0
->bulk_in_buffer
;
840 edge_serial
->bulk_in_endpoint
=
841 port0
->bulk_in_endpointAddress
;
842 edge_serial
->read_urb
= port0
->read_urb
;
843 edge_serial
->bulk_out_endpoint
=
844 port0
->bulk_out_endpointAddress
;
846 /* set up our interrupt urb */
847 usb_fill_int_urb(edge_serial
->interrupt_read_urb
,
849 usb_rcvintpipe(serial
->dev
,
850 port0
->interrupt_in_endpointAddress
),
851 port0
->interrupt_in_buffer
,
852 edge_serial
->interrupt_read_urb
->transfer_buffer_length
,
853 edge_interrupt_callback
, edge_serial
,
854 edge_serial
->interrupt_read_urb
->interval
);
856 /* set up our bulk in urb */
857 usb_fill_bulk_urb(edge_serial
->read_urb
, serial
->dev
,
858 usb_rcvbulkpipe(serial
->dev
,
859 port0
->bulk_in_endpointAddress
),
860 port0
->bulk_in_buffer
,
861 edge_serial
->read_urb
->transfer_buffer_length
,
862 edge_bulk_in_callback
, edge_serial
);
863 edge_serial
->read_in_progress
= false;
865 /* start interrupt read for this edgeport
866 * this interrupt will continue as long
867 * as the edgeport is connected */
868 response
= usb_submit_urb(edge_serial
->interrupt_read_urb
,
871 dev_err(dev
, "%s - Error %d submitting control urb\n",
876 /* initialize our wait queues */
877 init_waitqueue_head(&edge_port
->wait_open
);
878 init_waitqueue_head(&edge_port
->wait_chase
);
879 init_waitqueue_head(&edge_port
->wait_command
);
881 /* initialize our port settings */
882 edge_port
->txCredits
= 0; /* Can't send any data yet */
883 /* Must always set this bit to enable ints! */
884 edge_port
->shadowMCR
= MCR_MASTER_IE
;
885 edge_port
->chaseResponsePending
= false;
887 /* send a open port command */
888 edge_port
->openPending
= true;
889 edge_port
->open
= false;
890 response
= send_iosp_ext_cmd(edge_port
, IOSP_CMD_OPEN_PORT
, 0);
893 dev_err(dev
, "%s - error sending open port command\n", __func__
);
894 edge_port
->openPending
= false;
898 /* now wait for the port to be completely opened */
899 wait_event_timeout(edge_port
->wait_open
, !edge_port
->openPending
,
902 if (!edge_port
->open
) {
904 dev_dbg(dev
, "%s - open timeout\n", __func__
);
905 edge_port
->openPending
= false;
909 /* create the txfifo */
910 edge_port
->txfifo
.head
= 0;
911 edge_port
->txfifo
.tail
= 0;
912 edge_port
->txfifo
.count
= 0;
913 edge_port
->txfifo
.size
= edge_port
->maxTxCredits
;
914 edge_port
->txfifo
.fifo
= kmalloc(edge_port
->maxTxCredits
, GFP_KERNEL
);
916 if (!edge_port
->txfifo
.fifo
) {
921 /* Allocate a URB for the write */
922 edge_port
->write_urb
= usb_alloc_urb(0, GFP_KERNEL
);
923 edge_port
->write_in_progress
= false;
925 if (!edge_port
->write_urb
) {
930 dev_dbg(dev
, "%s - Initialize TX fifo to %d bytes\n",
931 __func__
, edge_port
->maxTxCredits
);
937 /************************************************************************
939 * block_until_chase_response
941 * This function will block the close until one of the following:
942 * 1. Response to our Chase comes from Edgeport
943 * 2. A timeout of 10 seconds without activity has expired
944 * (1K of Edgeport data @ 2400 baud ==> 4 sec to empty)
946 ************************************************************************/
947 static void block_until_chase_response(struct edgeport_port
*edge_port
)
949 struct device
*dev
= &edge_port
->port
->dev
;
956 /* Save Last credits */
957 lastCredits
= edge_port
->txCredits
;
959 /* Did we get our Chase response */
960 if (!edge_port
->chaseResponsePending
) {
961 dev_dbg(dev
, "%s - Got Chase Response\n", __func__
);
963 /* did we get all of our credit back? */
964 if (edge_port
->txCredits
== edge_port
->maxTxCredits
) {
965 dev_dbg(dev
, "%s - Got all credits\n", __func__
);
970 /* Block the thread for a while */
971 prepare_to_wait(&edge_port
->wait_chase
, &wait
,
972 TASK_UNINTERRUPTIBLE
);
973 schedule_timeout(timeout
);
974 finish_wait(&edge_port
->wait_chase
, &wait
);
976 if (lastCredits
== edge_port
->txCredits
) {
977 /* No activity.. count down. */
980 edge_port
->chaseResponsePending
= false;
981 dev_dbg(dev
, "%s - Chase TIMEOUT\n", __func__
);
985 /* Reset timeout value back to 10 seconds */
986 dev_dbg(dev
, "%s - Last %d, Current %d\n", __func__
,
987 lastCredits
, edge_port
->txCredits
);
994 /************************************************************************
996 * block_until_tx_empty
998 * This function will block the close until one of the following:
1000 * 2. The edgeport has stopped
1001 * 3. A timeout of 3 seconds without activity has expired
1003 ************************************************************************/
1004 static void block_until_tx_empty(struct edgeport_port
*edge_port
)
1006 struct device
*dev
= &edge_port
->port
->dev
;
1008 struct TxFifo
*fifo
= &edge_port
->txfifo
;
1010 int timeout
= HZ
/10;
1014 /* Save Last count */
1015 lastCount
= fifo
->count
;
1017 /* Is the Edgeport Buffer empty? */
1018 if (lastCount
== 0) {
1019 dev_dbg(dev
, "%s - TX Buffer Empty\n", __func__
);
1023 /* Block the thread for a while */
1024 prepare_to_wait(&edge_port
->wait_chase
, &wait
,
1025 TASK_UNINTERRUPTIBLE
);
1026 schedule_timeout(timeout
);
1027 finish_wait(&edge_port
->wait_chase
, &wait
);
1029 dev_dbg(dev
, "%s wait\n", __func__
);
1031 if (lastCount
== fifo
->count
) {
1032 /* No activity.. count down. */
1035 dev_dbg(dev
, "%s - TIMEOUT\n", __func__
);
1039 /* Reset timeout value back to seconds */
1046 /*****************************************************************************
1048 * this function is called by the tty driver when a port is closed
1049 *****************************************************************************/
1050 static void edge_close(struct usb_serial_port
*port
)
1052 struct edgeport_serial
*edge_serial
;
1053 struct edgeport_port
*edge_port
;
1056 edge_serial
= usb_get_serial_data(port
->serial
);
1057 edge_port
= usb_get_serial_port_data(port
);
1058 if (edge_serial
== NULL
|| edge_port
== NULL
)
1061 /* block until tx is empty */
1062 block_until_tx_empty(edge_port
);
1064 edge_port
->closePending
= true;
1066 if (!edge_serial
->is_epic
||
1067 edge_serial
->epic_descriptor
.Supports
.IOSPChase
) {
1068 /* flush and chase */
1069 edge_port
->chaseResponsePending
= true;
1071 dev_dbg(&port
->dev
, "%s - Sending IOSP_CMD_CHASE_PORT\n", __func__
);
1072 status
= send_iosp_ext_cmd(edge_port
, IOSP_CMD_CHASE_PORT
, 0);
1074 /* block until chase finished */
1075 block_until_chase_response(edge_port
);
1077 edge_port
->chaseResponsePending
= false;
1080 if (!edge_serial
->is_epic
||
1081 edge_serial
->epic_descriptor
.Supports
.IOSPClose
) {
1082 /* close the port */
1083 dev_dbg(&port
->dev
, "%s - Sending IOSP_CMD_CLOSE_PORT\n", __func__
);
1084 send_iosp_ext_cmd(edge_port
, IOSP_CMD_CLOSE_PORT
, 0);
1087 /* port->close = true; */
1088 edge_port
->closePending
= false;
1089 edge_port
->open
= false;
1090 edge_port
->openPending
= false;
1092 usb_kill_urb(edge_port
->write_urb
);
1094 if (edge_port
->write_urb
) {
1095 /* if this urb had a transfer buffer already
1096 (old transfer) free it */
1097 kfree(edge_port
->write_urb
->transfer_buffer
);
1098 usb_free_urb(edge_port
->write_urb
);
1099 edge_port
->write_urb
= NULL
;
1101 kfree(edge_port
->txfifo
.fifo
);
1102 edge_port
->txfifo
.fifo
= NULL
;
1105 /*****************************************************************************
1107 * this function is called by the tty driver when data should be written
1109 * If successful, we return the number of bytes written, otherwise we
1110 * return a negative error number.
1111 *****************************************************************************/
1112 static int edge_write(struct tty_struct
*tty
, struct usb_serial_port
*port
,
1113 const unsigned char *data
, int count
)
1115 struct edgeport_port
*edge_port
= usb_get_serial_port_data(port
);
1116 struct TxFifo
*fifo
;
1121 unsigned long flags
;
1123 if (edge_port
== NULL
)
1126 /* get a pointer to the Tx fifo */
1127 fifo
= &edge_port
->txfifo
;
1129 spin_lock_irqsave(&edge_port
->ep_lock
, flags
);
1131 /* calculate number of bytes to put in fifo */
1132 copySize
= min_t(unsigned int, count
,
1133 (edge_port
->txCredits
- fifo
->count
));
1135 dev_dbg(&port
->dev
, "%s of %d byte(s) Fifo room %d -- will copy %d bytes\n",
1136 __func__
, count
, edge_port
->txCredits
- fifo
->count
, copySize
);
1138 /* catch writes of 0 bytes which the tty driver likes to give us,
1139 and when txCredits is empty */
1140 if (copySize
== 0) {
1141 dev_dbg(&port
->dev
, "%s - copySize = Zero\n", __func__
);
1146 * since we can never overflow the buffer we do not have to check for a
1149 * the copy is done is two parts -- first fill to the end of the buffer
1150 * then copy the reset from the start of the buffer
1152 bytesleft
= fifo
->size
- fifo
->head
;
1153 firsthalf
= min(bytesleft
, copySize
);
1154 dev_dbg(&port
->dev
, "%s - copy %d bytes of %d into fifo \n", __func__
,
1155 firsthalf
, bytesleft
);
1157 /* now copy our data */
1158 memcpy(&fifo
->fifo
[fifo
->head
], data
, firsthalf
);
1159 usb_serial_debug_data(&port
->dev
, __func__
, firsthalf
, &fifo
->fifo
[fifo
->head
]);
1161 /* update the index and size */
1162 fifo
->head
+= firsthalf
;
1163 fifo
->count
+= firsthalf
;
1165 /* wrap the index */
1166 if (fifo
->head
== fifo
->size
)
1169 secondhalf
= copySize
-firsthalf
;
1172 dev_dbg(&port
->dev
, "%s - copy rest of data %d\n", __func__
, secondhalf
);
1173 memcpy(&fifo
->fifo
[fifo
->head
], &data
[firsthalf
], secondhalf
);
1174 usb_serial_debug_data(&port
->dev
, __func__
, secondhalf
, &fifo
->fifo
[fifo
->head
]);
1175 /* update the index and size */
1176 fifo
->count
+= secondhalf
;
1177 fifo
->head
+= secondhalf
;
1178 /* No need to check for wrap since we can not get to end of
1179 * the fifo in this part
1184 spin_unlock_irqrestore(&edge_port
->ep_lock
, flags
);
1186 send_more_port_data((struct edgeport_serial
*)
1187 usb_get_serial_data(port
->serial
), edge_port
);
1189 dev_dbg(&port
->dev
, "%s wrote %d byte(s) TxCredits %d, Fifo %d\n",
1190 __func__
, copySize
, edge_port
->txCredits
, fifo
->count
);
1196 /************************************************************************
1198 * send_more_port_data()
1200 * This routine attempts to write additional UART transmit data
1201 * to a port over the USB bulk pipe. It is called (1) when new
1202 * data has been written to a port's TxBuffer from higher layers
1203 * (2) when the peripheral sends us additional TxCredits indicating
1204 * that it can accept more Tx data for a given port; and (3) when
1205 * a bulk write completes successfully and we want to see if we
1206 * can transmit more.
1208 ************************************************************************/
1209 static void send_more_port_data(struct edgeport_serial
*edge_serial
,
1210 struct edgeport_port
*edge_port
)
1212 struct TxFifo
*fifo
= &edge_port
->txfifo
;
1213 struct device
*dev
= &edge_port
->port
->dev
;
1215 unsigned char *buffer
;
1221 unsigned long flags
;
1223 spin_lock_irqsave(&edge_port
->ep_lock
, flags
);
1225 if (edge_port
->write_in_progress
||
1227 (fifo
->count
== 0)) {
1228 dev_dbg(dev
, "%s EXIT - fifo %d, PendingWrite = %d\n",
1229 __func__
, fifo
->count
, edge_port
->write_in_progress
);
1233 /* since the amount of data in the fifo will always fit into the
1234 * edgeport buffer we do not need to check the write length
1236 * Do we have enough credits for this port to make it worthwhile
1237 * to bother queueing a write. If it's too small, say a few bytes,
1238 * it's better to wait for more credits so we can do a larger write.
1240 if (edge_port
->txCredits
< EDGE_FW_GET_TX_CREDITS_SEND_THRESHOLD(edge_port
->maxTxCredits
, EDGE_FW_BULK_MAX_PACKET_SIZE
)) {
1241 dev_dbg(dev
, "%s Not enough credit - fifo %d TxCredit %d\n",
1242 __func__
, fifo
->count
, edge_port
->txCredits
);
1246 /* lock this write */
1247 edge_port
->write_in_progress
= true;
1249 /* get a pointer to the write_urb */
1250 urb
= edge_port
->write_urb
;
1252 /* make sure transfer buffer is freed */
1253 kfree(urb
->transfer_buffer
);
1254 urb
->transfer_buffer
= NULL
;
1256 /* build the data header for the buffer and port that we are about
1258 count
= fifo
->count
;
1259 buffer
= kmalloc(count
+2, GFP_ATOMIC
);
1261 edge_port
->write_in_progress
= false;
1264 buffer
[0] = IOSP_BUILD_DATA_HDR1(edge_port
->port
->port_number
, count
);
1265 buffer
[1] = IOSP_BUILD_DATA_HDR2(edge_port
->port
->port_number
, count
);
1267 /* now copy our data */
1268 bytesleft
= fifo
->size
- fifo
->tail
;
1269 firsthalf
= min(bytesleft
, count
);
1270 memcpy(&buffer
[2], &fifo
->fifo
[fifo
->tail
], firsthalf
);
1271 fifo
->tail
+= firsthalf
;
1272 fifo
->count
-= firsthalf
;
1273 if (fifo
->tail
== fifo
->size
)
1276 secondhalf
= count
-firsthalf
;
1278 memcpy(&buffer
[2+firsthalf
], &fifo
->fifo
[fifo
->tail
],
1280 fifo
->tail
+= secondhalf
;
1281 fifo
->count
-= secondhalf
;
1285 usb_serial_debug_data(&edge_port
->port
->dev
, __func__
, count
, &buffer
[2]);
1287 /* fill up the urb with all of our data and submit it */
1288 usb_fill_bulk_urb(urb
, edge_serial
->serial
->dev
,
1289 usb_sndbulkpipe(edge_serial
->serial
->dev
,
1290 edge_serial
->bulk_out_endpoint
),
1292 edge_bulk_out_data_callback
, edge_port
);
1294 /* decrement the number of credits we have by the number we just sent */
1295 edge_port
->txCredits
-= count
;
1296 edge_port
->port
->icount
.tx
+= count
;
1298 status
= usb_submit_urb(urb
, GFP_ATOMIC
);
1300 /* something went wrong */
1301 dev_err_console(edge_port
->port
,
1302 "%s - usb_submit_urb(write bulk) failed, status = %d, data lost\n",
1304 edge_port
->write_in_progress
= false;
1306 /* revert the credits as something bad happened. */
1307 edge_port
->txCredits
+= count
;
1308 edge_port
->port
->icount
.tx
-= count
;
1310 dev_dbg(dev
, "%s wrote %d byte(s) TxCredit %d, Fifo %d\n",
1311 __func__
, count
, edge_port
->txCredits
, fifo
->count
);
1314 spin_unlock_irqrestore(&edge_port
->ep_lock
, flags
);
1318 /*****************************************************************************
1320 * this function is called by the tty driver when it wants to know how
1321 * many bytes of data we can accept for a specific port.
1322 *****************************************************************************/
1323 static unsigned int edge_write_room(struct tty_struct
*tty
)
1325 struct usb_serial_port
*port
= tty
->driver_data
;
1326 struct edgeport_port
*edge_port
= usb_get_serial_port_data(port
);
1328 unsigned long flags
;
1330 /* total of both buffers is still txCredit */
1331 spin_lock_irqsave(&edge_port
->ep_lock
, flags
);
1332 room
= edge_port
->txCredits
- edge_port
->txfifo
.count
;
1333 spin_unlock_irqrestore(&edge_port
->ep_lock
, flags
);
1335 dev_dbg(&port
->dev
, "%s - returns %u\n", __func__
, room
);
1340 /*****************************************************************************
1341 * edge_chars_in_buffer
1342 * this function is called by the tty driver when it wants to know how
1343 * many bytes of data we currently have outstanding in the port (data that
1344 * has been written, but hasn't made it out the port yet)
1345 *****************************************************************************/
1346 static unsigned int edge_chars_in_buffer(struct tty_struct
*tty
)
1348 struct usb_serial_port
*port
= tty
->driver_data
;
1349 struct edgeport_port
*edge_port
= usb_get_serial_port_data(port
);
1350 unsigned int num_chars
;
1351 unsigned long flags
;
1353 spin_lock_irqsave(&edge_port
->ep_lock
, flags
);
1354 num_chars
= edge_port
->maxTxCredits
- edge_port
->txCredits
+
1355 edge_port
->txfifo
.count
;
1356 spin_unlock_irqrestore(&edge_port
->ep_lock
, flags
);
1358 dev_dbg(&port
->dev
, "%s - returns %u\n", __func__
, num_chars
);
1365 /*****************************************************************************
1367 * this function is called by the tty driver when it wants to stop the data
1368 * being read from the port.
1369 *****************************************************************************/
1370 static void edge_throttle(struct tty_struct
*tty
)
1372 struct usb_serial_port
*port
= tty
->driver_data
;
1373 struct edgeport_port
*edge_port
= usb_get_serial_port_data(port
);
1376 if (edge_port
== NULL
)
1379 if (!edge_port
->open
) {
1380 dev_dbg(&port
->dev
, "%s - port not opened\n", __func__
);
1384 /* if we are implementing XON/XOFF, send the stop character */
1386 unsigned char stop_char
= STOP_CHAR(tty
);
1387 status
= edge_write(tty
, port
, &stop_char
, 1);
1392 /* if we are implementing RTS/CTS, toggle that line */
1393 if (C_CRTSCTS(tty
)) {
1394 edge_port
->shadowMCR
&= ~MCR_RTS
;
1395 status
= send_cmd_write_uart_register(edge_port
, MCR
,
1396 edge_port
->shadowMCR
);
1403 /*****************************************************************************
1405 * this function is called by the tty driver when it wants to resume the
1406 * data being read from the port (called after SerialThrottle is called)
1407 *****************************************************************************/
1408 static void edge_unthrottle(struct tty_struct
*tty
)
1410 struct usb_serial_port
*port
= tty
->driver_data
;
1411 struct edgeport_port
*edge_port
= usb_get_serial_port_data(port
);
1414 if (edge_port
== NULL
)
1417 if (!edge_port
->open
) {
1418 dev_dbg(&port
->dev
, "%s - port not opened\n", __func__
);
1422 /* if we are implementing XON/XOFF, send the start character */
1424 unsigned char start_char
= START_CHAR(tty
);
1425 status
= edge_write(tty
, port
, &start_char
, 1);
1429 /* if we are implementing RTS/CTS, toggle that line */
1430 if (C_CRTSCTS(tty
)) {
1431 edge_port
->shadowMCR
|= MCR_RTS
;
1432 send_cmd_write_uart_register(edge_port
, MCR
,
1433 edge_port
->shadowMCR
);
1438 /*****************************************************************************
1440 * this function is called by the tty driver when it wants to change
1441 * the termios structure
1442 *****************************************************************************/
1443 static void edge_set_termios(struct tty_struct
*tty
,
1444 struct usb_serial_port
*port
,
1445 const struct ktermios
*old_termios
)
1447 struct edgeport_port
*edge_port
= usb_get_serial_port_data(port
);
1449 if (edge_port
== NULL
)
1452 if (!edge_port
->open
) {
1453 dev_dbg(&port
->dev
, "%s - port not opened\n", __func__
);
1457 /* change the port settings to the new ones specified */
1458 change_port_settings(tty
, edge_port
, old_termios
);
1462 /*****************************************************************************
1463 * get_lsr_info - get line status register info
1465 * Purpose: Let user call ioctl() to get info when the UART physically
1466 * is emptied. On bus types like RS485, the transmitter must
1467 * release the bus after transmitting. This must be done when
1468 * the transmit shift register is empty, not be done when the
1469 * transmit holding register is empty. This functionality
1470 * allows an RS485 driver to be written in user space.
1471 *****************************************************************************/
1472 static int get_lsr_info(struct edgeport_port
*edge_port
,
1473 unsigned int __user
*value
)
1475 unsigned int result
= 0;
1476 unsigned long flags
;
1478 spin_lock_irqsave(&edge_port
->ep_lock
, flags
);
1479 if (edge_port
->maxTxCredits
== edge_port
->txCredits
&&
1480 edge_port
->txfifo
.count
== 0) {
1481 dev_dbg(&edge_port
->port
->dev
, "%s -- Empty\n", __func__
);
1482 result
= TIOCSER_TEMT
;
1484 spin_unlock_irqrestore(&edge_port
->ep_lock
, flags
);
1486 if (copy_to_user(value
, &result
, sizeof(int)))
1491 static int edge_tiocmset(struct tty_struct
*tty
,
1492 unsigned int set
, unsigned int clear
)
1494 struct usb_serial_port
*port
= tty
->driver_data
;
1495 struct edgeport_port
*edge_port
= usb_get_serial_port_data(port
);
1498 mcr
= edge_port
->shadowMCR
;
1499 if (set
& TIOCM_RTS
)
1501 if (set
& TIOCM_DTR
)
1503 if (set
& TIOCM_LOOP
)
1504 mcr
|= MCR_LOOPBACK
;
1506 if (clear
& TIOCM_RTS
)
1508 if (clear
& TIOCM_DTR
)
1510 if (clear
& TIOCM_LOOP
)
1511 mcr
&= ~MCR_LOOPBACK
;
1513 edge_port
->shadowMCR
= mcr
;
1515 send_cmd_write_uart_register(edge_port
, MCR
, edge_port
->shadowMCR
);
1520 static int edge_tiocmget(struct tty_struct
*tty
)
1522 struct usb_serial_port
*port
= tty
->driver_data
;
1523 struct edgeport_port
*edge_port
= usb_get_serial_port_data(port
);
1524 unsigned int result
= 0;
1528 msr
= edge_port
->shadowMSR
;
1529 mcr
= edge_port
->shadowMCR
;
1530 result
= ((mcr
& MCR_DTR
) ? TIOCM_DTR
: 0) /* 0x002 */
1531 | ((mcr
& MCR_RTS
) ? TIOCM_RTS
: 0) /* 0x004 */
1532 | ((msr
& EDGEPORT_MSR_CTS
) ? TIOCM_CTS
: 0) /* 0x020 */
1533 | ((msr
& EDGEPORT_MSR_CD
) ? TIOCM_CAR
: 0) /* 0x040 */
1534 | ((msr
& EDGEPORT_MSR_RI
) ? TIOCM_RI
: 0) /* 0x080 */
1535 | ((msr
& EDGEPORT_MSR_DSR
) ? TIOCM_DSR
: 0); /* 0x100 */
1540 /*****************************************************************************
1542 * this function handles any ioctl calls to the driver
1543 *****************************************************************************/
1544 static int edge_ioctl(struct tty_struct
*tty
,
1545 unsigned int cmd
, unsigned long arg
)
1547 struct usb_serial_port
*port
= tty
->driver_data
;
1548 struct edgeport_port
*edge_port
= usb_get_serial_port_data(port
);
1552 dev_dbg(&port
->dev
, "%s TIOCSERGETLSR\n", __func__
);
1553 return get_lsr_info(edge_port
, (unsigned int __user
*) arg
);
1555 return -ENOIOCTLCMD
;
1559 /*****************************************************************************
1561 * this function sends a break to the port
1562 *****************************************************************************/
1563 static int edge_break(struct tty_struct
*tty
, int break_state
)
1565 struct usb_serial_port
*port
= tty
->driver_data
;
1566 struct edgeport_port
*edge_port
= usb_get_serial_port_data(port
);
1567 struct edgeport_serial
*edge_serial
= usb_get_serial_data(port
->serial
);
1570 if (!edge_serial
->is_epic
||
1571 edge_serial
->epic_descriptor
.Supports
.IOSPChase
) {
1572 /* flush and chase */
1573 edge_port
->chaseResponsePending
= true;
1575 dev_dbg(&port
->dev
, "%s - Sending IOSP_CMD_CHASE_PORT\n", __func__
);
1576 status
= send_iosp_ext_cmd(edge_port
, IOSP_CMD_CHASE_PORT
, 0);
1578 /* block until chase finished */
1579 block_until_chase_response(edge_port
);
1581 edge_port
->chaseResponsePending
= false;
1585 if (!edge_serial
->is_epic
||
1586 edge_serial
->epic_descriptor
.Supports
.IOSPSetClrBreak
) {
1587 if (break_state
== -1) {
1588 dev_dbg(&port
->dev
, "%s - Sending IOSP_CMD_SET_BREAK\n", __func__
);
1589 status
= send_iosp_ext_cmd(edge_port
,
1590 IOSP_CMD_SET_BREAK
, 0);
1592 dev_dbg(&port
->dev
, "%s - Sending IOSP_CMD_CLEAR_BREAK\n", __func__
);
1593 status
= send_iosp_ext_cmd(edge_port
,
1594 IOSP_CMD_CLEAR_BREAK
, 0);
1597 dev_dbg(&port
->dev
, "%s - error sending break set/clear command.\n",
1605 /*****************************************************************************
1607 * this function handles the data received on the bulk in pipe.
1608 *****************************************************************************/
1609 static void process_rcvd_data(struct edgeport_serial
*edge_serial
,
1610 unsigned char *buffer
, __u16 bufferLength
)
1612 struct usb_serial
*serial
= edge_serial
->serial
;
1613 struct device
*dev
= &serial
->dev
->dev
;
1614 struct usb_serial_port
*port
;
1615 struct edgeport_port
*edge_port
;
1616 __u16 lastBufferLength
;
1619 lastBufferLength
= bufferLength
+ 1;
1621 while (bufferLength
> 0) {
1622 /* failsafe incase we get a message that we don't understand */
1623 if (lastBufferLength
== bufferLength
) {
1624 dev_dbg(dev
, "%s - stuck in loop, exiting it.\n", __func__
);
1627 lastBufferLength
= bufferLength
;
1629 switch (edge_serial
->rxState
) {
1631 edge_serial
->rxHeader1
= *buffer
;
1635 if (bufferLength
== 0) {
1636 edge_serial
->rxState
= EXPECT_HDR2
;
1641 edge_serial
->rxHeader2
= *buffer
;
1645 dev_dbg(dev
, "%s - Hdr1=%02X Hdr2=%02X\n", __func__
,
1646 edge_serial
->rxHeader1
, edge_serial
->rxHeader2
);
1647 /* Process depending on whether this header is
1650 if (IS_CMD_STAT_HDR(edge_serial
->rxHeader1
)) {
1651 /* Decode this status header and go to
1652 * EXPECT_HDR1 (if we can process the status
1653 * with only 2 bytes), or go to EXPECT_HDR3 to
1654 * get the third byte. */
1655 edge_serial
->rxPort
=
1656 IOSP_GET_HDR_PORT(edge_serial
->rxHeader1
);
1657 edge_serial
->rxStatusCode
=
1658 IOSP_GET_STATUS_CODE(
1659 edge_serial
->rxHeader1
);
1661 if (!IOSP_STATUS_IS_2BYTE(
1662 edge_serial
->rxStatusCode
)) {
1663 /* This status needs additional bytes.
1664 * Save what we have and then wait for
1667 edge_serial
->rxStatusParam
1668 = edge_serial
->rxHeader2
;
1669 edge_serial
->rxState
= EXPECT_HDR3
;
1672 /* We have all the header bytes, process the
1674 process_rcvd_status(edge_serial
,
1675 edge_serial
->rxHeader2
, 0);
1676 edge_serial
->rxState
= EXPECT_HDR1
;
1680 edge_serial
->rxPort
= IOSP_GET_HDR_PORT(edge_serial
->rxHeader1
);
1681 edge_serial
->rxBytesRemaining
= IOSP_GET_HDR_DATA_LEN(edge_serial
->rxHeader1
,
1682 edge_serial
->rxHeader2
);
1683 dev_dbg(dev
, "%s - Data for Port %u Len %u\n", __func__
,
1684 edge_serial
->rxPort
,
1685 edge_serial
->rxBytesRemaining
);
1687 if (bufferLength
== 0) {
1688 edge_serial
->rxState
= EXPECT_DATA
;
1692 case EXPECT_DATA
: /* Expect data */
1693 if (bufferLength
< edge_serial
->rxBytesRemaining
) {
1694 rxLen
= bufferLength
;
1695 /* Expect data to start next buffer */
1696 edge_serial
->rxState
= EXPECT_DATA
;
1698 /* BufLen >= RxBytesRemaining */
1699 rxLen
= edge_serial
->rxBytesRemaining
;
1700 /* Start another header next time */
1701 edge_serial
->rxState
= EXPECT_HDR1
;
1704 bufferLength
-= rxLen
;
1705 edge_serial
->rxBytesRemaining
-= rxLen
;
1707 /* spit this data back into the tty driver if this
1709 if (rxLen
&& edge_serial
->rxPort
< serial
->num_ports
) {
1710 port
= serial
->port
[edge_serial
->rxPort
];
1711 edge_port
= usb_get_serial_port_data(port
);
1712 if (edge_port
&& edge_port
->open
) {
1713 dev_dbg(dev
, "%s - Sending %d bytes to TTY for port %d\n",
1715 edge_serial
->rxPort
);
1716 edge_tty_recv(edge_port
->port
, buffer
,
1718 edge_port
->port
->icount
.rx
+= rxLen
;
1724 case EXPECT_HDR3
: /* Expect 3rd byte of status header */
1725 edge_serial
->rxHeader3
= *buffer
;
1729 /* We have all the header bytes, process the
1731 process_rcvd_status(edge_serial
,
1732 edge_serial
->rxStatusParam
,
1733 edge_serial
->rxHeader3
);
1734 edge_serial
->rxState
= EXPECT_HDR1
;
1741 /*****************************************************************************
1742 * process_rcvd_status
1743 * this function handles the any status messages received on the
1745 *****************************************************************************/
1746 static void process_rcvd_status(struct edgeport_serial
*edge_serial
,
1747 __u8 byte2
, __u8 byte3
)
1749 struct usb_serial_port
*port
;
1750 struct edgeport_port
*edge_port
;
1751 struct tty_struct
*tty
;
1753 __u8 code
= edge_serial
->rxStatusCode
;
1755 /* switch the port pointer to the one being currently talked about */
1756 if (edge_serial
->rxPort
>= edge_serial
->serial
->num_ports
)
1758 port
= edge_serial
->serial
->port
[edge_serial
->rxPort
];
1759 edge_port
= usb_get_serial_port_data(port
);
1760 if (edge_port
== NULL
) {
1761 dev_err(&edge_serial
->serial
->dev
->dev
,
1762 "%s - edge_port == NULL for port %d\n",
1763 __func__
, edge_serial
->rxPort
);
1768 if (code
== IOSP_EXT_STATUS
) {
1770 case IOSP_EXT_STATUS_CHASE_RSP
:
1771 /* we want to do EXT status regardless of port
1773 dev_dbg(dev
, "%s - Port %u EXT CHASE_RSP Data = %02x\n",
1774 __func__
, edge_serial
->rxPort
, byte3
);
1775 /* Currently, the only EXT_STATUS is Chase, so process
1776 * here instead of one more call to one more subroutine
1777 * If/when more EXT_STATUS, there'll be more work to do
1778 * Also, we currently clear flag and close the port
1779 * regardless of content of above's Byte3.
1780 * We could choose to do something else when Byte3 says
1781 * Timeout on Chase from Edgeport, like wait longer in
1782 * block_until_chase_response, but for now we don't.
1784 edge_port
->chaseResponsePending
= false;
1785 wake_up(&edge_port
->wait_chase
);
1788 case IOSP_EXT_STATUS_RX_CHECK_RSP
:
1789 dev_dbg(dev
, "%s ========== Port %u CHECK_RSP Sequence = %02x =============\n",
1790 __func__
, edge_serial
->rxPort
, byte3
);
1791 /* Port->RxCheckRsp = true; */
1796 if (code
== IOSP_STATUS_OPEN_RSP
) {
1797 edge_port
->txCredits
= GET_TX_BUFFER_SIZE(byte3
);
1798 edge_port
->maxTxCredits
= edge_port
->txCredits
;
1799 dev_dbg(dev
, "%s - Port %u Open Response Initial MSR = %02x TxBufferSize = %d\n",
1800 __func__
, edge_serial
->rxPort
, byte2
, edge_port
->txCredits
);
1801 handle_new_msr(edge_port
, byte2
);
1803 /* send the current line settings to the port so we are
1804 in sync with any further termios calls */
1805 tty
= tty_port_tty_get(&edge_port
->port
->port
);
1807 change_port_settings(tty
,
1808 edge_port
, &tty
->termios
);
1812 /* we have completed the open */
1813 edge_port
->openPending
= false;
1814 edge_port
->open
= true;
1815 wake_up(&edge_port
->wait_open
);
1819 /* If port is closed, silently discard all rcvd status. We can
1820 * have cases where buffered status is received AFTER the close
1821 * port command is sent to the Edgeport.
1823 if (!edge_port
->open
|| edge_port
->closePending
)
1827 /* Not currently sent by Edgeport */
1828 case IOSP_STATUS_LSR
:
1829 dev_dbg(dev
, "%s - Port %u LSR Status = %02x\n",
1830 __func__
, edge_serial
->rxPort
, byte2
);
1831 handle_new_lsr(edge_port
, false, byte2
, 0);
1834 case IOSP_STATUS_LSR_DATA
:
1835 dev_dbg(dev
, "%s - Port %u LSR Status = %02x, Data = %02x\n",
1836 __func__
, edge_serial
->rxPort
, byte2
, byte3
);
1837 /* byte2 is LSR Register */
1838 /* byte3 is broken data byte */
1839 handle_new_lsr(edge_port
, true, byte2
, byte3
);
1842 * case IOSP_EXT_4_STATUS:
1843 * dev_dbg(dev, "%s - Port %u LSR Status = %02x Data = %02x\n",
1844 * __func__, edge_serial->rxPort, byte2, byte3);
1847 case IOSP_STATUS_MSR
:
1848 dev_dbg(dev
, "%s - Port %u MSR Status = %02x\n",
1849 __func__
, edge_serial
->rxPort
, byte2
);
1851 * Process this new modem status and generate appropriate
1852 * events, etc, based on the new status. This routine
1853 * also saves the MSR in Port->ShadowMsr.
1855 handle_new_msr(edge_port
, byte2
);
1859 dev_dbg(dev
, "%s - Unrecognized IOSP status code %u\n", __func__
, code
);
1865 /*****************************************************************************
1867 * this function passes data on to the tty flip buffer
1868 *****************************************************************************/
1869 static void edge_tty_recv(struct usb_serial_port
*port
, unsigned char *data
,
1874 cnt
= tty_insert_flip_string(&port
->port
, data
, length
);
1876 dev_err(&port
->dev
, "%s - dropping data, %d bytes lost\n",
1877 __func__
, length
- cnt
);
1882 tty_flip_buffer_push(&port
->port
);
1886 /*****************************************************************************
1888 * this function handles any change to the msr register for a port.
1889 *****************************************************************************/
1890 static void handle_new_msr(struct edgeport_port
*edge_port
, __u8 newMsr
)
1892 struct async_icount
*icount
;
1894 if (newMsr
& (EDGEPORT_MSR_DELTA_CTS
| EDGEPORT_MSR_DELTA_DSR
|
1895 EDGEPORT_MSR_DELTA_RI
| EDGEPORT_MSR_DELTA_CD
)) {
1896 icount
= &edge_port
->port
->icount
;
1898 /* update input line counters */
1899 if (newMsr
& EDGEPORT_MSR_DELTA_CTS
)
1901 if (newMsr
& EDGEPORT_MSR_DELTA_DSR
)
1903 if (newMsr
& EDGEPORT_MSR_DELTA_CD
)
1905 if (newMsr
& EDGEPORT_MSR_DELTA_RI
)
1907 wake_up_interruptible(&edge_port
->port
->port
.delta_msr_wait
);
1910 /* Save the new modem status */
1911 edge_port
->shadowMSR
= newMsr
& 0xf0;
1915 /*****************************************************************************
1917 * this function handles any change to the lsr register for a port.
1918 *****************************************************************************/
1919 static void handle_new_lsr(struct edgeport_port
*edge_port
, __u8 lsrData
,
1920 __u8 lsr
, __u8 data
)
1922 __u8 newLsr
= (__u8
) (lsr
& (__u8
)
1923 (LSR_OVER_ERR
| LSR_PAR_ERR
| LSR_FRM_ERR
| LSR_BREAK
));
1924 struct async_icount
*icount
;
1926 edge_port
->shadowLSR
= lsr
;
1928 if (newLsr
& LSR_BREAK
) {
1930 * Parity and Framing errors only count if they
1931 * occur exclusive of a break being
1934 newLsr
&= (__u8
)(LSR_OVER_ERR
| LSR_BREAK
);
1937 /* Place LSR data byte into Rx buffer */
1939 edge_tty_recv(edge_port
->port
, &data
, 1);
1941 /* update input line counters */
1942 icount
= &edge_port
->port
->icount
;
1943 if (newLsr
& LSR_BREAK
)
1945 if (newLsr
& LSR_OVER_ERR
)
1947 if (newLsr
& LSR_PAR_ERR
)
1949 if (newLsr
& LSR_FRM_ERR
)
1954 /****************************************************************************
1956 * writes a number of bytes to the Edgeport device's sram starting at the
1958 * If successful returns the number of bytes written, otherwise it returns
1959 * a negative error number of the problem.
1960 ****************************************************************************/
1961 static int sram_write(struct usb_serial
*serial
, __u16 extAddr
, __u16 addr
,
1962 __u16 length
, const __u8
*data
)
1965 __u16 current_length
;
1966 unsigned char *transfer_buffer
;
1968 dev_dbg(&serial
->dev
->dev
, "%s - %x, %x, %d\n", __func__
, extAddr
, addr
, length
);
1970 transfer_buffer
= kmalloc(64, GFP_KERNEL
);
1971 if (!transfer_buffer
)
1974 /* need to split these writes up into 64 byte chunks */
1976 while (length
> 0) {
1978 current_length
= 64;
1980 current_length
= length
;
1982 /* dev_dbg(&serial->dev->dev, "%s - writing %x, %x, %d\n", __func__, extAddr, addr, current_length); */
1983 memcpy(transfer_buffer
, data
, current_length
);
1984 result
= usb_control_msg(serial
->dev
,
1985 usb_sndctrlpipe(serial
->dev
, 0),
1986 USB_REQUEST_ION_WRITE_RAM
,
1987 0x40, addr
, extAddr
, transfer_buffer
,
1988 current_length
, 300);
1991 length
-= current_length
;
1992 addr
+= current_length
;
1993 data
+= current_length
;
1996 kfree(transfer_buffer
);
2001 /****************************************************************************
2003 * writes a number of bytes to the Edgeport device's ROM starting at the
2005 * If successful returns the number of bytes written, otherwise it returns
2006 * a negative error number of the problem.
2007 ****************************************************************************/
2008 static int rom_write(struct usb_serial
*serial
, __u16 extAddr
, __u16 addr
,
2009 __u16 length
, const __u8
*data
)
2012 __u16 current_length
;
2013 unsigned char *transfer_buffer
;
2015 transfer_buffer
= kmalloc(64, GFP_KERNEL
);
2016 if (!transfer_buffer
)
2019 /* need to split these writes up into 64 byte chunks */
2021 while (length
> 0) {
2023 current_length
= 64;
2025 current_length
= length
;
2026 memcpy(transfer_buffer
, data
, current_length
);
2027 result
= usb_control_msg(serial
->dev
,
2028 usb_sndctrlpipe(serial
->dev
, 0),
2029 USB_REQUEST_ION_WRITE_ROM
, 0x40,
2031 transfer_buffer
, current_length
, 300);
2034 length
-= current_length
;
2035 addr
+= current_length
;
2036 data
+= current_length
;
2039 kfree(transfer_buffer
);
2044 /****************************************************************************
2046 * reads a number of bytes from the Edgeport device starting at the given
2048 * Returns zero on success or a negative error number.
2049 ****************************************************************************/
2050 static int rom_read(struct usb_serial
*serial
, __u16 extAddr
,
2051 __u16 addr
, __u16 length
, __u8
*data
)
2054 __u16 current_length
;
2055 unsigned char *transfer_buffer
;
2057 transfer_buffer
= kmalloc(64, GFP_KERNEL
);
2058 if (!transfer_buffer
)
2061 /* need to split these reads up into 64 byte chunks */
2063 while (length
> 0) {
2065 current_length
= 64;
2067 current_length
= length
;
2068 result
= usb_control_msg(serial
->dev
,
2069 usb_rcvctrlpipe(serial
->dev
, 0),
2070 USB_REQUEST_ION_READ_ROM
,
2071 0xC0, addr
, extAddr
, transfer_buffer
,
2072 current_length
, 300);
2073 if (result
< current_length
) {
2078 memcpy(data
, transfer_buffer
, current_length
);
2079 length
-= current_length
;
2080 addr
+= current_length
;
2081 data
+= current_length
;
2086 kfree(transfer_buffer
);
2091 /****************************************************************************
2093 * Is used to send a IOSP message to the Edgeport device
2094 ****************************************************************************/
2095 static int send_iosp_ext_cmd(struct edgeport_port
*edge_port
,
2096 __u8 command
, __u8 param
)
2098 unsigned char *buffer
;
2099 unsigned char *currentCommand
;
2103 buffer
= kmalloc(10, GFP_ATOMIC
);
2107 currentCommand
= buffer
;
2109 MAKE_CMD_EXT_CMD(¤tCommand
, &length
, edge_port
->port
->port_number
,
2112 status
= write_cmd_usb(edge_port
, buffer
, length
);
2114 /* something bad happened, let's free up the memory */
2122 /*****************************************************************************
2124 * this function writes the given buffer out to the bulk write endpoint.
2125 *****************************************************************************/
2126 static int write_cmd_usb(struct edgeport_port
*edge_port
,
2127 unsigned char *buffer
, int length
)
2129 struct edgeport_serial
*edge_serial
=
2130 usb_get_serial_data(edge_port
->port
->serial
);
2131 struct device
*dev
= &edge_port
->port
->dev
;
2135 usb_serial_debug_data(dev
, __func__
, length
, buffer
);
2137 /* Allocate our next urb */
2138 urb
= usb_alloc_urb(0, GFP_ATOMIC
);
2142 atomic_inc(&CmdUrbs
);
2143 dev_dbg(dev
, "%s - ALLOCATE URB %p (outstanding %d)\n",
2144 __func__
, urb
, atomic_read(&CmdUrbs
));
2146 usb_fill_bulk_urb(urb
, edge_serial
->serial
->dev
,
2147 usb_sndbulkpipe(edge_serial
->serial
->dev
,
2148 edge_serial
->bulk_out_endpoint
),
2149 buffer
, length
, edge_bulk_out_cmd_callback
, edge_port
);
2151 edge_port
->commandPending
= true;
2152 status
= usb_submit_urb(urb
, GFP_ATOMIC
);
2155 /* something went wrong */
2156 dev_err(dev
, "%s - usb_submit_urb(write command) failed, status = %d\n",
2159 atomic_dec(&CmdUrbs
);
2164 wait_event(&edge_port
->wait_command
, !edge_port
->commandPending
);
2166 if (edge_port
->commandPending
) {
2167 /* command timed out */
2168 dev_dbg(dev
, "%s - command timed out\n", __func__
);
2176 /*****************************************************************************
2177 * send_cmd_write_baud_rate
2178 * this function sends the proper command to change the baud rate of the
2180 *****************************************************************************/
2181 static int send_cmd_write_baud_rate(struct edgeport_port
*edge_port
,
2184 struct edgeport_serial
*edge_serial
=
2185 usb_get_serial_data(edge_port
->port
->serial
);
2186 struct device
*dev
= &edge_port
->port
->dev
;
2187 unsigned char *cmdBuffer
;
2188 unsigned char *currCmd
;
2192 u32 number
= edge_port
->port
->port_number
;
2194 if (edge_serial
->is_epic
&&
2195 !edge_serial
->epic_descriptor
.Supports
.IOSPSetBaudRate
) {
2196 dev_dbg(dev
, "SendCmdWriteBaudRate - NOT Setting baud rate for port, baud = %d\n",
2201 dev_dbg(dev
, "%s - baud = %d\n", __func__
, baudRate
);
2203 status
= calc_baud_rate_divisor(dev
, baudRate
, &divisor
);
2205 dev_err(dev
, "%s - bad baud rate\n", __func__
);
2209 /* Alloc memory for the string of commands. */
2210 cmdBuffer
= kmalloc(0x100, GFP_ATOMIC
);
2214 currCmd
= cmdBuffer
;
2216 /* Enable access to divisor latch */
2217 MAKE_CMD_WRITE_REG(&currCmd
, &cmdLen
, number
, LCR
, LCR_DL_ENABLE
);
2219 /* Write the divisor itself */
2220 MAKE_CMD_WRITE_REG(&currCmd
, &cmdLen
, number
, DLL
, LOW8(divisor
));
2221 MAKE_CMD_WRITE_REG(&currCmd
, &cmdLen
, number
, DLM
, HIGH8(divisor
));
2223 /* Restore original value to disable access to divisor latch */
2224 MAKE_CMD_WRITE_REG(&currCmd
, &cmdLen
, number
, LCR
,
2225 edge_port
->shadowLCR
);
2227 status
= write_cmd_usb(edge_port
, cmdBuffer
, cmdLen
);
2229 /* something bad happened, let's free up the memory */
2237 /*****************************************************************************
2238 * calc_baud_rate_divisor
2239 * this function calculates the proper baud rate divisor for the specified
2241 *****************************************************************************/
2242 static int calc_baud_rate_divisor(struct device
*dev
, int baudrate
, int *divisor
)
2247 for (i
= 0; i
< ARRAY_SIZE(divisor_table
); i
++) {
2248 if (divisor_table
[i
].BaudRate
== baudrate
) {
2249 *divisor
= divisor_table
[i
].Divisor
;
2254 /* We have tried all of the standard baud rates
2255 * lets try to calculate the divisor for this baud rate
2256 * Make sure the baud rate is reasonable */
2257 if (baudrate
> 50 && baudrate
< 230400) {
2259 custom
= (__u16
)((230400L + baudrate
/2) / baudrate
);
2263 dev_dbg(dev
, "%s - Baud %d = %d\n", __func__
, baudrate
, custom
);
2271 /*****************************************************************************
2272 * send_cmd_write_uart_register
2273 * this function builds up a uart register message and sends to the device.
2274 *****************************************************************************/
2275 static int send_cmd_write_uart_register(struct edgeport_port
*edge_port
,
2276 __u8 regNum
, __u8 regValue
)
2278 struct edgeport_serial
*edge_serial
=
2279 usb_get_serial_data(edge_port
->port
->serial
);
2280 struct device
*dev
= &edge_port
->port
->dev
;
2281 unsigned char *cmdBuffer
;
2282 unsigned char *currCmd
;
2283 unsigned long cmdLen
= 0;
2286 dev_dbg(dev
, "%s - write to %s register 0x%02x\n",
2287 (regNum
== MCR
) ? "MCR" : "LCR", __func__
, regValue
);
2289 if (edge_serial
->is_epic
&&
2290 !edge_serial
->epic_descriptor
.Supports
.IOSPWriteMCR
&&
2292 dev_dbg(dev
, "SendCmdWriteUartReg - Not writing to MCR Register\n");
2296 if (edge_serial
->is_epic
&&
2297 !edge_serial
->epic_descriptor
.Supports
.IOSPWriteLCR
&&
2299 dev_dbg(dev
, "SendCmdWriteUartReg - Not writing to LCR Register\n");
2303 /* Alloc memory for the string of commands. */
2304 cmdBuffer
= kmalloc(0x10, GFP_ATOMIC
);
2305 if (cmdBuffer
== NULL
)
2308 currCmd
= cmdBuffer
;
2310 /* Build a cmd in the buffer to write the given register */
2311 MAKE_CMD_WRITE_REG(&currCmd
, &cmdLen
, edge_port
->port
->port_number
,
2314 status
= write_cmd_usb(edge_port
, cmdBuffer
, cmdLen
);
2316 /* something bad happened, let's free up the memory */
2324 /*****************************************************************************
2325 * change_port_settings
2326 * This routine is called to set the UART on the device to match the
2327 * specified new settings.
2328 *****************************************************************************/
2330 static void change_port_settings(struct tty_struct
*tty
,
2331 struct edgeport_port
*edge_port
, const struct ktermios
*old_termios
)
2333 struct device
*dev
= &edge_port
->port
->dev
;
2334 struct edgeport_serial
*edge_serial
=
2335 usb_get_serial_data(edge_port
->port
->serial
);
2346 if (!edge_port
->open
&&
2347 !edge_port
->openPending
) {
2348 dev_dbg(dev
, "%s - port not opened\n", __func__
);
2352 cflag
= tty
->termios
.c_cflag
;
2354 switch (cflag
& CSIZE
) {
2356 lData
= LCR_BITS_5
; mask
= 0x1f;
2357 dev_dbg(dev
, "%s - data bits = 5\n", __func__
);
2360 lData
= LCR_BITS_6
; mask
= 0x3f;
2361 dev_dbg(dev
, "%s - data bits = 6\n", __func__
);
2364 lData
= LCR_BITS_7
; mask
= 0x7f;
2365 dev_dbg(dev
, "%s - data bits = 7\n", __func__
);
2370 dev_dbg(dev
, "%s - data bits = 8\n", __func__
);
2374 lParity
= LCR_PAR_NONE
;
2375 if (cflag
& PARENB
) {
2376 if (cflag
& CMSPAR
) {
2377 if (cflag
& PARODD
) {
2378 lParity
= LCR_PAR_MARK
;
2379 dev_dbg(dev
, "%s - parity = mark\n", __func__
);
2381 lParity
= LCR_PAR_SPACE
;
2382 dev_dbg(dev
, "%s - parity = space\n", __func__
);
2384 } else if (cflag
& PARODD
) {
2385 lParity
= LCR_PAR_ODD
;
2386 dev_dbg(dev
, "%s - parity = odd\n", __func__
);
2388 lParity
= LCR_PAR_EVEN
;
2389 dev_dbg(dev
, "%s - parity = even\n", __func__
);
2392 dev_dbg(dev
, "%s - parity = none\n", __func__
);
2395 if (cflag
& CSTOPB
) {
2397 dev_dbg(dev
, "%s - stop bits = 2\n", __func__
);
2400 dev_dbg(dev
, "%s - stop bits = 1\n", __func__
);
2403 /* figure out the flow control settings */
2404 rxFlow
= txFlow
= 0x00;
2405 if (cflag
& CRTSCTS
) {
2406 rxFlow
|= IOSP_RX_FLOW_RTS
;
2407 txFlow
|= IOSP_TX_FLOW_CTS
;
2408 dev_dbg(dev
, "%s - RTS/CTS is enabled\n", __func__
);
2410 dev_dbg(dev
, "%s - RTS/CTS is disabled\n", __func__
);
2413 /* if we are implementing XON/XOFF, set the start and stop character
2415 if (I_IXOFF(tty
) || I_IXON(tty
)) {
2416 unsigned char stop_char
= STOP_CHAR(tty
);
2417 unsigned char start_char
= START_CHAR(tty
);
2419 if (!edge_serial
->is_epic
||
2420 edge_serial
->epic_descriptor
.Supports
.IOSPSetXChar
) {
2421 send_iosp_ext_cmd(edge_port
,
2422 IOSP_CMD_SET_XON_CHAR
, start_char
);
2423 send_iosp_ext_cmd(edge_port
,
2424 IOSP_CMD_SET_XOFF_CHAR
, stop_char
);
2427 /* if we are implementing INBOUND XON/XOFF */
2429 rxFlow
|= IOSP_RX_FLOW_XON_XOFF
;
2430 dev_dbg(dev
, "%s - INBOUND XON/XOFF is enabled, XON = %2x, XOFF = %2x\n",
2431 __func__
, start_char
, stop_char
);
2433 dev_dbg(dev
, "%s - INBOUND XON/XOFF is disabled\n", __func__
);
2436 /* if we are implementing OUTBOUND XON/XOFF */
2438 txFlow
|= IOSP_TX_FLOW_XON_XOFF
;
2439 dev_dbg(dev
, "%s - OUTBOUND XON/XOFF is enabled, XON = %2x, XOFF = %2x\n",
2440 __func__
, start_char
, stop_char
);
2442 dev_dbg(dev
, "%s - OUTBOUND XON/XOFF is disabled\n", __func__
);
2446 /* Set flow control to the configured value */
2447 if (!edge_serial
->is_epic
||
2448 edge_serial
->epic_descriptor
.Supports
.IOSPSetRxFlow
)
2449 send_iosp_ext_cmd(edge_port
, IOSP_CMD_SET_RX_FLOW
, rxFlow
);
2450 if (!edge_serial
->is_epic
||
2451 edge_serial
->epic_descriptor
.Supports
.IOSPSetTxFlow
)
2452 send_iosp_ext_cmd(edge_port
, IOSP_CMD_SET_TX_FLOW
, txFlow
);
2455 edge_port
->shadowLCR
&= ~(LCR_BITS_MASK
| LCR_STOP_MASK
| LCR_PAR_MASK
);
2456 edge_port
->shadowLCR
|= (lData
| lParity
| lStop
);
2458 edge_port
->validDataMask
= mask
;
2460 /* Send the updated LCR value to the EdgePort */
2461 status
= send_cmd_write_uart_register(edge_port
, LCR
,
2462 edge_port
->shadowLCR
);
2466 /* set up the MCR register and send it to the EdgePort */
2467 edge_port
->shadowMCR
= MCR_MASTER_IE
;
2469 edge_port
->shadowMCR
|= (MCR_DTR
| MCR_RTS
);
2471 status
= send_cmd_write_uart_register(edge_port
, MCR
,
2472 edge_port
->shadowMCR
);
2476 /* Determine divisor based on baud rate */
2477 baud
= tty_get_baud_rate(tty
);
2479 /* pick a default, any default... */
2483 dev_dbg(dev
, "%s - baud rate = %d\n", __func__
, baud
);
2484 status
= send_cmd_write_baud_rate(edge_port
, baud
);
2486 /* Speed change was not possible - put back the old speed */
2487 baud
= tty_termios_baud_rate(old_termios
);
2488 tty_encode_baud_rate(tty
, baud
, baud
);
2493 /****************************************************************************
2495 * Turns a string from Unicode into ASCII.
2496 * Doesn't do a good job with any characters that are outside the normal
2497 * ASCII range, but it's only for debugging...
2498 * NOTE: expects the unicode in LE format
2499 ****************************************************************************/
2500 static void unicode_to_ascii(char *string
, int buflen
,
2501 __le16
*unicode
, int unicode_size
)
2505 if (buflen
<= 0) /* never happens, but... */
2507 --buflen
; /* space for nul */
2509 for (i
= 0; i
< unicode_size
; i
++) {
2512 string
[i
] = (char)(le16_to_cpu(unicode
[i
]));
2518 /****************************************************************************
2519 * get_manufacturing_desc
2520 * reads in the manufacturing descriptor and stores it into the serial
2522 ****************************************************************************/
2523 static void get_manufacturing_desc(struct edgeport_serial
*edge_serial
)
2525 struct device
*dev
= &edge_serial
->serial
->dev
->dev
;
2528 dev_dbg(dev
, "getting manufacturer descriptor\n");
2530 response
= rom_read(edge_serial
->serial
,
2531 (EDGE_MANUF_DESC_ADDR
& 0xffff0000) >> 16,
2532 (__u16
)(EDGE_MANUF_DESC_ADDR
& 0x0000ffff),
2533 EDGE_MANUF_DESC_LEN
,
2534 (__u8
*)(&edge_serial
->manuf_descriptor
));
2537 dev_err(dev
, "error in getting manufacturer descriptor: %d\n",
2541 dev_dbg(dev
, "**Manufacturer Descriptor\n");
2542 dev_dbg(dev
, " RomSize: %dK\n",
2543 edge_serial
->manuf_descriptor
.RomSize
);
2544 dev_dbg(dev
, " RamSize: %dK\n",
2545 edge_serial
->manuf_descriptor
.RamSize
);
2546 dev_dbg(dev
, " CpuRev: %d\n",
2547 edge_serial
->manuf_descriptor
.CpuRev
);
2548 dev_dbg(dev
, " BoardRev: %d\n",
2549 edge_serial
->manuf_descriptor
.BoardRev
);
2550 dev_dbg(dev
, " NumPorts: %d\n",
2551 edge_serial
->manuf_descriptor
.NumPorts
);
2552 dev_dbg(dev
, " DescDate: %d/%d/%d\n",
2553 edge_serial
->manuf_descriptor
.DescDate
[0],
2554 edge_serial
->manuf_descriptor
.DescDate
[1],
2555 edge_serial
->manuf_descriptor
.DescDate
[2]+1900);
2556 unicode_to_ascii(string
, sizeof(string
),
2557 edge_serial
->manuf_descriptor
.SerialNumber
,
2558 edge_serial
->manuf_descriptor
.SerNumLength
/2);
2559 dev_dbg(dev
, " SerialNumber: %s\n", string
);
2560 unicode_to_ascii(string
, sizeof(string
),
2561 edge_serial
->manuf_descriptor
.AssemblyNumber
,
2562 edge_serial
->manuf_descriptor
.AssemblyNumLength
/2);
2563 dev_dbg(dev
, " AssemblyNumber: %s\n", string
);
2564 unicode_to_ascii(string
, sizeof(string
),
2565 edge_serial
->manuf_descriptor
.OemAssyNumber
,
2566 edge_serial
->manuf_descriptor
.OemAssyNumLength
/2);
2567 dev_dbg(dev
, " OemAssyNumber: %s\n", string
);
2568 dev_dbg(dev
, " UartType: %d\n",
2569 edge_serial
->manuf_descriptor
.UartType
);
2570 dev_dbg(dev
, " IonPid: %d\n",
2571 edge_serial
->manuf_descriptor
.IonPid
);
2572 dev_dbg(dev
, " IonConfig: %d\n",
2573 edge_serial
->manuf_descriptor
.IonConfig
);
2578 /****************************************************************************
2580 * reads in the bootloader descriptor and stores it into the serial
2582 ****************************************************************************/
2583 static void get_boot_desc(struct edgeport_serial
*edge_serial
)
2585 struct device
*dev
= &edge_serial
->serial
->dev
->dev
;
2588 dev_dbg(dev
, "getting boot descriptor\n");
2590 response
= rom_read(edge_serial
->serial
,
2591 (EDGE_BOOT_DESC_ADDR
& 0xffff0000) >> 16,
2592 (__u16
)(EDGE_BOOT_DESC_ADDR
& 0x0000ffff),
2594 (__u8
*)(&edge_serial
->boot_descriptor
));
2597 dev_err(dev
, "error in getting boot descriptor: %d\n",
2600 dev_dbg(dev
, "**Boot Descriptor:\n");
2601 dev_dbg(dev
, " BootCodeLength: %d\n",
2602 le16_to_cpu(edge_serial
->boot_descriptor
.BootCodeLength
));
2603 dev_dbg(dev
, " MajorVersion: %d\n",
2604 edge_serial
->boot_descriptor
.MajorVersion
);
2605 dev_dbg(dev
, " MinorVersion: %d\n",
2606 edge_serial
->boot_descriptor
.MinorVersion
);
2607 dev_dbg(dev
, " BuildNumber: %d\n",
2608 le16_to_cpu(edge_serial
->boot_descriptor
.BuildNumber
));
2609 dev_dbg(dev
, " Capabilities: 0x%x\n",
2610 le16_to_cpu(edge_serial
->boot_descriptor
.Capabilities
));
2611 dev_dbg(dev
, " UConfig0: %d\n",
2612 edge_serial
->boot_descriptor
.UConfig0
);
2613 dev_dbg(dev
, " UConfig1: %d\n",
2614 edge_serial
->boot_descriptor
.UConfig1
);
2619 /****************************************************************************
2620 * load_application_firmware
2621 * This is called to load the application firmware to the device
2622 ****************************************************************************/
2623 static void load_application_firmware(struct edgeport_serial
*edge_serial
)
2625 struct device
*dev
= &edge_serial
->serial
->dev
->dev
;
2626 const struct ihex_binrec
*rec
;
2627 const struct firmware
*fw
;
2628 const char *fw_name
;
2629 const char *fw_info
;
2634 switch (edge_serial
->product_info
.iDownloadFile
) {
2635 case EDGE_DOWNLOAD_FILE_I930
:
2636 fw_info
= "downloading firmware version (930)";
2637 fw_name
= "edgeport/down.fw";
2640 case EDGE_DOWNLOAD_FILE_80251
:
2641 fw_info
= "downloading firmware version (80251)";
2642 fw_name
= "edgeport/down2.fw";
2645 case EDGE_DOWNLOAD_FILE_NONE
:
2646 dev_dbg(dev
, "No download file specified, skipping download\n");
2653 response
= request_ihex_firmware(&fw
, fw_name
,
2654 &edge_serial
->serial
->dev
->dev
);
2656 dev_err(dev
, "Failed to load image \"%s\" err %d\n",
2661 rec
= (const struct ihex_binrec
*)fw
->data
;
2662 build
= (rec
->data
[2] << 8) | rec
->data
[3];
2664 dev_dbg(dev
, "%s %d.%d.%d\n", fw_info
, rec
->data
[0], rec
->data
[1], build
);
2666 edge_serial
->product_info
.FirmwareMajorVersion
= rec
->data
[0];
2667 edge_serial
->product_info
.FirmwareMinorVersion
= rec
->data
[1];
2668 edge_serial
->product_info
.FirmwareBuildNumber
= cpu_to_le16(build
);
2670 for (rec
= ihex_next_binrec(rec
); rec
;
2671 rec
= ihex_next_binrec(rec
)) {
2672 Operaddr
= be32_to_cpu(rec
->addr
);
2673 response
= sram_write(edge_serial
->serial
,
2676 be16_to_cpu(rec
->len
),
2679 dev_err(&edge_serial
->serial
->dev
->dev
,
2680 "sram_write failed (%x, %x, %d)\n",
2681 Operaddr
>> 16, Operaddr
& 0xFFFF,
2682 be16_to_cpu(rec
->len
));
2687 dev_dbg(dev
, "sending exec_dl_code\n");
2688 response
= usb_control_msg (edge_serial
->serial
->dev
,
2689 usb_sndctrlpipe(edge_serial
->serial
->dev
, 0),
2690 USB_REQUEST_ION_EXEC_DL_CODE
,
2691 0x40, 0x4000, 0x0001, NULL
, 0, 3000);
2693 release_firmware(fw
);
2697 /****************************************************************************
2699 ****************************************************************************/
2700 static int edge_startup(struct usb_serial
*serial
)
2702 struct edgeport_serial
*edge_serial
;
2703 struct usb_device
*dev
;
2704 struct device
*ddev
= &serial
->dev
->dev
;
2707 bool interrupt_in_found
;
2709 bool bulk_out_found
;
2710 static const __u32 descriptor
[3] = { EDGE_COMPATIBILITY_MASK0
,
2711 EDGE_COMPATIBILITY_MASK1
,
2712 EDGE_COMPATIBILITY_MASK2
};
2716 /* create our private serial structure */
2717 edge_serial
= kzalloc(sizeof(struct edgeport_serial
), GFP_KERNEL
);
2721 spin_lock_init(&edge_serial
->es_lock
);
2722 edge_serial
->serial
= serial
;
2723 usb_set_serial_data(serial
, edge_serial
);
2725 /* get the name for the device from the device */
2726 i
= usb_string(dev
, dev
->descriptor
.iManufacturer
,
2727 &edge_serial
->name
[0], MAX_NAME_LEN
+1);
2730 edge_serial
->name
[i
++] = ' ';
2731 usb_string(dev
, dev
->descriptor
.iProduct
,
2732 &edge_serial
->name
[i
], MAX_NAME_LEN
+2 - i
);
2734 dev_info(&serial
->dev
->dev
, "%s detected\n", edge_serial
->name
);
2736 /* Read the epic descriptor */
2737 if (get_epic_descriptor(edge_serial
) < 0) {
2738 /* memcpy descriptor to Supports structures */
2739 memcpy(&edge_serial
->epic_descriptor
.Supports
, descriptor
,
2740 sizeof(struct edge_compatibility_bits
));
2742 /* get the manufacturing descriptor for this device */
2743 get_manufacturing_desc(edge_serial
);
2745 /* get the boot descriptor */
2746 get_boot_desc(edge_serial
);
2748 get_product_info(edge_serial
);
2751 /* set the number of ports from the manufacturing description */
2752 /* serial->num_ports = serial->product_info.NumPorts; */
2753 if ((!edge_serial
->is_epic
) &&
2754 (edge_serial
->product_info
.NumPorts
!= serial
->num_ports
)) {
2756 "Device Reported %d serial ports vs. core thinking we have %d ports, email greg@kroah.com this information.\n",
2757 edge_serial
->product_info
.NumPorts
,
2761 dev_dbg(ddev
, "%s - time 1 %ld\n", __func__
, jiffies
);
2763 /* If not an EPiC device */
2764 if (!edge_serial
->is_epic
) {
2765 /* now load the application firmware into this device */
2766 load_application_firmware(edge_serial
);
2768 dev_dbg(ddev
, "%s - time 2 %ld\n", __func__
, jiffies
);
2770 /* Check current Edgeport EEPROM and update if necessary */
2771 update_edgeport_E2PROM(edge_serial
);
2773 dev_dbg(ddev
, "%s - time 3 %ld\n", __func__
, jiffies
);
2775 /* set the configuration to use #1 */
2776 /* dev_dbg(ddev, "set_configuration 1\n"); */
2777 /* usb_set_configuration (dev, 1); */
2779 dev_dbg(ddev
, " FirmwareMajorVersion %d.%d.%d\n",
2780 edge_serial
->product_info
.FirmwareMajorVersion
,
2781 edge_serial
->product_info
.FirmwareMinorVersion
,
2782 le16_to_cpu(edge_serial
->product_info
.FirmwareBuildNumber
));
2784 /* we set up the pointers to the endpoints in the edge_open function,
2785 * as the structures aren't created yet. */
2789 if (edge_serial
->is_epic
) {
2790 struct usb_host_interface
*alt
;
2792 alt
= serial
->interface
->cur_altsetting
;
2794 /* EPIC thing, set up our interrupt polling now and our read
2795 * urb, so that the device knows it really is connected. */
2796 interrupt_in_found
= bulk_in_found
= bulk_out_found
= false;
2797 for (i
= 0; i
< alt
->desc
.bNumEndpoints
; ++i
) {
2798 struct usb_endpoint_descriptor
*endpoint
;
2801 endpoint
= &alt
->endpoint
[i
].desc
;
2802 buffer_size
= usb_endpoint_maxp(endpoint
);
2803 if (!interrupt_in_found
&&
2804 (usb_endpoint_is_int_in(endpoint
))) {
2805 /* we found a interrupt in endpoint */
2806 dev_dbg(ddev
, "found interrupt in\n");
2808 /* not set up yet, so do it now */
2809 edge_serial
->interrupt_read_urb
=
2810 usb_alloc_urb(0, GFP_KERNEL
);
2811 if (!edge_serial
->interrupt_read_urb
) {
2816 edge_serial
->interrupt_in_buffer
=
2817 kmalloc(buffer_size
, GFP_KERNEL
);
2818 if (!edge_serial
->interrupt_in_buffer
) {
2822 edge_serial
->interrupt_in_endpoint
=
2823 endpoint
->bEndpointAddress
;
2825 /* set up our interrupt urb */
2827 edge_serial
->interrupt_read_urb
,
2830 endpoint
->bEndpointAddress
),
2831 edge_serial
->interrupt_in_buffer
,
2833 edge_interrupt_callback
,
2835 endpoint
->bInterval
);
2837 interrupt_in_found
= true;
2840 if (!bulk_in_found
&&
2841 (usb_endpoint_is_bulk_in(endpoint
))) {
2842 /* we found a bulk in endpoint */
2843 dev_dbg(ddev
, "found bulk in\n");
2845 /* not set up yet, so do it now */
2846 edge_serial
->read_urb
=
2847 usb_alloc_urb(0, GFP_KERNEL
);
2848 if (!edge_serial
->read_urb
) {
2853 edge_serial
->bulk_in_buffer
=
2854 kmalloc(buffer_size
, GFP_KERNEL
);
2855 if (!edge_serial
->bulk_in_buffer
) {
2859 edge_serial
->bulk_in_endpoint
=
2860 endpoint
->bEndpointAddress
;
2862 /* set up our bulk in urb */
2863 usb_fill_bulk_urb(edge_serial
->read_urb
, dev
,
2864 usb_rcvbulkpipe(dev
,
2865 endpoint
->bEndpointAddress
),
2866 edge_serial
->bulk_in_buffer
,
2867 usb_endpoint_maxp(endpoint
),
2868 edge_bulk_in_callback
,
2870 bulk_in_found
= true;
2873 if (!bulk_out_found
&&
2874 (usb_endpoint_is_bulk_out(endpoint
))) {
2875 /* we found a bulk out endpoint */
2876 dev_dbg(ddev
, "found bulk out\n");
2877 edge_serial
->bulk_out_endpoint
=
2878 endpoint
->bEndpointAddress
;
2879 bulk_out_found
= true;
2883 if (response
|| !interrupt_in_found
|| !bulk_in_found
||
2886 dev_err(ddev
, "expected endpoints not found\n");
2893 /* start interrupt read for this edgeport this interrupt will
2894 * continue as long as the edgeport is connected */
2895 response
= usb_submit_urb(edge_serial
->interrupt_read_urb
,
2898 dev_err(ddev
, "%s - Error %d submitting control urb\n",
2899 __func__
, response
);
2907 usb_free_urb(edge_serial
->interrupt_read_urb
);
2908 kfree(edge_serial
->interrupt_in_buffer
);
2910 usb_free_urb(edge_serial
->read_urb
);
2911 kfree(edge_serial
->bulk_in_buffer
);
2919 /****************************************************************************
2921 * This function is called whenever the device is removed from the usb bus.
2922 ****************************************************************************/
2923 static void edge_disconnect(struct usb_serial
*serial
)
2925 struct edgeport_serial
*edge_serial
= usb_get_serial_data(serial
);
2927 if (edge_serial
->is_epic
) {
2928 usb_kill_urb(edge_serial
->interrupt_read_urb
);
2929 usb_kill_urb(edge_serial
->read_urb
);
2934 /****************************************************************************
2936 * This function is called when the device structure is deallocated.
2937 ****************************************************************************/
2938 static void edge_release(struct usb_serial
*serial
)
2940 struct edgeport_serial
*edge_serial
= usb_get_serial_data(serial
);
2942 if (edge_serial
->is_epic
) {
2943 usb_kill_urb(edge_serial
->interrupt_read_urb
);
2944 usb_free_urb(edge_serial
->interrupt_read_urb
);
2945 kfree(edge_serial
->interrupt_in_buffer
);
2947 usb_kill_urb(edge_serial
->read_urb
);
2948 usb_free_urb(edge_serial
->read_urb
);
2949 kfree(edge_serial
->bulk_in_buffer
);
2955 static int edge_port_probe(struct usb_serial_port
*port
)
2957 struct edgeport_port
*edge_port
;
2959 edge_port
= kzalloc(sizeof(*edge_port
), GFP_KERNEL
);
2963 spin_lock_init(&edge_port
->ep_lock
);
2964 edge_port
->port
= port
;
2966 usb_set_serial_port_data(port
, edge_port
);
2971 static void edge_port_remove(struct usb_serial_port
*port
)
2973 struct edgeport_port
*edge_port
;
2975 edge_port
= usb_get_serial_port_data(port
);
2979 static struct usb_serial_driver edgeport_2port_device
= {
2981 .name
= "edgeport_2",
2983 .description
= "Edgeport 2 port adapter",
2984 .id_table
= edgeport_2port_id_table
,
2988 .num_interrupt_in
= 1,
2990 .close
= edge_close
,
2991 .throttle
= edge_throttle
,
2992 .unthrottle
= edge_unthrottle
,
2993 .attach
= edge_startup
,
2994 .disconnect
= edge_disconnect
,
2995 .release
= edge_release
,
2996 .port_probe
= edge_port_probe
,
2997 .port_remove
= edge_port_remove
,
2998 .ioctl
= edge_ioctl
,
2999 .set_termios
= edge_set_termios
,
3000 .tiocmget
= edge_tiocmget
,
3001 .tiocmset
= edge_tiocmset
,
3002 .tiocmiwait
= usb_serial_generic_tiocmiwait
,
3003 .get_icount
= usb_serial_generic_get_icount
,
3004 .write
= edge_write
,
3005 .write_room
= edge_write_room
,
3006 .chars_in_buffer
= edge_chars_in_buffer
,
3007 .break_ctl
= edge_break
,
3008 .read_int_callback
= edge_interrupt_callback
,
3009 .read_bulk_callback
= edge_bulk_in_callback
,
3010 .write_bulk_callback
= edge_bulk_out_data_callback
,
3013 static struct usb_serial_driver edgeport_4port_device
= {
3015 .name
= "edgeport_4",
3017 .description
= "Edgeport 4 port adapter",
3018 .id_table
= edgeport_4port_id_table
,
3022 .num_interrupt_in
= 1,
3024 .close
= edge_close
,
3025 .throttle
= edge_throttle
,
3026 .unthrottle
= edge_unthrottle
,
3027 .attach
= edge_startup
,
3028 .disconnect
= edge_disconnect
,
3029 .release
= edge_release
,
3030 .port_probe
= edge_port_probe
,
3031 .port_remove
= edge_port_remove
,
3032 .ioctl
= edge_ioctl
,
3033 .set_termios
= edge_set_termios
,
3034 .tiocmget
= edge_tiocmget
,
3035 .tiocmset
= edge_tiocmset
,
3036 .tiocmiwait
= usb_serial_generic_tiocmiwait
,
3037 .get_icount
= usb_serial_generic_get_icount
,
3038 .write
= edge_write
,
3039 .write_room
= edge_write_room
,
3040 .chars_in_buffer
= edge_chars_in_buffer
,
3041 .break_ctl
= edge_break
,
3042 .read_int_callback
= edge_interrupt_callback
,
3043 .read_bulk_callback
= edge_bulk_in_callback
,
3044 .write_bulk_callback
= edge_bulk_out_data_callback
,
3047 static struct usb_serial_driver edgeport_8port_device
= {
3049 .name
= "edgeport_8",
3051 .description
= "Edgeport 8 port adapter",
3052 .id_table
= edgeport_8port_id_table
,
3056 .num_interrupt_in
= 1,
3058 .close
= edge_close
,
3059 .throttle
= edge_throttle
,
3060 .unthrottle
= edge_unthrottle
,
3061 .attach
= edge_startup
,
3062 .disconnect
= edge_disconnect
,
3063 .release
= edge_release
,
3064 .port_probe
= edge_port_probe
,
3065 .port_remove
= edge_port_remove
,
3066 .ioctl
= edge_ioctl
,
3067 .set_termios
= edge_set_termios
,
3068 .tiocmget
= edge_tiocmget
,
3069 .tiocmset
= edge_tiocmset
,
3070 .tiocmiwait
= usb_serial_generic_tiocmiwait
,
3071 .get_icount
= usb_serial_generic_get_icount
,
3072 .write
= edge_write
,
3073 .write_room
= edge_write_room
,
3074 .chars_in_buffer
= edge_chars_in_buffer
,
3075 .break_ctl
= edge_break
,
3076 .read_int_callback
= edge_interrupt_callback
,
3077 .read_bulk_callback
= edge_bulk_in_callback
,
3078 .write_bulk_callback
= edge_bulk_out_data_callback
,
3081 static struct usb_serial_driver epic_device
= {
3085 .description
= "EPiC device",
3086 .id_table
= Epic_port_id_table
,
3090 .num_interrupt_in
= 1,
3092 .close
= edge_close
,
3093 .throttle
= edge_throttle
,
3094 .unthrottle
= edge_unthrottle
,
3095 .attach
= edge_startup
,
3096 .disconnect
= edge_disconnect
,
3097 .release
= edge_release
,
3098 .port_probe
= edge_port_probe
,
3099 .port_remove
= edge_port_remove
,
3100 .ioctl
= edge_ioctl
,
3101 .set_termios
= edge_set_termios
,
3102 .tiocmget
= edge_tiocmget
,
3103 .tiocmset
= edge_tiocmset
,
3104 .tiocmiwait
= usb_serial_generic_tiocmiwait
,
3105 .get_icount
= usb_serial_generic_get_icount
,
3106 .write
= edge_write
,
3107 .write_room
= edge_write_room
,
3108 .chars_in_buffer
= edge_chars_in_buffer
,
3109 .break_ctl
= edge_break
,
3110 .read_int_callback
= edge_interrupt_callback
,
3111 .read_bulk_callback
= edge_bulk_in_callback
,
3112 .write_bulk_callback
= edge_bulk_out_data_callback
,
3115 static struct usb_serial_driver
* const serial_drivers
[] = {
3116 &edgeport_2port_device
, &edgeport_4port_device
,
3117 &edgeport_8port_device
, &epic_device
, NULL
3120 module_usb_serial_driver(serial_drivers
, id_table_combined
);
3122 MODULE_AUTHOR(DRIVER_AUTHOR
);
3123 MODULE_DESCRIPTION(DRIVER_DESC
);
3124 MODULE_LICENSE("GPL");
3125 MODULE_FIRMWARE("edgeport/boot.fw");
3126 MODULE_FIRMWARE("edgeport/boot2.fw");
3127 MODULE_FIRMWARE("edgeport/down.fw");
3128 MODULE_FIRMWARE("edgeport/down2.fw");