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) },
178 /* Devices that this driver supports */
179 static const struct usb_device_id id_table_combined[] = {
180 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_1) },
181 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_TI3410_EDGEPORT_1) },
182 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_TI3410_EDGEPORT_1I) },
183 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_PROXIMITY) },
184 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_MOTION) },
185 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_MOISTURE) },
186 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_TEMPERATURE) },
187 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_HUMIDITY) },
188 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_POWER) },
189 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_LIGHT) },
190 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_RADIATION) },
191 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_DISTANCE) },
192 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_ACCELERATION) },
193 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_PROX_DIST) },
194 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_PLUS_PWR_HP4CD) },
195 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_PLUS_PWR_PCI) },
196 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_2) },
197 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_2C) },
198 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_2I) },
199 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_421) },
200 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_21) },
201 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_42) },
202 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_4) },
203 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_4I) },
204 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_22I) },
205 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_221C) },
206 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_22C) },
207 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_21C) },
208 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_4S) },
209 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_8) },
210 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_8S) },
211 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_416) },
212 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_416B) },
216 MODULE_DEVICE_TABLE(usb, id_table_combined);
218 static int closing_wait = EDGE_CLOSING_WAIT;
219 static bool ignore_cpu_rev;
220 static int default_uart_mode; /* RS232 */
222 static void edge_tty_recv(struct usb_serial_port *port, unsigned char *data,
225 static void stop_read(struct edgeport_port *edge_port);
226 static int restart_read(struct edgeport_port *edge_port);
228 static void edge_set_termios(struct tty_struct *tty,
229 struct usb_serial_port *port, struct ktermios *old_termios);
230 static void edge_send(struct usb_serial_port *port, struct tty_struct *tty);
232 static int do_download_mode(struct edgeport_serial *serial,
233 const struct firmware *fw);
234 static int do_boot_mode(struct edgeport_serial *serial,
235 const struct firmware *fw);
237 /* sysfs attributes */
238 static int edge_create_sysfs_attrs(struct usb_serial_port *port);
239 static int edge_remove_sysfs_attrs(struct usb_serial_port *port);
242 * Some release of Edgeport firmware "down3.bin" after version 4.80
243 * introduced code to automatically disconnect idle devices on some
244 * Edgeport models after periods of inactivity, typically ~60 seconds.
245 * This occurs without regard to whether ports on the device are open
246 * or not. Digi International Tech Support suggested:
248 * 1. Adding driver "heartbeat" code to reset the firmware timer by
249 * requesting a descriptor record every 15 seconds, which should be
250 * effective with newer firmware versions that require it, and benign
251 * with older versions that do not. In practice 40 seconds seems often
253 * 2. The heartbeat code is currently required only on Edgeport/416 models.
255 #define FW_HEARTBEAT_VERSION_CUTOFF ((4 << 8) + 80)
256 #define FW_HEARTBEAT_SECS 40
258 /* Timeouts in msecs: firmware downloads take longer */
259 #define TI_VSEND_TIMEOUT_DEFAULT 1000
260 #define TI_VSEND_TIMEOUT_FW_DOWNLOAD 10000
262 static int ti_vread_sync(struct usb_device *dev, __u8 request,
263 __u16 value, __u16 index, u8 *data, int size)
267 status = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0), request,
268 (USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN),
269 value, index, data, size, 1000);
272 if (status != size) {
273 dev_dbg(&dev->dev, "%s - wanted to write %d, but only wrote %d\n",
274 __func__, size, status);
280 static int ti_vsend_sync(struct usb_device *dev, u8 request, u16 value,
281 u16 index, u8 *data, int size, int timeout)
285 status = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), request,
286 (USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT),
287 value, index, data, size, timeout);
290 if (status != size) {
291 dev_dbg(&dev->dev, "%s - wanted to write %d, but only wrote %d\n",
292 __func__, size, status);
298 static int send_cmd(struct usb_device *dev, __u8 command,
299 __u8 moduleid, __u16 value, u8 *data,
302 return ti_vsend_sync(dev, command, value, moduleid, data, size,
303 TI_VSEND_TIMEOUT_DEFAULT);
306 /* clear tx/rx buffers and fifo in TI UMP */
307 static int purge_port(struct usb_serial_port *port, __u16 mask)
309 int port_number = port->port_number;
311 dev_dbg(&port->dev, "%s - port %d, mask %x\n", __func__, port_number, mask);
313 return send_cmd(port->serial->dev,
315 (__u8)(UMPM_UART1_PORT + port_number),
322 * read_download_mem - Read edgeport memory from TI chip
323 * @dev: usb device pointer
324 * @start_address: Device CPU address at which to read
325 * @length: Length of above data
326 * @address_type: Can read both XDATA and I2C
327 * @buffer: pointer to input data buffer
329 static int read_download_mem(struct usb_device *dev, int start_address,
330 int length, __u8 address_type, __u8 *buffer)
334 u16 be_start_address;
336 dev_dbg(&dev->dev, "%s - @ %x for %d\n", __func__, start_address, length);
339 * Read in blocks of 64 bytes
340 * (TI firmware can't handle more than 64 byte reads)
346 read_length = (__u8)length;
348 if (read_length > 1) {
349 dev_dbg(&dev->dev, "%s - @ %x for %d\n", __func__, start_address, read_length);
352 * NOTE: Must use swab as wIndex is sent in little-endian
353 * byte order regardless of host byte order.
355 be_start_address = swab16((u16)start_address);
356 status = ti_vread_sync(dev, UMPC_MEMORY_READ,
359 buffer, read_length);
362 dev_dbg(&dev->dev, "%s - ERROR %x\n", __func__, status);
367 usb_serial_debug_data(&dev->dev, __func__, read_length, buffer);
369 /* Update pointers/length */
370 start_address += read_length;
371 buffer += read_length;
372 length -= read_length;
378 static int read_ram(struct usb_device *dev, int start_address,
379 int length, __u8 *buffer)
381 return read_download_mem(dev, start_address, length,
382 DTK_ADDR_SPACE_XDATA, buffer);
385 /* Read edgeport memory to a given block */
386 static int read_boot_mem(struct edgeport_serial *serial,
387 int start_address, int length, __u8 *buffer)
392 for (i = 0; i < length; i++) {
393 status = ti_vread_sync(serial->serial->dev,
394 UMPC_MEMORY_READ, serial->TI_I2C_Type,
395 (__u16)(start_address+i), &buffer[i], 0x01);
397 dev_dbg(&serial->serial->dev->dev, "%s - ERROR %x\n", __func__, status);
402 dev_dbg(&serial->serial->dev->dev, "%s - start_address = %x, length = %d\n",
403 __func__, start_address, length);
404 usb_serial_debug_data(&serial->serial->dev->dev, __func__, length, buffer);
406 serial->TiReadI2C = 1;
411 /* Write given block to TI EPROM memory */
412 static int write_boot_mem(struct edgeport_serial *serial,
413 int start_address, int length, __u8 *buffer)
419 /* Must do a read before write */
420 if (!serial->TiReadI2C) {
421 temp = kmalloc(1, GFP_KERNEL);
425 status = read_boot_mem(serial, 0, 1, temp);
431 for (i = 0; i < length; ++i) {
432 status = ti_vsend_sync(serial->serial->dev, UMPC_MEMORY_WRITE,
433 buffer[i], (u16)(i + start_address), NULL,
434 0, TI_VSEND_TIMEOUT_DEFAULT);
439 dev_dbg(&serial->serial->dev->dev, "%s - start_sddr = %x, length = %d\n", __func__, start_address, length);
440 usb_serial_debug_data(&serial->serial->dev->dev, __func__, length, buffer);
445 /* Write edgeport I2C memory to TI chip */
446 static int write_i2c_mem(struct edgeport_serial *serial,
447 int start_address, int length, __u8 address_type, __u8 *buffer)
449 struct device *dev = &serial->serial->dev->dev;
452 u16 be_start_address;
454 /* We can only send a maximum of 1 aligned byte page at a time */
456 /* calculate the number of bytes left in the first page */
457 write_length = EPROM_PAGE_SIZE -
458 (start_address & (EPROM_PAGE_SIZE - 1));
460 if (write_length > length)
461 write_length = length;
463 dev_dbg(dev, "%s - BytesInFirstPage Addr = %x, length = %d\n",
464 __func__, start_address, write_length);
465 usb_serial_debug_data(dev, __func__, write_length, buffer);
470 * NOTE: Must use swab as wIndex is sent in little-endian byte order
471 * regardless of host byte order.
473 be_start_address = swab16((u16)start_address);
474 status = ti_vsend_sync(serial->serial->dev, UMPC_MEMORY_WRITE,
475 (u16)address_type, be_start_address,
476 buffer, write_length, TI_VSEND_TIMEOUT_DEFAULT);
478 dev_dbg(dev, "%s - ERROR %d\n", __func__, status);
482 length -= write_length;
483 start_address += write_length;
484 buffer += write_length;
487 * We should be aligned now -- can write max page size bytes at a
491 if (length > EPROM_PAGE_SIZE)
492 write_length = EPROM_PAGE_SIZE;
494 write_length = length;
496 dev_dbg(dev, "%s - Page Write Addr = %x, length = %d\n",
497 __func__, start_address, write_length);
498 usb_serial_debug_data(dev, __func__, write_length, buffer);
503 * NOTE: Must use swab as wIndex is sent in little-endian byte
504 * order regardless of host byte order.
506 be_start_address = swab16((u16)start_address);
507 status = ti_vsend_sync(serial->serial->dev, UMPC_MEMORY_WRITE,
508 (u16)address_type, be_start_address, buffer,
509 write_length, TI_VSEND_TIMEOUT_DEFAULT);
511 dev_err(dev, "%s - ERROR %d\n", __func__, status);
515 length -= write_length;
516 start_address += write_length;
517 buffer += write_length;
523 * Examine the UMP DMA registers and LSR
525 * Check the MSBit of the X and Y DMA byte count registers.
526 * A zero in this bit indicates that the TX DMA buffers are empty
527 * then check the TX Empty bit in the UART.
529 static int tx_active(struct edgeport_port *port)
532 struct out_endpoint_desc_block *oedb;
536 oedb = kmalloc(sizeof(*oedb), GFP_KERNEL);
541 * Sigh, that's right, just one byte, as not all platforms can
544 lsr = kmalloc(1, GFP_KERNEL);
549 /* Read the DMA Count Registers */
550 status = read_ram(port->port->serial->dev, port->dma_address,
551 sizeof(*oedb), (void *)oedb);
553 goto exit_is_tx_active;
555 dev_dbg(&port->port->dev, "%s - XByteCount 0x%X\n", __func__, oedb->XByteCount);
558 status = read_ram(port->port->serial->dev,
559 port->uart_base + UMPMEM_OFFS_UART_LSR, 1, lsr);
562 goto exit_is_tx_active;
563 dev_dbg(&port->port->dev, "%s - LSR = 0x%X\n", __func__, *lsr);
565 /* If either buffer has data or we are transmitting then return TRUE */
566 if ((oedb->XByteCount & 0x80) != 0)
569 if ((*lsr & UMP_UART_LSR_TX_MASK) == 0)
572 /* We return Not Active if we get any kind of error */
574 dev_dbg(&port->port->dev, "%s - return %d\n", __func__, bytes_left);
581 static int choose_config(struct usb_device *dev)
584 * There may be multiple configurations on this device, in which case
585 * we would need to read and parse all of them to find out which one
586 * we want. However, we just support one config at this point,
587 * configuration # 1, which is Config Descriptor 0.
590 dev_dbg(&dev->dev, "%s - Number of Interfaces = %d\n",
591 __func__, dev->config->desc.bNumInterfaces);
592 dev_dbg(&dev->dev, "%s - MAX Power = %d\n",
593 __func__, dev->config->desc.bMaxPower * 2);
595 if (dev->config->desc.bNumInterfaces != 1) {
596 dev_err(&dev->dev, "%s - bNumInterfaces is not 1, ERROR!\n", __func__);
603 static int read_rom(struct edgeport_serial *serial,
604 int start_address, int length, __u8 *buffer)
608 if (serial->product_info.TiMode == TI_MODE_DOWNLOAD) {
609 status = read_download_mem(serial->serial->dev,
615 status = read_boot_mem(serial, start_address, length,
621 static int write_rom(struct edgeport_serial *serial, int start_address,
622 int length, __u8 *buffer)
624 if (serial->product_info.TiMode == TI_MODE_BOOT)
625 return write_boot_mem(serial, start_address, length,
628 if (serial->product_info.TiMode == TI_MODE_DOWNLOAD)
629 return write_i2c_mem(serial, start_address, length,
630 serial->TI_I2C_Type, buffer);
634 /* Read a descriptor header from I2C based on type */
635 static int get_descriptor_addr(struct edgeport_serial *serial,
636 int desc_type, struct ti_i2c_desc *rom_desc)
641 /* Search for requested descriptor in I2C */
644 status = read_rom(serial,
646 sizeof(struct ti_i2c_desc),
651 if (rom_desc->Type == desc_type)
652 return start_address;
654 start_address = start_address + sizeof(struct ti_i2c_desc) +
655 le16_to_cpu(rom_desc->Size);
657 } while ((start_address < TI_MAX_I2C_SIZE) && rom_desc->Type);
662 /* Validate descriptor checksum */
663 static int valid_csum(struct ti_i2c_desc *rom_desc, __u8 *buffer)
668 for (i = 0; i < le16_to_cpu(rom_desc->Size); i++)
669 cs = (__u8)(cs + buffer[i]);
671 if (cs != rom_desc->CheckSum) {
672 pr_debug("%s - Mismatch %x - %x", __func__, rom_desc->CheckSum, cs);
678 /* Make sure that the I2C image is good */
679 static int check_i2c_image(struct edgeport_serial *serial)
681 struct device *dev = &serial->serial->dev->dev;
683 struct ti_i2c_desc *rom_desc;
684 int start_address = 2;
688 rom_desc = kmalloc(sizeof(*rom_desc), GFP_KERNEL);
692 buffer = kmalloc(TI_MAX_I2C_SIZE, GFP_KERNEL);
698 /* Read the first byte (Signature0) must be 0x52 or 0x10 */
699 status = read_rom(serial, 0, 1, buffer);
703 if (*buffer != UMP5152 && *buffer != UMP3410) {
704 dev_err(dev, "%s - invalid buffer signature\n", __func__);
710 /* Validate the I2C */
711 status = read_rom(serial,
713 sizeof(struct ti_i2c_desc),
718 if ((start_address + sizeof(struct ti_i2c_desc) +
719 le16_to_cpu(rom_desc->Size)) > TI_MAX_I2C_SIZE) {
721 dev_dbg(dev, "%s - structure too big, erroring out.\n", __func__);
725 dev_dbg(dev, "%s Type = 0x%x\n", __func__, rom_desc->Type);
727 /* Skip type 2 record */
728 ttype = rom_desc->Type & 0x0f;
729 if (ttype != I2C_DESC_TYPE_FIRMWARE_BASIC
730 && ttype != I2C_DESC_TYPE_FIRMWARE_AUTO) {
731 /* Read the descriptor data */
732 status = read_rom(serial, start_address +
733 sizeof(struct ti_i2c_desc),
734 le16_to_cpu(rom_desc->Size),
739 status = valid_csum(rom_desc, buffer);
743 start_address = start_address + sizeof(struct ti_i2c_desc) +
744 le16_to_cpu(rom_desc->Size);
746 } while ((rom_desc->Type != I2C_DESC_TYPE_ION) &&
747 (start_address < TI_MAX_I2C_SIZE));
749 if ((rom_desc->Type != I2C_DESC_TYPE_ION) ||
750 (start_address > TI_MAX_I2C_SIZE))
759 static int get_manuf_info(struct edgeport_serial *serial, __u8 *buffer)
763 struct ti_i2c_desc *rom_desc;
764 struct edge_ti_manuf_descriptor *desc;
765 struct device *dev = &serial->serial->dev->dev;
767 rom_desc = kmalloc(sizeof(*rom_desc), GFP_KERNEL);
771 start_address = get_descriptor_addr(serial, I2C_DESC_TYPE_ION,
774 if (!start_address) {
775 dev_dbg(dev, "%s - Edge Descriptor not found in I2C\n", __func__);
780 /* Read the descriptor data */
781 status = read_rom(serial, start_address+sizeof(struct ti_i2c_desc),
782 le16_to_cpu(rom_desc->Size), buffer);
786 status = valid_csum(rom_desc, buffer);
788 desc = (struct edge_ti_manuf_descriptor *)buffer;
789 dev_dbg(dev, "%s - IonConfig 0x%x\n", __func__, desc->IonConfig);
790 dev_dbg(dev, "%s - Version %d\n", __func__, desc->Version);
791 dev_dbg(dev, "%s - Cpu/Board 0x%x\n", __func__, desc->CpuRev_BoardRev);
792 dev_dbg(dev, "%s - NumPorts %d\n", __func__, desc->NumPorts);
793 dev_dbg(dev, "%s - NumVirtualPorts %d\n", __func__, desc->NumVirtualPorts);
794 dev_dbg(dev, "%s - TotalPorts %d\n", __func__, desc->TotalPorts);
801 /* Build firmware header used for firmware update */
802 static int build_i2c_fw_hdr(u8 *header, const struct firmware *fw)
808 struct ti_i2c_desc *i2c_header;
809 struct ti_i2c_image_header *img_header;
810 struct ti_i2c_firmware_rec *firmware_rec;
811 struct edgeport_fw_hdr *fw_hdr = (struct edgeport_fw_hdr *)fw->data;
814 * In order to update the I2C firmware we must change the type 2 record
815 * to type 0xF2. This will force the UMP to come up in Boot Mode.
816 * Then while in boot mode, the driver will download the latest
817 * firmware (padded to 15.5k) into the UMP ram. And finally when the
818 * device comes back up in download mode the driver will cause the new
819 * firmware to be copied from the UMP Ram to I2C and the firmware will
820 * update the record type from 0xf2 to 0x02.
824 * Allocate a 15.5k buffer + 2 bytes for version number (Firmware
827 buffer_size = (((1024 * 16) - 512 ) +
828 sizeof(struct ti_i2c_firmware_rec));
830 buffer = kmalloc(buffer_size, GFP_KERNEL);
834 /* Set entire image of 0xffs */
835 memset(buffer, 0xff, buffer_size);
837 /* Copy version number into firmware record */
838 firmware_rec = (struct ti_i2c_firmware_rec *)buffer;
840 firmware_rec->Ver_Major = fw_hdr->major_version;
841 firmware_rec->Ver_Minor = fw_hdr->minor_version;
843 /* Pointer to fw_down memory image */
844 img_header = (struct ti_i2c_image_header *)&fw->data[4];
846 memcpy(buffer + sizeof(struct ti_i2c_firmware_rec),
847 &fw->data[4 + sizeof(struct ti_i2c_image_header)],
848 le16_to_cpu(img_header->Length));
850 for (i=0; i < buffer_size; i++) {
851 cs = (__u8)(cs + buffer[i]);
856 /* Build new header */
857 i2c_header = (struct ti_i2c_desc *)header;
858 firmware_rec = (struct ti_i2c_firmware_rec*)i2c_header->Data;
860 i2c_header->Type = I2C_DESC_TYPE_FIRMWARE_BLANK;
861 i2c_header->Size = cpu_to_le16(buffer_size);
862 i2c_header->CheckSum = cs;
863 firmware_rec->Ver_Major = fw_hdr->major_version;
864 firmware_rec->Ver_Minor = fw_hdr->minor_version;
869 /* Try to figure out what type of I2c we have */
870 static int i2c_type_bootmode(struct edgeport_serial *serial)
872 struct device *dev = &serial->serial->dev->dev;
876 data = kmalloc(1, GFP_KERNEL);
880 /* Try to read type 2 */
881 status = ti_vread_sync(serial->serial->dev, UMPC_MEMORY_READ,
882 DTK_ADDR_SPACE_I2C_TYPE_II, 0, data, 0x01);
884 dev_dbg(dev, "%s - read 2 status error = %d\n", __func__, status);
886 dev_dbg(dev, "%s - read 2 data = 0x%x\n", __func__, *data);
887 if ((!status) && (*data == UMP5152 || *data == UMP3410)) {
888 dev_dbg(dev, "%s - ROM_TYPE_II\n", __func__);
889 serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_II;
893 /* Try to read type 3 */
894 status = ti_vread_sync(serial->serial->dev, UMPC_MEMORY_READ,
895 DTK_ADDR_SPACE_I2C_TYPE_III, 0, data, 0x01);
897 dev_dbg(dev, "%s - read 3 status error = %d\n", __func__, status);
899 dev_dbg(dev, "%s - read 2 data = 0x%x\n", __func__, *data);
900 if ((!status) && (*data == UMP5152 || *data == UMP3410)) {
901 dev_dbg(dev, "%s - ROM_TYPE_III\n", __func__);
902 serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_III;
906 dev_dbg(dev, "%s - Unknown\n", __func__);
907 serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_II;
914 static int bulk_xfer(struct usb_serial *serial, void *buffer,
915 int length, int *num_sent)
919 status = usb_bulk_msg(serial->dev,
920 usb_sndbulkpipe(serial->dev,
921 serial->port[0]->bulk_out_endpointAddress),
922 buffer, length, num_sent, 1000);
926 /* Download given firmware image to the device (IN BOOT MODE) */
927 static int download_code(struct edgeport_serial *serial, __u8 *image,
935 /* Transfer firmware image */
936 for (pos = 0; pos < image_length; ) {
937 /* Read the next buffer from file */
938 transfer = image_length - pos;
939 if (transfer > EDGE_FW_BULK_MAX_PACKET_SIZE)
940 transfer = EDGE_FW_BULK_MAX_PACKET_SIZE;
943 status = bulk_xfer(serial->serial, &image[pos],
947 /* Advance buffer pointer */
955 static int config_boot_dev(struct usb_device *dev)
960 static int ti_cpu_rev(struct edge_ti_manuf_descriptor *desc)
962 return TI_GET_CPU_REVISION(desc->CpuRev_BoardRev);
965 static int check_fw_sanity(struct edgeport_serial *serial,
966 const struct firmware *fw)
971 struct device *dev = &serial->serial->interface->dev;
972 struct edgeport_fw_hdr *fw_hdr = (struct edgeport_fw_hdr *)fw->data;
974 if (fw->size < sizeof(struct edgeport_fw_hdr)) {
975 dev_err(dev, "incomplete fw header\n");
979 length_total = le16_to_cpu(fw_hdr->length) +
980 sizeof(struct edgeport_fw_hdr);
982 if (fw->size != length_total) {
983 dev_err(dev, "bad fw size (expected: %u, got: %zu)\n",
984 length_total, fw->size);
988 for (pos = sizeof(struct edgeport_fw_hdr); pos < fw->size; ++pos)
989 checksum += fw->data[pos];
991 if (checksum != fw_hdr->checksum) {
992 dev_err(dev, "bad fw checksum (expected: 0x%x, got: 0x%x)\n",
993 fw_hdr->checksum, checksum);
1001 * DownloadTIFirmware - Download run-time operating firmware to the TI5052
1003 * This routine downloads the main operating code into the TI5052, using the
1004 * boot code already burned into E2PROM or ROM.
1006 static int download_fw(struct edgeport_serial *serial)
1008 struct device *dev = &serial->serial->interface->dev;
1010 struct usb_interface_descriptor *interface;
1011 const struct firmware *fw;
1012 const char *fw_name = "edgeport/down3.bin";
1013 struct edgeport_fw_hdr *fw_hdr;
1015 status = request_firmware(&fw, fw_name, dev);
1017 dev_err(dev, "Failed to load image \"%s\" err %d\n",
1022 if (check_fw_sanity(serial, fw)) {
1027 fw_hdr = (struct edgeport_fw_hdr *)fw->data;
1029 /* If on-board version is newer, "fw_version" will be updated later. */
1030 serial->fw_version = (fw_hdr->major_version << 8) +
1031 fw_hdr->minor_version;
1034 * This routine is entered by both the BOOT mode and the Download mode
1035 * We can determine which code is running by the reading the config
1036 * descriptor and if we have only one bulk pipe it is in boot mode
1038 serial->product_info.hardware_type = HARDWARE_TYPE_TIUMP;
1040 /* Default to type 2 i2c */
1041 serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_II;
1043 status = choose_config(serial->serial->dev);
1047 interface = &serial->serial->interface->cur_altsetting->desc;
1049 dev_err(dev, "%s - no interface set, error!\n", __func__);
1055 * Setup initial mode -- the default mode 0 is TI_MODE_CONFIGURING
1056 * if we have more than one endpoint we are definitely in download
1059 if (interface->bNumEndpoints > 1) {
1060 serial->product_info.TiMode = TI_MODE_DOWNLOAD;
1061 status = do_download_mode(serial, fw);
1063 /* Otherwise we will remain in configuring mode */
1064 serial->product_info.TiMode = TI_MODE_CONFIGURING;
1065 status = do_boot_mode(serial, fw);
1069 release_firmware(fw);
1073 static int do_download_mode(struct edgeport_serial *serial,
1074 const struct firmware *fw)
1076 struct device *dev = &serial->serial->interface->dev;
1079 struct edge_ti_manuf_descriptor *ti_manuf_desc;
1080 int download_cur_ver;
1081 int download_new_ver;
1082 struct edgeport_fw_hdr *fw_hdr = (struct edgeport_fw_hdr *)fw->data;
1083 struct ti_i2c_desc *rom_desc;
1085 dev_dbg(dev, "%s - RUNNING IN DOWNLOAD MODE\n", __func__);
1087 status = check_i2c_image(serial);
1089 dev_dbg(dev, "%s - DOWNLOAD MODE -- BAD I2C\n", __func__);
1094 * Validate Hardware version number
1095 * Read Manufacturing Descriptor from TI Based Edgeport
1097 ti_manuf_desc = kmalloc(sizeof(*ti_manuf_desc), GFP_KERNEL);
1101 status = get_manuf_info(serial, (__u8 *)ti_manuf_desc);
1103 kfree(ti_manuf_desc);
1107 /* Check version number of ION descriptor */
1108 if (!ignore_cpu_rev && ti_cpu_rev(ti_manuf_desc) < 2) {
1109 dev_dbg(dev, "%s - Wrong CPU Rev %d (Must be 2)\n",
1110 __func__, ti_cpu_rev(ti_manuf_desc));
1111 kfree(ti_manuf_desc);
1115 rom_desc = kmalloc(sizeof(*rom_desc), GFP_KERNEL);
1117 kfree(ti_manuf_desc);
1121 /* Search for type 2 record (firmware record) */
1122 start_address = get_descriptor_addr(serial,
1123 I2C_DESC_TYPE_FIRMWARE_BASIC, rom_desc);
1124 if (start_address != 0) {
1125 struct ti_i2c_firmware_rec *firmware_version;
1128 dev_dbg(dev, "%s - Found Type FIRMWARE (Type 2) record\n",
1131 firmware_version = kmalloc(sizeof(*firmware_version),
1133 if (!firmware_version) {
1135 kfree(ti_manuf_desc);
1140 * Validate version number
1141 * Read the descriptor data
1143 status = read_rom(serial, start_address +
1144 sizeof(struct ti_i2c_desc),
1145 sizeof(struct ti_i2c_firmware_rec),
1146 (__u8 *)firmware_version);
1148 kfree(firmware_version);
1150 kfree(ti_manuf_desc);
1155 * Check version number of download with current
1158 download_cur_ver = (firmware_version->Ver_Major << 8) +
1159 (firmware_version->Ver_Minor);
1160 download_new_ver = (fw_hdr->major_version << 8) +
1161 (fw_hdr->minor_version);
1163 dev_dbg(dev, "%s - >> FW Versions Device %d.%d Driver %d.%d\n",
1164 __func__, firmware_version->Ver_Major,
1165 firmware_version->Ver_Minor,
1166 fw_hdr->major_version, fw_hdr->minor_version);
1169 * Check if we have an old version in the I2C and
1170 * update if necessary
1172 if (download_cur_ver < download_new_ver) {
1173 dev_dbg(dev, "%s - Update I2C dld from %d.%d to %d.%d\n",
1175 firmware_version->Ver_Major,
1176 firmware_version->Ver_Minor,
1177 fw_hdr->major_version,
1178 fw_hdr->minor_version);
1180 record = kmalloc(1, GFP_KERNEL);
1182 kfree(firmware_version);
1184 kfree(ti_manuf_desc);
1188 * In order to update the I2C firmware we must
1189 * change the type 2 record to type 0xF2. This
1190 * will force the UMP to come up in Boot Mode.
1191 * Then while in boot mode, the driver will
1192 * download the latest firmware (padded to
1193 * 15.5k) into the UMP ram. Finally when the
1194 * device comes back up in download mode the
1195 * driver will cause the new firmware to be
1196 * copied from the UMP Ram to I2C and the
1197 * firmware will update the record type from
1200 *record = I2C_DESC_TYPE_FIRMWARE_BLANK;
1203 * Change the I2C Firmware record type to
1204 * 0xf2 to trigger an update
1206 status = write_rom(serial, start_address,
1207 sizeof(*record), record);
1210 kfree(firmware_version);
1212 kfree(ti_manuf_desc);
1217 * verify the write -- must do this in order
1218 * for write to complete before we do the
1221 status = read_rom(serial,
1227 kfree(firmware_version);
1229 kfree(ti_manuf_desc);
1233 if (*record != I2C_DESC_TYPE_FIRMWARE_BLANK) {
1234 dev_err(dev, "%s - error resetting device\n",
1237 kfree(firmware_version);
1239 kfree(ti_manuf_desc);
1243 dev_dbg(dev, "%s - HARDWARE RESET\n", __func__);
1245 /* Reset UMP -- Back to BOOT MODE */
1246 status = ti_vsend_sync(serial->serial->dev,
1247 UMPC_HARDWARE_RESET,
1249 TI_VSEND_TIMEOUT_DEFAULT);
1251 dev_dbg(dev, "%s - HARDWARE RESET return %d\n",
1254 /* return an error on purpose. */
1256 kfree(firmware_version);
1258 kfree(ti_manuf_desc);
1261 /* Same or newer fw version is already loaded */
1262 serial->fw_version = download_cur_ver;
1263 kfree(firmware_version);
1265 /* Search for type 0xF2 record (firmware blank record) */
1267 start_address = get_descriptor_addr(serial,
1268 I2C_DESC_TYPE_FIRMWARE_BLANK, rom_desc);
1269 if (start_address != 0) {
1270 #define HEADER_SIZE (sizeof(struct ti_i2c_desc) + \
1271 sizeof(struct ti_i2c_firmware_rec))
1275 header = kmalloc(HEADER_SIZE, GFP_KERNEL);
1278 kfree(ti_manuf_desc);
1282 vheader = kmalloc(HEADER_SIZE, GFP_KERNEL);
1286 kfree(ti_manuf_desc);
1290 dev_dbg(dev, "%s - Found Type BLANK FIRMWARE (Type F2) record\n",
1294 * In order to update the I2C firmware we must change
1295 * the type 2 record to type 0xF2. This will force the
1296 * UMP to come up in Boot Mode. Then while in boot
1297 * mode, the driver will download the latest firmware
1298 * (padded to 15.5k) into the UMP ram. Finally when the
1299 * device comes back up in download mode the driver
1300 * will cause the new firmware to be copied from the
1301 * UMP Ram to I2C and the firmware will update the
1302 * record type from 0xf2 to 0x02.
1304 status = build_i2c_fw_hdr(header, fw);
1309 kfree(ti_manuf_desc);
1314 * Update I2C with type 0xf2 record with correct
1317 status = write_rom(serial,
1325 kfree(ti_manuf_desc);
1330 * verify the write -- must do this in order for
1331 * write to complete before we do the hardware reset
1333 status = read_rom(serial, start_address,
1334 HEADER_SIZE, vheader);
1337 dev_dbg(dev, "%s - can't read header back\n",
1342 kfree(ti_manuf_desc);
1345 if (memcmp(vheader, header, HEADER_SIZE)) {
1346 dev_dbg(dev, "%s - write download record failed\n",
1351 kfree(ti_manuf_desc);
1358 dev_dbg(dev, "%s - Start firmware update\n", __func__);
1360 /* Tell firmware to copy download image into I2C */
1361 status = ti_vsend_sync(serial->serial->dev,
1362 UMPC_COPY_DNLD_TO_I2C,
1364 TI_VSEND_TIMEOUT_FW_DOWNLOAD);
1366 dev_dbg(dev, "%s - Update complete 0x%x\n", __func__,
1370 "%s - UMPC_COPY_DNLD_TO_I2C failed\n",
1373 kfree(ti_manuf_desc);
1379 /* The device is running the download code */
1381 kfree(ti_manuf_desc);
1385 static int do_boot_mode(struct edgeport_serial *serial,
1386 const struct firmware *fw)
1388 struct device *dev = &serial->serial->interface->dev;
1390 struct edge_ti_manuf_descriptor *ti_manuf_desc;
1391 struct edgeport_fw_hdr *fw_hdr = (struct edgeport_fw_hdr *)fw->data;
1393 dev_dbg(dev, "%s - RUNNING IN BOOT MODE\n", __func__);
1395 /* Configure the TI device so we can use the BULK pipes for download */
1396 status = config_boot_dev(serial->serial->dev);
1400 if (le16_to_cpu(serial->serial->dev->descriptor.idVendor)
1401 != USB_VENDOR_ID_ION) {
1402 dev_dbg(dev, "%s - VID = 0x%x\n", __func__,
1403 le16_to_cpu(serial->serial->dev->descriptor.idVendor));
1404 serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_II;
1405 goto stayinbootmode;
1409 * We have an ION device (I2c Must be programmed)
1410 * Determine I2C image type
1412 if (i2c_type_bootmode(serial))
1413 goto stayinbootmode;
1415 /* Check for ION Vendor ID and that the I2C is valid */
1416 if (!check_i2c_image(serial)) {
1417 struct ti_i2c_image_header *header;
1424 * Validate Hardware version number
1425 * Read Manufacturing Descriptor from TI Based Edgeport
1427 ti_manuf_desc = kmalloc(sizeof(*ti_manuf_desc), GFP_KERNEL);
1431 status = get_manuf_info(serial, (__u8 *)ti_manuf_desc);
1433 kfree(ti_manuf_desc);
1434 goto stayinbootmode;
1437 /* Check for version 2 */
1438 if (!ignore_cpu_rev && ti_cpu_rev(ti_manuf_desc) < 2) {
1439 dev_dbg(dev, "%s - Wrong CPU Rev %d (Must be 2)\n",
1440 __func__, ti_cpu_rev(ti_manuf_desc));
1441 kfree(ti_manuf_desc);
1442 goto stayinbootmode;
1445 kfree(ti_manuf_desc);
1448 * In order to update the I2C firmware we must change the type
1449 * 2 record to type 0xF2. This will force the UMP to come up
1450 * in Boot Mode. Then while in boot mode, the driver will
1451 * download the latest firmware (padded to 15.5k) into the
1452 * UMP ram. Finally when the device comes back up in download
1453 * mode the driver will cause the new firmware to be copied
1454 * from the UMP Ram to I2C and the firmware will update the
1455 * record type from 0xf2 to 0x02.
1457 * Do we really have to copy the whole firmware image,
1458 * or could we do this in place!
1461 /* Allocate a 15.5k buffer + 3 byte header */
1462 buffer_size = (((1024 * 16) - 512) +
1463 sizeof(struct ti_i2c_image_header));
1464 buffer = kmalloc(buffer_size, GFP_KERNEL);
1468 /* Initialize the buffer to 0xff (pad the buffer) */
1469 memset(buffer, 0xff, buffer_size);
1470 memcpy(buffer, &fw->data[4], fw->size - 4);
1472 for (i = sizeof(struct ti_i2c_image_header);
1473 i < buffer_size; i++) {
1474 cs = (__u8)(cs + buffer[i]);
1477 header = (struct ti_i2c_image_header *)buffer;
1479 /* update length and checksum after padding */
1480 header->Length = cpu_to_le16((__u16)(buffer_size -
1481 sizeof(struct ti_i2c_image_header)));
1482 header->CheckSum = cs;
1484 /* Download the operational code */
1485 dev_dbg(dev, "%s - Downloading operational code image version %d.%d (TI UMP)\n",
1487 fw_hdr->major_version, fw_hdr->minor_version);
1488 status = download_code(serial, buffer, buffer_size);
1493 dev_dbg(dev, "%s - Error downloading operational code image\n", __func__);
1497 /* Device will reboot */
1498 serial->product_info.TiMode = TI_MODE_TRANSITIONING;
1500 dev_dbg(dev, "%s - Download successful -- Device rebooting...\n", __func__);
1502 /* return an error on purpose */
1507 /* Eprom is invalid or blank stay in boot mode */
1508 dev_dbg(dev, "%s - STAYING IN BOOT MODE\n", __func__);
1509 serial->product_info.TiMode = TI_MODE_BOOT;
1514 static int ti_do_config(struct edgeport_port *port, int feature, int on)
1516 int port_number = port->port->port_number;
1518 on = !!on; /* 1 or 0 not bitmask */
1519 return send_cmd(port->port->serial->dev,
1520 feature, (__u8)(UMPM_UART1_PORT + port_number),
1524 static int restore_mcr(struct edgeport_port *port, __u8 mcr)
1528 dev_dbg(&port->port->dev, "%s - %x\n", __func__, mcr);
1530 status = ti_do_config(port, UMPC_SET_CLR_DTR, mcr & MCR_DTR);
1533 status = ti_do_config(port, UMPC_SET_CLR_RTS, mcr & MCR_RTS);
1536 return ti_do_config(port, UMPC_SET_CLR_LOOPBACK, mcr & MCR_LOOPBACK);
1539 /* Convert TI LSR to standard UART flags */
1540 static __u8 map_line_status(__u8 ti_lsr)
1544 #define MAP_FLAG(flagUmp, flagUart) \
1545 if (ti_lsr & flagUmp) \
1548 MAP_FLAG(UMP_UART_LSR_OV_MASK, LSR_OVER_ERR) /* overrun */
1549 MAP_FLAG(UMP_UART_LSR_PE_MASK, LSR_PAR_ERR) /* parity error */
1550 MAP_FLAG(UMP_UART_LSR_FE_MASK, LSR_FRM_ERR) /* framing error */
1551 MAP_FLAG(UMP_UART_LSR_BR_MASK, LSR_BREAK) /* break detected */
1552 MAP_FLAG(UMP_UART_LSR_RX_MASK, LSR_RX_AVAIL) /* rx data available */
1553 MAP_FLAG(UMP_UART_LSR_TX_MASK, LSR_TX_EMPTY) /* tx hold reg empty */
1560 static void handle_new_msr(struct edgeport_port *edge_port, __u8 msr)
1562 struct async_icount *icount;
1563 struct tty_struct *tty;
1565 dev_dbg(&edge_port->port->dev, "%s - %02x\n", __func__, msr);
1567 if (msr & (EDGEPORT_MSR_DELTA_CTS | EDGEPORT_MSR_DELTA_DSR |
1568 EDGEPORT_MSR_DELTA_RI | EDGEPORT_MSR_DELTA_CD)) {
1569 icount = &edge_port->port->icount;
1571 /* update input line counters */
1572 if (msr & EDGEPORT_MSR_DELTA_CTS)
1574 if (msr & EDGEPORT_MSR_DELTA_DSR)
1576 if (msr & EDGEPORT_MSR_DELTA_CD)
1578 if (msr & EDGEPORT_MSR_DELTA_RI)
1580 wake_up_interruptible(&edge_port->port->port.delta_msr_wait);
1583 /* Save the new modem status */
1584 edge_port->shadow_msr = msr & 0xf0;
1586 tty = tty_port_tty_get(&edge_port->port->port);
1587 /* handle CTS flow control */
1588 if (tty && C_CRTSCTS(tty)) {
1589 if (msr & EDGEPORT_MSR_CTS)
1595 static void handle_new_lsr(struct edgeport_port *edge_port, int lsr_data,
1596 __u8 lsr, __u8 data)
1598 struct async_icount *icount;
1599 __u8 new_lsr = (__u8)(lsr & (__u8)(LSR_OVER_ERR | LSR_PAR_ERR |
1600 LSR_FRM_ERR | LSR_BREAK));
1602 dev_dbg(&edge_port->port->dev, "%s - %02x\n", __func__, new_lsr);
1604 edge_port->shadow_lsr = lsr;
1606 if (new_lsr & LSR_BREAK)
1608 * Parity and Framing errors only count if they
1609 * occur exclusive of a break being received.
1611 new_lsr &= (__u8)(LSR_OVER_ERR | LSR_BREAK);
1613 /* Place LSR data byte into Rx buffer */
1615 edge_tty_recv(edge_port->port, &data, 1);
1617 /* update input line counters */
1618 icount = &edge_port->port->icount;
1619 if (new_lsr & LSR_BREAK)
1621 if (new_lsr & LSR_OVER_ERR)
1623 if (new_lsr & LSR_PAR_ERR)
1625 if (new_lsr & LSR_FRM_ERR)
1629 static void edge_interrupt_callback(struct urb *urb)
1631 struct edgeport_serial *edge_serial = urb->context;
1632 struct usb_serial_port *port;
1633 struct edgeport_port *edge_port;
1635 unsigned char *data = urb->transfer_buffer;
1636 int length = urb->actual_length;
1642 int status = urb->status;
1651 /* this urb is terminated, clean up */
1652 dev_dbg(&urb->dev->dev, "%s - urb shutting down with status: %d\n",
1656 dev_err(&urb->dev->dev, "%s - nonzero urb status received: "
1657 "%d\n", __func__, status);
1662 dev_dbg(&urb->dev->dev, "%s - no data in urb\n", __func__);
1666 dev = &edge_serial->serial->dev->dev;
1667 usb_serial_debug_data(dev, __func__, length, data);
1670 dev_dbg(dev, "%s - expecting packet of size 2, got %d\n", __func__, length);
1674 port_number = TIUMP_GET_PORT_FROM_CODE(data[0]);
1675 function = TIUMP_GET_FUNC_FROM_CODE(data[0]);
1676 dev_dbg(dev, "%s - port_number %d, function %d, info 0x%x\n", __func__,
1677 port_number, function, data[1]);
1678 port = edge_serial->serial->port[port_number];
1679 edge_port = usb_get_serial_port_data(port);
1681 dev_dbg(dev, "%s - edge_port not found\n", __func__);
1685 case TIUMP_INTERRUPT_CODE_LSR:
1686 lsr = map_line_status(data[1]);
1687 if (lsr & UMP_UART_LSR_DATA_MASK) {
1689 * Save the LSR event for bulk read completion routine
1691 dev_dbg(dev, "%s - LSR Event Port %u LSR Status = %02x\n",
1692 __func__, port_number, lsr);
1693 edge_port->lsr_event = 1;
1694 edge_port->lsr_mask = lsr;
1696 dev_dbg(dev, "%s - ===== Port %d LSR Status = %02x ======\n",
1697 __func__, port_number, lsr);
1698 handle_new_lsr(edge_port, 0, lsr, 0);
1702 case TIUMP_INTERRUPT_CODE_MSR: /* MSR */
1703 /* Copy MSR from UMP */
1705 dev_dbg(dev, "%s - ===== Port %u MSR Status = %02x ======\n",
1706 __func__, port_number, msr);
1707 handle_new_msr(edge_port, msr);
1711 dev_err(&urb->dev->dev,
1712 "%s - Unknown Interrupt code from UMP %x\n",
1719 retval = usb_submit_urb(urb, GFP_ATOMIC);
1721 dev_err(&urb->dev->dev,
1722 "%s - usb_submit_urb failed with result %d\n",
1726 static void edge_bulk_in_callback(struct urb *urb)
1728 struct edgeport_port *edge_port = urb->context;
1729 struct device *dev = &edge_port->port->dev;
1730 unsigned char *data = urb->transfer_buffer;
1733 int status = urb->status;
1742 /* this urb is terminated, clean up */
1743 dev_dbg(&urb->dev->dev, "%s - urb shutting down with status: %d\n", __func__, status);
1746 dev_err(&urb->dev->dev, "%s - nonzero read bulk status received: %d\n", __func__, status);
1749 if (status == -EPIPE)
1753 dev_err(&urb->dev->dev, "%s - stopping read!\n", __func__);
1757 port_number = edge_port->port->port_number;
1759 if (edge_port->lsr_event) {
1760 edge_port->lsr_event = 0;
1761 dev_dbg(dev, "%s ===== Port %u LSR Status = %02x, Data = %02x ======\n",
1762 __func__, port_number, edge_port->lsr_mask, *data);
1763 handle_new_lsr(edge_port, 1, edge_port->lsr_mask, *data);
1764 /* Adjust buffer length/pointer */
1765 --urb->actual_length;
1769 if (urb->actual_length) {
1770 usb_serial_debug_data(dev, __func__, urb->actual_length, data);
1771 if (edge_port->close_pending)
1772 dev_dbg(dev, "%s - close pending, dropping data on the floor\n",
1775 edge_tty_recv(edge_port->port, data,
1776 urb->actual_length);
1777 edge_port->port->icount.rx += urb->actual_length;
1781 /* continue read unless stopped */
1782 spin_lock(&edge_port->ep_lock);
1783 if (edge_port->ep_read_urb_state == EDGE_READ_URB_RUNNING)
1784 retval = usb_submit_urb(urb, GFP_ATOMIC);
1785 else if (edge_port->ep_read_urb_state == EDGE_READ_URB_STOPPING)
1786 edge_port->ep_read_urb_state = EDGE_READ_URB_STOPPED;
1788 spin_unlock(&edge_port->ep_lock);
1790 dev_err(dev, "%s - usb_submit_urb failed with result %d\n", __func__, retval);
1793 static void edge_tty_recv(struct usb_serial_port *port, unsigned char *data,
1798 queued = tty_insert_flip_string(&port->port, data, length);
1799 if (queued < length)
1800 dev_err(&port->dev, "%s - dropping data, %d bytes lost\n",
1801 __func__, length - queued);
1802 tty_flip_buffer_push(&port->port);
1805 static void edge_bulk_out_callback(struct urb *urb)
1807 struct usb_serial_port *port = urb->context;
1808 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1809 int status = urb->status;
1810 struct tty_struct *tty;
1812 edge_port->ep_write_urb_in_use = 0;
1821 /* this urb is terminated, clean up */
1822 dev_dbg(&urb->dev->dev, "%s - urb shutting down with status: %d\n",
1826 dev_err_console(port, "%s - nonzero write bulk status "
1827 "received: %d\n", __func__, status);
1830 /* send any buffered data */
1831 tty = tty_port_tty_get(&port->port);
1832 edge_send(port, tty);
1836 static int edge_open(struct tty_struct *tty, struct usb_serial_port *port)
1838 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1839 struct edgeport_serial *edge_serial;
1840 struct usb_device *dev;
1845 u8 transaction_timeout;
1847 if (edge_port == NULL)
1850 port_number = port->port_number;
1852 dev = port->serial->dev;
1854 /* turn off loopback */
1855 status = ti_do_config(edge_port, UMPC_SET_CLR_LOOPBACK, 0);
1858 "%s - cannot send clear loopback command, %d\n",
1863 /* set up the port settings */
1865 edge_set_termios(tty, port, &tty->termios);
1867 /* open up the port */
1869 /* milliseconds to timeout for DMA transfer */
1870 transaction_timeout = 2;
1872 edge_port->ump_read_timeout =
1873 max(20, ((transaction_timeout * 3) / 2));
1875 /* milliseconds to timeout for DMA transfer */
1876 open_settings = (u8)(UMP_DMA_MODE_CONTINOUS |
1877 UMP_PIPE_TRANS_TIMEOUT_ENA |
1878 (transaction_timeout << 2));
1880 dev_dbg(&port->dev, "%s - Sending UMPC_OPEN_PORT\n", __func__);
1882 /* Tell TI to open and start the port */
1883 status = send_cmd(dev, UMPC_OPEN_PORT,
1884 (u8)(UMPM_UART1_PORT + port_number), open_settings, NULL, 0);
1886 dev_err(&port->dev, "%s - cannot send open command, %d\n",
1891 /* Start the DMA? */
1892 status = send_cmd(dev, UMPC_START_PORT,
1893 (u8)(UMPM_UART1_PORT + port_number), 0, NULL, 0);
1895 dev_err(&port->dev, "%s - cannot send start DMA command, %d\n",
1900 /* Clear TX and RX buffers in UMP */
1901 status = purge_port(port, UMP_PORT_DIR_OUT | UMP_PORT_DIR_IN);
1904 "%s - cannot send clear buffers command, %d\n",
1909 /* Read Initial MSR */
1910 status = ti_vread_sync(dev, UMPC_READ_MSR, 0,
1911 (__u16)(UMPM_UART1_PORT + port_number),
1912 &edge_port->shadow_msr, 1);
1914 dev_err(&port->dev, "%s - cannot send read MSR command, %d\n",
1919 dev_dbg(&port->dev, "ShadowMSR 0x%X\n", edge_port->shadow_msr);
1921 /* Set Initial MCR */
1922 edge_port->shadow_mcr = MCR_RTS | MCR_DTR;
1923 dev_dbg(&port->dev, "ShadowMCR 0x%X\n", edge_port->shadow_mcr);
1925 edge_serial = edge_port->edge_serial;
1926 if (mutex_lock_interruptible(&edge_serial->es_lock))
1927 return -ERESTARTSYS;
1928 if (edge_serial->num_ports_open == 0) {
1929 /* we are the first port to open, post the interrupt urb */
1930 urb = edge_serial->serial->port[0]->interrupt_in_urb;
1933 "%s - no interrupt urb present, exiting\n",
1936 goto release_es_lock;
1938 urb->context = edge_serial;
1939 status = usb_submit_urb(urb, GFP_KERNEL);
1942 "%s - usb_submit_urb failed with value %d\n",
1944 goto release_es_lock;
1949 * reset the data toggle on the bulk endpoints to work around bug in
1950 * host controllers where things get out of sync some times
1952 usb_clear_halt(dev, port->write_urb->pipe);
1953 usb_clear_halt(dev, port->read_urb->pipe);
1955 /* start up our bulk read urb */
1956 urb = port->read_urb;
1958 dev_err(&port->dev, "%s - no read urb present, exiting\n",
1961 goto unlink_int_urb;
1963 edge_port->ep_read_urb_state = EDGE_READ_URB_RUNNING;
1964 urb->context = edge_port;
1965 status = usb_submit_urb(urb, GFP_KERNEL);
1968 "%s - read bulk usb_submit_urb failed with value %d\n",
1970 goto unlink_int_urb;
1973 ++edge_serial->num_ports_open;
1975 goto release_es_lock;
1978 if (edge_port->edge_serial->num_ports_open == 0)
1979 usb_kill_urb(port->serial->port[0]->interrupt_in_urb);
1981 mutex_unlock(&edge_serial->es_lock);
1985 static void edge_close(struct usb_serial_port *port)
1987 struct edgeport_serial *edge_serial;
1988 struct edgeport_port *edge_port;
1989 struct usb_serial *serial = port->serial;
1990 unsigned long flags;
1993 edge_serial = usb_get_serial_data(port->serial);
1994 edge_port = usb_get_serial_port_data(port);
1995 if (edge_serial == NULL || edge_port == NULL)
1999 * The bulkreadcompletion routine will check
2000 * this flag and dump add read data
2002 edge_port->close_pending = 1;
2004 usb_kill_urb(port->read_urb);
2005 usb_kill_urb(port->write_urb);
2006 edge_port->ep_write_urb_in_use = 0;
2007 spin_lock_irqsave(&edge_port->ep_lock, flags);
2008 kfifo_reset_out(&port->write_fifo);
2009 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2011 dev_dbg(&port->dev, "%s - send umpc_close_port\n", __func__);
2012 port_number = port->port_number;
2013 send_cmd(serial->dev, UMPC_CLOSE_PORT,
2014 (__u8)(UMPM_UART1_PORT + port_number), 0, NULL, 0);
2016 mutex_lock(&edge_serial->es_lock);
2017 --edge_port->edge_serial->num_ports_open;
2018 if (edge_port->edge_serial->num_ports_open <= 0) {
2019 /* last port is now closed, let's shut down our interrupt urb */
2020 usb_kill_urb(port->serial->port[0]->interrupt_in_urb);
2021 edge_port->edge_serial->num_ports_open = 0;
2023 mutex_unlock(&edge_serial->es_lock);
2024 edge_port->close_pending = 0;
2027 static int edge_write(struct tty_struct *tty, struct usb_serial_port *port,
2028 const unsigned char *data, int count)
2030 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2033 dev_dbg(&port->dev, "%s - write request of 0 bytes\n", __func__);
2037 if (edge_port == NULL)
2039 if (edge_port->close_pending == 1)
2042 count = kfifo_in_locked(&port->write_fifo, data, count,
2043 &edge_port->ep_lock);
2044 edge_send(port, tty);
2049 static void edge_send(struct usb_serial_port *port, struct tty_struct *tty)
2052 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2053 unsigned long flags;
2055 spin_lock_irqsave(&edge_port->ep_lock, flags);
2057 if (edge_port->ep_write_urb_in_use) {
2058 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2062 count = kfifo_out(&port->write_fifo,
2063 port->write_urb->transfer_buffer,
2064 port->bulk_out_size);
2067 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2071 edge_port->ep_write_urb_in_use = 1;
2073 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2075 usb_serial_debug_data(&port->dev, __func__, count, port->write_urb->transfer_buffer);
2077 /* set up our urb */
2078 port->write_urb->transfer_buffer_length = count;
2080 /* send the data out the bulk port */
2081 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
2083 dev_err_console(port,
2084 "%s - failed submitting write urb, error %d\n",
2086 edge_port->ep_write_urb_in_use = 0;
2087 /* TODO: reschedule edge_send */
2089 edge_port->port->icount.tx += count;
2092 * wakeup any process waiting for writes to complete
2093 * there is now more room in the buffer for new writes
2099 static int edge_write_room(struct tty_struct *tty)
2101 struct usb_serial_port *port = tty->driver_data;
2102 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2104 unsigned long flags;
2106 if (edge_port == NULL)
2108 if (edge_port->close_pending == 1)
2111 spin_lock_irqsave(&edge_port->ep_lock, flags);
2112 room = kfifo_avail(&port->write_fifo);
2113 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2115 dev_dbg(&port->dev, "%s - returns %d\n", __func__, room);
2119 static int edge_chars_in_buffer(struct tty_struct *tty)
2121 struct usb_serial_port *port = tty->driver_data;
2122 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2124 unsigned long flags;
2125 if (edge_port == NULL)
2128 spin_lock_irqsave(&edge_port->ep_lock, flags);
2129 chars = kfifo_len(&port->write_fifo);
2130 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2132 dev_dbg(&port->dev, "%s - returns %d\n", __func__, chars);
2136 static bool edge_tx_empty(struct usb_serial_port *port)
2138 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2141 ret = tx_active(edge_port);
2148 static void edge_throttle(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 stop character */
2159 unsigned char stop_char = STOP_CHAR(tty);
2160 status = edge_write(tty, port, &stop_char, 1);
2162 dev_err(&port->dev, "%s - failed to write stop character, %d\n", __func__, status);
2167 * if we are implementing RTS/CTS, stop reads
2168 * and the Edgeport will clear the RTS line
2171 stop_read(edge_port);
2175 static void edge_unthrottle(struct tty_struct *tty)
2177 struct usb_serial_port *port = tty->driver_data;
2178 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2181 if (edge_port == NULL)
2184 /* if we are implementing XON/XOFF, send the start character */
2186 unsigned char start_char = START_CHAR(tty);
2187 status = edge_write(tty, port, &start_char, 1);
2189 dev_err(&port->dev, "%s - failed to write start character, %d\n", __func__, status);
2193 * if we are implementing RTS/CTS, restart reads
2194 * are the Edgeport will assert the RTS line
2196 if (C_CRTSCTS(tty)) {
2197 status = restart_read(edge_port);
2200 "%s - read bulk usb_submit_urb failed: %d\n",
2206 static void stop_read(struct edgeport_port *edge_port)
2208 unsigned long flags;
2210 spin_lock_irqsave(&edge_port->ep_lock, flags);
2212 if (edge_port->ep_read_urb_state == EDGE_READ_URB_RUNNING)
2213 edge_port->ep_read_urb_state = EDGE_READ_URB_STOPPING;
2214 edge_port->shadow_mcr &= ~MCR_RTS;
2216 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2219 static int restart_read(struct edgeport_port *edge_port)
2223 unsigned long flags;
2225 spin_lock_irqsave(&edge_port->ep_lock, flags);
2227 if (edge_port->ep_read_urb_state == EDGE_READ_URB_STOPPED) {
2228 urb = edge_port->port->read_urb;
2229 status = usb_submit_urb(urb, GFP_ATOMIC);
2231 edge_port->ep_read_urb_state = EDGE_READ_URB_RUNNING;
2232 edge_port->shadow_mcr |= MCR_RTS;
2234 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2239 static void change_port_settings(struct tty_struct *tty,
2240 struct edgeport_port *edge_port, struct ktermios *old_termios)
2242 struct device *dev = &edge_port->port->dev;
2243 struct ump_uart_config *config;
2247 int port_number = edge_port->port->port_number;
2249 config = kmalloc (sizeof (*config), GFP_KERNEL);
2251 tty->termios = *old_termios;
2255 cflag = tty->termios.c_cflag;
2259 /* These flags must be set */
2260 config->wFlags |= UMP_MASK_UART_FLAGS_RECEIVE_MS_INT;
2261 config->wFlags |= UMP_MASK_UART_FLAGS_AUTO_START_ON_ERR;
2262 config->bUartMode = (__u8)(edge_port->bUartMode);
2264 switch (cflag & CSIZE) {
2266 config->bDataBits = UMP_UART_CHAR5BITS;
2267 dev_dbg(dev, "%s - data bits = 5\n", __func__);
2270 config->bDataBits = UMP_UART_CHAR6BITS;
2271 dev_dbg(dev, "%s - data bits = 6\n", __func__);
2274 config->bDataBits = UMP_UART_CHAR7BITS;
2275 dev_dbg(dev, "%s - data bits = 7\n", __func__);
2279 config->bDataBits = UMP_UART_CHAR8BITS;
2280 dev_dbg(dev, "%s - data bits = 8\n", __func__);
2284 if (cflag & PARENB) {
2285 if (cflag & PARODD) {
2286 config->wFlags |= UMP_MASK_UART_FLAGS_PARITY;
2287 config->bParity = UMP_UART_ODDPARITY;
2288 dev_dbg(dev, "%s - parity = odd\n", __func__);
2290 config->wFlags |= UMP_MASK_UART_FLAGS_PARITY;
2291 config->bParity = UMP_UART_EVENPARITY;
2292 dev_dbg(dev, "%s - parity = even\n", __func__);
2295 config->bParity = UMP_UART_NOPARITY;
2296 dev_dbg(dev, "%s - parity = none\n", __func__);
2299 if (cflag & CSTOPB) {
2300 config->bStopBits = UMP_UART_STOPBIT2;
2301 dev_dbg(dev, "%s - stop bits = 2\n", __func__);
2303 config->bStopBits = UMP_UART_STOPBIT1;
2304 dev_dbg(dev, "%s - stop bits = 1\n", __func__);
2307 /* figure out the flow control settings */
2308 if (cflag & CRTSCTS) {
2309 config->wFlags |= UMP_MASK_UART_FLAGS_OUT_X_CTS_FLOW;
2310 config->wFlags |= UMP_MASK_UART_FLAGS_RTS_FLOW;
2311 dev_dbg(dev, "%s - RTS/CTS is enabled\n", __func__);
2313 dev_dbg(dev, "%s - RTS/CTS is disabled\n", __func__);
2314 restart_read(edge_port);
2318 * if we are implementing XON/XOFF, set the start and stop
2319 * character in the device
2321 config->cXon = START_CHAR(tty);
2322 config->cXoff = STOP_CHAR(tty);
2324 /* if we are implementing INBOUND XON/XOFF */
2326 config->wFlags |= UMP_MASK_UART_FLAGS_IN_X;
2327 dev_dbg(dev, "%s - INBOUND XON/XOFF is enabled, XON = %2x, XOFF = %2x\n",
2328 __func__, config->cXon, config->cXoff);
2330 dev_dbg(dev, "%s - INBOUND XON/XOFF is disabled\n", __func__);
2332 /* if we are implementing OUTBOUND XON/XOFF */
2334 config->wFlags |= UMP_MASK_UART_FLAGS_OUT_X;
2335 dev_dbg(dev, "%s - OUTBOUND XON/XOFF is enabled, XON = %2x, XOFF = %2x\n",
2336 __func__, config->cXon, config->cXoff);
2338 dev_dbg(dev, "%s - OUTBOUND XON/XOFF is disabled\n", __func__);
2340 tty->termios.c_cflag &= ~CMSPAR;
2342 /* Round the baud rate */
2343 baud = tty_get_baud_rate(tty);
2345 /* pick a default, any default... */
2348 tty_encode_baud_rate(tty, baud, baud);
2350 edge_port->baud_rate = baud;
2351 config->wBaudRate = (__u16)((461550L + baud/2) / baud);
2353 /* FIXME: Recompute actual baud from divisor here */
2355 dev_dbg(dev, "%s - baud rate = %d, wBaudRate = %d\n", __func__, baud, config->wBaudRate);
2357 dev_dbg(dev, "wBaudRate: %d\n", (int)(461550L / config->wBaudRate));
2358 dev_dbg(dev, "wFlags: 0x%x\n", config->wFlags);
2359 dev_dbg(dev, "bDataBits: %d\n", config->bDataBits);
2360 dev_dbg(dev, "bParity: %d\n", config->bParity);
2361 dev_dbg(dev, "bStopBits: %d\n", config->bStopBits);
2362 dev_dbg(dev, "cXon: %d\n", config->cXon);
2363 dev_dbg(dev, "cXoff: %d\n", config->cXoff);
2364 dev_dbg(dev, "bUartMode: %d\n", config->bUartMode);
2366 /* move the word values into big endian mode */
2367 cpu_to_be16s(&config->wFlags);
2368 cpu_to_be16s(&config->wBaudRate);
2370 status = send_cmd(edge_port->port->serial->dev, UMPC_SET_CONFIG,
2371 (__u8)(UMPM_UART1_PORT + port_number),
2372 0, (__u8 *)config, sizeof(*config));
2374 dev_dbg(dev, "%s - error %d when trying to write config to device\n",
2379 static void edge_set_termios(struct tty_struct *tty,
2380 struct usb_serial_port *port, struct ktermios *old_termios)
2382 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2385 cflag = tty->termios.c_cflag;
2387 dev_dbg(&port->dev, "%s - clfag %08x iflag %08x\n", __func__,
2388 tty->termios.c_cflag, tty->termios.c_iflag);
2389 dev_dbg(&port->dev, "%s - old clfag %08x old iflag %08x\n", __func__,
2390 old_termios->c_cflag, old_termios->c_iflag);
2392 if (edge_port == NULL)
2394 /* change the port settings to the new ones specified */
2395 change_port_settings(tty, edge_port, old_termios);
2398 static int edge_tiocmset(struct tty_struct *tty,
2399 unsigned int set, unsigned int clear)
2401 struct usb_serial_port *port = tty->driver_data;
2402 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2404 unsigned long flags;
2406 spin_lock_irqsave(&edge_port->ep_lock, flags);
2407 mcr = edge_port->shadow_mcr;
2408 if (set & TIOCM_RTS)
2410 if (set & TIOCM_DTR)
2412 if (set & TIOCM_LOOP)
2413 mcr |= MCR_LOOPBACK;
2415 if (clear & TIOCM_RTS)
2417 if (clear & TIOCM_DTR)
2419 if (clear & TIOCM_LOOP)
2420 mcr &= ~MCR_LOOPBACK;
2422 edge_port->shadow_mcr = mcr;
2423 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2425 restore_mcr(edge_port, mcr);
2429 static int edge_tiocmget(struct tty_struct *tty)
2431 struct usb_serial_port *port = tty->driver_data;
2432 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2433 unsigned int result = 0;
2436 unsigned long flags;
2438 spin_lock_irqsave(&edge_port->ep_lock, flags);
2440 msr = edge_port->shadow_msr;
2441 mcr = edge_port->shadow_mcr;
2442 result = ((mcr & MCR_DTR) ? TIOCM_DTR: 0) /* 0x002 */
2443 | ((mcr & MCR_RTS) ? TIOCM_RTS: 0) /* 0x004 */
2444 | ((msr & EDGEPORT_MSR_CTS) ? TIOCM_CTS: 0) /* 0x020 */
2445 | ((msr & EDGEPORT_MSR_CD) ? TIOCM_CAR: 0) /* 0x040 */
2446 | ((msr & EDGEPORT_MSR_RI) ? TIOCM_RI: 0) /* 0x080 */
2447 | ((msr & EDGEPORT_MSR_DSR) ? TIOCM_DSR: 0); /* 0x100 */
2450 dev_dbg(&port->dev, "%s -- %x\n", __func__, result);
2451 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2456 static int get_serial_info(struct edgeport_port *edge_port,
2457 struct serial_struct __user *retinfo)
2459 struct serial_struct tmp;
2462 cwait = edge_port->port->port.closing_wait;
2463 if (cwait != ASYNC_CLOSING_WAIT_NONE)
2464 cwait = jiffies_to_msecs(cwait) / 10;
2466 memset(&tmp, 0, sizeof(tmp));
2468 tmp.type = PORT_16550A;
2469 tmp.line = edge_port->port->minor;
2470 tmp.port = edge_port->port->port_number;
2472 tmp.flags = ASYNC_SKIP_TEST | ASYNC_AUTO_IRQ;
2473 tmp.xmit_fifo_size = edge_port->port->bulk_out_size;
2474 tmp.baud_base = 9600;
2475 tmp.close_delay = 5*HZ;
2476 tmp.closing_wait = cwait;
2478 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
2483 static int edge_ioctl(struct tty_struct *tty,
2484 unsigned int cmd, unsigned long arg)
2486 struct usb_serial_port *port = tty->driver_data;
2487 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2491 dev_dbg(&port->dev, "%s - TIOCGSERIAL\n", __func__);
2492 return get_serial_info(edge_port,
2493 (struct serial_struct __user *) arg);
2495 return -ENOIOCTLCMD;
2498 static void edge_break(struct tty_struct *tty, int break_state)
2500 struct usb_serial_port *port = tty->driver_data;
2501 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2503 int bv = 0; /* Off */
2505 if (break_state == -1)
2507 status = ti_do_config(edge_port, UMPC_SET_CLR_BREAK, bv);
2509 dev_dbg(&port->dev, "%s - error %d sending break set/clear command.\n",
2513 static void edge_heartbeat_schedule(struct edgeport_serial *edge_serial)
2515 if (!edge_serial->use_heartbeat)
2518 schedule_delayed_work(&edge_serial->heartbeat_work,
2519 FW_HEARTBEAT_SECS * HZ);
2522 static void edge_heartbeat_work(struct work_struct *work)
2524 struct edgeport_serial *serial;
2525 struct ti_i2c_desc *rom_desc;
2527 serial = container_of(work, struct edgeport_serial,
2528 heartbeat_work.work);
2530 rom_desc = kmalloc(sizeof(*rom_desc), GFP_KERNEL);
2532 /* Descriptor address request is enough to reset the firmware timer */
2533 if (!rom_desc || !get_descriptor_addr(serial, I2C_DESC_TYPE_ION,
2535 dev_err(&serial->serial->interface->dev,
2536 "%s - Incomplete heartbeat\n", __func__);
2540 edge_heartbeat_schedule(serial);
2543 static int edge_startup(struct usb_serial *serial)
2545 struct edgeport_serial *edge_serial;
2549 /* create our private serial structure */
2550 edge_serial = kzalloc(sizeof(struct edgeport_serial), GFP_KERNEL);
2554 mutex_init(&edge_serial->es_lock);
2555 edge_serial->serial = serial;
2556 usb_set_serial_data(serial, edge_serial);
2558 status = download_fw(edge_serial);
2564 product_id = le16_to_cpu(
2565 edge_serial->serial->dev->descriptor.idProduct);
2567 /* Currently only the EP/416 models require heartbeat support */
2568 if (edge_serial->fw_version > FW_HEARTBEAT_VERSION_CUTOFF) {
2569 if (product_id == ION_DEVICE_ID_TI_EDGEPORT_416 ||
2570 product_id == ION_DEVICE_ID_TI_EDGEPORT_416B) {
2571 edge_serial->use_heartbeat = true;
2575 INIT_DELAYED_WORK(&edge_serial->heartbeat_work, edge_heartbeat_work);
2576 edge_heartbeat_schedule(edge_serial);
2581 static void edge_disconnect(struct usb_serial *serial)
2585 static void edge_release(struct usb_serial *serial)
2587 struct edgeport_serial *edge_serial = usb_get_serial_data(serial);
2589 cancel_delayed_work_sync(&edge_serial->heartbeat_work);
2593 static int edge_port_probe(struct usb_serial_port *port)
2595 struct edgeport_port *edge_port;
2598 edge_port = kzalloc(sizeof(*edge_port), GFP_KERNEL);
2602 spin_lock_init(&edge_port->ep_lock);
2603 edge_port->port = port;
2604 edge_port->edge_serial = usb_get_serial_data(port->serial);
2605 edge_port->bUartMode = default_uart_mode;
2607 switch (port->port_number) {
2609 edge_port->uart_base = UMPMEM_BASE_UART1;
2610 edge_port->dma_address = UMPD_OEDB1_ADDRESS;
2613 edge_port->uart_base = UMPMEM_BASE_UART2;
2614 edge_port->dma_address = UMPD_OEDB2_ADDRESS;
2617 dev_err(&port->dev, "unknown port number\n");
2623 "%s - port_number = %d, uart_base = %04x, dma_address = %04x\n",
2624 __func__, port->port_number, edge_port->uart_base,
2625 edge_port->dma_address);
2627 usb_set_serial_port_data(port, edge_port);
2629 ret = edge_create_sysfs_attrs(port);
2633 port->port.closing_wait = msecs_to_jiffies(closing_wait * 10);
2634 port->port.drain_delay = 1;
2643 static int edge_port_remove(struct usb_serial_port *port)
2645 struct edgeport_port *edge_port;
2647 edge_port = usb_get_serial_port_data(port);
2648 edge_remove_sysfs_attrs(port);
2654 /* Sysfs Attributes */
2656 static ssize_t uart_mode_show(struct device *dev,
2657 struct device_attribute *attr, char *buf)
2659 struct usb_serial_port *port = to_usb_serial_port(dev);
2660 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2662 return sprintf(buf, "%d\n", edge_port->bUartMode);
2665 static ssize_t uart_mode_store(struct device *dev,
2666 struct device_attribute *attr, const char *valbuf, size_t count)
2668 struct usb_serial_port *port = to_usb_serial_port(dev);
2669 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2670 unsigned int v = simple_strtoul(valbuf, NULL, 0);
2672 dev_dbg(dev, "%s: setting uart_mode = %d\n", __func__, v);
2675 edge_port->bUartMode = v;
2677 dev_err(dev, "%s - uart_mode %d is invalid\n", __func__, v);
2681 static DEVICE_ATTR_RW(uart_mode);
2683 static int edge_create_sysfs_attrs(struct usb_serial_port *port)
2685 return device_create_file(&port->dev, &dev_attr_uart_mode);
2688 static int edge_remove_sysfs_attrs(struct usb_serial_port *port)
2690 device_remove_file(&port->dev, &dev_attr_uart_mode);
2695 static int edge_suspend(struct usb_serial *serial, pm_message_t message)
2697 struct edgeport_serial *edge_serial = usb_get_serial_data(serial);
2699 cancel_delayed_work_sync(&edge_serial->heartbeat_work);
2704 static int edge_resume(struct usb_serial *serial)
2706 struct edgeport_serial *edge_serial = usb_get_serial_data(serial);
2708 edge_heartbeat_schedule(edge_serial);
2714 static struct usb_serial_driver edgeport_1port_device = {
2716 .owner = THIS_MODULE,
2717 .name = "edgeport_ti_1",
2719 .description = "Edgeport TI 1 port adapter",
2720 .id_table = edgeport_1port_id_table,
2723 .close = edge_close,
2724 .throttle = edge_throttle,
2725 .unthrottle = edge_unthrottle,
2726 .attach = edge_startup,
2727 .disconnect = edge_disconnect,
2728 .release = edge_release,
2729 .port_probe = edge_port_probe,
2730 .port_remove = edge_port_remove,
2731 .ioctl = edge_ioctl,
2732 .set_termios = edge_set_termios,
2733 .tiocmget = edge_tiocmget,
2734 .tiocmset = edge_tiocmset,
2735 .tiocmiwait = usb_serial_generic_tiocmiwait,
2736 .get_icount = usb_serial_generic_get_icount,
2737 .write = edge_write,
2738 .write_room = edge_write_room,
2739 .chars_in_buffer = edge_chars_in_buffer,
2740 .tx_empty = edge_tx_empty,
2741 .break_ctl = edge_break,
2742 .read_int_callback = edge_interrupt_callback,
2743 .read_bulk_callback = edge_bulk_in_callback,
2744 .write_bulk_callback = edge_bulk_out_callback,
2746 .suspend = edge_suspend,
2747 .resume = edge_resume,
2751 static struct usb_serial_driver edgeport_2port_device = {
2753 .owner = THIS_MODULE,
2754 .name = "edgeport_ti_2",
2756 .description = "Edgeport TI 2 port adapter",
2757 .id_table = edgeport_2port_id_table,
2760 .close = edge_close,
2761 .throttle = edge_throttle,
2762 .unthrottle = edge_unthrottle,
2763 .attach = edge_startup,
2764 .disconnect = edge_disconnect,
2765 .release = edge_release,
2766 .port_probe = edge_port_probe,
2767 .port_remove = edge_port_remove,
2768 .ioctl = edge_ioctl,
2769 .set_termios = edge_set_termios,
2770 .tiocmget = edge_tiocmget,
2771 .tiocmset = edge_tiocmset,
2772 .tiocmiwait = usb_serial_generic_tiocmiwait,
2773 .get_icount = usb_serial_generic_get_icount,
2774 .write = edge_write,
2775 .write_room = edge_write_room,
2776 .chars_in_buffer = edge_chars_in_buffer,
2777 .tx_empty = edge_tx_empty,
2778 .break_ctl = edge_break,
2779 .read_int_callback = edge_interrupt_callback,
2780 .read_bulk_callback = edge_bulk_in_callback,
2781 .write_bulk_callback = edge_bulk_out_callback,
2783 .suspend = edge_suspend,
2784 .resume = edge_resume,
2788 static struct usb_serial_driver * const serial_drivers[] = {
2789 &edgeport_1port_device, &edgeport_2port_device, NULL
2792 module_usb_serial_driver(serial_drivers, id_table_combined);
2794 MODULE_AUTHOR(DRIVER_AUTHOR);
2795 MODULE_DESCRIPTION(DRIVER_DESC);
2796 MODULE_LICENSE("GPL");
2797 MODULE_FIRMWARE("edgeport/down3.bin");
2799 module_param(closing_wait, int, S_IRUGO | S_IWUSR);
2800 MODULE_PARM_DESC(closing_wait, "Maximum wait for data to drain, in .01 secs");
2802 module_param(ignore_cpu_rev, bool, S_IRUGO | S_IWUSR);
2803 MODULE_PARM_DESC(ignore_cpu_rev,
2804 "Ignore the cpu revision when connecting to a device");
2806 module_param(default_uart_mode, int, S_IRUGO | S_IWUSR);
2807 MODULE_PARM_DESC(default_uart_mode, "Default uart_mode, 0=RS232, ...");