1 // SPDX-License-Identifier: GPL-2.0+
3 * Edgeport USB Serial Converter driver
5 * Copyright (C) 2000-2002 Inside Out Networks, All rights reserved.
6 * Copyright (C) 2001-2002 Greg Kroah-Hartman <greg@kroah.com>
8 * Supports the following devices:
9 * EP/1 EP/2 EP/4 EP/21 EP/22 EP/221 EP/42 EP/421 WATCHPORT
11 * For questions or problems with this driver, contact Inside Out
12 * Networks technical support, or Peter Berger <pberger@brimson.com>,
13 * or Al Borchers <alborchers@steinerpoint.com>.
16 #include <linux/kernel.h>
17 #include <linux/jiffies.h>
18 #include <linux/errno.h>
19 #include <linux/slab.h>
20 #include <linux/tty.h>
21 #include <linux/tty_driver.h>
22 #include <linux/tty_flip.h>
23 #include <linux/module.h>
24 #include <linux/spinlock.h>
25 #include <linux/mutex.h>
26 #include <linux/serial.h>
27 #include <linux/swab.h>
28 #include <linux/kfifo.h>
29 #include <linux/ioctl.h>
30 #include <linux/firmware.h>
31 #include <linux/uaccess.h>
32 #include <linux/usb.h>
33 #include <linux/usb/serial.h>
36 #include "io_usbvend.h"
39 #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com> and David Iacovelli"
40 #define DRIVER_DESC "Edgeport USB Serial Driver"
42 #define EPROM_PAGE_SIZE 64
45 /* different hardware types */
46 #define HARDWARE_TYPE_930 0
47 #define HARDWARE_TYPE_TIUMP 1
49 /* IOCTL_PRIVATE_TI_GET_MODE Definitions */
50 #define TI_MODE_CONFIGURING 0 /* Device has not entered start device */
51 #define TI_MODE_BOOT 1 /* Staying in boot mode */
52 #define TI_MODE_DOWNLOAD 2 /* Made it to download mode */
53 #define TI_MODE_TRANSITIONING 3 /*
54 * Currently in boot mode but
55 * transitioning to download mode
59 #define EDGE_READ_URB_RUNNING 0
60 #define EDGE_READ_URB_STOPPING 1
61 #define EDGE_READ_URB_STOPPED 2
63 #define EDGE_CLOSING_WAIT 4000 /* in .01 sec */
66 /* Product information read from the Edgeport */
68 int TiMode
; /* Current TI Mode */
69 __u8 hardware_type
; /* Type of hardware */
70 } __attribute__((packed
));
73 * Edgeport firmware header
75 * "build_number" has been set to 0 in all three of the images I have
76 * seen, and Digi Tech Support suggests that it is safe to ignore it.
78 * "length" is the number of bytes of actual data following the header.
80 * "checksum" is the low order byte resulting from adding the values of
83 struct edgeport_fw_hdr
{
91 struct edgeport_port
{
98 __u32 ump_read_timeout
; /*
99 * Number of milliseconds the UMP will
100 * wait without data before completing
107 struct edgeport_serial
*edge_serial
;
108 struct usb_serial_port
*port
;
109 __u8 bUartMode
; /* Port type, 0: RS232, etc. */
111 int ep_read_urb_state
;
112 int ep_write_urb_in_use
;
115 struct edgeport_serial
{
116 struct product_info product_info
;
117 u8 TI_I2C_Type
; /* Type of I2C in UMP */
119 * Set to TRUE if we have read the
122 struct mutex es_lock
;
124 struct usb_serial
*serial
;
125 struct delayed_work heartbeat_work
;
131 /* Devices that this driver supports */
132 static const struct usb_device_id edgeport_1port_id_table
[] = {
133 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_TI_EDGEPORT_1
) },
134 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_TI_TI3410_EDGEPORT_1
) },
135 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_TI_TI3410_EDGEPORT_1I
) },
136 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_WP_PROXIMITY
) },
137 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_WP_MOTION
) },
138 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_WP_MOISTURE
) },
139 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_WP_TEMPERATURE
) },
140 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_WP_HUMIDITY
) },
141 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_WP_POWER
) },
142 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_WP_LIGHT
) },
143 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_WP_RADIATION
) },
144 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_WP_DISTANCE
) },
145 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_WP_ACCELERATION
) },
146 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_WP_PROX_DIST
) },
147 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_PLUS_PWR_HP4CD
) },
148 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_PLUS_PWR_PCI
) },
152 static const struct usb_device_id edgeport_2port_id_table
[] = {
153 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_TI_EDGEPORT_2
) },
154 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_TI_EDGEPORT_2C
) },
155 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_TI_EDGEPORT_2I
) },
156 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_TI_EDGEPORT_421
) },
157 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_TI_EDGEPORT_21
) },
158 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_TI_EDGEPORT_42
) },
159 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_TI_EDGEPORT_4
) },
160 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_TI_EDGEPORT_4I
) },
161 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_TI_EDGEPORT_22I
) },
162 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_TI_EDGEPORT_221C
) },
163 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_TI_EDGEPORT_22C
) },
164 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_TI_EDGEPORT_21C
) },
165 /* The 4, 8 and 16 port devices show up as multiple 2 port devices */
166 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_TI_EDGEPORT_4S
) },
167 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_TI_EDGEPORT_8
) },
168 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_TI_EDGEPORT_8S
) },
169 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_TI_EDGEPORT_416
) },
170 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_TI_EDGEPORT_416B
) },
174 /* Devices that this driver supports */
175 static const struct usb_device_id id_table_combined
[] = {
176 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_TI_EDGEPORT_1
) },
177 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_TI_TI3410_EDGEPORT_1
) },
178 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_TI_TI3410_EDGEPORT_1I
) },
179 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_WP_PROXIMITY
) },
180 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_WP_MOTION
) },
181 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_WP_MOISTURE
) },
182 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_WP_TEMPERATURE
) },
183 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_WP_HUMIDITY
) },
184 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_WP_POWER
) },
185 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_WP_LIGHT
) },
186 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_WP_RADIATION
) },
187 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_WP_DISTANCE
) },
188 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_WP_ACCELERATION
) },
189 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_WP_PROX_DIST
) },
190 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_PLUS_PWR_HP4CD
) },
191 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_PLUS_PWR_PCI
) },
192 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_TI_EDGEPORT_2
) },
193 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_TI_EDGEPORT_2C
) },
194 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_TI_EDGEPORT_2I
) },
195 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_TI_EDGEPORT_421
) },
196 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_TI_EDGEPORT_21
) },
197 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_TI_EDGEPORT_42
) },
198 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_TI_EDGEPORT_4
) },
199 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_TI_EDGEPORT_4I
) },
200 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_TI_EDGEPORT_22I
) },
201 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_TI_EDGEPORT_221C
) },
202 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_TI_EDGEPORT_22C
) },
203 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_TI_EDGEPORT_21C
) },
204 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_TI_EDGEPORT_4S
) },
205 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_TI_EDGEPORT_8
) },
206 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_TI_EDGEPORT_8S
) },
207 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_TI_EDGEPORT_416
) },
208 { USB_DEVICE(USB_VENDOR_ID_ION
, ION_DEVICE_ID_TI_EDGEPORT_416B
) },
212 MODULE_DEVICE_TABLE(usb
, id_table_combined
);
214 static int closing_wait
= EDGE_CLOSING_WAIT
;
215 static bool ignore_cpu_rev
;
216 static int default_uart_mode
; /* RS232 */
218 static void edge_tty_recv(struct usb_serial_port
*port
, unsigned char *data
,
221 static void stop_read(struct edgeport_port
*edge_port
);
222 static int restart_read(struct edgeport_port
*edge_port
);
224 static void edge_set_termios(struct tty_struct
*tty
,
225 struct usb_serial_port
*port
, struct ktermios
*old_termios
);
226 static void edge_send(struct usb_serial_port
*port
, struct tty_struct
*tty
);
228 static int do_download_mode(struct edgeport_serial
*serial
,
229 const struct firmware
*fw
);
230 static int do_boot_mode(struct edgeport_serial
*serial
,
231 const struct firmware
*fw
);
233 /* sysfs attributes */
234 static int edge_create_sysfs_attrs(struct usb_serial_port
*port
);
235 static int edge_remove_sysfs_attrs(struct usb_serial_port
*port
);
238 * Some release of Edgeport firmware "down3.bin" after version 4.80
239 * introduced code to automatically disconnect idle devices on some
240 * Edgeport models after periods of inactivity, typically ~60 seconds.
241 * This occurs without regard to whether ports on the device are open
242 * or not. Digi International Tech Support suggested:
244 * 1. Adding driver "heartbeat" code to reset the firmware timer by
245 * requesting a descriptor record every 15 seconds, which should be
246 * effective with newer firmware versions that require it, and benign
247 * with older versions that do not. In practice 40 seconds seems often
249 * 2. The heartbeat code is currently required only on Edgeport/416 models.
251 #define FW_HEARTBEAT_VERSION_CUTOFF ((4 << 8) + 80)
252 #define FW_HEARTBEAT_SECS 40
254 /* Timeouts in msecs: firmware downloads take longer */
255 #define TI_VSEND_TIMEOUT_DEFAULT 1000
256 #define TI_VSEND_TIMEOUT_FW_DOWNLOAD 10000
258 static int ti_vread_sync(struct usb_device
*dev
, __u8 request
,
259 __u16 value
, __u16 index
, u8
*data
, int size
)
263 status
= usb_control_msg(dev
, usb_rcvctrlpipe(dev
, 0), request
,
264 (USB_TYPE_VENDOR
| USB_RECIP_DEVICE
| USB_DIR_IN
),
265 value
, index
, data
, size
, 1000);
268 if (status
!= size
) {
269 dev_dbg(&dev
->dev
, "%s - wanted to write %d, but only wrote %d\n",
270 __func__
, size
, status
);
276 static int ti_vsend_sync(struct usb_device
*dev
, u8 request
, u16 value
,
277 u16 index
, u8
*data
, int size
, int timeout
)
281 status
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0), request
,
282 (USB_TYPE_VENDOR
| USB_RECIP_DEVICE
| USB_DIR_OUT
),
283 value
, index
, data
, size
, timeout
);
286 if (status
!= size
) {
287 dev_dbg(&dev
->dev
, "%s - wanted to write %d, but only wrote %d\n",
288 __func__
, size
, status
);
294 static int send_cmd(struct usb_device
*dev
, __u8 command
,
295 __u8 moduleid
, __u16 value
, u8
*data
,
298 return ti_vsend_sync(dev
, command
, value
, moduleid
, data
, size
,
299 TI_VSEND_TIMEOUT_DEFAULT
);
302 /* clear tx/rx buffers and fifo in TI UMP */
303 static int purge_port(struct usb_serial_port
*port
, __u16 mask
)
305 int port_number
= port
->port_number
;
307 dev_dbg(&port
->dev
, "%s - port %d, mask %x\n", __func__
, port_number
, mask
);
309 return send_cmd(port
->serial
->dev
,
311 (__u8
)(UMPM_UART1_PORT
+ port_number
),
318 * read_download_mem - Read edgeport memory from TI chip
319 * @dev: usb device pointer
320 * @start_address: Device CPU address at which to read
321 * @length: Length of above data
322 * @address_type: Can read both XDATA and I2C
323 * @buffer: pointer to input data buffer
325 static int read_download_mem(struct usb_device
*dev
, int start_address
,
326 int length
, __u8 address_type
, __u8
*buffer
)
330 u16 be_start_address
;
332 dev_dbg(&dev
->dev
, "%s - @ %x for %d\n", __func__
, start_address
, length
);
335 * Read in blocks of 64 bytes
336 * (TI firmware can't handle more than 64 byte reads)
342 read_length
= (__u8
)length
;
344 if (read_length
> 1) {
345 dev_dbg(&dev
->dev
, "%s - @ %x for %d\n", __func__
, start_address
, read_length
);
348 * NOTE: Must use swab as wIndex is sent in little-endian
349 * byte order regardless of host byte order.
351 be_start_address
= swab16((u16
)start_address
);
352 status
= ti_vread_sync(dev
, UMPC_MEMORY_READ
,
355 buffer
, read_length
);
358 dev_dbg(&dev
->dev
, "%s - ERROR %x\n", __func__
, status
);
363 usb_serial_debug_data(&dev
->dev
, __func__
, read_length
, buffer
);
365 /* Update pointers/length */
366 start_address
+= read_length
;
367 buffer
+= read_length
;
368 length
-= read_length
;
374 static int read_ram(struct usb_device
*dev
, int start_address
,
375 int length
, __u8
*buffer
)
377 return read_download_mem(dev
, start_address
, length
,
378 DTK_ADDR_SPACE_XDATA
, buffer
);
381 /* Read edgeport memory to a given block */
382 static int read_boot_mem(struct edgeport_serial
*serial
,
383 int start_address
, int length
, __u8
*buffer
)
388 for (i
= 0; i
< length
; i
++) {
389 status
= ti_vread_sync(serial
->serial
->dev
,
390 UMPC_MEMORY_READ
, serial
->TI_I2C_Type
,
391 (__u16
)(start_address
+i
), &buffer
[i
], 0x01);
393 dev_dbg(&serial
->serial
->dev
->dev
, "%s - ERROR %x\n", __func__
, status
);
398 dev_dbg(&serial
->serial
->dev
->dev
, "%s - start_address = %x, length = %d\n",
399 __func__
, start_address
, length
);
400 usb_serial_debug_data(&serial
->serial
->dev
->dev
, __func__
, length
, buffer
);
402 serial
->TiReadI2C
= 1;
407 /* Write given block to TI EPROM memory */
408 static int write_boot_mem(struct edgeport_serial
*serial
,
409 int start_address
, int length
, __u8
*buffer
)
415 /* Must do a read before write */
416 if (!serial
->TiReadI2C
) {
417 temp
= kmalloc(1, GFP_KERNEL
);
421 status
= read_boot_mem(serial
, 0, 1, temp
);
427 for (i
= 0; i
< length
; ++i
) {
428 status
= ti_vsend_sync(serial
->serial
->dev
, UMPC_MEMORY_WRITE
,
429 buffer
[i
], (u16
)(i
+ start_address
), NULL
,
430 0, TI_VSEND_TIMEOUT_DEFAULT
);
435 dev_dbg(&serial
->serial
->dev
->dev
, "%s - start_sddr = %x, length = %d\n", __func__
, start_address
, length
);
436 usb_serial_debug_data(&serial
->serial
->dev
->dev
, __func__
, length
, buffer
);
441 /* Write edgeport I2C memory to TI chip */
442 static int write_i2c_mem(struct edgeport_serial
*serial
,
443 int start_address
, int length
, __u8 address_type
, __u8
*buffer
)
445 struct device
*dev
= &serial
->serial
->dev
->dev
;
448 u16 be_start_address
;
450 /* We can only send a maximum of 1 aligned byte page at a time */
452 /* calculate the number of bytes left in the first page */
453 write_length
= EPROM_PAGE_SIZE
-
454 (start_address
& (EPROM_PAGE_SIZE
- 1));
456 if (write_length
> length
)
457 write_length
= length
;
459 dev_dbg(dev
, "%s - BytesInFirstPage Addr = %x, length = %d\n",
460 __func__
, start_address
, write_length
);
461 usb_serial_debug_data(dev
, __func__
, write_length
, buffer
);
466 * NOTE: Must use swab as wIndex is sent in little-endian byte order
467 * regardless of host byte order.
469 be_start_address
= swab16((u16
)start_address
);
470 status
= ti_vsend_sync(serial
->serial
->dev
, UMPC_MEMORY_WRITE
,
471 (u16
)address_type
, be_start_address
,
472 buffer
, write_length
, TI_VSEND_TIMEOUT_DEFAULT
);
474 dev_dbg(dev
, "%s - ERROR %d\n", __func__
, status
);
478 length
-= write_length
;
479 start_address
+= write_length
;
480 buffer
+= write_length
;
483 * We should be aligned now -- can write max page size bytes at a
487 if (length
> EPROM_PAGE_SIZE
)
488 write_length
= EPROM_PAGE_SIZE
;
490 write_length
= length
;
492 dev_dbg(dev
, "%s - Page Write Addr = %x, length = %d\n",
493 __func__
, start_address
, write_length
);
494 usb_serial_debug_data(dev
, __func__
, write_length
, buffer
);
499 * NOTE: Must use swab as wIndex is sent in little-endian byte
500 * order regardless of host byte order.
502 be_start_address
= swab16((u16
)start_address
);
503 status
= ti_vsend_sync(serial
->serial
->dev
, UMPC_MEMORY_WRITE
,
504 (u16
)address_type
, be_start_address
, buffer
,
505 write_length
, TI_VSEND_TIMEOUT_DEFAULT
);
507 dev_err(dev
, "%s - ERROR %d\n", __func__
, status
);
511 length
-= write_length
;
512 start_address
+= write_length
;
513 buffer
+= write_length
;
519 * Examine the UMP DMA registers and LSR
521 * Check the MSBit of the X and Y DMA byte count registers.
522 * A zero in this bit indicates that the TX DMA buffers are empty
523 * then check the TX Empty bit in the UART.
525 static int tx_active(struct edgeport_port
*port
)
528 struct out_endpoint_desc_block
*oedb
;
532 oedb
= kmalloc(sizeof(*oedb
), GFP_KERNEL
);
537 * Sigh, that's right, just one byte, as not all platforms can
540 lsr
= kmalloc(1, GFP_KERNEL
);
545 /* Read the DMA Count Registers */
546 status
= read_ram(port
->port
->serial
->dev
, port
->dma_address
,
547 sizeof(*oedb
), (void *)oedb
);
549 goto exit_is_tx_active
;
551 dev_dbg(&port
->port
->dev
, "%s - XByteCount 0x%X\n", __func__
, oedb
->XByteCount
);
554 status
= read_ram(port
->port
->serial
->dev
,
555 port
->uart_base
+ UMPMEM_OFFS_UART_LSR
, 1, lsr
);
558 goto exit_is_tx_active
;
559 dev_dbg(&port
->port
->dev
, "%s - LSR = 0x%X\n", __func__
, *lsr
);
561 /* If either buffer has data or we are transmitting then return TRUE */
562 if ((oedb
->XByteCount
& 0x80) != 0)
565 if ((*lsr
& UMP_UART_LSR_TX_MASK
) == 0)
568 /* We return Not Active if we get any kind of error */
570 dev_dbg(&port
->port
->dev
, "%s - return %d\n", __func__
, bytes_left
);
577 static int choose_config(struct usb_device
*dev
)
580 * There may be multiple configurations on this device, in which case
581 * we would need to read and parse all of them to find out which one
582 * we want. However, we just support one config at this point,
583 * configuration # 1, which is Config Descriptor 0.
586 dev_dbg(&dev
->dev
, "%s - Number of Interfaces = %d\n",
587 __func__
, dev
->config
->desc
.bNumInterfaces
);
588 dev_dbg(&dev
->dev
, "%s - MAX Power = %d\n",
589 __func__
, dev
->config
->desc
.bMaxPower
* 2);
591 if (dev
->config
->desc
.bNumInterfaces
!= 1) {
592 dev_err(&dev
->dev
, "%s - bNumInterfaces is not 1, ERROR!\n", __func__
);
599 static int read_rom(struct edgeport_serial
*serial
,
600 int start_address
, int length
, __u8
*buffer
)
604 if (serial
->product_info
.TiMode
== TI_MODE_DOWNLOAD
) {
605 status
= read_download_mem(serial
->serial
->dev
,
611 status
= read_boot_mem(serial
, start_address
, length
,
617 static int write_rom(struct edgeport_serial
*serial
, int start_address
,
618 int length
, __u8
*buffer
)
620 if (serial
->product_info
.TiMode
== TI_MODE_BOOT
)
621 return write_boot_mem(serial
, start_address
, length
,
624 if (serial
->product_info
.TiMode
== TI_MODE_DOWNLOAD
)
625 return write_i2c_mem(serial
, start_address
, length
,
626 serial
->TI_I2C_Type
, buffer
);
630 /* Read a descriptor header from I2C based on type */
631 static int get_descriptor_addr(struct edgeport_serial
*serial
,
632 int desc_type
, struct ti_i2c_desc
*rom_desc
)
637 /* Search for requested descriptor in I2C */
640 status
= read_rom(serial
,
642 sizeof(struct ti_i2c_desc
),
647 if (rom_desc
->Type
== desc_type
)
648 return start_address
;
650 start_address
= start_address
+ sizeof(struct ti_i2c_desc
) +
651 le16_to_cpu(rom_desc
->Size
);
653 } while ((start_address
< TI_MAX_I2C_SIZE
) && rom_desc
->Type
);
658 /* Validate descriptor checksum */
659 static int valid_csum(struct ti_i2c_desc
*rom_desc
, __u8
*buffer
)
664 for (i
= 0; i
< le16_to_cpu(rom_desc
->Size
); i
++)
665 cs
= (__u8
)(cs
+ buffer
[i
]);
667 if (cs
!= rom_desc
->CheckSum
) {
668 pr_debug("%s - Mismatch %x - %x", __func__
, rom_desc
->CheckSum
, cs
);
674 /* Make sure that the I2C image is good */
675 static int check_i2c_image(struct edgeport_serial
*serial
)
677 struct device
*dev
= &serial
->serial
->dev
->dev
;
679 struct ti_i2c_desc
*rom_desc
;
680 int start_address
= 2;
684 rom_desc
= kmalloc(sizeof(*rom_desc
), GFP_KERNEL
);
688 buffer
= kmalloc(TI_MAX_I2C_SIZE
, GFP_KERNEL
);
694 /* Read the first byte (Signature0) must be 0x52 or 0x10 */
695 status
= read_rom(serial
, 0, 1, buffer
);
699 if (*buffer
!= UMP5152
&& *buffer
!= UMP3410
) {
700 dev_err(dev
, "%s - invalid buffer signature\n", __func__
);
706 /* Validate the I2C */
707 status
= read_rom(serial
,
709 sizeof(struct ti_i2c_desc
),
714 if ((start_address
+ sizeof(struct ti_i2c_desc
) +
715 le16_to_cpu(rom_desc
->Size
)) > TI_MAX_I2C_SIZE
) {
717 dev_dbg(dev
, "%s - structure too big, erroring out.\n", __func__
);
721 dev_dbg(dev
, "%s Type = 0x%x\n", __func__
, rom_desc
->Type
);
723 /* Skip type 2 record */
724 ttype
= rom_desc
->Type
& 0x0f;
725 if (ttype
!= I2C_DESC_TYPE_FIRMWARE_BASIC
726 && ttype
!= I2C_DESC_TYPE_FIRMWARE_AUTO
) {
727 /* Read the descriptor data */
728 status
= read_rom(serial
, start_address
+
729 sizeof(struct ti_i2c_desc
),
730 le16_to_cpu(rom_desc
->Size
),
735 status
= valid_csum(rom_desc
, buffer
);
739 start_address
= start_address
+ sizeof(struct ti_i2c_desc
) +
740 le16_to_cpu(rom_desc
->Size
);
742 } while ((rom_desc
->Type
!= I2C_DESC_TYPE_ION
) &&
743 (start_address
< TI_MAX_I2C_SIZE
));
745 if ((rom_desc
->Type
!= I2C_DESC_TYPE_ION
) ||
746 (start_address
> TI_MAX_I2C_SIZE
))
755 static int get_manuf_info(struct edgeport_serial
*serial
, __u8
*buffer
)
759 struct ti_i2c_desc
*rom_desc
;
760 struct edge_ti_manuf_descriptor
*desc
;
761 struct device
*dev
= &serial
->serial
->dev
->dev
;
763 rom_desc
= kmalloc(sizeof(*rom_desc
), GFP_KERNEL
);
767 start_address
= get_descriptor_addr(serial
, I2C_DESC_TYPE_ION
,
770 if (!start_address
) {
771 dev_dbg(dev
, "%s - Edge Descriptor not found in I2C\n", __func__
);
776 /* Read the descriptor data */
777 status
= read_rom(serial
, start_address
+sizeof(struct ti_i2c_desc
),
778 le16_to_cpu(rom_desc
->Size
), buffer
);
782 status
= valid_csum(rom_desc
, buffer
);
784 desc
= (struct edge_ti_manuf_descriptor
*)buffer
;
785 dev_dbg(dev
, "%s - IonConfig 0x%x\n", __func__
, desc
->IonConfig
);
786 dev_dbg(dev
, "%s - Version %d\n", __func__
, desc
->Version
);
787 dev_dbg(dev
, "%s - Cpu/Board 0x%x\n", __func__
, desc
->CpuRev_BoardRev
);
788 dev_dbg(dev
, "%s - NumPorts %d\n", __func__
, desc
->NumPorts
);
789 dev_dbg(dev
, "%s - NumVirtualPorts %d\n", __func__
, desc
->NumVirtualPorts
);
790 dev_dbg(dev
, "%s - TotalPorts %d\n", __func__
, desc
->TotalPorts
);
797 /* Build firmware header used for firmware update */
798 static int build_i2c_fw_hdr(u8
*header
, const struct firmware
*fw
)
804 struct ti_i2c_desc
*i2c_header
;
805 struct ti_i2c_image_header
*img_header
;
806 struct ti_i2c_firmware_rec
*firmware_rec
;
807 struct edgeport_fw_hdr
*fw_hdr
= (struct edgeport_fw_hdr
*)fw
->data
;
810 * In order to update the I2C firmware we must change the type 2 record
811 * to type 0xF2. This will force the UMP to come up in Boot Mode.
812 * Then while in boot mode, the driver will download the latest
813 * firmware (padded to 15.5k) into the UMP ram. And finally when the
814 * device comes back up in download mode the driver will cause the new
815 * firmware to be copied from the UMP Ram to I2C and the firmware will
816 * update the record type from 0xf2 to 0x02.
820 * Allocate a 15.5k buffer + 2 bytes for version number (Firmware
823 buffer_size
= (((1024 * 16) - 512 ) +
824 sizeof(struct ti_i2c_firmware_rec
));
826 buffer
= kmalloc(buffer_size
, GFP_KERNEL
);
830 /* Set entire image of 0xffs */
831 memset(buffer
, 0xff, buffer_size
);
833 /* Copy version number into firmware record */
834 firmware_rec
= (struct ti_i2c_firmware_rec
*)buffer
;
836 firmware_rec
->Ver_Major
= fw_hdr
->major_version
;
837 firmware_rec
->Ver_Minor
= fw_hdr
->minor_version
;
839 /* Pointer to fw_down memory image */
840 img_header
= (struct ti_i2c_image_header
*)&fw
->data
[4];
842 memcpy(buffer
+ sizeof(struct ti_i2c_firmware_rec
),
843 &fw
->data
[4 + sizeof(struct ti_i2c_image_header
)],
844 le16_to_cpu(img_header
->Length
));
846 for (i
=0; i
< buffer_size
; i
++) {
847 cs
= (__u8
)(cs
+ buffer
[i
]);
852 /* Build new header */
853 i2c_header
= (struct ti_i2c_desc
*)header
;
854 firmware_rec
= (struct ti_i2c_firmware_rec
*)i2c_header
->Data
;
856 i2c_header
->Type
= I2C_DESC_TYPE_FIRMWARE_BLANK
;
857 i2c_header
->Size
= cpu_to_le16(buffer_size
);
858 i2c_header
->CheckSum
= cs
;
859 firmware_rec
->Ver_Major
= fw_hdr
->major_version
;
860 firmware_rec
->Ver_Minor
= fw_hdr
->minor_version
;
865 /* Try to figure out what type of I2c we have */
866 static int i2c_type_bootmode(struct edgeport_serial
*serial
)
868 struct device
*dev
= &serial
->serial
->dev
->dev
;
872 data
= kmalloc(1, GFP_KERNEL
);
876 /* Try to read type 2 */
877 status
= ti_vread_sync(serial
->serial
->dev
, UMPC_MEMORY_READ
,
878 DTK_ADDR_SPACE_I2C_TYPE_II
, 0, data
, 0x01);
880 dev_dbg(dev
, "%s - read 2 status error = %d\n", __func__
, status
);
882 dev_dbg(dev
, "%s - read 2 data = 0x%x\n", __func__
, *data
);
883 if ((!status
) && (*data
== UMP5152
|| *data
== UMP3410
)) {
884 dev_dbg(dev
, "%s - ROM_TYPE_II\n", __func__
);
885 serial
->TI_I2C_Type
= DTK_ADDR_SPACE_I2C_TYPE_II
;
889 /* Try to read type 3 */
890 status
= ti_vread_sync(serial
->serial
->dev
, UMPC_MEMORY_READ
,
891 DTK_ADDR_SPACE_I2C_TYPE_III
, 0, data
, 0x01);
893 dev_dbg(dev
, "%s - read 3 status error = %d\n", __func__
, status
);
895 dev_dbg(dev
, "%s - read 2 data = 0x%x\n", __func__
, *data
);
896 if ((!status
) && (*data
== UMP5152
|| *data
== UMP3410
)) {
897 dev_dbg(dev
, "%s - ROM_TYPE_III\n", __func__
);
898 serial
->TI_I2C_Type
= DTK_ADDR_SPACE_I2C_TYPE_III
;
902 dev_dbg(dev
, "%s - Unknown\n", __func__
);
903 serial
->TI_I2C_Type
= DTK_ADDR_SPACE_I2C_TYPE_II
;
910 static int bulk_xfer(struct usb_serial
*serial
, void *buffer
,
911 int length
, int *num_sent
)
915 status
= usb_bulk_msg(serial
->dev
,
916 usb_sndbulkpipe(serial
->dev
,
917 serial
->port
[0]->bulk_out_endpointAddress
),
918 buffer
, length
, num_sent
, 1000);
922 /* Download given firmware image to the device (IN BOOT MODE) */
923 static int download_code(struct edgeport_serial
*serial
, __u8
*image
,
931 /* Transfer firmware image */
932 for (pos
= 0; pos
< image_length
; ) {
933 /* Read the next buffer from file */
934 transfer
= image_length
- pos
;
935 if (transfer
> EDGE_FW_BULK_MAX_PACKET_SIZE
)
936 transfer
= EDGE_FW_BULK_MAX_PACKET_SIZE
;
939 status
= bulk_xfer(serial
->serial
, &image
[pos
],
943 /* Advance buffer pointer */
951 static int config_boot_dev(struct usb_device
*dev
)
956 static int ti_cpu_rev(struct edge_ti_manuf_descriptor
*desc
)
958 return TI_GET_CPU_REVISION(desc
->CpuRev_BoardRev
);
961 static int check_fw_sanity(struct edgeport_serial
*serial
,
962 const struct firmware
*fw
)
967 struct device
*dev
= &serial
->serial
->interface
->dev
;
968 struct edgeport_fw_hdr
*fw_hdr
= (struct edgeport_fw_hdr
*)fw
->data
;
970 if (fw
->size
< sizeof(struct edgeport_fw_hdr
)) {
971 dev_err(dev
, "incomplete fw header\n");
975 length_total
= le16_to_cpu(fw_hdr
->length
) +
976 sizeof(struct edgeport_fw_hdr
);
978 if (fw
->size
!= length_total
) {
979 dev_err(dev
, "bad fw size (expected: %u, got: %zu)\n",
980 length_total
, fw
->size
);
984 for (pos
= sizeof(struct edgeport_fw_hdr
); pos
< fw
->size
; ++pos
)
985 checksum
+= fw
->data
[pos
];
987 if (checksum
!= fw_hdr
->checksum
) {
988 dev_err(dev
, "bad fw checksum (expected: 0x%x, got: 0x%x)\n",
989 fw_hdr
->checksum
, checksum
);
997 * DownloadTIFirmware - Download run-time operating firmware to the TI5052
999 * This routine downloads the main operating code into the TI5052, using the
1000 * boot code already burned into E2PROM or ROM.
1002 static int download_fw(struct edgeport_serial
*serial
)
1004 struct device
*dev
= &serial
->serial
->interface
->dev
;
1006 struct usb_interface_descriptor
*interface
;
1007 const struct firmware
*fw
;
1008 const char *fw_name
= "edgeport/down3.bin";
1009 struct edgeport_fw_hdr
*fw_hdr
;
1011 status
= request_firmware(&fw
, fw_name
, dev
);
1013 dev_err(dev
, "Failed to load image \"%s\" err %d\n",
1018 if (check_fw_sanity(serial
, fw
)) {
1023 fw_hdr
= (struct edgeport_fw_hdr
*)fw
->data
;
1025 /* If on-board version is newer, "fw_version" will be updated later. */
1026 serial
->fw_version
= (fw_hdr
->major_version
<< 8) +
1027 fw_hdr
->minor_version
;
1030 * This routine is entered by both the BOOT mode and the Download mode
1031 * We can determine which code is running by the reading the config
1032 * descriptor and if we have only one bulk pipe it is in boot mode
1034 serial
->product_info
.hardware_type
= HARDWARE_TYPE_TIUMP
;
1036 /* Default to type 2 i2c */
1037 serial
->TI_I2C_Type
= DTK_ADDR_SPACE_I2C_TYPE_II
;
1039 status
= choose_config(serial
->serial
->dev
);
1043 interface
= &serial
->serial
->interface
->cur_altsetting
->desc
;
1045 dev_err(dev
, "%s - no interface set, error!\n", __func__
);
1051 * Setup initial mode -- the default mode 0 is TI_MODE_CONFIGURING
1052 * if we have more than one endpoint we are definitely in download
1055 if (interface
->bNumEndpoints
> 1) {
1056 serial
->product_info
.TiMode
= TI_MODE_DOWNLOAD
;
1057 status
= do_download_mode(serial
, fw
);
1059 /* Otherwise we will remain in configuring mode */
1060 serial
->product_info
.TiMode
= TI_MODE_CONFIGURING
;
1061 status
= do_boot_mode(serial
, fw
);
1065 release_firmware(fw
);
1069 static int do_download_mode(struct edgeport_serial
*serial
,
1070 const struct firmware
*fw
)
1072 struct device
*dev
= &serial
->serial
->interface
->dev
;
1075 struct edge_ti_manuf_descriptor
*ti_manuf_desc
;
1076 int download_cur_ver
;
1077 int download_new_ver
;
1078 struct edgeport_fw_hdr
*fw_hdr
= (struct edgeport_fw_hdr
*)fw
->data
;
1079 struct ti_i2c_desc
*rom_desc
;
1081 dev_dbg(dev
, "%s - RUNNING IN DOWNLOAD MODE\n", __func__
);
1083 status
= check_i2c_image(serial
);
1085 dev_dbg(dev
, "%s - DOWNLOAD MODE -- BAD I2C\n", __func__
);
1090 * Validate Hardware version number
1091 * Read Manufacturing Descriptor from TI Based Edgeport
1093 ti_manuf_desc
= kmalloc(sizeof(*ti_manuf_desc
), GFP_KERNEL
);
1097 status
= get_manuf_info(serial
, (__u8
*)ti_manuf_desc
);
1099 kfree(ti_manuf_desc
);
1103 /* Check version number of ION descriptor */
1104 if (!ignore_cpu_rev
&& ti_cpu_rev(ti_manuf_desc
) < 2) {
1105 dev_dbg(dev
, "%s - Wrong CPU Rev %d (Must be 2)\n",
1106 __func__
, ti_cpu_rev(ti_manuf_desc
));
1107 kfree(ti_manuf_desc
);
1111 rom_desc
= kmalloc(sizeof(*rom_desc
), GFP_KERNEL
);
1113 kfree(ti_manuf_desc
);
1117 /* Search for type 2 record (firmware record) */
1118 start_address
= get_descriptor_addr(serial
,
1119 I2C_DESC_TYPE_FIRMWARE_BASIC
, rom_desc
);
1120 if (start_address
!= 0) {
1121 struct ti_i2c_firmware_rec
*firmware_version
;
1124 dev_dbg(dev
, "%s - Found Type FIRMWARE (Type 2) record\n",
1127 firmware_version
= kmalloc(sizeof(*firmware_version
),
1129 if (!firmware_version
) {
1131 kfree(ti_manuf_desc
);
1136 * Validate version number
1137 * Read the descriptor data
1139 status
= read_rom(serial
, start_address
+
1140 sizeof(struct ti_i2c_desc
),
1141 sizeof(struct ti_i2c_firmware_rec
),
1142 (__u8
*)firmware_version
);
1144 kfree(firmware_version
);
1146 kfree(ti_manuf_desc
);
1151 * Check version number of download with current
1154 download_cur_ver
= (firmware_version
->Ver_Major
<< 8) +
1155 (firmware_version
->Ver_Minor
);
1156 download_new_ver
= (fw_hdr
->major_version
<< 8) +
1157 (fw_hdr
->minor_version
);
1159 dev_dbg(dev
, "%s - >> FW Versions Device %d.%d Driver %d.%d\n",
1160 __func__
, firmware_version
->Ver_Major
,
1161 firmware_version
->Ver_Minor
,
1162 fw_hdr
->major_version
, fw_hdr
->minor_version
);
1165 * Check if we have an old version in the I2C and
1166 * update if necessary
1168 if (download_cur_ver
< download_new_ver
) {
1169 dev_dbg(dev
, "%s - Update I2C dld from %d.%d to %d.%d\n",
1171 firmware_version
->Ver_Major
,
1172 firmware_version
->Ver_Minor
,
1173 fw_hdr
->major_version
,
1174 fw_hdr
->minor_version
);
1176 record
= kmalloc(1, GFP_KERNEL
);
1178 kfree(firmware_version
);
1180 kfree(ti_manuf_desc
);
1184 * In order to update the I2C firmware we must
1185 * change the type 2 record to type 0xF2. This
1186 * will force the UMP to come up in Boot Mode.
1187 * Then while in boot mode, the driver will
1188 * download the latest firmware (padded to
1189 * 15.5k) into the UMP ram. Finally when the
1190 * device comes back up in download mode the
1191 * driver will cause the new firmware to be
1192 * copied from the UMP Ram to I2C and the
1193 * firmware will update the record type from
1196 *record
= I2C_DESC_TYPE_FIRMWARE_BLANK
;
1199 * Change the I2C Firmware record type to
1200 * 0xf2 to trigger an update
1202 status
= write_rom(serial
, start_address
,
1203 sizeof(*record
), record
);
1206 kfree(firmware_version
);
1208 kfree(ti_manuf_desc
);
1213 * verify the write -- must do this in order
1214 * for write to complete before we do the
1217 status
= read_rom(serial
,
1223 kfree(firmware_version
);
1225 kfree(ti_manuf_desc
);
1229 if (*record
!= I2C_DESC_TYPE_FIRMWARE_BLANK
) {
1230 dev_err(dev
, "%s - error resetting device\n",
1233 kfree(firmware_version
);
1235 kfree(ti_manuf_desc
);
1239 dev_dbg(dev
, "%s - HARDWARE RESET\n", __func__
);
1241 /* Reset UMP -- Back to BOOT MODE */
1242 status
= ti_vsend_sync(serial
->serial
->dev
,
1243 UMPC_HARDWARE_RESET
,
1245 TI_VSEND_TIMEOUT_DEFAULT
);
1247 dev_dbg(dev
, "%s - HARDWARE RESET return %d\n",
1250 /* return an error on purpose. */
1252 kfree(firmware_version
);
1254 kfree(ti_manuf_desc
);
1257 /* Same or newer fw version is already loaded */
1258 serial
->fw_version
= download_cur_ver
;
1259 kfree(firmware_version
);
1261 /* Search for type 0xF2 record (firmware blank record) */
1263 start_address
= get_descriptor_addr(serial
,
1264 I2C_DESC_TYPE_FIRMWARE_BLANK
, rom_desc
);
1265 if (start_address
!= 0) {
1266 #define HEADER_SIZE (sizeof(struct ti_i2c_desc) + \
1267 sizeof(struct ti_i2c_firmware_rec))
1271 header
= kmalloc(HEADER_SIZE
, GFP_KERNEL
);
1274 kfree(ti_manuf_desc
);
1278 vheader
= kmalloc(HEADER_SIZE
, GFP_KERNEL
);
1282 kfree(ti_manuf_desc
);
1286 dev_dbg(dev
, "%s - Found Type BLANK FIRMWARE (Type F2) record\n",
1290 * In order to update the I2C firmware we must change
1291 * the type 2 record to type 0xF2. This will force the
1292 * UMP to come up in Boot Mode. Then while in boot
1293 * mode, the driver will download the latest firmware
1294 * (padded to 15.5k) into the UMP ram. Finally when the
1295 * device comes back up in download mode the driver
1296 * will cause the new firmware to be copied from the
1297 * UMP Ram to I2C and the firmware will update the
1298 * record type from 0xf2 to 0x02.
1300 status
= build_i2c_fw_hdr(header
, fw
);
1305 kfree(ti_manuf_desc
);
1310 * Update I2C with type 0xf2 record with correct
1313 status
= write_rom(serial
,
1321 kfree(ti_manuf_desc
);
1326 * verify the write -- must do this in order for
1327 * write to complete before we do the hardware reset
1329 status
= read_rom(serial
, start_address
,
1330 HEADER_SIZE
, vheader
);
1333 dev_dbg(dev
, "%s - can't read header back\n",
1338 kfree(ti_manuf_desc
);
1341 if (memcmp(vheader
, header
, HEADER_SIZE
)) {
1342 dev_dbg(dev
, "%s - write download record failed\n",
1347 kfree(ti_manuf_desc
);
1354 dev_dbg(dev
, "%s - Start firmware update\n", __func__
);
1356 /* Tell firmware to copy download image into I2C */
1357 status
= ti_vsend_sync(serial
->serial
->dev
,
1358 UMPC_COPY_DNLD_TO_I2C
,
1360 TI_VSEND_TIMEOUT_FW_DOWNLOAD
);
1362 dev_dbg(dev
, "%s - Update complete 0x%x\n", __func__
,
1366 "%s - UMPC_COPY_DNLD_TO_I2C failed\n",
1369 kfree(ti_manuf_desc
);
1375 /* The device is running the download code */
1377 kfree(ti_manuf_desc
);
1381 static int do_boot_mode(struct edgeport_serial
*serial
,
1382 const struct firmware
*fw
)
1384 struct device
*dev
= &serial
->serial
->interface
->dev
;
1386 struct edge_ti_manuf_descriptor
*ti_manuf_desc
;
1387 struct edgeport_fw_hdr
*fw_hdr
= (struct edgeport_fw_hdr
*)fw
->data
;
1389 dev_dbg(dev
, "%s - RUNNING IN BOOT MODE\n", __func__
);
1391 /* Configure the TI device so we can use the BULK pipes for download */
1392 status
= config_boot_dev(serial
->serial
->dev
);
1396 if (le16_to_cpu(serial
->serial
->dev
->descriptor
.idVendor
)
1397 != USB_VENDOR_ID_ION
) {
1398 dev_dbg(dev
, "%s - VID = 0x%x\n", __func__
,
1399 le16_to_cpu(serial
->serial
->dev
->descriptor
.idVendor
));
1400 serial
->TI_I2C_Type
= DTK_ADDR_SPACE_I2C_TYPE_II
;
1401 goto stayinbootmode
;
1405 * We have an ION device (I2c Must be programmed)
1406 * Determine I2C image type
1408 if (i2c_type_bootmode(serial
))
1409 goto stayinbootmode
;
1411 /* Check for ION Vendor ID and that the I2C is valid */
1412 if (!check_i2c_image(serial
)) {
1413 struct ti_i2c_image_header
*header
;
1420 * Validate Hardware version number
1421 * Read Manufacturing Descriptor from TI Based Edgeport
1423 ti_manuf_desc
= kmalloc(sizeof(*ti_manuf_desc
), GFP_KERNEL
);
1427 status
= get_manuf_info(serial
, (__u8
*)ti_manuf_desc
);
1429 kfree(ti_manuf_desc
);
1430 goto stayinbootmode
;
1433 /* Check for version 2 */
1434 if (!ignore_cpu_rev
&& ti_cpu_rev(ti_manuf_desc
) < 2) {
1435 dev_dbg(dev
, "%s - Wrong CPU Rev %d (Must be 2)\n",
1436 __func__
, ti_cpu_rev(ti_manuf_desc
));
1437 kfree(ti_manuf_desc
);
1438 goto stayinbootmode
;
1441 kfree(ti_manuf_desc
);
1444 * In order to update the I2C firmware we must change the type
1445 * 2 record to type 0xF2. This will force the UMP to come up
1446 * in Boot Mode. Then while in boot mode, the driver will
1447 * download the latest firmware (padded to 15.5k) into the
1448 * UMP ram. Finally when the device comes back up in download
1449 * mode the driver will cause the new firmware to be copied
1450 * from the UMP Ram to I2C and the firmware will update the
1451 * record type from 0xf2 to 0x02.
1453 * Do we really have to copy the whole firmware image,
1454 * or could we do this in place!
1457 /* Allocate a 15.5k buffer + 3 byte header */
1458 buffer_size
= (((1024 * 16) - 512) +
1459 sizeof(struct ti_i2c_image_header
));
1460 buffer
= kmalloc(buffer_size
, GFP_KERNEL
);
1464 /* Initialize the buffer to 0xff (pad the buffer) */
1465 memset(buffer
, 0xff, buffer_size
);
1466 memcpy(buffer
, &fw
->data
[4], fw
->size
- 4);
1468 for (i
= sizeof(struct ti_i2c_image_header
);
1469 i
< buffer_size
; i
++) {
1470 cs
= (__u8
)(cs
+ buffer
[i
]);
1473 header
= (struct ti_i2c_image_header
*)buffer
;
1475 /* update length and checksum after padding */
1476 header
->Length
= cpu_to_le16((__u16
)(buffer_size
-
1477 sizeof(struct ti_i2c_image_header
)));
1478 header
->CheckSum
= cs
;
1480 /* Download the operational code */
1481 dev_dbg(dev
, "%s - Downloading operational code image version %d.%d (TI UMP)\n",
1483 fw_hdr
->major_version
, fw_hdr
->minor_version
);
1484 status
= download_code(serial
, buffer
, buffer_size
);
1489 dev_dbg(dev
, "%s - Error downloading operational code image\n", __func__
);
1493 /* Device will reboot */
1494 serial
->product_info
.TiMode
= TI_MODE_TRANSITIONING
;
1496 dev_dbg(dev
, "%s - Download successful -- Device rebooting...\n", __func__
);
1502 /* Eprom is invalid or blank stay in boot mode */
1503 dev_dbg(dev
, "%s - STAYING IN BOOT MODE\n", __func__
);
1504 serial
->product_info
.TiMode
= TI_MODE_BOOT
;
1509 static int ti_do_config(struct edgeport_port
*port
, int feature
, int on
)
1511 int port_number
= port
->port
->port_number
;
1513 on
= !!on
; /* 1 or 0 not bitmask */
1514 return send_cmd(port
->port
->serial
->dev
,
1515 feature
, (__u8
)(UMPM_UART1_PORT
+ port_number
),
1519 static int restore_mcr(struct edgeport_port
*port
, __u8 mcr
)
1523 dev_dbg(&port
->port
->dev
, "%s - %x\n", __func__
, mcr
);
1525 status
= ti_do_config(port
, UMPC_SET_CLR_DTR
, mcr
& MCR_DTR
);
1528 status
= ti_do_config(port
, UMPC_SET_CLR_RTS
, mcr
& MCR_RTS
);
1531 return ti_do_config(port
, UMPC_SET_CLR_LOOPBACK
, mcr
& MCR_LOOPBACK
);
1534 /* Convert TI LSR to standard UART flags */
1535 static __u8
map_line_status(__u8 ti_lsr
)
1539 #define MAP_FLAG(flagUmp, flagUart) \
1540 if (ti_lsr & flagUmp) \
1543 MAP_FLAG(UMP_UART_LSR_OV_MASK
, LSR_OVER_ERR
) /* overrun */
1544 MAP_FLAG(UMP_UART_LSR_PE_MASK
, LSR_PAR_ERR
) /* parity error */
1545 MAP_FLAG(UMP_UART_LSR_FE_MASK
, LSR_FRM_ERR
) /* framing error */
1546 MAP_FLAG(UMP_UART_LSR_BR_MASK
, LSR_BREAK
) /* break detected */
1547 MAP_FLAG(UMP_UART_LSR_RX_MASK
, LSR_RX_AVAIL
) /* rx data available */
1548 MAP_FLAG(UMP_UART_LSR_TX_MASK
, LSR_TX_EMPTY
) /* tx hold reg empty */
1555 static void handle_new_msr(struct edgeport_port
*edge_port
, __u8 msr
)
1557 struct async_icount
*icount
;
1558 struct tty_struct
*tty
;
1560 dev_dbg(&edge_port
->port
->dev
, "%s - %02x\n", __func__
, msr
);
1562 if (msr
& (EDGEPORT_MSR_DELTA_CTS
| EDGEPORT_MSR_DELTA_DSR
|
1563 EDGEPORT_MSR_DELTA_RI
| EDGEPORT_MSR_DELTA_CD
)) {
1564 icount
= &edge_port
->port
->icount
;
1566 /* update input line counters */
1567 if (msr
& EDGEPORT_MSR_DELTA_CTS
)
1569 if (msr
& EDGEPORT_MSR_DELTA_DSR
)
1571 if (msr
& EDGEPORT_MSR_DELTA_CD
)
1573 if (msr
& EDGEPORT_MSR_DELTA_RI
)
1575 wake_up_interruptible(&edge_port
->port
->port
.delta_msr_wait
);
1578 /* Save the new modem status */
1579 edge_port
->shadow_msr
= msr
& 0xf0;
1581 tty
= tty_port_tty_get(&edge_port
->port
->port
);
1582 /* handle CTS flow control */
1583 if (tty
&& C_CRTSCTS(tty
)) {
1584 if (msr
& EDGEPORT_MSR_CTS
)
1590 static void handle_new_lsr(struct edgeport_port
*edge_port
, int lsr_data
,
1591 __u8 lsr
, __u8 data
)
1593 struct async_icount
*icount
;
1594 __u8 new_lsr
= (__u8
)(lsr
& (__u8
)(LSR_OVER_ERR
| LSR_PAR_ERR
|
1595 LSR_FRM_ERR
| LSR_BREAK
));
1597 dev_dbg(&edge_port
->port
->dev
, "%s - %02x\n", __func__
, new_lsr
);
1599 edge_port
->shadow_lsr
= lsr
;
1601 if (new_lsr
& LSR_BREAK
)
1603 * Parity and Framing errors only count if they
1604 * occur exclusive of a break being received.
1606 new_lsr
&= (__u8
)(LSR_OVER_ERR
| LSR_BREAK
);
1608 /* Place LSR data byte into Rx buffer */
1610 edge_tty_recv(edge_port
->port
, &data
, 1);
1612 /* update input line counters */
1613 icount
= &edge_port
->port
->icount
;
1614 if (new_lsr
& LSR_BREAK
)
1616 if (new_lsr
& LSR_OVER_ERR
)
1618 if (new_lsr
& LSR_PAR_ERR
)
1620 if (new_lsr
& LSR_FRM_ERR
)
1624 static void edge_interrupt_callback(struct urb
*urb
)
1626 struct edgeport_serial
*edge_serial
= urb
->context
;
1627 struct usb_serial_port
*port
;
1628 struct edgeport_port
*edge_port
;
1630 unsigned char *data
= urb
->transfer_buffer
;
1631 int length
= urb
->actual_length
;
1637 int status
= urb
->status
;
1646 /* this urb is terminated, clean up */
1647 dev_dbg(&urb
->dev
->dev
, "%s - urb shutting down with status: %d\n",
1651 dev_err(&urb
->dev
->dev
, "%s - nonzero urb status received: "
1652 "%d\n", __func__
, status
);
1657 dev_dbg(&urb
->dev
->dev
, "%s - no data in urb\n", __func__
);
1661 dev
= &edge_serial
->serial
->dev
->dev
;
1662 usb_serial_debug_data(dev
, __func__
, length
, data
);
1665 dev_dbg(dev
, "%s - expecting packet of size 2, got %d\n", __func__
, length
);
1669 port_number
= TIUMP_GET_PORT_FROM_CODE(data
[0]);
1670 function
= TIUMP_GET_FUNC_FROM_CODE(data
[0]);
1671 dev_dbg(dev
, "%s - port_number %d, function %d, info 0x%x\n", __func__
,
1672 port_number
, function
, data
[1]);
1674 if (port_number
>= edge_serial
->serial
->num_ports
) {
1675 dev_err(dev
, "bad port number %d\n", port_number
);
1679 port
= edge_serial
->serial
->port
[port_number
];
1680 edge_port
= usb_get_serial_port_data(port
);
1682 dev_dbg(dev
, "%s - edge_port not found\n", __func__
);
1686 case TIUMP_INTERRUPT_CODE_LSR
:
1687 lsr
= map_line_status(data
[1]);
1688 if (lsr
& UMP_UART_LSR_DATA_MASK
) {
1690 * Save the LSR event for bulk read completion routine
1692 dev_dbg(dev
, "%s - LSR Event Port %u LSR Status = %02x\n",
1693 __func__
, port_number
, lsr
);
1694 edge_port
->lsr_event
= 1;
1695 edge_port
->lsr_mask
= lsr
;
1697 dev_dbg(dev
, "%s - ===== Port %d LSR Status = %02x ======\n",
1698 __func__
, port_number
, lsr
);
1699 handle_new_lsr(edge_port
, 0, lsr
, 0);
1703 case TIUMP_INTERRUPT_CODE_MSR
: /* MSR */
1704 /* Copy MSR from UMP */
1706 dev_dbg(dev
, "%s - ===== Port %u MSR Status = %02x ======\n",
1707 __func__
, port_number
, msr
);
1708 handle_new_msr(edge_port
, msr
);
1712 dev_err(&urb
->dev
->dev
,
1713 "%s - Unknown Interrupt code from UMP %x\n",
1720 retval
= usb_submit_urb(urb
, GFP_ATOMIC
);
1722 dev_err(&urb
->dev
->dev
,
1723 "%s - usb_submit_urb failed with result %d\n",
1727 static void edge_bulk_in_callback(struct urb
*urb
)
1729 struct edgeport_port
*edge_port
= urb
->context
;
1730 struct device
*dev
= &edge_port
->port
->dev
;
1731 unsigned char *data
= urb
->transfer_buffer
;
1734 int status
= urb
->status
;
1743 /* this urb is terminated, clean up */
1744 dev_dbg(&urb
->dev
->dev
, "%s - urb shutting down with status: %d\n", __func__
, status
);
1747 dev_err(&urb
->dev
->dev
, "%s - nonzero read bulk status received: %d\n", __func__
, status
);
1750 if (status
== -EPIPE
)
1754 dev_err(&urb
->dev
->dev
, "%s - stopping read!\n", __func__
);
1758 port_number
= edge_port
->port
->port_number
;
1760 if (urb
->actual_length
> 0 && edge_port
->lsr_event
) {
1761 edge_port
->lsr_event
= 0;
1762 dev_dbg(dev
, "%s ===== Port %u LSR Status = %02x, Data = %02x ======\n",
1763 __func__
, port_number
, edge_port
->lsr_mask
, *data
);
1764 handle_new_lsr(edge_port
, 1, edge_port
->lsr_mask
, *data
);
1765 /* Adjust buffer length/pointer */
1766 --urb
->actual_length
;
1770 if (urb
->actual_length
) {
1771 usb_serial_debug_data(dev
, __func__
, urb
->actual_length
, data
);
1772 if (edge_port
->close_pending
)
1773 dev_dbg(dev
, "%s - close pending, dropping data on the floor\n",
1776 edge_tty_recv(edge_port
->port
, data
,
1777 urb
->actual_length
);
1778 edge_port
->port
->icount
.rx
+= urb
->actual_length
;
1782 /* continue read unless stopped */
1783 spin_lock(&edge_port
->ep_lock
);
1784 if (edge_port
->ep_read_urb_state
== EDGE_READ_URB_RUNNING
)
1785 retval
= usb_submit_urb(urb
, GFP_ATOMIC
);
1786 else if (edge_port
->ep_read_urb_state
== EDGE_READ_URB_STOPPING
)
1787 edge_port
->ep_read_urb_state
= EDGE_READ_URB_STOPPED
;
1789 spin_unlock(&edge_port
->ep_lock
);
1791 dev_err(dev
, "%s - usb_submit_urb failed with result %d\n", __func__
, retval
);
1794 static void edge_tty_recv(struct usb_serial_port
*port
, unsigned char *data
,
1799 queued
= tty_insert_flip_string(&port
->port
, data
, length
);
1800 if (queued
< length
)
1801 dev_err(&port
->dev
, "%s - dropping data, %d bytes lost\n",
1802 __func__
, length
- queued
);
1803 tty_flip_buffer_push(&port
->port
);
1806 static void edge_bulk_out_callback(struct urb
*urb
)
1808 struct usb_serial_port
*port
= urb
->context
;
1809 struct edgeport_port
*edge_port
= usb_get_serial_port_data(port
);
1810 int status
= urb
->status
;
1811 struct tty_struct
*tty
;
1813 edge_port
->ep_write_urb_in_use
= 0;
1822 /* this urb is terminated, clean up */
1823 dev_dbg(&urb
->dev
->dev
, "%s - urb shutting down with status: %d\n",
1827 dev_err_console(port
, "%s - nonzero write bulk status "
1828 "received: %d\n", __func__
, status
);
1831 /* send any buffered data */
1832 tty
= tty_port_tty_get(&port
->port
);
1833 edge_send(port
, tty
);
1837 static int edge_open(struct tty_struct
*tty
, struct usb_serial_port
*port
)
1839 struct edgeport_port
*edge_port
= usb_get_serial_port_data(port
);
1840 struct edgeport_serial
*edge_serial
;
1841 struct usb_device
*dev
;
1846 u8 transaction_timeout
;
1848 if (edge_port
== NULL
)
1851 port_number
= port
->port_number
;
1853 dev
= port
->serial
->dev
;
1855 /* turn off loopback */
1856 status
= ti_do_config(edge_port
, UMPC_SET_CLR_LOOPBACK
, 0);
1859 "%s - cannot send clear loopback command, %d\n",
1864 /* set up the port settings */
1866 edge_set_termios(tty
, port
, &tty
->termios
);
1868 /* open up the port */
1870 /* milliseconds to timeout for DMA transfer */
1871 transaction_timeout
= 2;
1873 edge_port
->ump_read_timeout
=
1874 max(20, ((transaction_timeout
* 3) / 2));
1876 /* milliseconds to timeout for DMA transfer */
1877 open_settings
= (u8
)(UMP_DMA_MODE_CONTINOUS
|
1878 UMP_PIPE_TRANS_TIMEOUT_ENA
|
1879 (transaction_timeout
<< 2));
1881 dev_dbg(&port
->dev
, "%s - Sending UMPC_OPEN_PORT\n", __func__
);
1883 /* Tell TI to open and start the port */
1884 status
= send_cmd(dev
, UMPC_OPEN_PORT
,
1885 (u8
)(UMPM_UART1_PORT
+ port_number
), open_settings
, NULL
, 0);
1887 dev_err(&port
->dev
, "%s - cannot send open command, %d\n",
1892 /* Start the DMA? */
1893 status
= send_cmd(dev
, UMPC_START_PORT
,
1894 (u8
)(UMPM_UART1_PORT
+ port_number
), 0, NULL
, 0);
1896 dev_err(&port
->dev
, "%s - cannot send start DMA command, %d\n",
1901 /* Clear TX and RX buffers in UMP */
1902 status
= purge_port(port
, UMP_PORT_DIR_OUT
| UMP_PORT_DIR_IN
);
1905 "%s - cannot send clear buffers command, %d\n",
1910 /* Read Initial MSR */
1911 status
= ti_vread_sync(dev
, UMPC_READ_MSR
, 0,
1912 (__u16
)(UMPM_UART1_PORT
+ port_number
),
1913 &edge_port
->shadow_msr
, 1);
1915 dev_err(&port
->dev
, "%s - cannot send read MSR command, %d\n",
1920 dev_dbg(&port
->dev
, "ShadowMSR 0x%X\n", edge_port
->shadow_msr
);
1922 /* Set Initial MCR */
1923 edge_port
->shadow_mcr
= MCR_RTS
| MCR_DTR
;
1924 dev_dbg(&port
->dev
, "ShadowMCR 0x%X\n", edge_port
->shadow_mcr
);
1926 edge_serial
= edge_port
->edge_serial
;
1927 if (mutex_lock_interruptible(&edge_serial
->es_lock
))
1928 return -ERESTARTSYS
;
1929 if (edge_serial
->num_ports_open
== 0) {
1930 /* we are the first port to open, post the interrupt urb */
1931 urb
= edge_serial
->serial
->port
[0]->interrupt_in_urb
;
1932 urb
->context
= edge_serial
;
1933 status
= usb_submit_urb(urb
, GFP_KERNEL
);
1936 "%s - usb_submit_urb failed with value %d\n",
1938 goto release_es_lock
;
1943 * reset the data toggle on the bulk endpoints to work around bug in
1944 * host controllers where things get out of sync some times
1946 usb_clear_halt(dev
, port
->write_urb
->pipe
);
1947 usb_clear_halt(dev
, port
->read_urb
->pipe
);
1949 /* start up our bulk read urb */
1950 urb
= port
->read_urb
;
1951 edge_port
->ep_read_urb_state
= EDGE_READ_URB_RUNNING
;
1952 urb
->context
= edge_port
;
1953 status
= usb_submit_urb(urb
, GFP_KERNEL
);
1956 "%s - read bulk usb_submit_urb failed with value %d\n",
1958 goto unlink_int_urb
;
1961 ++edge_serial
->num_ports_open
;
1963 goto release_es_lock
;
1966 if (edge_port
->edge_serial
->num_ports_open
== 0)
1967 usb_kill_urb(port
->serial
->port
[0]->interrupt_in_urb
);
1969 mutex_unlock(&edge_serial
->es_lock
);
1973 static void edge_close(struct usb_serial_port
*port
)
1975 struct edgeport_serial
*edge_serial
;
1976 struct edgeport_port
*edge_port
;
1977 struct usb_serial
*serial
= port
->serial
;
1978 unsigned long flags
;
1981 edge_serial
= usb_get_serial_data(port
->serial
);
1982 edge_port
= usb_get_serial_port_data(port
);
1983 if (edge_serial
== NULL
|| edge_port
== NULL
)
1987 * The bulkreadcompletion routine will check
1988 * this flag and dump add read data
1990 edge_port
->close_pending
= 1;
1992 usb_kill_urb(port
->read_urb
);
1993 usb_kill_urb(port
->write_urb
);
1994 edge_port
->ep_write_urb_in_use
= 0;
1995 spin_lock_irqsave(&edge_port
->ep_lock
, flags
);
1996 kfifo_reset_out(&port
->write_fifo
);
1997 spin_unlock_irqrestore(&edge_port
->ep_lock
, flags
);
1999 dev_dbg(&port
->dev
, "%s - send umpc_close_port\n", __func__
);
2000 port_number
= port
->port_number
;
2001 send_cmd(serial
->dev
, UMPC_CLOSE_PORT
,
2002 (__u8
)(UMPM_UART1_PORT
+ port_number
), 0, NULL
, 0);
2004 mutex_lock(&edge_serial
->es_lock
);
2005 --edge_port
->edge_serial
->num_ports_open
;
2006 if (edge_port
->edge_serial
->num_ports_open
<= 0) {
2007 /* last port is now closed, let's shut down our interrupt urb */
2008 usb_kill_urb(port
->serial
->port
[0]->interrupt_in_urb
);
2009 edge_port
->edge_serial
->num_ports_open
= 0;
2011 mutex_unlock(&edge_serial
->es_lock
);
2012 edge_port
->close_pending
= 0;
2015 static int edge_write(struct tty_struct
*tty
, struct usb_serial_port
*port
,
2016 const unsigned char *data
, int count
)
2018 struct edgeport_port
*edge_port
= usb_get_serial_port_data(port
);
2021 dev_dbg(&port
->dev
, "%s - write request of 0 bytes\n", __func__
);
2025 if (edge_port
== NULL
)
2027 if (edge_port
->close_pending
== 1)
2030 count
= kfifo_in_locked(&port
->write_fifo
, data
, count
,
2031 &edge_port
->ep_lock
);
2032 edge_send(port
, tty
);
2037 static void edge_send(struct usb_serial_port
*port
, struct tty_struct
*tty
)
2040 struct edgeport_port
*edge_port
= usb_get_serial_port_data(port
);
2041 unsigned long flags
;
2043 spin_lock_irqsave(&edge_port
->ep_lock
, flags
);
2045 if (edge_port
->ep_write_urb_in_use
) {
2046 spin_unlock_irqrestore(&edge_port
->ep_lock
, flags
);
2050 count
= kfifo_out(&port
->write_fifo
,
2051 port
->write_urb
->transfer_buffer
,
2052 port
->bulk_out_size
);
2055 spin_unlock_irqrestore(&edge_port
->ep_lock
, flags
);
2059 edge_port
->ep_write_urb_in_use
= 1;
2061 spin_unlock_irqrestore(&edge_port
->ep_lock
, flags
);
2063 usb_serial_debug_data(&port
->dev
, __func__
, count
, port
->write_urb
->transfer_buffer
);
2065 /* set up our urb */
2066 port
->write_urb
->transfer_buffer_length
= count
;
2068 /* send the data out the bulk port */
2069 result
= usb_submit_urb(port
->write_urb
, GFP_ATOMIC
);
2071 dev_err_console(port
,
2072 "%s - failed submitting write urb, error %d\n",
2074 edge_port
->ep_write_urb_in_use
= 0;
2075 /* TODO: reschedule edge_send */
2077 edge_port
->port
->icount
.tx
+= count
;
2080 * wakeup any process waiting for writes to complete
2081 * there is now more room in the buffer for new writes
2087 static int edge_write_room(struct tty_struct
*tty
)
2089 struct usb_serial_port
*port
= tty
->driver_data
;
2090 struct edgeport_port
*edge_port
= usb_get_serial_port_data(port
);
2092 unsigned long flags
;
2094 if (edge_port
== NULL
)
2096 if (edge_port
->close_pending
== 1)
2099 spin_lock_irqsave(&edge_port
->ep_lock
, flags
);
2100 room
= kfifo_avail(&port
->write_fifo
);
2101 spin_unlock_irqrestore(&edge_port
->ep_lock
, flags
);
2103 dev_dbg(&port
->dev
, "%s - returns %d\n", __func__
, room
);
2107 static int edge_chars_in_buffer(struct tty_struct
*tty
)
2109 struct usb_serial_port
*port
= tty
->driver_data
;
2110 struct edgeport_port
*edge_port
= usb_get_serial_port_data(port
);
2112 unsigned long flags
;
2113 if (edge_port
== NULL
)
2116 spin_lock_irqsave(&edge_port
->ep_lock
, flags
);
2117 chars
= kfifo_len(&port
->write_fifo
);
2118 spin_unlock_irqrestore(&edge_port
->ep_lock
, flags
);
2120 dev_dbg(&port
->dev
, "%s - returns %d\n", __func__
, chars
);
2124 static bool edge_tx_empty(struct usb_serial_port
*port
)
2126 struct edgeport_port
*edge_port
= usb_get_serial_port_data(port
);
2129 ret
= tx_active(edge_port
);
2136 static void edge_throttle(struct tty_struct
*tty
)
2138 struct usb_serial_port
*port
= tty
->driver_data
;
2139 struct edgeport_port
*edge_port
= usb_get_serial_port_data(port
);
2142 if (edge_port
== NULL
)
2145 /* if we are implementing XON/XOFF, send the stop character */
2147 unsigned char stop_char
= STOP_CHAR(tty
);
2148 status
= edge_write(tty
, port
, &stop_char
, 1);
2150 dev_err(&port
->dev
, "%s - failed to write stop character, %d\n", __func__
, status
);
2155 * if we are implementing RTS/CTS, stop reads
2156 * and the Edgeport will clear the RTS line
2159 stop_read(edge_port
);
2163 static void edge_unthrottle(struct tty_struct
*tty
)
2165 struct usb_serial_port
*port
= tty
->driver_data
;
2166 struct edgeport_port
*edge_port
= usb_get_serial_port_data(port
);
2169 if (edge_port
== NULL
)
2172 /* if we are implementing XON/XOFF, send the start character */
2174 unsigned char start_char
= START_CHAR(tty
);
2175 status
= edge_write(tty
, port
, &start_char
, 1);
2177 dev_err(&port
->dev
, "%s - failed to write start character, %d\n", __func__
, status
);
2181 * if we are implementing RTS/CTS, restart reads
2182 * are the Edgeport will assert the RTS line
2184 if (C_CRTSCTS(tty
)) {
2185 status
= restart_read(edge_port
);
2188 "%s - read bulk usb_submit_urb failed: %d\n",
2194 static void stop_read(struct edgeport_port
*edge_port
)
2196 unsigned long flags
;
2198 spin_lock_irqsave(&edge_port
->ep_lock
, flags
);
2200 if (edge_port
->ep_read_urb_state
== EDGE_READ_URB_RUNNING
)
2201 edge_port
->ep_read_urb_state
= EDGE_READ_URB_STOPPING
;
2202 edge_port
->shadow_mcr
&= ~MCR_RTS
;
2204 spin_unlock_irqrestore(&edge_port
->ep_lock
, flags
);
2207 static int restart_read(struct edgeport_port
*edge_port
)
2211 unsigned long flags
;
2213 spin_lock_irqsave(&edge_port
->ep_lock
, flags
);
2215 if (edge_port
->ep_read_urb_state
== EDGE_READ_URB_STOPPED
) {
2216 urb
= edge_port
->port
->read_urb
;
2217 status
= usb_submit_urb(urb
, GFP_ATOMIC
);
2219 edge_port
->ep_read_urb_state
= EDGE_READ_URB_RUNNING
;
2220 edge_port
->shadow_mcr
|= MCR_RTS
;
2222 spin_unlock_irqrestore(&edge_port
->ep_lock
, flags
);
2227 static void change_port_settings(struct tty_struct
*tty
,
2228 struct edgeport_port
*edge_port
, struct ktermios
*old_termios
)
2230 struct device
*dev
= &edge_port
->port
->dev
;
2231 struct ump_uart_config
*config
;
2235 int port_number
= edge_port
->port
->port_number
;
2237 config
= kmalloc (sizeof (*config
), GFP_KERNEL
);
2239 tty
->termios
= *old_termios
;
2243 cflag
= tty
->termios
.c_cflag
;
2247 /* These flags must be set */
2248 config
->wFlags
|= UMP_MASK_UART_FLAGS_RECEIVE_MS_INT
;
2249 config
->wFlags
|= UMP_MASK_UART_FLAGS_AUTO_START_ON_ERR
;
2250 config
->bUartMode
= (__u8
)(edge_port
->bUartMode
);
2252 switch (cflag
& CSIZE
) {
2254 config
->bDataBits
= UMP_UART_CHAR5BITS
;
2255 dev_dbg(dev
, "%s - data bits = 5\n", __func__
);
2258 config
->bDataBits
= UMP_UART_CHAR6BITS
;
2259 dev_dbg(dev
, "%s - data bits = 6\n", __func__
);
2262 config
->bDataBits
= UMP_UART_CHAR7BITS
;
2263 dev_dbg(dev
, "%s - data bits = 7\n", __func__
);
2267 config
->bDataBits
= UMP_UART_CHAR8BITS
;
2268 dev_dbg(dev
, "%s - data bits = 8\n", __func__
);
2272 if (cflag
& PARENB
) {
2273 if (cflag
& PARODD
) {
2274 config
->wFlags
|= UMP_MASK_UART_FLAGS_PARITY
;
2275 config
->bParity
= UMP_UART_ODDPARITY
;
2276 dev_dbg(dev
, "%s - parity = odd\n", __func__
);
2278 config
->wFlags
|= UMP_MASK_UART_FLAGS_PARITY
;
2279 config
->bParity
= UMP_UART_EVENPARITY
;
2280 dev_dbg(dev
, "%s - parity = even\n", __func__
);
2283 config
->bParity
= UMP_UART_NOPARITY
;
2284 dev_dbg(dev
, "%s - parity = none\n", __func__
);
2287 if (cflag
& CSTOPB
) {
2288 config
->bStopBits
= UMP_UART_STOPBIT2
;
2289 dev_dbg(dev
, "%s - stop bits = 2\n", __func__
);
2291 config
->bStopBits
= UMP_UART_STOPBIT1
;
2292 dev_dbg(dev
, "%s - stop bits = 1\n", __func__
);
2295 /* figure out the flow control settings */
2296 if (cflag
& CRTSCTS
) {
2297 config
->wFlags
|= UMP_MASK_UART_FLAGS_OUT_X_CTS_FLOW
;
2298 config
->wFlags
|= UMP_MASK_UART_FLAGS_RTS_FLOW
;
2299 dev_dbg(dev
, "%s - RTS/CTS is enabled\n", __func__
);
2301 dev_dbg(dev
, "%s - RTS/CTS is disabled\n", __func__
);
2302 restart_read(edge_port
);
2306 * if we are implementing XON/XOFF, set the start and stop
2307 * character in the device
2309 config
->cXon
= START_CHAR(tty
);
2310 config
->cXoff
= STOP_CHAR(tty
);
2312 /* if we are implementing INBOUND XON/XOFF */
2314 config
->wFlags
|= UMP_MASK_UART_FLAGS_IN_X
;
2315 dev_dbg(dev
, "%s - INBOUND XON/XOFF is enabled, XON = %2x, XOFF = %2x\n",
2316 __func__
, config
->cXon
, config
->cXoff
);
2318 dev_dbg(dev
, "%s - INBOUND XON/XOFF is disabled\n", __func__
);
2320 /* if we are implementing OUTBOUND XON/XOFF */
2322 config
->wFlags
|= UMP_MASK_UART_FLAGS_OUT_X
;
2323 dev_dbg(dev
, "%s - OUTBOUND XON/XOFF is enabled, XON = %2x, XOFF = %2x\n",
2324 __func__
, config
->cXon
, config
->cXoff
);
2326 dev_dbg(dev
, "%s - OUTBOUND XON/XOFF is disabled\n", __func__
);
2328 tty
->termios
.c_cflag
&= ~CMSPAR
;
2330 /* Round the baud rate */
2331 baud
= tty_get_baud_rate(tty
);
2333 /* pick a default, any default... */
2336 /* Avoid a zero divisor. */
2337 baud
= min(baud
, 461550);
2338 tty_encode_baud_rate(tty
, baud
, baud
);
2341 edge_port
->baud_rate
= baud
;
2342 config
->wBaudRate
= (__u16
)((461550L + baud
/2) / baud
);
2344 /* FIXME: Recompute actual baud from divisor here */
2346 dev_dbg(dev
, "%s - baud rate = %d, wBaudRate = %d\n", __func__
, baud
, config
->wBaudRate
);
2348 dev_dbg(dev
, "wBaudRate: %d\n", (int)(461550L / config
->wBaudRate
));
2349 dev_dbg(dev
, "wFlags: 0x%x\n", config
->wFlags
);
2350 dev_dbg(dev
, "bDataBits: %d\n", config
->bDataBits
);
2351 dev_dbg(dev
, "bParity: %d\n", config
->bParity
);
2352 dev_dbg(dev
, "bStopBits: %d\n", config
->bStopBits
);
2353 dev_dbg(dev
, "cXon: %d\n", config
->cXon
);
2354 dev_dbg(dev
, "cXoff: %d\n", config
->cXoff
);
2355 dev_dbg(dev
, "bUartMode: %d\n", config
->bUartMode
);
2357 /* move the word values into big endian mode */
2358 cpu_to_be16s(&config
->wFlags
);
2359 cpu_to_be16s(&config
->wBaudRate
);
2361 status
= send_cmd(edge_port
->port
->serial
->dev
, UMPC_SET_CONFIG
,
2362 (__u8
)(UMPM_UART1_PORT
+ port_number
),
2363 0, (__u8
*)config
, sizeof(*config
));
2365 dev_dbg(dev
, "%s - error %d when trying to write config to device\n",
2370 static void edge_set_termios(struct tty_struct
*tty
,
2371 struct usb_serial_port
*port
, struct ktermios
*old_termios
)
2373 struct edgeport_port
*edge_port
= usb_get_serial_port_data(port
);
2375 if (edge_port
== NULL
)
2377 /* change the port settings to the new ones specified */
2378 change_port_settings(tty
, edge_port
, old_termios
);
2381 static int edge_tiocmset(struct tty_struct
*tty
,
2382 unsigned int set
, unsigned int clear
)
2384 struct usb_serial_port
*port
= tty
->driver_data
;
2385 struct edgeport_port
*edge_port
= usb_get_serial_port_data(port
);
2387 unsigned long flags
;
2389 spin_lock_irqsave(&edge_port
->ep_lock
, flags
);
2390 mcr
= edge_port
->shadow_mcr
;
2391 if (set
& TIOCM_RTS
)
2393 if (set
& TIOCM_DTR
)
2395 if (set
& TIOCM_LOOP
)
2396 mcr
|= MCR_LOOPBACK
;
2398 if (clear
& TIOCM_RTS
)
2400 if (clear
& TIOCM_DTR
)
2402 if (clear
& TIOCM_LOOP
)
2403 mcr
&= ~MCR_LOOPBACK
;
2405 edge_port
->shadow_mcr
= mcr
;
2406 spin_unlock_irqrestore(&edge_port
->ep_lock
, flags
);
2408 restore_mcr(edge_port
, mcr
);
2412 static int edge_tiocmget(struct tty_struct
*tty
)
2414 struct usb_serial_port
*port
= tty
->driver_data
;
2415 struct edgeport_port
*edge_port
= usb_get_serial_port_data(port
);
2416 unsigned int result
= 0;
2419 unsigned long flags
;
2421 spin_lock_irqsave(&edge_port
->ep_lock
, flags
);
2423 msr
= edge_port
->shadow_msr
;
2424 mcr
= edge_port
->shadow_mcr
;
2425 result
= ((mcr
& MCR_DTR
) ? TIOCM_DTR
: 0) /* 0x002 */
2426 | ((mcr
& MCR_RTS
) ? TIOCM_RTS
: 0) /* 0x004 */
2427 | ((msr
& EDGEPORT_MSR_CTS
) ? TIOCM_CTS
: 0) /* 0x020 */
2428 | ((msr
& EDGEPORT_MSR_CD
) ? TIOCM_CAR
: 0) /* 0x040 */
2429 | ((msr
& EDGEPORT_MSR_RI
) ? TIOCM_RI
: 0) /* 0x080 */
2430 | ((msr
& EDGEPORT_MSR_DSR
) ? TIOCM_DSR
: 0); /* 0x100 */
2433 dev_dbg(&port
->dev
, "%s -- %x\n", __func__
, result
);
2434 spin_unlock_irqrestore(&edge_port
->ep_lock
, flags
);
2439 static int get_serial_info(struct edgeport_port
*edge_port
,
2440 struct serial_struct __user
*retinfo
)
2442 struct serial_struct tmp
;
2445 cwait
= edge_port
->port
->port
.closing_wait
;
2446 if (cwait
!= ASYNC_CLOSING_WAIT_NONE
)
2447 cwait
= jiffies_to_msecs(cwait
) / 10;
2449 memset(&tmp
, 0, sizeof(tmp
));
2451 tmp
.type
= PORT_16550A
;
2452 tmp
.line
= edge_port
->port
->minor
;
2453 tmp
.port
= edge_port
->port
->port_number
;
2455 tmp
.xmit_fifo_size
= edge_port
->port
->bulk_out_size
;
2456 tmp
.baud_base
= 9600;
2457 tmp
.close_delay
= 5*HZ
;
2458 tmp
.closing_wait
= cwait
;
2460 if (copy_to_user(retinfo
, &tmp
, sizeof(*retinfo
)))
2465 static int edge_ioctl(struct tty_struct
*tty
,
2466 unsigned int cmd
, unsigned long arg
)
2468 struct usb_serial_port
*port
= tty
->driver_data
;
2469 struct edgeport_port
*edge_port
= usb_get_serial_port_data(port
);
2473 dev_dbg(&port
->dev
, "%s - TIOCGSERIAL\n", __func__
);
2474 return get_serial_info(edge_port
,
2475 (struct serial_struct __user
*) arg
);
2477 return -ENOIOCTLCMD
;
2480 static void edge_break(struct tty_struct
*tty
, int break_state
)
2482 struct usb_serial_port
*port
= tty
->driver_data
;
2483 struct edgeport_port
*edge_port
= usb_get_serial_port_data(port
);
2485 int bv
= 0; /* Off */
2487 if (break_state
== -1)
2489 status
= ti_do_config(edge_port
, UMPC_SET_CLR_BREAK
, bv
);
2491 dev_dbg(&port
->dev
, "%s - error %d sending break set/clear command.\n",
2495 static void edge_heartbeat_schedule(struct edgeport_serial
*edge_serial
)
2497 if (!edge_serial
->use_heartbeat
)
2500 schedule_delayed_work(&edge_serial
->heartbeat_work
,
2501 FW_HEARTBEAT_SECS
* HZ
);
2504 static void edge_heartbeat_work(struct work_struct
*work
)
2506 struct edgeport_serial
*serial
;
2507 struct ti_i2c_desc
*rom_desc
;
2509 serial
= container_of(work
, struct edgeport_serial
,
2510 heartbeat_work
.work
);
2512 rom_desc
= kmalloc(sizeof(*rom_desc
), GFP_KERNEL
);
2514 /* Descriptor address request is enough to reset the firmware timer */
2515 if (!rom_desc
|| !get_descriptor_addr(serial
, I2C_DESC_TYPE_ION
,
2517 dev_err(&serial
->serial
->interface
->dev
,
2518 "%s - Incomplete heartbeat\n", __func__
);
2522 edge_heartbeat_schedule(serial
);
2525 static int edge_calc_num_ports(struct usb_serial
*serial
,
2526 struct usb_serial_endpoints
*epds
)
2528 struct device
*dev
= &serial
->interface
->dev
;
2529 unsigned char num_ports
= serial
->type
->num_ports
;
2531 /* Make sure we have the required endpoints when in download mode. */
2532 if (serial
->interface
->cur_altsetting
->desc
.bNumEndpoints
> 1) {
2533 if (epds
->num_bulk_in
< num_ports
||
2534 epds
->num_bulk_out
< num_ports
||
2535 epds
->num_interrupt_in
< 1) {
2536 dev_err(dev
, "required endpoints missing\n");
2544 static int edge_startup(struct usb_serial
*serial
)
2546 struct edgeport_serial
*edge_serial
;
2550 /* create our private serial structure */
2551 edge_serial
= kzalloc(sizeof(struct edgeport_serial
), GFP_KERNEL
);
2555 mutex_init(&edge_serial
->es_lock
);
2556 edge_serial
->serial
= serial
;
2557 INIT_DELAYED_WORK(&edge_serial
->heartbeat_work
, edge_heartbeat_work
);
2558 usb_set_serial_data(serial
, edge_serial
);
2560 status
= download_fw(edge_serial
);
2567 return 1; /* bind but do not register any ports */
2569 product_id
= le16_to_cpu(
2570 edge_serial
->serial
->dev
->descriptor
.idProduct
);
2572 /* Currently only the EP/416 models require heartbeat support */
2573 if (edge_serial
->fw_version
> FW_HEARTBEAT_VERSION_CUTOFF
) {
2574 if (product_id
== ION_DEVICE_ID_TI_EDGEPORT_416
||
2575 product_id
== ION_DEVICE_ID_TI_EDGEPORT_416B
) {
2576 edge_serial
->use_heartbeat
= true;
2580 edge_heartbeat_schedule(edge_serial
);
2585 static void edge_disconnect(struct usb_serial
*serial
)
2587 struct edgeport_serial
*edge_serial
= usb_get_serial_data(serial
);
2589 cancel_delayed_work_sync(&edge_serial
->heartbeat_work
);
2592 static void edge_release(struct usb_serial
*serial
)
2594 struct edgeport_serial
*edge_serial
= usb_get_serial_data(serial
);
2596 cancel_delayed_work_sync(&edge_serial
->heartbeat_work
);
2600 static int edge_port_probe(struct usb_serial_port
*port
)
2602 struct edgeport_port
*edge_port
;
2605 edge_port
= kzalloc(sizeof(*edge_port
), GFP_KERNEL
);
2609 spin_lock_init(&edge_port
->ep_lock
);
2610 edge_port
->port
= port
;
2611 edge_port
->edge_serial
= usb_get_serial_data(port
->serial
);
2612 edge_port
->bUartMode
= default_uart_mode
;
2614 switch (port
->port_number
) {
2616 edge_port
->uart_base
= UMPMEM_BASE_UART1
;
2617 edge_port
->dma_address
= UMPD_OEDB1_ADDRESS
;
2620 edge_port
->uart_base
= UMPMEM_BASE_UART2
;
2621 edge_port
->dma_address
= UMPD_OEDB2_ADDRESS
;
2624 dev_err(&port
->dev
, "unknown port number\n");
2630 "%s - port_number = %d, uart_base = %04x, dma_address = %04x\n",
2631 __func__
, port
->port_number
, edge_port
->uart_base
,
2632 edge_port
->dma_address
);
2634 usb_set_serial_port_data(port
, edge_port
);
2636 ret
= edge_create_sysfs_attrs(port
);
2640 port
->port
.closing_wait
= msecs_to_jiffies(closing_wait
* 10);
2641 port
->port
.drain_delay
= 1;
2650 static int edge_port_remove(struct usb_serial_port
*port
)
2652 struct edgeport_port
*edge_port
;
2654 edge_port
= usb_get_serial_port_data(port
);
2655 edge_remove_sysfs_attrs(port
);
2661 /* Sysfs Attributes */
2663 static ssize_t
uart_mode_show(struct device
*dev
,
2664 struct device_attribute
*attr
, char *buf
)
2666 struct usb_serial_port
*port
= to_usb_serial_port(dev
);
2667 struct edgeport_port
*edge_port
= usb_get_serial_port_data(port
);
2669 return sprintf(buf
, "%d\n", edge_port
->bUartMode
);
2672 static ssize_t
uart_mode_store(struct device
*dev
,
2673 struct device_attribute
*attr
, const char *valbuf
, size_t count
)
2675 struct usb_serial_port
*port
= to_usb_serial_port(dev
);
2676 struct edgeport_port
*edge_port
= usb_get_serial_port_data(port
);
2677 unsigned int v
= simple_strtoul(valbuf
, NULL
, 0);
2679 dev_dbg(dev
, "%s: setting uart_mode = %d\n", __func__
, v
);
2682 edge_port
->bUartMode
= v
;
2684 dev_err(dev
, "%s - uart_mode %d is invalid\n", __func__
, v
);
2688 static DEVICE_ATTR_RW(uart_mode
);
2690 static int edge_create_sysfs_attrs(struct usb_serial_port
*port
)
2692 return device_create_file(&port
->dev
, &dev_attr_uart_mode
);
2695 static int edge_remove_sysfs_attrs(struct usb_serial_port
*port
)
2697 device_remove_file(&port
->dev
, &dev_attr_uart_mode
);
2702 static int edge_suspend(struct usb_serial
*serial
, pm_message_t message
)
2704 struct edgeport_serial
*edge_serial
= usb_get_serial_data(serial
);
2706 cancel_delayed_work_sync(&edge_serial
->heartbeat_work
);
2711 static int edge_resume(struct usb_serial
*serial
)
2713 struct edgeport_serial
*edge_serial
= usb_get_serial_data(serial
);
2715 edge_heartbeat_schedule(edge_serial
);
2721 static struct usb_serial_driver edgeport_1port_device
= {
2723 .owner
= THIS_MODULE
,
2724 .name
= "edgeport_ti_1",
2726 .description
= "Edgeport TI 1 port adapter",
2727 .id_table
= edgeport_1port_id_table
,
2731 .close
= edge_close
,
2732 .throttle
= edge_throttle
,
2733 .unthrottle
= edge_unthrottle
,
2734 .attach
= edge_startup
,
2735 .calc_num_ports
= edge_calc_num_ports
,
2736 .disconnect
= edge_disconnect
,
2737 .release
= edge_release
,
2738 .port_probe
= edge_port_probe
,
2739 .port_remove
= edge_port_remove
,
2740 .ioctl
= edge_ioctl
,
2741 .set_termios
= edge_set_termios
,
2742 .tiocmget
= edge_tiocmget
,
2743 .tiocmset
= edge_tiocmset
,
2744 .tiocmiwait
= usb_serial_generic_tiocmiwait
,
2745 .get_icount
= usb_serial_generic_get_icount
,
2746 .write
= edge_write
,
2747 .write_room
= edge_write_room
,
2748 .chars_in_buffer
= edge_chars_in_buffer
,
2749 .tx_empty
= edge_tx_empty
,
2750 .break_ctl
= edge_break
,
2751 .read_int_callback
= edge_interrupt_callback
,
2752 .read_bulk_callback
= edge_bulk_in_callback
,
2753 .write_bulk_callback
= edge_bulk_out_callback
,
2755 .suspend
= edge_suspend
,
2756 .resume
= edge_resume
,
2760 static struct usb_serial_driver edgeport_2port_device
= {
2762 .owner
= THIS_MODULE
,
2763 .name
= "edgeport_ti_2",
2765 .description
= "Edgeport TI 2 port adapter",
2766 .id_table
= edgeport_2port_id_table
,
2770 .close
= edge_close
,
2771 .throttle
= edge_throttle
,
2772 .unthrottle
= edge_unthrottle
,
2773 .attach
= edge_startup
,
2774 .calc_num_ports
= edge_calc_num_ports
,
2775 .disconnect
= edge_disconnect
,
2776 .release
= edge_release
,
2777 .port_probe
= edge_port_probe
,
2778 .port_remove
= edge_port_remove
,
2779 .ioctl
= edge_ioctl
,
2780 .set_termios
= edge_set_termios
,
2781 .tiocmget
= edge_tiocmget
,
2782 .tiocmset
= edge_tiocmset
,
2783 .tiocmiwait
= usb_serial_generic_tiocmiwait
,
2784 .get_icount
= usb_serial_generic_get_icount
,
2785 .write
= edge_write
,
2786 .write_room
= edge_write_room
,
2787 .chars_in_buffer
= edge_chars_in_buffer
,
2788 .tx_empty
= edge_tx_empty
,
2789 .break_ctl
= edge_break
,
2790 .read_int_callback
= edge_interrupt_callback
,
2791 .read_bulk_callback
= edge_bulk_in_callback
,
2792 .write_bulk_callback
= edge_bulk_out_callback
,
2794 .suspend
= edge_suspend
,
2795 .resume
= edge_resume
,
2799 static struct usb_serial_driver
* const serial_drivers
[] = {
2800 &edgeport_1port_device
, &edgeport_2port_device
, NULL
2803 module_usb_serial_driver(serial_drivers
, id_table_combined
);
2805 MODULE_AUTHOR(DRIVER_AUTHOR
);
2806 MODULE_DESCRIPTION(DRIVER_DESC
);
2807 MODULE_LICENSE("GPL");
2808 MODULE_FIRMWARE("edgeport/down3.bin");
2810 module_param(closing_wait
, int, S_IRUGO
| S_IWUSR
);
2811 MODULE_PARM_DESC(closing_wait
, "Maximum wait for data to drain, in .01 secs");
2813 module_param(ignore_cpu_rev
, bool, S_IRUGO
| S_IWUSR
);
2814 MODULE_PARM_DESC(ignore_cpu_rev
,
2815 "Ignore the cpu revision when connecting to a device");
2817 module_param(default_uart_mode
, int, S_IRUGO
| S_IWUSR
);
2818 MODULE_PARM_DESC(default_uart_mode
, "Default uart_mode, 0=RS232, ...");