Loading...
1// SPDX-License-Identifier: GPL-2.0+
2/*
3 * Edgeport USB Serial Converter driver
4 *
5 * Copyright (C) 2000-2002 Inside Out Networks, All rights reserved.
6 * Copyright (C) 2001-2002 Greg Kroah-Hartman <greg@kroah.com>
7 *
8 * Supports the following devices:
9 * EP/1 EP/2 EP/4 EP/21 EP/22 EP/221 EP/42 EP/421 WATCHPORT
10 *
11 * For questions or problems with this driver, contact Inside Out
12 * Networks technical support, or Peter Berger <pberger@brimson.com>,
13 * or Al Borchers <alborchers@steinerpoint.com>.
14 */
15
16#include <linux/kernel.h>
17#include <linux/jiffies.h>
18#include <linux/errno.h>
19#include <linux/slab.h>
20#include <linux/tty.h>
21#include <linux/tty_driver.h>
22#include <linux/tty_flip.h>
23#include <linux/module.h>
24#include <linux/spinlock.h>
25#include <linux/mutex.h>
26#include <linux/serial.h>
27#include <linux/swab.h>
28#include <linux/kfifo.h>
29#include <linux/ioctl.h>
30#include <linux/firmware.h>
31#include <linux/uaccess.h>
32#include <linux/usb.h>
33#include <linux/usb/serial.h>
34
35#include "io_16654.h"
36#include "io_usbvend.h"
37#include "io_ti.h"
38
39#define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com> and David Iacovelli"
40#define DRIVER_DESC "Edgeport USB Serial Driver"
41
42#define EPROM_PAGE_SIZE 64
43
44
45/* different hardware types */
46#define HARDWARE_TYPE_930 0
47#define HARDWARE_TYPE_TIUMP 1
48
49/* IOCTL_PRIVATE_TI_GET_MODE Definitions */
50#define TI_MODE_CONFIGURING 0 /* Device has not entered start device */
51#define TI_MODE_BOOT 1 /* Staying in boot mode */
52#define TI_MODE_DOWNLOAD 2 /* Made it to download mode */
53#define TI_MODE_TRANSITIONING 3 /*
54 * Currently in boot mode but
55 * transitioning to download mode
56 */
57
58/* read urb state */
59#define EDGE_READ_URB_RUNNING 0
60#define EDGE_READ_URB_STOPPING 1
61#define EDGE_READ_URB_STOPPED 2
62
63#define EDGE_CLOSING_WAIT 4000 /* in .01 sec */
64
65
66/* Product information read from the Edgeport */
67struct product_info {
68 int TiMode; /* Current TI Mode */
69 __u8 hardware_type; /* Type of hardware */
70} __attribute__((packed));
71
72/*
73 * Edgeport firmware header
74 *
75 * "build_number" has been set to 0 in all three of the images I have
76 * seen, and Digi Tech Support suggests that it is safe to ignore it.
77 *
78 * "length" is the number of bytes of actual data following the header.
79 *
80 * "checksum" is the low order byte resulting from adding the values of
81 * all the data bytes.
82 */
83struct edgeport_fw_hdr {
84 u8 major_version;
85 u8 minor_version;
86 __le16 build_number;
87 __le16 length;
88 u8 checksum;
89} __packed;
90
91struct edgeport_port {
92 __u16 uart_base;
93 __u16 dma_address;
94 __u8 shadow_msr;
95 __u8 shadow_mcr;
96 __u8 shadow_lsr;
97 __u8 lsr_mask;
98 __u32 ump_read_timeout; /*
99 * Number of milliseconds the UMP will
100 * wait without data before completing
101 * a read short
102 */
103 int baud_rate;
104 int close_pending;
105 int lsr_event;
106
107 struct edgeport_serial *edge_serial;
108 struct usb_serial_port *port;
109 __u8 bUartMode; /* Port type, 0: RS232, etc. */
110 spinlock_t ep_lock;
111 int ep_read_urb_state;
112 int ep_write_urb_in_use;
113};
114
115struct edgeport_serial {
116 struct product_info product_info;
117 u8 TI_I2C_Type; /* Type of I2C in UMP */
118 u8 TiReadI2C; /*
119 * Set to TRUE if we have read the
120 * I2c in Boot Mode
121 */
122 struct mutex es_lock;
123 int num_ports_open;
124 struct usb_serial *serial;
125 struct delayed_work heartbeat_work;
126 int fw_version;
127 bool use_heartbeat;
128};
129
130
131/* Devices that this driver supports */
132static const struct usb_device_id edgeport_1port_id_table[] = {
133 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_1) },
134 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_TI3410_EDGEPORT_1) },
135 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_TI3410_EDGEPORT_1I) },
136 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_PROXIMITY) },
137 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_MOTION) },
138 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_MOISTURE) },
139 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_TEMPERATURE) },
140 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_HUMIDITY) },
141 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_POWER) },
142 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_LIGHT) },
143 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_RADIATION) },
144 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_DISTANCE) },
145 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_ACCELERATION) },
146 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_PROX_DIST) },
147 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_PLUS_PWR_HP4CD) },
148 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_PLUS_PWR_PCI) },
149 { }
150};
151
152static const struct usb_device_id edgeport_2port_id_table[] = {
153 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_2) },
154 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_2C) },
155 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_2I) },
156 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_421) },
157 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_21) },
158 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_42) },
159 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_4) },
160 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_4I) },
161 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_22I) },
162 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_221C) },
163 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_22C) },
164 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_21C) },
165 /* The 4, 8 and 16 port devices show up as multiple 2 port devices */
166 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_4S) },
167 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_8) },
168 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_8S) },
169 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_416) },
170 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_416B) },
171 { }
172};
173
174/* Devices that this driver supports */
175static const struct usb_device_id id_table_combined[] = {
176 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_1) },
177 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_TI3410_EDGEPORT_1) },
178 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_TI3410_EDGEPORT_1I) },
179 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_PROXIMITY) },
180 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_MOTION) },
181 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_MOISTURE) },
182 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_TEMPERATURE) },
183 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_HUMIDITY) },
184 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_POWER) },
185 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_LIGHT) },
186 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_RADIATION) },
187 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_DISTANCE) },
188 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_ACCELERATION) },
189 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_PROX_DIST) },
190 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_PLUS_PWR_HP4CD) },
191 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_PLUS_PWR_PCI) },
192 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_2) },
193 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_2C) },
194 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_2I) },
195 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_421) },
196 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_21) },
197 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_42) },
198 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_4) },
199 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_4I) },
200 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_22I) },
201 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_221C) },
202 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_22C) },
203 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_21C) },
204 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_4S) },
205 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_8) },
206 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_8S) },
207 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_416) },
208 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_416B) },
209 { }
210};
211
212MODULE_DEVICE_TABLE(usb, id_table_combined);
213
214static int closing_wait = EDGE_CLOSING_WAIT;
215static bool ignore_cpu_rev;
216static int default_uart_mode; /* RS232 */
217
218static void edge_tty_recv(struct usb_serial_port *port, unsigned char *data,
219 int length);
220
221static void stop_read(struct edgeport_port *edge_port);
222static int restart_read(struct edgeport_port *edge_port);
223
224static void edge_set_termios(struct tty_struct *tty,
225 struct usb_serial_port *port, struct ktermios *old_termios);
226static void edge_send(struct usb_serial_port *port, struct tty_struct *tty);
227
228static int do_download_mode(struct edgeport_serial *serial,
229 const struct firmware *fw);
230static int do_boot_mode(struct edgeport_serial *serial,
231 const struct firmware *fw);
232
233/* sysfs attributes */
234static int edge_create_sysfs_attrs(struct usb_serial_port *port);
235static int edge_remove_sysfs_attrs(struct usb_serial_port *port);
236
237/*
238 * Some release of Edgeport firmware "down3.bin" after version 4.80
239 * introduced code to automatically disconnect idle devices on some
240 * Edgeport models after periods of inactivity, typically ~60 seconds.
241 * This occurs without regard to whether ports on the device are open
242 * or not. Digi International Tech Support suggested:
243 *
244 * 1. Adding driver "heartbeat" code to reset the firmware timer by
245 * requesting a descriptor record every 15 seconds, which should be
246 * effective with newer firmware versions that require it, and benign
247 * with older versions that do not. In practice 40 seconds seems often
248 * enough.
249 * 2. The heartbeat code is currently required only on Edgeport/416 models.
250 */
251#define FW_HEARTBEAT_VERSION_CUTOFF ((4 << 8) + 80)
252#define FW_HEARTBEAT_SECS 40
253
254/* Timeouts in msecs: firmware downloads take longer */
255#define TI_VSEND_TIMEOUT_DEFAULT 1000
256#define TI_VSEND_TIMEOUT_FW_DOWNLOAD 10000
257
258static int ti_vread_sync(struct usb_device *dev, __u8 request,
259 __u16 value, __u16 index, u8 *data, int size)
260{
261 int status;
262
263 status = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0), request,
264 (USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN),
265 value, index, data, size, 1000);
266 if (status < 0)
267 return status;
268 if (status != size) {
269 dev_dbg(&dev->dev, "%s - wanted to write %d, but only wrote %d\n",
270 __func__, size, status);
271 return -ECOMM;
272 }
273 return 0;
274}
275
276static int ti_vsend_sync(struct usb_device *dev, u8 request, u16 value,
277 u16 index, u8 *data, int size, int timeout)
278{
279 int status;
280
281 status = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), request,
282 (USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT),
283 value, index, data, size, timeout);
284 if (status < 0)
285 return status;
286 if (status != size) {
287 dev_dbg(&dev->dev, "%s - wanted to write %d, but only wrote %d\n",
288 __func__, size, status);
289 return -ECOMM;
290 }
291 return 0;
292}
293
294static int send_cmd(struct usb_device *dev, __u8 command,
295 __u8 moduleid, __u16 value, u8 *data,
296 int size)
297{
298 return ti_vsend_sync(dev, command, value, moduleid, data, size,
299 TI_VSEND_TIMEOUT_DEFAULT);
300}
301
302/* clear tx/rx buffers and fifo in TI UMP */
303static int purge_port(struct usb_serial_port *port, __u16 mask)
304{
305 int port_number = port->port_number;
306
307 dev_dbg(&port->dev, "%s - port %d, mask %x\n", __func__, port_number, mask);
308
309 return send_cmd(port->serial->dev,
310 UMPC_PURGE_PORT,
311 (__u8)(UMPM_UART1_PORT + port_number),
312 mask,
313 NULL,
314 0);
315}
316
317/**
318 * read_download_mem - Read edgeport memory from TI chip
319 * @dev: usb device pointer
320 * @start_address: Device CPU address at which to read
321 * @length: Length of above data
322 * @address_type: Can read both XDATA and I2C
323 * @buffer: pointer to input data buffer
324 */
325static int read_download_mem(struct usb_device *dev, int start_address,
326 int length, __u8 address_type, __u8 *buffer)
327{
328 int status = 0;
329 __u8 read_length;
330 u16 be_start_address;
331
332 dev_dbg(&dev->dev, "%s - @ %x for %d\n", __func__, start_address, length);
333
334 /*
335 * Read in blocks of 64 bytes
336 * (TI firmware can't handle more than 64 byte reads)
337 */
338 while (length) {
339 if (length > 64)
340 read_length = 64;
341 else
342 read_length = (__u8)length;
343
344 if (read_length > 1) {
345 dev_dbg(&dev->dev, "%s - @ %x for %d\n", __func__, start_address, read_length);
346 }
347 /*
348 * NOTE: Must use swab as wIndex is sent in little-endian
349 * byte order regardless of host byte order.
350 */
351 be_start_address = swab16((u16)start_address);
352 status = ti_vread_sync(dev, UMPC_MEMORY_READ,
353 (__u16)address_type,
354 be_start_address,
355 buffer, read_length);
356
357 if (status) {
358 dev_dbg(&dev->dev, "%s - ERROR %x\n", __func__, status);
359 return status;
360 }
361
362 if (read_length > 1)
363 usb_serial_debug_data(&dev->dev, __func__, read_length, buffer);
364
365 /* Update pointers/length */
366 start_address += read_length;
367 buffer += read_length;
368 length -= read_length;
369 }
370
371 return status;
372}
373
374static int read_ram(struct usb_device *dev, int start_address,
375 int length, __u8 *buffer)
376{
377 return read_download_mem(dev, start_address, length,
378 DTK_ADDR_SPACE_XDATA, buffer);
379}
380
381/* Read edgeport memory to a given block */
382static int read_boot_mem(struct edgeport_serial *serial,
383 int start_address, int length, __u8 *buffer)
384{
385 int status = 0;
386 int i;
387
388 for (i = 0; i < length; i++) {
389 status = ti_vread_sync(serial->serial->dev,
390 UMPC_MEMORY_READ, serial->TI_I2C_Type,
391 (__u16)(start_address+i), &buffer[i], 0x01);
392 if (status) {
393 dev_dbg(&serial->serial->dev->dev, "%s - ERROR %x\n", __func__, status);
394 return status;
395 }
396 }
397
398 dev_dbg(&serial->serial->dev->dev, "%s - start_address = %x, length = %d\n",
399 __func__, start_address, length);
400 usb_serial_debug_data(&serial->serial->dev->dev, __func__, length, buffer);
401
402 serial->TiReadI2C = 1;
403
404 return status;
405}
406
407/* Write given block to TI EPROM memory */
408static int write_boot_mem(struct edgeport_serial *serial,
409 int start_address, int length, __u8 *buffer)
410{
411 int status = 0;
412 int i;
413 u8 *temp;
414
415 /* Must do a read before write */
416 if (!serial->TiReadI2C) {
417 temp = kmalloc(1, GFP_KERNEL);
418 if (!temp)
419 return -ENOMEM;
420
421 status = read_boot_mem(serial, 0, 1, temp);
422 kfree(temp);
423 if (status)
424 return status;
425 }
426
427 for (i = 0; i < length; ++i) {
428 status = ti_vsend_sync(serial->serial->dev, UMPC_MEMORY_WRITE,
429 buffer[i], (u16)(i + start_address), NULL,
430 0, TI_VSEND_TIMEOUT_DEFAULT);
431 if (status)
432 return status;
433 }
434
435 dev_dbg(&serial->serial->dev->dev, "%s - start_sddr = %x, length = %d\n", __func__, start_address, length);
436 usb_serial_debug_data(&serial->serial->dev->dev, __func__, length, buffer);
437
438 return status;
439}
440
441/* Write edgeport I2C memory to TI chip */
442static int write_i2c_mem(struct edgeport_serial *serial,
443 int start_address, int length, __u8 address_type, __u8 *buffer)
444{
445 struct device *dev = &serial->serial->dev->dev;
446 int status = 0;
447 int write_length;
448 u16 be_start_address;
449
450 /* We can only send a maximum of 1 aligned byte page at a time */
451
452 /* calculate the number of bytes left in the first page */
453 write_length = EPROM_PAGE_SIZE -
454 (start_address & (EPROM_PAGE_SIZE - 1));
455
456 if (write_length > length)
457 write_length = length;
458
459 dev_dbg(dev, "%s - BytesInFirstPage Addr = %x, length = %d\n",
460 __func__, start_address, write_length);
461 usb_serial_debug_data(dev, __func__, write_length, buffer);
462
463 /*
464 * Write first page.
465 *
466 * NOTE: Must use swab as wIndex is sent in little-endian byte order
467 * regardless of host byte order.
468 */
469 be_start_address = swab16((u16)start_address);
470 status = ti_vsend_sync(serial->serial->dev, UMPC_MEMORY_WRITE,
471 (u16)address_type, be_start_address,
472 buffer, write_length, TI_VSEND_TIMEOUT_DEFAULT);
473 if (status) {
474 dev_dbg(dev, "%s - ERROR %d\n", __func__, status);
475 return status;
476 }
477
478 length -= write_length;
479 start_address += write_length;
480 buffer += write_length;
481
482 /*
483 * We should be aligned now -- can write max page size bytes at a
484 * time.
485 */
486 while (length) {
487 if (length > EPROM_PAGE_SIZE)
488 write_length = EPROM_PAGE_SIZE;
489 else
490 write_length = length;
491
492 dev_dbg(dev, "%s - Page Write Addr = %x, length = %d\n",
493 __func__, start_address, write_length);
494 usb_serial_debug_data(dev, __func__, write_length, buffer);
495
496 /*
497 * Write next page.
498 *
499 * NOTE: Must use swab as wIndex is sent in little-endian byte
500 * order regardless of host byte order.
501 */
502 be_start_address = swab16((u16)start_address);
503 status = ti_vsend_sync(serial->serial->dev, UMPC_MEMORY_WRITE,
504 (u16)address_type, be_start_address, buffer,
505 write_length, TI_VSEND_TIMEOUT_DEFAULT);
506 if (status) {
507 dev_err(dev, "%s - ERROR %d\n", __func__, status);
508 return status;
509 }
510
511 length -= write_length;
512 start_address += write_length;
513 buffer += write_length;
514 }
515 return status;
516}
517
518/*
519 * Examine the UMP DMA registers and LSR
520 *
521 * Check the MSBit of the X and Y DMA byte count registers.
522 * A zero in this bit indicates that the TX DMA buffers are empty
523 * then check the TX Empty bit in the UART.
524 */
525static int tx_active(struct edgeport_port *port)
526{
527 int status;
528 struct out_endpoint_desc_block *oedb;
529 __u8 *lsr;
530 int bytes_left = 0;
531
532 oedb = kmalloc(sizeof(*oedb), GFP_KERNEL);
533 if (!oedb)
534 return -ENOMEM;
535
536 /*
537 * Sigh, that's right, just one byte, as not all platforms can
538 * do DMA from stack
539 */
540 lsr = kmalloc(1, GFP_KERNEL);
541 if (!lsr) {
542 kfree(oedb);
543 return -ENOMEM;
544 }
545 /* Read the DMA Count Registers */
546 status = read_ram(port->port->serial->dev, port->dma_address,
547 sizeof(*oedb), (void *)oedb);
548 if (status)
549 goto exit_is_tx_active;
550
551 dev_dbg(&port->port->dev, "%s - XByteCount 0x%X\n", __func__, oedb->XByteCount);
552
553 /* and the LSR */
554 status = read_ram(port->port->serial->dev,
555 port->uart_base + UMPMEM_OFFS_UART_LSR, 1, lsr);
556
557 if (status)
558 goto exit_is_tx_active;
559 dev_dbg(&port->port->dev, "%s - LSR = 0x%X\n", __func__, *lsr);
560
561 /* If either buffer has data or we are transmitting then return TRUE */
562 if ((oedb->XByteCount & 0x80) != 0)
563 bytes_left += 64;
564
565 if ((*lsr & UMP_UART_LSR_TX_MASK) == 0)
566 bytes_left += 1;
567
568 /* We return Not Active if we get any kind of error */
569exit_is_tx_active:
570 dev_dbg(&port->port->dev, "%s - return %d\n", __func__, bytes_left);
571
572 kfree(lsr);
573 kfree(oedb);
574 return bytes_left;
575}
576
577static int choose_config(struct usb_device *dev)
578{
579 /*
580 * There may be multiple configurations on this device, in which case
581 * we would need to read and parse all of them to find out which one
582 * we want. However, we just support one config at this point,
583 * configuration # 1, which is Config Descriptor 0.
584 */
585
586 dev_dbg(&dev->dev, "%s - Number of Interfaces = %d\n",
587 __func__, dev->config->desc.bNumInterfaces);
588 dev_dbg(&dev->dev, "%s - MAX Power = %d\n",
589 __func__, dev->config->desc.bMaxPower * 2);
590
591 if (dev->config->desc.bNumInterfaces != 1) {
592 dev_err(&dev->dev, "%s - bNumInterfaces is not 1, ERROR!\n", __func__);
593 return -ENODEV;
594 }
595
596 return 0;
597}
598
599static int read_rom(struct edgeport_serial *serial,
600 int start_address, int length, __u8 *buffer)
601{
602 int status;
603
604 if (serial->product_info.TiMode == TI_MODE_DOWNLOAD) {
605 status = read_download_mem(serial->serial->dev,
606 start_address,
607 length,
608 serial->TI_I2C_Type,
609 buffer);
610 } else {
611 status = read_boot_mem(serial, start_address, length,
612 buffer);
613 }
614 return status;
615}
616
617static int write_rom(struct edgeport_serial *serial, int start_address,
618 int length, __u8 *buffer)
619{
620 if (serial->product_info.TiMode == TI_MODE_BOOT)
621 return write_boot_mem(serial, start_address, length,
622 buffer);
623
624 if (serial->product_info.TiMode == TI_MODE_DOWNLOAD)
625 return write_i2c_mem(serial, start_address, length,
626 serial->TI_I2C_Type, buffer);
627 return -EINVAL;
628}
629
630/* Read a descriptor header from I2C based on type */
631static int get_descriptor_addr(struct edgeport_serial *serial,
632 int desc_type, struct ti_i2c_desc *rom_desc)
633{
634 int start_address;
635 int status;
636
637 /* Search for requested descriptor in I2C */
638 start_address = 2;
639 do {
640 status = read_rom(serial,
641 start_address,
642 sizeof(struct ti_i2c_desc),
643 (__u8 *)rom_desc);
644 if (status)
645 return 0;
646
647 if (rom_desc->Type == desc_type)
648 return start_address;
649
650 start_address = start_address + sizeof(struct ti_i2c_desc) +
651 le16_to_cpu(rom_desc->Size);
652
653 } while ((start_address < TI_MAX_I2C_SIZE) && rom_desc->Type);
654
655 return 0;
656}
657
658/* Validate descriptor checksum */
659static int valid_csum(struct ti_i2c_desc *rom_desc, __u8 *buffer)
660{
661 __u16 i;
662 __u8 cs = 0;
663
664 for (i = 0; i < le16_to_cpu(rom_desc->Size); i++)
665 cs = (__u8)(cs + buffer[i]);
666
667 if (cs != rom_desc->CheckSum) {
668 pr_debug("%s - Mismatch %x - %x", __func__, rom_desc->CheckSum, cs);
669 return -EINVAL;
670 }
671 return 0;
672}
673
674/* Make sure that the I2C image is good */
675static int check_i2c_image(struct edgeport_serial *serial)
676{
677 struct device *dev = &serial->serial->dev->dev;
678 int status = 0;
679 struct ti_i2c_desc *rom_desc;
680 int start_address = 2;
681 __u8 *buffer;
682 __u16 ttype;
683
684 rom_desc = kmalloc(sizeof(*rom_desc), GFP_KERNEL);
685 if (!rom_desc)
686 return -ENOMEM;
687
688 buffer = kmalloc(TI_MAX_I2C_SIZE, GFP_KERNEL);
689 if (!buffer) {
690 kfree(rom_desc);
691 return -ENOMEM;
692 }
693
694 /* Read the first byte (Signature0) must be 0x52 or 0x10 */
695 status = read_rom(serial, 0, 1, buffer);
696 if (status)
697 goto out;
698
699 if (*buffer != UMP5152 && *buffer != UMP3410) {
700 dev_err(dev, "%s - invalid buffer signature\n", __func__);
701 status = -ENODEV;
702 goto out;
703 }
704
705 do {
706 /* Validate the I2C */
707 status = read_rom(serial,
708 start_address,
709 sizeof(struct ti_i2c_desc),
710 (__u8 *)rom_desc);
711 if (status)
712 break;
713
714 if ((start_address + sizeof(struct ti_i2c_desc) +
715 le16_to_cpu(rom_desc->Size)) > TI_MAX_I2C_SIZE) {
716 status = -ENODEV;
717 dev_dbg(dev, "%s - structure too big, erroring out.\n", __func__);
718 break;
719 }
720
721 dev_dbg(dev, "%s Type = 0x%x\n", __func__, rom_desc->Type);
722
723 /* Skip type 2 record */
724 ttype = rom_desc->Type & 0x0f;
725 if (ttype != I2C_DESC_TYPE_FIRMWARE_BASIC
726 && ttype != I2C_DESC_TYPE_FIRMWARE_AUTO) {
727 /* Read the descriptor data */
728 status = read_rom(serial, start_address +
729 sizeof(struct ti_i2c_desc),
730 le16_to_cpu(rom_desc->Size),
731 buffer);
732 if (status)
733 break;
734
735 status = valid_csum(rom_desc, buffer);
736 if (status)
737 break;
738 }
739 start_address = start_address + sizeof(struct ti_i2c_desc) +
740 le16_to_cpu(rom_desc->Size);
741
742 } while ((rom_desc->Type != I2C_DESC_TYPE_ION) &&
743 (start_address < TI_MAX_I2C_SIZE));
744
745 if ((rom_desc->Type != I2C_DESC_TYPE_ION) ||
746 (start_address > TI_MAX_I2C_SIZE))
747 status = -ENODEV;
748
749out:
750 kfree(buffer);
751 kfree(rom_desc);
752 return status;
753}
754
755static int get_manuf_info(struct edgeport_serial *serial, __u8 *buffer)
756{
757 int status;
758 int start_address;
759 struct ti_i2c_desc *rom_desc;
760 struct edge_ti_manuf_descriptor *desc;
761 struct device *dev = &serial->serial->dev->dev;
762
763 rom_desc = kmalloc(sizeof(*rom_desc), GFP_KERNEL);
764 if (!rom_desc)
765 return -ENOMEM;
766
767 start_address = get_descriptor_addr(serial, I2C_DESC_TYPE_ION,
768 rom_desc);
769
770 if (!start_address) {
771 dev_dbg(dev, "%s - Edge Descriptor not found in I2C\n", __func__);
772 status = -ENODEV;
773 goto exit;
774 }
775
776 /* Read the descriptor data */
777 status = read_rom(serial, start_address+sizeof(struct ti_i2c_desc),
778 le16_to_cpu(rom_desc->Size), buffer);
779 if (status)
780 goto exit;
781
782 status = valid_csum(rom_desc, buffer);
783
784 desc = (struct edge_ti_manuf_descriptor *)buffer;
785 dev_dbg(dev, "%s - IonConfig 0x%x\n", __func__, desc->IonConfig);
786 dev_dbg(dev, "%s - Version %d\n", __func__, desc->Version);
787 dev_dbg(dev, "%s - Cpu/Board 0x%x\n", __func__, desc->CpuRev_BoardRev);
788 dev_dbg(dev, "%s - NumPorts %d\n", __func__, desc->NumPorts);
789 dev_dbg(dev, "%s - NumVirtualPorts %d\n", __func__, desc->NumVirtualPorts);
790 dev_dbg(dev, "%s - TotalPorts %d\n", __func__, desc->TotalPorts);
791
792exit:
793 kfree(rom_desc);
794 return status;
795}
796
797/* Build firmware header used for firmware update */
798static int build_i2c_fw_hdr(u8 *header, const struct firmware *fw)
799{
800 __u8 *buffer;
801 int buffer_size;
802 int i;
803 __u8 cs = 0;
804 struct ti_i2c_desc *i2c_header;
805 struct ti_i2c_image_header *img_header;
806 struct ti_i2c_firmware_rec *firmware_rec;
807 struct edgeport_fw_hdr *fw_hdr = (struct edgeport_fw_hdr *)fw->data;
808
809 /*
810 * In order to update the I2C firmware we must change the type 2 record
811 * to type 0xF2. This will force the UMP to come up in Boot Mode.
812 * Then while in boot mode, the driver will download the latest
813 * firmware (padded to 15.5k) into the UMP ram. And finally when the
814 * device comes back up in download mode the driver will cause the new
815 * firmware to be copied from the UMP Ram to I2C and the firmware will
816 * update the record type from 0xf2 to 0x02.
817 */
818
819 /*
820 * Allocate a 15.5k buffer + 2 bytes for version number (Firmware
821 * Record)
822 */
823 buffer_size = (((1024 * 16) - 512 ) +
824 sizeof(struct ti_i2c_firmware_rec));
825
826 buffer = kmalloc(buffer_size, GFP_KERNEL);
827 if (!buffer)
828 return -ENOMEM;
829
830 /* Set entire image of 0xffs */
831 memset(buffer, 0xff, buffer_size);
832
833 /* Copy version number into firmware record */
834 firmware_rec = (struct ti_i2c_firmware_rec *)buffer;
835
836 firmware_rec->Ver_Major = fw_hdr->major_version;
837 firmware_rec->Ver_Minor = fw_hdr->minor_version;
838
839 /* Pointer to fw_down memory image */
840 img_header = (struct ti_i2c_image_header *)&fw->data[4];
841
842 memcpy(buffer + sizeof(struct ti_i2c_firmware_rec),
843 &fw->data[4 + sizeof(struct ti_i2c_image_header)],
844 le16_to_cpu(img_header->Length));
845
846 for (i=0; i < buffer_size; i++) {
847 cs = (__u8)(cs + buffer[i]);
848 }
849
850 kfree(buffer);
851
852 /* Build new header */
853 i2c_header = (struct ti_i2c_desc *)header;
854 firmware_rec = (struct ti_i2c_firmware_rec*)i2c_header->Data;
855
856 i2c_header->Type = I2C_DESC_TYPE_FIRMWARE_BLANK;
857 i2c_header->Size = cpu_to_le16(buffer_size);
858 i2c_header->CheckSum = cs;
859 firmware_rec->Ver_Major = fw_hdr->major_version;
860 firmware_rec->Ver_Minor = fw_hdr->minor_version;
861
862 return 0;
863}
864
865/* Try to figure out what type of I2c we have */
866static int i2c_type_bootmode(struct edgeport_serial *serial)
867{
868 struct device *dev = &serial->serial->dev->dev;
869 int status;
870 u8 *data;
871
872 data = kmalloc(1, GFP_KERNEL);
873 if (!data)
874 return -ENOMEM;
875
876 /* Try to read type 2 */
877 status = ti_vread_sync(serial->serial->dev, UMPC_MEMORY_READ,
878 DTK_ADDR_SPACE_I2C_TYPE_II, 0, data, 0x01);
879 if (status)
880 dev_dbg(dev, "%s - read 2 status error = %d\n", __func__, status);
881 else
882 dev_dbg(dev, "%s - read 2 data = 0x%x\n", __func__, *data);
883 if ((!status) && (*data == UMP5152 || *data == UMP3410)) {
884 dev_dbg(dev, "%s - ROM_TYPE_II\n", __func__);
885 serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_II;
886 goto out;
887 }
888
889 /* Try to read type 3 */
890 status = ti_vread_sync(serial->serial->dev, UMPC_MEMORY_READ,
891 DTK_ADDR_SPACE_I2C_TYPE_III, 0, data, 0x01);
892 if (status)
893 dev_dbg(dev, "%s - read 3 status error = %d\n", __func__, status);
894 else
895 dev_dbg(dev, "%s - read 2 data = 0x%x\n", __func__, *data);
896 if ((!status) && (*data == UMP5152 || *data == UMP3410)) {
897 dev_dbg(dev, "%s - ROM_TYPE_III\n", __func__);
898 serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_III;
899 goto out;
900 }
901
902 dev_dbg(dev, "%s - Unknown\n", __func__);
903 serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_II;
904 status = -ENODEV;
905out:
906 kfree(data);
907 return status;
908}
909
910static int bulk_xfer(struct usb_serial *serial, void *buffer,
911 int length, int *num_sent)
912{
913 int status;
914
915 status = usb_bulk_msg(serial->dev,
916 usb_sndbulkpipe(serial->dev,
917 serial->port[0]->bulk_out_endpointAddress),
918 buffer, length, num_sent, 1000);
919 return status;
920}
921
922/* Download given firmware image to the device (IN BOOT MODE) */
923static int download_code(struct edgeport_serial *serial, __u8 *image,
924 int image_length)
925{
926 int status = 0;
927 int pos;
928 int transfer;
929 int done;
930
931 /* Transfer firmware image */
932 for (pos = 0; pos < image_length; ) {
933 /* Read the next buffer from file */
934 transfer = image_length - pos;
935 if (transfer > EDGE_FW_BULK_MAX_PACKET_SIZE)
936 transfer = EDGE_FW_BULK_MAX_PACKET_SIZE;
937
938 /* Transfer data */
939 status = bulk_xfer(serial->serial, &image[pos],
940 transfer, &done);
941 if (status)
942 break;
943 /* Advance buffer pointer */
944 pos += done;
945 }
946
947 return status;
948}
949
950/* FIXME!!! */
951static int config_boot_dev(struct usb_device *dev)
952{
953 return 0;
954}
955
956static int ti_cpu_rev(struct edge_ti_manuf_descriptor *desc)
957{
958 return TI_GET_CPU_REVISION(desc->CpuRev_BoardRev);
959}
960
961static int check_fw_sanity(struct edgeport_serial *serial,
962 const struct firmware *fw)
963{
964 u16 length_total;
965 u8 checksum = 0;
966 int pos;
967 struct device *dev = &serial->serial->interface->dev;
968 struct edgeport_fw_hdr *fw_hdr = (struct edgeport_fw_hdr *)fw->data;
969
970 if (fw->size < sizeof(struct edgeport_fw_hdr)) {
971 dev_err(dev, "incomplete fw header\n");
972 return -EINVAL;
973 }
974
975 length_total = le16_to_cpu(fw_hdr->length) +
976 sizeof(struct edgeport_fw_hdr);
977
978 if (fw->size != length_total) {
979 dev_err(dev, "bad fw size (expected: %u, got: %zu)\n",
980 length_total, fw->size);
981 return -EINVAL;
982 }
983
984 for (pos = sizeof(struct edgeport_fw_hdr); pos < fw->size; ++pos)
985 checksum += fw->data[pos];
986
987 if (checksum != fw_hdr->checksum) {
988 dev_err(dev, "bad fw checksum (expected: 0x%x, got: 0x%x)\n",
989 fw_hdr->checksum, checksum);
990 return -EINVAL;
991 }
992
993 return 0;
994}
995
996/*
997 * DownloadTIFirmware - Download run-time operating firmware to the TI5052
998 *
999 * This routine downloads the main operating code into the TI5052, using the
1000 * boot code already burned into E2PROM or ROM.
1001 */
1002static int download_fw(struct edgeport_serial *serial)
1003{
1004 struct device *dev = &serial->serial->interface->dev;
1005 int status = 0;
1006 struct usb_interface_descriptor *interface;
1007 const struct firmware *fw;
1008 const char *fw_name = "edgeport/down3.bin";
1009 struct edgeport_fw_hdr *fw_hdr;
1010
1011 status = request_firmware(&fw, fw_name, dev);
1012 if (status) {
1013 dev_err(dev, "Failed to load image \"%s\" err %d\n",
1014 fw_name, status);
1015 return status;
1016 }
1017
1018 if (check_fw_sanity(serial, fw)) {
1019 status = -EINVAL;
1020 goto out;
1021 }
1022
1023 fw_hdr = (struct edgeport_fw_hdr *)fw->data;
1024
1025 /* If on-board version is newer, "fw_version" will be updated later. */
1026 serial->fw_version = (fw_hdr->major_version << 8) +
1027 fw_hdr->minor_version;
1028
1029 /*
1030 * This routine is entered by both the BOOT mode and the Download mode
1031 * We can determine which code is running by the reading the config
1032 * descriptor and if we have only one bulk pipe it is in boot mode
1033 */
1034 serial->product_info.hardware_type = HARDWARE_TYPE_TIUMP;
1035
1036 /* Default to type 2 i2c */
1037 serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_II;
1038
1039 status = choose_config(serial->serial->dev);
1040 if (status)
1041 goto out;
1042
1043 interface = &serial->serial->interface->cur_altsetting->desc;
1044 if (!interface) {
1045 dev_err(dev, "%s - no interface set, error!\n", __func__);
1046 status = -ENODEV;
1047 goto out;
1048 }
1049
1050 /*
1051 * Setup initial mode -- the default mode 0 is TI_MODE_CONFIGURING
1052 * if we have more than one endpoint we are definitely in download
1053 * mode
1054 */
1055 if (interface->bNumEndpoints > 1) {
1056 serial->product_info.TiMode = TI_MODE_DOWNLOAD;
1057 status = do_download_mode(serial, fw);
1058 } else {
1059 /* Otherwise we will remain in configuring mode */
1060 serial->product_info.TiMode = TI_MODE_CONFIGURING;
1061 status = do_boot_mode(serial, fw);
1062 }
1063
1064out:
1065 release_firmware(fw);
1066 return status;
1067}
1068
1069static int do_download_mode(struct edgeport_serial *serial,
1070 const struct firmware *fw)
1071{
1072 struct device *dev = &serial->serial->interface->dev;
1073 int status = 0;
1074 int start_address;
1075 struct edge_ti_manuf_descriptor *ti_manuf_desc;
1076 int download_cur_ver;
1077 int download_new_ver;
1078 struct edgeport_fw_hdr *fw_hdr = (struct edgeport_fw_hdr *)fw->data;
1079 struct ti_i2c_desc *rom_desc;
1080
1081 dev_dbg(dev, "%s - RUNNING IN DOWNLOAD MODE\n", __func__);
1082
1083 status = check_i2c_image(serial);
1084 if (status) {
1085 dev_dbg(dev, "%s - DOWNLOAD MODE -- BAD I2C\n", __func__);
1086 return status;
1087 }
1088
1089 /*
1090 * Validate Hardware version number
1091 * Read Manufacturing Descriptor from TI Based Edgeport
1092 */
1093 ti_manuf_desc = kmalloc(sizeof(*ti_manuf_desc), GFP_KERNEL);
1094 if (!ti_manuf_desc)
1095 return -ENOMEM;
1096
1097 status = get_manuf_info(serial, (__u8 *)ti_manuf_desc);
1098 if (status) {
1099 kfree(ti_manuf_desc);
1100 return status;
1101 }
1102
1103 /* Check version number of ION descriptor */
1104 if (!ignore_cpu_rev && ti_cpu_rev(ti_manuf_desc) < 2) {
1105 dev_dbg(dev, "%s - Wrong CPU Rev %d (Must be 2)\n",
1106 __func__, ti_cpu_rev(ti_manuf_desc));
1107 kfree(ti_manuf_desc);
1108 return -EINVAL;
1109 }
1110
1111 rom_desc = kmalloc(sizeof(*rom_desc), GFP_KERNEL);
1112 if (!rom_desc) {
1113 kfree(ti_manuf_desc);
1114 return -ENOMEM;
1115 }
1116
1117 /* Search for type 2 record (firmware record) */
1118 start_address = get_descriptor_addr(serial,
1119 I2C_DESC_TYPE_FIRMWARE_BASIC, rom_desc);
1120 if (start_address != 0) {
1121 struct ti_i2c_firmware_rec *firmware_version;
1122 u8 *record;
1123
1124 dev_dbg(dev, "%s - Found Type FIRMWARE (Type 2) record\n",
1125 __func__);
1126
1127 firmware_version = kmalloc(sizeof(*firmware_version),
1128 GFP_KERNEL);
1129 if (!firmware_version) {
1130 kfree(rom_desc);
1131 kfree(ti_manuf_desc);
1132 return -ENOMEM;
1133 }
1134
1135 /*
1136 * Validate version number
1137 * Read the descriptor data
1138 */
1139 status = read_rom(serial, start_address +
1140 sizeof(struct ti_i2c_desc),
1141 sizeof(struct ti_i2c_firmware_rec),
1142 (__u8 *)firmware_version);
1143 if (status) {
1144 kfree(firmware_version);
1145 kfree(rom_desc);
1146 kfree(ti_manuf_desc);
1147 return status;
1148 }
1149
1150 /*
1151 * Check version number of download with current
1152 * version in I2c
1153 */
1154 download_cur_ver = (firmware_version->Ver_Major << 8) +
1155 (firmware_version->Ver_Minor);
1156 download_new_ver = (fw_hdr->major_version << 8) +
1157 (fw_hdr->minor_version);
1158
1159 dev_dbg(dev, "%s - >> FW Versions Device %d.%d Driver %d.%d\n",
1160 __func__, firmware_version->Ver_Major,
1161 firmware_version->Ver_Minor,
1162 fw_hdr->major_version, fw_hdr->minor_version);
1163
1164 /*
1165 * Check if we have an old version in the I2C and
1166 * update if necessary
1167 */
1168 if (download_cur_ver < download_new_ver) {
1169 dev_dbg(dev, "%s - Update I2C dld from %d.%d to %d.%d\n",
1170 __func__,
1171 firmware_version->Ver_Major,
1172 firmware_version->Ver_Minor,
1173 fw_hdr->major_version,
1174 fw_hdr->minor_version);
1175
1176 record = kmalloc(1, GFP_KERNEL);
1177 if (!record) {
1178 kfree(firmware_version);
1179 kfree(rom_desc);
1180 kfree(ti_manuf_desc);
1181 return -ENOMEM;
1182 }
1183 /*
1184 * In order to update the I2C firmware we must
1185 * change the type 2 record to type 0xF2. This
1186 * will force the UMP to come up in Boot Mode.
1187 * Then while in boot mode, the driver will
1188 * download the latest firmware (padded to
1189 * 15.5k) into the UMP ram. Finally when the
1190 * device comes back up in download mode the
1191 * driver will cause the new firmware to be
1192 * copied from the UMP Ram to I2C and the
1193 * firmware will update the record type from
1194 * 0xf2 to 0x02.
1195 */
1196 *record = I2C_DESC_TYPE_FIRMWARE_BLANK;
1197
1198 /*
1199 * Change the I2C Firmware record type to
1200 * 0xf2 to trigger an update
1201 */
1202 status = write_rom(serial, start_address,
1203 sizeof(*record), record);
1204 if (status) {
1205 kfree(record);
1206 kfree(firmware_version);
1207 kfree(rom_desc);
1208 kfree(ti_manuf_desc);
1209 return status;
1210 }
1211
1212 /*
1213 * verify the write -- must do this in order
1214 * for write to complete before we do the
1215 * hardware reset
1216 */
1217 status = read_rom(serial,
1218 start_address,
1219 sizeof(*record),
1220 record);
1221 if (status) {
1222 kfree(record);
1223 kfree(firmware_version);
1224 kfree(rom_desc);
1225 kfree(ti_manuf_desc);
1226 return status;
1227 }
1228
1229 if (*record != I2C_DESC_TYPE_FIRMWARE_BLANK) {
1230 dev_err(dev, "%s - error resetting device\n",
1231 __func__);
1232 kfree(record);
1233 kfree(firmware_version);
1234 kfree(rom_desc);
1235 kfree(ti_manuf_desc);
1236 return -ENODEV;
1237 }
1238
1239 dev_dbg(dev, "%s - HARDWARE RESET\n", __func__);
1240
1241 /* Reset UMP -- Back to BOOT MODE */
1242 status = ti_vsend_sync(serial->serial->dev,
1243 UMPC_HARDWARE_RESET,
1244 0, 0, NULL, 0,
1245 TI_VSEND_TIMEOUT_DEFAULT);
1246
1247 dev_dbg(dev, "%s - HARDWARE RESET return %d\n",
1248 __func__, status);
1249
1250 /* return an error on purpose. */
1251 kfree(record);
1252 kfree(firmware_version);
1253 kfree(rom_desc);
1254 kfree(ti_manuf_desc);
1255 return -ENODEV;
1256 }
1257 /* Same or newer fw version is already loaded */
1258 serial->fw_version = download_cur_ver;
1259 kfree(firmware_version);
1260 }
1261 /* Search for type 0xF2 record (firmware blank record) */
1262 else {
1263 start_address = get_descriptor_addr(serial,
1264 I2C_DESC_TYPE_FIRMWARE_BLANK, rom_desc);
1265 if (start_address != 0) {
1266#define HEADER_SIZE (sizeof(struct ti_i2c_desc) + \
1267 sizeof(struct ti_i2c_firmware_rec))
1268 __u8 *header;
1269 __u8 *vheader;
1270
1271 header = kmalloc(HEADER_SIZE, GFP_KERNEL);
1272 if (!header) {
1273 kfree(rom_desc);
1274 kfree(ti_manuf_desc);
1275 return -ENOMEM;
1276 }
1277
1278 vheader = kmalloc(HEADER_SIZE, GFP_KERNEL);
1279 if (!vheader) {
1280 kfree(header);
1281 kfree(rom_desc);
1282 kfree(ti_manuf_desc);
1283 return -ENOMEM;
1284 }
1285
1286 dev_dbg(dev, "%s - Found Type BLANK FIRMWARE (Type F2) record\n",
1287 __func__);
1288
1289 /*
1290 * In order to update the I2C firmware we must change
1291 * the type 2 record to type 0xF2. This will force the
1292 * UMP to come up in Boot Mode. Then while in boot
1293 * mode, the driver will download the latest firmware
1294 * (padded to 15.5k) into the UMP ram. Finally when the
1295 * device comes back up in download mode the driver
1296 * will cause the new firmware to be copied from the
1297 * UMP Ram to I2C and the firmware will update the
1298 * record type from 0xf2 to 0x02.
1299 */
1300 status = build_i2c_fw_hdr(header, fw);
1301 if (status) {
1302 kfree(vheader);
1303 kfree(header);
1304 kfree(rom_desc);
1305 kfree(ti_manuf_desc);
1306 return -EINVAL;
1307 }
1308
1309 /*
1310 * Update I2C with type 0xf2 record with correct
1311 * size and checksum
1312 */
1313 status = write_rom(serial,
1314 start_address,
1315 HEADER_SIZE,
1316 header);
1317 if (status) {
1318 kfree(vheader);
1319 kfree(header);
1320 kfree(rom_desc);
1321 kfree(ti_manuf_desc);
1322 return -EINVAL;
1323 }
1324
1325 /*
1326 * verify the write -- must do this in order for
1327 * write to complete before we do the hardware reset
1328 */
1329 status = read_rom(serial, start_address,
1330 HEADER_SIZE, vheader);
1331
1332 if (status) {
1333 dev_dbg(dev, "%s - can't read header back\n",
1334 __func__);
1335 kfree(vheader);
1336 kfree(header);
1337 kfree(rom_desc);
1338 kfree(ti_manuf_desc);
1339 return status;
1340 }
1341 if (memcmp(vheader, header, HEADER_SIZE)) {
1342 dev_dbg(dev, "%s - write download record failed\n",
1343 __func__);
1344 kfree(vheader);
1345 kfree(header);
1346 kfree(rom_desc);
1347 kfree(ti_manuf_desc);
1348 return -EINVAL;
1349 }
1350
1351 kfree(vheader);
1352 kfree(header);
1353
1354 dev_dbg(dev, "%s - Start firmware update\n", __func__);
1355
1356 /* Tell firmware to copy download image into I2C */
1357 status = ti_vsend_sync(serial->serial->dev,
1358 UMPC_COPY_DNLD_TO_I2C,
1359 0, 0, NULL, 0,
1360 TI_VSEND_TIMEOUT_FW_DOWNLOAD);
1361
1362 dev_dbg(dev, "%s - Update complete 0x%x\n", __func__,
1363 status);
1364 if (status) {
1365 dev_err(dev,
1366 "%s - UMPC_COPY_DNLD_TO_I2C failed\n",
1367 __func__);
1368 kfree(rom_desc);
1369 kfree(ti_manuf_desc);
1370 return status;
1371 }
1372 }
1373 }
1374
1375 /* The device is running the download code */
1376 kfree(rom_desc);
1377 kfree(ti_manuf_desc);
1378 return 0;
1379}
1380
1381static int do_boot_mode(struct edgeport_serial *serial,
1382 const struct firmware *fw)
1383{
1384 struct device *dev = &serial->serial->interface->dev;
1385 int status = 0;
1386 struct edge_ti_manuf_descriptor *ti_manuf_desc;
1387 struct edgeport_fw_hdr *fw_hdr = (struct edgeport_fw_hdr *)fw->data;
1388
1389 dev_dbg(dev, "%s - RUNNING IN BOOT MODE\n", __func__);
1390
1391 /* Configure the TI device so we can use the BULK pipes for download */
1392 status = config_boot_dev(serial->serial->dev);
1393 if (status)
1394 return status;
1395
1396 if (le16_to_cpu(serial->serial->dev->descriptor.idVendor)
1397 != USB_VENDOR_ID_ION) {
1398 dev_dbg(dev, "%s - VID = 0x%x\n", __func__,
1399 le16_to_cpu(serial->serial->dev->descriptor.idVendor));
1400 serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_II;
1401 goto stayinbootmode;
1402 }
1403
1404 /*
1405 * We have an ION device (I2c Must be programmed)
1406 * Determine I2C image type
1407 */
1408 if (i2c_type_bootmode(serial))
1409 goto stayinbootmode;
1410
1411 /* Check for ION Vendor ID and that the I2C is valid */
1412 if (!check_i2c_image(serial)) {
1413 struct ti_i2c_image_header *header;
1414 int i;
1415 __u8 cs = 0;
1416 __u8 *buffer;
1417 int buffer_size;
1418
1419 /*
1420 * Validate Hardware version number
1421 * Read Manufacturing Descriptor from TI Based Edgeport
1422 */
1423 ti_manuf_desc = kmalloc(sizeof(*ti_manuf_desc), GFP_KERNEL);
1424 if (!ti_manuf_desc)
1425 return -ENOMEM;
1426
1427 status = get_manuf_info(serial, (__u8 *)ti_manuf_desc);
1428 if (status) {
1429 kfree(ti_manuf_desc);
1430 goto stayinbootmode;
1431 }
1432
1433 /* Check for version 2 */
1434 if (!ignore_cpu_rev && ti_cpu_rev(ti_manuf_desc) < 2) {
1435 dev_dbg(dev, "%s - Wrong CPU Rev %d (Must be 2)\n",
1436 __func__, ti_cpu_rev(ti_manuf_desc));
1437 kfree(ti_manuf_desc);
1438 goto stayinbootmode;
1439 }
1440
1441 kfree(ti_manuf_desc);
1442
1443 /*
1444 * In order to update the I2C firmware we must change the type
1445 * 2 record to type 0xF2. This will force the UMP to come up
1446 * in Boot Mode. Then while in boot mode, the driver will
1447 * download the latest firmware (padded to 15.5k) into the
1448 * UMP ram. Finally when the device comes back up in download
1449 * mode the driver will cause the new firmware to be copied
1450 * from the UMP Ram to I2C and the firmware will update the
1451 * record type from 0xf2 to 0x02.
1452 *
1453 * Do we really have to copy the whole firmware image,
1454 * or could we do this in place!
1455 */
1456
1457 /* Allocate a 15.5k buffer + 3 byte header */
1458 buffer_size = (((1024 * 16) - 512) +
1459 sizeof(struct ti_i2c_image_header));
1460 buffer = kmalloc(buffer_size, GFP_KERNEL);
1461 if (!buffer)
1462 return -ENOMEM;
1463
1464 /* Initialize the buffer to 0xff (pad the buffer) */
1465 memset(buffer, 0xff, buffer_size);
1466 memcpy(buffer, &fw->data[4], fw->size - 4);
1467
1468 for (i = sizeof(struct ti_i2c_image_header);
1469 i < buffer_size; i++) {
1470 cs = (__u8)(cs + buffer[i]);
1471 }
1472
1473 header = (struct ti_i2c_image_header *)buffer;
1474
1475 /* update length and checksum after padding */
1476 header->Length = cpu_to_le16((__u16)(buffer_size -
1477 sizeof(struct ti_i2c_image_header)));
1478 header->CheckSum = cs;
1479
1480 /* Download the operational code */
1481 dev_dbg(dev, "%s - Downloading operational code image version %d.%d (TI UMP)\n",
1482 __func__,
1483 fw_hdr->major_version, fw_hdr->minor_version);
1484 status = download_code(serial, buffer, buffer_size);
1485
1486 kfree(buffer);
1487
1488 if (status) {
1489 dev_dbg(dev, "%s - Error downloading operational code image\n", __func__);
1490 return status;
1491 }
1492
1493 /* Device will reboot */
1494 serial->product_info.TiMode = TI_MODE_TRANSITIONING;
1495
1496 dev_dbg(dev, "%s - Download successful -- Device rebooting...\n", __func__);
1497
1498 return 1;
1499 }
1500
1501stayinbootmode:
1502 /* Eprom is invalid or blank stay in boot mode */
1503 dev_dbg(dev, "%s - STAYING IN BOOT MODE\n", __func__);
1504 serial->product_info.TiMode = TI_MODE_BOOT;
1505
1506 return 1;
1507}
1508
1509static int ti_do_config(struct edgeport_port *port, int feature, int on)
1510{
1511 int port_number = port->port->port_number;
1512
1513 on = !!on; /* 1 or 0 not bitmask */
1514 return send_cmd(port->port->serial->dev,
1515 feature, (__u8)(UMPM_UART1_PORT + port_number),
1516 on, NULL, 0);
1517}
1518
1519static int restore_mcr(struct edgeport_port *port, __u8 mcr)
1520{
1521 int status = 0;
1522
1523 dev_dbg(&port->port->dev, "%s - %x\n", __func__, mcr);
1524
1525 status = ti_do_config(port, UMPC_SET_CLR_DTR, mcr & MCR_DTR);
1526 if (status)
1527 return status;
1528 status = ti_do_config(port, UMPC_SET_CLR_RTS, mcr & MCR_RTS);
1529 if (status)
1530 return status;
1531 return ti_do_config(port, UMPC_SET_CLR_LOOPBACK, mcr & MCR_LOOPBACK);
1532}
1533
1534/* Convert TI LSR to standard UART flags */
1535static __u8 map_line_status(__u8 ti_lsr)
1536{
1537 __u8 lsr = 0;
1538
1539#define MAP_FLAG(flagUmp, flagUart) \
1540 if (ti_lsr & flagUmp) \
1541 lsr |= flagUart;
1542
1543 MAP_FLAG(UMP_UART_LSR_OV_MASK, LSR_OVER_ERR) /* overrun */
1544 MAP_FLAG(UMP_UART_LSR_PE_MASK, LSR_PAR_ERR) /* parity error */
1545 MAP_FLAG(UMP_UART_LSR_FE_MASK, LSR_FRM_ERR) /* framing error */
1546 MAP_FLAG(UMP_UART_LSR_BR_MASK, LSR_BREAK) /* break detected */
1547 MAP_FLAG(UMP_UART_LSR_RX_MASK, LSR_RX_AVAIL) /* rx data available */
1548 MAP_FLAG(UMP_UART_LSR_TX_MASK, LSR_TX_EMPTY) /* tx hold reg empty */
1549
1550#undef MAP_FLAG
1551
1552 return lsr;
1553}
1554
1555static void handle_new_msr(struct edgeport_port *edge_port, __u8 msr)
1556{
1557 struct async_icount *icount;
1558 struct tty_struct *tty;
1559
1560 dev_dbg(&edge_port->port->dev, "%s - %02x\n", __func__, msr);
1561
1562 if (msr & (EDGEPORT_MSR_DELTA_CTS | EDGEPORT_MSR_DELTA_DSR |
1563 EDGEPORT_MSR_DELTA_RI | EDGEPORT_MSR_DELTA_CD)) {
1564 icount = &edge_port->port->icount;
1565
1566 /* update input line counters */
1567 if (msr & EDGEPORT_MSR_DELTA_CTS)
1568 icount->cts++;
1569 if (msr & EDGEPORT_MSR_DELTA_DSR)
1570 icount->dsr++;
1571 if (msr & EDGEPORT_MSR_DELTA_CD)
1572 icount->dcd++;
1573 if (msr & EDGEPORT_MSR_DELTA_RI)
1574 icount->rng++;
1575 wake_up_interruptible(&edge_port->port->port.delta_msr_wait);
1576 }
1577
1578 /* Save the new modem status */
1579 edge_port->shadow_msr = msr & 0xf0;
1580
1581 tty = tty_port_tty_get(&edge_port->port->port);
1582 /* handle CTS flow control */
1583 if (tty && C_CRTSCTS(tty)) {
1584 if (msr & EDGEPORT_MSR_CTS)
1585 tty_wakeup(tty);
1586 }
1587 tty_kref_put(tty);
1588}
1589
1590static void handle_new_lsr(struct edgeport_port *edge_port, int lsr_data,
1591 __u8 lsr, __u8 data)
1592{
1593 struct async_icount *icount;
1594 __u8 new_lsr = (__u8)(lsr & (__u8)(LSR_OVER_ERR | LSR_PAR_ERR |
1595 LSR_FRM_ERR | LSR_BREAK));
1596
1597 dev_dbg(&edge_port->port->dev, "%s - %02x\n", __func__, new_lsr);
1598
1599 edge_port->shadow_lsr = lsr;
1600
1601 if (new_lsr & LSR_BREAK)
1602 /*
1603 * Parity and Framing errors only count if they
1604 * occur exclusive of a break being received.
1605 */
1606 new_lsr &= (__u8)(LSR_OVER_ERR | LSR_BREAK);
1607
1608 /* Place LSR data byte into Rx buffer */
1609 if (lsr_data)
1610 edge_tty_recv(edge_port->port, &data, 1);
1611
1612 /* update input line counters */
1613 icount = &edge_port->port->icount;
1614 if (new_lsr & LSR_BREAK)
1615 icount->brk++;
1616 if (new_lsr & LSR_OVER_ERR)
1617 icount->overrun++;
1618 if (new_lsr & LSR_PAR_ERR)
1619 icount->parity++;
1620 if (new_lsr & LSR_FRM_ERR)
1621 icount->frame++;
1622}
1623
1624static void edge_interrupt_callback(struct urb *urb)
1625{
1626 struct edgeport_serial *edge_serial = urb->context;
1627 struct usb_serial_port *port;
1628 struct edgeport_port *edge_port;
1629 struct device *dev;
1630 unsigned char *data = urb->transfer_buffer;
1631 int length = urb->actual_length;
1632 int port_number;
1633 int function;
1634 int retval;
1635 __u8 lsr;
1636 __u8 msr;
1637 int status = urb->status;
1638
1639 switch (status) {
1640 case 0:
1641 /* success */
1642 break;
1643 case -ECONNRESET:
1644 case -ENOENT:
1645 case -ESHUTDOWN:
1646 /* this urb is terminated, clean up */
1647 dev_dbg(&urb->dev->dev, "%s - urb shutting down with status: %d\n",
1648 __func__, status);
1649 return;
1650 default:
1651 dev_err(&urb->dev->dev, "%s - nonzero urb status received: "
1652 "%d\n", __func__, status);
1653 goto exit;
1654 }
1655
1656 if (!length) {
1657 dev_dbg(&urb->dev->dev, "%s - no data in urb\n", __func__);
1658 goto exit;
1659 }
1660
1661 dev = &edge_serial->serial->dev->dev;
1662 usb_serial_debug_data(dev, __func__, length, data);
1663
1664 if (length != 2) {
1665 dev_dbg(dev, "%s - expecting packet of size 2, got %d\n", __func__, length);
1666 goto exit;
1667 }
1668
1669 port_number = TIUMP_GET_PORT_FROM_CODE(data[0]);
1670 function = TIUMP_GET_FUNC_FROM_CODE(data[0]);
1671 dev_dbg(dev, "%s - port_number %d, function %d, info 0x%x\n", __func__,
1672 port_number, function, data[1]);
1673
1674 if (port_number >= edge_serial->serial->num_ports) {
1675 dev_err(dev, "bad port number %d\n", port_number);
1676 goto exit;
1677 }
1678
1679 port = edge_serial->serial->port[port_number];
1680 edge_port = usb_get_serial_port_data(port);
1681 if (!edge_port) {
1682 dev_dbg(dev, "%s - edge_port not found\n", __func__);
1683 return;
1684 }
1685 switch (function) {
1686 case TIUMP_INTERRUPT_CODE_LSR:
1687 lsr = map_line_status(data[1]);
1688 if (lsr & UMP_UART_LSR_DATA_MASK) {
1689 /*
1690 * Save the LSR event for bulk read completion routine
1691 */
1692 dev_dbg(dev, "%s - LSR Event Port %u LSR Status = %02x\n",
1693 __func__, port_number, lsr);
1694 edge_port->lsr_event = 1;
1695 edge_port->lsr_mask = lsr;
1696 } else {
1697 dev_dbg(dev, "%s - ===== Port %d LSR Status = %02x ======\n",
1698 __func__, port_number, lsr);
1699 handle_new_lsr(edge_port, 0, lsr, 0);
1700 }
1701 break;
1702
1703 case TIUMP_INTERRUPT_CODE_MSR: /* MSR */
1704 /* Copy MSR from UMP */
1705 msr = data[1];
1706 dev_dbg(dev, "%s - ===== Port %u MSR Status = %02x ======\n",
1707 __func__, port_number, msr);
1708 handle_new_msr(edge_port, msr);
1709 break;
1710
1711 default:
1712 dev_err(&urb->dev->dev,
1713 "%s - Unknown Interrupt code from UMP %x\n",
1714 __func__, data[1]);
1715 break;
1716
1717 }
1718
1719exit:
1720 retval = usb_submit_urb(urb, GFP_ATOMIC);
1721 if (retval)
1722 dev_err(&urb->dev->dev,
1723 "%s - usb_submit_urb failed with result %d\n",
1724 __func__, retval);
1725}
1726
1727static void edge_bulk_in_callback(struct urb *urb)
1728{
1729 struct edgeport_port *edge_port = urb->context;
1730 struct device *dev = &edge_port->port->dev;
1731 unsigned char *data = urb->transfer_buffer;
1732 unsigned long flags;
1733 int retval = 0;
1734 int port_number;
1735 int status = urb->status;
1736
1737 switch (status) {
1738 case 0:
1739 /* success */
1740 break;
1741 case -ECONNRESET:
1742 case -ENOENT:
1743 case -ESHUTDOWN:
1744 /* this urb is terminated, clean up */
1745 dev_dbg(&urb->dev->dev, "%s - urb shutting down with status: %d\n", __func__, status);
1746 return;
1747 default:
1748 dev_err(&urb->dev->dev, "%s - nonzero read bulk status received: %d\n", __func__, status);
1749 }
1750
1751 if (status == -EPIPE)
1752 goto exit;
1753
1754 if (status) {
1755 dev_err(&urb->dev->dev, "%s - stopping read!\n", __func__);
1756 return;
1757 }
1758
1759 port_number = edge_port->port->port_number;
1760
1761 if (urb->actual_length > 0 && edge_port->lsr_event) {
1762 edge_port->lsr_event = 0;
1763 dev_dbg(dev, "%s ===== Port %u LSR Status = %02x, Data = %02x ======\n",
1764 __func__, port_number, edge_port->lsr_mask, *data);
1765 handle_new_lsr(edge_port, 1, edge_port->lsr_mask, *data);
1766 /* Adjust buffer length/pointer */
1767 --urb->actual_length;
1768 ++data;
1769 }
1770
1771 if (urb->actual_length) {
1772 usb_serial_debug_data(dev, __func__, urb->actual_length, data);
1773 if (edge_port->close_pending)
1774 dev_dbg(dev, "%s - close pending, dropping data on the floor\n",
1775 __func__);
1776 else
1777 edge_tty_recv(edge_port->port, data,
1778 urb->actual_length);
1779 edge_port->port->icount.rx += urb->actual_length;
1780 }
1781
1782exit:
1783 /* continue read unless stopped */
1784 spin_lock_irqsave(&edge_port->ep_lock, flags);
1785 if (edge_port->ep_read_urb_state == EDGE_READ_URB_RUNNING)
1786 retval = usb_submit_urb(urb, GFP_ATOMIC);
1787 else if (edge_port->ep_read_urb_state == EDGE_READ_URB_STOPPING)
1788 edge_port->ep_read_urb_state = EDGE_READ_URB_STOPPED;
1789
1790 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
1791 if (retval)
1792 dev_err(dev, "%s - usb_submit_urb failed with result %d\n", __func__, retval);
1793}
1794
1795static void edge_tty_recv(struct usb_serial_port *port, unsigned char *data,
1796 int length)
1797{
1798 int queued;
1799
1800 queued = tty_insert_flip_string(&port->port, data, length);
1801 if (queued < length)
1802 dev_err(&port->dev, "%s - dropping data, %d bytes lost\n",
1803 __func__, length - queued);
1804 tty_flip_buffer_push(&port->port);
1805}
1806
1807static void edge_bulk_out_callback(struct urb *urb)
1808{
1809 struct usb_serial_port *port = urb->context;
1810 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1811 int status = urb->status;
1812 struct tty_struct *tty;
1813
1814 edge_port->ep_write_urb_in_use = 0;
1815
1816 switch (status) {
1817 case 0:
1818 /* success */
1819 break;
1820 case -ECONNRESET:
1821 case -ENOENT:
1822 case -ESHUTDOWN:
1823 /* this urb is terminated, clean up */
1824 dev_dbg(&urb->dev->dev, "%s - urb shutting down with status: %d\n",
1825 __func__, status);
1826 return;
1827 default:
1828 dev_err_console(port, "%s - nonzero write bulk status "
1829 "received: %d\n", __func__, status);
1830 }
1831
1832 /* send any buffered data */
1833 tty = tty_port_tty_get(&port->port);
1834 edge_send(port, tty);
1835 tty_kref_put(tty);
1836}
1837
1838static int edge_open(struct tty_struct *tty, struct usb_serial_port *port)
1839{
1840 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1841 struct edgeport_serial *edge_serial;
1842 struct usb_device *dev;
1843 struct urb *urb;
1844 int port_number;
1845 int status;
1846 u16 open_settings;
1847 u8 transaction_timeout;
1848
1849 if (edge_port == NULL)
1850 return -ENODEV;
1851
1852 port_number = port->port_number;
1853
1854 dev = port->serial->dev;
1855
1856 /* turn off loopback */
1857 status = ti_do_config(edge_port, UMPC_SET_CLR_LOOPBACK, 0);
1858 if (status) {
1859 dev_err(&port->dev,
1860 "%s - cannot send clear loopback command, %d\n",
1861 __func__, status);
1862 return status;
1863 }
1864
1865 /* set up the port settings */
1866 if (tty)
1867 edge_set_termios(tty, port, &tty->termios);
1868
1869 /* open up the port */
1870
1871 /* milliseconds to timeout for DMA transfer */
1872 transaction_timeout = 2;
1873
1874 edge_port->ump_read_timeout =
1875 max(20, ((transaction_timeout * 3) / 2));
1876
1877 /* milliseconds to timeout for DMA transfer */
1878 open_settings = (u8)(UMP_DMA_MODE_CONTINOUS |
1879 UMP_PIPE_TRANS_TIMEOUT_ENA |
1880 (transaction_timeout << 2));
1881
1882 dev_dbg(&port->dev, "%s - Sending UMPC_OPEN_PORT\n", __func__);
1883
1884 /* Tell TI to open and start the port */
1885 status = send_cmd(dev, UMPC_OPEN_PORT,
1886 (u8)(UMPM_UART1_PORT + port_number), open_settings, NULL, 0);
1887 if (status) {
1888 dev_err(&port->dev, "%s - cannot send open command, %d\n",
1889 __func__, status);
1890 return status;
1891 }
1892
1893 /* Start the DMA? */
1894 status = send_cmd(dev, UMPC_START_PORT,
1895 (u8)(UMPM_UART1_PORT + port_number), 0, NULL, 0);
1896 if (status) {
1897 dev_err(&port->dev, "%s - cannot send start DMA command, %d\n",
1898 __func__, status);
1899 return status;
1900 }
1901
1902 /* Clear TX and RX buffers in UMP */
1903 status = purge_port(port, UMP_PORT_DIR_OUT | UMP_PORT_DIR_IN);
1904 if (status) {
1905 dev_err(&port->dev,
1906 "%s - cannot send clear buffers command, %d\n",
1907 __func__, status);
1908 return status;
1909 }
1910
1911 /* Read Initial MSR */
1912 status = ti_vread_sync(dev, UMPC_READ_MSR, 0,
1913 (__u16)(UMPM_UART1_PORT + port_number),
1914 &edge_port->shadow_msr, 1);
1915 if (status) {
1916 dev_err(&port->dev, "%s - cannot send read MSR command, %d\n",
1917 __func__, status);
1918 return status;
1919 }
1920
1921 dev_dbg(&port->dev, "ShadowMSR 0x%X\n", edge_port->shadow_msr);
1922
1923 /* Set Initial MCR */
1924 edge_port->shadow_mcr = MCR_RTS | MCR_DTR;
1925 dev_dbg(&port->dev, "ShadowMCR 0x%X\n", edge_port->shadow_mcr);
1926
1927 edge_serial = edge_port->edge_serial;
1928 if (mutex_lock_interruptible(&edge_serial->es_lock))
1929 return -ERESTARTSYS;
1930 if (edge_serial->num_ports_open == 0) {
1931 /* we are the first port to open, post the interrupt urb */
1932 urb = edge_serial->serial->port[0]->interrupt_in_urb;
1933 urb->context = edge_serial;
1934 status = usb_submit_urb(urb, GFP_KERNEL);
1935 if (status) {
1936 dev_err(&port->dev,
1937 "%s - usb_submit_urb failed with value %d\n",
1938 __func__, status);
1939 goto release_es_lock;
1940 }
1941 }
1942
1943 /*
1944 * reset the data toggle on the bulk endpoints to work around bug in
1945 * host controllers where things get out of sync some times
1946 */
1947 usb_clear_halt(dev, port->write_urb->pipe);
1948 usb_clear_halt(dev, port->read_urb->pipe);
1949
1950 /* start up our bulk read urb */
1951 urb = port->read_urb;
1952 edge_port->ep_read_urb_state = EDGE_READ_URB_RUNNING;
1953 urb->context = edge_port;
1954 status = usb_submit_urb(urb, GFP_KERNEL);
1955 if (status) {
1956 dev_err(&port->dev,
1957 "%s - read bulk usb_submit_urb failed with value %d\n",
1958 __func__, status);
1959 goto unlink_int_urb;
1960 }
1961
1962 ++edge_serial->num_ports_open;
1963
1964 goto release_es_lock;
1965
1966unlink_int_urb:
1967 if (edge_port->edge_serial->num_ports_open == 0)
1968 usb_kill_urb(port->serial->port[0]->interrupt_in_urb);
1969release_es_lock:
1970 mutex_unlock(&edge_serial->es_lock);
1971 return status;
1972}
1973
1974static void edge_close(struct usb_serial_port *port)
1975{
1976 struct edgeport_serial *edge_serial;
1977 struct edgeport_port *edge_port;
1978 struct usb_serial *serial = port->serial;
1979 unsigned long flags;
1980 int port_number;
1981
1982 edge_serial = usb_get_serial_data(port->serial);
1983 edge_port = usb_get_serial_port_data(port);
1984 if (edge_serial == NULL || edge_port == NULL)
1985 return;
1986
1987 /*
1988 * The bulkreadcompletion routine will check
1989 * this flag and dump add read data
1990 */
1991 edge_port->close_pending = 1;
1992
1993 usb_kill_urb(port->read_urb);
1994 usb_kill_urb(port->write_urb);
1995 edge_port->ep_write_urb_in_use = 0;
1996 spin_lock_irqsave(&edge_port->ep_lock, flags);
1997 kfifo_reset_out(&port->write_fifo);
1998 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
1999
2000 dev_dbg(&port->dev, "%s - send umpc_close_port\n", __func__);
2001 port_number = port->port_number;
2002 send_cmd(serial->dev, UMPC_CLOSE_PORT,
2003 (__u8)(UMPM_UART1_PORT + port_number), 0, NULL, 0);
2004
2005 mutex_lock(&edge_serial->es_lock);
2006 --edge_port->edge_serial->num_ports_open;
2007 if (edge_port->edge_serial->num_ports_open <= 0) {
2008 /* last port is now closed, let's shut down our interrupt urb */
2009 usb_kill_urb(port->serial->port[0]->interrupt_in_urb);
2010 edge_port->edge_serial->num_ports_open = 0;
2011 }
2012 mutex_unlock(&edge_serial->es_lock);
2013 edge_port->close_pending = 0;
2014}
2015
2016static int edge_write(struct tty_struct *tty, struct usb_serial_port *port,
2017 const unsigned char *data, int count)
2018{
2019 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2020
2021 if (count == 0) {
2022 dev_dbg(&port->dev, "%s - write request of 0 bytes\n", __func__);
2023 return 0;
2024 }
2025
2026 if (edge_port == NULL)
2027 return -ENODEV;
2028 if (edge_port->close_pending == 1)
2029 return -ENODEV;
2030
2031 count = kfifo_in_locked(&port->write_fifo, data, count,
2032 &edge_port->ep_lock);
2033 edge_send(port, tty);
2034
2035 return count;
2036}
2037
2038static void edge_send(struct usb_serial_port *port, struct tty_struct *tty)
2039{
2040 int count, result;
2041 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2042 unsigned long flags;
2043
2044 spin_lock_irqsave(&edge_port->ep_lock, flags);
2045
2046 if (edge_port->ep_write_urb_in_use) {
2047 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2048 return;
2049 }
2050
2051 count = kfifo_out(&port->write_fifo,
2052 port->write_urb->transfer_buffer,
2053 port->bulk_out_size);
2054
2055 if (count == 0) {
2056 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2057 return;
2058 }
2059
2060 edge_port->ep_write_urb_in_use = 1;
2061
2062 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2063
2064 usb_serial_debug_data(&port->dev, __func__, count, port->write_urb->transfer_buffer);
2065
2066 /* set up our urb */
2067 port->write_urb->transfer_buffer_length = count;
2068
2069 /* send the data out the bulk port */
2070 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
2071 if (result) {
2072 dev_err_console(port,
2073 "%s - failed submitting write urb, error %d\n",
2074 __func__, result);
2075 edge_port->ep_write_urb_in_use = 0;
2076 /* TODO: reschedule edge_send */
2077 } else
2078 edge_port->port->icount.tx += count;
2079
2080 /*
2081 * wakeup any process waiting for writes to complete
2082 * there is now more room in the buffer for new writes
2083 */
2084 if (tty)
2085 tty_wakeup(tty);
2086}
2087
2088static int edge_write_room(struct tty_struct *tty)
2089{
2090 struct usb_serial_port *port = tty->driver_data;
2091 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2092 int room = 0;
2093 unsigned long flags;
2094
2095 if (edge_port == NULL)
2096 return 0;
2097 if (edge_port->close_pending == 1)
2098 return 0;
2099
2100 spin_lock_irqsave(&edge_port->ep_lock, flags);
2101 room = kfifo_avail(&port->write_fifo);
2102 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2103
2104 dev_dbg(&port->dev, "%s - returns %d\n", __func__, room);
2105 return room;
2106}
2107
2108static int edge_chars_in_buffer(struct tty_struct *tty)
2109{
2110 struct usb_serial_port *port = tty->driver_data;
2111 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2112 int chars = 0;
2113 unsigned long flags;
2114 if (edge_port == NULL)
2115 return 0;
2116
2117 spin_lock_irqsave(&edge_port->ep_lock, flags);
2118 chars = kfifo_len(&port->write_fifo);
2119 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2120
2121 dev_dbg(&port->dev, "%s - returns %d\n", __func__, chars);
2122 return chars;
2123}
2124
2125static bool edge_tx_empty(struct usb_serial_port *port)
2126{
2127 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2128 int ret;
2129
2130 ret = tx_active(edge_port);
2131 if (ret > 0)
2132 return false;
2133
2134 return true;
2135}
2136
2137static void edge_throttle(struct tty_struct *tty)
2138{
2139 struct usb_serial_port *port = tty->driver_data;
2140 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2141 int status;
2142
2143 if (edge_port == NULL)
2144 return;
2145
2146 /* if we are implementing XON/XOFF, send the stop character */
2147 if (I_IXOFF(tty)) {
2148 unsigned char stop_char = STOP_CHAR(tty);
2149 status = edge_write(tty, port, &stop_char, 1);
2150 if (status <= 0) {
2151 dev_err(&port->dev, "%s - failed to write stop character, %d\n", __func__, status);
2152 }
2153 }
2154
2155 /*
2156 * if we are implementing RTS/CTS, stop reads
2157 * and the Edgeport will clear the RTS line
2158 */
2159 if (C_CRTSCTS(tty))
2160 stop_read(edge_port);
2161
2162}
2163
2164static void edge_unthrottle(struct tty_struct *tty)
2165{
2166 struct usb_serial_port *port = tty->driver_data;
2167 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2168 int status;
2169
2170 if (edge_port == NULL)
2171 return;
2172
2173 /* if we are implementing XON/XOFF, send the start character */
2174 if (I_IXOFF(tty)) {
2175 unsigned char start_char = START_CHAR(tty);
2176 status = edge_write(tty, port, &start_char, 1);
2177 if (status <= 0) {
2178 dev_err(&port->dev, "%s - failed to write start character, %d\n", __func__, status);
2179 }
2180 }
2181 /*
2182 * if we are implementing RTS/CTS, restart reads
2183 * are the Edgeport will assert the RTS line
2184 */
2185 if (C_CRTSCTS(tty)) {
2186 status = restart_read(edge_port);
2187 if (status)
2188 dev_err(&port->dev,
2189 "%s - read bulk usb_submit_urb failed: %d\n",
2190 __func__, status);
2191 }
2192
2193}
2194
2195static void stop_read(struct edgeport_port *edge_port)
2196{
2197 unsigned long flags;
2198
2199 spin_lock_irqsave(&edge_port->ep_lock, flags);
2200
2201 if (edge_port->ep_read_urb_state == EDGE_READ_URB_RUNNING)
2202 edge_port->ep_read_urb_state = EDGE_READ_URB_STOPPING;
2203 edge_port->shadow_mcr &= ~MCR_RTS;
2204
2205 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2206}
2207
2208static int restart_read(struct edgeport_port *edge_port)
2209{
2210 struct urb *urb;
2211 int status = 0;
2212 unsigned long flags;
2213
2214 spin_lock_irqsave(&edge_port->ep_lock, flags);
2215
2216 if (edge_port->ep_read_urb_state == EDGE_READ_URB_STOPPED) {
2217 urb = edge_port->port->read_urb;
2218 status = usb_submit_urb(urb, GFP_ATOMIC);
2219 }
2220 edge_port->ep_read_urb_state = EDGE_READ_URB_RUNNING;
2221 edge_port->shadow_mcr |= MCR_RTS;
2222
2223 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2224
2225 return status;
2226}
2227
2228static void change_port_settings(struct tty_struct *tty,
2229 struct edgeport_port *edge_port, struct ktermios *old_termios)
2230{
2231 struct device *dev = &edge_port->port->dev;
2232 struct ump_uart_config *config;
2233 int baud;
2234 unsigned cflag;
2235 int status;
2236 int port_number = edge_port->port->port_number;
2237
2238 config = kmalloc (sizeof (*config), GFP_KERNEL);
2239 if (!config) {
2240 tty->termios = *old_termios;
2241 return;
2242 }
2243
2244 cflag = tty->termios.c_cflag;
2245
2246 config->wFlags = 0;
2247
2248 /* These flags must be set */
2249 config->wFlags |= UMP_MASK_UART_FLAGS_RECEIVE_MS_INT;
2250 config->wFlags |= UMP_MASK_UART_FLAGS_AUTO_START_ON_ERR;
2251 config->bUartMode = (__u8)(edge_port->bUartMode);
2252
2253 switch (cflag & CSIZE) {
2254 case CS5:
2255 config->bDataBits = UMP_UART_CHAR5BITS;
2256 dev_dbg(dev, "%s - data bits = 5\n", __func__);
2257 break;
2258 case CS6:
2259 config->bDataBits = UMP_UART_CHAR6BITS;
2260 dev_dbg(dev, "%s - data bits = 6\n", __func__);
2261 break;
2262 case CS7:
2263 config->bDataBits = UMP_UART_CHAR7BITS;
2264 dev_dbg(dev, "%s - data bits = 7\n", __func__);
2265 break;
2266 default:
2267 case CS8:
2268 config->bDataBits = UMP_UART_CHAR8BITS;
2269 dev_dbg(dev, "%s - data bits = 8\n", __func__);
2270 break;
2271 }
2272
2273 if (cflag & PARENB) {
2274 if (cflag & PARODD) {
2275 config->wFlags |= UMP_MASK_UART_FLAGS_PARITY;
2276 config->bParity = UMP_UART_ODDPARITY;
2277 dev_dbg(dev, "%s - parity = odd\n", __func__);
2278 } else {
2279 config->wFlags |= UMP_MASK_UART_FLAGS_PARITY;
2280 config->bParity = UMP_UART_EVENPARITY;
2281 dev_dbg(dev, "%s - parity = even\n", __func__);
2282 }
2283 } else {
2284 config->bParity = UMP_UART_NOPARITY;
2285 dev_dbg(dev, "%s - parity = none\n", __func__);
2286 }
2287
2288 if (cflag & CSTOPB) {
2289 config->bStopBits = UMP_UART_STOPBIT2;
2290 dev_dbg(dev, "%s - stop bits = 2\n", __func__);
2291 } else {
2292 config->bStopBits = UMP_UART_STOPBIT1;
2293 dev_dbg(dev, "%s - stop bits = 1\n", __func__);
2294 }
2295
2296 /* figure out the flow control settings */
2297 if (cflag & CRTSCTS) {
2298 config->wFlags |= UMP_MASK_UART_FLAGS_OUT_X_CTS_FLOW;
2299 config->wFlags |= UMP_MASK_UART_FLAGS_RTS_FLOW;
2300 dev_dbg(dev, "%s - RTS/CTS is enabled\n", __func__);
2301 } else {
2302 dev_dbg(dev, "%s - RTS/CTS is disabled\n", __func__);
2303 restart_read(edge_port);
2304 }
2305
2306 /*
2307 * if we are implementing XON/XOFF, set the start and stop
2308 * character in the device
2309 */
2310 config->cXon = START_CHAR(tty);
2311 config->cXoff = STOP_CHAR(tty);
2312
2313 /* if we are implementing INBOUND XON/XOFF */
2314 if (I_IXOFF(tty)) {
2315 config->wFlags |= UMP_MASK_UART_FLAGS_IN_X;
2316 dev_dbg(dev, "%s - INBOUND XON/XOFF is enabled, XON = %2x, XOFF = %2x\n",
2317 __func__, config->cXon, config->cXoff);
2318 } else
2319 dev_dbg(dev, "%s - INBOUND XON/XOFF is disabled\n", __func__);
2320
2321 /* if we are implementing OUTBOUND XON/XOFF */
2322 if (I_IXON(tty)) {
2323 config->wFlags |= UMP_MASK_UART_FLAGS_OUT_X;
2324 dev_dbg(dev, "%s - OUTBOUND XON/XOFF is enabled, XON = %2x, XOFF = %2x\n",
2325 __func__, config->cXon, config->cXoff);
2326 } else
2327 dev_dbg(dev, "%s - OUTBOUND XON/XOFF is disabled\n", __func__);
2328
2329 tty->termios.c_cflag &= ~CMSPAR;
2330
2331 /* Round the baud rate */
2332 baud = tty_get_baud_rate(tty);
2333 if (!baud) {
2334 /* pick a default, any default... */
2335 baud = 9600;
2336 } else {
2337 /* Avoid a zero divisor. */
2338 baud = min(baud, 461550);
2339 tty_encode_baud_rate(tty, baud, baud);
2340 }
2341
2342 edge_port->baud_rate = baud;
2343 config->wBaudRate = (__u16)((461550L + baud/2) / baud);
2344
2345 /* FIXME: Recompute actual baud from divisor here */
2346
2347 dev_dbg(dev, "%s - baud rate = %d, wBaudRate = %d\n", __func__, baud, config->wBaudRate);
2348
2349 dev_dbg(dev, "wBaudRate: %d\n", (int)(461550L / config->wBaudRate));
2350 dev_dbg(dev, "wFlags: 0x%x\n", config->wFlags);
2351 dev_dbg(dev, "bDataBits: %d\n", config->bDataBits);
2352 dev_dbg(dev, "bParity: %d\n", config->bParity);
2353 dev_dbg(dev, "bStopBits: %d\n", config->bStopBits);
2354 dev_dbg(dev, "cXon: %d\n", config->cXon);
2355 dev_dbg(dev, "cXoff: %d\n", config->cXoff);
2356 dev_dbg(dev, "bUartMode: %d\n", config->bUartMode);
2357
2358 /* move the word values into big endian mode */
2359 cpu_to_be16s(&config->wFlags);
2360 cpu_to_be16s(&config->wBaudRate);
2361
2362 status = send_cmd(edge_port->port->serial->dev, UMPC_SET_CONFIG,
2363 (__u8)(UMPM_UART1_PORT + port_number),
2364 0, (__u8 *)config, sizeof(*config));
2365 if (status)
2366 dev_dbg(dev, "%s - error %d when trying to write config to device\n",
2367 __func__, status);
2368 kfree(config);
2369}
2370
2371static void edge_set_termios(struct tty_struct *tty,
2372 struct usb_serial_port *port, struct ktermios *old_termios)
2373{
2374 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2375
2376 if (edge_port == NULL)
2377 return;
2378 /* change the port settings to the new ones specified */
2379 change_port_settings(tty, edge_port, old_termios);
2380}
2381
2382static int edge_tiocmset(struct tty_struct *tty,
2383 unsigned int set, unsigned int clear)
2384{
2385 struct usb_serial_port *port = tty->driver_data;
2386 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2387 unsigned int mcr;
2388 unsigned long flags;
2389
2390 spin_lock_irqsave(&edge_port->ep_lock, flags);
2391 mcr = edge_port->shadow_mcr;
2392 if (set & TIOCM_RTS)
2393 mcr |= MCR_RTS;
2394 if (set & TIOCM_DTR)
2395 mcr |= MCR_DTR;
2396 if (set & TIOCM_LOOP)
2397 mcr |= MCR_LOOPBACK;
2398
2399 if (clear & TIOCM_RTS)
2400 mcr &= ~MCR_RTS;
2401 if (clear & TIOCM_DTR)
2402 mcr &= ~MCR_DTR;
2403 if (clear & TIOCM_LOOP)
2404 mcr &= ~MCR_LOOPBACK;
2405
2406 edge_port->shadow_mcr = mcr;
2407 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2408
2409 restore_mcr(edge_port, mcr);
2410 return 0;
2411}
2412
2413static int edge_tiocmget(struct tty_struct *tty)
2414{
2415 struct usb_serial_port *port = tty->driver_data;
2416 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2417 unsigned int result = 0;
2418 unsigned int msr;
2419 unsigned int mcr;
2420 unsigned long flags;
2421
2422 spin_lock_irqsave(&edge_port->ep_lock, flags);
2423
2424 msr = edge_port->shadow_msr;
2425 mcr = edge_port->shadow_mcr;
2426 result = ((mcr & MCR_DTR) ? TIOCM_DTR: 0) /* 0x002 */
2427 | ((mcr & MCR_RTS) ? TIOCM_RTS: 0) /* 0x004 */
2428 | ((msr & EDGEPORT_MSR_CTS) ? TIOCM_CTS: 0) /* 0x020 */
2429 | ((msr & EDGEPORT_MSR_CD) ? TIOCM_CAR: 0) /* 0x040 */
2430 | ((msr & EDGEPORT_MSR_RI) ? TIOCM_RI: 0) /* 0x080 */
2431 | ((msr & EDGEPORT_MSR_DSR) ? TIOCM_DSR: 0); /* 0x100 */
2432
2433
2434 dev_dbg(&port->dev, "%s -- %x\n", __func__, result);
2435 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2436
2437 return result;
2438}
2439
2440static int get_serial_info(struct tty_struct *tty,
2441 struct serial_struct *ss)
2442{
2443 struct usb_serial_port *port = tty->driver_data;
2444 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2445 unsigned cwait;
2446
2447 cwait = edge_port->port->port.closing_wait;
2448 if (cwait != ASYNC_CLOSING_WAIT_NONE)
2449 cwait = jiffies_to_msecs(cwait) / 10;
2450
2451 ss->type = PORT_16550A;
2452 ss->line = edge_port->port->minor;
2453 ss->port = edge_port->port->port_number;
2454 ss->irq = 0;
2455 ss->xmit_fifo_size = edge_port->port->bulk_out_size;
2456 ss->baud_base = 9600;
2457 ss->close_delay = 5*HZ;
2458 ss->closing_wait = cwait;
2459 return 0;
2460}
2461
2462static void edge_break(struct tty_struct *tty, int break_state)
2463{
2464 struct usb_serial_port *port = tty->driver_data;
2465 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2466 int status;
2467 int bv = 0; /* Off */
2468
2469 if (break_state == -1)
2470 bv = 1; /* On */
2471 status = ti_do_config(edge_port, UMPC_SET_CLR_BREAK, bv);
2472 if (status)
2473 dev_dbg(&port->dev, "%s - error %d sending break set/clear command.\n",
2474 __func__, status);
2475}
2476
2477static void edge_heartbeat_schedule(struct edgeport_serial *edge_serial)
2478{
2479 if (!edge_serial->use_heartbeat)
2480 return;
2481
2482 schedule_delayed_work(&edge_serial->heartbeat_work,
2483 FW_HEARTBEAT_SECS * HZ);
2484}
2485
2486static void edge_heartbeat_work(struct work_struct *work)
2487{
2488 struct edgeport_serial *serial;
2489 struct ti_i2c_desc *rom_desc;
2490
2491 serial = container_of(work, struct edgeport_serial,
2492 heartbeat_work.work);
2493
2494 rom_desc = kmalloc(sizeof(*rom_desc), GFP_KERNEL);
2495
2496 /* Descriptor address request is enough to reset the firmware timer */
2497 if (!rom_desc || !get_descriptor_addr(serial, I2C_DESC_TYPE_ION,
2498 rom_desc)) {
2499 dev_err(&serial->serial->interface->dev,
2500 "%s - Incomplete heartbeat\n", __func__);
2501 }
2502 kfree(rom_desc);
2503
2504 edge_heartbeat_schedule(serial);
2505}
2506
2507static int edge_calc_num_ports(struct usb_serial *serial,
2508 struct usb_serial_endpoints *epds)
2509{
2510 struct device *dev = &serial->interface->dev;
2511 unsigned char num_ports = serial->type->num_ports;
2512
2513 /* Make sure we have the required endpoints when in download mode. */
2514 if (serial->interface->cur_altsetting->desc.bNumEndpoints > 1) {
2515 if (epds->num_bulk_in < num_ports ||
2516 epds->num_bulk_out < num_ports ||
2517 epds->num_interrupt_in < 1) {
2518 dev_err(dev, "required endpoints missing\n");
2519 return -ENODEV;
2520 }
2521 }
2522
2523 return num_ports;
2524}
2525
2526static int edge_startup(struct usb_serial *serial)
2527{
2528 struct edgeport_serial *edge_serial;
2529 int status;
2530 u16 product_id;
2531
2532 /* create our private serial structure */
2533 edge_serial = kzalloc(sizeof(struct edgeport_serial), GFP_KERNEL);
2534 if (!edge_serial)
2535 return -ENOMEM;
2536
2537 mutex_init(&edge_serial->es_lock);
2538 edge_serial->serial = serial;
2539 INIT_DELAYED_WORK(&edge_serial->heartbeat_work, edge_heartbeat_work);
2540 usb_set_serial_data(serial, edge_serial);
2541
2542 status = download_fw(edge_serial);
2543 if (status < 0) {
2544 kfree(edge_serial);
2545 return status;
2546 }
2547
2548 if (status > 0)
2549 return 1; /* bind but do not register any ports */
2550
2551 product_id = le16_to_cpu(
2552 edge_serial->serial->dev->descriptor.idProduct);
2553
2554 /* Currently only the EP/416 models require heartbeat support */
2555 if (edge_serial->fw_version > FW_HEARTBEAT_VERSION_CUTOFF) {
2556 if (product_id == ION_DEVICE_ID_TI_EDGEPORT_416 ||
2557 product_id == ION_DEVICE_ID_TI_EDGEPORT_416B) {
2558 edge_serial->use_heartbeat = true;
2559 }
2560 }
2561
2562 edge_heartbeat_schedule(edge_serial);
2563
2564 return 0;
2565}
2566
2567static void edge_disconnect(struct usb_serial *serial)
2568{
2569 struct edgeport_serial *edge_serial = usb_get_serial_data(serial);
2570
2571 cancel_delayed_work_sync(&edge_serial->heartbeat_work);
2572}
2573
2574static void edge_release(struct usb_serial *serial)
2575{
2576 struct edgeport_serial *edge_serial = usb_get_serial_data(serial);
2577
2578 cancel_delayed_work_sync(&edge_serial->heartbeat_work);
2579 kfree(edge_serial);
2580}
2581
2582static int edge_port_probe(struct usb_serial_port *port)
2583{
2584 struct edgeport_port *edge_port;
2585 int ret;
2586
2587 edge_port = kzalloc(sizeof(*edge_port), GFP_KERNEL);
2588 if (!edge_port)
2589 return -ENOMEM;
2590
2591 spin_lock_init(&edge_port->ep_lock);
2592 edge_port->port = port;
2593 edge_port->edge_serial = usb_get_serial_data(port->serial);
2594 edge_port->bUartMode = default_uart_mode;
2595
2596 switch (port->port_number) {
2597 case 0:
2598 edge_port->uart_base = UMPMEM_BASE_UART1;
2599 edge_port->dma_address = UMPD_OEDB1_ADDRESS;
2600 break;
2601 case 1:
2602 edge_port->uart_base = UMPMEM_BASE_UART2;
2603 edge_port->dma_address = UMPD_OEDB2_ADDRESS;
2604 break;
2605 default:
2606 dev_err(&port->dev, "unknown port number\n");
2607 ret = -ENODEV;
2608 goto err;
2609 }
2610
2611 dev_dbg(&port->dev,
2612 "%s - port_number = %d, uart_base = %04x, dma_address = %04x\n",
2613 __func__, port->port_number, edge_port->uart_base,
2614 edge_port->dma_address);
2615
2616 usb_set_serial_port_data(port, edge_port);
2617
2618 ret = edge_create_sysfs_attrs(port);
2619 if (ret)
2620 goto err;
2621
2622 port->port.closing_wait = msecs_to_jiffies(closing_wait * 10);
2623 port->port.drain_delay = 1;
2624
2625 return 0;
2626err:
2627 kfree(edge_port);
2628
2629 return ret;
2630}
2631
2632static int edge_port_remove(struct usb_serial_port *port)
2633{
2634 struct edgeport_port *edge_port;
2635
2636 edge_port = usb_get_serial_port_data(port);
2637 edge_remove_sysfs_attrs(port);
2638 kfree(edge_port);
2639
2640 return 0;
2641}
2642
2643/* Sysfs Attributes */
2644
2645static ssize_t uart_mode_show(struct device *dev,
2646 struct device_attribute *attr, char *buf)
2647{
2648 struct usb_serial_port *port = to_usb_serial_port(dev);
2649 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2650
2651 return sprintf(buf, "%d\n", edge_port->bUartMode);
2652}
2653
2654static ssize_t uart_mode_store(struct device *dev,
2655 struct device_attribute *attr, const char *valbuf, size_t count)
2656{
2657 struct usb_serial_port *port = to_usb_serial_port(dev);
2658 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2659 unsigned int v = simple_strtoul(valbuf, NULL, 0);
2660
2661 dev_dbg(dev, "%s: setting uart_mode = %d\n", __func__, v);
2662
2663 if (v < 256)
2664 edge_port->bUartMode = v;
2665 else
2666 dev_err(dev, "%s - uart_mode %d is invalid\n", __func__, v);
2667
2668 return count;
2669}
2670static DEVICE_ATTR_RW(uart_mode);
2671
2672static int edge_create_sysfs_attrs(struct usb_serial_port *port)
2673{
2674 return device_create_file(&port->dev, &dev_attr_uart_mode);
2675}
2676
2677static int edge_remove_sysfs_attrs(struct usb_serial_port *port)
2678{
2679 device_remove_file(&port->dev, &dev_attr_uart_mode);
2680 return 0;
2681}
2682
2683#ifdef CONFIG_PM
2684static int edge_suspend(struct usb_serial *serial, pm_message_t message)
2685{
2686 struct edgeport_serial *edge_serial = usb_get_serial_data(serial);
2687
2688 cancel_delayed_work_sync(&edge_serial->heartbeat_work);
2689
2690 return 0;
2691}
2692
2693static int edge_resume(struct usb_serial *serial)
2694{
2695 struct edgeport_serial *edge_serial = usb_get_serial_data(serial);
2696
2697 edge_heartbeat_schedule(edge_serial);
2698
2699 return 0;
2700}
2701#endif
2702
2703static struct usb_serial_driver edgeport_1port_device = {
2704 .driver = {
2705 .owner = THIS_MODULE,
2706 .name = "edgeport_ti_1",
2707 },
2708 .description = "Edgeport TI 1 port adapter",
2709 .id_table = edgeport_1port_id_table,
2710 .num_ports = 1,
2711 .num_bulk_out = 1,
2712 .open = edge_open,
2713 .close = edge_close,
2714 .throttle = edge_throttle,
2715 .unthrottle = edge_unthrottle,
2716 .attach = edge_startup,
2717 .calc_num_ports = edge_calc_num_ports,
2718 .disconnect = edge_disconnect,
2719 .release = edge_release,
2720 .port_probe = edge_port_probe,
2721 .port_remove = edge_port_remove,
2722 .get_serial = get_serial_info,
2723 .set_termios = edge_set_termios,
2724 .tiocmget = edge_tiocmget,
2725 .tiocmset = edge_tiocmset,
2726 .tiocmiwait = usb_serial_generic_tiocmiwait,
2727 .get_icount = usb_serial_generic_get_icount,
2728 .write = edge_write,
2729 .write_room = edge_write_room,
2730 .chars_in_buffer = edge_chars_in_buffer,
2731 .tx_empty = edge_tx_empty,
2732 .break_ctl = edge_break,
2733 .read_int_callback = edge_interrupt_callback,
2734 .read_bulk_callback = edge_bulk_in_callback,
2735 .write_bulk_callback = edge_bulk_out_callback,
2736#ifdef CONFIG_PM
2737 .suspend = edge_suspend,
2738 .resume = edge_resume,
2739#endif
2740};
2741
2742static struct usb_serial_driver edgeport_2port_device = {
2743 .driver = {
2744 .owner = THIS_MODULE,
2745 .name = "edgeport_ti_2",
2746 },
2747 .description = "Edgeport TI 2 port adapter",
2748 .id_table = edgeport_2port_id_table,
2749 .num_ports = 2,
2750 .num_bulk_out = 1,
2751 .open = edge_open,
2752 .close = edge_close,
2753 .throttle = edge_throttle,
2754 .unthrottle = edge_unthrottle,
2755 .attach = edge_startup,
2756 .calc_num_ports = edge_calc_num_ports,
2757 .disconnect = edge_disconnect,
2758 .release = edge_release,
2759 .port_probe = edge_port_probe,
2760 .port_remove = edge_port_remove,
2761 .get_serial = get_serial_info,
2762 .set_termios = edge_set_termios,
2763 .tiocmget = edge_tiocmget,
2764 .tiocmset = edge_tiocmset,
2765 .tiocmiwait = usb_serial_generic_tiocmiwait,
2766 .get_icount = usb_serial_generic_get_icount,
2767 .write = edge_write,
2768 .write_room = edge_write_room,
2769 .chars_in_buffer = edge_chars_in_buffer,
2770 .tx_empty = edge_tx_empty,
2771 .break_ctl = edge_break,
2772 .read_int_callback = edge_interrupt_callback,
2773 .read_bulk_callback = edge_bulk_in_callback,
2774 .write_bulk_callback = edge_bulk_out_callback,
2775#ifdef CONFIG_PM
2776 .suspend = edge_suspend,
2777 .resume = edge_resume,
2778#endif
2779};
2780
2781static struct usb_serial_driver * const serial_drivers[] = {
2782 &edgeport_1port_device, &edgeport_2port_device, NULL
2783};
2784
2785module_usb_serial_driver(serial_drivers, id_table_combined);
2786
2787MODULE_AUTHOR(DRIVER_AUTHOR);
2788MODULE_DESCRIPTION(DRIVER_DESC);
2789MODULE_LICENSE("GPL");
2790MODULE_FIRMWARE("edgeport/down3.bin");
2791
2792module_param(closing_wait, int, S_IRUGO | S_IWUSR);
2793MODULE_PARM_DESC(closing_wait, "Maximum wait for data to drain, in .01 secs");
2794
2795module_param(ignore_cpu_rev, bool, S_IRUGO | S_IWUSR);
2796MODULE_PARM_DESC(ignore_cpu_rev,
2797 "Ignore the cpu revision when connecting to a device");
2798
2799module_param(default_uart_mode, int, S_IRUGO | S_IWUSR);
2800MODULE_PARM_DESC(default_uart_mode, "Default uart_mode, 0=RS232, ...");
1/*
2 * Edgeport USB Serial Converter driver
3 *
4 * Copyright (C) 2000-2002 Inside Out Networks, All rights reserved.
5 * Copyright (C) 2001-2002 Greg Kroah-Hartman <greg@kroah.com>
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * Supports the following devices:
13 * EP/1 EP/2 EP/4 EP/21 EP/22 EP/221 EP/42 EP/421 WATCHPORT
14 *
15 * For questions or problems with this driver, contact Inside Out
16 * Networks technical support, or Peter Berger <pberger@brimson.com>,
17 * or Al Borchers <alborchers@steinerpoint.com>.
18 */
19
20#include <linux/kernel.h>
21#include <linux/jiffies.h>
22#include <linux/errno.h>
23#include <linux/slab.h>
24#include <linux/tty.h>
25#include <linux/tty_driver.h>
26#include <linux/tty_flip.h>
27#include <linux/module.h>
28#include <linux/spinlock.h>
29#include <linux/mutex.h>
30#include <linux/serial.h>
31#include <linux/swab.h>
32#include <linux/kfifo.h>
33#include <linux/ioctl.h>
34#include <linux/firmware.h>
35#include <linux/uaccess.h>
36#include <linux/usb.h>
37#include <linux/usb/serial.h>
38
39#include "io_16654.h"
40#include "io_usbvend.h"
41#include "io_ti.h"
42
43#define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com> and David Iacovelli"
44#define DRIVER_DESC "Edgeport USB Serial Driver"
45
46#define EPROM_PAGE_SIZE 64
47
48
49/* different hardware types */
50#define HARDWARE_TYPE_930 0
51#define HARDWARE_TYPE_TIUMP 1
52
53/* IOCTL_PRIVATE_TI_GET_MODE Definitions */
54#define TI_MODE_CONFIGURING 0 /* Device has not entered start device */
55#define TI_MODE_BOOT 1 /* Staying in boot mode */
56#define TI_MODE_DOWNLOAD 2 /* Made it to download mode */
57#define TI_MODE_TRANSITIONING 3 /*
58 * Currently in boot mode but
59 * transitioning to download mode
60 */
61
62/* read urb state */
63#define EDGE_READ_URB_RUNNING 0
64#define EDGE_READ_URB_STOPPING 1
65#define EDGE_READ_URB_STOPPED 2
66
67#define EDGE_CLOSING_WAIT 4000 /* in .01 sec */
68
69
70/* Product information read from the Edgeport */
71struct product_info {
72 int TiMode; /* Current TI Mode */
73 __u8 hardware_type; /* Type of hardware */
74} __attribute__((packed));
75
76/*
77 * Edgeport firmware header
78 *
79 * "build_number" has been set to 0 in all three of the images I have
80 * seen, and Digi Tech Support suggests that it is safe to ignore it.
81 *
82 * "length" is the number of bytes of actual data following the header.
83 *
84 * "checksum" is the low order byte resulting from adding the values of
85 * all the data bytes.
86 */
87struct edgeport_fw_hdr {
88 u8 major_version;
89 u8 minor_version;
90 __le16 build_number;
91 __le16 length;
92 u8 checksum;
93} __packed;
94
95struct edgeport_port {
96 __u16 uart_base;
97 __u16 dma_address;
98 __u8 shadow_msr;
99 __u8 shadow_mcr;
100 __u8 shadow_lsr;
101 __u8 lsr_mask;
102 __u32 ump_read_timeout; /*
103 * Number of milliseconds the UMP will
104 * wait without data before completing
105 * a read short
106 */
107 int baud_rate;
108 int close_pending;
109 int lsr_event;
110
111 struct edgeport_serial *edge_serial;
112 struct usb_serial_port *port;
113 __u8 bUartMode; /* Port type, 0: RS232, etc. */
114 spinlock_t ep_lock;
115 int ep_read_urb_state;
116 int ep_write_urb_in_use;
117};
118
119struct edgeport_serial {
120 struct product_info product_info;
121 u8 TI_I2C_Type; /* Type of I2C in UMP */
122 u8 TiReadI2C; /*
123 * Set to TRUE if we have read the
124 * I2c in Boot Mode
125 */
126 struct mutex es_lock;
127 int num_ports_open;
128 struct usb_serial *serial;
129 struct delayed_work heartbeat_work;
130 int fw_version;
131 bool use_heartbeat;
132};
133
134
135/* Devices that this driver supports */
136static const struct usb_device_id edgeport_1port_id_table[] = {
137 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_1) },
138 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_TI3410_EDGEPORT_1) },
139 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_TI3410_EDGEPORT_1I) },
140 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_PROXIMITY) },
141 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_MOTION) },
142 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_MOISTURE) },
143 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_TEMPERATURE) },
144 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_HUMIDITY) },
145 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_POWER) },
146 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_LIGHT) },
147 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_RADIATION) },
148 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_DISTANCE) },
149 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_ACCELERATION) },
150 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_PROX_DIST) },
151 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_PLUS_PWR_HP4CD) },
152 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_PLUS_PWR_PCI) },
153 { }
154};
155
156static const struct usb_device_id edgeport_2port_id_table[] = {
157 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_2) },
158 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_2C) },
159 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_2I) },
160 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_421) },
161 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_21) },
162 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_42) },
163 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_4) },
164 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_4I) },
165 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_22I) },
166 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_221C) },
167 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_22C) },
168 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_21C) },
169 /* The 4, 8 and 16 port devices show up as multiple 2 port devices */
170 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_4S) },
171 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_8) },
172 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_8S) },
173 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_416) },
174 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_416B) },
175 { }
176};
177
178/* Devices that this driver supports */
179static const struct usb_device_id id_table_combined[] = {
180 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_1) },
181 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_TI3410_EDGEPORT_1) },
182 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_TI3410_EDGEPORT_1I) },
183 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_PROXIMITY) },
184 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_MOTION) },
185 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_MOISTURE) },
186 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_TEMPERATURE) },
187 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_HUMIDITY) },
188 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_POWER) },
189 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_LIGHT) },
190 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_RADIATION) },
191 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_DISTANCE) },
192 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_ACCELERATION) },
193 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_PROX_DIST) },
194 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_PLUS_PWR_HP4CD) },
195 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_PLUS_PWR_PCI) },
196 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_2) },
197 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_2C) },
198 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_2I) },
199 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_421) },
200 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_21) },
201 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_42) },
202 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_4) },
203 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_4I) },
204 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_22I) },
205 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_221C) },
206 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_22C) },
207 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_21C) },
208 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_4S) },
209 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_8) },
210 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_8S) },
211 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_416) },
212 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_416B) },
213 { }
214};
215
216MODULE_DEVICE_TABLE(usb, id_table_combined);
217
218static int closing_wait = EDGE_CLOSING_WAIT;
219static bool ignore_cpu_rev;
220static int default_uart_mode; /* RS232 */
221
222static void edge_tty_recv(struct usb_serial_port *port, unsigned char *data,
223 int length);
224
225static void stop_read(struct edgeport_port *edge_port);
226static int restart_read(struct edgeport_port *edge_port);
227
228static void edge_set_termios(struct tty_struct *tty,
229 struct usb_serial_port *port, struct ktermios *old_termios);
230static void edge_send(struct usb_serial_port *port, struct tty_struct *tty);
231
232static int do_download_mode(struct edgeport_serial *serial,
233 const struct firmware *fw);
234static int do_boot_mode(struct edgeport_serial *serial,
235 const struct firmware *fw);
236
237/* sysfs attributes */
238static int edge_create_sysfs_attrs(struct usb_serial_port *port);
239static int edge_remove_sysfs_attrs(struct usb_serial_port *port);
240
241/*
242 * Some release of Edgeport firmware "down3.bin" after version 4.80
243 * introduced code to automatically disconnect idle devices on some
244 * Edgeport models after periods of inactivity, typically ~60 seconds.
245 * This occurs without regard to whether ports on the device are open
246 * or not. Digi International Tech Support suggested:
247 *
248 * 1. Adding driver "heartbeat" code to reset the firmware timer by
249 * requesting a descriptor record every 15 seconds, which should be
250 * effective with newer firmware versions that require it, and benign
251 * with older versions that do not. In practice 40 seconds seems often
252 * enough.
253 * 2. The heartbeat code is currently required only on Edgeport/416 models.
254 */
255#define FW_HEARTBEAT_VERSION_CUTOFF ((4 << 8) + 80)
256#define FW_HEARTBEAT_SECS 40
257
258/* Timeouts in msecs: firmware downloads take longer */
259#define TI_VSEND_TIMEOUT_DEFAULT 1000
260#define TI_VSEND_TIMEOUT_FW_DOWNLOAD 10000
261
262static int ti_vread_sync(struct usb_device *dev, __u8 request,
263 __u16 value, __u16 index, u8 *data, int size)
264{
265 int status;
266
267 status = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0), request,
268 (USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN),
269 value, index, data, size, 1000);
270 if (status < 0)
271 return status;
272 if (status != size) {
273 dev_dbg(&dev->dev, "%s - wanted to write %d, but only wrote %d\n",
274 __func__, size, status);
275 return -ECOMM;
276 }
277 return 0;
278}
279
280static int ti_vsend_sync(struct usb_device *dev, u8 request, u16 value,
281 u16 index, u8 *data, int size, int timeout)
282{
283 int status;
284
285 status = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), request,
286 (USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT),
287 value, index, data, size, timeout);
288 if (status < 0)
289 return status;
290 if (status != size) {
291 dev_dbg(&dev->dev, "%s - wanted to write %d, but only wrote %d\n",
292 __func__, size, status);
293 return -ECOMM;
294 }
295 return 0;
296}
297
298static int send_cmd(struct usb_device *dev, __u8 command,
299 __u8 moduleid, __u16 value, u8 *data,
300 int size)
301{
302 return ti_vsend_sync(dev, command, value, moduleid, data, size,
303 TI_VSEND_TIMEOUT_DEFAULT);
304}
305
306/* clear tx/rx buffers and fifo in TI UMP */
307static int purge_port(struct usb_serial_port *port, __u16 mask)
308{
309 int port_number = port->port_number;
310
311 dev_dbg(&port->dev, "%s - port %d, mask %x\n", __func__, port_number, mask);
312
313 return send_cmd(port->serial->dev,
314 UMPC_PURGE_PORT,
315 (__u8)(UMPM_UART1_PORT + port_number),
316 mask,
317 NULL,
318 0);
319}
320
321/**
322 * read_download_mem - Read edgeport memory from TI chip
323 * @dev: usb device pointer
324 * @start_address: Device CPU address at which to read
325 * @length: Length of above data
326 * @address_type: Can read both XDATA and I2C
327 * @buffer: pointer to input data buffer
328 */
329static int read_download_mem(struct usb_device *dev, int start_address,
330 int length, __u8 address_type, __u8 *buffer)
331{
332 int status = 0;
333 __u8 read_length;
334 u16 be_start_address;
335
336 dev_dbg(&dev->dev, "%s - @ %x for %d\n", __func__, start_address, length);
337
338 /*
339 * Read in blocks of 64 bytes
340 * (TI firmware can't handle more than 64 byte reads)
341 */
342 while (length) {
343 if (length > 64)
344 read_length = 64;
345 else
346 read_length = (__u8)length;
347
348 if (read_length > 1) {
349 dev_dbg(&dev->dev, "%s - @ %x for %d\n", __func__, start_address, read_length);
350 }
351 /*
352 * NOTE: Must use swab as wIndex is sent in little-endian
353 * byte order regardless of host byte order.
354 */
355 be_start_address = swab16((u16)start_address);
356 status = ti_vread_sync(dev, UMPC_MEMORY_READ,
357 (__u16)address_type,
358 be_start_address,
359 buffer, read_length);
360
361 if (status) {
362 dev_dbg(&dev->dev, "%s - ERROR %x\n", __func__, status);
363 return status;
364 }
365
366 if (read_length > 1)
367 usb_serial_debug_data(&dev->dev, __func__, read_length, buffer);
368
369 /* Update pointers/length */
370 start_address += read_length;
371 buffer += read_length;
372 length -= read_length;
373 }
374
375 return status;
376}
377
378static int read_ram(struct usb_device *dev, int start_address,
379 int length, __u8 *buffer)
380{
381 return read_download_mem(dev, start_address, length,
382 DTK_ADDR_SPACE_XDATA, buffer);
383}
384
385/* Read edgeport memory to a given block */
386static int read_boot_mem(struct edgeport_serial *serial,
387 int start_address, int length, __u8 *buffer)
388{
389 int status = 0;
390 int i;
391
392 for (i = 0; i < length; i++) {
393 status = ti_vread_sync(serial->serial->dev,
394 UMPC_MEMORY_READ, serial->TI_I2C_Type,
395 (__u16)(start_address+i), &buffer[i], 0x01);
396 if (status) {
397 dev_dbg(&serial->serial->dev->dev, "%s - ERROR %x\n", __func__, status);
398 return status;
399 }
400 }
401
402 dev_dbg(&serial->serial->dev->dev, "%s - start_address = %x, length = %d\n",
403 __func__, start_address, length);
404 usb_serial_debug_data(&serial->serial->dev->dev, __func__, length, buffer);
405
406 serial->TiReadI2C = 1;
407
408 return status;
409}
410
411/* Write given block to TI EPROM memory */
412static int write_boot_mem(struct edgeport_serial *serial,
413 int start_address, int length, __u8 *buffer)
414{
415 int status = 0;
416 int i;
417 u8 *temp;
418
419 /* Must do a read before write */
420 if (!serial->TiReadI2C) {
421 temp = kmalloc(1, GFP_KERNEL);
422 if (!temp)
423 return -ENOMEM;
424
425 status = read_boot_mem(serial, 0, 1, temp);
426 kfree(temp);
427 if (status)
428 return status;
429 }
430
431 for (i = 0; i < length; ++i) {
432 status = ti_vsend_sync(serial->serial->dev, UMPC_MEMORY_WRITE,
433 buffer[i], (u16)(i + start_address), NULL,
434 0, TI_VSEND_TIMEOUT_DEFAULT);
435 if (status)
436 return status;
437 }
438
439 dev_dbg(&serial->serial->dev->dev, "%s - start_sddr = %x, length = %d\n", __func__, start_address, length);
440 usb_serial_debug_data(&serial->serial->dev->dev, __func__, length, buffer);
441
442 return status;
443}
444
445/* Write edgeport I2C memory to TI chip */
446static int write_i2c_mem(struct edgeport_serial *serial,
447 int start_address, int length, __u8 address_type, __u8 *buffer)
448{
449 struct device *dev = &serial->serial->dev->dev;
450 int status = 0;
451 int write_length;
452 u16 be_start_address;
453
454 /* We can only send a maximum of 1 aligned byte page at a time */
455
456 /* calculate the number of bytes left in the first page */
457 write_length = EPROM_PAGE_SIZE -
458 (start_address & (EPROM_PAGE_SIZE - 1));
459
460 if (write_length > length)
461 write_length = length;
462
463 dev_dbg(dev, "%s - BytesInFirstPage Addr = %x, length = %d\n",
464 __func__, start_address, write_length);
465 usb_serial_debug_data(dev, __func__, write_length, buffer);
466
467 /*
468 * Write first page.
469 *
470 * NOTE: Must use swab as wIndex is sent in little-endian byte order
471 * regardless of host byte order.
472 */
473 be_start_address = swab16((u16)start_address);
474 status = ti_vsend_sync(serial->serial->dev, UMPC_MEMORY_WRITE,
475 (u16)address_type, be_start_address,
476 buffer, write_length, TI_VSEND_TIMEOUT_DEFAULT);
477 if (status) {
478 dev_dbg(dev, "%s - ERROR %d\n", __func__, status);
479 return status;
480 }
481
482 length -= write_length;
483 start_address += write_length;
484 buffer += write_length;
485
486 /*
487 * We should be aligned now -- can write max page size bytes at a
488 * time.
489 */
490 while (length) {
491 if (length > EPROM_PAGE_SIZE)
492 write_length = EPROM_PAGE_SIZE;
493 else
494 write_length = length;
495
496 dev_dbg(dev, "%s - Page Write Addr = %x, length = %d\n",
497 __func__, start_address, write_length);
498 usb_serial_debug_data(dev, __func__, write_length, buffer);
499
500 /*
501 * Write next page.
502 *
503 * NOTE: Must use swab as wIndex is sent in little-endian byte
504 * order regardless of host byte order.
505 */
506 be_start_address = swab16((u16)start_address);
507 status = ti_vsend_sync(serial->serial->dev, UMPC_MEMORY_WRITE,
508 (u16)address_type, be_start_address, buffer,
509 write_length, TI_VSEND_TIMEOUT_DEFAULT);
510 if (status) {
511 dev_err(dev, "%s - ERROR %d\n", __func__, status);
512 return status;
513 }
514
515 length -= write_length;
516 start_address += write_length;
517 buffer += write_length;
518 }
519 return status;
520}
521
522/*
523 * Examine the UMP DMA registers and LSR
524 *
525 * Check the MSBit of the X and Y DMA byte count registers.
526 * A zero in this bit indicates that the TX DMA buffers are empty
527 * then check the TX Empty bit in the UART.
528 */
529static int tx_active(struct edgeport_port *port)
530{
531 int status;
532 struct out_endpoint_desc_block *oedb;
533 __u8 *lsr;
534 int bytes_left = 0;
535
536 oedb = kmalloc(sizeof(*oedb), GFP_KERNEL);
537 if (!oedb)
538 return -ENOMEM;
539
540 /*
541 * Sigh, that's right, just one byte, as not all platforms can
542 * do DMA from stack
543 */
544 lsr = kmalloc(1, GFP_KERNEL);
545 if (!lsr) {
546 kfree(oedb);
547 return -ENOMEM;
548 }
549 /* Read the DMA Count Registers */
550 status = read_ram(port->port->serial->dev, port->dma_address,
551 sizeof(*oedb), (void *)oedb);
552 if (status)
553 goto exit_is_tx_active;
554
555 dev_dbg(&port->port->dev, "%s - XByteCount 0x%X\n", __func__, oedb->XByteCount);
556
557 /* and the LSR */
558 status = read_ram(port->port->serial->dev,
559 port->uart_base + UMPMEM_OFFS_UART_LSR, 1, lsr);
560
561 if (status)
562 goto exit_is_tx_active;
563 dev_dbg(&port->port->dev, "%s - LSR = 0x%X\n", __func__, *lsr);
564
565 /* If either buffer has data or we are transmitting then return TRUE */
566 if ((oedb->XByteCount & 0x80) != 0)
567 bytes_left += 64;
568
569 if ((*lsr & UMP_UART_LSR_TX_MASK) == 0)
570 bytes_left += 1;
571
572 /* We return Not Active if we get any kind of error */
573exit_is_tx_active:
574 dev_dbg(&port->port->dev, "%s - return %d\n", __func__, bytes_left);
575
576 kfree(lsr);
577 kfree(oedb);
578 return bytes_left;
579}
580
581static int choose_config(struct usb_device *dev)
582{
583 /*
584 * There may be multiple configurations on this device, in which case
585 * we would need to read and parse all of them to find out which one
586 * we want. However, we just support one config at this point,
587 * configuration # 1, which is Config Descriptor 0.
588 */
589
590 dev_dbg(&dev->dev, "%s - Number of Interfaces = %d\n",
591 __func__, dev->config->desc.bNumInterfaces);
592 dev_dbg(&dev->dev, "%s - MAX Power = %d\n",
593 __func__, dev->config->desc.bMaxPower * 2);
594
595 if (dev->config->desc.bNumInterfaces != 1) {
596 dev_err(&dev->dev, "%s - bNumInterfaces is not 1, ERROR!\n", __func__);
597 return -ENODEV;
598 }
599
600 return 0;
601}
602
603static int read_rom(struct edgeport_serial *serial,
604 int start_address, int length, __u8 *buffer)
605{
606 int status;
607
608 if (serial->product_info.TiMode == TI_MODE_DOWNLOAD) {
609 status = read_download_mem(serial->serial->dev,
610 start_address,
611 length,
612 serial->TI_I2C_Type,
613 buffer);
614 } else {
615 status = read_boot_mem(serial, start_address, length,
616 buffer);
617 }
618 return status;
619}
620
621static int write_rom(struct edgeport_serial *serial, int start_address,
622 int length, __u8 *buffer)
623{
624 if (serial->product_info.TiMode == TI_MODE_BOOT)
625 return write_boot_mem(serial, start_address, length,
626 buffer);
627
628 if (serial->product_info.TiMode == TI_MODE_DOWNLOAD)
629 return write_i2c_mem(serial, start_address, length,
630 serial->TI_I2C_Type, buffer);
631 return -EINVAL;
632}
633
634/* Read a descriptor header from I2C based on type */
635static int get_descriptor_addr(struct edgeport_serial *serial,
636 int desc_type, struct ti_i2c_desc *rom_desc)
637{
638 int start_address;
639 int status;
640
641 /* Search for requested descriptor in I2C */
642 start_address = 2;
643 do {
644 status = read_rom(serial,
645 start_address,
646 sizeof(struct ti_i2c_desc),
647 (__u8 *)rom_desc);
648 if (status)
649 return 0;
650
651 if (rom_desc->Type == desc_type)
652 return start_address;
653
654 start_address = start_address + sizeof(struct ti_i2c_desc) +
655 le16_to_cpu(rom_desc->Size);
656
657 } while ((start_address < TI_MAX_I2C_SIZE) && rom_desc->Type);
658
659 return 0;
660}
661
662/* Validate descriptor checksum */
663static int valid_csum(struct ti_i2c_desc *rom_desc, __u8 *buffer)
664{
665 __u16 i;
666 __u8 cs = 0;
667
668 for (i = 0; i < le16_to_cpu(rom_desc->Size); i++)
669 cs = (__u8)(cs + buffer[i]);
670
671 if (cs != rom_desc->CheckSum) {
672 pr_debug("%s - Mismatch %x - %x", __func__, rom_desc->CheckSum, cs);
673 return -EINVAL;
674 }
675 return 0;
676}
677
678/* Make sure that the I2C image is good */
679static int check_i2c_image(struct edgeport_serial *serial)
680{
681 struct device *dev = &serial->serial->dev->dev;
682 int status = 0;
683 struct ti_i2c_desc *rom_desc;
684 int start_address = 2;
685 __u8 *buffer;
686 __u16 ttype;
687
688 rom_desc = kmalloc(sizeof(*rom_desc), GFP_KERNEL);
689 if (!rom_desc)
690 return -ENOMEM;
691
692 buffer = kmalloc(TI_MAX_I2C_SIZE, GFP_KERNEL);
693 if (!buffer) {
694 kfree(rom_desc);
695 return -ENOMEM;
696 }
697
698 /* Read the first byte (Signature0) must be 0x52 or 0x10 */
699 status = read_rom(serial, 0, 1, buffer);
700 if (status)
701 goto out;
702
703 if (*buffer != UMP5152 && *buffer != UMP3410) {
704 dev_err(dev, "%s - invalid buffer signature\n", __func__);
705 status = -ENODEV;
706 goto out;
707 }
708
709 do {
710 /* Validate the I2C */
711 status = read_rom(serial,
712 start_address,
713 sizeof(struct ti_i2c_desc),
714 (__u8 *)rom_desc);
715 if (status)
716 break;
717
718 if ((start_address + sizeof(struct ti_i2c_desc) +
719 le16_to_cpu(rom_desc->Size)) > TI_MAX_I2C_SIZE) {
720 status = -ENODEV;
721 dev_dbg(dev, "%s - structure too big, erroring out.\n", __func__);
722 break;
723 }
724
725 dev_dbg(dev, "%s Type = 0x%x\n", __func__, rom_desc->Type);
726
727 /* Skip type 2 record */
728 ttype = rom_desc->Type & 0x0f;
729 if (ttype != I2C_DESC_TYPE_FIRMWARE_BASIC
730 && ttype != I2C_DESC_TYPE_FIRMWARE_AUTO) {
731 /* Read the descriptor data */
732 status = read_rom(serial, start_address +
733 sizeof(struct ti_i2c_desc),
734 le16_to_cpu(rom_desc->Size),
735 buffer);
736 if (status)
737 break;
738
739 status = valid_csum(rom_desc, buffer);
740 if (status)
741 break;
742 }
743 start_address = start_address + sizeof(struct ti_i2c_desc) +
744 le16_to_cpu(rom_desc->Size);
745
746 } while ((rom_desc->Type != I2C_DESC_TYPE_ION) &&
747 (start_address < TI_MAX_I2C_SIZE));
748
749 if ((rom_desc->Type != I2C_DESC_TYPE_ION) ||
750 (start_address > TI_MAX_I2C_SIZE))
751 status = -ENODEV;
752
753out:
754 kfree(buffer);
755 kfree(rom_desc);
756 return status;
757}
758
759static int get_manuf_info(struct edgeport_serial *serial, __u8 *buffer)
760{
761 int status;
762 int start_address;
763 struct ti_i2c_desc *rom_desc;
764 struct edge_ti_manuf_descriptor *desc;
765 struct device *dev = &serial->serial->dev->dev;
766
767 rom_desc = kmalloc(sizeof(*rom_desc), GFP_KERNEL);
768 if (!rom_desc)
769 return -ENOMEM;
770
771 start_address = get_descriptor_addr(serial, I2C_DESC_TYPE_ION,
772 rom_desc);
773
774 if (!start_address) {
775 dev_dbg(dev, "%s - Edge Descriptor not found in I2C\n", __func__);
776 status = -ENODEV;
777 goto exit;
778 }
779
780 /* Read the descriptor data */
781 status = read_rom(serial, start_address+sizeof(struct ti_i2c_desc),
782 le16_to_cpu(rom_desc->Size), buffer);
783 if (status)
784 goto exit;
785
786 status = valid_csum(rom_desc, buffer);
787
788 desc = (struct edge_ti_manuf_descriptor *)buffer;
789 dev_dbg(dev, "%s - IonConfig 0x%x\n", __func__, desc->IonConfig);
790 dev_dbg(dev, "%s - Version %d\n", __func__, desc->Version);
791 dev_dbg(dev, "%s - Cpu/Board 0x%x\n", __func__, desc->CpuRev_BoardRev);
792 dev_dbg(dev, "%s - NumPorts %d\n", __func__, desc->NumPorts);
793 dev_dbg(dev, "%s - NumVirtualPorts %d\n", __func__, desc->NumVirtualPorts);
794 dev_dbg(dev, "%s - TotalPorts %d\n", __func__, desc->TotalPorts);
795
796exit:
797 kfree(rom_desc);
798 return status;
799}
800
801/* Build firmware header used for firmware update */
802static int build_i2c_fw_hdr(u8 *header, const struct firmware *fw)
803{
804 __u8 *buffer;
805 int buffer_size;
806 int i;
807 __u8 cs = 0;
808 struct ti_i2c_desc *i2c_header;
809 struct ti_i2c_image_header *img_header;
810 struct ti_i2c_firmware_rec *firmware_rec;
811 struct edgeport_fw_hdr *fw_hdr = (struct edgeport_fw_hdr *)fw->data;
812
813 /*
814 * In order to update the I2C firmware we must change the type 2 record
815 * to type 0xF2. This will force the UMP to come up in Boot Mode.
816 * Then while in boot mode, the driver will download the latest
817 * firmware (padded to 15.5k) into the UMP ram. And finally when the
818 * device comes back up in download mode the driver will cause the new
819 * firmware to be copied from the UMP Ram to I2C and the firmware will
820 * update the record type from 0xf2 to 0x02.
821 */
822
823 /*
824 * Allocate a 15.5k buffer + 2 bytes for version number (Firmware
825 * Record)
826 */
827 buffer_size = (((1024 * 16) - 512 ) +
828 sizeof(struct ti_i2c_firmware_rec));
829
830 buffer = kmalloc(buffer_size, GFP_KERNEL);
831 if (!buffer)
832 return -ENOMEM;
833
834 /* Set entire image of 0xffs */
835 memset(buffer, 0xff, buffer_size);
836
837 /* Copy version number into firmware record */
838 firmware_rec = (struct ti_i2c_firmware_rec *)buffer;
839
840 firmware_rec->Ver_Major = fw_hdr->major_version;
841 firmware_rec->Ver_Minor = fw_hdr->minor_version;
842
843 /* Pointer to fw_down memory image */
844 img_header = (struct ti_i2c_image_header *)&fw->data[4];
845
846 memcpy(buffer + sizeof(struct ti_i2c_firmware_rec),
847 &fw->data[4 + sizeof(struct ti_i2c_image_header)],
848 le16_to_cpu(img_header->Length));
849
850 for (i=0; i < buffer_size; i++) {
851 cs = (__u8)(cs + buffer[i]);
852 }
853
854 kfree(buffer);
855
856 /* Build new header */
857 i2c_header = (struct ti_i2c_desc *)header;
858 firmware_rec = (struct ti_i2c_firmware_rec*)i2c_header->Data;
859
860 i2c_header->Type = I2C_DESC_TYPE_FIRMWARE_BLANK;
861 i2c_header->Size = cpu_to_le16(buffer_size);
862 i2c_header->CheckSum = cs;
863 firmware_rec->Ver_Major = fw_hdr->major_version;
864 firmware_rec->Ver_Minor = fw_hdr->minor_version;
865
866 return 0;
867}
868
869/* Try to figure out what type of I2c we have */
870static int i2c_type_bootmode(struct edgeport_serial *serial)
871{
872 struct device *dev = &serial->serial->dev->dev;
873 int status;
874 u8 *data;
875
876 data = kmalloc(1, GFP_KERNEL);
877 if (!data)
878 return -ENOMEM;
879
880 /* Try to read type 2 */
881 status = ti_vread_sync(serial->serial->dev, UMPC_MEMORY_READ,
882 DTK_ADDR_SPACE_I2C_TYPE_II, 0, data, 0x01);
883 if (status)
884 dev_dbg(dev, "%s - read 2 status error = %d\n", __func__, status);
885 else
886 dev_dbg(dev, "%s - read 2 data = 0x%x\n", __func__, *data);
887 if ((!status) && (*data == UMP5152 || *data == UMP3410)) {
888 dev_dbg(dev, "%s - ROM_TYPE_II\n", __func__);
889 serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_II;
890 goto out;
891 }
892
893 /* Try to read type 3 */
894 status = ti_vread_sync(serial->serial->dev, UMPC_MEMORY_READ,
895 DTK_ADDR_SPACE_I2C_TYPE_III, 0, data, 0x01);
896 if (status)
897 dev_dbg(dev, "%s - read 3 status error = %d\n", __func__, status);
898 else
899 dev_dbg(dev, "%s - read 2 data = 0x%x\n", __func__, *data);
900 if ((!status) && (*data == UMP5152 || *data == UMP3410)) {
901 dev_dbg(dev, "%s - ROM_TYPE_III\n", __func__);
902 serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_III;
903 goto out;
904 }
905
906 dev_dbg(dev, "%s - Unknown\n", __func__);
907 serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_II;
908 status = -ENODEV;
909out:
910 kfree(data);
911 return status;
912}
913
914static int bulk_xfer(struct usb_serial *serial, void *buffer,
915 int length, int *num_sent)
916{
917 int status;
918
919 status = usb_bulk_msg(serial->dev,
920 usb_sndbulkpipe(serial->dev,
921 serial->port[0]->bulk_out_endpointAddress),
922 buffer, length, num_sent, 1000);
923 return status;
924}
925
926/* Download given firmware image to the device (IN BOOT MODE) */
927static int download_code(struct edgeport_serial *serial, __u8 *image,
928 int image_length)
929{
930 int status = 0;
931 int pos;
932 int transfer;
933 int done;
934
935 /* Transfer firmware image */
936 for (pos = 0; pos < image_length; ) {
937 /* Read the next buffer from file */
938 transfer = image_length - pos;
939 if (transfer > EDGE_FW_BULK_MAX_PACKET_SIZE)
940 transfer = EDGE_FW_BULK_MAX_PACKET_SIZE;
941
942 /* Transfer data */
943 status = bulk_xfer(serial->serial, &image[pos],
944 transfer, &done);
945 if (status)
946 break;
947 /* Advance buffer pointer */
948 pos += done;
949 }
950
951 return status;
952}
953
954/* FIXME!!! */
955static int config_boot_dev(struct usb_device *dev)
956{
957 return 0;
958}
959
960static int ti_cpu_rev(struct edge_ti_manuf_descriptor *desc)
961{
962 return TI_GET_CPU_REVISION(desc->CpuRev_BoardRev);
963}
964
965static int check_fw_sanity(struct edgeport_serial *serial,
966 const struct firmware *fw)
967{
968 u16 length_total;
969 u8 checksum = 0;
970 int pos;
971 struct device *dev = &serial->serial->interface->dev;
972 struct edgeport_fw_hdr *fw_hdr = (struct edgeport_fw_hdr *)fw->data;
973
974 if (fw->size < sizeof(struct edgeport_fw_hdr)) {
975 dev_err(dev, "incomplete fw header\n");
976 return -EINVAL;
977 }
978
979 length_total = le16_to_cpu(fw_hdr->length) +
980 sizeof(struct edgeport_fw_hdr);
981
982 if (fw->size != length_total) {
983 dev_err(dev, "bad fw size (expected: %u, got: %zu)\n",
984 length_total, fw->size);
985 return -EINVAL;
986 }
987
988 for (pos = sizeof(struct edgeport_fw_hdr); pos < fw->size; ++pos)
989 checksum += fw->data[pos];
990
991 if (checksum != fw_hdr->checksum) {
992 dev_err(dev, "bad fw checksum (expected: 0x%x, got: 0x%x)\n",
993 fw_hdr->checksum, checksum);
994 return -EINVAL;
995 }
996
997 return 0;
998}
999
1000/*
1001 * DownloadTIFirmware - Download run-time operating firmware to the TI5052
1002 *
1003 * This routine downloads the main operating code into the TI5052, using the
1004 * boot code already burned into E2PROM or ROM.
1005 */
1006static int download_fw(struct edgeport_serial *serial)
1007{
1008 struct device *dev = &serial->serial->interface->dev;
1009 int status = 0;
1010 struct usb_interface_descriptor *interface;
1011 const struct firmware *fw;
1012 const char *fw_name = "edgeport/down3.bin";
1013 struct edgeport_fw_hdr *fw_hdr;
1014
1015 status = request_firmware(&fw, fw_name, dev);
1016 if (status) {
1017 dev_err(dev, "Failed to load image \"%s\" err %d\n",
1018 fw_name, status);
1019 return status;
1020 }
1021
1022 if (check_fw_sanity(serial, fw)) {
1023 status = -EINVAL;
1024 goto out;
1025 }
1026
1027 fw_hdr = (struct edgeport_fw_hdr *)fw->data;
1028
1029 /* If on-board version is newer, "fw_version" will be updated later. */
1030 serial->fw_version = (fw_hdr->major_version << 8) +
1031 fw_hdr->minor_version;
1032
1033 /*
1034 * This routine is entered by both the BOOT mode and the Download mode
1035 * We can determine which code is running by the reading the config
1036 * descriptor and if we have only one bulk pipe it is in boot mode
1037 */
1038 serial->product_info.hardware_type = HARDWARE_TYPE_TIUMP;
1039
1040 /* Default to type 2 i2c */
1041 serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_II;
1042
1043 status = choose_config(serial->serial->dev);
1044 if (status)
1045 goto out;
1046
1047 interface = &serial->serial->interface->cur_altsetting->desc;
1048 if (!interface) {
1049 dev_err(dev, "%s - no interface set, error!\n", __func__);
1050 status = -ENODEV;
1051 goto out;
1052 }
1053
1054 /*
1055 * Setup initial mode -- the default mode 0 is TI_MODE_CONFIGURING
1056 * if we have more than one endpoint we are definitely in download
1057 * mode
1058 */
1059 if (interface->bNumEndpoints > 1) {
1060 serial->product_info.TiMode = TI_MODE_DOWNLOAD;
1061 status = do_download_mode(serial, fw);
1062 } else {
1063 /* Otherwise we will remain in configuring mode */
1064 serial->product_info.TiMode = TI_MODE_CONFIGURING;
1065 status = do_boot_mode(serial, fw);
1066 }
1067
1068out:
1069 release_firmware(fw);
1070 return status;
1071}
1072
1073static int do_download_mode(struct edgeport_serial *serial,
1074 const struct firmware *fw)
1075{
1076 struct device *dev = &serial->serial->interface->dev;
1077 int status = 0;
1078 int start_address;
1079 struct edge_ti_manuf_descriptor *ti_manuf_desc;
1080 int download_cur_ver;
1081 int download_new_ver;
1082 struct edgeport_fw_hdr *fw_hdr = (struct edgeport_fw_hdr *)fw->data;
1083 struct ti_i2c_desc *rom_desc;
1084
1085 dev_dbg(dev, "%s - RUNNING IN DOWNLOAD MODE\n", __func__);
1086
1087 status = check_i2c_image(serial);
1088 if (status) {
1089 dev_dbg(dev, "%s - DOWNLOAD MODE -- BAD I2C\n", __func__);
1090 return status;
1091 }
1092
1093 /*
1094 * Validate Hardware version number
1095 * Read Manufacturing Descriptor from TI Based Edgeport
1096 */
1097 ti_manuf_desc = kmalloc(sizeof(*ti_manuf_desc), GFP_KERNEL);
1098 if (!ti_manuf_desc)
1099 return -ENOMEM;
1100
1101 status = get_manuf_info(serial, (__u8 *)ti_manuf_desc);
1102 if (status) {
1103 kfree(ti_manuf_desc);
1104 return status;
1105 }
1106
1107 /* Check version number of ION descriptor */
1108 if (!ignore_cpu_rev && ti_cpu_rev(ti_manuf_desc) < 2) {
1109 dev_dbg(dev, "%s - Wrong CPU Rev %d (Must be 2)\n",
1110 __func__, ti_cpu_rev(ti_manuf_desc));
1111 kfree(ti_manuf_desc);
1112 return -EINVAL;
1113 }
1114
1115 rom_desc = kmalloc(sizeof(*rom_desc), GFP_KERNEL);
1116 if (!rom_desc) {
1117 kfree(ti_manuf_desc);
1118 return -ENOMEM;
1119 }
1120
1121 /* Search for type 2 record (firmware record) */
1122 start_address = get_descriptor_addr(serial,
1123 I2C_DESC_TYPE_FIRMWARE_BASIC, rom_desc);
1124 if (start_address != 0) {
1125 struct ti_i2c_firmware_rec *firmware_version;
1126 u8 *record;
1127
1128 dev_dbg(dev, "%s - Found Type FIRMWARE (Type 2) record\n",
1129 __func__);
1130
1131 firmware_version = kmalloc(sizeof(*firmware_version),
1132 GFP_KERNEL);
1133 if (!firmware_version) {
1134 kfree(rom_desc);
1135 kfree(ti_manuf_desc);
1136 return -ENOMEM;
1137 }
1138
1139 /*
1140 * Validate version number
1141 * Read the descriptor data
1142 */
1143 status = read_rom(serial, start_address +
1144 sizeof(struct ti_i2c_desc),
1145 sizeof(struct ti_i2c_firmware_rec),
1146 (__u8 *)firmware_version);
1147 if (status) {
1148 kfree(firmware_version);
1149 kfree(rom_desc);
1150 kfree(ti_manuf_desc);
1151 return status;
1152 }
1153
1154 /*
1155 * Check version number of download with current
1156 * version in I2c
1157 */
1158 download_cur_ver = (firmware_version->Ver_Major << 8) +
1159 (firmware_version->Ver_Minor);
1160 download_new_ver = (fw_hdr->major_version << 8) +
1161 (fw_hdr->minor_version);
1162
1163 dev_dbg(dev, "%s - >> FW Versions Device %d.%d Driver %d.%d\n",
1164 __func__, firmware_version->Ver_Major,
1165 firmware_version->Ver_Minor,
1166 fw_hdr->major_version, fw_hdr->minor_version);
1167
1168 /*
1169 * Check if we have an old version in the I2C and
1170 * update if necessary
1171 */
1172 if (download_cur_ver < download_new_ver) {
1173 dev_dbg(dev, "%s - Update I2C dld from %d.%d to %d.%d\n",
1174 __func__,
1175 firmware_version->Ver_Major,
1176 firmware_version->Ver_Minor,
1177 fw_hdr->major_version,
1178 fw_hdr->minor_version);
1179
1180 record = kmalloc(1, GFP_KERNEL);
1181 if (!record) {
1182 kfree(firmware_version);
1183 kfree(rom_desc);
1184 kfree(ti_manuf_desc);
1185 return -ENOMEM;
1186 }
1187 /*
1188 * In order to update the I2C firmware we must
1189 * change the type 2 record to type 0xF2. This
1190 * will force the UMP to come up in Boot Mode.
1191 * Then while in boot mode, the driver will
1192 * download the latest firmware (padded to
1193 * 15.5k) into the UMP ram. Finally when the
1194 * device comes back up in download mode the
1195 * driver will cause the new firmware to be
1196 * copied from the UMP Ram to I2C and the
1197 * firmware will update the record type from
1198 * 0xf2 to 0x02.
1199 */
1200 *record = I2C_DESC_TYPE_FIRMWARE_BLANK;
1201
1202 /*
1203 * Change the I2C Firmware record type to
1204 * 0xf2 to trigger an update
1205 */
1206 status = write_rom(serial, start_address,
1207 sizeof(*record), record);
1208 if (status) {
1209 kfree(record);
1210 kfree(firmware_version);
1211 kfree(rom_desc);
1212 kfree(ti_manuf_desc);
1213 return status;
1214 }
1215
1216 /*
1217 * verify the write -- must do this in order
1218 * for write to complete before we do the
1219 * hardware reset
1220 */
1221 status = read_rom(serial,
1222 start_address,
1223 sizeof(*record),
1224 record);
1225 if (status) {
1226 kfree(record);
1227 kfree(firmware_version);
1228 kfree(rom_desc);
1229 kfree(ti_manuf_desc);
1230 return status;
1231 }
1232
1233 if (*record != I2C_DESC_TYPE_FIRMWARE_BLANK) {
1234 dev_err(dev, "%s - error resetting device\n",
1235 __func__);
1236 kfree(record);
1237 kfree(firmware_version);
1238 kfree(rom_desc);
1239 kfree(ti_manuf_desc);
1240 return -ENODEV;
1241 }
1242
1243 dev_dbg(dev, "%s - HARDWARE RESET\n", __func__);
1244
1245 /* Reset UMP -- Back to BOOT MODE */
1246 status = ti_vsend_sync(serial->serial->dev,
1247 UMPC_HARDWARE_RESET,
1248 0, 0, NULL, 0,
1249 TI_VSEND_TIMEOUT_DEFAULT);
1250
1251 dev_dbg(dev, "%s - HARDWARE RESET return %d\n",
1252 __func__, status);
1253
1254 /* return an error on purpose. */
1255 kfree(record);
1256 kfree(firmware_version);
1257 kfree(rom_desc);
1258 kfree(ti_manuf_desc);
1259 return -ENODEV;
1260 }
1261 /* Same or newer fw version is already loaded */
1262 serial->fw_version = download_cur_ver;
1263 kfree(firmware_version);
1264 }
1265 /* Search for type 0xF2 record (firmware blank record) */
1266 else {
1267 start_address = get_descriptor_addr(serial,
1268 I2C_DESC_TYPE_FIRMWARE_BLANK, rom_desc);
1269 if (start_address != 0) {
1270#define HEADER_SIZE (sizeof(struct ti_i2c_desc) + \
1271 sizeof(struct ti_i2c_firmware_rec))
1272 __u8 *header;
1273 __u8 *vheader;
1274
1275 header = kmalloc(HEADER_SIZE, GFP_KERNEL);
1276 if (!header) {
1277 kfree(rom_desc);
1278 kfree(ti_manuf_desc);
1279 return -ENOMEM;
1280 }
1281
1282 vheader = kmalloc(HEADER_SIZE, GFP_KERNEL);
1283 if (!vheader) {
1284 kfree(header);
1285 kfree(rom_desc);
1286 kfree(ti_manuf_desc);
1287 return -ENOMEM;
1288 }
1289
1290 dev_dbg(dev, "%s - Found Type BLANK FIRMWARE (Type F2) record\n",
1291 __func__);
1292
1293 /*
1294 * In order to update the I2C firmware we must change
1295 * the type 2 record to type 0xF2. This will force the
1296 * UMP to come up in Boot Mode. Then while in boot
1297 * mode, the driver will download the latest firmware
1298 * (padded to 15.5k) into the UMP ram. Finally when the
1299 * device comes back up in download mode the driver
1300 * will cause the new firmware to be copied from the
1301 * UMP Ram to I2C and the firmware will update the
1302 * record type from 0xf2 to 0x02.
1303 */
1304 status = build_i2c_fw_hdr(header, fw);
1305 if (status) {
1306 kfree(vheader);
1307 kfree(header);
1308 kfree(rom_desc);
1309 kfree(ti_manuf_desc);
1310 return -EINVAL;
1311 }
1312
1313 /*
1314 * Update I2C with type 0xf2 record with correct
1315 * size and checksum
1316 */
1317 status = write_rom(serial,
1318 start_address,
1319 HEADER_SIZE,
1320 header);
1321 if (status) {
1322 kfree(vheader);
1323 kfree(header);
1324 kfree(rom_desc);
1325 kfree(ti_manuf_desc);
1326 return -EINVAL;
1327 }
1328
1329 /*
1330 * verify the write -- must do this in order for
1331 * write to complete before we do the hardware reset
1332 */
1333 status = read_rom(serial, start_address,
1334 HEADER_SIZE, vheader);
1335
1336 if (status) {
1337 dev_dbg(dev, "%s - can't read header back\n",
1338 __func__);
1339 kfree(vheader);
1340 kfree(header);
1341 kfree(rom_desc);
1342 kfree(ti_manuf_desc);
1343 return status;
1344 }
1345 if (memcmp(vheader, header, HEADER_SIZE)) {
1346 dev_dbg(dev, "%s - write download record failed\n",
1347 __func__);
1348 kfree(vheader);
1349 kfree(header);
1350 kfree(rom_desc);
1351 kfree(ti_manuf_desc);
1352 return -EINVAL;
1353 }
1354
1355 kfree(vheader);
1356 kfree(header);
1357
1358 dev_dbg(dev, "%s - Start firmware update\n", __func__);
1359
1360 /* Tell firmware to copy download image into I2C */
1361 status = ti_vsend_sync(serial->serial->dev,
1362 UMPC_COPY_DNLD_TO_I2C,
1363 0, 0, NULL, 0,
1364 TI_VSEND_TIMEOUT_FW_DOWNLOAD);
1365
1366 dev_dbg(dev, "%s - Update complete 0x%x\n", __func__,
1367 status);
1368 if (status) {
1369 dev_err(dev,
1370 "%s - UMPC_COPY_DNLD_TO_I2C failed\n",
1371 __func__);
1372 kfree(rom_desc);
1373 kfree(ti_manuf_desc);
1374 return status;
1375 }
1376 }
1377 }
1378
1379 /* The device is running the download code */
1380 kfree(rom_desc);
1381 kfree(ti_manuf_desc);
1382 return 0;
1383}
1384
1385static int do_boot_mode(struct edgeport_serial *serial,
1386 const struct firmware *fw)
1387{
1388 struct device *dev = &serial->serial->interface->dev;
1389 int status = 0;
1390 struct edge_ti_manuf_descriptor *ti_manuf_desc;
1391 struct edgeport_fw_hdr *fw_hdr = (struct edgeport_fw_hdr *)fw->data;
1392
1393 dev_dbg(dev, "%s - RUNNING IN BOOT MODE\n", __func__);
1394
1395 /* Configure the TI device so we can use the BULK pipes for download */
1396 status = config_boot_dev(serial->serial->dev);
1397 if (status)
1398 return status;
1399
1400 if (le16_to_cpu(serial->serial->dev->descriptor.idVendor)
1401 != USB_VENDOR_ID_ION) {
1402 dev_dbg(dev, "%s - VID = 0x%x\n", __func__,
1403 le16_to_cpu(serial->serial->dev->descriptor.idVendor));
1404 serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_II;
1405 goto stayinbootmode;
1406 }
1407
1408 /*
1409 * We have an ION device (I2c Must be programmed)
1410 * Determine I2C image type
1411 */
1412 if (i2c_type_bootmode(serial))
1413 goto stayinbootmode;
1414
1415 /* Check for ION Vendor ID and that the I2C is valid */
1416 if (!check_i2c_image(serial)) {
1417 struct ti_i2c_image_header *header;
1418 int i;
1419 __u8 cs = 0;
1420 __u8 *buffer;
1421 int buffer_size;
1422
1423 /*
1424 * Validate Hardware version number
1425 * Read Manufacturing Descriptor from TI Based Edgeport
1426 */
1427 ti_manuf_desc = kmalloc(sizeof(*ti_manuf_desc), GFP_KERNEL);
1428 if (!ti_manuf_desc)
1429 return -ENOMEM;
1430
1431 status = get_manuf_info(serial, (__u8 *)ti_manuf_desc);
1432 if (status) {
1433 kfree(ti_manuf_desc);
1434 goto stayinbootmode;
1435 }
1436
1437 /* Check for version 2 */
1438 if (!ignore_cpu_rev && ti_cpu_rev(ti_manuf_desc) < 2) {
1439 dev_dbg(dev, "%s - Wrong CPU Rev %d (Must be 2)\n",
1440 __func__, ti_cpu_rev(ti_manuf_desc));
1441 kfree(ti_manuf_desc);
1442 goto stayinbootmode;
1443 }
1444
1445 kfree(ti_manuf_desc);
1446
1447 /*
1448 * In order to update the I2C firmware we must change the type
1449 * 2 record to type 0xF2. This will force the UMP to come up
1450 * in Boot Mode. Then while in boot mode, the driver will
1451 * download the latest firmware (padded to 15.5k) into the
1452 * UMP ram. Finally when the device comes back up in download
1453 * mode the driver will cause the new firmware to be copied
1454 * from the UMP Ram to I2C and the firmware will update the
1455 * record type from 0xf2 to 0x02.
1456 *
1457 * Do we really have to copy the whole firmware image,
1458 * or could we do this in place!
1459 */
1460
1461 /* Allocate a 15.5k buffer + 3 byte header */
1462 buffer_size = (((1024 * 16) - 512) +
1463 sizeof(struct ti_i2c_image_header));
1464 buffer = kmalloc(buffer_size, GFP_KERNEL);
1465 if (!buffer)
1466 return -ENOMEM;
1467
1468 /* Initialize the buffer to 0xff (pad the buffer) */
1469 memset(buffer, 0xff, buffer_size);
1470 memcpy(buffer, &fw->data[4], fw->size - 4);
1471
1472 for (i = sizeof(struct ti_i2c_image_header);
1473 i < buffer_size; i++) {
1474 cs = (__u8)(cs + buffer[i]);
1475 }
1476
1477 header = (struct ti_i2c_image_header *)buffer;
1478
1479 /* update length and checksum after padding */
1480 header->Length = cpu_to_le16((__u16)(buffer_size -
1481 sizeof(struct ti_i2c_image_header)));
1482 header->CheckSum = cs;
1483
1484 /* Download the operational code */
1485 dev_dbg(dev, "%s - Downloading operational code image version %d.%d (TI UMP)\n",
1486 __func__,
1487 fw_hdr->major_version, fw_hdr->minor_version);
1488 status = download_code(serial, buffer, buffer_size);
1489
1490 kfree(buffer);
1491
1492 if (status) {
1493 dev_dbg(dev, "%s - Error downloading operational code image\n", __func__);
1494 return status;
1495 }
1496
1497 /* Device will reboot */
1498 serial->product_info.TiMode = TI_MODE_TRANSITIONING;
1499
1500 dev_dbg(dev, "%s - Download successful -- Device rebooting...\n", __func__);
1501
1502 /* return an error on purpose */
1503 return -ENODEV;
1504 }
1505
1506stayinbootmode:
1507 /* Eprom is invalid or blank stay in boot mode */
1508 dev_dbg(dev, "%s - STAYING IN BOOT MODE\n", __func__);
1509 serial->product_info.TiMode = TI_MODE_BOOT;
1510
1511 return 0;
1512}
1513
1514static int ti_do_config(struct edgeport_port *port, int feature, int on)
1515{
1516 int port_number = port->port->port_number;
1517
1518 on = !!on; /* 1 or 0 not bitmask */
1519 return send_cmd(port->port->serial->dev,
1520 feature, (__u8)(UMPM_UART1_PORT + port_number),
1521 on, NULL, 0);
1522}
1523
1524static int restore_mcr(struct edgeport_port *port, __u8 mcr)
1525{
1526 int status = 0;
1527
1528 dev_dbg(&port->port->dev, "%s - %x\n", __func__, mcr);
1529
1530 status = ti_do_config(port, UMPC_SET_CLR_DTR, mcr & MCR_DTR);
1531 if (status)
1532 return status;
1533 status = ti_do_config(port, UMPC_SET_CLR_RTS, mcr & MCR_RTS);
1534 if (status)
1535 return status;
1536 return ti_do_config(port, UMPC_SET_CLR_LOOPBACK, mcr & MCR_LOOPBACK);
1537}
1538
1539/* Convert TI LSR to standard UART flags */
1540static __u8 map_line_status(__u8 ti_lsr)
1541{
1542 __u8 lsr = 0;
1543
1544#define MAP_FLAG(flagUmp, flagUart) \
1545 if (ti_lsr & flagUmp) \
1546 lsr |= flagUart;
1547
1548 MAP_FLAG(UMP_UART_LSR_OV_MASK, LSR_OVER_ERR) /* overrun */
1549 MAP_FLAG(UMP_UART_LSR_PE_MASK, LSR_PAR_ERR) /* parity error */
1550 MAP_FLAG(UMP_UART_LSR_FE_MASK, LSR_FRM_ERR) /* framing error */
1551 MAP_FLAG(UMP_UART_LSR_BR_MASK, LSR_BREAK) /* break detected */
1552 MAP_FLAG(UMP_UART_LSR_RX_MASK, LSR_RX_AVAIL) /* rx data available */
1553 MAP_FLAG(UMP_UART_LSR_TX_MASK, LSR_TX_EMPTY) /* tx hold reg empty */
1554
1555#undef MAP_FLAG
1556
1557 return lsr;
1558}
1559
1560static void handle_new_msr(struct edgeport_port *edge_port, __u8 msr)
1561{
1562 struct async_icount *icount;
1563 struct tty_struct *tty;
1564
1565 dev_dbg(&edge_port->port->dev, "%s - %02x\n", __func__, msr);
1566
1567 if (msr & (EDGEPORT_MSR_DELTA_CTS | EDGEPORT_MSR_DELTA_DSR |
1568 EDGEPORT_MSR_DELTA_RI | EDGEPORT_MSR_DELTA_CD)) {
1569 icount = &edge_port->port->icount;
1570
1571 /* update input line counters */
1572 if (msr & EDGEPORT_MSR_DELTA_CTS)
1573 icount->cts++;
1574 if (msr & EDGEPORT_MSR_DELTA_DSR)
1575 icount->dsr++;
1576 if (msr & EDGEPORT_MSR_DELTA_CD)
1577 icount->dcd++;
1578 if (msr & EDGEPORT_MSR_DELTA_RI)
1579 icount->rng++;
1580 wake_up_interruptible(&edge_port->port->port.delta_msr_wait);
1581 }
1582
1583 /* Save the new modem status */
1584 edge_port->shadow_msr = msr & 0xf0;
1585
1586 tty = tty_port_tty_get(&edge_port->port->port);
1587 /* handle CTS flow control */
1588 if (tty && C_CRTSCTS(tty)) {
1589 if (msr & EDGEPORT_MSR_CTS)
1590 tty_wakeup(tty);
1591 }
1592 tty_kref_put(tty);
1593}
1594
1595static void handle_new_lsr(struct edgeport_port *edge_port, int lsr_data,
1596 __u8 lsr, __u8 data)
1597{
1598 struct async_icount *icount;
1599 __u8 new_lsr = (__u8)(lsr & (__u8)(LSR_OVER_ERR | LSR_PAR_ERR |
1600 LSR_FRM_ERR | LSR_BREAK));
1601
1602 dev_dbg(&edge_port->port->dev, "%s - %02x\n", __func__, new_lsr);
1603
1604 edge_port->shadow_lsr = lsr;
1605
1606 if (new_lsr & LSR_BREAK)
1607 /*
1608 * Parity and Framing errors only count if they
1609 * occur exclusive of a break being received.
1610 */
1611 new_lsr &= (__u8)(LSR_OVER_ERR | LSR_BREAK);
1612
1613 /* Place LSR data byte into Rx buffer */
1614 if (lsr_data)
1615 edge_tty_recv(edge_port->port, &data, 1);
1616
1617 /* update input line counters */
1618 icount = &edge_port->port->icount;
1619 if (new_lsr & LSR_BREAK)
1620 icount->brk++;
1621 if (new_lsr & LSR_OVER_ERR)
1622 icount->overrun++;
1623 if (new_lsr & LSR_PAR_ERR)
1624 icount->parity++;
1625 if (new_lsr & LSR_FRM_ERR)
1626 icount->frame++;
1627}
1628
1629static void edge_interrupt_callback(struct urb *urb)
1630{
1631 struct edgeport_serial *edge_serial = urb->context;
1632 struct usb_serial_port *port;
1633 struct edgeport_port *edge_port;
1634 struct device *dev;
1635 unsigned char *data = urb->transfer_buffer;
1636 int length = urb->actual_length;
1637 int port_number;
1638 int function;
1639 int retval;
1640 __u8 lsr;
1641 __u8 msr;
1642 int status = urb->status;
1643
1644 switch (status) {
1645 case 0:
1646 /* success */
1647 break;
1648 case -ECONNRESET:
1649 case -ENOENT:
1650 case -ESHUTDOWN:
1651 /* this urb is terminated, clean up */
1652 dev_dbg(&urb->dev->dev, "%s - urb shutting down with status: %d\n",
1653 __func__, status);
1654 return;
1655 default:
1656 dev_err(&urb->dev->dev, "%s - nonzero urb status received: "
1657 "%d\n", __func__, status);
1658 goto exit;
1659 }
1660
1661 if (!length) {
1662 dev_dbg(&urb->dev->dev, "%s - no data in urb\n", __func__);
1663 goto exit;
1664 }
1665
1666 dev = &edge_serial->serial->dev->dev;
1667 usb_serial_debug_data(dev, __func__, length, data);
1668
1669 if (length != 2) {
1670 dev_dbg(dev, "%s - expecting packet of size 2, got %d\n", __func__, length);
1671 goto exit;
1672 }
1673
1674 port_number = TIUMP_GET_PORT_FROM_CODE(data[0]);
1675 function = TIUMP_GET_FUNC_FROM_CODE(data[0]);
1676 dev_dbg(dev, "%s - port_number %d, function %d, info 0x%x\n", __func__,
1677 port_number, function, data[1]);
1678 port = edge_serial->serial->port[port_number];
1679 edge_port = usb_get_serial_port_data(port);
1680 if (!edge_port) {
1681 dev_dbg(dev, "%s - edge_port not found\n", __func__);
1682 return;
1683 }
1684 switch (function) {
1685 case TIUMP_INTERRUPT_CODE_LSR:
1686 lsr = map_line_status(data[1]);
1687 if (lsr & UMP_UART_LSR_DATA_MASK) {
1688 /*
1689 * Save the LSR event for bulk read completion routine
1690 */
1691 dev_dbg(dev, "%s - LSR Event Port %u LSR Status = %02x\n",
1692 __func__, port_number, lsr);
1693 edge_port->lsr_event = 1;
1694 edge_port->lsr_mask = lsr;
1695 } else {
1696 dev_dbg(dev, "%s - ===== Port %d LSR Status = %02x ======\n",
1697 __func__, port_number, lsr);
1698 handle_new_lsr(edge_port, 0, lsr, 0);
1699 }
1700 break;
1701
1702 case TIUMP_INTERRUPT_CODE_MSR: /* MSR */
1703 /* Copy MSR from UMP */
1704 msr = data[1];
1705 dev_dbg(dev, "%s - ===== Port %u MSR Status = %02x ======\n",
1706 __func__, port_number, msr);
1707 handle_new_msr(edge_port, msr);
1708 break;
1709
1710 default:
1711 dev_err(&urb->dev->dev,
1712 "%s - Unknown Interrupt code from UMP %x\n",
1713 __func__, data[1]);
1714 break;
1715
1716 }
1717
1718exit:
1719 retval = usb_submit_urb(urb, GFP_ATOMIC);
1720 if (retval)
1721 dev_err(&urb->dev->dev,
1722 "%s - usb_submit_urb failed with result %d\n",
1723 __func__, retval);
1724}
1725
1726static void edge_bulk_in_callback(struct urb *urb)
1727{
1728 struct edgeport_port *edge_port = urb->context;
1729 struct device *dev = &edge_port->port->dev;
1730 unsigned char *data = urb->transfer_buffer;
1731 int retval = 0;
1732 int port_number;
1733 int status = urb->status;
1734
1735 switch (status) {
1736 case 0:
1737 /* success */
1738 break;
1739 case -ECONNRESET:
1740 case -ENOENT:
1741 case -ESHUTDOWN:
1742 /* this urb is terminated, clean up */
1743 dev_dbg(&urb->dev->dev, "%s - urb shutting down with status: %d\n", __func__, status);
1744 return;
1745 default:
1746 dev_err(&urb->dev->dev, "%s - nonzero read bulk status received: %d\n", __func__, status);
1747 }
1748
1749 if (status == -EPIPE)
1750 goto exit;
1751
1752 if (status) {
1753 dev_err(&urb->dev->dev, "%s - stopping read!\n", __func__);
1754 return;
1755 }
1756
1757 port_number = edge_port->port->port_number;
1758
1759 if (edge_port->lsr_event) {
1760 edge_port->lsr_event = 0;
1761 dev_dbg(dev, "%s ===== Port %u LSR Status = %02x, Data = %02x ======\n",
1762 __func__, port_number, edge_port->lsr_mask, *data);
1763 handle_new_lsr(edge_port, 1, edge_port->lsr_mask, *data);
1764 /* Adjust buffer length/pointer */
1765 --urb->actual_length;
1766 ++data;
1767 }
1768
1769 if (urb->actual_length) {
1770 usb_serial_debug_data(dev, __func__, urb->actual_length, data);
1771 if (edge_port->close_pending)
1772 dev_dbg(dev, "%s - close pending, dropping data on the floor\n",
1773 __func__);
1774 else
1775 edge_tty_recv(edge_port->port, data,
1776 urb->actual_length);
1777 edge_port->port->icount.rx += urb->actual_length;
1778 }
1779
1780exit:
1781 /* continue read unless stopped */
1782 spin_lock(&edge_port->ep_lock);
1783 if (edge_port->ep_read_urb_state == EDGE_READ_URB_RUNNING)
1784 retval = usb_submit_urb(urb, GFP_ATOMIC);
1785 else if (edge_port->ep_read_urb_state == EDGE_READ_URB_STOPPING)
1786 edge_port->ep_read_urb_state = EDGE_READ_URB_STOPPED;
1787
1788 spin_unlock(&edge_port->ep_lock);
1789 if (retval)
1790 dev_err(dev, "%s - usb_submit_urb failed with result %d\n", __func__, retval);
1791}
1792
1793static void edge_tty_recv(struct usb_serial_port *port, unsigned char *data,
1794 int length)
1795{
1796 int queued;
1797
1798 queued = tty_insert_flip_string(&port->port, data, length);
1799 if (queued < length)
1800 dev_err(&port->dev, "%s - dropping data, %d bytes lost\n",
1801 __func__, length - queued);
1802 tty_flip_buffer_push(&port->port);
1803}
1804
1805static void edge_bulk_out_callback(struct urb *urb)
1806{
1807 struct usb_serial_port *port = urb->context;
1808 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1809 int status = urb->status;
1810 struct tty_struct *tty;
1811
1812 edge_port->ep_write_urb_in_use = 0;
1813
1814 switch (status) {
1815 case 0:
1816 /* success */
1817 break;
1818 case -ECONNRESET:
1819 case -ENOENT:
1820 case -ESHUTDOWN:
1821 /* this urb is terminated, clean up */
1822 dev_dbg(&urb->dev->dev, "%s - urb shutting down with status: %d\n",
1823 __func__, status);
1824 return;
1825 default:
1826 dev_err_console(port, "%s - nonzero write bulk status "
1827 "received: %d\n", __func__, status);
1828 }
1829
1830 /* send any buffered data */
1831 tty = tty_port_tty_get(&port->port);
1832 edge_send(port, tty);
1833 tty_kref_put(tty);
1834}
1835
1836static int edge_open(struct tty_struct *tty, struct usb_serial_port *port)
1837{
1838 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1839 struct edgeport_serial *edge_serial;
1840 struct usb_device *dev;
1841 struct urb *urb;
1842 int port_number;
1843 int status;
1844 u16 open_settings;
1845 u8 transaction_timeout;
1846
1847 if (edge_port == NULL)
1848 return -ENODEV;
1849
1850 port_number = port->port_number;
1851
1852 dev = port->serial->dev;
1853
1854 /* turn off loopback */
1855 status = ti_do_config(edge_port, UMPC_SET_CLR_LOOPBACK, 0);
1856 if (status) {
1857 dev_err(&port->dev,
1858 "%s - cannot send clear loopback command, %d\n",
1859 __func__, status);
1860 return status;
1861 }
1862
1863 /* set up the port settings */
1864 if (tty)
1865 edge_set_termios(tty, port, &tty->termios);
1866
1867 /* open up the port */
1868
1869 /* milliseconds to timeout for DMA transfer */
1870 transaction_timeout = 2;
1871
1872 edge_port->ump_read_timeout =
1873 max(20, ((transaction_timeout * 3) / 2));
1874
1875 /* milliseconds to timeout for DMA transfer */
1876 open_settings = (u8)(UMP_DMA_MODE_CONTINOUS |
1877 UMP_PIPE_TRANS_TIMEOUT_ENA |
1878 (transaction_timeout << 2));
1879
1880 dev_dbg(&port->dev, "%s - Sending UMPC_OPEN_PORT\n", __func__);
1881
1882 /* Tell TI to open and start the port */
1883 status = send_cmd(dev, UMPC_OPEN_PORT,
1884 (u8)(UMPM_UART1_PORT + port_number), open_settings, NULL, 0);
1885 if (status) {
1886 dev_err(&port->dev, "%s - cannot send open command, %d\n",
1887 __func__, status);
1888 return status;
1889 }
1890
1891 /* Start the DMA? */
1892 status = send_cmd(dev, UMPC_START_PORT,
1893 (u8)(UMPM_UART1_PORT + port_number), 0, NULL, 0);
1894 if (status) {
1895 dev_err(&port->dev, "%s - cannot send start DMA command, %d\n",
1896 __func__, status);
1897 return status;
1898 }
1899
1900 /* Clear TX and RX buffers in UMP */
1901 status = purge_port(port, UMP_PORT_DIR_OUT | UMP_PORT_DIR_IN);
1902 if (status) {
1903 dev_err(&port->dev,
1904 "%s - cannot send clear buffers command, %d\n",
1905 __func__, status);
1906 return status;
1907 }
1908
1909 /* Read Initial MSR */
1910 status = ti_vread_sync(dev, UMPC_READ_MSR, 0,
1911 (__u16)(UMPM_UART1_PORT + port_number),
1912 &edge_port->shadow_msr, 1);
1913 if (status) {
1914 dev_err(&port->dev, "%s - cannot send read MSR command, %d\n",
1915 __func__, status);
1916 return status;
1917 }
1918
1919 dev_dbg(&port->dev, "ShadowMSR 0x%X\n", edge_port->shadow_msr);
1920
1921 /* Set Initial MCR */
1922 edge_port->shadow_mcr = MCR_RTS | MCR_DTR;
1923 dev_dbg(&port->dev, "ShadowMCR 0x%X\n", edge_port->shadow_mcr);
1924
1925 edge_serial = edge_port->edge_serial;
1926 if (mutex_lock_interruptible(&edge_serial->es_lock))
1927 return -ERESTARTSYS;
1928 if (edge_serial->num_ports_open == 0) {
1929 /* we are the first port to open, post the interrupt urb */
1930 urb = edge_serial->serial->port[0]->interrupt_in_urb;
1931 if (!urb) {
1932 dev_err(&port->dev,
1933 "%s - no interrupt urb present, exiting\n",
1934 __func__);
1935 status = -EINVAL;
1936 goto release_es_lock;
1937 }
1938 urb->context = edge_serial;
1939 status = usb_submit_urb(urb, GFP_KERNEL);
1940 if (status) {
1941 dev_err(&port->dev,
1942 "%s - usb_submit_urb failed with value %d\n",
1943 __func__, status);
1944 goto release_es_lock;
1945 }
1946 }
1947
1948 /*
1949 * reset the data toggle on the bulk endpoints to work around bug in
1950 * host controllers where things get out of sync some times
1951 */
1952 usb_clear_halt(dev, port->write_urb->pipe);
1953 usb_clear_halt(dev, port->read_urb->pipe);
1954
1955 /* start up our bulk read urb */
1956 urb = port->read_urb;
1957 if (!urb) {
1958 dev_err(&port->dev, "%s - no read urb present, exiting\n",
1959 __func__);
1960 status = -EINVAL;
1961 goto unlink_int_urb;
1962 }
1963 edge_port->ep_read_urb_state = EDGE_READ_URB_RUNNING;
1964 urb->context = edge_port;
1965 status = usb_submit_urb(urb, GFP_KERNEL);
1966 if (status) {
1967 dev_err(&port->dev,
1968 "%s - read bulk usb_submit_urb failed with value %d\n",
1969 __func__, status);
1970 goto unlink_int_urb;
1971 }
1972
1973 ++edge_serial->num_ports_open;
1974
1975 goto release_es_lock;
1976
1977unlink_int_urb:
1978 if (edge_port->edge_serial->num_ports_open == 0)
1979 usb_kill_urb(port->serial->port[0]->interrupt_in_urb);
1980release_es_lock:
1981 mutex_unlock(&edge_serial->es_lock);
1982 return status;
1983}
1984
1985static void edge_close(struct usb_serial_port *port)
1986{
1987 struct edgeport_serial *edge_serial;
1988 struct edgeport_port *edge_port;
1989 struct usb_serial *serial = port->serial;
1990 unsigned long flags;
1991 int port_number;
1992
1993 edge_serial = usb_get_serial_data(port->serial);
1994 edge_port = usb_get_serial_port_data(port);
1995 if (edge_serial == NULL || edge_port == NULL)
1996 return;
1997
1998 /*
1999 * The bulkreadcompletion routine will check
2000 * this flag and dump add read data
2001 */
2002 edge_port->close_pending = 1;
2003
2004 usb_kill_urb(port->read_urb);
2005 usb_kill_urb(port->write_urb);
2006 edge_port->ep_write_urb_in_use = 0;
2007 spin_lock_irqsave(&edge_port->ep_lock, flags);
2008 kfifo_reset_out(&port->write_fifo);
2009 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2010
2011 dev_dbg(&port->dev, "%s - send umpc_close_port\n", __func__);
2012 port_number = port->port_number;
2013 send_cmd(serial->dev, UMPC_CLOSE_PORT,
2014 (__u8)(UMPM_UART1_PORT + port_number), 0, NULL, 0);
2015
2016 mutex_lock(&edge_serial->es_lock);
2017 --edge_port->edge_serial->num_ports_open;
2018 if (edge_port->edge_serial->num_ports_open <= 0) {
2019 /* last port is now closed, let's shut down our interrupt urb */
2020 usb_kill_urb(port->serial->port[0]->interrupt_in_urb);
2021 edge_port->edge_serial->num_ports_open = 0;
2022 }
2023 mutex_unlock(&edge_serial->es_lock);
2024 edge_port->close_pending = 0;
2025}
2026
2027static int edge_write(struct tty_struct *tty, struct usb_serial_port *port,
2028 const unsigned char *data, int count)
2029{
2030 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2031
2032 if (count == 0) {
2033 dev_dbg(&port->dev, "%s - write request of 0 bytes\n", __func__);
2034 return 0;
2035 }
2036
2037 if (edge_port == NULL)
2038 return -ENODEV;
2039 if (edge_port->close_pending == 1)
2040 return -ENODEV;
2041
2042 count = kfifo_in_locked(&port->write_fifo, data, count,
2043 &edge_port->ep_lock);
2044 edge_send(port, tty);
2045
2046 return count;
2047}
2048
2049static void edge_send(struct usb_serial_port *port, struct tty_struct *tty)
2050{
2051 int count, result;
2052 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2053 unsigned long flags;
2054
2055 spin_lock_irqsave(&edge_port->ep_lock, flags);
2056
2057 if (edge_port->ep_write_urb_in_use) {
2058 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2059 return;
2060 }
2061
2062 count = kfifo_out(&port->write_fifo,
2063 port->write_urb->transfer_buffer,
2064 port->bulk_out_size);
2065
2066 if (count == 0) {
2067 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2068 return;
2069 }
2070
2071 edge_port->ep_write_urb_in_use = 1;
2072
2073 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2074
2075 usb_serial_debug_data(&port->dev, __func__, count, port->write_urb->transfer_buffer);
2076
2077 /* set up our urb */
2078 port->write_urb->transfer_buffer_length = count;
2079
2080 /* send the data out the bulk port */
2081 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
2082 if (result) {
2083 dev_err_console(port,
2084 "%s - failed submitting write urb, error %d\n",
2085 __func__, result);
2086 edge_port->ep_write_urb_in_use = 0;
2087 /* TODO: reschedule edge_send */
2088 } else
2089 edge_port->port->icount.tx += count;
2090
2091 /*
2092 * wakeup any process waiting for writes to complete
2093 * there is now more room in the buffer for new writes
2094 */
2095 if (tty)
2096 tty_wakeup(tty);
2097}
2098
2099static int edge_write_room(struct tty_struct *tty)
2100{
2101 struct usb_serial_port *port = tty->driver_data;
2102 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2103 int room = 0;
2104 unsigned long flags;
2105
2106 if (edge_port == NULL)
2107 return 0;
2108 if (edge_port->close_pending == 1)
2109 return 0;
2110
2111 spin_lock_irqsave(&edge_port->ep_lock, flags);
2112 room = kfifo_avail(&port->write_fifo);
2113 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2114
2115 dev_dbg(&port->dev, "%s - returns %d\n", __func__, room);
2116 return room;
2117}
2118
2119static int edge_chars_in_buffer(struct tty_struct *tty)
2120{
2121 struct usb_serial_port *port = tty->driver_data;
2122 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2123 int chars = 0;
2124 unsigned long flags;
2125 if (edge_port == NULL)
2126 return 0;
2127
2128 spin_lock_irqsave(&edge_port->ep_lock, flags);
2129 chars = kfifo_len(&port->write_fifo);
2130 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2131
2132 dev_dbg(&port->dev, "%s - returns %d\n", __func__, chars);
2133 return chars;
2134}
2135
2136static bool edge_tx_empty(struct usb_serial_port *port)
2137{
2138 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2139 int ret;
2140
2141 ret = tx_active(edge_port);
2142 if (ret > 0)
2143 return false;
2144
2145 return true;
2146}
2147
2148static void edge_throttle(struct tty_struct *tty)
2149{
2150 struct usb_serial_port *port = tty->driver_data;
2151 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2152 int status;
2153
2154 if (edge_port == NULL)
2155 return;
2156
2157 /* if we are implementing XON/XOFF, send the stop character */
2158 if (I_IXOFF(tty)) {
2159 unsigned char stop_char = STOP_CHAR(tty);
2160 status = edge_write(tty, port, &stop_char, 1);
2161 if (status <= 0) {
2162 dev_err(&port->dev, "%s - failed to write stop character, %d\n", __func__, status);
2163 }
2164 }
2165
2166 /*
2167 * if we are implementing RTS/CTS, stop reads
2168 * and the Edgeport will clear the RTS line
2169 */
2170 if (C_CRTSCTS(tty))
2171 stop_read(edge_port);
2172
2173}
2174
2175static void edge_unthrottle(struct tty_struct *tty)
2176{
2177 struct usb_serial_port *port = tty->driver_data;
2178 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2179 int status;
2180
2181 if (edge_port == NULL)
2182 return;
2183
2184 /* if we are implementing XON/XOFF, send the start character */
2185 if (I_IXOFF(tty)) {
2186 unsigned char start_char = START_CHAR(tty);
2187 status = edge_write(tty, port, &start_char, 1);
2188 if (status <= 0) {
2189 dev_err(&port->dev, "%s - failed to write start character, %d\n", __func__, status);
2190 }
2191 }
2192 /*
2193 * if we are implementing RTS/CTS, restart reads
2194 * are the Edgeport will assert the RTS line
2195 */
2196 if (C_CRTSCTS(tty)) {
2197 status = restart_read(edge_port);
2198 if (status)
2199 dev_err(&port->dev,
2200 "%s - read bulk usb_submit_urb failed: %d\n",
2201 __func__, status);
2202 }
2203
2204}
2205
2206static void stop_read(struct edgeport_port *edge_port)
2207{
2208 unsigned long flags;
2209
2210 spin_lock_irqsave(&edge_port->ep_lock, flags);
2211
2212 if (edge_port->ep_read_urb_state == EDGE_READ_URB_RUNNING)
2213 edge_port->ep_read_urb_state = EDGE_READ_URB_STOPPING;
2214 edge_port->shadow_mcr &= ~MCR_RTS;
2215
2216 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2217}
2218
2219static int restart_read(struct edgeport_port *edge_port)
2220{
2221 struct urb *urb;
2222 int status = 0;
2223 unsigned long flags;
2224
2225 spin_lock_irqsave(&edge_port->ep_lock, flags);
2226
2227 if (edge_port->ep_read_urb_state == EDGE_READ_URB_STOPPED) {
2228 urb = edge_port->port->read_urb;
2229 status = usb_submit_urb(urb, GFP_ATOMIC);
2230 }
2231 edge_port->ep_read_urb_state = EDGE_READ_URB_RUNNING;
2232 edge_port->shadow_mcr |= MCR_RTS;
2233
2234 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2235
2236 return status;
2237}
2238
2239static void change_port_settings(struct tty_struct *tty,
2240 struct edgeport_port *edge_port, struct ktermios *old_termios)
2241{
2242 struct device *dev = &edge_port->port->dev;
2243 struct ump_uart_config *config;
2244 int baud;
2245 unsigned cflag;
2246 int status;
2247 int port_number = edge_port->port->port_number;
2248
2249 config = kmalloc (sizeof (*config), GFP_KERNEL);
2250 if (!config) {
2251 tty->termios = *old_termios;
2252 return;
2253 }
2254
2255 cflag = tty->termios.c_cflag;
2256
2257 config->wFlags = 0;
2258
2259 /* These flags must be set */
2260 config->wFlags |= UMP_MASK_UART_FLAGS_RECEIVE_MS_INT;
2261 config->wFlags |= UMP_MASK_UART_FLAGS_AUTO_START_ON_ERR;
2262 config->bUartMode = (__u8)(edge_port->bUartMode);
2263
2264 switch (cflag & CSIZE) {
2265 case CS5:
2266 config->bDataBits = UMP_UART_CHAR5BITS;
2267 dev_dbg(dev, "%s - data bits = 5\n", __func__);
2268 break;
2269 case CS6:
2270 config->bDataBits = UMP_UART_CHAR6BITS;
2271 dev_dbg(dev, "%s - data bits = 6\n", __func__);
2272 break;
2273 case CS7:
2274 config->bDataBits = UMP_UART_CHAR7BITS;
2275 dev_dbg(dev, "%s - data bits = 7\n", __func__);
2276 break;
2277 default:
2278 case CS8:
2279 config->bDataBits = UMP_UART_CHAR8BITS;
2280 dev_dbg(dev, "%s - data bits = 8\n", __func__);
2281 break;
2282 }
2283
2284 if (cflag & PARENB) {
2285 if (cflag & PARODD) {
2286 config->wFlags |= UMP_MASK_UART_FLAGS_PARITY;
2287 config->bParity = UMP_UART_ODDPARITY;
2288 dev_dbg(dev, "%s - parity = odd\n", __func__);
2289 } else {
2290 config->wFlags |= UMP_MASK_UART_FLAGS_PARITY;
2291 config->bParity = UMP_UART_EVENPARITY;
2292 dev_dbg(dev, "%s - parity = even\n", __func__);
2293 }
2294 } else {
2295 config->bParity = UMP_UART_NOPARITY;
2296 dev_dbg(dev, "%s - parity = none\n", __func__);
2297 }
2298
2299 if (cflag & CSTOPB) {
2300 config->bStopBits = UMP_UART_STOPBIT2;
2301 dev_dbg(dev, "%s - stop bits = 2\n", __func__);
2302 } else {
2303 config->bStopBits = UMP_UART_STOPBIT1;
2304 dev_dbg(dev, "%s - stop bits = 1\n", __func__);
2305 }
2306
2307 /* figure out the flow control settings */
2308 if (cflag & CRTSCTS) {
2309 config->wFlags |= UMP_MASK_UART_FLAGS_OUT_X_CTS_FLOW;
2310 config->wFlags |= UMP_MASK_UART_FLAGS_RTS_FLOW;
2311 dev_dbg(dev, "%s - RTS/CTS is enabled\n", __func__);
2312 } else {
2313 dev_dbg(dev, "%s - RTS/CTS is disabled\n", __func__);
2314 restart_read(edge_port);
2315 }
2316
2317 /*
2318 * if we are implementing XON/XOFF, set the start and stop
2319 * character in the device
2320 */
2321 config->cXon = START_CHAR(tty);
2322 config->cXoff = STOP_CHAR(tty);
2323
2324 /* if we are implementing INBOUND XON/XOFF */
2325 if (I_IXOFF(tty)) {
2326 config->wFlags |= UMP_MASK_UART_FLAGS_IN_X;
2327 dev_dbg(dev, "%s - INBOUND XON/XOFF is enabled, XON = %2x, XOFF = %2x\n",
2328 __func__, config->cXon, config->cXoff);
2329 } else
2330 dev_dbg(dev, "%s - INBOUND XON/XOFF is disabled\n", __func__);
2331
2332 /* if we are implementing OUTBOUND XON/XOFF */
2333 if (I_IXON(tty)) {
2334 config->wFlags |= UMP_MASK_UART_FLAGS_OUT_X;
2335 dev_dbg(dev, "%s - OUTBOUND XON/XOFF is enabled, XON = %2x, XOFF = %2x\n",
2336 __func__, config->cXon, config->cXoff);
2337 } else
2338 dev_dbg(dev, "%s - OUTBOUND XON/XOFF is disabled\n", __func__);
2339
2340 tty->termios.c_cflag &= ~CMSPAR;
2341
2342 /* Round the baud rate */
2343 baud = tty_get_baud_rate(tty);
2344 if (!baud) {
2345 /* pick a default, any default... */
2346 baud = 9600;
2347 } else
2348 tty_encode_baud_rate(tty, baud, baud);
2349
2350 edge_port->baud_rate = baud;
2351 config->wBaudRate = (__u16)((461550L + baud/2) / baud);
2352
2353 /* FIXME: Recompute actual baud from divisor here */
2354
2355 dev_dbg(dev, "%s - baud rate = %d, wBaudRate = %d\n", __func__, baud, config->wBaudRate);
2356
2357 dev_dbg(dev, "wBaudRate: %d\n", (int)(461550L / config->wBaudRate));
2358 dev_dbg(dev, "wFlags: 0x%x\n", config->wFlags);
2359 dev_dbg(dev, "bDataBits: %d\n", config->bDataBits);
2360 dev_dbg(dev, "bParity: %d\n", config->bParity);
2361 dev_dbg(dev, "bStopBits: %d\n", config->bStopBits);
2362 dev_dbg(dev, "cXon: %d\n", config->cXon);
2363 dev_dbg(dev, "cXoff: %d\n", config->cXoff);
2364 dev_dbg(dev, "bUartMode: %d\n", config->bUartMode);
2365
2366 /* move the word values into big endian mode */
2367 cpu_to_be16s(&config->wFlags);
2368 cpu_to_be16s(&config->wBaudRate);
2369
2370 status = send_cmd(edge_port->port->serial->dev, UMPC_SET_CONFIG,
2371 (__u8)(UMPM_UART1_PORT + port_number),
2372 0, (__u8 *)config, sizeof(*config));
2373 if (status)
2374 dev_dbg(dev, "%s - error %d when trying to write config to device\n",
2375 __func__, status);
2376 kfree(config);
2377}
2378
2379static void edge_set_termios(struct tty_struct *tty,
2380 struct usb_serial_port *port, struct ktermios *old_termios)
2381{
2382 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2383 unsigned int cflag;
2384
2385 cflag = tty->termios.c_cflag;
2386
2387 dev_dbg(&port->dev, "%s - clfag %08x iflag %08x\n", __func__,
2388 tty->termios.c_cflag, tty->termios.c_iflag);
2389 dev_dbg(&port->dev, "%s - old clfag %08x old iflag %08x\n", __func__,
2390 old_termios->c_cflag, old_termios->c_iflag);
2391
2392 if (edge_port == NULL)
2393 return;
2394 /* change the port settings to the new ones specified */
2395 change_port_settings(tty, edge_port, old_termios);
2396}
2397
2398static int edge_tiocmset(struct tty_struct *tty,
2399 unsigned int set, unsigned int clear)
2400{
2401 struct usb_serial_port *port = tty->driver_data;
2402 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2403 unsigned int mcr;
2404 unsigned long flags;
2405
2406 spin_lock_irqsave(&edge_port->ep_lock, flags);
2407 mcr = edge_port->shadow_mcr;
2408 if (set & TIOCM_RTS)
2409 mcr |= MCR_RTS;
2410 if (set & TIOCM_DTR)
2411 mcr |= MCR_DTR;
2412 if (set & TIOCM_LOOP)
2413 mcr |= MCR_LOOPBACK;
2414
2415 if (clear & TIOCM_RTS)
2416 mcr &= ~MCR_RTS;
2417 if (clear & TIOCM_DTR)
2418 mcr &= ~MCR_DTR;
2419 if (clear & TIOCM_LOOP)
2420 mcr &= ~MCR_LOOPBACK;
2421
2422 edge_port->shadow_mcr = mcr;
2423 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2424
2425 restore_mcr(edge_port, mcr);
2426 return 0;
2427}
2428
2429static int edge_tiocmget(struct tty_struct *tty)
2430{
2431 struct usb_serial_port *port = tty->driver_data;
2432 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2433 unsigned int result = 0;
2434 unsigned int msr;
2435 unsigned int mcr;
2436 unsigned long flags;
2437
2438 spin_lock_irqsave(&edge_port->ep_lock, flags);
2439
2440 msr = edge_port->shadow_msr;
2441 mcr = edge_port->shadow_mcr;
2442 result = ((mcr & MCR_DTR) ? TIOCM_DTR: 0) /* 0x002 */
2443 | ((mcr & MCR_RTS) ? TIOCM_RTS: 0) /* 0x004 */
2444 | ((msr & EDGEPORT_MSR_CTS) ? TIOCM_CTS: 0) /* 0x020 */
2445 | ((msr & EDGEPORT_MSR_CD) ? TIOCM_CAR: 0) /* 0x040 */
2446 | ((msr & EDGEPORT_MSR_RI) ? TIOCM_RI: 0) /* 0x080 */
2447 | ((msr & EDGEPORT_MSR_DSR) ? TIOCM_DSR: 0); /* 0x100 */
2448
2449
2450 dev_dbg(&port->dev, "%s -- %x\n", __func__, result);
2451 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2452
2453 return result;
2454}
2455
2456static int get_serial_info(struct edgeport_port *edge_port,
2457 struct serial_struct __user *retinfo)
2458{
2459 struct serial_struct tmp;
2460 unsigned cwait;
2461
2462 if (!retinfo)
2463 return -EFAULT;
2464
2465 cwait = edge_port->port->port.closing_wait;
2466 if (cwait != ASYNC_CLOSING_WAIT_NONE)
2467 cwait = jiffies_to_msecs(cwait) / 10;
2468
2469 memset(&tmp, 0, sizeof(tmp));
2470
2471 tmp.type = PORT_16550A;
2472 tmp.line = edge_port->port->minor;
2473 tmp.port = edge_port->port->port_number;
2474 tmp.irq = 0;
2475 tmp.flags = ASYNC_SKIP_TEST | ASYNC_AUTO_IRQ;
2476 tmp.xmit_fifo_size = edge_port->port->bulk_out_size;
2477 tmp.baud_base = 9600;
2478 tmp.close_delay = 5*HZ;
2479 tmp.closing_wait = cwait;
2480
2481 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
2482 return -EFAULT;
2483 return 0;
2484}
2485
2486static int edge_ioctl(struct tty_struct *tty,
2487 unsigned int cmd, unsigned long arg)
2488{
2489 struct usb_serial_port *port = tty->driver_data;
2490 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2491
2492 switch (cmd) {
2493 case TIOCGSERIAL:
2494 dev_dbg(&port->dev, "%s - TIOCGSERIAL\n", __func__);
2495 return get_serial_info(edge_port,
2496 (struct serial_struct __user *) arg);
2497 }
2498 return -ENOIOCTLCMD;
2499}
2500
2501static void edge_break(struct tty_struct *tty, int break_state)
2502{
2503 struct usb_serial_port *port = tty->driver_data;
2504 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2505 int status;
2506 int bv = 0; /* Off */
2507
2508 if (break_state == -1)
2509 bv = 1; /* On */
2510 status = ti_do_config(edge_port, UMPC_SET_CLR_BREAK, bv);
2511 if (status)
2512 dev_dbg(&port->dev, "%s - error %d sending break set/clear command.\n",
2513 __func__, status);
2514}
2515
2516static void edge_heartbeat_schedule(struct edgeport_serial *edge_serial)
2517{
2518 if (!edge_serial->use_heartbeat)
2519 return;
2520
2521 schedule_delayed_work(&edge_serial->heartbeat_work,
2522 FW_HEARTBEAT_SECS * HZ);
2523}
2524
2525static void edge_heartbeat_work(struct work_struct *work)
2526{
2527 struct edgeport_serial *serial;
2528 struct ti_i2c_desc *rom_desc;
2529
2530 serial = container_of(work, struct edgeport_serial,
2531 heartbeat_work.work);
2532
2533 rom_desc = kmalloc(sizeof(*rom_desc), GFP_KERNEL);
2534
2535 /* Descriptor address request is enough to reset the firmware timer */
2536 if (!rom_desc || !get_descriptor_addr(serial, I2C_DESC_TYPE_ION,
2537 rom_desc)) {
2538 dev_err(&serial->serial->interface->dev,
2539 "%s - Incomplete heartbeat\n", __func__);
2540 }
2541 kfree(rom_desc);
2542
2543 edge_heartbeat_schedule(serial);
2544}
2545
2546static int edge_startup(struct usb_serial *serial)
2547{
2548 struct edgeport_serial *edge_serial;
2549 int status;
2550 u16 product_id;
2551
2552 /* create our private serial structure */
2553 edge_serial = kzalloc(sizeof(struct edgeport_serial), GFP_KERNEL);
2554 if (!edge_serial)
2555 return -ENOMEM;
2556
2557 mutex_init(&edge_serial->es_lock);
2558 edge_serial->serial = serial;
2559 usb_set_serial_data(serial, edge_serial);
2560
2561 status = download_fw(edge_serial);
2562 if (status) {
2563 kfree(edge_serial);
2564 return status;
2565 }
2566
2567 product_id = le16_to_cpu(
2568 edge_serial->serial->dev->descriptor.idProduct);
2569
2570 /* Currently only the EP/416 models require heartbeat support */
2571 if (edge_serial->fw_version > FW_HEARTBEAT_VERSION_CUTOFF) {
2572 if (product_id == ION_DEVICE_ID_TI_EDGEPORT_416 ||
2573 product_id == ION_DEVICE_ID_TI_EDGEPORT_416B) {
2574 edge_serial->use_heartbeat = true;
2575 }
2576 }
2577
2578 INIT_DELAYED_WORK(&edge_serial->heartbeat_work, edge_heartbeat_work);
2579 edge_heartbeat_schedule(edge_serial);
2580
2581 return 0;
2582}
2583
2584static void edge_disconnect(struct usb_serial *serial)
2585{
2586}
2587
2588static void edge_release(struct usb_serial *serial)
2589{
2590 struct edgeport_serial *edge_serial = usb_get_serial_data(serial);
2591
2592 cancel_delayed_work_sync(&edge_serial->heartbeat_work);
2593 kfree(edge_serial);
2594}
2595
2596static int edge_port_probe(struct usb_serial_port *port)
2597{
2598 struct edgeport_port *edge_port;
2599 int ret;
2600
2601 edge_port = kzalloc(sizeof(*edge_port), GFP_KERNEL);
2602 if (!edge_port)
2603 return -ENOMEM;
2604
2605 spin_lock_init(&edge_port->ep_lock);
2606 edge_port->port = port;
2607 edge_port->edge_serial = usb_get_serial_data(port->serial);
2608 edge_port->bUartMode = default_uart_mode;
2609
2610 switch (port->port_number) {
2611 case 0:
2612 edge_port->uart_base = UMPMEM_BASE_UART1;
2613 edge_port->dma_address = UMPD_OEDB1_ADDRESS;
2614 break;
2615 case 1:
2616 edge_port->uart_base = UMPMEM_BASE_UART2;
2617 edge_port->dma_address = UMPD_OEDB2_ADDRESS;
2618 break;
2619 default:
2620 dev_err(&port->dev, "unknown port number\n");
2621 ret = -ENODEV;
2622 goto err;
2623 }
2624
2625 dev_dbg(&port->dev,
2626 "%s - port_number = %d, uart_base = %04x, dma_address = %04x\n",
2627 __func__, port->port_number, edge_port->uart_base,
2628 edge_port->dma_address);
2629
2630 usb_set_serial_port_data(port, edge_port);
2631
2632 ret = edge_create_sysfs_attrs(port);
2633 if (ret)
2634 goto err;
2635
2636 port->port.closing_wait = msecs_to_jiffies(closing_wait * 10);
2637 port->port.drain_delay = 1;
2638
2639 return 0;
2640err:
2641 kfree(edge_port);
2642
2643 return ret;
2644}
2645
2646static int edge_port_remove(struct usb_serial_port *port)
2647{
2648 struct edgeport_port *edge_port;
2649
2650 edge_port = usb_get_serial_port_data(port);
2651 edge_remove_sysfs_attrs(port);
2652 kfree(edge_port);
2653
2654 return 0;
2655}
2656
2657/* Sysfs Attributes */
2658
2659static ssize_t uart_mode_show(struct device *dev,
2660 struct device_attribute *attr, char *buf)
2661{
2662 struct usb_serial_port *port = to_usb_serial_port(dev);
2663 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2664
2665 return sprintf(buf, "%d\n", edge_port->bUartMode);
2666}
2667
2668static ssize_t uart_mode_store(struct device *dev,
2669 struct device_attribute *attr, const char *valbuf, size_t count)
2670{
2671 struct usb_serial_port *port = to_usb_serial_port(dev);
2672 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2673 unsigned int v = simple_strtoul(valbuf, NULL, 0);
2674
2675 dev_dbg(dev, "%s: setting uart_mode = %d\n", __func__, v);
2676
2677 if (v < 256)
2678 edge_port->bUartMode = v;
2679 else
2680 dev_err(dev, "%s - uart_mode %d is invalid\n", __func__, v);
2681
2682 return count;
2683}
2684static DEVICE_ATTR_RW(uart_mode);
2685
2686static int edge_create_sysfs_attrs(struct usb_serial_port *port)
2687{
2688 return device_create_file(&port->dev, &dev_attr_uart_mode);
2689}
2690
2691static int edge_remove_sysfs_attrs(struct usb_serial_port *port)
2692{
2693 device_remove_file(&port->dev, &dev_attr_uart_mode);
2694 return 0;
2695}
2696
2697#ifdef CONFIG_PM
2698static int edge_suspend(struct usb_serial *serial, pm_message_t message)
2699{
2700 struct edgeport_serial *edge_serial = usb_get_serial_data(serial);
2701
2702 cancel_delayed_work_sync(&edge_serial->heartbeat_work);
2703
2704 return 0;
2705}
2706
2707static int edge_resume(struct usb_serial *serial)
2708{
2709 struct edgeport_serial *edge_serial = usb_get_serial_data(serial);
2710
2711 edge_heartbeat_schedule(edge_serial);
2712
2713 return 0;
2714}
2715#endif
2716
2717static struct usb_serial_driver edgeport_1port_device = {
2718 .driver = {
2719 .owner = THIS_MODULE,
2720 .name = "edgeport_ti_1",
2721 },
2722 .description = "Edgeport TI 1 port adapter",
2723 .id_table = edgeport_1port_id_table,
2724 .num_ports = 1,
2725 .open = edge_open,
2726 .close = edge_close,
2727 .throttle = edge_throttle,
2728 .unthrottle = edge_unthrottle,
2729 .attach = edge_startup,
2730 .disconnect = edge_disconnect,
2731 .release = edge_release,
2732 .port_probe = edge_port_probe,
2733 .port_remove = edge_port_remove,
2734 .ioctl = edge_ioctl,
2735 .set_termios = edge_set_termios,
2736 .tiocmget = edge_tiocmget,
2737 .tiocmset = edge_tiocmset,
2738 .tiocmiwait = usb_serial_generic_tiocmiwait,
2739 .get_icount = usb_serial_generic_get_icount,
2740 .write = edge_write,
2741 .write_room = edge_write_room,
2742 .chars_in_buffer = edge_chars_in_buffer,
2743 .tx_empty = edge_tx_empty,
2744 .break_ctl = edge_break,
2745 .read_int_callback = edge_interrupt_callback,
2746 .read_bulk_callback = edge_bulk_in_callback,
2747 .write_bulk_callback = edge_bulk_out_callback,
2748#ifdef CONFIG_PM
2749 .suspend = edge_suspend,
2750 .resume = edge_resume,
2751#endif
2752};
2753
2754static struct usb_serial_driver edgeport_2port_device = {
2755 .driver = {
2756 .owner = THIS_MODULE,
2757 .name = "edgeport_ti_2",
2758 },
2759 .description = "Edgeport TI 2 port adapter",
2760 .id_table = edgeport_2port_id_table,
2761 .num_ports = 2,
2762 .open = edge_open,
2763 .close = edge_close,
2764 .throttle = edge_throttle,
2765 .unthrottle = edge_unthrottle,
2766 .attach = edge_startup,
2767 .disconnect = edge_disconnect,
2768 .release = edge_release,
2769 .port_probe = edge_port_probe,
2770 .port_remove = edge_port_remove,
2771 .ioctl = edge_ioctl,
2772 .set_termios = edge_set_termios,
2773 .tiocmget = edge_tiocmget,
2774 .tiocmset = edge_tiocmset,
2775 .tiocmiwait = usb_serial_generic_tiocmiwait,
2776 .get_icount = usb_serial_generic_get_icount,
2777 .write = edge_write,
2778 .write_room = edge_write_room,
2779 .chars_in_buffer = edge_chars_in_buffer,
2780 .tx_empty = edge_tx_empty,
2781 .break_ctl = edge_break,
2782 .read_int_callback = edge_interrupt_callback,
2783 .read_bulk_callback = edge_bulk_in_callback,
2784 .write_bulk_callback = edge_bulk_out_callback,
2785#ifdef CONFIG_PM
2786 .suspend = edge_suspend,
2787 .resume = edge_resume,
2788#endif
2789};
2790
2791static struct usb_serial_driver * const serial_drivers[] = {
2792 &edgeport_1port_device, &edgeport_2port_device, NULL
2793};
2794
2795module_usb_serial_driver(serial_drivers, id_table_combined);
2796
2797MODULE_AUTHOR(DRIVER_AUTHOR);
2798MODULE_DESCRIPTION(DRIVER_DESC);
2799MODULE_LICENSE("GPL");
2800MODULE_FIRMWARE("edgeport/down3.bin");
2801
2802module_param(closing_wait, int, S_IRUGO | S_IWUSR);
2803MODULE_PARM_DESC(closing_wait, "Maximum wait for data to drain, in .01 secs");
2804
2805module_param(ignore_cpu_rev, bool, S_IRUGO | S_IWUSR);
2806MODULE_PARM_DESC(ignore_cpu_rev,
2807 "Ignore the cpu revision when connecting to a device");
2808
2809module_param(default_uart_mode, int, S_IRUGO | S_IWUSR);
2810MODULE_PARM_DESC(default_uart_mode, "Default uart_mode, 0=RS232, ...");