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