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