Linux 4.2.1
[linux/fpc-iii.git] / drivers / usb / serial / io_ti.c
blobddbb8fe1046d6868476cb0613068cca0cae30a15
1 /*
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>
39 #include "io_16654.h"
40 #include "io_usbvend.h"
41 #include "io_ti.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 /* Currently in boot mode but
58 transitioning to download mode */
60 /* read urb state */
61 #define EDGE_READ_URB_RUNNING 0
62 #define EDGE_READ_URB_STOPPING 1
63 #define EDGE_READ_URB_STOPPED 2
65 #define EDGE_CLOSING_WAIT 4000 /* in .01 sec */
68 /* Product information read from the Edgeport */
69 struct product_info {
70 int TiMode; /* Current TI Mode */
71 __u8 hardware_type; /* Type of hardware */
72 } __attribute__((packed));
74 struct edgeport_port {
75 __u16 uart_base;
76 __u16 dma_address;
77 __u8 shadow_msr;
78 __u8 shadow_mcr;
79 __u8 shadow_lsr;
80 __u8 lsr_mask;
81 __u32 ump_read_timeout; /* Number of milliseconds the UMP will
82 wait without data before completing
83 a read short */
84 int baud_rate;
85 int close_pending;
86 int lsr_event;
88 struct edgeport_serial *edge_serial;
89 struct usb_serial_port *port;
90 __u8 bUartMode; /* Port type, 0: RS232, etc. */
91 spinlock_t ep_lock;
92 int ep_read_urb_state;
93 int ep_write_urb_in_use;
96 struct edgeport_serial {
97 struct product_info product_info;
98 u8 TI_I2C_Type; /* Type of I2C in UMP */
99 u8 TiReadI2C; /* Set to TRUE if we have read the
100 I2c in Boot Mode */
101 struct mutex es_lock;
102 int num_ports_open;
103 struct usb_serial *serial;
107 /* Devices that this driver supports */
108 static const struct usb_device_id edgeport_1port_id_table[] = {
109 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_1) },
110 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_TI3410_EDGEPORT_1) },
111 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_TI3410_EDGEPORT_1I) },
112 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_PROXIMITY) },
113 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_MOTION) },
114 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_MOISTURE) },
115 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_TEMPERATURE) },
116 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_HUMIDITY) },
117 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_POWER) },
118 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_LIGHT) },
119 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_RADIATION) },
120 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_DISTANCE) },
121 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_ACCELERATION) },
122 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_PROX_DIST) },
123 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_PLUS_PWR_HP4CD) },
124 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_PLUS_PWR_PCI) },
128 static const struct usb_device_id edgeport_2port_id_table[] = {
129 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_2) },
130 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_2C) },
131 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_2I) },
132 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_421) },
133 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_21) },
134 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_42) },
135 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_4) },
136 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_4I) },
137 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_22I) },
138 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_221C) },
139 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_22C) },
140 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_21C) },
141 /* The 4, 8 and 16 port devices show up as multiple 2 port devices */
142 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_4S) },
143 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_8) },
144 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_8S) },
145 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_416) },
146 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_416B) },
150 /* Devices that this driver supports */
151 static const struct usb_device_id id_table_combined[] = {
152 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_1) },
153 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_TI3410_EDGEPORT_1) },
154 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_TI3410_EDGEPORT_1I) },
155 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_PROXIMITY) },
156 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_MOTION) },
157 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_MOISTURE) },
158 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_TEMPERATURE) },
159 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_HUMIDITY) },
160 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_POWER) },
161 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_LIGHT) },
162 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_RADIATION) },
163 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_DISTANCE) },
164 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_ACCELERATION) },
165 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_WP_PROX_DIST) },
166 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_PLUS_PWR_HP4CD) },
167 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_PLUS_PWR_PCI) },
168 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_2) },
169 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_2C) },
170 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_2I) },
171 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_421) },
172 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_21) },
173 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_42) },
174 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_4) },
175 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_4I) },
176 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_22I) },
177 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_221C) },
178 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_22C) },
179 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_21C) },
180 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_4S) },
181 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_8) },
182 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_8S) },
183 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_416) },
184 { USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_TI_EDGEPORT_416B) },
188 MODULE_DEVICE_TABLE(usb, id_table_combined);
190 static unsigned char OperationalMajorVersion;
191 static unsigned char OperationalMinorVersion;
192 static unsigned short OperationalBuildNumber;
194 static int closing_wait = EDGE_CLOSING_WAIT;
195 static bool ignore_cpu_rev;
196 static int default_uart_mode; /* RS232 */
198 static void edge_tty_recv(struct usb_serial_port *port, unsigned char *data,
199 int length);
201 static void stop_read(struct edgeport_port *edge_port);
202 static int restart_read(struct edgeport_port *edge_port);
204 static void edge_set_termios(struct tty_struct *tty,
205 struct usb_serial_port *port, struct ktermios *old_termios);
206 static void edge_send(struct usb_serial_port *port, struct tty_struct *tty);
208 /* sysfs attributes */
209 static int edge_create_sysfs_attrs(struct usb_serial_port *port);
210 static int edge_remove_sysfs_attrs(struct usb_serial_port *port);
213 static int ti_vread_sync(struct usb_device *dev, __u8 request,
214 __u16 value, __u16 index, u8 *data, int size)
216 int status;
218 status = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0), request,
219 (USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN),
220 value, index, data, size, 1000);
221 if (status < 0)
222 return status;
223 if (status != size) {
224 dev_dbg(&dev->dev, "%s - wanted to write %d, but only wrote %d\n",
225 __func__, size, status);
226 return -ECOMM;
228 return 0;
231 static int ti_vsend_sync(struct usb_device *dev, __u8 request,
232 __u16 value, __u16 index, u8 *data, int size)
234 int status;
236 status = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), request,
237 (USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT),
238 value, index, data, size, 1000);
239 if (status < 0)
240 return status;
241 if (status != size) {
242 dev_dbg(&dev->dev, "%s - wanted to write %d, but only wrote %d\n",
243 __func__, size, status);
244 return -ECOMM;
246 return 0;
249 static int send_cmd(struct usb_device *dev, __u8 command,
250 __u8 moduleid, __u16 value, u8 *data,
251 int size)
253 return ti_vsend_sync(dev, command, value, moduleid, data, size);
256 /* clear tx/rx buffers and fifo in TI UMP */
257 static int purge_port(struct usb_serial_port *port, __u16 mask)
259 int port_number = port->port_number;
261 dev_dbg(&port->dev, "%s - port %d, mask %x\n", __func__, port_number, mask);
263 return send_cmd(port->serial->dev,
264 UMPC_PURGE_PORT,
265 (__u8)(UMPM_UART1_PORT + port_number),
266 mask,
267 NULL,
272 * read_download_mem - Read edgeport memory from TI chip
273 * @dev: usb device pointer
274 * @start_address: Device CPU address at which to read
275 * @length: Length of above data
276 * @address_type: Can read both XDATA and I2C
277 * @buffer: pointer to input data buffer
279 static int read_download_mem(struct usb_device *dev, int start_address,
280 int length, __u8 address_type, __u8 *buffer)
282 int status = 0;
283 __u8 read_length;
284 u16 be_start_address;
286 dev_dbg(&dev->dev, "%s - @ %x for %d\n", __func__, start_address, length);
288 /* Read in blocks of 64 bytes
289 * (TI firmware can't handle more than 64 byte reads)
291 while (length) {
292 if (length > 64)
293 read_length = 64;
294 else
295 read_length = (__u8)length;
297 if (read_length > 1) {
298 dev_dbg(&dev->dev, "%s - @ %x for %d\n", __func__, start_address, read_length);
301 * NOTE: Must use swab as wIndex is sent in little-endian
302 * byte order regardless of host byte order.
304 be_start_address = swab16((u16)start_address);
305 status = ti_vread_sync(dev, UMPC_MEMORY_READ,
306 (__u16)address_type,
307 be_start_address,
308 buffer, read_length);
310 if (status) {
311 dev_dbg(&dev->dev, "%s - ERROR %x\n", __func__, status);
312 return status;
315 if (read_length > 1)
316 usb_serial_debug_data(&dev->dev, __func__, read_length, buffer);
318 /* Update pointers/length */
319 start_address += read_length;
320 buffer += read_length;
321 length -= read_length;
324 return status;
327 static int read_ram(struct usb_device *dev, int start_address,
328 int length, __u8 *buffer)
330 return read_download_mem(dev, start_address, length,
331 DTK_ADDR_SPACE_XDATA, buffer);
334 /* Read edgeport memory to a given block */
335 static int read_boot_mem(struct edgeport_serial *serial,
336 int start_address, int length, __u8 *buffer)
338 int status = 0;
339 int i;
341 for (i = 0; i < length; i++) {
342 status = ti_vread_sync(serial->serial->dev,
343 UMPC_MEMORY_READ, serial->TI_I2C_Type,
344 (__u16)(start_address+i), &buffer[i], 0x01);
345 if (status) {
346 dev_dbg(&serial->serial->dev->dev, "%s - ERROR %x\n", __func__, status);
347 return status;
351 dev_dbg(&serial->serial->dev->dev, "%s - start_address = %x, length = %d\n",
352 __func__, start_address, length);
353 usb_serial_debug_data(&serial->serial->dev->dev, __func__, length, buffer);
355 serial->TiReadI2C = 1;
357 return status;
360 /* Write given block to TI EPROM memory */
361 static int write_boot_mem(struct edgeport_serial *serial,
362 int start_address, int length, __u8 *buffer)
364 int status = 0;
365 int i;
366 u8 *temp;
368 /* Must do a read before write */
369 if (!serial->TiReadI2C) {
370 temp = kmalloc(1, GFP_KERNEL);
371 if (!temp)
372 return -ENOMEM;
374 status = read_boot_mem(serial, 0, 1, temp);
375 kfree(temp);
376 if (status)
377 return status;
380 for (i = 0; i < length; ++i) {
381 status = ti_vsend_sync(serial->serial->dev,
382 UMPC_MEMORY_WRITE, buffer[i],
383 (__u16)(i + start_address), NULL, 0);
384 if (status)
385 return status;
388 dev_dbg(&serial->serial->dev->dev, "%s - start_sddr = %x, length = %d\n", __func__, start_address, length);
389 usb_serial_debug_data(&serial->serial->dev->dev, __func__, length, buffer);
391 return status;
395 /* Write edgeport I2C memory to TI chip */
396 static int write_i2c_mem(struct edgeport_serial *serial,
397 int start_address, int length, __u8 address_type, __u8 *buffer)
399 struct device *dev = &serial->serial->dev->dev;
400 int status = 0;
401 int write_length;
402 u16 be_start_address;
404 /* We can only send a maximum of 1 aligned byte page at a time */
406 /* calculate the number of bytes left in the first page */
407 write_length = EPROM_PAGE_SIZE -
408 (start_address & (EPROM_PAGE_SIZE - 1));
410 if (write_length > length)
411 write_length = length;
413 dev_dbg(dev, "%s - BytesInFirstPage Addr = %x, length = %d\n",
414 __func__, start_address, write_length);
415 usb_serial_debug_data(dev, __func__, write_length, buffer);
418 * Write first page.
420 * NOTE: Must use swab as wIndex is sent in little-endian byte order
421 * regardless of host byte order.
423 be_start_address = swab16((u16)start_address);
424 status = ti_vsend_sync(serial->serial->dev,
425 UMPC_MEMORY_WRITE, (__u16)address_type,
426 be_start_address,
427 buffer, write_length);
428 if (status) {
429 dev_dbg(dev, "%s - ERROR %d\n", __func__, status);
430 return status;
433 length -= write_length;
434 start_address += write_length;
435 buffer += write_length;
437 /* We should be aligned now -- can write
438 max page size bytes at a time */
439 while (length) {
440 if (length > EPROM_PAGE_SIZE)
441 write_length = EPROM_PAGE_SIZE;
442 else
443 write_length = length;
445 dev_dbg(dev, "%s - Page Write Addr = %x, length = %d\n",
446 __func__, start_address, write_length);
447 usb_serial_debug_data(dev, __func__, write_length, buffer);
450 * Write next page.
452 * NOTE: Must use swab as wIndex is sent in little-endian byte
453 * order regardless of host byte order.
455 be_start_address = swab16((u16)start_address);
456 status = ti_vsend_sync(serial->serial->dev, UMPC_MEMORY_WRITE,
457 (__u16)address_type,
458 be_start_address,
459 buffer, write_length);
460 if (status) {
461 dev_err(dev, "%s - ERROR %d\n", __func__, status);
462 return status;
465 length -= write_length;
466 start_address += write_length;
467 buffer += write_length;
469 return status;
472 /* Examine the UMP DMA registers and LSR
474 * Check the MSBit of the X and Y DMA byte count registers.
475 * A zero in this bit indicates that the TX DMA buffers are empty
476 * then check the TX Empty bit in the UART.
478 static int tx_active(struct edgeport_port *port)
480 int status;
481 struct out_endpoint_desc_block *oedb;
482 __u8 *lsr;
483 int bytes_left = 0;
485 oedb = kmalloc(sizeof(*oedb), GFP_KERNEL);
486 if (!oedb)
487 return -ENOMEM;
489 lsr = kmalloc(1, GFP_KERNEL); /* Sigh, that's right, just one byte,
490 as not all platforms can do DMA
491 from stack */
492 if (!lsr) {
493 kfree(oedb);
494 return -ENOMEM;
496 /* Read the DMA Count Registers */
497 status = read_ram(port->port->serial->dev, port->dma_address,
498 sizeof(*oedb), (void *)oedb);
499 if (status)
500 goto exit_is_tx_active;
502 dev_dbg(&port->port->dev, "%s - XByteCount 0x%X\n", __func__, oedb->XByteCount);
504 /* and the LSR */
505 status = read_ram(port->port->serial->dev,
506 port->uart_base + UMPMEM_OFFS_UART_LSR, 1, lsr);
508 if (status)
509 goto exit_is_tx_active;
510 dev_dbg(&port->port->dev, "%s - LSR = 0x%X\n", __func__, *lsr);
512 /* If either buffer has data or we are transmitting then return TRUE */
513 if ((oedb->XByteCount & 0x80) != 0)
514 bytes_left += 64;
516 if ((*lsr & UMP_UART_LSR_TX_MASK) == 0)
517 bytes_left += 1;
519 /* We return Not Active if we get any kind of error */
520 exit_is_tx_active:
521 dev_dbg(&port->port->dev, "%s - return %d\n", __func__, bytes_left);
523 kfree(lsr);
524 kfree(oedb);
525 return bytes_left;
528 static int choose_config(struct usb_device *dev)
531 * There may be multiple configurations on this device, in which case
532 * we would need to read and parse all of them to find out which one
533 * we want. However, we just support one config at this point,
534 * configuration # 1, which is Config Descriptor 0.
537 dev_dbg(&dev->dev, "%s - Number of Interfaces = %d\n",
538 __func__, dev->config->desc.bNumInterfaces);
539 dev_dbg(&dev->dev, "%s - MAX Power = %d\n",
540 __func__, dev->config->desc.bMaxPower * 2);
542 if (dev->config->desc.bNumInterfaces != 1) {
543 dev_err(&dev->dev, "%s - bNumInterfaces is not 1, ERROR!\n", __func__);
544 return -ENODEV;
547 return 0;
550 static int read_rom(struct edgeport_serial *serial,
551 int start_address, int length, __u8 *buffer)
553 int status;
555 if (serial->product_info.TiMode == TI_MODE_DOWNLOAD) {
556 status = read_download_mem(serial->serial->dev,
557 start_address,
558 length,
559 serial->TI_I2C_Type,
560 buffer);
561 } else {
562 status = read_boot_mem(serial, start_address, length,
563 buffer);
565 return status;
568 static int write_rom(struct edgeport_serial *serial, int start_address,
569 int length, __u8 *buffer)
571 if (serial->product_info.TiMode == TI_MODE_BOOT)
572 return write_boot_mem(serial, start_address, length,
573 buffer);
575 if (serial->product_info.TiMode == TI_MODE_DOWNLOAD)
576 return write_i2c_mem(serial, start_address, length,
577 serial->TI_I2C_Type, buffer);
578 return -EINVAL;
583 /* Read a descriptor header from I2C based on type */
584 static int get_descriptor_addr(struct edgeport_serial *serial,
585 int desc_type, struct ti_i2c_desc *rom_desc)
587 int start_address;
588 int status;
590 /* Search for requested descriptor in I2C */
591 start_address = 2;
592 do {
593 status = read_rom(serial,
594 start_address,
595 sizeof(struct ti_i2c_desc),
596 (__u8 *)rom_desc);
597 if (status)
598 return 0;
600 if (rom_desc->Type == desc_type)
601 return start_address;
603 start_address = start_address + sizeof(struct ti_i2c_desc) +
604 le16_to_cpu(rom_desc->Size);
606 } while ((start_address < TI_MAX_I2C_SIZE) && rom_desc->Type);
608 return 0;
611 /* Validate descriptor checksum */
612 static int valid_csum(struct ti_i2c_desc *rom_desc, __u8 *buffer)
614 __u16 i;
615 __u8 cs = 0;
617 for (i = 0; i < le16_to_cpu(rom_desc->Size); i++)
618 cs = (__u8)(cs + buffer[i]);
620 if (cs != rom_desc->CheckSum) {
621 pr_debug("%s - Mismatch %x - %x", __func__, rom_desc->CheckSum, cs);
622 return -EINVAL;
624 return 0;
627 /* Make sure that the I2C image is good */
628 static int check_i2c_image(struct edgeport_serial *serial)
630 struct device *dev = &serial->serial->dev->dev;
631 int status = 0;
632 struct ti_i2c_desc *rom_desc;
633 int start_address = 2;
634 __u8 *buffer;
635 __u16 ttype;
637 rom_desc = kmalloc(sizeof(*rom_desc), GFP_KERNEL);
638 if (!rom_desc)
639 return -ENOMEM;
641 buffer = kmalloc(TI_MAX_I2C_SIZE, GFP_KERNEL);
642 if (!buffer) {
643 kfree(rom_desc);
644 return -ENOMEM;
647 /* Read the first byte (Signature0) must be 0x52 or 0x10 */
648 status = read_rom(serial, 0, 1, buffer);
649 if (status)
650 goto out;
652 if (*buffer != UMP5152 && *buffer != UMP3410) {
653 dev_err(dev, "%s - invalid buffer signature\n", __func__);
654 status = -ENODEV;
655 goto out;
658 do {
659 /* Validate the I2C */
660 status = read_rom(serial,
661 start_address,
662 sizeof(struct ti_i2c_desc),
663 (__u8 *)rom_desc);
664 if (status)
665 break;
667 if ((start_address + sizeof(struct ti_i2c_desc) +
668 le16_to_cpu(rom_desc->Size)) > TI_MAX_I2C_SIZE) {
669 status = -ENODEV;
670 dev_dbg(dev, "%s - structure too big, erroring out.\n", __func__);
671 break;
674 dev_dbg(dev, "%s Type = 0x%x\n", __func__, rom_desc->Type);
676 /* Skip type 2 record */
677 ttype = rom_desc->Type & 0x0f;
678 if (ttype != I2C_DESC_TYPE_FIRMWARE_BASIC
679 && ttype != I2C_DESC_TYPE_FIRMWARE_AUTO) {
680 /* Read the descriptor data */
681 status = read_rom(serial, start_address +
682 sizeof(struct ti_i2c_desc),
683 le16_to_cpu(rom_desc->Size),
684 buffer);
685 if (status)
686 break;
688 status = valid_csum(rom_desc, buffer);
689 if (status)
690 break;
692 start_address = start_address + sizeof(struct ti_i2c_desc) +
693 le16_to_cpu(rom_desc->Size);
695 } while ((rom_desc->Type != I2C_DESC_TYPE_ION) &&
696 (start_address < TI_MAX_I2C_SIZE));
698 if ((rom_desc->Type != I2C_DESC_TYPE_ION) ||
699 (start_address > TI_MAX_I2C_SIZE))
700 status = -ENODEV;
702 out:
703 kfree(buffer);
704 kfree(rom_desc);
705 return status;
708 static int get_manuf_info(struct edgeport_serial *serial, __u8 *buffer)
710 int status;
711 int start_address;
712 struct ti_i2c_desc *rom_desc;
713 struct edge_ti_manuf_descriptor *desc;
714 struct device *dev = &serial->serial->dev->dev;
716 rom_desc = kmalloc(sizeof(*rom_desc), GFP_KERNEL);
717 if (!rom_desc)
718 return -ENOMEM;
720 start_address = get_descriptor_addr(serial, I2C_DESC_TYPE_ION,
721 rom_desc);
723 if (!start_address) {
724 dev_dbg(dev, "%s - Edge Descriptor not found in I2C\n", __func__);
725 status = -ENODEV;
726 goto exit;
729 /* Read the descriptor data */
730 status = read_rom(serial, start_address+sizeof(struct ti_i2c_desc),
731 le16_to_cpu(rom_desc->Size), buffer);
732 if (status)
733 goto exit;
735 status = valid_csum(rom_desc, buffer);
737 desc = (struct edge_ti_manuf_descriptor *)buffer;
738 dev_dbg(dev, "%s - IonConfig 0x%x\n", __func__, desc->IonConfig);
739 dev_dbg(dev, "%s - Version %d\n", __func__, desc->Version);
740 dev_dbg(dev, "%s - Cpu/Board 0x%x\n", __func__, desc->CpuRev_BoardRev);
741 dev_dbg(dev, "%s - NumPorts %d\n", __func__, desc->NumPorts);
742 dev_dbg(dev, "%s - NumVirtualPorts %d\n", __func__, desc->NumVirtualPorts);
743 dev_dbg(dev, "%s - TotalPorts %d\n", __func__, desc->TotalPorts);
745 exit:
746 kfree(rom_desc);
747 return status;
750 /* Build firmware header used for firmware update */
751 static int build_i2c_fw_hdr(__u8 *header, struct device *dev)
753 __u8 *buffer;
754 int buffer_size;
755 int i;
756 int err;
757 __u8 cs = 0;
758 struct ti_i2c_desc *i2c_header;
759 struct ti_i2c_image_header *img_header;
760 struct ti_i2c_firmware_rec *firmware_rec;
761 const struct firmware *fw;
762 const char *fw_name = "edgeport/down3.bin";
764 /* In order to update the I2C firmware we must change the type 2 record
765 * to type 0xF2. This will force the UMP to come up in Boot Mode.
766 * Then while in boot mode, the driver will download the latest
767 * firmware (padded to 15.5k) into the UMP ram. And finally when the
768 * device comes back up in download mode the driver will cause the new
769 * firmware to be copied from the UMP Ram to I2C and the firmware will
770 * update the record type from 0xf2 to 0x02.
773 /* Allocate a 15.5k buffer + 2 bytes for version number
774 * (Firmware Record) */
775 buffer_size = (((1024 * 16) - 512 ) +
776 sizeof(struct ti_i2c_firmware_rec));
778 buffer = kmalloc(buffer_size, GFP_KERNEL);
779 if (!buffer)
780 return -ENOMEM;
782 // Set entire image of 0xffs
783 memset(buffer, 0xff, buffer_size);
785 err = request_firmware(&fw, fw_name, dev);
786 if (err) {
787 dev_err(dev, "Failed to load image \"%s\" err %d\n",
788 fw_name, err);
789 kfree(buffer);
790 return err;
793 /* Save Download Version Number */
794 OperationalMajorVersion = fw->data[0];
795 OperationalMinorVersion = fw->data[1];
796 OperationalBuildNumber = fw->data[2] | (fw->data[3] << 8);
798 /* Copy version number into firmware record */
799 firmware_rec = (struct ti_i2c_firmware_rec *)buffer;
801 firmware_rec->Ver_Major = OperationalMajorVersion;
802 firmware_rec->Ver_Minor = OperationalMinorVersion;
804 /* Pointer to fw_down memory image */
805 img_header = (struct ti_i2c_image_header *)&fw->data[4];
807 memcpy(buffer + sizeof(struct ti_i2c_firmware_rec),
808 &fw->data[4 + sizeof(struct ti_i2c_image_header)],
809 le16_to_cpu(img_header->Length));
811 release_firmware(fw);
813 for (i=0; i < buffer_size; i++) {
814 cs = (__u8)(cs + buffer[i]);
817 kfree(buffer);
819 /* Build new header */
820 i2c_header = (struct ti_i2c_desc *)header;
821 firmware_rec = (struct ti_i2c_firmware_rec*)i2c_header->Data;
823 i2c_header->Type = I2C_DESC_TYPE_FIRMWARE_BLANK;
824 i2c_header->Size = cpu_to_le16(buffer_size);
825 i2c_header->CheckSum = cs;
826 firmware_rec->Ver_Major = OperationalMajorVersion;
827 firmware_rec->Ver_Minor = OperationalMinorVersion;
829 return 0;
832 /* Try to figure out what type of I2c we have */
833 static int i2c_type_bootmode(struct edgeport_serial *serial)
835 struct device *dev = &serial->serial->dev->dev;
836 int status;
837 u8 *data;
839 data = kmalloc(1, GFP_KERNEL);
840 if (!data)
841 return -ENOMEM;
843 /* Try to read type 2 */
844 status = ti_vread_sync(serial->serial->dev, UMPC_MEMORY_READ,
845 DTK_ADDR_SPACE_I2C_TYPE_II, 0, data, 0x01);
846 if (status)
847 dev_dbg(dev, "%s - read 2 status error = %d\n", __func__, status);
848 else
849 dev_dbg(dev, "%s - read 2 data = 0x%x\n", __func__, *data);
850 if ((!status) && (*data == UMP5152 || *data == UMP3410)) {
851 dev_dbg(dev, "%s - ROM_TYPE_II\n", __func__);
852 serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_II;
853 goto out;
856 /* Try to read type 3 */
857 status = ti_vread_sync(serial->serial->dev, UMPC_MEMORY_READ,
858 DTK_ADDR_SPACE_I2C_TYPE_III, 0, data, 0x01);
859 if (status)
860 dev_dbg(dev, "%s - read 3 status error = %d\n", __func__, status);
861 else
862 dev_dbg(dev, "%s - read 2 data = 0x%x\n", __func__, *data);
863 if ((!status) && (*data == UMP5152 || *data == UMP3410)) {
864 dev_dbg(dev, "%s - ROM_TYPE_III\n", __func__);
865 serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_III;
866 goto out;
869 dev_dbg(dev, "%s - Unknown\n", __func__);
870 serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_II;
871 status = -ENODEV;
872 out:
873 kfree(data);
874 return status;
877 static int bulk_xfer(struct usb_serial *serial, void *buffer,
878 int length, int *num_sent)
880 int status;
882 status = usb_bulk_msg(serial->dev,
883 usb_sndbulkpipe(serial->dev,
884 serial->port[0]->bulk_out_endpointAddress),
885 buffer, length, num_sent, 1000);
886 return status;
889 /* Download given firmware image to the device (IN BOOT MODE) */
890 static int download_code(struct edgeport_serial *serial, __u8 *image,
891 int image_length)
893 int status = 0;
894 int pos;
895 int transfer;
896 int done;
898 /* Transfer firmware image */
899 for (pos = 0; pos < image_length; ) {
900 /* Read the next buffer from file */
901 transfer = image_length - pos;
902 if (transfer > EDGE_FW_BULK_MAX_PACKET_SIZE)
903 transfer = EDGE_FW_BULK_MAX_PACKET_SIZE;
905 /* Transfer data */
906 status = bulk_xfer(serial->serial, &image[pos],
907 transfer, &done);
908 if (status)
909 break;
910 /* Advance buffer pointer */
911 pos += done;
914 return status;
917 /* FIXME!!! */
918 static int config_boot_dev(struct usb_device *dev)
920 return 0;
923 static int ti_cpu_rev(struct edge_ti_manuf_descriptor *desc)
925 return TI_GET_CPU_REVISION(desc->CpuRev_BoardRev);
929 * DownloadTIFirmware - Download run-time operating firmware to the TI5052
931 * This routine downloads the main operating code into the TI5052, using the
932 * boot code already burned into E2PROM or ROM.
934 static int download_fw(struct edgeport_serial *serial)
936 struct device *dev = &serial->serial->dev->dev;
937 int status = 0;
938 int start_address;
939 struct edge_ti_manuf_descriptor *ti_manuf_desc;
940 struct usb_interface_descriptor *interface;
941 int download_cur_ver;
942 int download_new_ver;
944 /* This routine is entered by both the BOOT mode and the Download mode
945 * We can determine which code is running by the reading the config
946 * descriptor and if we have only one bulk pipe it is in boot mode
948 serial->product_info.hardware_type = HARDWARE_TYPE_TIUMP;
950 /* Default to type 2 i2c */
951 serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_II;
953 status = choose_config(serial->serial->dev);
954 if (status)
955 return status;
957 interface = &serial->serial->interface->cur_altsetting->desc;
958 if (!interface) {
959 dev_err(dev, "%s - no interface set, error!\n", __func__);
960 return -ENODEV;
964 * Setup initial mode -- the default mode 0 is TI_MODE_CONFIGURING
965 * if we have more than one endpoint we are definitely in download
966 * mode
968 if (interface->bNumEndpoints > 1)
969 serial->product_info.TiMode = TI_MODE_DOWNLOAD;
970 else
971 /* Otherwise we will remain in configuring mode */
972 serial->product_info.TiMode = TI_MODE_CONFIGURING;
974 /********************************************************************/
975 /* Download Mode */
976 /********************************************************************/
977 if (serial->product_info.TiMode == TI_MODE_DOWNLOAD) {
978 struct ti_i2c_desc *rom_desc;
980 dev_dbg(dev, "%s - RUNNING IN DOWNLOAD MODE\n", __func__);
982 status = check_i2c_image(serial);
983 if (status) {
984 dev_dbg(dev, "%s - DOWNLOAD MODE -- BAD I2C\n", __func__);
985 return status;
988 /* Validate Hardware version number
989 * Read Manufacturing Descriptor from TI Based Edgeport
991 ti_manuf_desc = kmalloc(sizeof(*ti_manuf_desc), GFP_KERNEL);
992 if (!ti_manuf_desc)
993 return -ENOMEM;
995 status = get_manuf_info(serial, (__u8 *)ti_manuf_desc);
996 if (status) {
997 kfree(ti_manuf_desc);
998 return status;
1001 /* Check version number of ION descriptor */
1002 if (!ignore_cpu_rev && ti_cpu_rev(ti_manuf_desc) < 2) {
1003 dev_dbg(dev, "%s - Wrong CPU Rev %d (Must be 2)\n",
1004 __func__, ti_cpu_rev(ti_manuf_desc));
1005 kfree(ti_manuf_desc);
1006 return -EINVAL;
1009 rom_desc = kmalloc(sizeof(*rom_desc), GFP_KERNEL);
1010 if (!rom_desc) {
1011 kfree(ti_manuf_desc);
1012 return -ENOMEM;
1015 /* Search for type 2 record (firmware record) */
1016 start_address = get_descriptor_addr(serial,
1017 I2C_DESC_TYPE_FIRMWARE_BASIC, rom_desc);
1018 if (start_address != 0) {
1019 struct ti_i2c_firmware_rec *firmware_version;
1020 u8 *record;
1022 dev_dbg(dev, "%s - Found Type FIRMWARE (Type 2) record\n", __func__);
1024 firmware_version = kmalloc(sizeof(*firmware_version),
1025 GFP_KERNEL);
1026 if (!firmware_version) {
1027 kfree(rom_desc);
1028 kfree(ti_manuf_desc);
1029 return -ENOMEM;
1032 /* Validate version number
1033 * Read the descriptor data
1035 status = read_rom(serial, start_address +
1036 sizeof(struct ti_i2c_desc),
1037 sizeof(struct ti_i2c_firmware_rec),
1038 (__u8 *)firmware_version);
1039 if (status) {
1040 kfree(firmware_version);
1041 kfree(rom_desc);
1042 kfree(ti_manuf_desc);
1043 return status;
1046 /* Check version number of download with current
1047 version in I2c */
1048 download_cur_ver = (firmware_version->Ver_Major << 8) +
1049 (firmware_version->Ver_Minor);
1050 download_new_ver = (OperationalMajorVersion << 8) +
1051 (OperationalMinorVersion);
1053 dev_dbg(dev, "%s - >> FW Versions Device %d.%d Driver %d.%d\n",
1054 __func__, firmware_version->Ver_Major,
1055 firmware_version->Ver_Minor,
1056 OperationalMajorVersion,
1057 OperationalMinorVersion);
1059 /* Check if we have an old version in the I2C and
1060 update if necessary */
1061 if (download_cur_ver < download_new_ver) {
1062 dev_dbg(dev, "%s - Update I2C dld from %d.%d to %d.%d\n",
1063 __func__,
1064 firmware_version->Ver_Major,
1065 firmware_version->Ver_Minor,
1066 OperationalMajorVersion,
1067 OperationalMinorVersion);
1069 record = kmalloc(1, GFP_KERNEL);
1070 if (!record) {
1071 kfree(firmware_version);
1072 kfree(rom_desc);
1073 kfree(ti_manuf_desc);
1074 return -ENOMEM;
1076 /* In order to update the I2C firmware we must
1077 * change the type 2 record to type 0xF2. This
1078 * will force the UMP to come up in Boot Mode.
1079 * Then while in boot mode, the driver will
1080 * download the latest firmware (padded to
1081 * 15.5k) into the UMP ram. Finally when the
1082 * device comes back up in download mode the
1083 * driver will cause the new firmware to be
1084 * copied from the UMP Ram to I2C and the
1085 * firmware will update the record type from
1086 * 0xf2 to 0x02.
1088 *record = I2C_DESC_TYPE_FIRMWARE_BLANK;
1090 /* Change the I2C Firmware record type to
1091 0xf2 to trigger an update */
1092 status = write_rom(serial, start_address,
1093 sizeof(*record), record);
1094 if (status) {
1095 kfree(record);
1096 kfree(firmware_version);
1097 kfree(rom_desc);
1098 kfree(ti_manuf_desc);
1099 return status;
1102 /* verify the write -- must do this in order
1103 * for write to complete before we do the
1104 * hardware reset
1106 status = read_rom(serial,
1107 start_address,
1108 sizeof(*record),
1109 record);
1110 if (status) {
1111 kfree(record);
1112 kfree(firmware_version);
1113 kfree(rom_desc);
1114 kfree(ti_manuf_desc);
1115 return status;
1118 if (*record != I2C_DESC_TYPE_FIRMWARE_BLANK) {
1119 dev_err(dev, "%s - error resetting device\n", __func__);
1120 kfree(record);
1121 kfree(firmware_version);
1122 kfree(rom_desc);
1123 kfree(ti_manuf_desc);
1124 return -ENODEV;
1127 dev_dbg(dev, "%s - HARDWARE RESET\n", __func__);
1129 /* Reset UMP -- Back to BOOT MODE */
1130 status = ti_vsend_sync(serial->serial->dev,
1131 UMPC_HARDWARE_RESET,
1132 0, 0, NULL, 0);
1134 dev_dbg(dev, "%s - HARDWARE RESET return %d\n", __func__, status);
1136 /* return an error on purpose. */
1137 kfree(record);
1138 kfree(firmware_version);
1139 kfree(rom_desc);
1140 kfree(ti_manuf_desc);
1141 return -ENODEV;
1143 kfree(firmware_version);
1145 /* Search for type 0xF2 record (firmware blank record) */
1146 else if ((start_address = get_descriptor_addr(serial, I2C_DESC_TYPE_FIRMWARE_BLANK, rom_desc)) != 0) {
1147 #define HEADER_SIZE (sizeof(struct ti_i2c_desc) + \
1148 sizeof(struct ti_i2c_firmware_rec))
1149 __u8 *header;
1150 __u8 *vheader;
1152 header = kmalloc(HEADER_SIZE, GFP_KERNEL);
1153 if (!header) {
1154 kfree(rom_desc);
1155 kfree(ti_manuf_desc);
1156 return -ENOMEM;
1159 vheader = kmalloc(HEADER_SIZE, GFP_KERNEL);
1160 if (!vheader) {
1161 kfree(header);
1162 kfree(rom_desc);
1163 kfree(ti_manuf_desc);
1164 return -ENOMEM;
1167 dev_dbg(dev, "%s - Found Type BLANK FIRMWARE (Type F2) record\n", __func__);
1170 * In order to update the I2C firmware we must change
1171 * the type 2 record to type 0xF2. This will force the
1172 * UMP to come up in Boot Mode. Then while in boot
1173 * mode, the driver will download the latest firmware
1174 * (padded to 15.5k) into the UMP ram. Finally when the
1175 * device comes back up in download mode the driver
1176 * will cause the new firmware to be copied from the
1177 * UMP Ram to I2C and the firmware will update the
1178 * record type from 0xf2 to 0x02.
1180 status = build_i2c_fw_hdr(header, dev);
1181 if (status) {
1182 kfree(vheader);
1183 kfree(header);
1184 kfree(rom_desc);
1185 kfree(ti_manuf_desc);
1186 return -EINVAL;
1189 /* Update I2C with type 0xf2 record with correct
1190 size and checksum */
1191 status = write_rom(serial,
1192 start_address,
1193 HEADER_SIZE,
1194 header);
1195 if (status) {
1196 kfree(vheader);
1197 kfree(header);
1198 kfree(rom_desc);
1199 kfree(ti_manuf_desc);
1200 return -EINVAL;
1203 /* verify the write -- must do this in order for
1204 write to complete before we do the hardware reset */
1205 status = read_rom(serial, start_address,
1206 HEADER_SIZE, vheader);
1208 if (status) {
1209 dev_dbg(dev, "%s - can't read header back\n", __func__);
1210 kfree(vheader);
1211 kfree(header);
1212 kfree(rom_desc);
1213 kfree(ti_manuf_desc);
1214 return status;
1216 if (memcmp(vheader, header, HEADER_SIZE)) {
1217 dev_dbg(dev, "%s - write download record failed\n", __func__);
1218 kfree(vheader);
1219 kfree(header);
1220 kfree(rom_desc);
1221 kfree(ti_manuf_desc);
1222 return -EINVAL;
1225 kfree(vheader);
1226 kfree(header);
1228 dev_dbg(dev, "%s - Start firmware update\n", __func__);
1230 /* Tell firmware to copy download image into I2C */
1231 status = ti_vsend_sync(serial->serial->dev,
1232 UMPC_COPY_DNLD_TO_I2C, 0, 0, NULL, 0);
1234 dev_dbg(dev, "%s - Update complete 0x%x\n", __func__, status);
1235 if (status) {
1236 dev_err(dev,
1237 "%s - UMPC_COPY_DNLD_TO_I2C failed\n",
1238 __func__);
1239 kfree(rom_desc);
1240 kfree(ti_manuf_desc);
1241 return status;
1245 // The device is running the download code
1246 kfree(rom_desc);
1247 kfree(ti_manuf_desc);
1248 return 0;
1251 /********************************************************************/
1252 /* Boot Mode */
1253 /********************************************************************/
1254 dev_dbg(dev, "%s - RUNNING IN BOOT MODE\n", __func__);
1256 /* Configure the TI device so we can use the BULK pipes for download */
1257 status = config_boot_dev(serial->serial->dev);
1258 if (status)
1259 return status;
1261 if (le16_to_cpu(serial->serial->dev->descriptor.idVendor)
1262 != USB_VENDOR_ID_ION) {
1263 dev_dbg(dev, "%s - VID = 0x%x\n", __func__,
1264 le16_to_cpu(serial->serial->dev->descriptor.idVendor));
1265 serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_II;
1266 goto stayinbootmode;
1269 /* We have an ION device (I2c Must be programmed)
1270 Determine I2C image type */
1271 if (i2c_type_bootmode(serial))
1272 goto stayinbootmode;
1274 /* Check for ION Vendor ID and that the I2C is valid */
1275 if (!check_i2c_image(serial)) {
1276 struct ti_i2c_image_header *header;
1277 int i;
1278 __u8 cs = 0;
1279 __u8 *buffer;
1280 int buffer_size;
1281 int err;
1282 const struct firmware *fw;
1283 const char *fw_name = "edgeport/down3.bin";
1285 /* Validate Hardware version number
1286 * Read Manufacturing Descriptor from TI Based Edgeport
1288 ti_manuf_desc = kmalloc(sizeof(*ti_manuf_desc), GFP_KERNEL);
1289 if (!ti_manuf_desc)
1290 return -ENOMEM;
1292 status = get_manuf_info(serial, (__u8 *)ti_manuf_desc);
1293 if (status) {
1294 kfree(ti_manuf_desc);
1295 goto stayinbootmode;
1298 /* Check for version 2 */
1299 if (!ignore_cpu_rev && ti_cpu_rev(ti_manuf_desc) < 2) {
1300 dev_dbg(dev, "%s - Wrong CPU Rev %d (Must be 2)\n",
1301 __func__, ti_cpu_rev(ti_manuf_desc));
1302 kfree(ti_manuf_desc);
1303 goto stayinbootmode;
1306 kfree(ti_manuf_desc);
1309 * In order to update the I2C firmware we must change the type
1310 * 2 record to type 0xF2. This will force the UMP to come up
1311 * in Boot Mode. Then while in boot mode, the driver will
1312 * download the latest firmware (padded to 15.5k) into the
1313 * UMP ram. Finally when the device comes back up in download
1314 * mode the driver will cause the new firmware to be copied
1315 * from the UMP Ram to I2C and the firmware will update the
1316 * record type from 0xf2 to 0x02.
1318 * Do we really have to copy the whole firmware image,
1319 * or could we do this in place!
1322 /* Allocate a 15.5k buffer + 3 byte header */
1323 buffer_size = (((1024 * 16) - 512) +
1324 sizeof(struct ti_i2c_image_header));
1325 buffer = kmalloc(buffer_size, GFP_KERNEL);
1326 if (!buffer)
1327 return -ENOMEM;
1329 /* Initialize the buffer to 0xff (pad the buffer) */
1330 memset(buffer, 0xff, buffer_size);
1332 err = request_firmware(&fw, fw_name, dev);
1333 if (err) {
1334 dev_err(dev, "Failed to load image \"%s\" err %d\n",
1335 fw_name, err);
1336 kfree(buffer);
1337 return err;
1339 memcpy(buffer, &fw->data[4], fw->size - 4);
1340 release_firmware(fw);
1342 for (i = sizeof(struct ti_i2c_image_header);
1343 i < buffer_size; i++) {
1344 cs = (__u8)(cs + buffer[i]);
1347 header = (struct ti_i2c_image_header *)buffer;
1349 /* update length and checksum after padding */
1350 header->Length = cpu_to_le16((__u16)(buffer_size -
1351 sizeof(struct ti_i2c_image_header)));
1352 header->CheckSum = cs;
1354 /* Download the operational code */
1355 dev_dbg(dev, "%s - Downloading operational code image (TI UMP)\n", __func__);
1356 status = download_code(serial, buffer, buffer_size);
1358 kfree(buffer);
1360 if (status) {
1361 dev_dbg(dev, "%s - Error downloading operational code image\n", __func__);
1362 return status;
1365 /* Device will reboot */
1366 serial->product_info.TiMode = TI_MODE_TRANSITIONING;
1368 dev_dbg(dev, "%s - Download successful -- Device rebooting...\n", __func__);
1370 /* return an error on purpose */
1371 return -ENODEV;
1374 stayinbootmode:
1375 /* Eprom is invalid or blank stay in boot mode */
1376 dev_dbg(dev, "%s - STAYING IN BOOT MODE\n", __func__);
1377 serial->product_info.TiMode = TI_MODE_BOOT;
1379 return 0;
1383 static int ti_do_config(struct edgeport_port *port, int feature, int on)
1385 int port_number = port->port->port_number;
1387 on = !!on; /* 1 or 0 not bitmask */
1388 return send_cmd(port->port->serial->dev,
1389 feature, (__u8)(UMPM_UART1_PORT + port_number),
1390 on, NULL, 0);
1394 static int restore_mcr(struct edgeport_port *port, __u8 mcr)
1396 int status = 0;
1398 dev_dbg(&port->port->dev, "%s - %x\n", __func__, mcr);
1400 status = ti_do_config(port, UMPC_SET_CLR_DTR, mcr & MCR_DTR);
1401 if (status)
1402 return status;
1403 status = ti_do_config(port, UMPC_SET_CLR_RTS, mcr & MCR_RTS);
1404 if (status)
1405 return status;
1406 return ti_do_config(port, UMPC_SET_CLR_LOOPBACK, mcr & MCR_LOOPBACK);
1409 /* Convert TI LSR to standard UART flags */
1410 static __u8 map_line_status(__u8 ti_lsr)
1412 __u8 lsr = 0;
1414 #define MAP_FLAG(flagUmp, flagUart) \
1415 if (ti_lsr & flagUmp) \
1416 lsr |= flagUart;
1418 MAP_FLAG(UMP_UART_LSR_OV_MASK, LSR_OVER_ERR) /* overrun */
1419 MAP_FLAG(UMP_UART_LSR_PE_MASK, LSR_PAR_ERR) /* parity error */
1420 MAP_FLAG(UMP_UART_LSR_FE_MASK, LSR_FRM_ERR) /* framing error */
1421 MAP_FLAG(UMP_UART_LSR_BR_MASK, LSR_BREAK) /* break detected */
1422 MAP_FLAG(UMP_UART_LSR_RX_MASK, LSR_RX_AVAIL) /* rx data available */
1423 MAP_FLAG(UMP_UART_LSR_TX_MASK, LSR_TX_EMPTY) /* tx hold reg empty */
1425 #undef MAP_FLAG
1427 return lsr;
1430 static void handle_new_msr(struct edgeport_port *edge_port, __u8 msr)
1432 struct async_icount *icount;
1433 struct tty_struct *tty;
1435 dev_dbg(&edge_port->port->dev, "%s - %02x\n", __func__, msr);
1437 if (msr & (EDGEPORT_MSR_DELTA_CTS | EDGEPORT_MSR_DELTA_DSR |
1438 EDGEPORT_MSR_DELTA_RI | EDGEPORT_MSR_DELTA_CD)) {
1439 icount = &edge_port->port->icount;
1441 /* update input line counters */
1442 if (msr & EDGEPORT_MSR_DELTA_CTS)
1443 icount->cts++;
1444 if (msr & EDGEPORT_MSR_DELTA_DSR)
1445 icount->dsr++;
1446 if (msr & EDGEPORT_MSR_DELTA_CD)
1447 icount->dcd++;
1448 if (msr & EDGEPORT_MSR_DELTA_RI)
1449 icount->rng++;
1450 wake_up_interruptible(&edge_port->port->port.delta_msr_wait);
1453 /* Save the new modem status */
1454 edge_port->shadow_msr = msr & 0xf0;
1456 tty = tty_port_tty_get(&edge_port->port->port);
1457 /* handle CTS flow control */
1458 if (tty && C_CRTSCTS(tty)) {
1459 if (msr & EDGEPORT_MSR_CTS)
1460 tty_wakeup(tty);
1462 tty_kref_put(tty);
1465 static void handle_new_lsr(struct edgeport_port *edge_port, int lsr_data,
1466 __u8 lsr, __u8 data)
1468 struct async_icount *icount;
1469 __u8 new_lsr = (__u8)(lsr & (__u8)(LSR_OVER_ERR | LSR_PAR_ERR |
1470 LSR_FRM_ERR | LSR_BREAK));
1472 dev_dbg(&edge_port->port->dev, "%s - %02x\n", __func__, new_lsr);
1474 edge_port->shadow_lsr = lsr;
1476 if (new_lsr & LSR_BREAK)
1478 * Parity and Framing errors only count if they
1479 * occur exclusive of a break being received.
1481 new_lsr &= (__u8)(LSR_OVER_ERR | LSR_BREAK);
1483 /* Place LSR data byte into Rx buffer */
1484 if (lsr_data)
1485 edge_tty_recv(edge_port->port, &data, 1);
1487 /* update input line counters */
1488 icount = &edge_port->port->icount;
1489 if (new_lsr & LSR_BREAK)
1490 icount->brk++;
1491 if (new_lsr & LSR_OVER_ERR)
1492 icount->overrun++;
1493 if (new_lsr & LSR_PAR_ERR)
1494 icount->parity++;
1495 if (new_lsr & LSR_FRM_ERR)
1496 icount->frame++;
1500 static void edge_interrupt_callback(struct urb *urb)
1502 struct edgeport_serial *edge_serial = urb->context;
1503 struct usb_serial_port *port;
1504 struct edgeport_port *edge_port;
1505 struct device *dev;
1506 unsigned char *data = urb->transfer_buffer;
1507 int length = urb->actual_length;
1508 int port_number;
1509 int function;
1510 int retval;
1511 __u8 lsr;
1512 __u8 msr;
1513 int status = urb->status;
1515 switch (status) {
1516 case 0:
1517 /* success */
1518 break;
1519 case -ECONNRESET:
1520 case -ENOENT:
1521 case -ESHUTDOWN:
1522 /* this urb is terminated, clean up */
1523 dev_dbg(&urb->dev->dev, "%s - urb shutting down with status: %d\n",
1524 __func__, status);
1525 return;
1526 default:
1527 dev_err(&urb->dev->dev, "%s - nonzero urb status received: "
1528 "%d\n", __func__, status);
1529 goto exit;
1532 if (!length) {
1533 dev_dbg(&urb->dev->dev, "%s - no data in urb\n", __func__);
1534 goto exit;
1537 dev = &edge_serial->serial->dev->dev;
1538 usb_serial_debug_data(dev, __func__, length, data);
1540 if (length != 2) {
1541 dev_dbg(dev, "%s - expecting packet of size 2, got %d\n", __func__, length);
1542 goto exit;
1545 port_number = TIUMP_GET_PORT_FROM_CODE(data[0]);
1546 function = TIUMP_GET_FUNC_FROM_CODE(data[0]);
1547 dev_dbg(dev, "%s - port_number %d, function %d, info 0x%x\n", __func__,
1548 port_number, function, data[1]);
1549 port = edge_serial->serial->port[port_number];
1550 edge_port = usb_get_serial_port_data(port);
1551 if (!edge_port) {
1552 dev_dbg(dev, "%s - edge_port not found\n", __func__);
1553 return;
1555 switch (function) {
1556 case TIUMP_INTERRUPT_CODE_LSR:
1557 lsr = map_line_status(data[1]);
1558 if (lsr & UMP_UART_LSR_DATA_MASK) {
1559 /* Save the LSR event for bulk read
1560 completion routine */
1561 dev_dbg(dev, "%s - LSR Event Port %u LSR Status = %02x\n",
1562 __func__, port_number, lsr);
1563 edge_port->lsr_event = 1;
1564 edge_port->lsr_mask = lsr;
1565 } else {
1566 dev_dbg(dev, "%s - ===== Port %d LSR Status = %02x ======\n",
1567 __func__, port_number, lsr);
1568 handle_new_lsr(edge_port, 0, lsr, 0);
1570 break;
1572 case TIUMP_INTERRUPT_CODE_MSR: /* MSR */
1573 /* Copy MSR from UMP */
1574 msr = data[1];
1575 dev_dbg(dev, "%s - ===== Port %u MSR Status = %02x ======\n",
1576 __func__, port_number, msr);
1577 handle_new_msr(edge_port, msr);
1578 break;
1580 default:
1581 dev_err(&urb->dev->dev,
1582 "%s - Unknown Interrupt code from UMP %x\n",
1583 __func__, data[1]);
1584 break;
1588 exit:
1589 retval = usb_submit_urb(urb, GFP_ATOMIC);
1590 if (retval)
1591 dev_err(&urb->dev->dev,
1592 "%s - usb_submit_urb failed with result %d\n",
1593 __func__, retval);
1596 static void edge_bulk_in_callback(struct urb *urb)
1598 struct edgeport_port *edge_port = urb->context;
1599 struct device *dev = &edge_port->port->dev;
1600 unsigned char *data = urb->transfer_buffer;
1601 int retval = 0;
1602 int port_number;
1603 int status = urb->status;
1605 switch (status) {
1606 case 0:
1607 /* success */
1608 break;
1609 case -ECONNRESET:
1610 case -ENOENT:
1611 case -ESHUTDOWN:
1612 /* this urb is terminated, clean up */
1613 dev_dbg(&urb->dev->dev, "%s - urb shutting down with status: %d\n", __func__, status);
1614 return;
1615 default:
1616 dev_err(&urb->dev->dev, "%s - nonzero read bulk status received: %d\n", __func__, status);
1619 if (status == -EPIPE)
1620 goto exit;
1622 if (status) {
1623 dev_err(&urb->dev->dev, "%s - stopping read!\n", __func__);
1624 return;
1627 port_number = edge_port->port->port_number;
1629 if (edge_port->lsr_event) {
1630 edge_port->lsr_event = 0;
1631 dev_dbg(dev, "%s ===== Port %u LSR Status = %02x, Data = %02x ======\n",
1632 __func__, port_number, edge_port->lsr_mask, *data);
1633 handle_new_lsr(edge_port, 1, edge_port->lsr_mask, *data);
1634 /* Adjust buffer length/pointer */
1635 --urb->actual_length;
1636 ++data;
1639 if (urb->actual_length) {
1640 usb_serial_debug_data(dev, __func__, urb->actual_length, data);
1641 if (edge_port->close_pending)
1642 dev_dbg(dev, "%s - close pending, dropping data on the floor\n",
1643 __func__);
1644 else
1645 edge_tty_recv(edge_port->port, data,
1646 urb->actual_length);
1647 edge_port->port->icount.rx += urb->actual_length;
1650 exit:
1651 /* continue read unless stopped */
1652 spin_lock(&edge_port->ep_lock);
1653 if (edge_port->ep_read_urb_state == EDGE_READ_URB_RUNNING)
1654 retval = usb_submit_urb(urb, GFP_ATOMIC);
1655 else if (edge_port->ep_read_urb_state == EDGE_READ_URB_STOPPING)
1656 edge_port->ep_read_urb_state = EDGE_READ_URB_STOPPED;
1658 spin_unlock(&edge_port->ep_lock);
1659 if (retval)
1660 dev_err(dev, "%s - usb_submit_urb failed with result %d\n", __func__, retval);
1663 static void edge_tty_recv(struct usb_serial_port *port, unsigned char *data,
1664 int length)
1666 int queued;
1668 queued = tty_insert_flip_string(&port->port, data, length);
1669 if (queued < length)
1670 dev_err(&port->dev, "%s - dropping data, %d bytes lost\n",
1671 __func__, length - queued);
1672 tty_flip_buffer_push(&port->port);
1675 static void edge_bulk_out_callback(struct urb *urb)
1677 struct usb_serial_port *port = urb->context;
1678 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1679 int status = urb->status;
1680 struct tty_struct *tty;
1682 edge_port->ep_write_urb_in_use = 0;
1684 switch (status) {
1685 case 0:
1686 /* success */
1687 break;
1688 case -ECONNRESET:
1689 case -ENOENT:
1690 case -ESHUTDOWN:
1691 /* this urb is terminated, clean up */
1692 dev_dbg(&urb->dev->dev, "%s - urb shutting down with status: %d\n",
1693 __func__, status);
1694 return;
1695 default:
1696 dev_err_console(port, "%s - nonzero write bulk status "
1697 "received: %d\n", __func__, status);
1700 /* send any buffered data */
1701 tty = tty_port_tty_get(&port->port);
1702 edge_send(port, tty);
1703 tty_kref_put(tty);
1706 static int edge_open(struct tty_struct *tty, struct usb_serial_port *port)
1708 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1709 struct edgeport_serial *edge_serial;
1710 struct usb_device *dev;
1711 struct urb *urb;
1712 int port_number;
1713 int status;
1714 u16 open_settings;
1715 u8 transaction_timeout;
1717 if (edge_port == NULL)
1718 return -ENODEV;
1720 port_number = port->port_number;
1722 dev = port->serial->dev;
1724 /* turn off loopback */
1725 status = ti_do_config(edge_port, UMPC_SET_CLR_LOOPBACK, 0);
1726 if (status) {
1727 dev_err(&port->dev,
1728 "%s - cannot send clear loopback command, %d\n",
1729 __func__, status);
1730 return status;
1733 /* set up the port settings */
1734 if (tty)
1735 edge_set_termios(tty, port, &tty->termios);
1737 /* open up the port */
1739 /* milliseconds to timeout for DMA transfer */
1740 transaction_timeout = 2;
1742 edge_port->ump_read_timeout =
1743 max(20, ((transaction_timeout * 3) / 2));
1745 /* milliseconds to timeout for DMA transfer */
1746 open_settings = (u8)(UMP_DMA_MODE_CONTINOUS |
1747 UMP_PIPE_TRANS_TIMEOUT_ENA |
1748 (transaction_timeout << 2));
1750 dev_dbg(&port->dev, "%s - Sending UMPC_OPEN_PORT\n", __func__);
1752 /* Tell TI to open and start the port */
1753 status = send_cmd(dev, UMPC_OPEN_PORT,
1754 (u8)(UMPM_UART1_PORT + port_number), open_settings, NULL, 0);
1755 if (status) {
1756 dev_err(&port->dev, "%s - cannot send open command, %d\n",
1757 __func__, status);
1758 return status;
1761 /* Start the DMA? */
1762 status = send_cmd(dev, UMPC_START_PORT,
1763 (u8)(UMPM_UART1_PORT + port_number), 0, NULL, 0);
1764 if (status) {
1765 dev_err(&port->dev, "%s - cannot send start DMA command, %d\n",
1766 __func__, status);
1767 return status;
1770 /* Clear TX and RX buffers in UMP */
1771 status = purge_port(port, UMP_PORT_DIR_OUT | UMP_PORT_DIR_IN);
1772 if (status) {
1773 dev_err(&port->dev,
1774 "%s - cannot send clear buffers command, %d\n",
1775 __func__, status);
1776 return status;
1779 /* Read Initial MSR */
1780 status = ti_vread_sync(dev, UMPC_READ_MSR, 0,
1781 (__u16)(UMPM_UART1_PORT + port_number),
1782 &edge_port->shadow_msr, 1);
1783 if (status) {
1784 dev_err(&port->dev, "%s - cannot send read MSR command, %d\n",
1785 __func__, status);
1786 return status;
1789 dev_dbg(&port->dev, "ShadowMSR 0x%X\n", edge_port->shadow_msr);
1791 /* Set Initial MCR */
1792 edge_port->shadow_mcr = MCR_RTS | MCR_DTR;
1793 dev_dbg(&port->dev, "ShadowMCR 0x%X\n", edge_port->shadow_mcr);
1795 edge_serial = edge_port->edge_serial;
1796 if (mutex_lock_interruptible(&edge_serial->es_lock))
1797 return -ERESTARTSYS;
1798 if (edge_serial->num_ports_open == 0) {
1799 /* we are the first port to open, post the interrupt urb */
1800 urb = edge_serial->serial->port[0]->interrupt_in_urb;
1801 if (!urb) {
1802 dev_err(&port->dev,
1803 "%s - no interrupt urb present, exiting\n",
1804 __func__);
1805 status = -EINVAL;
1806 goto release_es_lock;
1808 urb->context = edge_serial;
1809 status = usb_submit_urb(urb, GFP_KERNEL);
1810 if (status) {
1811 dev_err(&port->dev,
1812 "%s - usb_submit_urb failed with value %d\n",
1813 __func__, status);
1814 goto release_es_lock;
1819 * reset the data toggle on the bulk endpoints to work around bug in
1820 * host controllers where things get out of sync some times
1822 usb_clear_halt(dev, port->write_urb->pipe);
1823 usb_clear_halt(dev, port->read_urb->pipe);
1825 /* start up our bulk read urb */
1826 urb = port->read_urb;
1827 if (!urb) {
1828 dev_err(&port->dev, "%s - no read urb present, exiting\n",
1829 __func__);
1830 status = -EINVAL;
1831 goto unlink_int_urb;
1833 edge_port->ep_read_urb_state = EDGE_READ_URB_RUNNING;
1834 urb->context = edge_port;
1835 status = usb_submit_urb(urb, GFP_KERNEL);
1836 if (status) {
1837 dev_err(&port->dev,
1838 "%s - read bulk usb_submit_urb failed with value %d\n",
1839 __func__, status);
1840 goto unlink_int_urb;
1843 ++edge_serial->num_ports_open;
1845 goto release_es_lock;
1847 unlink_int_urb:
1848 if (edge_port->edge_serial->num_ports_open == 0)
1849 usb_kill_urb(port->serial->port[0]->interrupt_in_urb);
1850 release_es_lock:
1851 mutex_unlock(&edge_serial->es_lock);
1852 return status;
1855 static void edge_close(struct usb_serial_port *port)
1857 struct edgeport_serial *edge_serial;
1858 struct edgeport_port *edge_port;
1859 struct usb_serial *serial = port->serial;
1860 unsigned long flags;
1861 int port_number;
1863 edge_serial = usb_get_serial_data(port->serial);
1864 edge_port = usb_get_serial_port_data(port);
1865 if (edge_serial == NULL || edge_port == NULL)
1866 return;
1868 /* The bulkreadcompletion routine will check
1869 * this flag and dump add read data */
1870 edge_port->close_pending = 1;
1872 usb_kill_urb(port->read_urb);
1873 usb_kill_urb(port->write_urb);
1874 edge_port->ep_write_urb_in_use = 0;
1875 spin_lock_irqsave(&edge_port->ep_lock, flags);
1876 kfifo_reset_out(&port->write_fifo);
1877 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
1879 dev_dbg(&port->dev, "%s - send umpc_close_port\n", __func__);
1880 port_number = port->port_number;
1881 send_cmd(serial->dev, UMPC_CLOSE_PORT,
1882 (__u8)(UMPM_UART1_PORT + port_number), 0, NULL, 0);
1884 mutex_lock(&edge_serial->es_lock);
1885 --edge_port->edge_serial->num_ports_open;
1886 if (edge_port->edge_serial->num_ports_open <= 0) {
1887 /* last port is now closed, let's shut down our interrupt urb */
1888 usb_kill_urb(port->serial->port[0]->interrupt_in_urb);
1889 edge_port->edge_serial->num_ports_open = 0;
1891 mutex_unlock(&edge_serial->es_lock);
1892 edge_port->close_pending = 0;
1895 static int edge_write(struct tty_struct *tty, struct usb_serial_port *port,
1896 const unsigned char *data, int count)
1898 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1900 if (count == 0) {
1901 dev_dbg(&port->dev, "%s - write request of 0 bytes\n", __func__);
1902 return 0;
1905 if (edge_port == NULL)
1906 return -ENODEV;
1907 if (edge_port->close_pending == 1)
1908 return -ENODEV;
1910 count = kfifo_in_locked(&port->write_fifo, data, count,
1911 &edge_port->ep_lock);
1912 edge_send(port, tty);
1914 return count;
1917 static void edge_send(struct usb_serial_port *port, struct tty_struct *tty)
1919 int count, result;
1920 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1921 unsigned long flags;
1923 spin_lock_irqsave(&edge_port->ep_lock, flags);
1925 if (edge_port->ep_write_urb_in_use) {
1926 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
1927 return;
1930 count = kfifo_out(&port->write_fifo,
1931 port->write_urb->transfer_buffer,
1932 port->bulk_out_size);
1934 if (count == 0) {
1935 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
1936 return;
1939 edge_port->ep_write_urb_in_use = 1;
1941 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
1943 usb_serial_debug_data(&port->dev, __func__, count, port->write_urb->transfer_buffer);
1945 /* set up our urb */
1946 port->write_urb->transfer_buffer_length = count;
1948 /* send the data out the bulk port */
1949 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
1950 if (result) {
1951 dev_err_console(port,
1952 "%s - failed submitting write urb, error %d\n",
1953 __func__, result);
1954 edge_port->ep_write_urb_in_use = 0;
1955 /* TODO: reschedule edge_send */
1956 } else
1957 edge_port->port->icount.tx += count;
1959 /* wakeup any process waiting for writes to complete */
1960 /* there is now more room in the buffer for new writes */
1961 if (tty)
1962 tty_wakeup(tty);
1965 static int edge_write_room(struct tty_struct *tty)
1967 struct usb_serial_port *port = tty->driver_data;
1968 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1969 int room = 0;
1970 unsigned long flags;
1972 if (edge_port == NULL)
1973 return 0;
1974 if (edge_port->close_pending == 1)
1975 return 0;
1977 spin_lock_irqsave(&edge_port->ep_lock, flags);
1978 room = kfifo_avail(&port->write_fifo);
1979 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
1981 dev_dbg(&port->dev, "%s - returns %d\n", __func__, room);
1982 return room;
1985 static int edge_chars_in_buffer(struct tty_struct *tty)
1987 struct usb_serial_port *port = tty->driver_data;
1988 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1989 int chars = 0;
1990 unsigned long flags;
1991 if (edge_port == NULL)
1992 return 0;
1994 spin_lock_irqsave(&edge_port->ep_lock, flags);
1995 chars = kfifo_len(&port->write_fifo);
1996 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
1998 dev_dbg(&port->dev, "%s - returns %d\n", __func__, chars);
1999 return chars;
2002 static bool edge_tx_empty(struct usb_serial_port *port)
2004 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2005 int ret;
2007 ret = tx_active(edge_port);
2008 if (ret > 0)
2009 return false;
2011 return true;
2014 static void edge_throttle(struct tty_struct *tty)
2016 struct usb_serial_port *port = tty->driver_data;
2017 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2018 int status;
2020 if (edge_port == NULL)
2021 return;
2023 /* if we are implementing XON/XOFF, send the stop character */
2024 if (I_IXOFF(tty)) {
2025 unsigned char stop_char = STOP_CHAR(tty);
2026 status = edge_write(tty, port, &stop_char, 1);
2027 if (status <= 0) {
2028 dev_err(&port->dev, "%s - failed to write stop character, %d\n", __func__, status);
2032 /* if we are implementing RTS/CTS, stop reads */
2033 /* and the Edgeport will clear the RTS line */
2034 if (C_CRTSCTS(tty))
2035 stop_read(edge_port);
2039 static void edge_unthrottle(struct tty_struct *tty)
2041 struct usb_serial_port *port = tty->driver_data;
2042 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2043 int status;
2045 if (edge_port == NULL)
2046 return;
2048 /* if we are implementing XON/XOFF, send the start character */
2049 if (I_IXOFF(tty)) {
2050 unsigned char start_char = START_CHAR(tty);
2051 status = edge_write(tty, port, &start_char, 1);
2052 if (status <= 0) {
2053 dev_err(&port->dev, "%s - failed to write start character, %d\n", __func__, status);
2056 /* if we are implementing RTS/CTS, restart reads */
2057 /* are the Edgeport will assert the RTS line */
2058 if (C_CRTSCTS(tty)) {
2059 status = restart_read(edge_port);
2060 if (status)
2061 dev_err(&port->dev,
2062 "%s - read bulk usb_submit_urb failed: %d\n",
2063 __func__, status);
2068 static void stop_read(struct edgeport_port *edge_port)
2070 unsigned long flags;
2072 spin_lock_irqsave(&edge_port->ep_lock, flags);
2074 if (edge_port->ep_read_urb_state == EDGE_READ_URB_RUNNING)
2075 edge_port->ep_read_urb_state = EDGE_READ_URB_STOPPING;
2076 edge_port->shadow_mcr &= ~MCR_RTS;
2078 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2081 static int restart_read(struct edgeport_port *edge_port)
2083 struct urb *urb;
2084 int status = 0;
2085 unsigned long flags;
2087 spin_lock_irqsave(&edge_port->ep_lock, flags);
2089 if (edge_port->ep_read_urb_state == EDGE_READ_URB_STOPPED) {
2090 urb = edge_port->port->read_urb;
2091 status = usb_submit_urb(urb, GFP_ATOMIC);
2093 edge_port->ep_read_urb_state = EDGE_READ_URB_RUNNING;
2094 edge_port->shadow_mcr |= MCR_RTS;
2096 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2098 return status;
2101 static void change_port_settings(struct tty_struct *tty,
2102 struct edgeport_port *edge_port, struct ktermios *old_termios)
2104 struct device *dev = &edge_port->port->dev;
2105 struct ump_uart_config *config;
2106 int baud;
2107 unsigned cflag;
2108 int status;
2109 int port_number = edge_port->port->port_number;
2111 config = kmalloc (sizeof (*config), GFP_KERNEL);
2112 if (!config) {
2113 tty->termios = *old_termios;
2114 return;
2117 cflag = tty->termios.c_cflag;
2119 config->wFlags = 0;
2121 /* These flags must be set */
2122 config->wFlags |= UMP_MASK_UART_FLAGS_RECEIVE_MS_INT;
2123 config->wFlags |= UMP_MASK_UART_FLAGS_AUTO_START_ON_ERR;
2124 config->bUartMode = (__u8)(edge_port->bUartMode);
2126 switch (cflag & CSIZE) {
2127 case CS5:
2128 config->bDataBits = UMP_UART_CHAR5BITS;
2129 dev_dbg(dev, "%s - data bits = 5\n", __func__);
2130 break;
2131 case CS6:
2132 config->bDataBits = UMP_UART_CHAR6BITS;
2133 dev_dbg(dev, "%s - data bits = 6\n", __func__);
2134 break;
2135 case CS7:
2136 config->bDataBits = UMP_UART_CHAR7BITS;
2137 dev_dbg(dev, "%s - data bits = 7\n", __func__);
2138 break;
2139 default:
2140 case CS8:
2141 config->bDataBits = UMP_UART_CHAR8BITS;
2142 dev_dbg(dev, "%s - data bits = 8\n", __func__);
2143 break;
2146 if (cflag & PARENB) {
2147 if (cflag & PARODD) {
2148 config->wFlags |= UMP_MASK_UART_FLAGS_PARITY;
2149 config->bParity = UMP_UART_ODDPARITY;
2150 dev_dbg(dev, "%s - parity = odd\n", __func__);
2151 } else {
2152 config->wFlags |= UMP_MASK_UART_FLAGS_PARITY;
2153 config->bParity = UMP_UART_EVENPARITY;
2154 dev_dbg(dev, "%s - parity = even\n", __func__);
2156 } else {
2157 config->bParity = UMP_UART_NOPARITY;
2158 dev_dbg(dev, "%s - parity = none\n", __func__);
2161 if (cflag & CSTOPB) {
2162 config->bStopBits = UMP_UART_STOPBIT2;
2163 dev_dbg(dev, "%s - stop bits = 2\n", __func__);
2164 } else {
2165 config->bStopBits = UMP_UART_STOPBIT1;
2166 dev_dbg(dev, "%s - stop bits = 1\n", __func__);
2169 /* figure out the flow control settings */
2170 if (cflag & CRTSCTS) {
2171 config->wFlags |= UMP_MASK_UART_FLAGS_OUT_X_CTS_FLOW;
2172 config->wFlags |= UMP_MASK_UART_FLAGS_RTS_FLOW;
2173 dev_dbg(dev, "%s - RTS/CTS is enabled\n", __func__);
2174 } else {
2175 dev_dbg(dev, "%s - RTS/CTS is disabled\n", __func__);
2176 restart_read(edge_port);
2179 /* if we are implementing XON/XOFF, set the start and stop
2180 character in the device */
2181 config->cXon = START_CHAR(tty);
2182 config->cXoff = STOP_CHAR(tty);
2184 /* if we are implementing INBOUND XON/XOFF */
2185 if (I_IXOFF(tty)) {
2186 config->wFlags |= UMP_MASK_UART_FLAGS_IN_X;
2187 dev_dbg(dev, "%s - INBOUND XON/XOFF is enabled, XON = %2x, XOFF = %2x\n",
2188 __func__, config->cXon, config->cXoff);
2189 } else
2190 dev_dbg(dev, "%s - INBOUND XON/XOFF is disabled\n", __func__);
2192 /* if we are implementing OUTBOUND XON/XOFF */
2193 if (I_IXON(tty)) {
2194 config->wFlags |= UMP_MASK_UART_FLAGS_OUT_X;
2195 dev_dbg(dev, "%s - OUTBOUND XON/XOFF is enabled, XON = %2x, XOFF = %2x\n",
2196 __func__, config->cXon, config->cXoff);
2197 } else
2198 dev_dbg(dev, "%s - OUTBOUND XON/XOFF is disabled\n", __func__);
2200 tty->termios.c_cflag &= ~CMSPAR;
2202 /* Round the baud rate */
2203 baud = tty_get_baud_rate(tty);
2204 if (!baud) {
2205 /* pick a default, any default... */
2206 baud = 9600;
2207 } else
2208 tty_encode_baud_rate(tty, baud, baud);
2210 edge_port->baud_rate = baud;
2211 config->wBaudRate = (__u16)((461550L + baud/2) / baud);
2213 /* FIXME: Recompute actual baud from divisor here */
2215 dev_dbg(dev, "%s - baud rate = %d, wBaudRate = %d\n", __func__, baud, config->wBaudRate);
2217 dev_dbg(dev, "wBaudRate: %d\n", (int)(461550L / config->wBaudRate));
2218 dev_dbg(dev, "wFlags: 0x%x\n", config->wFlags);
2219 dev_dbg(dev, "bDataBits: %d\n", config->bDataBits);
2220 dev_dbg(dev, "bParity: %d\n", config->bParity);
2221 dev_dbg(dev, "bStopBits: %d\n", config->bStopBits);
2222 dev_dbg(dev, "cXon: %d\n", config->cXon);
2223 dev_dbg(dev, "cXoff: %d\n", config->cXoff);
2224 dev_dbg(dev, "bUartMode: %d\n", config->bUartMode);
2226 /* move the word values into big endian mode */
2227 cpu_to_be16s(&config->wFlags);
2228 cpu_to_be16s(&config->wBaudRate);
2230 status = send_cmd(edge_port->port->serial->dev, UMPC_SET_CONFIG,
2231 (__u8)(UMPM_UART1_PORT + port_number),
2232 0, (__u8 *)config, sizeof(*config));
2233 if (status)
2234 dev_dbg(dev, "%s - error %d when trying to write config to device\n",
2235 __func__, status);
2236 kfree(config);
2239 static void edge_set_termios(struct tty_struct *tty,
2240 struct usb_serial_port *port, struct ktermios *old_termios)
2242 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2243 unsigned int cflag;
2245 cflag = tty->termios.c_cflag;
2247 dev_dbg(&port->dev, "%s - clfag %08x iflag %08x\n", __func__,
2248 tty->termios.c_cflag, tty->termios.c_iflag);
2249 dev_dbg(&port->dev, "%s - old clfag %08x old iflag %08x\n", __func__,
2250 old_termios->c_cflag, old_termios->c_iflag);
2252 if (edge_port == NULL)
2253 return;
2254 /* change the port settings to the new ones specified */
2255 change_port_settings(tty, edge_port, old_termios);
2258 static int edge_tiocmset(struct tty_struct *tty,
2259 unsigned int set, unsigned int clear)
2261 struct usb_serial_port *port = tty->driver_data;
2262 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2263 unsigned int mcr;
2264 unsigned long flags;
2266 spin_lock_irqsave(&edge_port->ep_lock, flags);
2267 mcr = edge_port->shadow_mcr;
2268 if (set & TIOCM_RTS)
2269 mcr |= MCR_RTS;
2270 if (set & TIOCM_DTR)
2271 mcr |= MCR_DTR;
2272 if (set & TIOCM_LOOP)
2273 mcr |= MCR_LOOPBACK;
2275 if (clear & TIOCM_RTS)
2276 mcr &= ~MCR_RTS;
2277 if (clear & TIOCM_DTR)
2278 mcr &= ~MCR_DTR;
2279 if (clear & TIOCM_LOOP)
2280 mcr &= ~MCR_LOOPBACK;
2282 edge_port->shadow_mcr = mcr;
2283 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2285 restore_mcr(edge_port, mcr);
2286 return 0;
2289 static int edge_tiocmget(struct tty_struct *tty)
2291 struct usb_serial_port *port = tty->driver_data;
2292 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2293 unsigned int result = 0;
2294 unsigned int msr;
2295 unsigned int mcr;
2296 unsigned long flags;
2298 spin_lock_irqsave(&edge_port->ep_lock, flags);
2300 msr = edge_port->shadow_msr;
2301 mcr = edge_port->shadow_mcr;
2302 result = ((mcr & MCR_DTR) ? TIOCM_DTR: 0) /* 0x002 */
2303 | ((mcr & MCR_RTS) ? TIOCM_RTS: 0) /* 0x004 */
2304 | ((msr & EDGEPORT_MSR_CTS) ? TIOCM_CTS: 0) /* 0x020 */
2305 | ((msr & EDGEPORT_MSR_CD) ? TIOCM_CAR: 0) /* 0x040 */
2306 | ((msr & EDGEPORT_MSR_RI) ? TIOCM_RI: 0) /* 0x080 */
2307 | ((msr & EDGEPORT_MSR_DSR) ? TIOCM_DSR: 0); /* 0x100 */
2310 dev_dbg(&port->dev, "%s -- %x\n", __func__, result);
2311 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2313 return result;
2316 static int get_serial_info(struct edgeport_port *edge_port,
2317 struct serial_struct __user *retinfo)
2319 struct serial_struct tmp;
2320 unsigned cwait;
2322 if (!retinfo)
2323 return -EFAULT;
2325 cwait = edge_port->port->port.closing_wait;
2326 if (cwait != ASYNC_CLOSING_WAIT_NONE)
2327 cwait = jiffies_to_msecs(cwait) / 10;
2329 memset(&tmp, 0, sizeof(tmp));
2331 tmp.type = PORT_16550A;
2332 tmp.line = edge_port->port->minor;
2333 tmp.port = edge_port->port->port_number;
2334 tmp.irq = 0;
2335 tmp.flags = ASYNC_SKIP_TEST | ASYNC_AUTO_IRQ;
2336 tmp.xmit_fifo_size = edge_port->port->bulk_out_size;
2337 tmp.baud_base = 9600;
2338 tmp.close_delay = 5*HZ;
2339 tmp.closing_wait = cwait;
2341 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
2342 return -EFAULT;
2343 return 0;
2346 static int edge_ioctl(struct tty_struct *tty,
2347 unsigned int cmd, unsigned long arg)
2349 struct usb_serial_port *port = tty->driver_data;
2350 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2352 switch (cmd) {
2353 case TIOCGSERIAL:
2354 dev_dbg(&port->dev, "%s - TIOCGSERIAL\n", __func__);
2355 return get_serial_info(edge_port,
2356 (struct serial_struct __user *) arg);
2358 return -ENOIOCTLCMD;
2361 static void edge_break(struct tty_struct *tty, int break_state)
2363 struct usb_serial_port *port = tty->driver_data;
2364 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2365 int status;
2366 int bv = 0; /* Off */
2368 if (break_state == -1)
2369 bv = 1; /* On */
2370 status = ti_do_config(edge_port, UMPC_SET_CLR_BREAK, bv);
2371 if (status)
2372 dev_dbg(&port->dev, "%s - error %d sending break set/clear command.\n",
2373 __func__, status);
2376 static int edge_startup(struct usb_serial *serial)
2378 struct edgeport_serial *edge_serial;
2379 int status;
2381 /* create our private serial structure */
2382 edge_serial = kzalloc(sizeof(struct edgeport_serial), GFP_KERNEL);
2383 if (!edge_serial)
2384 return -ENOMEM;
2386 mutex_init(&edge_serial->es_lock);
2387 edge_serial->serial = serial;
2388 usb_set_serial_data(serial, edge_serial);
2390 status = download_fw(edge_serial);
2391 if (status) {
2392 kfree(edge_serial);
2393 return status;
2396 return 0;
2399 static void edge_disconnect(struct usb_serial *serial)
2403 static void edge_release(struct usb_serial *serial)
2405 kfree(usb_get_serial_data(serial));
2408 static int edge_port_probe(struct usb_serial_port *port)
2410 struct edgeport_port *edge_port;
2411 int ret;
2413 edge_port = kzalloc(sizeof(*edge_port), GFP_KERNEL);
2414 if (!edge_port)
2415 return -ENOMEM;
2417 spin_lock_init(&edge_port->ep_lock);
2418 edge_port->port = port;
2419 edge_port->edge_serial = usb_get_serial_data(port->serial);
2420 edge_port->bUartMode = default_uart_mode;
2422 switch (port->port_number) {
2423 case 0:
2424 edge_port->uart_base = UMPMEM_BASE_UART1;
2425 edge_port->dma_address = UMPD_OEDB1_ADDRESS;
2426 break;
2427 case 1:
2428 edge_port->uart_base = UMPMEM_BASE_UART2;
2429 edge_port->dma_address = UMPD_OEDB2_ADDRESS;
2430 break;
2431 default:
2432 dev_err(&port->dev, "unknown port number\n");
2433 ret = -ENODEV;
2434 goto err;
2437 dev_dbg(&port->dev,
2438 "%s - port_number = %d, uart_base = %04x, dma_address = %04x\n",
2439 __func__, port->port_number, edge_port->uart_base,
2440 edge_port->dma_address);
2442 usb_set_serial_port_data(port, edge_port);
2444 ret = edge_create_sysfs_attrs(port);
2445 if (ret)
2446 goto err;
2448 port->port.closing_wait = msecs_to_jiffies(closing_wait * 10);
2449 port->port.drain_delay = 1;
2451 return 0;
2452 err:
2453 kfree(edge_port);
2455 return ret;
2458 static int edge_port_remove(struct usb_serial_port *port)
2460 struct edgeport_port *edge_port;
2462 edge_port = usb_get_serial_port_data(port);
2463 edge_remove_sysfs_attrs(port);
2464 kfree(edge_port);
2466 return 0;
2469 /* Sysfs Attributes */
2471 static ssize_t uart_mode_show(struct device *dev,
2472 struct device_attribute *attr, char *buf)
2474 struct usb_serial_port *port = to_usb_serial_port(dev);
2475 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2477 return sprintf(buf, "%d\n", edge_port->bUartMode);
2480 static ssize_t uart_mode_store(struct device *dev,
2481 struct device_attribute *attr, const char *valbuf, size_t count)
2483 struct usb_serial_port *port = to_usb_serial_port(dev);
2484 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2485 unsigned int v = simple_strtoul(valbuf, NULL, 0);
2487 dev_dbg(dev, "%s: setting uart_mode = %d\n", __func__, v);
2489 if (v < 256)
2490 edge_port->bUartMode = v;
2491 else
2492 dev_err(dev, "%s - uart_mode %d is invalid\n", __func__, v);
2494 return count;
2496 static DEVICE_ATTR_RW(uart_mode);
2498 static int edge_create_sysfs_attrs(struct usb_serial_port *port)
2500 return device_create_file(&port->dev, &dev_attr_uart_mode);
2503 static int edge_remove_sysfs_attrs(struct usb_serial_port *port)
2505 device_remove_file(&port->dev, &dev_attr_uart_mode);
2506 return 0;
2510 static struct usb_serial_driver edgeport_1port_device = {
2511 .driver = {
2512 .owner = THIS_MODULE,
2513 .name = "edgeport_ti_1",
2515 .description = "Edgeport TI 1 port adapter",
2516 .id_table = edgeport_1port_id_table,
2517 .num_ports = 1,
2518 .open = edge_open,
2519 .close = edge_close,
2520 .throttle = edge_throttle,
2521 .unthrottle = edge_unthrottle,
2522 .attach = edge_startup,
2523 .disconnect = edge_disconnect,
2524 .release = edge_release,
2525 .port_probe = edge_port_probe,
2526 .port_remove = edge_port_remove,
2527 .ioctl = edge_ioctl,
2528 .set_termios = edge_set_termios,
2529 .tiocmget = edge_tiocmget,
2530 .tiocmset = edge_tiocmset,
2531 .tiocmiwait = usb_serial_generic_tiocmiwait,
2532 .get_icount = usb_serial_generic_get_icount,
2533 .write = edge_write,
2534 .write_room = edge_write_room,
2535 .chars_in_buffer = edge_chars_in_buffer,
2536 .tx_empty = edge_tx_empty,
2537 .break_ctl = edge_break,
2538 .read_int_callback = edge_interrupt_callback,
2539 .read_bulk_callback = edge_bulk_in_callback,
2540 .write_bulk_callback = edge_bulk_out_callback,
2543 static struct usb_serial_driver edgeport_2port_device = {
2544 .driver = {
2545 .owner = THIS_MODULE,
2546 .name = "edgeport_ti_2",
2548 .description = "Edgeport TI 2 port adapter",
2549 .id_table = edgeport_2port_id_table,
2550 .num_ports = 2,
2551 .open = edge_open,
2552 .close = edge_close,
2553 .throttle = edge_throttle,
2554 .unthrottle = edge_unthrottle,
2555 .attach = edge_startup,
2556 .disconnect = edge_disconnect,
2557 .release = edge_release,
2558 .port_probe = edge_port_probe,
2559 .port_remove = edge_port_remove,
2560 .ioctl = edge_ioctl,
2561 .set_termios = edge_set_termios,
2562 .tiocmget = edge_tiocmget,
2563 .tiocmset = edge_tiocmset,
2564 .tiocmiwait = usb_serial_generic_tiocmiwait,
2565 .get_icount = usb_serial_generic_get_icount,
2566 .write = edge_write,
2567 .write_room = edge_write_room,
2568 .chars_in_buffer = edge_chars_in_buffer,
2569 .tx_empty = edge_tx_empty,
2570 .break_ctl = edge_break,
2571 .read_int_callback = edge_interrupt_callback,
2572 .read_bulk_callback = edge_bulk_in_callback,
2573 .write_bulk_callback = edge_bulk_out_callback,
2576 static struct usb_serial_driver * const serial_drivers[] = {
2577 &edgeport_1port_device, &edgeport_2port_device, NULL
2580 module_usb_serial_driver(serial_drivers, id_table_combined);
2582 MODULE_AUTHOR(DRIVER_AUTHOR);
2583 MODULE_DESCRIPTION(DRIVER_DESC);
2584 MODULE_LICENSE("GPL");
2585 MODULE_FIRMWARE("edgeport/down3.bin");
2587 module_param(closing_wait, int, S_IRUGO | S_IWUSR);
2588 MODULE_PARM_DESC(closing_wait, "Maximum wait for data to drain, in .01 secs");
2590 module_param(ignore_cpu_rev, bool, S_IRUGO | S_IWUSR);
2591 MODULE_PARM_DESC(ignore_cpu_rev,
2592 "Ignore the cpu revision when connecting to a device");
2594 module_param(default_uart_mode, int, S_IRUGO | S_IWUSR);
2595 MODULE_PARM_DESC(default_uart_mode, "Default uart_mode, 0=RS232, ...");