1 // SPDX-License-Identifier: GPL-2.0+
3 * Edgeport USB Serial Converter driver
5 * Copyright (C) 2000-2002 Inside Out Networks, All rights reserved.
6 * Copyright (C) 2001-2002 Greg Kroah-Hartman <greg@kroah.com>
8 * Supports the following devices:
9 * EP/1 EP/2 EP/4 EP/21 EP/22 EP/221 EP/42 EP/421 WATCHPORT
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>.
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>
36 #include "io_usbvend.h"
39 #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com> and David Iacovelli"
40 #define DRIVER_DESC "Edgeport USB Serial Driver"
42 #define EPROM_PAGE_SIZE 64
45 /* different hardware types */
46 #define HARDWARE_TYPE_930 0
47 #define HARDWARE_TYPE_TIUMP 1
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
59 #define EDGE_READ_URB_RUNNING 0
60 #define EDGE_READ_URB_STOPPING 1
61 #define EDGE_READ_URB_STOPPED 2
64 /* Product information read from the Edgeport */
66 int TiMode; /* Current TI Mode */
67 u8 hardware_type; /* Type of hardware */
71 * Edgeport firmware header
73 * "build_number" has been set to 0 in all three of the images I have
74 * seen, and Digi Tech Support suggests that it is safe to ignore it.
76 * "length" is the number of bytes of actual data following the header.
78 * "checksum" is the low order byte resulting from adding the values of
81 struct edgeport_fw_hdr {
89 struct edgeport_port {
96 u32 ump_read_timeout; /*
97 * Number of milliseconds the UMP will
98 * wait without data before completing
105 struct edgeport_serial *edge_serial;
106 struct usb_serial_port *port;
107 u8 bUartMode; /* Port type, 0: RS232, etc. */
109 int ep_read_urb_state;
110 int ep_write_urb_in_use;
113 struct edgeport_serial {
114 struct product_info product_info;
115 u8 TI_I2C_Type; /* Type of I2C in UMP */
117 * Set to TRUE if we have read the
120 struct mutex es_lock;
122 struct usb_serial *serial;
123 struct delayed_work heartbeat_work;
129 /* Devices that this driver supports */
130 static const struct usb_device_id edgeport_1port_id_table[] = {
131 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_1) },
132 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_TI3410_EDGEPORT_1) },
133 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_TI3410_EDGEPORT_1I) },
134 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_PROXIMITY) },
135 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_MOTION) },
136 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_MOISTURE) },
137 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_TEMPERATURE) },
138 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_HUMIDITY) },
139 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_POWER) },
140 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_LIGHT) },
141 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_RADIATION) },
142 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_DISTANCE) },
143 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_ACCELERATION) },
144 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_PROX_DIST) },
145 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_PLUS_PWR_HP4CD) },
146 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_PLUS_PWR_PCI) },
150 static const struct usb_device_id edgeport_2port_id_table[] = {
151 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_2) },
152 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_2C) },
153 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_2I) },
154 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_421) },
155 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_21) },
156 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_42) },
157 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_4) },
158 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_4I) },
159 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_22I) },
160 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_221C) },
161 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_22C) },
162 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_21C) },
163 /* The 4, 8 and 16 port devices show up as multiple 2 port devices */
164 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_4S) },
165 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_8) },
166 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_8S) },
167 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_416) },
168 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_416B) },
169 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_E5805A) },
173 /* Devices that this driver supports */
174 static const struct usb_device_id id_table_combined[] = {
175 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_1) },
176 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_TI3410_EDGEPORT_1) },
177 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_TI3410_EDGEPORT_1I) },
178 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_PROXIMITY) },
179 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_MOTION) },
180 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_MOISTURE) },
181 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_TEMPERATURE) },
182 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_HUMIDITY) },
183 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_POWER) },
184 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_LIGHT) },
185 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_RADIATION) },
186 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_DISTANCE) },
187 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_ACCELERATION) },
188 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_PROX_DIST) },
189 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_PLUS_PWR_HP4CD) },
190 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_PLUS_PWR_PCI) },
191 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_2) },
192 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_2C) },
193 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_2I) },
194 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_421) },
195 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_21) },
196 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_42) },
197 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_4) },
198 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_4I) },
199 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_22I) },
200 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_221C) },
201 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_22C) },
202 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_21C) },
203 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_4S) },
204 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_8) },
205 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_8S) },
206 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_416) },
207 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_416B) },
208 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_E5805A) },
212 MODULE_DEVICE_TABLE(usb, id_table_combined);
214 static bool ignore_cpu_rev;
215 static int default_uart_mode; /* RS232 */
217 static void edge_tty_recv(struct usb_serial_port *port, unsigned char *data,
220 static void stop_read(struct edgeport_port *edge_port);
221 static int restart_read(struct edgeport_port *edge_port);
223 static void edge_set_termios(struct tty_struct *tty,
224 struct usb_serial_port *port, struct ktermios *old_termios);
225 static void edge_send(struct usb_serial_port *port, struct tty_struct *tty);
227 static int do_download_mode(struct edgeport_serial *serial,
228 const struct firmware *fw);
229 static int do_boot_mode(struct edgeport_serial *serial,
230 const struct firmware *fw);
232 /* sysfs attributes */
233 static int edge_create_sysfs_attrs(struct usb_serial_port *port);
234 static int edge_remove_sysfs_attrs(struct usb_serial_port *port);
237 * Some release of Edgeport firmware "down3.bin" after version 4.80
238 * introduced code to automatically disconnect idle devices on some
239 * Edgeport models after periods of inactivity, typically ~60 seconds.
240 * This occurs without regard to whether ports on the device are open
241 * or not. Digi International Tech Support suggested:
243 * 1. Adding driver "heartbeat" code to reset the firmware timer by
244 * requesting a descriptor record every 15 seconds, which should be
245 * effective with newer firmware versions that require it, and benign
246 * with older versions that do not. In practice 40 seconds seems often
248 * 2. The heartbeat code is currently required only on Edgeport/416 models.
250 #define FW_HEARTBEAT_VERSION_CUTOFF ((4 << 8) + 80)
251 #define FW_HEARTBEAT_SECS 40
253 /* Timeouts in msecs: firmware downloads take longer */
254 #define TI_VSEND_TIMEOUT_DEFAULT 1000
255 #define TI_VSEND_TIMEOUT_FW_DOWNLOAD 10000
257 static int ti_vread_sync(struct usb_device *dev, u8 request, u16 value,
258 u16 index, void *data, int size)
262 status = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0), request,
263 (USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN),
264 value, index, data, size, 1000);
267 if (status != size) {
268 dev_dbg(&dev->dev, "%s - wanted to read %d, but only read %d\n",
269 __func__, size, status);
275 static int ti_vsend_sync(struct usb_device *dev, u8 request, u16 value,
276 u16 index, void *data, int size, int timeout)
280 status = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), request,
281 (USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT),
282 value, index, data, size, timeout);
289 static int read_port_cmd(struct usb_serial_port *port, u8 command, u16 value,
290 void *data, int size)
292 return ti_vread_sync(port->serial->dev, command, value,
293 UMPM_UART1_PORT + port->port_number,
297 static int send_port_cmd(struct usb_serial_port *port, u8 command, u16 value,
298 void *data, int size)
300 return ti_vsend_sync(port->serial->dev, command, value,
301 UMPM_UART1_PORT + port->port_number,
302 data, size, TI_VSEND_TIMEOUT_DEFAULT);
305 /* clear tx/rx buffers and fifo in TI UMP */
306 static int purge_port(struct usb_serial_port *port, u16 mask)
308 int port_number = port->port_number;
310 dev_dbg(&port->dev, "%s - port %d, mask %x\n", __func__, port_number, mask);
312 return send_port_cmd(port, UMPC_PURGE_PORT, mask, NULL, 0);
316 * read_download_mem - Read edgeport memory from TI chip
317 * @dev: usb device pointer
318 * @start_address: Device CPU address at which to read
319 * @length: Length of above data
320 * @address_type: Can read both XDATA and I2C
321 * @buffer: pointer to input data buffer
323 static int read_download_mem(struct usb_device *dev, int start_address,
324 int length, u8 address_type, u8 *buffer)
328 u16 be_start_address;
330 dev_dbg(&dev->dev, "%s - @ %x for %d\n", __func__, start_address, length);
333 * Read in blocks of 64 bytes
334 * (TI firmware can't handle more than 64 byte reads)
340 read_length = (u8)length;
342 if (read_length > 1) {
343 dev_dbg(&dev->dev, "%s - @ %x for %d\n", __func__, start_address, read_length);
346 * NOTE: Must use swab as wIndex is sent in little-endian
347 * byte order regardless of host byte order.
349 be_start_address = swab16((u16)start_address);
350 status = ti_vread_sync(dev, UMPC_MEMORY_READ,
353 buffer, read_length);
356 dev_dbg(&dev->dev, "%s - ERROR %x\n", __func__, status);
361 usb_serial_debug_data(&dev->dev, __func__, read_length, buffer);
363 /* Update pointers/length */
364 start_address += read_length;
365 buffer += read_length;
366 length -= read_length;
372 static int read_ram(struct usb_device *dev, int start_address,
373 int length, u8 *buffer)
375 return read_download_mem(dev, start_address, length,
376 DTK_ADDR_SPACE_XDATA, buffer);
379 /* Read edgeport memory to a given block */
380 static int read_boot_mem(struct edgeport_serial *serial,
381 int start_address, int length, u8 *buffer)
386 for (i = 0; i < length; i++) {
387 status = ti_vread_sync(serial->serial->dev,
388 UMPC_MEMORY_READ, serial->TI_I2C_Type,
389 (u16)(start_address+i), &buffer[i], 0x01);
391 dev_dbg(&serial->serial->dev->dev, "%s - ERROR %x\n", __func__, status);
396 dev_dbg(&serial->serial->dev->dev, "%s - start_address = %x, length = %d\n",
397 __func__, start_address, length);
398 usb_serial_debug_data(&serial->serial->dev->dev, __func__, length, buffer);
400 serial->TiReadI2C = 1;
405 /* Write given block to TI EPROM memory */
406 static int write_boot_mem(struct edgeport_serial *serial,
407 int start_address, int length, u8 *buffer)
413 /* Must do a read before write */
414 if (!serial->TiReadI2C) {
415 temp = kmalloc(1, GFP_KERNEL);
419 status = read_boot_mem(serial, 0, 1, temp);
425 for (i = 0; i < length; ++i) {
426 status = ti_vsend_sync(serial->serial->dev, UMPC_MEMORY_WRITE,
427 buffer[i], (u16)(i + start_address), NULL,
428 0, TI_VSEND_TIMEOUT_DEFAULT);
433 dev_dbg(&serial->serial->dev->dev, "%s - start_sddr = %x, length = %d\n", __func__, start_address, length);
434 usb_serial_debug_data(&serial->serial->dev->dev, __func__, length, buffer);
439 /* Write edgeport I2C memory to TI chip */
440 static int write_i2c_mem(struct edgeport_serial *serial,
441 int start_address, int length, u8 address_type, u8 *buffer)
443 struct device *dev = &serial->serial->dev->dev;
446 u16 be_start_address;
448 /* We can only send a maximum of 1 aligned byte page at a time */
450 /* calculate the number of bytes left in the first page */
451 write_length = EPROM_PAGE_SIZE -
452 (start_address & (EPROM_PAGE_SIZE - 1));
454 if (write_length > length)
455 write_length = length;
457 dev_dbg(dev, "%s - BytesInFirstPage Addr = %x, length = %d\n",
458 __func__, start_address, write_length);
459 usb_serial_debug_data(dev, __func__, write_length, buffer);
464 * NOTE: Must use swab as wIndex is sent in little-endian byte order
465 * regardless of host byte order.
467 be_start_address = swab16((u16)start_address);
468 status = ti_vsend_sync(serial->serial->dev, UMPC_MEMORY_WRITE,
469 (u16)address_type, be_start_address,
470 buffer, write_length, TI_VSEND_TIMEOUT_DEFAULT);
472 dev_dbg(dev, "%s - ERROR %d\n", __func__, status);
476 length -= write_length;
477 start_address += write_length;
478 buffer += write_length;
481 * We should be aligned now -- can write max page size bytes at a
485 if (length > EPROM_PAGE_SIZE)
486 write_length = EPROM_PAGE_SIZE;
488 write_length = length;
490 dev_dbg(dev, "%s - Page Write Addr = %x, length = %d\n",
491 __func__, start_address, write_length);
492 usb_serial_debug_data(dev, __func__, write_length, buffer);
497 * NOTE: Must use swab as wIndex is sent in little-endian byte
498 * order regardless of host byte order.
500 be_start_address = swab16((u16)start_address);
501 status = ti_vsend_sync(serial->serial->dev, UMPC_MEMORY_WRITE,
502 (u16)address_type, be_start_address, buffer,
503 write_length, TI_VSEND_TIMEOUT_DEFAULT);
505 dev_err(dev, "%s - ERROR %d\n", __func__, status);
509 length -= write_length;
510 start_address += write_length;
511 buffer += write_length;
517 * Examine the UMP DMA registers and LSR
519 * Check the MSBit of the X and Y DMA byte count registers.
520 * A zero in this bit indicates that the TX DMA buffers are empty
521 * then check the TX Empty bit in the UART.
523 static int tx_active(struct edgeport_port *port)
526 struct out_endpoint_desc_block *oedb;
530 oedb = kmalloc(sizeof(*oedb), GFP_KERNEL);
535 * Sigh, that's right, just one byte, as not all platforms can
538 lsr = kmalloc(1, GFP_KERNEL);
543 /* Read the DMA Count Registers */
544 status = read_ram(port->port->serial->dev, port->dma_address,
545 sizeof(*oedb), (void *)oedb);
547 goto exit_is_tx_active;
549 dev_dbg(&port->port->dev, "%s - XByteCount 0x%X\n", __func__, oedb->XByteCount);
552 status = read_ram(port->port->serial->dev,
553 port->uart_base + UMPMEM_OFFS_UART_LSR, 1, lsr);
556 goto exit_is_tx_active;
557 dev_dbg(&port->port->dev, "%s - LSR = 0x%X\n", __func__, *lsr);
559 /* If either buffer has data or we are transmitting then return TRUE */
560 if ((oedb->XByteCount & 0x80) != 0)
563 if ((*lsr & UMP_UART_LSR_TX_MASK) == 0)
566 /* We return Not Active if we get any kind of error */
568 dev_dbg(&port->port->dev, "%s - return %d\n", __func__, bytes_left);
575 static int choose_config(struct usb_device *dev)
578 * There may be multiple configurations on this device, in which case
579 * we would need to read and parse all of them to find out which one
580 * we want. However, we just support one config at this point,
581 * configuration # 1, which is Config Descriptor 0.
584 dev_dbg(&dev->dev, "%s - Number of Interfaces = %d\n",
585 __func__, dev->config->desc.bNumInterfaces);
586 dev_dbg(&dev->dev, "%s - MAX Power = %d\n",
587 __func__, dev->config->desc.bMaxPower * 2);
589 if (dev->config->desc.bNumInterfaces != 1) {
590 dev_err(&dev->dev, "%s - bNumInterfaces is not 1, ERROR!\n", __func__);
597 static int read_rom(struct edgeport_serial *serial,
598 int start_address, int length, u8 *buffer)
602 if (serial->product_info.TiMode == TI_MODE_DOWNLOAD) {
603 status = read_download_mem(serial->serial->dev,
609 status = read_boot_mem(serial, start_address, length,
615 static int write_rom(struct edgeport_serial *serial, int start_address,
616 int length, u8 *buffer)
618 if (serial->product_info.TiMode == TI_MODE_BOOT)
619 return write_boot_mem(serial, start_address, length,
622 if (serial->product_info.TiMode == TI_MODE_DOWNLOAD)
623 return write_i2c_mem(serial, start_address, length,
624 serial->TI_I2C_Type, buffer);
628 /* Read a descriptor header from I2C based on type */
629 static int get_descriptor_addr(struct edgeport_serial *serial,
630 int desc_type, struct ti_i2c_desc *rom_desc)
635 /* Search for requested descriptor in I2C */
638 status = read_rom(serial,
640 sizeof(struct ti_i2c_desc),
645 if (rom_desc->Type == desc_type)
646 return start_address;
648 start_address = start_address + sizeof(struct ti_i2c_desc) +
649 le16_to_cpu(rom_desc->Size);
651 } while ((start_address < TI_MAX_I2C_SIZE) && rom_desc->Type);
656 /* Validate descriptor checksum */
657 static int valid_csum(struct ti_i2c_desc *rom_desc, u8 *buffer)
662 for (i = 0; i < le16_to_cpu(rom_desc->Size); i++)
663 cs = (u8)(cs + buffer[i]);
665 if (cs != rom_desc->CheckSum) {
666 pr_debug("%s - Mismatch %x - %x", __func__, rom_desc->CheckSum, cs);
672 /* Make sure that the I2C image is good */
673 static int check_i2c_image(struct edgeport_serial *serial)
675 struct device *dev = &serial->serial->dev->dev;
677 struct ti_i2c_desc *rom_desc;
678 int start_address = 2;
682 rom_desc = kmalloc(sizeof(*rom_desc), GFP_KERNEL);
686 buffer = kmalloc(TI_MAX_I2C_SIZE, GFP_KERNEL);
692 /* Read the first byte (Signature0) must be 0x52 or 0x10 */
693 status = read_rom(serial, 0, 1, buffer);
697 if (*buffer != UMP5152 && *buffer != UMP3410) {
698 dev_err(dev, "%s - invalid buffer signature\n", __func__);
704 /* Validate the I2C */
705 status = read_rom(serial,
707 sizeof(struct ti_i2c_desc),
712 if ((start_address + sizeof(struct ti_i2c_desc) +
713 le16_to_cpu(rom_desc->Size)) > TI_MAX_I2C_SIZE) {
715 dev_dbg(dev, "%s - structure too big, erroring out.\n", __func__);
719 dev_dbg(dev, "%s Type = 0x%x\n", __func__, rom_desc->Type);
721 /* Skip type 2 record */
722 ttype = rom_desc->Type & 0x0f;
723 if (ttype != I2C_DESC_TYPE_FIRMWARE_BASIC
724 && ttype != I2C_DESC_TYPE_FIRMWARE_AUTO) {
725 /* Read the descriptor data */
726 status = read_rom(serial, start_address +
727 sizeof(struct ti_i2c_desc),
728 le16_to_cpu(rom_desc->Size),
733 status = valid_csum(rom_desc, buffer);
737 start_address = start_address + sizeof(struct ti_i2c_desc) +
738 le16_to_cpu(rom_desc->Size);
740 } while ((rom_desc->Type != I2C_DESC_TYPE_ION) &&
741 (start_address < TI_MAX_I2C_SIZE));
743 if ((rom_desc->Type != I2C_DESC_TYPE_ION) ||
744 (start_address > TI_MAX_I2C_SIZE))
753 static int get_manuf_info(struct edgeport_serial *serial, u8 *buffer)
757 struct ti_i2c_desc *rom_desc;
758 struct edge_ti_manuf_descriptor *desc;
759 struct device *dev = &serial->serial->dev->dev;
761 rom_desc = kmalloc(sizeof(*rom_desc), GFP_KERNEL);
765 start_address = get_descriptor_addr(serial, I2C_DESC_TYPE_ION,
768 if (!start_address) {
769 dev_dbg(dev, "%s - Edge Descriptor not found in I2C\n", __func__);
774 /* Read the descriptor data */
775 status = read_rom(serial, start_address+sizeof(struct ti_i2c_desc),
776 le16_to_cpu(rom_desc->Size), buffer);
780 status = valid_csum(rom_desc, buffer);
782 desc = (struct edge_ti_manuf_descriptor *)buffer;
783 dev_dbg(dev, "%s - IonConfig 0x%x\n", __func__, desc->IonConfig);
784 dev_dbg(dev, "%s - Version %d\n", __func__, desc->Version);
785 dev_dbg(dev, "%s - Cpu/Board 0x%x\n", __func__, desc->CpuRev_BoardRev);
786 dev_dbg(dev, "%s - NumPorts %d\n", __func__, desc->NumPorts);
787 dev_dbg(dev, "%s - NumVirtualPorts %d\n", __func__, desc->NumVirtualPorts);
788 dev_dbg(dev, "%s - TotalPorts %d\n", __func__, desc->TotalPorts);
795 /* Build firmware header used for firmware update */
796 static int build_i2c_fw_hdr(u8 *header, const struct firmware *fw)
802 struct ti_i2c_desc *i2c_header;
803 struct ti_i2c_image_header *img_header;
804 struct ti_i2c_firmware_rec *firmware_rec;
805 struct edgeport_fw_hdr *fw_hdr = (struct edgeport_fw_hdr *)fw->data;
808 * In order to update the I2C firmware we must change the type 2 record
809 * to type 0xF2. This will force the UMP to come up in Boot Mode.
810 * Then while in boot mode, the driver will download the latest
811 * firmware (padded to 15.5k) into the UMP ram. And finally when the
812 * device comes back up in download mode the driver will cause the new
813 * firmware to be copied from the UMP Ram to I2C and the firmware will
814 * update the record type from 0xf2 to 0x02.
818 * Allocate a 15.5k buffer + 2 bytes for version number (Firmware
821 buffer_size = (((1024 * 16) - 512 ) +
822 sizeof(struct ti_i2c_firmware_rec));
824 buffer = kmalloc(buffer_size, GFP_KERNEL);
828 /* Set entire image of 0xffs */
829 memset(buffer, 0xff, buffer_size);
831 /* Copy version number into firmware record */
832 firmware_rec = (struct ti_i2c_firmware_rec *)buffer;
834 firmware_rec->Ver_Major = fw_hdr->major_version;
835 firmware_rec->Ver_Minor = fw_hdr->minor_version;
837 /* Pointer to fw_down memory image */
838 img_header = (struct ti_i2c_image_header *)&fw->data[4];
840 memcpy(buffer + sizeof(struct ti_i2c_firmware_rec),
841 &fw->data[4 + sizeof(struct ti_i2c_image_header)],
842 le16_to_cpu(img_header->Length));
844 for (i=0; i < buffer_size; i++) {
845 cs = (u8)(cs + buffer[i]);
850 /* Build new header */
851 i2c_header = (struct ti_i2c_desc *)header;
852 firmware_rec = (struct ti_i2c_firmware_rec*)i2c_header->Data;
854 i2c_header->Type = I2C_DESC_TYPE_FIRMWARE_BLANK;
855 i2c_header->Size = cpu_to_le16(buffer_size);
856 i2c_header->CheckSum = cs;
857 firmware_rec->Ver_Major = fw_hdr->major_version;
858 firmware_rec->Ver_Minor = fw_hdr->minor_version;
863 /* Try to figure out what type of I2c we have */
864 static int i2c_type_bootmode(struct edgeport_serial *serial)
866 struct device *dev = &serial->serial->dev->dev;
870 data = kmalloc(1, GFP_KERNEL);
874 /* Try to read type 2 */
875 status = ti_vread_sync(serial->serial->dev, UMPC_MEMORY_READ,
876 DTK_ADDR_SPACE_I2C_TYPE_II, 0, data, 0x01);
878 dev_dbg(dev, "%s - read 2 status error = %d\n", __func__, status);
880 dev_dbg(dev, "%s - read 2 data = 0x%x\n", __func__, *data);
881 if ((!status) && (*data == UMP5152 || *data == UMP3410)) {
882 dev_dbg(dev, "%s - ROM_TYPE_II\n", __func__);
883 serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_II;
887 /* Try to read type 3 */
888 status = ti_vread_sync(serial->serial->dev, UMPC_MEMORY_READ,
889 DTK_ADDR_SPACE_I2C_TYPE_III, 0, data, 0x01);
891 dev_dbg(dev, "%s - read 3 status error = %d\n", __func__, status);
893 dev_dbg(dev, "%s - read 2 data = 0x%x\n", __func__, *data);
894 if ((!status) && (*data == UMP5152 || *data == UMP3410)) {
895 dev_dbg(dev, "%s - ROM_TYPE_III\n", __func__);
896 serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_III;
900 dev_dbg(dev, "%s - Unknown\n", __func__);
901 serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_II;
908 static int bulk_xfer(struct usb_serial *serial, void *buffer,
909 int length, int *num_sent)
913 status = usb_bulk_msg(serial->dev,
914 usb_sndbulkpipe(serial->dev,
915 serial->port[0]->bulk_out_endpointAddress),
916 buffer, length, num_sent, 1000);
920 /* Download given firmware image to the device (IN BOOT MODE) */
921 static int download_code(struct edgeport_serial *serial, u8 *image,
929 /* Transfer firmware image */
930 for (pos = 0; pos < image_length; ) {
931 /* Read the next buffer from file */
932 transfer = image_length - pos;
933 if (transfer > EDGE_FW_BULK_MAX_PACKET_SIZE)
934 transfer = EDGE_FW_BULK_MAX_PACKET_SIZE;
937 status = bulk_xfer(serial->serial, &image[pos],
941 /* Advance buffer pointer */
949 static int config_boot_dev(struct usb_device *dev)
954 static int ti_cpu_rev(struct edge_ti_manuf_descriptor *desc)
956 return TI_GET_CPU_REVISION(desc->CpuRev_BoardRev);
959 static int check_fw_sanity(struct edgeport_serial *serial,
960 const struct firmware *fw)
965 struct device *dev = &serial->serial->interface->dev;
966 struct edgeport_fw_hdr *fw_hdr = (struct edgeport_fw_hdr *)fw->data;
968 if (fw->size < sizeof(struct edgeport_fw_hdr)) {
969 dev_err(dev, "incomplete fw header\n");
973 length_total = le16_to_cpu(fw_hdr->length) +
974 sizeof(struct edgeport_fw_hdr);
976 if (fw->size != length_total) {
977 dev_err(dev, "bad fw size (expected: %u, got: %zu)\n",
978 length_total, fw->size);
982 for (pos = sizeof(struct edgeport_fw_hdr); pos < fw->size; ++pos)
983 checksum += fw->data[pos];
985 if (checksum != fw_hdr->checksum) {
986 dev_err(dev, "bad fw checksum (expected: 0x%x, got: 0x%x)\n",
987 fw_hdr->checksum, checksum);
995 * DownloadTIFirmware - Download run-time operating firmware to the TI5052
997 * This routine downloads the main operating code into the TI5052, using the
998 * boot code already burned into E2PROM or ROM.
1000 static int download_fw(struct edgeport_serial *serial)
1002 struct device *dev = &serial->serial->interface->dev;
1004 struct usb_interface_descriptor *interface;
1005 const struct firmware *fw;
1006 const char *fw_name = "edgeport/down3.bin";
1007 struct edgeport_fw_hdr *fw_hdr;
1009 status = request_firmware(&fw, fw_name, dev);
1011 dev_err(dev, "Failed to load image \"%s\" err %d\n",
1016 if (check_fw_sanity(serial, fw)) {
1021 fw_hdr = (struct edgeport_fw_hdr *)fw->data;
1023 /* If on-board version is newer, "fw_version" will be updated later. */
1024 serial->fw_version = (fw_hdr->major_version << 8) +
1025 fw_hdr->minor_version;
1028 * This routine is entered by both the BOOT mode and the Download mode
1029 * We can determine which code is running by the reading the config
1030 * descriptor and if we have only one bulk pipe it is in boot mode
1032 serial->product_info.hardware_type = HARDWARE_TYPE_TIUMP;
1034 /* Default to type 2 i2c */
1035 serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_II;
1037 status = choose_config(serial->serial->dev);
1041 interface = &serial->serial->interface->cur_altsetting->desc;
1043 dev_err(dev, "%s - no interface set, error!\n", __func__);
1049 * Setup initial mode -- the default mode 0 is TI_MODE_CONFIGURING
1050 * if we have more than one endpoint we are definitely in download
1053 if (interface->bNumEndpoints > 1) {
1054 serial->product_info.TiMode = TI_MODE_DOWNLOAD;
1055 status = do_download_mode(serial, fw);
1057 /* Otherwise we will remain in configuring mode */
1058 serial->product_info.TiMode = TI_MODE_CONFIGURING;
1059 status = do_boot_mode(serial, fw);
1063 release_firmware(fw);
1067 static int do_download_mode(struct edgeport_serial *serial,
1068 const struct firmware *fw)
1070 struct device *dev = &serial->serial->interface->dev;
1073 struct edge_ti_manuf_descriptor *ti_manuf_desc;
1074 int download_cur_ver;
1075 int download_new_ver;
1076 struct edgeport_fw_hdr *fw_hdr = (struct edgeport_fw_hdr *)fw->data;
1077 struct ti_i2c_desc *rom_desc;
1079 dev_dbg(dev, "%s - RUNNING IN DOWNLOAD MODE\n", __func__);
1081 status = check_i2c_image(serial);
1083 dev_dbg(dev, "%s - DOWNLOAD MODE -- BAD I2C\n", __func__);
1088 * Validate Hardware version number
1089 * Read Manufacturing Descriptor from TI Based Edgeport
1091 ti_manuf_desc = kmalloc(sizeof(*ti_manuf_desc), GFP_KERNEL);
1095 status = get_manuf_info(serial, (u8 *)ti_manuf_desc);
1097 kfree(ti_manuf_desc);
1101 /* Check version number of ION descriptor */
1102 if (!ignore_cpu_rev && ti_cpu_rev(ti_manuf_desc) < 2) {
1103 dev_dbg(dev, "%s - Wrong CPU Rev %d (Must be 2)\n",
1104 __func__, ti_cpu_rev(ti_manuf_desc));
1105 kfree(ti_manuf_desc);
1109 rom_desc = kmalloc(sizeof(*rom_desc), GFP_KERNEL);
1111 kfree(ti_manuf_desc);
1115 /* Search for type 2 record (firmware record) */
1116 start_address = get_descriptor_addr(serial,
1117 I2C_DESC_TYPE_FIRMWARE_BASIC, rom_desc);
1118 if (start_address != 0) {
1119 struct ti_i2c_firmware_rec *firmware_version;
1122 dev_dbg(dev, "%s - Found Type FIRMWARE (Type 2) record\n",
1125 firmware_version = kmalloc(sizeof(*firmware_version),
1127 if (!firmware_version) {
1129 kfree(ti_manuf_desc);
1134 * Validate version number
1135 * Read the descriptor data
1137 status = read_rom(serial, start_address +
1138 sizeof(struct ti_i2c_desc),
1139 sizeof(struct ti_i2c_firmware_rec),
1140 (u8 *)firmware_version);
1142 kfree(firmware_version);
1144 kfree(ti_manuf_desc);
1149 * Check version number of download with current
1152 download_cur_ver = (firmware_version->Ver_Major << 8) +
1153 (firmware_version->Ver_Minor);
1154 download_new_ver = (fw_hdr->major_version << 8) +
1155 (fw_hdr->minor_version);
1157 dev_dbg(dev, "%s - >> FW Versions Device %d.%d Driver %d.%d\n",
1158 __func__, firmware_version->Ver_Major,
1159 firmware_version->Ver_Minor,
1160 fw_hdr->major_version, fw_hdr->minor_version);
1163 * Check if we have an old version in the I2C and
1164 * update if necessary
1166 if (download_cur_ver < download_new_ver) {
1167 dev_dbg(dev, "%s - Update I2C dld from %d.%d to %d.%d\n",
1169 firmware_version->Ver_Major,
1170 firmware_version->Ver_Minor,
1171 fw_hdr->major_version,
1172 fw_hdr->minor_version);
1174 record = kmalloc(1, GFP_KERNEL);
1176 kfree(firmware_version);
1178 kfree(ti_manuf_desc);
1182 * In order to update the I2C firmware we must
1183 * change the type 2 record to type 0xF2. This
1184 * will force the UMP to come up in Boot Mode.
1185 * Then while in boot mode, the driver will
1186 * download the latest firmware (padded to
1187 * 15.5k) into the UMP ram. Finally when the
1188 * device comes back up in download mode the
1189 * driver will cause the new firmware to be
1190 * copied from the UMP Ram to I2C and the
1191 * firmware will update the record type from
1194 *record = I2C_DESC_TYPE_FIRMWARE_BLANK;
1197 * Change the I2C Firmware record type to
1198 * 0xf2 to trigger an update
1200 status = write_rom(serial, start_address,
1201 sizeof(*record), record);
1204 kfree(firmware_version);
1206 kfree(ti_manuf_desc);
1211 * verify the write -- must do this in order
1212 * for write to complete before we do the
1215 status = read_rom(serial,
1221 kfree(firmware_version);
1223 kfree(ti_manuf_desc);
1227 if (*record != I2C_DESC_TYPE_FIRMWARE_BLANK) {
1228 dev_err(dev, "%s - error resetting device\n",
1231 kfree(firmware_version);
1233 kfree(ti_manuf_desc);
1237 dev_dbg(dev, "%s - HARDWARE RESET\n", __func__);
1239 /* Reset UMP -- Back to BOOT MODE */
1240 status = ti_vsend_sync(serial->serial->dev,
1241 UMPC_HARDWARE_RESET,
1243 TI_VSEND_TIMEOUT_DEFAULT);
1245 dev_dbg(dev, "%s - HARDWARE RESET return %d\n",
1248 /* return an error on purpose. */
1250 kfree(firmware_version);
1252 kfree(ti_manuf_desc);
1255 /* Same or newer fw version is already loaded */
1256 serial->fw_version = download_cur_ver;
1257 kfree(firmware_version);
1259 /* Search for type 0xF2 record (firmware blank record) */
1261 start_address = get_descriptor_addr(serial,
1262 I2C_DESC_TYPE_FIRMWARE_BLANK, rom_desc);
1263 if (start_address != 0) {
1264 #define HEADER_SIZE (sizeof(struct ti_i2c_desc) + \
1265 sizeof(struct ti_i2c_firmware_rec))
1269 header = kmalloc(HEADER_SIZE, GFP_KERNEL);
1272 kfree(ti_manuf_desc);
1276 vheader = kmalloc(HEADER_SIZE, GFP_KERNEL);
1280 kfree(ti_manuf_desc);
1284 dev_dbg(dev, "%s - Found Type BLANK FIRMWARE (Type F2) record\n",
1288 * In order to update the I2C firmware we must change
1289 * the type 2 record to type 0xF2. This will force the
1290 * UMP to come up in Boot Mode. Then while in boot
1291 * mode, the driver will download the latest firmware
1292 * (padded to 15.5k) into the UMP ram. Finally when the
1293 * device comes back up in download mode the driver
1294 * will cause the new firmware to be copied from the
1295 * UMP Ram to I2C and the firmware will update the
1296 * record type from 0xf2 to 0x02.
1298 status = build_i2c_fw_hdr(header, fw);
1303 kfree(ti_manuf_desc);
1308 * Update I2C with type 0xf2 record with correct
1311 status = write_rom(serial,
1319 kfree(ti_manuf_desc);
1324 * verify the write -- must do this in order for
1325 * write to complete before we do the hardware reset
1327 status = read_rom(serial, start_address,
1328 HEADER_SIZE, vheader);
1331 dev_dbg(dev, "%s - can't read header back\n",
1336 kfree(ti_manuf_desc);
1339 if (memcmp(vheader, header, HEADER_SIZE)) {
1340 dev_dbg(dev, "%s - write download record failed\n",
1345 kfree(ti_manuf_desc);
1352 dev_dbg(dev, "%s - Start firmware update\n", __func__);
1354 /* Tell firmware to copy download image into I2C */
1355 status = ti_vsend_sync(serial->serial->dev,
1356 UMPC_COPY_DNLD_TO_I2C,
1358 TI_VSEND_TIMEOUT_FW_DOWNLOAD);
1360 dev_dbg(dev, "%s - Update complete 0x%x\n", __func__,
1364 "%s - UMPC_COPY_DNLD_TO_I2C failed\n",
1367 kfree(ti_manuf_desc);
1373 /* The device is running the download code */
1375 kfree(ti_manuf_desc);
1379 static int do_boot_mode(struct edgeport_serial *serial,
1380 const struct firmware *fw)
1382 struct device *dev = &serial->serial->interface->dev;
1384 struct edge_ti_manuf_descriptor *ti_manuf_desc;
1385 struct edgeport_fw_hdr *fw_hdr = (struct edgeport_fw_hdr *)fw->data;
1387 dev_dbg(dev, "%s - RUNNING IN BOOT MODE\n", __func__);
1389 /* Configure the TI device so we can use the BULK pipes for download */
1390 status = config_boot_dev(serial->serial->dev);
1394 if (le16_to_cpu(serial->serial->dev->descriptor.idVendor)
1395 != USB_VENDOR_ID_ION) {
1396 dev_dbg(dev, "%s - VID = 0x%x\n", __func__,
1397 le16_to_cpu(serial->serial->dev->descriptor.idVendor));
1398 serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_II;
1399 goto stayinbootmode;
1403 * We have an ION device (I2c Must be programmed)
1404 * Determine I2C image type
1406 if (i2c_type_bootmode(serial))
1407 goto stayinbootmode;
1409 /* Check for ION Vendor ID and that the I2C is valid */
1410 if (!check_i2c_image(serial)) {
1411 struct ti_i2c_image_header *header;
1418 * Validate Hardware version number
1419 * Read Manufacturing Descriptor from TI Based Edgeport
1421 ti_manuf_desc = kmalloc(sizeof(*ti_manuf_desc), GFP_KERNEL);
1425 status = get_manuf_info(serial, (u8 *)ti_manuf_desc);
1427 kfree(ti_manuf_desc);
1428 goto stayinbootmode;
1431 /* Check for version 2 */
1432 if (!ignore_cpu_rev && ti_cpu_rev(ti_manuf_desc) < 2) {
1433 dev_dbg(dev, "%s - Wrong CPU Rev %d (Must be 2)\n",
1434 __func__, ti_cpu_rev(ti_manuf_desc));
1435 kfree(ti_manuf_desc);
1436 goto stayinbootmode;
1439 kfree(ti_manuf_desc);
1442 * In order to update the I2C firmware we must change the type
1443 * 2 record to type 0xF2. This will force the UMP to come up
1444 * in Boot Mode. Then while in boot mode, the driver will
1445 * download the latest firmware (padded to 15.5k) into the
1446 * UMP ram. Finally when the device comes back up in download
1447 * mode the driver will cause the new firmware to be copied
1448 * from the UMP Ram to I2C and the firmware will update the
1449 * record type from 0xf2 to 0x02.
1451 * Do we really have to copy the whole firmware image,
1452 * or could we do this in place!
1455 /* Allocate a 15.5k buffer + 3 byte header */
1456 buffer_size = (((1024 * 16) - 512) +
1457 sizeof(struct ti_i2c_image_header));
1458 buffer = kmalloc(buffer_size, GFP_KERNEL);
1462 /* Initialize the buffer to 0xff (pad the buffer) */
1463 memset(buffer, 0xff, buffer_size);
1464 memcpy(buffer, &fw->data[4], fw->size - 4);
1466 for (i = sizeof(struct ti_i2c_image_header);
1467 i < buffer_size; i++) {
1468 cs = (u8)(cs + buffer[i]);
1471 header = (struct ti_i2c_image_header *)buffer;
1473 /* update length and checksum after padding */
1474 header->Length = cpu_to_le16((u16)(buffer_size -
1475 sizeof(struct ti_i2c_image_header)));
1476 header->CheckSum = cs;
1478 /* Download the operational code */
1479 dev_dbg(dev, "%s - Downloading operational code image version %d.%d (TI UMP)\n",
1481 fw_hdr->major_version, fw_hdr->minor_version);
1482 status = download_code(serial, buffer, buffer_size);
1487 dev_dbg(dev, "%s - Error downloading operational code image\n", __func__);
1491 /* Device will reboot */
1492 serial->product_info.TiMode = TI_MODE_TRANSITIONING;
1494 dev_dbg(dev, "%s - Download successful -- Device rebooting...\n", __func__);
1500 /* Eprom is invalid or blank stay in boot mode */
1501 dev_dbg(dev, "%s - STAYING IN BOOT MODE\n", __func__);
1502 serial->product_info.TiMode = TI_MODE_BOOT;
1507 static int ti_do_config(struct edgeport_port *port, int feature, int on)
1509 on = !!on; /* 1 or 0 not bitmask */
1511 return send_port_cmd(port->port, feature, on, NULL, 0);
1514 static int restore_mcr(struct edgeport_port *port, u8 mcr)
1518 dev_dbg(&port->port->dev, "%s - %x\n", __func__, mcr);
1520 status = ti_do_config(port, UMPC_SET_CLR_DTR, mcr & MCR_DTR);
1523 status = ti_do_config(port, UMPC_SET_CLR_RTS, mcr & MCR_RTS);
1526 return ti_do_config(port, UMPC_SET_CLR_LOOPBACK, mcr & MCR_LOOPBACK);
1529 /* Convert TI LSR to standard UART flags */
1530 static u8 map_line_status(u8 ti_lsr)
1534 #define MAP_FLAG(flagUmp, flagUart) \
1535 if (ti_lsr & flagUmp) \
1538 MAP_FLAG(UMP_UART_LSR_OV_MASK, LSR_OVER_ERR) /* overrun */
1539 MAP_FLAG(UMP_UART_LSR_PE_MASK, LSR_PAR_ERR) /* parity error */
1540 MAP_FLAG(UMP_UART_LSR_FE_MASK, LSR_FRM_ERR) /* framing error */
1541 MAP_FLAG(UMP_UART_LSR_BR_MASK, LSR_BREAK) /* break detected */
1542 MAP_FLAG(UMP_UART_LSR_RX_MASK, LSR_RX_AVAIL) /* rx data available */
1543 MAP_FLAG(UMP_UART_LSR_TX_MASK, LSR_TX_EMPTY) /* tx hold reg empty */
1550 static void handle_new_msr(struct edgeport_port *edge_port, u8 msr)
1552 struct async_icount *icount;
1553 struct tty_struct *tty;
1555 dev_dbg(&edge_port->port->dev, "%s - %02x\n", __func__, msr);
1557 if (msr & (EDGEPORT_MSR_DELTA_CTS | EDGEPORT_MSR_DELTA_DSR |
1558 EDGEPORT_MSR_DELTA_RI | EDGEPORT_MSR_DELTA_CD)) {
1559 icount = &edge_port->port->icount;
1561 /* update input line counters */
1562 if (msr & EDGEPORT_MSR_DELTA_CTS)
1564 if (msr & EDGEPORT_MSR_DELTA_DSR)
1566 if (msr & EDGEPORT_MSR_DELTA_CD)
1568 if (msr & EDGEPORT_MSR_DELTA_RI)
1570 wake_up_interruptible(&edge_port->port->port.delta_msr_wait);
1573 /* Save the new modem status */
1574 edge_port->shadow_msr = msr & 0xf0;
1576 tty = tty_port_tty_get(&edge_port->port->port);
1577 /* handle CTS flow control */
1578 if (tty && C_CRTSCTS(tty)) {
1579 if (msr & EDGEPORT_MSR_CTS)
1585 static void handle_new_lsr(struct edgeport_port *edge_port, int lsr_data,
1588 struct async_icount *icount;
1589 u8 new_lsr = (u8)(lsr & (u8)(LSR_OVER_ERR | LSR_PAR_ERR |
1590 LSR_FRM_ERR | LSR_BREAK));
1592 dev_dbg(&edge_port->port->dev, "%s - %02x\n", __func__, new_lsr);
1594 edge_port->shadow_lsr = lsr;
1596 if (new_lsr & LSR_BREAK)
1598 * Parity and Framing errors only count if they
1599 * occur exclusive of a break being received.
1601 new_lsr &= (u8)(LSR_OVER_ERR | LSR_BREAK);
1603 /* Place LSR data byte into Rx buffer */
1605 edge_tty_recv(edge_port->port, &data, 1);
1607 /* update input line counters */
1608 icount = &edge_port->port->icount;
1609 if (new_lsr & LSR_BREAK)
1611 if (new_lsr & LSR_OVER_ERR)
1613 if (new_lsr & LSR_PAR_ERR)
1615 if (new_lsr & LSR_FRM_ERR)
1619 static void edge_interrupt_callback(struct urb *urb)
1621 struct edgeport_serial *edge_serial = urb->context;
1622 struct usb_serial_port *port;
1623 struct edgeport_port *edge_port;
1625 unsigned char *data = urb->transfer_buffer;
1626 int length = urb->actual_length;
1632 int status = urb->status;
1641 /* this urb is terminated, clean up */
1642 dev_dbg(&urb->dev->dev, "%s - urb shutting down with status: %d\n",
1646 dev_err(&urb->dev->dev, "%s - nonzero urb status received: "
1647 "%d\n", __func__, status);
1652 dev_dbg(&urb->dev->dev, "%s - no data in urb\n", __func__);
1656 dev = &edge_serial->serial->dev->dev;
1657 usb_serial_debug_data(dev, __func__, length, data);
1660 dev_dbg(dev, "%s - expecting packet of size 2, got %d\n", __func__, length);
1664 port_number = TIUMP_GET_PORT_FROM_CODE(data[0]);
1665 function = TIUMP_GET_FUNC_FROM_CODE(data[0]);
1666 dev_dbg(dev, "%s - port_number %d, function %d, info 0x%x\n", __func__,
1667 port_number, function, data[1]);
1669 if (port_number >= edge_serial->serial->num_ports) {
1670 dev_err(dev, "bad port number %d\n", port_number);
1674 port = edge_serial->serial->port[port_number];
1675 edge_port = usb_get_serial_port_data(port);
1677 dev_dbg(dev, "%s - edge_port not found\n", __func__);
1681 case TIUMP_INTERRUPT_CODE_LSR:
1682 lsr = map_line_status(data[1]);
1683 if (lsr & UMP_UART_LSR_DATA_MASK) {
1685 * Save the LSR event for bulk read completion routine
1687 dev_dbg(dev, "%s - LSR Event Port %u LSR Status = %02x\n",
1688 __func__, port_number, lsr);
1689 edge_port->lsr_event = 1;
1690 edge_port->lsr_mask = lsr;
1692 dev_dbg(dev, "%s - ===== Port %d LSR Status = %02x ======\n",
1693 __func__, port_number, lsr);
1694 handle_new_lsr(edge_port, 0, lsr, 0);
1698 case TIUMP_INTERRUPT_CODE_MSR: /* MSR */
1699 /* Copy MSR from UMP */
1701 dev_dbg(dev, "%s - ===== Port %u MSR Status = %02x ======\n",
1702 __func__, port_number, msr);
1703 handle_new_msr(edge_port, msr);
1707 dev_err(&urb->dev->dev,
1708 "%s - Unknown Interrupt code from UMP %x\n",
1715 retval = usb_submit_urb(urb, GFP_ATOMIC);
1717 dev_err(&urb->dev->dev,
1718 "%s - usb_submit_urb failed with result %d\n",
1722 static void edge_bulk_in_callback(struct urb *urb)
1724 struct edgeport_port *edge_port = urb->context;
1725 struct device *dev = &edge_port->port->dev;
1726 unsigned char *data = urb->transfer_buffer;
1727 unsigned long flags;
1730 int status = urb->status;
1739 /* this urb is terminated, clean up */
1740 dev_dbg(&urb->dev->dev, "%s - urb shutting down with status: %d\n", __func__, status);
1743 dev_err(&urb->dev->dev, "%s - nonzero read bulk status received: %d\n", __func__, status);
1746 if (status == -EPIPE)
1750 dev_err(&urb->dev->dev, "%s - stopping read!\n", __func__);
1754 port_number = edge_port->port->port_number;
1756 if (urb->actual_length > 0 && edge_port->lsr_event) {
1757 edge_port->lsr_event = 0;
1758 dev_dbg(dev, "%s ===== Port %u LSR Status = %02x, Data = %02x ======\n",
1759 __func__, port_number, edge_port->lsr_mask, *data);
1760 handle_new_lsr(edge_port, 1, edge_port->lsr_mask, *data);
1761 /* Adjust buffer length/pointer */
1762 --urb->actual_length;
1766 if (urb->actual_length) {
1767 usb_serial_debug_data(dev, __func__, urb->actual_length, data);
1768 if (edge_port->close_pending)
1769 dev_dbg(dev, "%s - close pending, dropping data on the floor\n",
1772 edge_tty_recv(edge_port->port, data,
1773 urb->actual_length);
1774 edge_port->port->icount.rx += urb->actual_length;
1778 /* continue read unless stopped */
1779 spin_lock_irqsave(&edge_port->ep_lock, flags);
1780 if (edge_port->ep_read_urb_state == EDGE_READ_URB_RUNNING)
1781 retval = usb_submit_urb(urb, GFP_ATOMIC);
1782 else if (edge_port->ep_read_urb_state == EDGE_READ_URB_STOPPING)
1783 edge_port->ep_read_urb_state = EDGE_READ_URB_STOPPED;
1785 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
1787 dev_err(dev, "%s - usb_submit_urb failed with result %d\n", __func__, retval);
1790 static void edge_tty_recv(struct usb_serial_port *port, unsigned char *data,
1795 queued = tty_insert_flip_string(&port->port, data, length);
1796 if (queued < length)
1797 dev_err(&port->dev, "%s - dropping data, %d bytes lost\n",
1798 __func__, length - queued);
1799 tty_flip_buffer_push(&port->port);
1802 static void edge_bulk_out_callback(struct urb *urb)
1804 struct usb_serial_port *port = urb->context;
1805 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1806 int status = urb->status;
1807 struct tty_struct *tty;
1809 edge_port->ep_write_urb_in_use = 0;
1818 /* this urb is terminated, clean up */
1819 dev_dbg(&urb->dev->dev, "%s - urb shutting down with status: %d\n",
1823 dev_err_console(port, "%s - nonzero write bulk status "
1824 "received: %d\n", __func__, status);
1827 /* send any buffered data */
1828 tty = tty_port_tty_get(&port->port);
1829 edge_send(port, tty);
1833 static int edge_open(struct tty_struct *tty, struct usb_serial_port *port)
1835 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1836 struct edgeport_serial *edge_serial;
1837 struct usb_device *dev;
1841 u8 transaction_timeout;
1843 if (edge_port == NULL)
1846 dev = port->serial->dev;
1848 /* turn off loopback */
1849 status = ti_do_config(edge_port, UMPC_SET_CLR_LOOPBACK, 0);
1852 "%s - cannot send clear loopback command, %d\n",
1857 /* set up the port settings */
1859 edge_set_termios(tty, port, &tty->termios);
1861 /* open up the port */
1863 /* milliseconds to timeout for DMA transfer */
1864 transaction_timeout = 2;
1866 edge_port->ump_read_timeout =
1867 max(20, ((transaction_timeout * 3) / 2));
1869 /* milliseconds to timeout for DMA transfer */
1870 open_settings = (u8)(UMP_DMA_MODE_CONTINOUS |
1871 UMP_PIPE_TRANS_TIMEOUT_ENA |
1872 (transaction_timeout << 2));
1874 dev_dbg(&port->dev, "%s - Sending UMPC_OPEN_PORT\n", __func__);
1876 /* Tell TI to open and start the port */
1877 status = send_port_cmd(port, UMPC_OPEN_PORT, open_settings, NULL, 0);
1879 dev_err(&port->dev, "%s - cannot send open command, %d\n",
1884 /* Start the DMA? */
1885 status = send_port_cmd(port, UMPC_START_PORT, 0, NULL, 0);
1887 dev_err(&port->dev, "%s - cannot send start DMA command, %d\n",
1892 /* Clear TX and RX buffers in UMP */
1893 status = purge_port(port, UMP_PORT_DIR_OUT | UMP_PORT_DIR_IN);
1896 "%s - cannot send clear buffers command, %d\n",
1901 /* Read Initial MSR */
1902 status = read_port_cmd(port, UMPC_READ_MSR, 0, &edge_port->shadow_msr, 1);
1904 dev_err(&port->dev, "%s - cannot send read MSR command, %d\n",
1909 dev_dbg(&port->dev, "ShadowMSR 0x%X\n", edge_port->shadow_msr);
1911 /* Set Initial MCR */
1912 edge_port->shadow_mcr = MCR_RTS | MCR_DTR;
1913 dev_dbg(&port->dev, "ShadowMCR 0x%X\n", edge_port->shadow_mcr);
1915 edge_serial = edge_port->edge_serial;
1916 if (mutex_lock_interruptible(&edge_serial->es_lock))
1917 return -ERESTARTSYS;
1918 if (edge_serial->num_ports_open == 0) {
1919 /* we are the first port to open, post the interrupt urb */
1920 urb = edge_serial->serial->port[0]->interrupt_in_urb;
1921 urb->context = edge_serial;
1922 status = usb_submit_urb(urb, GFP_KERNEL);
1925 "%s - usb_submit_urb failed with value %d\n",
1927 goto release_es_lock;
1932 * reset the data toggle on the bulk endpoints to work around bug in
1933 * host controllers where things get out of sync some times
1935 usb_clear_halt(dev, port->write_urb->pipe);
1936 usb_clear_halt(dev, port->read_urb->pipe);
1938 /* start up our bulk read urb */
1939 urb = port->read_urb;
1940 edge_port->ep_read_urb_state = EDGE_READ_URB_RUNNING;
1941 urb->context = edge_port;
1942 status = usb_submit_urb(urb, GFP_KERNEL);
1945 "%s - read bulk usb_submit_urb failed with value %d\n",
1947 goto unlink_int_urb;
1950 ++edge_serial->num_ports_open;
1952 goto release_es_lock;
1955 if (edge_port->edge_serial->num_ports_open == 0)
1956 usb_kill_urb(port->serial->port[0]->interrupt_in_urb);
1958 mutex_unlock(&edge_serial->es_lock);
1962 static void edge_close(struct usb_serial_port *port)
1964 struct edgeport_serial *edge_serial;
1965 struct edgeport_port *edge_port;
1966 unsigned long flags;
1968 edge_serial = usb_get_serial_data(port->serial);
1969 edge_port = usb_get_serial_port_data(port);
1970 if (edge_serial == NULL || edge_port == NULL)
1974 * The bulkreadcompletion routine will check
1975 * this flag and dump add read data
1977 edge_port->close_pending = 1;
1979 usb_kill_urb(port->read_urb);
1980 usb_kill_urb(port->write_urb);
1981 edge_port->ep_write_urb_in_use = 0;
1982 spin_lock_irqsave(&edge_port->ep_lock, flags);
1983 kfifo_reset_out(&port->write_fifo);
1984 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
1986 dev_dbg(&port->dev, "%s - send umpc_close_port\n", __func__);
1987 send_port_cmd(port, UMPC_CLOSE_PORT, 0, NULL, 0);
1989 mutex_lock(&edge_serial->es_lock);
1990 --edge_port->edge_serial->num_ports_open;
1991 if (edge_port->edge_serial->num_ports_open <= 0) {
1992 /* last port is now closed, let's shut down our interrupt urb */
1993 usb_kill_urb(port->serial->port[0]->interrupt_in_urb);
1994 edge_port->edge_serial->num_ports_open = 0;
1996 mutex_unlock(&edge_serial->es_lock);
1997 edge_port->close_pending = 0;
2000 static int edge_write(struct tty_struct *tty, struct usb_serial_port *port,
2001 const unsigned char *data, int count)
2003 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2006 dev_dbg(&port->dev, "%s - write request of 0 bytes\n", __func__);
2010 if (edge_port == NULL)
2012 if (edge_port->close_pending == 1)
2015 count = kfifo_in_locked(&port->write_fifo, data, count,
2016 &edge_port->ep_lock);
2017 edge_send(port, tty);
2022 static void edge_send(struct usb_serial_port *port, struct tty_struct *tty)
2025 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2026 unsigned long flags;
2028 spin_lock_irqsave(&edge_port->ep_lock, flags);
2030 if (edge_port->ep_write_urb_in_use) {
2031 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2035 count = kfifo_out(&port->write_fifo,
2036 port->write_urb->transfer_buffer,
2037 port->bulk_out_size);
2040 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2044 edge_port->ep_write_urb_in_use = 1;
2046 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2048 usb_serial_debug_data(&port->dev, __func__, count, port->write_urb->transfer_buffer);
2050 /* set up our urb */
2051 port->write_urb->transfer_buffer_length = count;
2053 /* send the data out the bulk port */
2054 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
2056 dev_err_console(port,
2057 "%s - failed submitting write urb, error %d\n",
2059 edge_port->ep_write_urb_in_use = 0;
2060 /* TODO: reschedule edge_send */
2062 edge_port->port->icount.tx += count;
2065 * wakeup any process waiting for writes to complete
2066 * there is now more room in the buffer for new writes
2072 static unsigned int edge_write_room(struct tty_struct *tty)
2074 struct usb_serial_port *port = tty->driver_data;
2075 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2077 unsigned long flags;
2079 if (edge_port == NULL)
2081 if (edge_port->close_pending == 1)
2084 spin_lock_irqsave(&edge_port->ep_lock, flags);
2085 room = kfifo_avail(&port->write_fifo);
2086 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2088 dev_dbg(&port->dev, "%s - returns %u\n", __func__, room);
2092 static unsigned int edge_chars_in_buffer(struct tty_struct *tty)
2094 struct usb_serial_port *port = tty->driver_data;
2095 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2097 unsigned long flags;
2098 if (edge_port == NULL)
2101 spin_lock_irqsave(&edge_port->ep_lock, flags);
2102 chars = kfifo_len(&port->write_fifo);
2103 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2105 dev_dbg(&port->dev, "%s - returns %u\n", __func__, chars);
2109 static bool edge_tx_empty(struct usb_serial_port *port)
2111 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2114 ret = tx_active(edge_port);
2121 static void edge_throttle(struct tty_struct *tty)
2123 struct usb_serial_port *port = tty->driver_data;
2124 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2127 if (edge_port == NULL)
2130 /* if we are implementing XON/XOFF, send the stop character */
2132 unsigned char stop_char = STOP_CHAR(tty);
2133 status = edge_write(tty, port, &stop_char, 1);
2135 dev_err(&port->dev, "%s - failed to write stop character, %d\n", __func__, status);
2140 * if we are implementing RTS/CTS, stop reads
2141 * and the Edgeport will clear the RTS line
2144 stop_read(edge_port);
2148 static void edge_unthrottle(struct tty_struct *tty)
2150 struct usb_serial_port *port = tty->driver_data;
2151 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2154 if (edge_port == NULL)
2157 /* if we are implementing XON/XOFF, send the start character */
2159 unsigned char start_char = START_CHAR(tty);
2160 status = edge_write(tty, port, &start_char, 1);
2162 dev_err(&port->dev, "%s - failed to write start character, %d\n", __func__, status);
2166 * if we are implementing RTS/CTS, restart reads
2167 * are the Edgeport will assert the RTS line
2169 if (C_CRTSCTS(tty)) {
2170 status = restart_read(edge_port);
2173 "%s - read bulk usb_submit_urb failed: %d\n",
2179 static void stop_read(struct edgeport_port *edge_port)
2181 unsigned long flags;
2183 spin_lock_irqsave(&edge_port->ep_lock, flags);
2185 if (edge_port->ep_read_urb_state == EDGE_READ_URB_RUNNING)
2186 edge_port->ep_read_urb_state = EDGE_READ_URB_STOPPING;
2187 edge_port->shadow_mcr &= ~MCR_RTS;
2189 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2192 static int restart_read(struct edgeport_port *edge_port)
2196 unsigned long flags;
2198 spin_lock_irqsave(&edge_port->ep_lock, flags);
2200 if (edge_port->ep_read_urb_state == EDGE_READ_URB_STOPPED) {
2201 urb = edge_port->port->read_urb;
2202 status = usb_submit_urb(urb, GFP_ATOMIC);
2204 edge_port->ep_read_urb_state = EDGE_READ_URB_RUNNING;
2205 edge_port->shadow_mcr |= MCR_RTS;
2207 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2212 static void change_port_settings(struct tty_struct *tty,
2213 struct edgeport_port *edge_port, struct ktermios *old_termios)
2215 struct device *dev = &edge_port->port->dev;
2216 struct ump_uart_config *config;
2221 config = kmalloc (sizeof (*config), GFP_KERNEL);
2223 tty->termios = *old_termios;
2227 cflag = tty->termios.c_cflag;
2231 /* These flags must be set */
2232 config->wFlags |= UMP_MASK_UART_FLAGS_RECEIVE_MS_INT;
2233 config->wFlags |= UMP_MASK_UART_FLAGS_AUTO_START_ON_ERR;
2234 config->bUartMode = (u8)(edge_port->bUartMode);
2236 switch (cflag & CSIZE) {
2238 config->bDataBits = UMP_UART_CHAR5BITS;
2239 dev_dbg(dev, "%s - data bits = 5\n", __func__);
2242 config->bDataBits = UMP_UART_CHAR6BITS;
2243 dev_dbg(dev, "%s - data bits = 6\n", __func__);
2246 config->bDataBits = UMP_UART_CHAR7BITS;
2247 dev_dbg(dev, "%s - data bits = 7\n", __func__);
2251 config->bDataBits = UMP_UART_CHAR8BITS;
2252 dev_dbg(dev, "%s - data bits = 8\n", __func__);
2256 if (cflag & PARENB) {
2257 if (cflag & PARODD) {
2258 config->wFlags |= UMP_MASK_UART_FLAGS_PARITY;
2259 config->bParity = UMP_UART_ODDPARITY;
2260 dev_dbg(dev, "%s - parity = odd\n", __func__);
2262 config->wFlags |= UMP_MASK_UART_FLAGS_PARITY;
2263 config->bParity = UMP_UART_EVENPARITY;
2264 dev_dbg(dev, "%s - parity = even\n", __func__);
2267 config->bParity = UMP_UART_NOPARITY;
2268 dev_dbg(dev, "%s - parity = none\n", __func__);
2271 if (cflag & CSTOPB) {
2272 config->bStopBits = UMP_UART_STOPBIT2;
2273 dev_dbg(dev, "%s - stop bits = 2\n", __func__);
2275 config->bStopBits = UMP_UART_STOPBIT1;
2276 dev_dbg(dev, "%s - stop bits = 1\n", __func__);
2279 /* figure out the flow control settings */
2280 if (cflag & CRTSCTS) {
2281 config->wFlags |= UMP_MASK_UART_FLAGS_OUT_X_CTS_FLOW;
2282 config->wFlags |= UMP_MASK_UART_FLAGS_RTS_FLOW;
2283 dev_dbg(dev, "%s - RTS/CTS is enabled\n", __func__);
2285 dev_dbg(dev, "%s - RTS/CTS is disabled\n", __func__);
2286 restart_read(edge_port);
2290 * if we are implementing XON/XOFF, set the start and stop
2291 * character in the device
2293 config->cXon = START_CHAR(tty);
2294 config->cXoff = STOP_CHAR(tty);
2296 /* if we are implementing INBOUND XON/XOFF */
2298 config->wFlags |= UMP_MASK_UART_FLAGS_IN_X;
2299 dev_dbg(dev, "%s - INBOUND XON/XOFF is enabled, XON = %2x, XOFF = %2x\n",
2300 __func__, config->cXon, config->cXoff);
2302 dev_dbg(dev, "%s - INBOUND XON/XOFF is disabled\n", __func__);
2304 /* if we are implementing OUTBOUND XON/XOFF */
2306 config->wFlags |= UMP_MASK_UART_FLAGS_OUT_X;
2307 dev_dbg(dev, "%s - OUTBOUND XON/XOFF is enabled, XON = %2x, XOFF = %2x\n",
2308 __func__, config->cXon, config->cXoff);
2310 dev_dbg(dev, "%s - OUTBOUND XON/XOFF is disabled\n", __func__);
2312 tty->termios.c_cflag &= ~CMSPAR;
2314 /* Round the baud rate */
2315 baud = tty_get_baud_rate(tty);
2317 /* pick a default, any default... */
2320 /* Avoid a zero divisor. */
2321 baud = min(baud, 461550);
2322 tty_encode_baud_rate(tty, baud, baud);
2325 edge_port->baud_rate = baud;
2326 config->wBaudRate = (u16)((461550L + baud/2) / baud);
2328 /* FIXME: Recompute actual baud from divisor here */
2330 dev_dbg(dev, "%s - baud rate = %d, wBaudRate = %d\n", __func__, baud, config->wBaudRate);
2332 dev_dbg(dev, "wBaudRate: %d\n", (int)(461550L / config->wBaudRate));
2333 dev_dbg(dev, "wFlags: 0x%x\n", config->wFlags);
2334 dev_dbg(dev, "bDataBits: %d\n", config->bDataBits);
2335 dev_dbg(dev, "bParity: %d\n", config->bParity);
2336 dev_dbg(dev, "bStopBits: %d\n", config->bStopBits);
2337 dev_dbg(dev, "cXon: %d\n", config->cXon);
2338 dev_dbg(dev, "cXoff: %d\n", config->cXoff);
2339 dev_dbg(dev, "bUartMode: %d\n", config->bUartMode);
2341 /* move the word values into big endian mode */
2342 cpu_to_be16s(&config->wFlags);
2343 cpu_to_be16s(&config->wBaudRate);
2345 status = send_port_cmd(edge_port->port, UMPC_SET_CONFIG, 0, config,
2348 dev_dbg(dev, "%s - error %d when trying to write config to device\n",
2353 static void edge_set_termios(struct tty_struct *tty,
2354 struct usb_serial_port *port, struct ktermios *old_termios)
2356 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2358 if (edge_port == NULL)
2360 /* change the port settings to the new ones specified */
2361 change_port_settings(tty, edge_port, old_termios);
2364 static int edge_tiocmset(struct tty_struct *tty,
2365 unsigned int set, unsigned int clear)
2367 struct usb_serial_port *port = tty->driver_data;
2368 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2370 unsigned long flags;
2372 spin_lock_irqsave(&edge_port->ep_lock, flags);
2373 mcr = edge_port->shadow_mcr;
2374 if (set & TIOCM_RTS)
2376 if (set & TIOCM_DTR)
2378 if (set & TIOCM_LOOP)
2379 mcr |= MCR_LOOPBACK;
2381 if (clear & TIOCM_RTS)
2383 if (clear & TIOCM_DTR)
2385 if (clear & TIOCM_LOOP)
2386 mcr &= ~MCR_LOOPBACK;
2388 edge_port->shadow_mcr = mcr;
2389 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2391 restore_mcr(edge_port, mcr);
2395 static int edge_tiocmget(struct tty_struct *tty)
2397 struct usb_serial_port *port = tty->driver_data;
2398 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2399 unsigned int result = 0;
2402 unsigned long flags;
2404 spin_lock_irqsave(&edge_port->ep_lock, flags);
2406 msr = edge_port->shadow_msr;
2407 mcr = edge_port->shadow_mcr;
2408 result = ((mcr & MCR_DTR) ? TIOCM_DTR: 0) /* 0x002 */
2409 | ((mcr & MCR_RTS) ? TIOCM_RTS: 0) /* 0x004 */
2410 | ((msr & EDGEPORT_MSR_CTS) ? TIOCM_CTS: 0) /* 0x020 */
2411 | ((msr & EDGEPORT_MSR_CD) ? TIOCM_CAR: 0) /* 0x040 */
2412 | ((msr & EDGEPORT_MSR_RI) ? TIOCM_RI: 0) /* 0x080 */
2413 | ((msr & EDGEPORT_MSR_DSR) ? TIOCM_DSR: 0); /* 0x100 */
2416 dev_dbg(&port->dev, "%s -- %x\n", __func__, result);
2417 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2422 static void edge_break(struct tty_struct *tty, int break_state)
2424 struct usb_serial_port *port = tty->driver_data;
2425 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2427 int bv = 0; /* Off */
2429 if (break_state == -1)
2431 status = ti_do_config(edge_port, UMPC_SET_CLR_BREAK, bv);
2433 dev_dbg(&port->dev, "%s - error %d sending break set/clear command.\n",
2437 static void edge_heartbeat_schedule(struct edgeport_serial *edge_serial)
2439 if (!edge_serial->use_heartbeat)
2442 schedule_delayed_work(&edge_serial->heartbeat_work,
2443 FW_HEARTBEAT_SECS * HZ);
2446 static void edge_heartbeat_work(struct work_struct *work)
2448 struct edgeport_serial *serial;
2449 struct ti_i2c_desc *rom_desc;
2451 serial = container_of(work, struct edgeport_serial,
2452 heartbeat_work.work);
2454 rom_desc = kmalloc(sizeof(*rom_desc), GFP_KERNEL);
2456 /* Descriptor address request is enough to reset the firmware timer */
2457 if (!rom_desc || !get_descriptor_addr(serial, I2C_DESC_TYPE_ION,
2459 dev_err(&serial->serial->interface->dev,
2460 "%s - Incomplete heartbeat\n", __func__);
2464 edge_heartbeat_schedule(serial);
2467 static int edge_calc_num_ports(struct usb_serial *serial,
2468 struct usb_serial_endpoints *epds)
2470 struct device *dev = &serial->interface->dev;
2471 unsigned char num_ports = serial->type->num_ports;
2473 /* Make sure we have the required endpoints when in download mode. */
2474 if (serial->interface->cur_altsetting->desc.bNumEndpoints > 1) {
2475 if (epds->num_bulk_in < num_ports ||
2476 epds->num_bulk_out < num_ports ||
2477 epds->num_interrupt_in < 1) {
2478 dev_err(dev, "required endpoints missing\n");
2486 static int edge_startup(struct usb_serial *serial)
2488 struct edgeport_serial *edge_serial;
2492 /* create our private serial structure */
2493 edge_serial = kzalloc(sizeof(struct edgeport_serial), GFP_KERNEL);
2497 mutex_init(&edge_serial->es_lock);
2498 edge_serial->serial = serial;
2499 INIT_DELAYED_WORK(&edge_serial->heartbeat_work, edge_heartbeat_work);
2500 usb_set_serial_data(serial, edge_serial);
2502 status = download_fw(edge_serial);
2509 return 1; /* bind but do not register any ports */
2511 product_id = le16_to_cpu(
2512 edge_serial->serial->dev->descriptor.idProduct);
2514 /* Currently only the EP/416 models require heartbeat support */
2515 if (edge_serial->fw_version > FW_HEARTBEAT_VERSION_CUTOFF) {
2516 if (product_id == ION_DEVICE_ID_TI_EDGEPORT_416 ||
2517 product_id == ION_DEVICE_ID_TI_EDGEPORT_416B) {
2518 edge_serial->use_heartbeat = true;
2522 edge_heartbeat_schedule(edge_serial);
2527 static void edge_disconnect(struct usb_serial *serial)
2529 struct edgeport_serial *edge_serial = usb_get_serial_data(serial);
2531 cancel_delayed_work_sync(&edge_serial->heartbeat_work);
2534 static void edge_release(struct usb_serial *serial)
2536 struct edgeport_serial *edge_serial = usb_get_serial_data(serial);
2538 cancel_delayed_work_sync(&edge_serial->heartbeat_work);
2542 static int edge_port_probe(struct usb_serial_port *port)
2544 struct edgeport_port *edge_port;
2547 edge_port = kzalloc(sizeof(*edge_port), GFP_KERNEL);
2551 spin_lock_init(&edge_port->ep_lock);
2552 edge_port->port = port;
2553 edge_port->edge_serial = usb_get_serial_data(port->serial);
2554 edge_port->bUartMode = default_uart_mode;
2556 switch (port->port_number) {
2558 edge_port->uart_base = UMPMEM_BASE_UART1;
2559 edge_port->dma_address = UMPD_OEDB1_ADDRESS;
2562 edge_port->uart_base = UMPMEM_BASE_UART2;
2563 edge_port->dma_address = UMPD_OEDB2_ADDRESS;
2566 dev_err(&port->dev, "unknown port number\n");
2572 "%s - port_number = %d, uart_base = %04x, dma_address = %04x\n",
2573 __func__, port->port_number, edge_port->uart_base,
2574 edge_port->dma_address);
2576 usb_set_serial_port_data(port, edge_port);
2578 ret = edge_create_sysfs_attrs(port);
2583 * The LSR does not tell when the transmitter shift register has
2584 * emptied so add a one-character drain delay.
2586 port->port.drain_delay = 1;
2595 static void edge_port_remove(struct usb_serial_port *port)
2597 struct edgeport_port *edge_port;
2599 edge_port = usb_get_serial_port_data(port);
2600 edge_remove_sysfs_attrs(port);
2604 /* Sysfs Attributes */
2606 static ssize_t uart_mode_show(struct device *dev,
2607 struct device_attribute *attr, char *buf)
2609 struct usb_serial_port *port = to_usb_serial_port(dev);
2610 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2612 return sprintf(buf, "%d\n", edge_port->bUartMode);
2615 static ssize_t uart_mode_store(struct device *dev,
2616 struct device_attribute *attr, const char *valbuf, size_t count)
2618 struct usb_serial_port *port = to_usb_serial_port(dev);
2619 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2620 unsigned int v = simple_strtoul(valbuf, NULL, 0);
2622 dev_dbg(dev, "%s: setting uart_mode = %d\n", __func__, v);
2625 edge_port->bUartMode = v;
2627 dev_err(dev, "%s - uart_mode %d is invalid\n", __func__, v);
2631 static DEVICE_ATTR_RW(uart_mode);
2633 static int edge_create_sysfs_attrs(struct usb_serial_port *port)
2635 return device_create_file(&port->dev, &dev_attr_uart_mode);
2638 static int edge_remove_sysfs_attrs(struct usb_serial_port *port)
2640 device_remove_file(&port->dev, &dev_attr_uart_mode);
2645 static int edge_suspend(struct usb_serial *serial, pm_message_t message)
2647 struct edgeport_serial *edge_serial = usb_get_serial_data(serial);
2649 cancel_delayed_work_sync(&edge_serial->heartbeat_work);
2654 static int edge_resume(struct usb_serial *serial)
2656 struct edgeport_serial *edge_serial = usb_get_serial_data(serial);
2658 edge_heartbeat_schedule(edge_serial);
2664 static struct usb_serial_driver edgeport_1port_device = {
2666 .owner = THIS_MODULE,
2667 .name = "edgeport_ti_1",
2669 .description = "Edgeport TI 1 port adapter",
2670 .id_table = edgeport_1port_id_table,
2674 .close = edge_close,
2675 .throttle = edge_throttle,
2676 .unthrottle = edge_unthrottle,
2677 .attach = edge_startup,
2678 .calc_num_ports = edge_calc_num_ports,
2679 .disconnect = edge_disconnect,
2680 .release = edge_release,
2681 .port_probe = edge_port_probe,
2682 .port_remove = edge_port_remove,
2683 .set_termios = edge_set_termios,
2684 .tiocmget = edge_tiocmget,
2685 .tiocmset = edge_tiocmset,
2686 .tiocmiwait = usb_serial_generic_tiocmiwait,
2687 .get_icount = usb_serial_generic_get_icount,
2688 .write = edge_write,
2689 .write_room = edge_write_room,
2690 .chars_in_buffer = edge_chars_in_buffer,
2691 .tx_empty = edge_tx_empty,
2692 .break_ctl = edge_break,
2693 .read_int_callback = edge_interrupt_callback,
2694 .read_bulk_callback = edge_bulk_in_callback,
2695 .write_bulk_callback = edge_bulk_out_callback,
2697 .suspend = edge_suspend,
2698 .resume = edge_resume,
2702 static struct usb_serial_driver edgeport_2port_device = {
2704 .owner = THIS_MODULE,
2705 .name = "edgeport_ti_2",
2707 .description = "Edgeport TI 2 port adapter",
2708 .id_table = edgeport_2port_id_table,
2712 .close = edge_close,
2713 .throttle = edge_throttle,
2714 .unthrottle = edge_unthrottle,
2715 .attach = edge_startup,
2716 .calc_num_ports = edge_calc_num_ports,
2717 .disconnect = edge_disconnect,
2718 .release = edge_release,
2719 .port_probe = edge_port_probe,
2720 .port_remove = edge_port_remove,
2721 .set_termios = edge_set_termios,
2722 .tiocmget = edge_tiocmget,
2723 .tiocmset = edge_tiocmset,
2724 .tiocmiwait = usb_serial_generic_tiocmiwait,
2725 .get_icount = usb_serial_generic_get_icount,
2726 .write = edge_write,
2727 .write_room = edge_write_room,
2728 .chars_in_buffer = edge_chars_in_buffer,
2729 .tx_empty = edge_tx_empty,
2730 .break_ctl = edge_break,
2731 .read_int_callback = edge_interrupt_callback,
2732 .read_bulk_callback = edge_bulk_in_callback,
2733 .write_bulk_callback = edge_bulk_out_callback,
2735 .suspend = edge_suspend,
2736 .resume = edge_resume,
2740 static struct usb_serial_driver * const serial_drivers[] = {
2741 &edgeport_1port_device, &edgeport_2port_device, NULL
2744 module_usb_serial_driver(serial_drivers, id_table_combined);
2746 MODULE_AUTHOR(DRIVER_AUTHOR);
2747 MODULE_DESCRIPTION(DRIVER_DESC);
2748 MODULE_LICENSE("GPL");
2749 MODULE_FIRMWARE("edgeport/down3.bin");
2751 module_param(ignore_cpu_rev, bool, 0644);
2752 MODULE_PARM_DESC(ignore_cpu_rev,
2753 "Ignore the cpu revision when connecting to a device");
2755 module_param(default_uart_mode, int, 0644);
2756 MODULE_PARM_DESC(default_uart_mode, "Default uart_mode, 0=RS232, ...");