2 * Edgeport USB Serial Converter driver
4 * Copyright (C) 2000-2002 Inside Out Networks, All rights reserved.
5 * Copyright (C) 2001-2002 Greg Kroah-Hartman <greg@kroah.com>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * Supports the following devices:
13 * EP/1 EP/2 EP/4 EP/21 EP/22 EP/221 EP/42 EP/421 WATCHPORT
15 * For questions or problems with this driver, contact Inside Out
16 * Networks technical support, or Peter Berger <pberger@brimson.com>,
17 * or Al Borchers <alborchers@steinerpoint.com>.
20 #include <linux/kernel.h>
21 #include <linux/jiffies.h>
22 #include <linux/errno.h>
23 #include <linux/slab.h>
24 #include <linux/tty.h>
25 #include <linux/tty_driver.h>
26 #include <linux/tty_flip.h>
27 #include <linux/module.h>
28 #include <linux/spinlock.h>
29 #include <linux/mutex.h>
30 #include <linux/serial.h>
31 #include <linux/swab.h>
32 #include <linux/kfifo.h>
33 #include <linux/ioctl.h>
34 #include <linux/firmware.h>
35 #include <linux/uaccess.h>
36 #include <linux/usb.h>
37 #include <linux/usb/serial.h>
40 #include "io_usbvend.h"
43 #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com> and David Iacovelli"
44 #define DRIVER_DESC "Edgeport USB Serial Driver"
46 #define EPROM_PAGE_SIZE 64
49 /* different hardware types */
50 #define HARDWARE_TYPE_930 0
51 #define HARDWARE_TYPE_TIUMP 1
53 /* IOCTL_PRIVATE_TI_GET_MODE Definitions */
54 #define TI_MODE_CONFIGURING 0 /* Device has not entered start device */
55 #define TI_MODE_BOOT 1 /* Staying in boot mode */
56 #define TI_MODE_DOWNLOAD 2 /* Made it to download mode */
57 #define TI_MODE_TRANSITIONING 3 /*
58 * Currently in boot mode but
59 * transitioning to download mode
63 #define EDGE_READ_URB_RUNNING 0
64 #define EDGE_READ_URB_STOPPING 1
65 #define EDGE_READ_URB_STOPPED 2
67 #define EDGE_CLOSING_WAIT 4000 /* in .01 sec */
70 /* Product information read from the Edgeport */
72 int TiMode; /* Current TI Mode */
73 __u8 hardware_type; /* Type of hardware */
74 } __attribute__((packed));
77 * Edgeport firmware header
79 * "build_number" has been set to 0 in all three of the images I have
80 * seen, and Digi Tech Support suggests that it is safe to ignore it.
82 * "length" is the number of bytes of actual data following the header.
84 * "checksum" is the low order byte resulting from adding the values of
87 struct edgeport_fw_hdr {
95 struct edgeport_port {
102 __u32 ump_read_timeout; /*
103 * Number of milliseconds the UMP will
104 * wait without data before completing
111 struct edgeport_serial *edge_serial;
112 struct usb_serial_port *port;
113 __u8 bUartMode; /* Port type, 0: RS232, etc. */
115 int ep_read_urb_state;
116 int ep_write_urb_in_use;
119 struct edgeport_serial {
120 struct product_info product_info;
121 u8 TI_I2C_Type; /* Type of I2C in UMP */
123 * Set to TRUE if we have read the
126 struct mutex es_lock;
128 struct usb_serial *serial;
129 struct delayed_work heartbeat_work;
135 /* Devices that this driver supports */
136 static const struct usb_device_id edgeport_1port_id_table[] = {
137 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_1) },
138 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_TI3410_EDGEPORT_1) },
139 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_TI3410_EDGEPORT_1I) },
140 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_PROXIMITY) },
141 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_MOTION) },
142 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_MOISTURE) },
143 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_TEMPERATURE) },
144 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_HUMIDITY) },
145 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_POWER) },
146 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_LIGHT) },
147 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_RADIATION) },
148 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_DISTANCE) },
149 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_ACCELERATION) },
150 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_PROX_DIST) },
151 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_PLUS_PWR_HP4CD) },
152 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_PLUS_PWR_PCI) },
156 static const struct usb_device_id edgeport_2port_id_table[] = {
157 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_2) },
158 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_2C) },
159 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_2I) },
160 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_421) },
161 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_21) },
162 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_42) },
163 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_4) },
164 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_4I) },
165 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_22I) },
166 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_221C) },
167 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_22C) },
168 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_21C) },
169 /* The 4, 8 and 16 port devices show up as multiple 2 port devices */
170 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_4S) },
171 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_8) },
172 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_8S) },
173 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_416) },
174 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_416B) },
175 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_E5805A) },
179 /* Devices that this driver supports */
180 static const struct usb_device_id id_table_combined[] = {
181 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_1) },
182 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_TI3410_EDGEPORT_1) },
183 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_TI3410_EDGEPORT_1I) },
184 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_PROXIMITY) },
185 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_MOTION) },
186 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_MOISTURE) },
187 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_TEMPERATURE) },
188 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_HUMIDITY) },
189 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_POWER) },
190 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_LIGHT) },
191 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_RADIATION) },
192 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_DISTANCE) },
193 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_ACCELERATION) },
194 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_PROX_DIST) },
195 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_PLUS_PWR_HP4CD) },
196 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_PLUS_PWR_PCI) },
197 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_2) },
198 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_2C) },
199 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_2I) },
200 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_421) },
201 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_21) },
202 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_42) },
203 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_4) },
204 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_4I) },
205 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_22I) },
206 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_221C) },
207 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_22C) },
208 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_21C) },
209 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_4S) },
210 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_8) },
211 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_8S) },
212 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_416) },
213 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_416B) },
214 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_E5805A) },
218 MODULE_DEVICE_TABLE(usb, id_table_combined);
220 static int closing_wait = EDGE_CLOSING_WAIT;
221 static bool ignore_cpu_rev;
222 static int default_uart_mode; /* RS232 */
224 static void edge_tty_recv(struct usb_serial_port *port, unsigned char *data,
227 static void stop_read(struct edgeport_port *edge_port);
228 static int restart_read(struct edgeport_port *edge_port);
230 static void edge_set_termios(struct tty_struct *tty,
231 struct usb_serial_port *port, struct ktermios *old_termios);
232 static void edge_send(struct usb_serial_port *port, struct tty_struct *tty);
234 static int do_download_mode(struct edgeport_serial *serial,
235 const struct firmware *fw);
236 static int do_boot_mode(struct edgeport_serial *serial,
237 const struct firmware *fw);
239 /* sysfs attributes */
240 static int edge_create_sysfs_attrs(struct usb_serial_port *port);
241 static int edge_remove_sysfs_attrs(struct usb_serial_port *port);
244 * Some release of Edgeport firmware "(DEBLOBBED)" after version 4.80
245 * introduced code to automatically disconnect idle devices on some
246 * Edgeport models after periods of inactivity, typically ~60 seconds.
247 * This occurs without regard to whether ports on the device are open
248 * or not. Digi International Tech Support suggested:
250 * 1. Adding driver "heartbeat" code to reset the firmware timer by
251 * requesting a descriptor record every 15 seconds, which should be
252 * effective with newer firmware versions that require it, and benign
253 * with older versions that do not. In practice 40 seconds seems often
255 * 2. The heartbeat code is currently required only on Edgeport/416 models.
257 #define FW_HEARTBEAT_VERSION_CUTOFF ((4 << 8) + 80)
258 #define FW_HEARTBEAT_SECS 40
260 /* Timeouts in msecs: firmware downloads take longer */
261 #define TI_VSEND_TIMEOUT_DEFAULT 1000
262 #define TI_VSEND_TIMEOUT_FW_DOWNLOAD 10000
264 static int ti_vread_sync(struct usb_device *dev, __u8 request,
265 __u16 value, __u16 index, u8 *data, int size)
269 status = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0), request,
270 (USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN),
271 value, index, data, size, 1000);
274 if (status != size) {
275 dev_dbg(&dev->dev, "%s - wanted to write %d, but only wrote %d\n",
276 __func__, size, status);
282 static int ti_vsend_sync(struct usb_device *dev, u8 request, u16 value,
283 u16 index, u8 *data, int size, int timeout)
287 status = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), request,
288 (USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT),
289 value, index, data, size, timeout);
292 if (status != size) {
293 dev_dbg(&dev->dev, "%s - wanted to write %d, but only wrote %d\n",
294 __func__, size, status);
300 static int send_cmd(struct usb_device *dev, __u8 command,
301 __u8 moduleid, __u16 value, u8 *data,
304 return ti_vsend_sync(dev, command, value, moduleid, data, size,
305 TI_VSEND_TIMEOUT_DEFAULT);
308 /* clear tx/rx buffers and fifo in TI UMP */
309 static int purge_port(struct usb_serial_port *port, __u16 mask)
311 int port_number = port->port_number;
313 dev_dbg(&port->dev, "%s - port %d, mask %x\n", __func__, port_number, mask);
315 return send_cmd(port->serial->dev,
317 (__u8)(UMPM_UART1_PORT + port_number),
324 * read_download_mem - Read edgeport memory from TI chip
325 * @dev: usb device pointer
326 * @start_address: Device CPU address at which to read
327 * @length: Length of above data
328 * @address_type: Can read both XDATA and I2C
329 * @buffer: pointer to input data buffer
331 static int read_download_mem(struct usb_device *dev, int start_address,
332 int length, __u8 address_type, __u8 *buffer)
336 u16 be_start_address;
338 dev_dbg(&dev->dev, "%s - @ %x for %d\n", __func__, start_address, length);
341 * Read in blocks of 64 bytes
342 * (TI firmware can't handle more than 64 byte reads)
348 read_length = (__u8)length;
350 if (read_length > 1) {
351 dev_dbg(&dev->dev, "%s - @ %x for %d\n", __func__, start_address, read_length);
354 * NOTE: Must use swab as wIndex is sent in little-endian
355 * byte order regardless of host byte order.
357 be_start_address = swab16((u16)start_address);
358 status = ti_vread_sync(dev, UMPC_MEMORY_READ,
361 buffer, read_length);
364 dev_dbg(&dev->dev, "%s - ERROR %x\n", __func__, status);
369 usb_serial_debug_data(&dev->dev, __func__, read_length, buffer);
371 /* Update pointers/length */
372 start_address += read_length;
373 buffer += read_length;
374 length -= read_length;
380 static int read_ram(struct usb_device *dev, int start_address,
381 int length, __u8 *buffer)
383 return read_download_mem(dev, start_address, length,
384 DTK_ADDR_SPACE_XDATA, buffer);
387 /* Read edgeport memory to a given block */
388 static int read_boot_mem(struct edgeport_serial *serial,
389 int start_address, int length, __u8 *buffer)
394 for (i = 0; i < length; i++) {
395 status = ti_vread_sync(serial->serial->dev,
396 UMPC_MEMORY_READ, serial->TI_I2C_Type,
397 (__u16)(start_address+i), &buffer[i], 0x01);
399 dev_dbg(&serial->serial->dev->dev, "%s - ERROR %x\n", __func__, status);
404 dev_dbg(&serial->serial->dev->dev, "%s - start_address = %x, length = %d\n",
405 __func__, start_address, length);
406 usb_serial_debug_data(&serial->serial->dev->dev, __func__, length, buffer);
408 serial->TiReadI2C = 1;
413 /* Write given block to TI EPROM memory */
414 static int write_boot_mem(struct edgeport_serial *serial,
415 int start_address, int length, __u8 *buffer)
421 /* Must do a read before write */
422 if (!serial->TiReadI2C) {
423 temp = kmalloc(1, GFP_KERNEL);
427 status = read_boot_mem(serial, 0, 1, temp);
433 for (i = 0; i < length; ++i) {
434 status = ti_vsend_sync(serial->serial->dev, UMPC_MEMORY_WRITE,
435 buffer[i], (u16)(i + start_address), NULL,
436 0, TI_VSEND_TIMEOUT_DEFAULT);
441 dev_dbg(&serial->serial->dev->dev, "%s - start_sddr = %x, length = %d\n", __func__, start_address, length);
442 usb_serial_debug_data(&serial->serial->dev->dev, __func__, length, buffer);
447 /* Write edgeport I2C memory to TI chip */
448 static int write_i2c_mem(struct edgeport_serial *serial,
449 int start_address, int length, __u8 address_type, __u8 *buffer)
451 struct device *dev = &serial->serial->dev->dev;
454 u16 be_start_address;
456 /* We can only send a maximum of 1 aligned byte page at a time */
458 /* calculate the number of bytes left in the first page */
459 write_length = EPROM_PAGE_SIZE -
460 (start_address & (EPROM_PAGE_SIZE - 1));
462 if (write_length > length)
463 write_length = length;
465 dev_dbg(dev, "%s - BytesInFirstPage Addr = %x, length = %d\n",
466 __func__, start_address, write_length);
467 usb_serial_debug_data(dev, __func__, write_length, buffer);
472 * NOTE: Must use swab as wIndex is sent in little-endian byte order
473 * regardless of host byte order.
475 be_start_address = swab16((u16)start_address);
476 status = ti_vsend_sync(serial->serial->dev, UMPC_MEMORY_WRITE,
477 (u16)address_type, be_start_address,
478 buffer, write_length, TI_VSEND_TIMEOUT_DEFAULT);
480 dev_dbg(dev, "%s - ERROR %d\n", __func__, status);
484 length -= write_length;
485 start_address += write_length;
486 buffer += write_length;
489 * We should be aligned now -- can write max page size bytes at a
493 if (length > EPROM_PAGE_SIZE)
494 write_length = EPROM_PAGE_SIZE;
496 write_length = length;
498 dev_dbg(dev, "%s - Page Write Addr = %x, length = %d\n",
499 __func__, start_address, write_length);
500 usb_serial_debug_data(dev, __func__, write_length, buffer);
505 * NOTE: Must use swab as wIndex is sent in little-endian byte
506 * order regardless of host byte order.
508 be_start_address = swab16((u16)start_address);
509 status = ti_vsend_sync(serial->serial->dev, UMPC_MEMORY_WRITE,
510 (u16)address_type, be_start_address, buffer,
511 write_length, TI_VSEND_TIMEOUT_DEFAULT);
513 dev_err(dev, "%s - ERROR %d\n", __func__, status);
517 length -= write_length;
518 start_address += write_length;
519 buffer += write_length;
525 * Examine the UMP DMA registers and LSR
527 * Check the MSBit of the X and Y DMA byte count registers.
528 * A zero in this bit indicates that the TX DMA buffers are empty
529 * then check the TX Empty bit in the UART.
531 static int tx_active(struct edgeport_port *port)
534 struct out_endpoint_desc_block *oedb;
538 oedb = kmalloc(sizeof(*oedb), GFP_KERNEL);
543 * Sigh, that's right, just one byte, as not all platforms can
546 lsr = kmalloc(1, GFP_KERNEL);
551 /* Read the DMA Count Registers */
552 status = read_ram(port->port->serial->dev, port->dma_address,
553 sizeof(*oedb), (void *)oedb);
555 goto exit_is_tx_active;
557 dev_dbg(&port->port->dev, "%s - XByteCount 0x%X\n", __func__, oedb->XByteCount);
560 status = read_ram(port->port->serial->dev,
561 port->uart_base + UMPMEM_OFFS_UART_LSR, 1, lsr);
564 goto exit_is_tx_active;
565 dev_dbg(&port->port->dev, "%s - LSR = 0x%X\n", __func__, *lsr);
567 /* If either buffer has data or we are transmitting then return TRUE */
568 if ((oedb->XByteCount & 0x80) != 0)
571 if ((*lsr & UMP_UART_LSR_TX_MASK) == 0)
574 /* We return Not Active if we get any kind of error */
576 dev_dbg(&port->port->dev, "%s - return %d\n", __func__, bytes_left);
583 static int choose_config(struct usb_device *dev)
586 * There may be multiple configurations on this device, in which case
587 * we would need to read and parse all of them to find out which one
588 * we want. However, we just support one config at this point,
589 * configuration # 1, which is Config Descriptor 0.
592 dev_dbg(&dev->dev, "%s - Number of Interfaces = %d\n",
593 __func__, dev->config->desc.bNumInterfaces);
594 dev_dbg(&dev->dev, "%s - MAX Power = %d\n",
595 __func__, dev->config->desc.bMaxPower * 2);
597 if (dev->config->desc.bNumInterfaces != 1) {
598 dev_err(&dev->dev, "%s - bNumInterfaces is not 1, ERROR!\n", __func__);
605 static int read_rom(struct edgeport_serial *serial,
606 int start_address, int length, __u8 *buffer)
610 if (serial->product_info.TiMode == TI_MODE_DOWNLOAD) {
611 status = read_download_mem(serial->serial->dev,
617 status = read_boot_mem(serial, start_address, length,
623 static int write_rom(struct edgeport_serial *serial, int start_address,
624 int length, __u8 *buffer)
626 if (serial->product_info.TiMode == TI_MODE_BOOT)
627 return write_boot_mem(serial, start_address, length,
630 if (serial->product_info.TiMode == TI_MODE_DOWNLOAD)
631 return write_i2c_mem(serial, start_address, length,
632 serial->TI_I2C_Type, buffer);
636 /* Read a descriptor header from I2C based on type */
637 static int get_descriptor_addr(struct edgeport_serial *serial,
638 int desc_type, struct ti_i2c_desc *rom_desc)
643 /* Search for requested descriptor in I2C */
646 status = read_rom(serial,
648 sizeof(struct ti_i2c_desc),
653 if (rom_desc->Type == desc_type)
654 return start_address;
656 start_address = start_address + sizeof(struct ti_i2c_desc) +
657 le16_to_cpu(rom_desc->Size);
659 } while ((start_address < TI_MAX_I2C_SIZE) && rom_desc->Type);
664 /* Validate descriptor checksum */
665 static int valid_csum(struct ti_i2c_desc *rom_desc, __u8 *buffer)
670 for (i = 0; i < le16_to_cpu(rom_desc->Size); i++)
671 cs = (__u8)(cs + buffer[i]);
673 if (cs != rom_desc->CheckSum) {
674 pr_debug("%s - Mismatch %x - %x", __func__, rom_desc->CheckSum, cs);
680 /* Make sure that the I2C image is good */
681 static int check_i2c_image(struct edgeport_serial *serial)
683 struct device *dev = &serial->serial->dev->dev;
685 struct ti_i2c_desc *rom_desc;
686 int start_address = 2;
690 rom_desc = kmalloc(sizeof(*rom_desc), GFP_KERNEL);
694 buffer = kmalloc(TI_MAX_I2C_SIZE, GFP_KERNEL);
700 /* Read the first byte (Signature0) must be 0x52 or 0x10 */
701 status = read_rom(serial, 0, 1, buffer);
705 if (*buffer != UMP5152 && *buffer != UMP3410) {
706 dev_err(dev, "%s - invalid buffer signature\n", __func__);
712 /* Validate the I2C */
713 status = read_rom(serial,
715 sizeof(struct ti_i2c_desc),
720 if ((start_address + sizeof(struct ti_i2c_desc) +
721 le16_to_cpu(rom_desc->Size)) > TI_MAX_I2C_SIZE) {
723 dev_dbg(dev, "%s - structure too big, erroring out.\n", __func__);
727 dev_dbg(dev, "%s Type = 0x%x\n", __func__, rom_desc->Type);
729 /* Skip type 2 record */
730 ttype = rom_desc->Type & 0x0f;
731 if (ttype != I2C_DESC_TYPE_FIRMWARE_BASIC
732 && ttype != I2C_DESC_TYPE_FIRMWARE_AUTO) {
733 /* Read the descriptor data */
734 status = read_rom(serial, start_address +
735 sizeof(struct ti_i2c_desc),
736 le16_to_cpu(rom_desc->Size),
741 status = valid_csum(rom_desc, buffer);
745 start_address = start_address + sizeof(struct ti_i2c_desc) +
746 le16_to_cpu(rom_desc->Size);
748 } while ((rom_desc->Type != I2C_DESC_TYPE_ION) &&
749 (start_address < TI_MAX_I2C_SIZE));
751 if ((rom_desc->Type != I2C_DESC_TYPE_ION) ||
752 (start_address > TI_MAX_I2C_SIZE))
761 static int get_manuf_info(struct edgeport_serial *serial, __u8 *buffer)
765 struct ti_i2c_desc *rom_desc;
766 struct edge_ti_manuf_descriptor *desc;
767 struct device *dev = &serial->serial->dev->dev;
769 rom_desc = kmalloc(sizeof(*rom_desc), GFP_KERNEL);
773 start_address = get_descriptor_addr(serial, I2C_DESC_TYPE_ION,
776 if (!start_address) {
777 dev_dbg(dev, "%s - Edge Descriptor not found in I2C\n", __func__);
782 /* Read the descriptor data */
783 status = read_rom(serial, start_address+sizeof(struct ti_i2c_desc),
784 le16_to_cpu(rom_desc->Size), buffer);
788 status = valid_csum(rom_desc, buffer);
790 desc = (struct edge_ti_manuf_descriptor *)buffer;
791 dev_dbg(dev, "%s - IonConfig 0x%x\n", __func__, desc->IonConfig);
792 dev_dbg(dev, "%s - Version %d\n", __func__, desc->Version);
793 dev_dbg(dev, "%s - Cpu/Board 0x%x\n", __func__, desc->CpuRev_BoardRev);
794 dev_dbg(dev, "%s - NumPorts %d\n", __func__, desc->NumPorts);
795 dev_dbg(dev, "%s - NumVirtualPorts %d\n", __func__, desc->NumVirtualPorts);
796 dev_dbg(dev, "%s - TotalPorts %d\n", __func__, desc->TotalPorts);
803 /* Build firmware header used for firmware update */
804 static int build_i2c_fw_hdr(u8 *header, const struct firmware *fw)
810 struct ti_i2c_desc *i2c_header;
811 struct ti_i2c_image_header *img_header;
812 struct ti_i2c_firmware_rec *firmware_rec;
813 struct edgeport_fw_hdr *fw_hdr = (struct edgeport_fw_hdr *)fw->data;
816 * In order to update the I2C firmware we must change the type 2 record
817 * to type 0xF2. This will force the UMP to come up in Boot Mode.
818 * Then while in boot mode, the driver will download the latest
819 * firmware (padded to 15.5k) into the UMP ram. And finally when the
820 * device comes back up in download mode the driver will cause the new
821 * firmware to be copied from the UMP Ram to I2C and the firmware will
822 * update the record type from 0xf2 to 0x02.
826 * Allocate a 15.5k buffer + 2 bytes for version number (Firmware
829 buffer_size = (((1024 * 16) - 512 ) +
830 sizeof(struct ti_i2c_firmware_rec));
832 buffer = kmalloc(buffer_size, GFP_KERNEL);
836 /* Set entire image of 0xffs */
837 memset(buffer, 0xff, buffer_size);
839 /* Copy version number into firmware record */
840 firmware_rec = (struct ti_i2c_firmware_rec *)buffer;
842 firmware_rec->Ver_Major = fw_hdr->major_version;
843 firmware_rec->Ver_Minor = fw_hdr->minor_version;
845 /* Pointer to fw_down memory image */
846 img_header = (struct ti_i2c_image_header *)&fw->data[4];
848 memcpy(buffer + sizeof(struct ti_i2c_firmware_rec),
849 &fw->data[4 + sizeof(struct ti_i2c_image_header)],
850 le16_to_cpu(img_header->Length));
852 for (i=0; i < buffer_size; i++) {
853 cs = (__u8)(cs + buffer[i]);
858 /* Build new header */
859 i2c_header = (struct ti_i2c_desc *)header;
860 firmware_rec = (struct ti_i2c_firmware_rec*)i2c_header->Data;
862 i2c_header->Type = I2C_DESC_TYPE_FIRMWARE_BLANK;
863 i2c_header->Size = cpu_to_le16(buffer_size);
864 i2c_header->CheckSum = cs;
865 firmware_rec->Ver_Major = fw_hdr->major_version;
866 firmware_rec->Ver_Minor = fw_hdr->minor_version;
871 /* Try to figure out what type of I2c we have */
872 static int i2c_type_bootmode(struct edgeport_serial *serial)
874 struct device *dev = &serial->serial->dev->dev;
878 data = kmalloc(1, GFP_KERNEL);
882 /* Try to read type 2 */
883 status = ti_vread_sync(serial->serial->dev, UMPC_MEMORY_READ,
884 DTK_ADDR_SPACE_I2C_TYPE_II, 0, data, 0x01);
886 dev_dbg(dev, "%s - read 2 status error = %d\n", __func__, status);
888 dev_dbg(dev, "%s - read 2 data = 0x%x\n", __func__, *data);
889 if ((!status) && (*data == UMP5152 || *data == UMP3410)) {
890 dev_dbg(dev, "%s - ROM_TYPE_II\n", __func__);
891 serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_II;
895 /* Try to read type 3 */
896 status = ti_vread_sync(serial->serial->dev, UMPC_MEMORY_READ,
897 DTK_ADDR_SPACE_I2C_TYPE_III, 0, data, 0x01);
899 dev_dbg(dev, "%s - read 3 status error = %d\n", __func__, status);
901 dev_dbg(dev, "%s - read 2 data = 0x%x\n", __func__, *data);
902 if ((!status) && (*data == UMP5152 || *data == UMP3410)) {
903 dev_dbg(dev, "%s - ROM_TYPE_III\n", __func__);
904 serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_III;
908 dev_dbg(dev, "%s - Unknown\n", __func__);
909 serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_II;
916 static int bulk_xfer(struct usb_serial *serial, void *buffer,
917 int length, int *num_sent)
921 status = usb_bulk_msg(serial->dev,
922 usb_sndbulkpipe(serial->dev,
923 serial->port[0]->bulk_out_endpointAddress),
924 buffer, length, num_sent, 1000);
928 /* Download given firmware image to the device (IN BOOT MODE) */
929 static int download_code(struct edgeport_serial *serial, __u8 *image,
937 /* Transfer firmware image */
938 for (pos = 0; pos < image_length; ) {
939 /* Read the next buffer from file */
940 transfer = image_length - pos;
941 if (transfer > EDGE_FW_BULK_MAX_PACKET_SIZE)
942 transfer = EDGE_FW_BULK_MAX_PACKET_SIZE;
945 status = bulk_xfer(serial->serial, &image[pos],
949 /* Advance buffer pointer */
957 static int config_boot_dev(struct usb_device *dev)
962 static int ti_cpu_rev(struct edge_ti_manuf_descriptor *desc)
964 return TI_GET_CPU_REVISION(desc->CpuRev_BoardRev);
967 static int check_fw_sanity(struct edgeport_serial *serial,
968 const struct firmware *fw)
973 struct device *dev = &serial->serial->interface->dev;
974 struct edgeport_fw_hdr *fw_hdr = (struct edgeport_fw_hdr *)fw->data;
976 if (fw->size < sizeof(struct edgeport_fw_hdr)) {
977 dev_err(dev, "incomplete fw header\n");
981 length_total = le16_to_cpu(fw_hdr->length) +
982 sizeof(struct edgeport_fw_hdr);
984 if (fw->size != length_total) {
985 dev_err(dev, "bad fw size (expected: %u, got: %zu)\n",
986 length_total, fw->size);
990 for (pos = sizeof(struct edgeport_fw_hdr); pos < fw->size; ++pos)
991 checksum += fw->data[pos];
993 if (checksum != fw_hdr->checksum) {
994 dev_err(dev, "bad fw checksum (expected: 0x%x, got: 0x%x)\n",
995 fw_hdr->checksum, checksum);
1003 * DownloadTIFirmware - Download run-time operating firmware to the TI5052
1005 * This routine downloads the main operating code into the TI5052, using the
1006 * boot code already burned into E2PROM or ROM.
1008 static int download_fw(struct edgeport_serial *serial)
1010 struct device *dev = &serial->serial->interface->dev;
1012 struct usb_interface_descriptor *interface;
1013 const struct firmware *fw;
1014 const char *fw_name = "/*(DEBLOBBED)*/";
1015 struct edgeport_fw_hdr *fw_hdr;
1017 status = reject_firmware(&fw, fw_name, dev);
1019 dev_err(dev, "Failed to load image \"%s\" err %d\n",
1024 if (check_fw_sanity(serial, fw)) {
1029 fw_hdr = (struct edgeport_fw_hdr *)fw->data;
1031 /* If on-board version is newer, "fw_version" will be updated later. */
1032 serial->fw_version = (fw_hdr->major_version << 8) +
1033 fw_hdr->minor_version;
1036 * This routine is entered by both the BOOT mode and the Download mode
1037 * We can determine which code is running by the reading the config
1038 * descriptor and if we have only one bulk pipe it is in boot mode
1040 serial->product_info.hardware_type = HARDWARE_TYPE_TIUMP;
1042 /* Default to type 2 i2c */
1043 serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_II;
1045 status = choose_config(serial->serial->dev);
1049 interface = &serial->serial->interface->cur_altsetting->desc;
1051 dev_err(dev, "%s - no interface set, error!\n", __func__);
1057 * Setup initial mode -- the default mode 0 is TI_MODE_CONFIGURING
1058 * if we have more than one endpoint we are definitely in download
1061 if (interface->bNumEndpoints > 1) {
1062 serial->product_info.TiMode = TI_MODE_DOWNLOAD;
1063 status = do_download_mode(serial, fw);
1065 /* Otherwise we will remain in configuring mode */
1066 serial->product_info.TiMode = TI_MODE_CONFIGURING;
1067 status = do_boot_mode(serial, fw);
1071 release_firmware(fw);
1075 static int do_download_mode(struct edgeport_serial *serial,
1076 const struct firmware *fw)
1078 struct device *dev = &serial->serial->interface->dev;
1081 struct edge_ti_manuf_descriptor *ti_manuf_desc;
1082 int download_cur_ver;
1083 int download_new_ver;
1084 struct edgeport_fw_hdr *fw_hdr = (struct edgeport_fw_hdr *)fw->data;
1085 struct ti_i2c_desc *rom_desc;
1087 dev_dbg(dev, "%s - RUNNING IN DOWNLOAD MODE\n", __func__);
1089 status = check_i2c_image(serial);
1091 dev_dbg(dev, "%s - DOWNLOAD MODE -- BAD I2C\n", __func__);
1096 * Validate Hardware version number
1097 * Read Manufacturing Descriptor from TI Based Edgeport
1099 ti_manuf_desc = kmalloc(sizeof(*ti_manuf_desc), GFP_KERNEL);
1103 status = get_manuf_info(serial, (__u8 *)ti_manuf_desc);
1105 kfree(ti_manuf_desc);
1109 /* Check version number of ION descriptor */
1110 if (!ignore_cpu_rev && ti_cpu_rev(ti_manuf_desc) < 2) {
1111 dev_dbg(dev, "%s - Wrong CPU Rev %d (Must be 2)\n",
1112 __func__, ti_cpu_rev(ti_manuf_desc));
1113 kfree(ti_manuf_desc);
1117 rom_desc = kmalloc(sizeof(*rom_desc), GFP_KERNEL);
1119 kfree(ti_manuf_desc);
1123 /* Search for type 2 record (firmware record) */
1124 start_address = get_descriptor_addr(serial,
1125 I2C_DESC_TYPE_FIRMWARE_BASIC, rom_desc);
1126 if (start_address != 0) {
1127 struct ti_i2c_firmware_rec *firmware_version;
1130 dev_dbg(dev, "%s - Found Type FIRMWARE (Type 2) record\n",
1133 firmware_version = kmalloc(sizeof(*firmware_version),
1135 if (!firmware_version) {
1137 kfree(ti_manuf_desc);
1142 * Validate version number
1143 * Read the descriptor data
1145 status = read_rom(serial, start_address +
1146 sizeof(struct ti_i2c_desc),
1147 sizeof(struct ti_i2c_firmware_rec),
1148 (__u8 *)firmware_version);
1150 kfree(firmware_version);
1152 kfree(ti_manuf_desc);
1157 * Check version number of download with current
1160 download_cur_ver = (firmware_version->Ver_Major << 8) +
1161 (firmware_version->Ver_Minor);
1162 download_new_ver = (fw_hdr->major_version << 8) +
1163 (fw_hdr->minor_version);
1165 dev_dbg(dev, "%s - >> FW Versions Device %d.%d Driver %d.%d\n",
1166 __func__, firmware_version->Ver_Major,
1167 firmware_version->Ver_Minor,
1168 fw_hdr->major_version, fw_hdr->minor_version);
1171 * Check if we have an old version in the I2C and
1172 * update if necessary
1174 if (download_cur_ver < download_new_ver) {
1175 dev_dbg(dev, "%s - Update I2C dld from %d.%d to %d.%d\n",
1177 firmware_version->Ver_Major,
1178 firmware_version->Ver_Minor,
1179 fw_hdr->major_version,
1180 fw_hdr->minor_version);
1182 record = kmalloc(1, GFP_KERNEL);
1184 kfree(firmware_version);
1186 kfree(ti_manuf_desc);
1190 * In order to update the I2C firmware we must
1191 * change the type 2 record to type 0xF2. This
1192 * will force the UMP to come up in Boot Mode.
1193 * Then while in boot mode, the driver will
1194 * download the latest firmware (padded to
1195 * 15.5k) into the UMP ram. Finally when the
1196 * device comes back up in download mode the
1197 * driver will cause the new firmware to be
1198 * copied from the UMP Ram to I2C and the
1199 * firmware will update the record type from
1202 *record = I2C_DESC_TYPE_FIRMWARE_BLANK;
1205 * Change the I2C Firmware record type to
1206 * 0xf2 to trigger an update
1208 status = write_rom(serial, start_address,
1209 sizeof(*record), record);
1212 kfree(firmware_version);
1214 kfree(ti_manuf_desc);
1219 * verify the write -- must do this in order
1220 * for write to complete before we do the
1223 status = read_rom(serial,
1229 kfree(firmware_version);
1231 kfree(ti_manuf_desc);
1235 if (*record != I2C_DESC_TYPE_FIRMWARE_BLANK) {
1236 dev_err(dev, "%s - error resetting device\n",
1239 kfree(firmware_version);
1241 kfree(ti_manuf_desc);
1245 dev_dbg(dev, "%s - HARDWARE RESET\n", __func__);
1247 /* Reset UMP -- Back to BOOT MODE */
1248 status = ti_vsend_sync(serial->serial->dev,
1249 UMPC_HARDWARE_RESET,
1251 TI_VSEND_TIMEOUT_DEFAULT);
1253 dev_dbg(dev, "%s - HARDWARE RESET return %d\n",
1256 /* return an error on purpose. */
1258 kfree(firmware_version);
1260 kfree(ti_manuf_desc);
1263 /* Same or newer fw version is already loaded */
1264 serial->fw_version = download_cur_ver;
1265 kfree(firmware_version);
1267 /* Search for type 0xF2 record (firmware blank record) */
1269 start_address = get_descriptor_addr(serial,
1270 I2C_DESC_TYPE_FIRMWARE_BLANK, rom_desc);
1271 if (start_address != 0) {
1272 #define HEADER_SIZE (sizeof(struct ti_i2c_desc) + \
1273 sizeof(struct ti_i2c_firmware_rec))
1277 header = kmalloc(HEADER_SIZE, GFP_KERNEL);
1280 kfree(ti_manuf_desc);
1284 vheader = kmalloc(HEADER_SIZE, GFP_KERNEL);
1288 kfree(ti_manuf_desc);
1292 dev_dbg(dev, "%s - Found Type BLANK FIRMWARE (Type F2) record\n",
1296 * In order to update the I2C firmware we must change
1297 * the type 2 record to type 0xF2. This will force the
1298 * UMP to come up in Boot Mode. Then while in boot
1299 * mode, the driver will download the latest firmware
1300 * (padded to 15.5k) into the UMP ram. Finally when the
1301 * device comes back up in download mode the driver
1302 * will cause the new firmware to be copied from the
1303 * UMP Ram to I2C and the firmware will update the
1304 * record type from 0xf2 to 0x02.
1306 status = build_i2c_fw_hdr(header, fw);
1311 kfree(ti_manuf_desc);
1316 * Update I2C with type 0xf2 record with correct
1319 status = write_rom(serial,
1327 kfree(ti_manuf_desc);
1332 * verify the write -- must do this in order for
1333 * write to complete before we do the hardware reset
1335 status = read_rom(serial, start_address,
1336 HEADER_SIZE, vheader);
1339 dev_dbg(dev, "%s - can't read header back\n",
1344 kfree(ti_manuf_desc);
1347 if (memcmp(vheader, header, HEADER_SIZE)) {
1348 dev_dbg(dev, "%s - write download record failed\n",
1353 kfree(ti_manuf_desc);
1360 dev_dbg(dev, "%s - Start firmware update\n", __func__);
1362 /* Tell firmware to copy download image into I2C */
1363 status = ti_vsend_sync(serial->serial->dev,
1364 UMPC_COPY_DNLD_TO_I2C,
1366 TI_VSEND_TIMEOUT_FW_DOWNLOAD);
1368 dev_dbg(dev, "%s - Update complete 0x%x\n", __func__,
1372 "%s - UMPC_COPY_DNLD_TO_I2C failed\n",
1375 kfree(ti_manuf_desc);
1381 /* The device is running the download code */
1383 kfree(ti_manuf_desc);
1387 static int do_boot_mode(struct edgeport_serial *serial,
1388 const struct firmware *fw)
1390 struct device *dev = &serial->serial->interface->dev;
1392 struct edge_ti_manuf_descriptor *ti_manuf_desc;
1393 struct edgeport_fw_hdr *fw_hdr = (struct edgeport_fw_hdr *)fw->data;
1395 dev_dbg(dev, "%s - RUNNING IN BOOT MODE\n", __func__);
1397 /* Configure the TI device so we can use the BULK pipes for download */
1398 status = config_boot_dev(serial->serial->dev);
1402 if (le16_to_cpu(serial->serial->dev->descriptor.idVendor)
1403 != USB_VENDOR_ID_ION) {
1404 dev_dbg(dev, "%s - VID = 0x%x\n", __func__,
1405 le16_to_cpu(serial->serial->dev->descriptor.idVendor));
1406 serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_II;
1407 goto stayinbootmode;
1411 * We have an ION device (I2c Must be programmed)
1412 * Determine I2C image type
1414 if (i2c_type_bootmode(serial))
1415 goto stayinbootmode;
1417 /* Check for ION Vendor ID and that the I2C is valid */
1418 if (!check_i2c_image(serial)) {
1419 struct ti_i2c_image_header *header;
1426 * Validate Hardware version number
1427 * Read Manufacturing Descriptor from TI Based Edgeport
1429 ti_manuf_desc = kmalloc(sizeof(*ti_manuf_desc), GFP_KERNEL);
1433 status = get_manuf_info(serial, (__u8 *)ti_manuf_desc);
1435 kfree(ti_manuf_desc);
1436 goto stayinbootmode;
1439 /* Check for version 2 */
1440 if (!ignore_cpu_rev && ti_cpu_rev(ti_manuf_desc) < 2) {
1441 dev_dbg(dev, "%s - Wrong CPU Rev %d (Must be 2)\n",
1442 __func__, ti_cpu_rev(ti_manuf_desc));
1443 kfree(ti_manuf_desc);
1444 goto stayinbootmode;
1447 kfree(ti_manuf_desc);
1450 * In order to update the I2C firmware we must change the type
1451 * 2 record to type 0xF2. This will force the UMP to come up
1452 * in Boot Mode. Then while in boot mode, the driver will
1453 * download the latest firmware (padded to 15.5k) into the
1454 * UMP ram. Finally when the device comes back up in download
1455 * mode the driver will cause the new firmware to be copied
1456 * from the UMP Ram to I2C and the firmware will update the
1457 * record type from 0xf2 to 0x02.
1459 * Do we really have to copy the whole firmware image,
1460 * or could we do this in place!
1463 /* Allocate a 15.5k buffer + 3 byte header */
1464 buffer_size = (((1024 * 16) - 512) +
1465 sizeof(struct ti_i2c_image_header));
1466 buffer = kmalloc(buffer_size, GFP_KERNEL);
1470 /* Initialize the buffer to 0xff (pad the buffer) */
1471 memset(buffer, 0xff, buffer_size);
1472 memcpy(buffer, &fw->data[4], fw->size - 4);
1474 for (i = sizeof(struct ti_i2c_image_header);
1475 i < buffer_size; i++) {
1476 cs = (__u8)(cs + buffer[i]);
1479 header = (struct ti_i2c_image_header *)buffer;
1481 /* update length and checksum after padding */
1482 header->Length = cpu_to_le16((__u16)(buffer_size -
1483 sizeof(struct ti_i2c_image_header)));
1484 header->CheckSum = cs;
1486 /* Download the operational code */
1487 dev_dbg(dev, "%s - Downloading operational code image version %d.%d (TI UMP)\n",
1489 fw_hdr->major_version, fw_hdr->minor_version);
1490 status = download_code(serial, buffer, buffer_size);
1495 dev_dbg(dev, "%s - Error downloading operational code image\n", __func__);
1499 /* Device will reboot */
1500 serial->product_info.TiMode = TI_MODE_TRANSITIONING;
1502 dev_dbg(dev, "%s - Download successful -- Device rebooting...\n", __func__);
1508 /* Eprom is invalid or blank stay in boot mode */
1509 dev_dbg(dev, "%s - STAYING IN BOOT MODE\n", __func__);
1510 serial->product_info.TiMode = TI_MODE_BOOT;
1515 static int ti_do_config(struct edgeport_port *port, int feature, int on)
1517 int port_number = port->port->port_number;
1519 on = !!on; /* 1 or 0 not bitmask */
1520 return send_cmd(port->port->serial->dev,
1521 feature, (__u8)(UMPM_UART1_PORT + port_number),
1525 static int restore_mcr(struct edgeport_port *port, __u8 mcr)
1529 dev_dbg(&port->port->dev, "%s - %x\n", __func__, mcr);
1531 status = ti_do_config(port, UMPC_SET_CLR_DTR, mcr & MCR_DTR);
1534 status = ti_do_config(port, UMPC_SET_CLR_RTS, mcr & MCR_RTS);
1537 return ti_do_config(port, UMPC_SET_CLR_LOOPBACK, mcr & MCR_LOOPBACK);
1540 /* Convert TI LSR to standard UART flags */
1541 static __u8 map_line_status(__u8 ti_lsr)
1545 #define MAP_FLAG(flagUmp, flagUart) \
1546 if (ti_lsr & flagUmp) \
1549 MAP_FLAG(UMP_UART_LSR_OV_MASK, LSR_OVER_ERR) /* overrun */
1550 MAP_FLAG(UMP_UART_LSR_PE_MASK, LSR_PAR_ERR) /* parity error */
1551 MAP_FLAG(UMP_UART_LSR_FE_MASK, LSR_FRM_ERR) /* framing error */
1552 MAP_FLAG(UMP_UART_LSR_BR_MASK, LSR_BREAK) /* break detected */
1553 MAP_FLAG(UMP_UART_LSR_RX_MASK, LSR_RX_AVAIL) /* rx data available */
1554 MAP_FLAG(UMP_UART_LSR_TX_MASK, LSR_TX_EMPTY) /* tx hold reg empty */
1561 static void handle_new_msr(struct edgeport_port *edge_port, __u8 msr)
1563 struct async_icount *icount;
1564 struct tty_struct *tty;
1566 dev_dbg(&edge_port->port->dev, "%s - %02x\n", __func__, msr);
1568 if (msr & (EDGEPORT_MSR_DELTA_CTS | EDGEPORT_MSR_DELTA_DSR |
1569 EDGEPORT_MSR_DELTA_RI | EDGEPORT_MSR_DELTA_CD)) {
1570 icount = &edge_port->port->icount;
1572 /* update input line counters */
1573 if (msr & EDGEPORT_MSR_DELTA_CTS)
1575 if (msr & EDGEPORT_MSR_DELTA_DSR)
1577 if (msr & EDGEPORT_MSR_DELTA_CD)
1579 if (msr & EDGEPORT_MSR_DELTA_RI)
1581 wake_up_interruptible(&edge_port->port->port.delta_msr_wait);
1584 /* Save the new modem status */
1585 edge_port->shadow_msr = msr & 0xf0;
1587 tty = tty_port_tty_get(&edge_port->port->port);
1588 /* handle CTS flow control */
1589 if (tty && C_CRTSCTS(tty)) {
1590 if (msr & EDGEPORT_MSR_CTS)
1596 static void handle_new_lsr(struct edgeport_port *edge_port, int lsr_data,
1597 __u8 lsr, __u8 data)
1599 struct async_icount *icount;
1600 __u8 new_lsr = (__u8)(lsr & (__u8)(LSR_OVER_ERR | LSR_PAR_ERR |
1601 LSR_FRM_ERR | LSR_BREAK));
1603 dev_dbg(&edge_port->port->dev, "%s - %02x\n", __func__, new_lsr);
1605 edge_port->shadow_lsr = lsr;
1607 if (new_lsr & LSR_BREAK)
1609 * Parity and Framing errors only count if they
1610 * occur exclusive of a break being received.
1612 new_lsr &= (__u8)(LSR_OVER_ERR | LSR_BREAK);
1614 /* Place LSR data byte into Rx buffer */
1616 edge_tty_recv(edge_port->port, &data, 1);
1618 /* update input line counters */
1619 icount = &edge_port->port->icount;
1620 if (new_lsr & LSR_BREAK)
1622 if (new_lsr & LSR_OVER_ERR)
1624 if (new_lsr & LSR_PAR_ERR)
1626 if (new_lsr & LSR_FRM_ERR)
1630 static void edge_interrupt_callback(struct urb *urb)
1632 struct edgeport_serial *edge_serial = urb->context;
1633 struct usb_serial_port *port;
1634 struct edgeport_port *edge_port;
1636 unsigned char *data = urb->transfer_buffer;
1637 int length = urb->actual_length;
1643 int status = urb->status;
1652 /* this urb is terminated, clean up */
1653 dev_dbg(&urb->dev->dev, "%s - urb shutting down with status: %d\n",
1657 dev_err(&urb->dev->dev, "%s - nonzero urb status received: "
1658 "%d\n", __func__, status);
1663 dev_dbg(&urb->dev->dev, "%s - no data in urb\n", __func__);
1667 dev = &edge_serial->serial->dev->dev;
1668 usb_serial_debug_data(dev, __func__, length, data);
1671 dev_dbg(dev, "%s - expecting packet of size 2, got %d\n", __func__, length);
1675 port_number = TIUMP_GET_PORT_FROM_CODE(data[0]);
1676 function = TIUMP_GET_FUNC_FROM_CODE(data[0]);
1677 dev_dbg(dev, "%s - port_number %d, function %d, info 0x%x\n", __func__,
1678 port_number, function, data[1]);
1680 if (port_number >= edge_serial->serial->num_ports) {
1681 dev_err(dev, "bad port number %d\n", port_number);
1685 port = edge_serial->serial->port[port_number];
1686 edge_port = usb_get_serial_port_data(port);
1688 dev_dbg(dev, "%s - edge_port not found\n", __func__);
1692 case TIUMP_INTERRUPT_CODE_LSR:
1693 lsr = map_line_status(data[1]);
1694 if (lsr & UMP_UART_LSR_DATA_MASK) {
1696 * Save the LSR event for bulk read completion routine
1698 dev_dbg(dev, "%s - LSR Event Port %u LSR Status = %02x\n",
1699 __func__, port_number, lsr);
1700 edge_port->lsr_event = 1;
1701 edge_port->lsr_mask = lsr;
1703 dev_dbg(dev, "%s - ===== Port %d LSR Status = %02x ======\n",
1704 __func__, port_number, lsr);
1705 handle_new_lsr(edge_port, 0, lsr, 0);
1709 case TIUMP_INTERRUPT_CODE_MSR: /* MSR */
1710 /* Copy MSR from UMP */
1712 dev_dbg(dev, "%s - ===== Port %u MSR Status = %02x ======\n",
1713 __func__, port_number, msr);
1714 handle_new_msr(edge_port, msr);
1718 dev_err(&urb->dev->dev,
1719 "%s - Unknown Interrupt code from UMP %x\n",
1726 retval = usb_submit_urb(urb, GFP_ATOMIC);
1728 dev_err(&urb->dev->dev,
1729 "%s - usb_submit_urb failed with result %d\n",
1733 static void edge_bulk_in_callback(struct urb *urb)
1735 struct edgeport_port *edge_port = urb->context;
1736 struct device *dev = &edge_port->port->dev;
1737 unsigned char *data = urb->transfer_buffer;
1740 int status = urb->status;
1749 /* this urb is terminated, clean up */
1750 dev_dbg(&urb->dev->dev, "%s - urb shutting down with status: %d\n", __func__, status);
1753 dev_err(&urb->dev->dev, "%s - nonzero read bulk status received: %d\n", __func__, status);
1756 if (status == -EPIPE)
1760 dev_err(&urb->dev->dev, "%s - stopping read!\n", __func__);
1764 port_number = edge_port->port->port_number;
1766 if (urb->actual_length > 0 && edge_port->lsr_event) {
1767 edge_port->lsr_event = 0;
1768 dev_dbg(dev, "%s ===== Port %u LSR Status = %02x, Data = %02x ======\n",
1769 __func__, port_number, edge_port->lsr_mask, *data);
1770 handle_new_lsr(edge_port, 1, edge_port->lsr_mask, *data);
1771 /* Adjust buffer length/pointer */
1772 --urb->actual_length;
1776 if (urb->actual_length) {
1777 usb_serial_debug_data(dev, __func__, urb->actual_length, data);
1778 if (edge_port->close_pending)
1779 dev_dbg(dev, "%s - close pending, dropping data on the floor\n",
1782 edge_tty_recv(edge_port->port, data,
1783 urb->actual_length);
1784 edge_port->port->icount.rx += urb->actual_length;
1788 /* continue read unless stopped */
1789 spin_lock(&edge_port->ep_lock);
1790 if (edge_port->ep_read_urb_state == EDGE_READ_URB_RUNNING)
1791 retval = usb_submit_urb(urb, GFP_ATOMIC);
1792 else if (edge_port->ep_read_urb_state == EDGE_READ_URB_STOPPING)
1793 edge_port->ep_read_urb_state = EDGE_READ_URB_STOPPED;
1795 spin_unlock(&edge_port->ep_lock);
1797 dev_err(dev, "%s - usb_submit_urb failed with result %d\n", __func__, retval);
1800 static void edge_tty_recv(struct usb_serial_port *port, unsigned char *data,
1805 queued = tty_insert_flip_string(&port->port, data, length);
1806 if (queued < length)
1807 dev_err(&port->dev, "%s - dropping data, %d bytes lost\n",
1808 __func__, length - queued);
1809 tty_flip_buffer_push(&port->port);
1812 static void edge_bulk_out_callback(struct urb *urb)
1814 struct usb_serial_port *port = urb->context;
1815 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1816 int status = urb->status;
1817 struct tty_struct *tty;
1819 edge_port->ep_write_urb_in_use = 0;
1828 /* this urb is terminated, clean up */
1829 dev_dbg(&urb->dev->dev, "%s - urb shutting down with status: %d\n",
1833 dev_err_console(port, "%s - nonzero write bulk status "
1834 "received: %d\n", __func__, status);
1837 /* send any buffered data */
1838 tty = tty_port_tty_get(&port->port);
1839 edge_send(port, tty);
1843 static int edge_open(struct tty_struct *tty, struct usb_serial_port *port)
1845 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1846 struct edgeport_serial *edge_serial;
1847 struct usb_device *dev;
1852 u8 transaction_timeout;
1854 if (edge_port == NULL)
1857 port_number = port->port_number;
1859 dev = port->serial->dev;
1861 /* turn off loopback */
1862 status = ti_do_config(edge_port, UMPC_SET_CLR_LOOPBACK, 0);
1865 "%s - cannot send clear loopback command, %d\n",
1870 /* set up the port settings */
1872 edge_set_termios(tty, port, &tty->termios);
1874 /* open up the port */
1876 /* milliseconds to timeout for DMA transfer */
1877 transaction_timeout = 2;
1879 edge_port->ump_read_timeout =
1880 max(20, ((transaction_timeout * 3) / 2));
1882 /* milliseconds to timeout for DMA transfer */
1883 open_settings = (u8)(UMP_DMA_MODE_CONTINOUS |
1884 UMP_PIPE_TRANS_TIMEOUT_ENA |
1885 (transaction_timeout << 2));
1887 dev_dbg(&port->dev, "%s - Sending UMPC_OPEN_PORT\n", __func__);
1889 /* Tell TI to open and start the port */
1890 status = send_cmd(dev, UMPC_OPEN_PORT,
1891 (u8)(UMPM_UART1_PORT + port_number), open_settings, NULL, 0);
1893 dev_err(&port->dev, "%s - cannot send open command, %d\n",
1898 /* Start the DMA? */
1899 status = send_cmd(dev, UMPC_START_PORT,
1900 (u8)(UMPM_UART1_PORT + port_number), 0, NULL, 0);
1902 dev_err(&port->dev, "%s - cannot send start DMA command, %d\n",
1907 /* Clear TX and RX buffers in UMP */
1908 status = purge_port(port, UMP_PORT_DIR_OUT | UMP_PORT_DIR_IN);
1911 "%s - cannot send clear buffers command, %d\n",
1916 /* Read Initial MSR */
1917 status = ti_vread_sync(dev, UMPC_READ_MSR, 0,
1918 (__u16)(UMPM_UART1_PORT + port_number),
1919 &edge_port->shadow_msr, 1);
1921 dev_err(&port->dev, "%s - cannot send read MSR command, %d\n",
1926 dev_dbg(&port->dev, "ShadowMSR 0x%X\n", edge_port->shadow_msr);
1928 /* Set Initial MCR */
1929 edge_port->shadow_mcr = MCR_RTS | MCR_DTR;
1930 dev_dbg(&port->dev, "ShadowMCR 0x%X\n", edge_port->shadow_mcr);
1932 edge_serial = edge_port->edge_serial;
1933 if (mutex_lock_interruptible(&edge_serial->es_lock))
1934 return -ERESTARTSYS;
1935 if (edge_serial->num_ports_open == 0) {
1936 /* we are the first port to open, post the interrupt urb */
1937 urb = edge_serial->serial->port[0]->interrupt_in_urb;
1940 "%s - no interrupt urb present, exiting\n",
1943 goto release_es_lock;
1945 urb->context = edge_serial;
1946 status = usb_submit_urb(urb, GFP_KERNEL);
1949 "%s - usb_submit_urb failed with value %d\n",
1951 goto release_es_lock;
1956 * reset the data toggle on the bulk endpoints to work around bug in
1957 * host controllers where things get out of sync some times
1959 usb_clear_halt(dev, port->write_urb->pipe);
1960 usb_clear_halt(dev, port->read_urb->pipe);
1962 /* start up our bulk read urb */
1963 urb = port->read_urb;
1965 dev_err(&port->dev, "%s - no read urb present, exiting\n",
1968 goto unlink_int_urb;
1970 edge_port->ep_read_urb_state = EDGE_READ_URB_RUNNING;
1971 urb->context = edge_port;
1972 status = usb_submit_urb(urb, GFP_KERNEL);
1975 "%s - read bulk usb_submit_urb failed with value %d\n",
1977 goto unlink_int_urb;
1980 ++edge_serial->num_ports_open;
1982 goto release_es_lock;
1985 if (edge_port->edge_serial->num_ports_open == 0)
1986 usb_kill_urb(port->serial->port[0]->interrupt_in_urb);
1988 mutex_unlock(&edge_serial->es_lock);
1992 static void edge_close(struct usb_serial_port *port)
1994 struct edgeport_serial *edge_serial;
1995 struct edgeport_port *edge_port;
1996 struct usb_serial *serial = port->serial;
1997 unsigned long flags;
2000 edge_serial = usb_get_serial_data(port->serial);
2001 edge_port = usb_get_serial_port_data(port);
2002 if (edge_serial == NULL || edge_port == NULL)
2006 * The bulkreadcompletion routine will check
2007 * this flag and dump add read data
2009 edge_port->close_pending = 1;
2011 usb_kill_urb(port->read_urb);
2012 usb_kill_urb(port->write_urb);
2013 edge_port->ep_write_urb_in_use = 0;
2014 spin_lock_irqsave(&edge_port->ep_lock, flags);
2015 kfifo_reset_out(&port->write_fifo);
2016 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2018 dev_dbg(&port->dev, "%s - send umpc_close_port\n", __func__);
2019 port_number = port->port_number;
2020 send_cmd(serial->dev, UMPC_CLOSE_PORT,
2021 (__u8)(UMPM_UART1_PORT + port_number), 0, NULL, 0);
2023 mutex_lock(&edge_serial->es_lock);
2024 --edge_port->edge_serial->num_ports_open;
2025 if (edge_port->edge_serial->num_ports_open <= 0) {
2026 /* last port is now closed, let's shut down our interrupt urb */
2027 usb_kill_urb(port->serial->port[0]->interrupt_in_urb);
2028 edge_port->edge_serial->num_ports_open = 0;
2030 mutex_unlock(&edge_serial->es_lock);
2031 edge_port->close_pending = 0;
2034 static int edge_write(struct tty_struct *tty, struct usb_serial_port *port,
2035 const unsigned char *data, int count)
2037 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2040 dev_dbg(&port->dev, "%s - write request of 0 bytes\n", __func__);
2044 if (edge_port == NULL)
2046 if (edge_port->close_pending == 1)
2049 count = kfifo_in_locked(&port->write_fifo, data, count,
2050 &edge_port->ep_lock);
2051 edge_send(port, tty);
2056 static void edge_send(struct usb_serial_port *port, struct tty_struct *tty)
2059 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2060 unsigned long flags;
2062 spin_lock_irqsave(&edge_port->ep_lock, flags);
2064 if (edge_port->ep_write_urb_in_use) {
2065 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2069 count = kfifo_out(&port->write_fifo,
2070 port->write_urb->transfer_buffer,
2071 port->bulk_out_size);
2074 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2078 edge_port->ep_write_urb_in_use = 1;
2080 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2082 usb_serial_debug_data(&port->dev, __func__, count, port->write_urb->transfer_buffer);
2084 /* set up our urb */
2085 port->write_urb->transfer_buffer_length = count;
2087 /* send the data out the bulk port */
2088 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
2090 dev_err_console(port,
2091 "%s - failed submitting write urb, error %d\n",
2093 edge_port->ep_write_urb_in_use = 0;
2094 /* TODO: reschedule edge_send */
2096 edge_port->port->icount.tx += count;
2099 * wakeup any process waiting for writes to complete
2100 * there is now more room in the buffer for new writes
2106 static int edge_write_room(struct tty_struct *tty)
2108 struct usb_serial_port *port = tty->driver_data;
2109 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2111 unsigned long flags;
2113 if (edge_port == NULL)
2115 if (edge_port->close_pending == 1)
2118 spin_lock_irqsave(&edge_port->ep_lock, flags);
2119 room = kfifo_avail(&port->write_fifo);
2120 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2122 dev_dbg(&port->dev, "%s - returns %d\n", __func__, room);
2126 static int edge_chars_in_buffer(struct tty_struct *tty)
2128 struct usb_serial_port *port = tty->driver_data;
2129 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2131 unsigned long flags;
2132 if (edge_port == NULL)
2135 spin_lock_irqsave(&edge_port->ep_lock, flags);
2136 chars = kfifo_len(&port->write_fifo);
2137 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2139 dev_dbg(&port->dev, "%s - returns %d\n", __func__, chars);
2143 static bool edge_tx_empty(struct usb_serial_port *port)
2145 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2148 ret = tx_active(edge_port);
2155 static void edge_throttle(struct tty_struct *tty)
2157 struct usb_serial_port *port = tty->driver_data;
2158 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2161 if (edge_port == NULL)
2164 /* if we are implementing XON/XOFF, send the stop character */
2166 unsigned char stop_char = STOP_CHAR(tty);
2167 status = edge_write(tty, port, &stop_char, 1);
2169 dev_err(&port->dev, "%s - failed to write stop character, %d\n", __func__, status);
2174 * if we are implementing RTS/CTS, stop reads
2175 * and the Edgeport will clear the RTS line
2178 stop_read(edge_port);
2182 static void edge_unthrottle(struct tty_struct *tty)
2184 struct usb_serial_port *port = tty->driver_data;
2185 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2188 if (edge_port == NULL)
2191 /* if we are implementing XON/XOFF, send the start character */
2193 unsigned char start_char = START_CHAR(tty);
2194 status = edge_write(tty, port, &start_char, 1);
2196 dev_err(&port->dev, "%s - failed to write start character, %d\n", __func__, status);
2200 * if we are implementing RTS/CTS, restart reads
2201 * are the Edgeport will assert the RTS line
2203 if (C_CRTSCTS(tty)) {
2204 status = restart_read(edge_port);
2207 "%s - read bulk usb_submit_urb failed: %d\n",
2213 static void stop_read(struct edgeport_port *edge_port)
2215 unsigned long flags;
2217 spin_lock_irqsave(&edge_port->ep_lock, flags);
2219 if (edge_port->ep_read_urb_state == EDGE_READ_URB_RUNNING)
2220 edge_port->ep_read_urb_state = EDGE_READ_URB_STOPPING;
2221 edge_port->shadow_mcr &= ~MCR_RTS;
2223 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2226 static int restart_read(struct edgeport_port *edge_port)
2230 unsigned long flags;
2232 spin_lock_irqsave(&edge_port->ep_lock, flags);
2234 if (edge_port->ep_read_urb_state == EDGE_READ_URB_STOPPED) {
2235 urb = edge_port->port->read_urb;
2236 status = usb_submit_urb(urb, GFP_ATOMIC);
2238 edge_port->ep_read_urb_state = EDGE_READ_URB_RUNNING;
2239 edge_port->shadow_mcr |= MCR_RTS;
2241 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2246 static void change_port_settings(struct tty_struct *tty,
2247 struct edgeport_port *edge_port, struct ktermios *old_termios)
2249 struct device *dev = &edge_port->port->dev;
2250 struct ump_uart_config *config;
2254 int port_number = edge_port->port->port_number;
2256 config = kmalloc (sizeof (*config), GFP_KERNEL);
2258 tty->termios = *old_termios;
2262 cflag = tty->termios.c_cflag;
2266 /* These flags must be set */
2267 config->wFlags |= UMP_MASK_UART_FLAGS_RECEIVE_MS_INT;
2268 config->wFlags |= UMP_MASK_UART_FLAGS_AUTO_START_ON_ERR;
2269 config->bUartMode = (__u8)(edge_port->bUartMode);
2271 switch (cflag & CSIZE) {
2273 config->bDataBits = UMP_UART_CHAR5BITS;
2274 dev_dbg(dev, "%s - data bits = 5\n", __func__);
2277 config->bDataBits = UMP_UART_CHAR6BITS;
2278 dev_dbg(dev, "%s - data bits = 6\n", __func__);
2281 config->bDataBits = UMP_UART_CHAR7BITS;
2282 dev_dbg(dev, "%s - data bits = 7\n", __func__);
2286 config->bDataBits = UMP_UART_CHAR8BITS;
2287 dev_dbg(dev, "%s - data bits = 8\n", __func__);
2291 if (cflag & PARENB) {
2292 if (cflag & PARODD) {
2293 config->wFlags |= UMP_MASK_UART_FLAGS_PARITY;
2294 config->bParity = UMP_UART_ODDPARITY;
2295 dev_dbg(dev, "%s - parity = odd\n", __func__);
2297 config->wFlags |= UMP_MASK_UART_FLAGS_PARITY;
2298 config->bParity = UMP_UART_EVENPARITY;
2299 dev_dbg(dev, "%s - parity = even\n", __func__);
2302 config->bParity = UMP_UART_NOPARITY;
2303 dev_dbg(dev, "%s - parity = none\n", __func__);
2306 if (cflag & CSTOPB) {
2307 config->bStopBits = UMP_UART_STOPBIT2;
2308 dev_dbg(dev, "%s - stop bits = 2\n", __func__);
2310 config->bStopBits = UMP_UART_STOPBIT1;
2311 dev_dbg(dev, "%s - stop bits = 1\n", __func__);
2314 /* figure out the flow control settings */
2315 if (cflag & CRTSCTS) {
2316 config->wFlags |= UMP_MASK_UART_FLAGS_OUT_X_CTS_FLOW;
2317 config->wFlags |= UMP_MASK_UART_FLAGS_RTS_FLOW;
2318 dev_dbg(dev, "%s - RTS/CTS is enabled\n", __func__);
2320 dev_dbg(dev, "%s - RTS/CTS is disabled\n", __func__);
2321 restart_read(edge_port);
2325 * if we are implementing XON/XOFF, set the start and stop
2326 * character in the device
2328 config->cXon = START_CHAR(tty);
2329 config->cXoff = STOP_CHAR(tty);
2331 /* if we are implementing INBOUND XON/XOFF */
2333 config->wFlags |= UMP_MASK_UART_FLAGS_IN_X;
2334 dev_dbg(dev, "%s - INBOUND XON/XOFF is enabled, XON = %2x, XOFF = %2x\n",
2335 __func__, config->cXon, config->cXoff);
2337 dev_dbg(dev, "%s - INBOUND XON/XOFF is disabled\n", __func__);
2339 /* if we are implementing OUTBOUND XON/XOFF */
2341 config->wFlags |= UMP_MASK_UART_FLAGS_OUT_X;
2342 dev_dbg(dev, "%s - OUTBOUND XON/XOFF is enabled, XON = %2x, XOFF = %2x\n",
2343 __func__, config->cXon, config->cXoff);
2345 dev_dbg(dev, "%s - OUTBOUND XON/XOFF is disabled\n", __func__);
2347 tty->termios.c_cflag &= ~CMSPAR;
2349 /* Round the baud rate */
2350 baud = tty_get_baud_rate(tty);
2352 /* pick a default, any default... */
2355 /* Avoid a zero divisor. */
2356 baud = min(baud, 461550);
2357 tty_encode_baud_rate(tty, baud, baud);
2360 edge_port->baud_rate = baud;
2361 config->wBaudRate = (__u16)((461550L + baud/2) / baud);
2363 /* FIXME: Recompute actual baud from divisor here */
2365 dev_dbg(dev, "%s - baud rate = %d, wBaudRate = %d\n", __func__, baud, config->wBaudRate);
2367 dev_dbg(dev, "wBaudRate: %d\n", (int)(461550L / config->wBaudRate));
2368 dev_dbg(dev, "wFlags: 0x%x\n", config->wFlags);
2369 dev_dbg(dev, "bDataBits: %d\n", config->bDataBits);
2370 dev_dbg(dev, "bParity: %d\n", config->bParity);
2371 dev_dbg(dev, "bStopBits: %d\n", config->bStopBits);
2372 dev_dbg(dev, "cXon: %d\n", config->cXon);
2373 dev_dbg(dev, "cXoff: %d\n", config->cXoff);
2374 dev_dbg(dev, "bUartMode: %d\n", config->bUartMode);
2376 /* move the word values into big endian mode */
2377 cpu_to_be16s(&config->wFlags);
2378 cpu_to_be16s(&config->wBaudRate);
2380 status = send_cmd(edge_port->port->serial->dev, UMPC_SET_CONFIG,
2381 (__u8)(UMPM_UART1_PORT + port_number),
2382 0, (__u8 *)config, sizeof(*config));
2384 dev_dbg(dev, "%s - error %d when trying to write config to device\n",
2389 static void edge_set_termios(struct tty_struct *tty,
2390 struct usb_serial_port *port, struct ktermios *old_termios)
2392 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2395 cflag = tty->termios.c_cflag;
2397 dev_dbg(&port->dev, "%s - clfag %08x iflag %08x\n", __func__,
2398 tty->termios.c_cflag, tty->termios.c_iflag);
2399 dev_dbg(&port->dev, "%s - old clfag %08x old iflag %08x\n", __func__,
2400 old_termios->c_cflag, old_termios->c_iflag);
2402 if (edge_port == NULL)
2404 /* change the port settings to the new ones specified */
2405 change_port_settings(tty, edge_port, old_termios);
2408 static int edge_tiocmset(struct tty_struct *tty,
2409 unsigned int set, unsigned int clear)
2411 struct usb_serial_port *port = tty->driver_data;
2412 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2414 unsigned long flags;
2416 spin_lock_irqsave(&edge_port->ep_lock, flags);
2417 mcr = edge_port->shadow_mcr;
2418 if (set & TIOCM_RTS)
2420 if (set & TIOCM_DTR)
2422 if (set & TIOCM_LOOP)
2423 mcr |= MCR_LOOPBACK;
2425 if (clear & TIOCM_RTS)
2427 if (clear & TIOCM_DTR)
2429 if (clear & TIOCM_LOOP)
2430 mcr &= ~MCR_LOOPBACK;
2432 edge_port->shadow_mcr = mcr;
2433 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2435 restore_mcr(edge_port, mcr);
2439 static int edge_tiocmget(struct tty_struct *tty)
2441 struct usb_serial_port *port = tty->driver_data;
2442 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2443 unsigned int result = 0;
2446 unsigned long flags;
2448 spin_lock_irqsave(&edge_port->ep_lock, flags);
2450 msr = edge_port->shadow_msr;
2451 mcr = edge_port->shadow_mcr;
2452 result = ((mcr & MCR_DTR) ? TIOCM_DTR: 0) /* 0x002 */
2453 | ((mcr & MCR_RTS) ? TIOCM_RTS: 0) /* 0x004 */
2454 | ((msr & EDGEPORT_MSR_CTS) ? TIOCM_CTS: 0) /* 0x020 */
2455 | ((msr & EDGEPORT_MSR_CD) ? TIOCM_CAR: 0) /* 0x040 */
2456 | ((msr & EDGEPORT_MSR_RI) ? TIOCM_RI: 0) /* 0x080 */
2457 | ((msr & EDGEPORT_MSR_DSR) ? TIOCM_DSR: 0); /* 0x100 */
2460 dev_dbg(&port->dev, "%s -- %x\n", __func__, result);
2461 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2466 static int get_serial_info(struct edgeport_port *edge_port,
2467 struct serial_struct __user *retinfo)
2469 struct serial_struct tmp;
2475 cwait = edge_port->port->port.closing_wait;
2476 if (cwait != ASYNC_CLOSING_WAIT_NONE)
2477 cwait = jiffies_to_msecs(cwait) / 10;
2479 memset(&tmp, 0, sizeof(tmp));
2481 tmp.type = PORT_16550A;
2482 tmp.line = edge_port->port->minor;
2483 tmp.port = edge_port->port->port_number;
2485 tmp.flags = ASYNC_SKIP_TEST | ASYNC_AUTO_IRQ;
2486 tmp.xmit_fifo_size = edge_port->port->bulk_out_size;
2487 tmp.baud_base = 9600;
2488 tmp.close_delay = 5*HZ;
2489 tmp.closing_wait = cwait;
2491 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
2496 static int edge_ioctl(struct tty_struct *tty,
2497 unsigned int cmd, unsigned long arg)
2499 struct usb_serial_port *port = tty->driver_data;
2500 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2504 dev_dbg(&port->dev, "%s - TIOCGSERIAL\n", __func__);
2505 return get_serial_info(edge_port,
2506 (struct serial_struct __user *) arg);
2508 return -ENOIOCTLCMD;
2511 static void edge_break(struct tty_struct *tty, int break_state)
2513 struct usb_serial_port *port = tty->driver_data;
2514 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2516 int bv = 0; /* Off */
2518 if (break_state == -1)
2520 status = ti_do_config(edge_port, UMPC_SET_CLR_BREAK, bv);
2522 dev_dbg(&port->dev, "%s - error %d sending break set/clear command.\n",
2526 static void edge_heartbeat_schedule(struct edgeport_serial *edge_serial)
2528 if (!edge_serial->use_heartbeat)
2531 schedule_delayed_work(&edge_serial->heartbeat_work,
2532 FW_HEARTBEAT_SECS * HZ);
2535 static void edge_heartbeat_work(struct work_struct *work)
2537 struct edgeport_serial *serial;
2538 struct ti_i2c_desc *rom_desc;
2540 serial = container_of(work, struct edgeport_serial,
2541 heartbeat_work.work);
2543 rom_desc = kmalloc(sizeof(*rom_desc), GFP_KERNEL);
2545 /* Descriptor address request is enough to reset the firmware timer */
2546 if (!rom_desc || !get_descriptor_addr(serial, I2C_DESC_TYPE_ION,
2548 dev_err(&serial->serial->interface->dev,
2549 "%s - Incomplete heartbeat\n", __func__);
2553 edge_heartbeat_schedule(serial);
2556 static int edge_startup(struct usb_serial *serial)
2558 struct edgeport_serial *edge_serial;
2562 /* Make sure we have the required endpoints when in download mode. */
2563 if (serial->interface->cur_altsetting->desc.bNumEndpoints > 1) {
2564 if (serial->num_bulk_in < serial->num_ports ||
2565 serial->num_bulk_out < serial->num_ports)
2569 /* create our private serial structure */
2570 edge_serial = kzalloc(sizeof(struct edgeport_serial), GFP_KERNEL);
2574 mutex_init(&edge_serial->es_lock);
2575 edge_serial->serial = serial;
2576 INIT_DELAYED_WORK(&edge_serial->heartbeat_work, edge_heartbeat_work);
2577 usb_set_serial_data(serial, edge_serial);
2579 status = download_fw(edge_serial);
2586 return 1; /* bind but do not register any ports */
2588 product_id = le16_to_cpu(
2589 edge_serial->serial->dev->descriptor.idProduct);
2591 /* Currently only the EP/416 models require heartbeat support */
2592 if (edge_serial->fw_version > FW_HEARTBEAT_VERSION_CUTOFF) {
2593 if (product_id == ION_DEVICE_ID_TI_EDGEPORT_416 ||
2594 product_id == ION_DEVICE_ID_TI_EDGEPORT_416B) {
2595 edge_serial->use_heartbeat = true;
2599 edge_heartbeat_schedule(edge_serial);
2604 static void edge_disconnect(struct usb_serial *serial)
2606 struct edgeport_serial *edge_serial = usb_get_serial_data(serial);
2608 cancel_delayed_work_sync(&edge_serial->heartbeat_work);
2611 static void edge_release(struct usb_serial *serial)
2613 struct edgeport_serial *edge_serial = usb_get_serial_data(serial);
2615 cancel_delayed_work_sync(&edge_serial->heartbeat_work);
2619 static int edge_port_probe(struct usb_serial_port *port)
2621 struct edgeport_port *edge_port;
2624 edge_port = kzalloc(sizeof(*edge_port), GFP_KERNEL);
2628 spin_lock_init(&edge_port->ep_lock);
2629 edge_port->port = port;
2630 edge_port->edge_serial = usb_get_serial_data(port->serial);
2631 edge_port->bUartMode = default_uart_mode;
2633 switch (port->port_number) {
2635 edge_port->uart_base = UMPMEM_BASE_UART1;
2636 edge_port->dma_address = UMPD_OEDB1_ADDRESS;
2639 edge_port->uart_base = UMPMEM_BASE_UART2;
2640 edge_port->dma_address = UMPD_OEDB2_ADDRESS;
2643 dev_err(&port->dev, "unknown port number\n");
2649 "%s - port_number = %d, uart_base = %04x, dma_address = %04x\n",
2650 __func__, port->port_number, edge_port->uart_base,
2651 edge_port->dma_address);
2653 usb_set_serial_port_data(port, edge_port);
2655 ret = edge_create_sysfs_attrs(port);
2659 port->port.closing_wait = msecs_to_jiffies(closing_wait * 10);
2660 port->port.drain_delay = 1;
2669 static int edge_port_remove(struct usb_serial_port *port)
2671 struct edgeport_port *edge_port;
2673 edge_port = usb_get_serial_port_data(port);
2674 edge_remove_sysfs_attrs(port);
2680 /* Sysfs Attributes */
2682 static ssize_t uart_mode_show(struct device *dev,
2683 struct device_attribute *attr, char *buf)
2685 struct usb_serial_port *port = to_usb_serial_port(dev);
2686 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2688 return sprintf(buf, "%d\n", edge_port->bUartMode);
2691 static ssize_t uart_mode_store(struct device *dev,
2692 struct device_attribute *attr, const char *valbuf, size_t count)
2694 struct usb_serial_port *port = to_usb_serial_port(dev);
2695 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2696 unsigned int v = simple_strtoul(valbuf, NULL, 0);
2698 dev_dbg(dev, "%s: setting uart_mode = %d\n", __func__, v);
2701 edge_port->bUartMode = v;
2703 dev_err(dev, "%s - uart_mode %d is invalid\n", __func__, v);
2707 static DEVICE_ATTR_RW(uart_mode);
2709 static int edge_create_sysfs_attrs(struct usb_serial_port *port)
2711 return device_create_file(&port->dev, &dev_attr_uart_mode);
2714 static int edge_remove_sysfs_attrs(struct usb_serial_port *port)
2716 device_remove_file(&port->dev, &dev_attr_uart_mode);
2721 static int edge_suspend(struct usb_serial *serial, pm_message_t message)
2723 struct edgeport_serial *edge_serial = usb_get_serial_data(serial);
2725 cancel_delayed_work_sync(&edge_serial->heartbeat_work);
2730 static int edge_resume(struct usb_serial *serial)
2732 struct edgeport_serial *edge_serial = usb_get_serial_data(serial);
2734 edge_heartbeat_schedule(edge_serial);
2740 static struct usb_serial_driver edgeport_1port_device = {
2742 .owner = THIS_MODULE,
2743 .name = "edgeport_ti_1",
2745 .description = "Edgeport TI 1 port adapter",
2746 .id_table = edgeport_1port_id_table,
2749 .close = edge_close,
2750 .throttle = edge_throttle,
2751 .unthrottle = edge_unthrottle,
2752 .attach = edge_startup,
2753 .disconnect = edge_disconnect,
2754 .release = edge_release,
2755 .port_probe = edge_port_probe,
2756 .port_remove = edge_port_remove,
2757 .ioctl = edge_ioctl,
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,
2772 .suspend = edge_suspend,
2773 .resume = edge_resume,
2777 static struct usb_serial_driver edgeport_2port_device = {
2779 .owner = THIS_MODULE,
2780 .name = "edgeport_ti_2",
2782 .description = "Edgeport TI 2 port adapter",
2783 .id_table = edgeport_2port_id_table,
2786 .close = edge_close,
2787 .throttle = edge_throttle,
2788 .unthrottle = edge_unthrottle,
2789 .attach = edge_startup,
2790 .disconnect = edge_disconnect,
2791 .release = edge_release,
2792 .port_probe = edge_port_probe,
2793 .port_remove = edge_port_remove,
2794 .ioctl = edge_ioctl,
2795 .set_termios = edge_set_termios,
2796 .tiocmget = edge_tiocmget,
2797 .tiocmset = edge_tiocmset,
2798 .tiocmiwait = usb_serial_generic_tiocmiwait,
2799 .get_icount = usb_serial_generic_get_icount,
2800 .write = edge_write,
2801 .write_room = edge_write_room,
2802 .chars_in_buffer = edge_chars_in_buffer,
2803 .tx_empty = edge_tx_empty,
2804 .break_ctl = edge_break,
2805 .read_int_callback = edge_interrupt_callback,
2806 .read_bulk_callback = edge_bulk_in_callback,
2807 .write_bulk_callback = edge_bulk_out_callback,
2809 .suspend = edge_suspend,
2810 .resume = edge_resume,
2814 static struct usb_serial_driver * const serial_drivers[] = {
2815 &edgeport_1port_device, &edgeport_2port_device, NULL
2818 module_usb_serial_driver(serial_drivers, id_table_combined);
2820 MODULE_AUTHOR(DRIVER_AUTHOR);
2821 MODULE_DESCRIPTION(DRIVER_DESC);
2822 MODULE_LICENSE("GPL");
2825 module_param(closing_wait, int, S_IRUGO | S_IWUSR);
2826 MODULE_PARM_DESC(closing_wait, "Maximum wait for data to drain, in .01 secs");
2828 module_param(ignore_cpu_rev, bool, S_IRUGO | S_IWUSR);
2829 MODULE_PARM_DESC(ignore_cpu_rev,
2830 "Ignore the cpu revision when connecting to a device");
2832 module_param(default_uart_mode, int, S_IRUGO | S_IWUSR);
2833 MODULE_PARM_DESC(default_uart_mode, "Default uart_mode, 0=RS232, ...");