1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3 * Edgeport USB Serial Converter driver
4 *
5 * Copyright (C) 2000-2002 Inside Out Networks, All rights reserved.
6 * Copyright (C) 2001-2002 Greg Kroah-Hartman <greg@kroah.com>
7 *
8 * Supports the following devices:
9 * EP/1 EP/2 EP/4 EP/21 EP/22 EP/221 EP/42 EP/421 WATCHPORT
10 *
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>.
14 */
15
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>
34
35 #include "io_16654.h"
36 #include "io_usbvend.h"
37 #include "io_ti.h"
38
39 #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com> and David Iacovelli"
40 #define DRIVER_DESC "Edgeport USB Serial Driver"
41
42 #define EPROM_PAGE_SIZE 64
43
44
45 /* different hardware types */
46 #define HARDWARE_TYPE_930 0
47 #define HARDWARE_TYPE_TIUMP 1
48
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
56 */
57
58 /* read urb state */
59 #define EDGE_READ_URB_RUNNING 0
60 #define EDGE_READ_URB_STOPPING 1
61 #define EDGE_READ_URB_STOPPED 2
62
63 #define EDGE_CLOSING_WAIT 4000 /* in .01 sec */
64
65
66 /* Product information read from the Edgeport */
67 struct product_info {
68 int TiMode; /* Current TI Mode */
69 __u8 hardware_type; /* Type of hardware */
70 } __attribute__((packed));
71
72 /*
73 * Edgeport firmware header
74 *
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.
77 *
78 * "length" is the number of bytes of actual data following the header.
79 *
80 * "checksum" is the low order byte resulting from adding the values of
81 * all the data bytes.
82 */
83 struct edgeport_fw_hdr {
84 u8 major_version;
85 u8 minor_version;
86 __le16 build_number;
87 __le16 length;
88 u8 checksum;
89 } __packed;
90
91 struct edgeport_port {
92 __u16 uart_base;
93 __u16 dma_address;
94 __u8 shadow_msr;
95 __u8 shadow_mcr;
96 __u8 shadow_lsr;
97 __u8 lsr_mask;
98 __u32 ump_read_timeout; /*
99 * Number of milliseconds the UMP will
100 * wait without data before completing
101 * a read short
102 */
103 int baud_rate;
104 int close_pending;
105 int lsr_event;
106
107 struct edgeport_serial *edge_serial;
108 struct usb_serial_port *port;
109 __u8 bUartMode; /* Port type, 0: RS232, etc. */
110 spinlock_t ep_lock;
111 int ep_read_urb_state;
112 int ep_write_urb_in_use;
113 };
114
115 struct edgeport_serial {
116 struct product_info product_info;
117 u8 TI_I2C_Type; /* Type of I2C in UMP */
118 u8 TiReadI2C; /*
119 * Set to TRUE if we have read the
120 * I2c in Boot Mode
121 */
122 struct mutex es_lock;
123 int num_ports_open;
124 struct usb_serial *serial;
125 struct delayed_work heartbeat_work;
126 int fw_version;
127 bool use_heartbeat;
128 };
129
130
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) },
149 { }
150 };
151
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) },
171 { }
172 };
173
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) },
209 { }
210 };
211
212 MODULE_DEVICE_TABLE(usb, id_table_combined);
213
214 static int closing_wait = EDGE_CLOSING_WAIT;
215 static bool ignore_cpu_rev;
216 static int default_uart_mode; /* RS232 */
217
218 static void edge_tty_recv(struct usb_serial_port *port, unsigned char *data,
219 int length);
220
221 static void stop_read(struct edgeport_port *edge_port);
222 static int restart_read(struct edgeport_port *edge_port);
223
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);
227
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);
232
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);
236
237 /*
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:
243 *
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
248 * enough.
249 * 2. The heartbeat code is currently required only on Edgeport/416 models.
250 */
251 #define FW_HEARTBEAT_VERSION_CUTOFF ((4 << 8) + 80)
252 #define FW_HEARTBEAT_SECS 40
253
254 /* Timeouts in msecs: firmware downloads take longer */
255 #define TI_VSEND_TIMEOUT_DEFAULT 1000
256 #define TI_VSEND_TIMEOUT_FW_DOWNLOAD 10000
257
ti_vread_sync(struct usb_device * dev,__u8 request,__u16 value,__u16 index,u8 * data,int size)258 static int ti_vread_sync(struct usb_device *dev, __u8 request,
259 __u16 value, __u16 index, u8 *data, int size)
260 {
261 int status;
262
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);
266 if (status < 0)
267 return status;
268 if (status != size) {
269 dev_dbg(&dev->dev, "%s - wanted to write %d, but only wrote %d\n",
270 __func__, size, status);
271 return -ECOMM;
272 }
273 return 0;
274 }
275
ti_vsend_sync(struct usb_device * dev,u8 request,u16 value,u16 index,u8 * data,int size,int timeout)276 static int ti_vsend_sync(struct usb_device *dev, u8 request, u16 value,
277 u16 index, u8 *data, int size, int timeout)
278 {
279 int status;
280
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);
284 if (status < 0)
285 return status;
286 if (status != size) {
287 dev_dbg(&dev->dev, "%s - wanted to write %d, but only wrote %d\n",
288 __func__, size, status);
289 return -ECOMM;
290 }
291 return 0;
292 }
293
send_cmd(struct usb_device * dev,__u8 command,__u8 moduleid,__u16 value,u8 * data,int size)294 static int send_cmd(struct usb_device *dev, __u8 command,
295 __u8 moduleid, __u16 value, u8 *data,
296 int size)
297 {
298 return ti_vsend_sync(dev, command, value, moduleid, data, size,
299 TI_VSEND_TIMEOUT_DEFAULT);
300 }
301
302 /* clear tx/rx buffers and fifo in TI UMP */
purge_port(struct usb_serial_port * port,__u16 mask)303 static int purge_port(struct usb_serial_port *port, __u16 mask)
304 {
305 int port_number = port->port_number;
306
307 dev_dbg(&port->dev, "%s - port %d, mask %x\n", __func__, port_number, mask);
308
309 return send_cmd(port->serial->dev,
310 UMPC_PURGE_PORT,
311 (__u8)(UMPM_UART1_PORT + port_number),
312 mask,
313 NULL,
314 0);
315 }
316
317 /**
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
324 */
read_download_mem(struct usb_device * dev,int start_address,int length,__u8 address_type,__u8 * buffer)325 static int read_download_mem(struct usb_device *dev, int start_address,
326 int length, __u8 address_type, __u8 *buffer)
327 {
328 int status = 0;
329 __u8 read_length;
330 u16 be_start_address;
331
332 dev_dbg(&dev->dev, "%s - @ %x for %d\n", __func__, start_address, length);
333
334 /*
335 * Read in blocks of 64 bytes
336 * (TI firmware can't handle more than 64 byte reads)
337 */
338 while (length) {
339 if (length > 64)
340 read_length = 64;
341 else
342 read_length = (__u8)length;
343
344 if (read_length > 1) {
345 dev_dbg(&dev->dev, "%s - @ %x for %d\n", __func__, start_address, read_length);
346 }
347 /*
348 * NOTE: Must use swab as wIndex is sent in little-endian
349 * byte order regardless of host byte order.
350 */
351 be_start_address = swab16((u16)start_address);
352 status = ti_vread_sync(dev, UMPC_MEMORY_READ,
353 (__u16)address_type,
354 be_start_address,
355 buffer, read_length);
356
357 if (status) {
358 dev_dbg(&dev->dev, "%s - ERROR %x\n", __func__, status);
359 return status;
360 }
361
362 if (read_length > 1)
363 usb_serial_debug_data(&dev->dev, __func__, read_length, buffer);
364
365 /* Update pointers/length */
366 start_address += read_length;
367 buffer += read_length;
368 length -= read_length;
369 }
370
371 return status;
372 }
373
read_ram(struct usb_device * dev,int start_address,int length,__u8 * buffer)374 static int read_ram(struct usb_device *dev, int start_address,
375 int length, __u8 *buffer)
376 {
377 return read_download_mem(dev, start_address, length,
378 DTK_ADDR_SPACE_XDATA, buffer);
379 }
380
381 /* Read edgeport memory to a given block */
read_boot_mem(struct edgeport_serial * serial,int start_address,int length,__u8 * buffer)382 static int read_boot_mem(struct edgeport_serial *serial,
383 int start_address, int length, __u8 *buffer)
384 {
385 int status = 0;
386 int i;
387
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);
392 if (status) {
393 dev_dbg(&serial->serial->dev->dev, "%s - ERROR %x\n", __func__, status);
394 return status;
395 }
396 }
397
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);
401
402 serial->TiReadI2C = 1;
403
404 return status;
405 }
406
407 /* Write given block to TI EPROM memory */
write_boot_mem(struct edgeport_serial * serial,int start_address,int length,__u8 * buffer)408 static int write_boot_mem(struct edgeport_serial *serial,
409 int start_address, int length, __u8 *buffer)
410 {
411 int status = 0;
412 int i;
413 u8 *temp;
414
415 /* Must do a read before write */
416 if (!serial->TiReadI2C) {
417 temp = kmalloc(1, GFP_KERNEL);
418 if (!temp)
419 return -ENOMEM;
420
421 status = read_boot_mem(serial, 0, 1, temp);
422 kfree(temp);
423 if (status)
424 return status;
425 }
426
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);
431 if (status)
432 return status;
433 }
434
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);
437
438 return status;
439 }
440
441 /* Write edgeport I2C memory to TI chip */
write_i2c_mem(struct edgeport_serial * serial,int start_address,int length,__u8 address_type,__u8 * buffer)442 static int write_i2c_mem(struct edgeport_serial *serial,
443 int start_address, int length, __u8 address_type, __u8 *buffer)
444 {
445 struct device *dev = &serial->serial->dev->dev;
446 int status = 0;
447 int write_length;
448 u16 be_start_address;
449
450 /* We can only send a maximum of 1 aligned byte page at a time */
451
452 /* calculate the number of bytes left in the first page */
453 write_length = EPROM_PAGE_SIZE -
454 (start_address & (EPROM_PAGE_SIZE - 1));
455
456 if (write_length > length)
457 write_length = length;
458
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);
462
463 /*
464 * Write first page.
465 *
466 * NOTE: Must use swab as wIndex is sent in little-endian byte order
467 * regardless of host byte order.
468 */
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);
473 if (status) {
474 dev_dbg(dev, "%s - ERROR %d\n", __func__, status);
475 return status;
476 }
477
478 length -= write_length;
479 start_address += write_length;
480 buffer += write_length;
481
482 /*
483 * We should be aligned now -- can write max page size bytes at a
484 * time.
485 */
486 while (length) {
487 if (length > EPROM_PAGE_SIZE)
488 write_length = EPROM_PAGE_SIZE;
489 else
490 write_length = length;
491
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);
495
496 /*
497 * Write next page.
498 *
499 * NOTE: Must use swab as wIndex is sent in little-endian byte
500 * order regardless of host byte order.
501 */
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);
506 if (status) {
507 dev_err(dev, "%s - ERROR %d\n", __func__, status);
508 return status;
509 }
510
511 length -= write_length;
512 start_address += write_length;
513 buffer += write_length;
514 }
515 return status;
516 }
517
518 /*
519 * Examine the UMP DMA registers and LSR
520 *
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.
524 */
tx_active(struct edgeport_port * port)525 static int tx_active(struct edgeport_port *port)
526 {
527 int status;
528 struct out_endpoint_desc_block *oedb;
529 __u8 *lsr;
530 int bytes_left = 0;
531
532 oedb = kmalloc(sizeof(*oedb), GFP_KERNEL);
533 if (!oedb)
534 return -ENOMEM;
535
536 /*
537 * Sigh, that's right, just one byte, as not all platforms can
538 * do DMA from stack
539 */
540 lsr = kmalloc(1, GFP_KERNEL);
541 if (!lsr) {
542 kfree(oedb);
543 return -ENOMEM;
544 }
545 /* Read the DMA Count Registers */
546 status = read_ram(port->port->serial->dev, port->dma_address,
547 sizeof(*oedb), (void *)oedb);
548 if (status)
549 goto exit_is_tx_active;
550
551 dev_dbg(&port->port->dev, "%s - XByteCount 0x%X\n", __func__, oedb->XByteCount);
552
553 /* and the LSR */
554 status = read_ram(port->port->serial->dev,
555 port->uart_base + UMPMEM_OFFS_UART_LSR, 1, lsr);
556
557 if (status)
558 goto exit_is_tx_active;
559 dev_dbg(&port->port->dev, "%s - LSR = 0x%X\n", __func__, *lsr);
560
561 /* If either buffer has data or we are transmitting then return TRUE */
562 if ((oedb->XByteCount & 0x80) != 0)
563 bytes_left += 64;
564
565 if ((*lsr & UMP_UART_LSR_TX_MASK) == 0)
566 bytes_left += 1;
567
568 /* We return Not Active if we get any kind of error */
569 exit_is_tx_active:
570 dev_dbg(&port->port->dev, "%s - return %d\n", __func__, bytes_left);
571
572 kfree(lsr);
573 kfree(oedb);
574 return bytes_left;
575 }
576
choose_config(struct usb_device * dev)577 static int choose_config(struct usb_device *dev)
578 {
579 /*
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.
584 */
585
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);
590
591 if (dev->config->desc.bNumInterfaces != 1) {
592 dev_err(&dev->dev, "%s - bNumInterfaces is not 1, ERROR!\n", __func__);
593 return -ENODEV;
594 }
595
596 return 0;
597 }
598
read_rom(struct edgeport_serial * serial,int start_address,int length,__u8 * buffer)599 static int read_rom(struct edgeport_serial *serial,
600 int start_address, int length, __u8 *buffer)
601 {
602 int status;
603
604 if (serial->product_info.TiMode == TI_MODE_DOWNLOAD) {
605 status = read_download_mem(serial->serial->dev,
606 start_address,
607 length,
608 serial->TI_I2C_Type,
609 buffer);
610 } else {
611 status = read_boot_mem(serial, start_address, length,
612 buffer);
613 }
614 return status;
615 }
616
write_rom(struct edgeport_serial * serial,int start_address,int length,__u8 * buffer)617 static int write_rom(struct edgeport_serial *serial, int start_address,
618 int length, __u8 *buffer)
619 {
620 if (serial->product_info.TiMode == TI_MODE_BOOT)
621 return write_boot_mem(serial, start_address, length,
622 buffer);
623
624 if (serial->product_info.TiMode == TI_MODE_DOWNLOAD)
625 return write_i2c_mem(serial, start_address, length,
626 serial->TI_I2C_Type, buffer);
627 return -EINVAL;
628 }
629
630 /* Read a descriptor header from I2C based on type */
get_descriptor_addr(struct edgeport_serial * serial,int desc_type,struct ti_i2c_desc * rom_desc)631 static int get_descriptor_addr(struct edgeport_serial *serial,
632 int desc_type, struct ti_i2c_desc *rom_desc)
633 {
634 int start_address;
635 int status;
636
637 /* Search for requested descriptor in I2C */
638 start_address = 2;
639 do {
640 status = read_rom(serial,
641 start_address,
642 sizeof(struct ti_i2c_desc),
643 (__u8 *)rom_desc);
644 if (status)
645 return 0;
646
647 if (rom_desc->Type == desc_type)
648 return start_address;
649
650 start_address = start_address + sizeof(struct ti_i2c_desc) +
651 le16_to_cpu(rom_desc->Size);
652
653 } while ((start_address < TI_MAX_I2C_SIZE) && rom_desc->Type);
654
655 return 0;
656 }
657
658 /* Validate descriptor checksum */
valid_csum(struct ti_i2c_desc * rom_desc,__u8 * buffer)659 static int valid_csum(struct ti_i2c_desc *rom_desc, __u8 *buffer)
660 {
661 __u16 i;
662 __u8 cs = 0;
663
664 for (i = 0; i < le16_to_cpu(rom_desc->Size); i++)
665 cs = (__u8)(cs + buffer[i]);
666
667 if (cs != rom_desc->CheckSum) {
668 pr_debug("%s - Mismatch %x - %x", __func__, rom_desc->CheckSum, cs);
669 return -EINVAL;
670 }
671 return 0;
672 }
673
674 /* Make sure that the I2C image is good */
check_i2c_image(struct edgeport_serial * serial)675 static int check_i2c_image(struct edgeport_serial *serial)
676 {
677 struct device *dev = &serial->serial->dev->dev;
678 int status = 0;
679 struct ti_i2c_desc *rom_desc;
680 int start_address = 2;
681 __u8 *buffer;
682 __u16 ttype;
683
684 rom_desc = kmalloc(sizeof(*rom_desc), GFP_KERNEL);
685 if (!rom_desc)
686 return -ENOMEM;
687
688 buffer = kmalloc(TI_MAX_I2C_SIZE, GFP_KERNEL);
689 if (!buffer) {
690 kfree(rom_desc);
691 return -ENOMEM;
692 }
693
694 /* Read the first byte (Signature0) must be 0x52 or 0x10 */
695 status = read_rom(serial, 0, 1, buffer);
696 if (status)
697 goto out;
698
699 if (*buffer != UMP5152 && *buffer != UMP3410) {
700 dev_err(dev, "%s - invalid buffer signature\n", __func__);
701 status = -ENODEV;
702 goto out;
703 }
704
705 do {
706 /* Validate the I2C */
707 status = read_rom(serial,
708 start_address,
709 sizeof(struct ti_i2c_desc),
710 (__u8 *)rom_desc);
711 if (status)
712 break;
713
714 if ((start_address + sizeof(struct ti_i2c_desc) +
715 le16_to_cpu(rom_desc->Size)) > TI_MAX_I2C_SIZE) {
716 status = -ENODEV;
717 dev_dbg(dev, "%s - structure too big, erroring out.\n", __func__);
718 break;
719 }
720
721 dev_dbg(dev, "%s Type = 0x%x\n", __func__, rom_desc->Type);
722
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),
731 buffer);
732 if (status)
733 break;
734
735 status = valid_csum(rom_desc, buffer);
736 if (status)
737 break;
738 }
739 start_address = start_address + sizeof(struct ti_i2c_desc) +
740 le16_to_cpu(rom_desc->Size);
741
742 } while ((rom_desc->Type != I2C_DESC_TYPE_ION) &&
743 (start_address < TI_MAX_I2C_SIZE));
744
745 if ((rom_desc->Type != I2C_DESC_TYPE_ION) ||
746 (start_address > TI_MAX_I2C_SIZE))
747 status = -ENODEV;
748
749 out:
750 kfree(buffer);
751 kfree(rom_desc);
752 return status;
753 }
754
get_manuf_info(struct edgeport_serial * serial,__u8 * buffer)755 static int get_manuf_info(struct edgeport_serial *serial, __u8 *buffer)
756 {
757 int status;
758 int start_address;
759 struct ti_i2c_desc *rom_desc;
760 struct edge_ti_manuf_descriptor *desc;
761 struct device *dev = &serial->serial->dev->dev;
762
763 rom_desc = kmalloc(sizeof(*rom_desc), GFP_KERNEL);
764 if (!rom_desc)
765 return -ENOMEM;
766
767 start_address = get_descriptor_addr(serial, I2C_DESC_TYPE_ION,
768 rom_desc);
769
770 if (!start_address) {
771 dev_dbg(dev, "%s - Edge Descriptor not found in I2C\n", __func__);
772 status = -ENODEV;
773 goto exit;
774 }
775
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);
779 if (status)
780 goto exit;
781
782 status = valid_csum(rom_desc, buffer);
783
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);
791
792 exit:
793 kfree(rom_desc);
794 return status;
795 }
796
797 /* Build firmware header used for firmware update */
build_i2c_fw_hdr(u8 * header,const struct firmware * fw)798 static int build_i2c_fw_hdr(u8 *header, const struct firmware *fw)
799 {
800 __u8 *buffer;
801 int buffer_size;
802 int i;
803 __u8 cs = 0;
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;
808
809 /*
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.
817 */
818
819 /*
820 * Allocate a 15.5k buffer + 2 bytes for version number (Firmware
821 * Record)
822 */
823 buffer_size = (((1024 * 16) - 512 ) +
824 sizeof(struct ti_i2c_firmware_rec));
825
826 buffer = kmalloc(buffer_size, GFP_KERNEL);
827 if (!buffer)
828 return -ENOMEM;
829
830 /* Set entire image of 0xffs */
831 memset(buffer, 0xff, buffer_size);
832
833 /* Copy version number into firmware record */
834 firmware_rec = (struct ti_i2c_firmware_rec *)buffer;
835
836 firmware_rec->Ver_Major = fw_hdr->major_version;
837 firmware_rec->Ver_Minor = fw_hdr->minor_version;
838
839 /* Pointer to fw_down memory image */
840 img_header = (struct ti_i2c_image_header *)&fw->data[4];
841
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));
845
846 for (i=0; i < buffer_size; i++) {
847 cs = (__u8)(cs + buffer[i]);
848 }
849
850 kfree(buffer);
851
852 /* Build new header */
853 i2c_header = (struct ti_i2c_desc *)header;
854 firmware_rec = (struct ti_i2c_firmware_rec*)i2c_header->Data;
855
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;
861
862 return 0;
863 }
864
865 /* Try to figure out what type of I2c we have */
i2c_type_bootmode(struct edgeport_serial * serial)866 static int i2c_type_bootmode(struct edgeport_serial *serial)
867 {
868 struct device *dev = &serial->serial->dev->dev;
869 int status;
870 u8 *data;
871
872 data = kmalloc(1, GFP_KERNEL);
873 if (!data)
874 return -ENOMEM;
875
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);
879 if (status)
880 dev_dbg(dev, "%s - read 2 status error = %d\n", __func__, status);
881 else
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;
886 goto out;
887 }
888
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);
892 if (status)
893 dev_dbg(dev, "%s - read 3 status error = %d\n", __func__, status);
894 else
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;
899 goto out;
900 }
901
902 dev_dbg(dev, "%s - Unknown\n", __func__);
903 serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_II;
904 status = -ENODEV;
905 out:
906 kfree(data);
907 return status;
908 }
909
bulk_xfer(struct usb_serial * serial,void * buffer,int length,int * num_sent)910 static int bulk_xfer(struct usb_serial *serial, void *buffer,
911 int length, int *num_sent)
912 {
913 int status;
914
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);
919 return status;
920 }
921
922 /* Download given firmware image to the device (IN BOOT MODE) */
download_code(struct edgeport_serial * serial,__u8 * image,int image_length)923 static int download_code(struct edgeport_serial *serial, __u8 *image,
924 int image_length)
925 {
926 int status = 0;
927 int pos;
928 int transfer;
929 int done;
930
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;
937
938 /* Transfer data */
939 status = bulk_xfer(serial->serial, &image[pos],
940 transfer, &done);
941 if (status)
942 break;
943 /* Advance buffer pointer */
944 pos += done;
945 }
946
947 return status;
948 }
949
950 /* FIXME!!! */
config_boot_dev(struct usb_device * dev)951 static int config_boot_dev(struct usb_device *dev)
952 {
953 return 0;
954 }
955
ti_cpu_rev(struct edge_ti_manuf_descriptor * desc)956 static int ti_cpu_rev(struct edge_ti_manuf_descriptor *desc)
957 {
958 return TI_GET_CPU_REVISION(desc->CpuRev_BoardRev);
959 }
960
check_fw_sanity(struct edgeport_serial * serial,const struct firmware * fw)961 static int check_fw_sanity(struct edgeport_serial *serial,
962 const struct firmware *fw)
963 {
964 u16 length_total;
965 u8 checksum = 0;
966 int pos;
967 struct device *dev = &serial->serial->interface->dev;
968 struct edgeport_fw_hdr *fw_hdr = (struct edgeport_fw_hdr *)fw->data;
969
970 if (fw->size < sizeof(struct edgeport_fw_hdr)) {
971 dev_err(dev, "incomplete fw header\n");
972 return -EINVAL;
973 }
974
975 length_total = le16_to_cpu(fw_hdr->length) +
976 sizeof(struct edgeport_fw_hdr);
977
978 if (fw->size != length_total) {
979 dev_err(dev, "bad fw size (expected: %u, got: %zu)\n",
980 length_total, fw->size);
981 return -EINVAL;
982 }
983
984 for (pos = sizeof(struct edgeport_fw_hdr); pos < fw->size; ++pos)
985 checksum += fw->data[pos];
986
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);
990 return -EINVAL;
991 }
992
993 return 0;
994 }
995
996 /*
997 * DownloadTIFirmware - Download run-time operating firmware to the TI5052
998 *
999 * This routine downloads the main operating code into the TI5052, using the
1000 * boot code already burned into E2PROM or ROM.
1001 */
download_fw(struct edgeport_serial * serial)1002 static int download_fw(struct edgeport_serial *serial)
1003 {
1004 struct device *dev = &serial->serial->interface->dev;
1005 int status = 0;
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;
1010
1011 status = request_firmware(&fw, fw_name, dev);
1012 if (status) {
1013 dev_err(dev, "Failed to load image \"%s\" err %d\n",
1014 fw_name, status);
1015 return status;
1016 }
1017
1018 if (check_fw_sanity(serial, fw)) {
1019 status = -EINVAL;
1020 goto out;
1021 }
1022
1023 fw_hdr = (struct edgeport_fw_hdr *)fw->data;
1024
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;
1028
1029 /*
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
1033 */
1034 serial->product_info.hardware_type = HARDWARE_TYPE_TIUMP;
1035
1036 /* Default to type 2 i2c */
1037 serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_II;
1038
1039 status = choose_config(serial->serial->dev);
1040 if (status)
1041 goto out;
1042
1043 interface = &serial->serial->interface->cur_altsetting->desc;
1044 if (!interface) {
1045 dev_err(dev, "%s - no interface set, error!\n", __func__);
1046 status = -ENODEV;
1047 goto out;
1048 }
1049
1050 /*
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
1053 * mode
1054 */
1055 if (interface->bNumEndpoints > 1) {
1056 serial->product_info.TiMode = TI_MODE_DOWNLOAD;
1057 status = do_download_mode(serial, fw);
1058 } else {
1059 /* Otherwise we will remain in configuring mode */
1060 serial->product_info.TiMode = TI_MODE_CONFIGURING;
1061 status = do_boot_mode(serial, fw);
1062 }
1063
1064 out:
1065 release_firmware(fw);
1066 return status;
1067 }
1068
do_download_mode(struct edgeport_serial * serial,const struct firmware * fw)1069 static int do_download_mode(struct edgeport_serial *serial,
1070 const struct firmware *fw)
1071 {
1072 struct device *dev = &serial->serial->interface->dev;
1073 int status = 0;
1074 int start_address;
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;
1080
1081 dev_dbg(dev, "%s - RUNNING IN DOWNLOAD MODE\n", __func__);
1082
1083 status = check_i2c_image(serial);
1084 if (status) {
1085 dev_dbg(dev, "%s - DOWNLOAD MODE -- BAD I2C\n", __func__);
1086 return status;
1087 }
1088
1089 /*
1090 * Validate Hardware version number
1091 * Read Manufacturing Descriptor from TI Based Edgeport
1092 */
1093 ti_manuf_desc = kmalloc(sizeof(*ti_manuf_desc), GFP_KERNEL);
1094 if (!ti_manuf_desc)
1095 return -ENOMEM;
1096
1097 status = get_manuf_info(serial, (__u8 *)ti_manuf_desc);
1098 if (status) {
1099 kfree(ti_manuf_desc);
1100 return status;
1101 }
1102
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);
1108 return -EINVAL;
1109 }
1110
1111 rom_desc = kmalloc(sizeof(*rom_desc), GFP_KERNEL);
1112 if (!rom_desc) {
1113 kfree(ti_manuf_desc);
1114 return -ENOMEM;
1115 }
1116
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;
1122 u8 *record;
1123
1124 dev_dbg(dev, "%s - Found Type FIRMWARE (Type 2) record\n",
1125 __func__);
1126
1127 firmware_version = kmalloc(sizeof(*firmware_version),
1128 GFP_KERNEL);
1129 if (!firmware_version) {
1130 kfree(rom_desc);
1131 kfree(ti_manuf_desc);
1132 return -ENOMEM;
1133 }
1134
1135 /*
1136 * Validate version number
1137 * Read the descriptor data
1138 */
1139 status = read_rom(serial, start_address +
1140 sizeof(struct ti_i2c_desc),
1141 sizeof(struct ti_i2c_firmware_rec),
1142 (__u8 *)firmware_version);
1143 if (status) {
1144 kfree(firmware_version);
1145 kfree(rom_desc);
1146 kfree(ti_manuf_desc);
1147 return status;
1148 }
1149
1150 /*
1151 * Check version number of download with current
1152 * version in I2c
1153 */
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);
1158
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);
1163
1164 /*
1165 * Check if we have an old version in the I2C and
1166 * update if necessary
1167 */
1168 if (download_cur_ver < download_new_ver) {
1169 dev_dbg(dev, "%s - Update I2C dld from %d.%d to %d.%d\n",
1170 __func__,
1171 firmware_version->Ver_Major,
1172 firmware_version->Ver_Minor,
1173 fw_hdr->major_version,
1174 fw_hdr->minor_version);
1175
1176 record = kmalloc(1, GFP_KERNEL);
1177 if (!record) {
1178 kfree(firmware_version);
1179 kfree(rom_desc);
1180 kfree(ti_manuf_desc);
1181 return -ENOMEM;
1182 }
1183 /*
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
1194 * 0xf2 to 0x02.
1195 */
1196 *record = I2C_DESC_TYPE_FIRMWARE_BLANK;
1197
1198 /*
1199 * Change the I2C Firmware record type to
1200 * 0xf2 to trigger an update
1201 */
1202 status = write_rom(serial, start_address,
1203 sizeof(*record), record);
1204 if (status) {
1205 kfree(record);
1206 kfree(firmware_version);
1207 kfree(rom_desc);
1208 kfree(ti_manuf_desc);
1209 return status;
1210 }
1211
1212 /*
1213 * verify the write -- must do this in order
1214 * for write to complete before we do the
1215 * hardware reset
1216 */
1217 status = read_rom(serial,
1218 start_address,
1219 sizeof(*record),
1220 record);
1221 if (status) {
1222 kfree(record);
1223 kfree(firmware_version);
1224 kfree(rom_desc);
1225 kfree(ti_manuf_desc);
1226 return status;
1227 }
1228
1229 if (*record != I2C_DESC_TYPE_FIRMWARE_BLANK) {
1230 dev_err(dev, "%s - error resetting device\n",
1231 __func__);
1232 kfree(record);
1233 kfree(firmware_version);
1234 kfree(rom_desc);
1235 kfree(ti_manuf_desc);
1236 return -ENODEV;
1237 }
1238
1239 dev_dbg(dev, "%s - HARDWARE RESET\n", __func__);
1240
1241 /* Reset UMP -- Back to BOOT MODE */
1242 status = ti_vsend_sync(serial->serial->dev,
1243 UMPC_HARDWARE_RESET,
1244 0, 0, NULL, 0,
1245 TI_VSEND_TIMEOUT_DEFAULT);
1246
1247 dev_dbg(dev, "%s - HARDWARE RESET return %d\n",
1248 __func__, status);
1249
1250 /* return an error on purpose. */
1251 kfree(record);
1252 kfree(firmware_version);
1253 kfree(rom_desc);
1254 kfree(ti_manuf_desc);
1255 return -ENODEV;
1256 }
1257 /* Same or newer fw version is already loaded */
1258 serial->fw_version = download_cur_ver;
1259 kfree(firmware_version);
1260 }
1261 /* Search for type 0xF2 record (firmware blank record) */
1262 else {
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))
1268 __u8 *header;
1269 __u8 *vheader;
1270
1271 header = kmalloc(HEADER_SIZE, GFP_KERNEL);
1272 if (!header) {
1273 kfree(rom_desc);
1274 kfree(ti_manuf_desc);
1275 return -ENOMEM;
1276 }
1277
1278 vheader = kmalloc(HEADER_SIZE, GFP_KERNEL);
1279 if (!vheader) {
1280 kfree(header);
1281 kfree(rom_desc);
1282 kfree(ti_manuf_desc);
1283 return -ENOMEM;
1284 }
1285
1286 dev_dbg(dev, "%s - Found Type BLANK FIRMWARE (Type F2) record\n",
1287 __func__);
1288
1289 /*
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.
1299 */
1300 status = build_i2c_fw_hdr(header, fw);
1301 if (status) {
1302 kfree(vheader);
1303 kfree(header);
1304 kfree(rom_desc);
1305 kfree(ti_manuf_desc);
1306 return -EINVAL;
1307 }
1308
1309 /*
1310 * Update I2C with type 0xf2 record with correct
1311 * size and checksum
1312 */
1313 status = write_rom(serial,
1314 start_address,
1315 HEADER_SIZE,
1316 header);
1317 if (status) {
1318 kfree(vheader);
1319 kfree(header);
1320 kfree(rom_desc);
1321 kfree(ti_manuf_desc);
1322 return -EINVAL;
1323 }
1324
1325 /*
1326 * verify the write -- must do this in order for
1327 * write to complete before we do the hardware reset
1328 */
1329 status = read_rom(serial, start_address,
1330 HEADER_SIZE, vheader);
1331
1332 if (status) {
1333 dev_dbg(dev, "%s - can't read header back\n",
1334 __func__);
1335 kfree(vheader);
1336 kfree(header);
1337 kfree(rom_desc);
1338 kfree(ti_manuf_desc);
1339 return status;
1340 }
1341 if (memcmp(vheader, header, HEADER_SIZE)) {
1342 dev_dbg(dev, "%s - write download record failed\n",
1343 __func__);
1344 kfree(vheader);
1345 kfree(header);
1346 kfree(rom_desc);
1347 kfree(ti_manuf_desc);
1348 return -EINVAL;
1349 }
1350
1351 kfree(vheader);
1352 kfree(header);
1353
1354 dev_dbg(dev, "%s - Start firmware update\n", __func__);
1355
1356 /* Tell firmware to copy download image into I2C */
1357 status = ti_vsend_sync(serial->serial->dev,
1358 UMPC_COPY_DNLD_TO_I2C,
1359 0, 0, NULL, 0,
1360 TI_VSEND_TIMEOUT_FW_DOWNLOAD);
1361
1362 dev_dbg(dev, "%s - Update complete 0x%x\n", __func__,
1363 status);
1364 if (status) {
1365 dev_err(dev,
1366 "%s - UMPC_COPY_DNLD_TO_I2C failed\n",
1367 __func__);
1368 kfree(rom_desc);
1369 kfree(ti_manuf_desc);
1370 return status;
1371 }
1372 }
1373 }
1374
1375 /* The device is running the download code */
1376 kfree(rom_desc);
1377 kfree(ti_manuf_desc);
1378 return 0;
1379 }
1380
do_boot_mode(struct edgeport_serial * serial,const struct firmware * fw)1381 static int do_boot_mode(struct edgeport_serial *serial,
1382 const struct firmware *fw)
1383 {
1384 struct device *dev = &serial->serial->interface->dev;
1385 int status = 0;
1386 struct edge_ti_manuf_descriptor *ti_manuf_desc;
1387 struct edgeport_fw_hdr *fw_hdr = (struct edgeport_fw_hdr *)fw->data;
1388
1389 dev_dbg(dev, "%s - RUNNING IN BOOT MODE\n", __func__);
1390
1391 /* Configure the TI device so we can use the BULK pipes for download */
1392 status = config_boot_dev(serial->serial->dev);
1393 if (status)
1394 return status;
1395
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;
1402 }
1403
1404 /*
1405 * We have an ION device (I2c Must be programmed)
1406 * Determine I2C image type
1407 */
1408 if (i2c_type_bootmode(serial))
1409 goto stayinbootmode;
1410
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;
1414 int i;
1415 __u8 cs = 0;
1416 __u8 *buffer;
1417 int buffer_size;
1418
1419 /*
1420 * Validate Hardware version number
1421 * Read Manufacturing Descriptor from TI Based Edgeport
1422 */
1423 ti_manuf_desc = kmalloc(sizeof(*ti_manuf_desc), GFP_KERNEL);
1424 if (!ti_manuf_desc)
1425 return -ENOMEM;
1426
1427 status = get_manuf_info(serial, (__u8 *)ti_manuf_desc);
1428 if (status) {
1429 kfree(ti_manuf_desc);
1430 goto stayinbootmode;
1431 }
1432
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;
1439 }
1440
1441 kfree(ti_manuf_desc);
1442
1443 /*
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.
1452 *
1453 * Do we really have to copy the whole firmware image,
1454 * or could we do this in place!
1455 */
1456
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);
1461 if (!buffer)
1462 return -ENOMEM;
1463
1464 /* Initialize the buffer to 0xff (pad the buffer) */
1465 memset(buffer, 0xff, buffer_size);
1466 memcpy(buffer, &fw->data[4], fw->size - 4);
1467
1468 for (i = sizeof(struct ti_i2c_image_header);
1469 i < buffer_size; i++) {
1470 cs = (__u8)(cs + buffer[i]);
1471 }
1472
1473 header = (struct ti_i2c_image_header *)buffer;
1474
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;
1479
1480 /* Download the operational code */
1481 dev_dbg(dev, "%s - Downloading operational code image version %d.%d (TI UMP)\n",
1482 __func__,
1483 fw_hdr->major_version, fw_hdr->minor_version);
1484 status = download_code(serial, buffer, buffer_size);
1485
1486 kfree(buffer);
1487
1488 if (status) {
1489 dev_dbg(dev, "%s - Error downloading operational code image\n", __func__);
1490 return status;
1491 }
1492
1493 /* Device will reboot */
1494 serial->product_info.TiMode = TI_MODE_TRANSITIONING;
1495
1496 dev_dbg(dev, "%s - Download successful -- Device rebooting...\n", __func__);
1497
1498 return 1;
1499 }
1500
1501 stayinbootmode:
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;
1505
1506 return 1;
1507 }
1508
ti_do_config(struct edgeport_port * port,int feature,int on)1509 static int ti_do_config(struct edgeport_port *port, int feature, int on)
1510 {
1511 int port_number = port->port->port_number;
1512
1513 on = !!on; /* 1 or 0 not bitmask */
1514 return send_cmd(port->port->serial->dev,
1515 feature, (__u8)(UMPM_UART1_PORT + port_number),
1516 on, NULL, 0);
1517 }
1518
restore_mcr(struct edgeport_port * port,__u8 mcr)1519 static int restore_mcr(struct edgeport_port *port, __u8 mcr)
1520 {
1521 int status = 0;
1522
1523 dev_dbg(&port->port->dev, "%s - %x\n", __func__, mcr);
1524
1525 status = ti_do_config(port, UMPC_SET_CLR_DTR, mcr & MCR_DTR);
1526 if (status)
1527 return status;
1528 status = ti_do_config(port, UMPC_SET_CLR_RTS, mcr & MCR_RTS);
1529 if (status)
1530 return status;
1531 return ti_do_config(port, UMPC_SET_CLR_LOOPBACK, mcr & MCR_LOOPBACK);
1532 }
1533
1534 /* Convert TI LSR to standard UART flags */
map_line_status(__u8 ti_lsr)1535 static __u8 map_line_status(__u8 ti_lsr)
1536 {
1537 __u8 lsr = 0;
1538
1539 #define MAP_FLAG(flagUmp, flagUart) \
1540 if (ti_lsr & flagUmp) \
1541 lsr |= flagUart;
1542
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 */
1549
1550 #undef MAP_FLAG
1551
1552 return lsr;
1553 }
1554
handle_new_msr(struct edgeport_port * edge_port,__u8 msr)1555 static void handle_new_msr(struct edgeport_port *edge_port, __u8 msr)
1556 {
1557 struct async_icount *icount;
1558 struct tty_struct *tty;
1559
1560 dev_dbg(&edge_port->port->dev, "%s - %02x\n", __func__, msr);
1561
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;
1565
1566 /* update input line counters */
1567 if (msr & EDGEPORT_MSR_DELTA_CTS)
1568 icount->cts++;
1569 if (msr & EDGEPORT_MSR_DELTA_DSR)
1570 icount->dsr++;
1571 if (msr & EDGEPORT_MSR_DELTA_CD)
1572 icount->dcd++;
1573 if (msr & EDGEPORT_MSR_DELTA_RI)
1574 icount->rng++;
1575 wake_up_interruptible(&edge_port->port->port.delta_msr_wait);
1576 }
1577
1578 /* Save the new modem status */
1579 edge_port->shadow_msr = msr & 0xf0;
1580
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)
1585 tty_wakeup(tty);
1586 }
1587 tty_kref_put(tty);
1588 }
1589
handle_new_lsr(struct edgeport_port * edge_port,int lsr_data,__u8 lsr,__u8 data)1590 static void handle_new_lsr(struct edgeport_port *edge_port, int lsr_data,
1591 __u8 lsr, __u8 data)
1592 {
1593 struct async_icount *icount;
1594 __u8 new_lsr = (__u8)(lsr & (__u8)(LSR_OVER_ERR | LSR_PAR_ERR |
1595 LSR_FRM_ERR | LSR_BREAK));
1596
1597 dev_dbg(&edge_port->port->dev, "%s - %02x\n", __func__, new_lsr);
1598
1599 edge_port->shadow_lsr = lsr;
1600
1601 if (new_lsr & LSR_BREAK)
1602 /*
1603 * Parity and Framing errors only count if they
1604 * occur exclusive of a break being received.
1605 */
1606 new_lsr &= (__u8)(LSR_OVER_ERR | LSR_BREAK);
1607
1608 /* Place LSR data byte into Rx buffer */
1609 if (lsr_data)
1610 edge_tty_recv(edge_port->port, &data, 1);
1611
1612 /* update input line counters */
1613 icount = &edge_port->port->icount;
1614 if (new_lsr & LSR_BREAK)
1615 icount->brk++;
1616 if (new_lsr & LSR_OVER_ERR)
1617 icount->overrun++;
1618 if (new_lsr & LSR_PAR_ERR)
1619 icount->parity++;
1620 if (new_lsr & LSR_FRM_ERR)
1621 icount->frame++;
1622 }
1623
edge_interrupt_callback(struct urb * urb)1624 static void edge_interrupt_callback(struct urb *urb)
1625 {
1626 struct edgeport_serial *edge_serial = urb->context;
1627 struct usb_serial_port *port;
1628 struct edgeport_port *edge_port;
1629 struct device *dev;
1630 unsigned char *data = urb->transfer_buffer;
1631 int length = urb->actual_length;
1632 int port_number;
1633 int function;
1634 int retval;
1635 __u8 lsr;
1636 __u8 msr;
1637 int status = urb->status;
1638
1639 switch (status) {
1640 case 0:
1641 /* success */
1642 break;
1643 case -ECONNRESET:
1644 case -ENOENT:
1645 case -ESHUTDOWN:
1646 /* this urb is terminated, clean up */
1647 dev_dbg(&urb->dev->dev, "%s - urb shutting down with status: %d\n",
1648 __func__, status);
1649 return;
1650 default:
1651 dev_err(&urb->dev->dev, "%s - nonzero urb status received: "
1652 "%d\n", __func__, status);
1653 goto exit;
1654 }
1655
1656 if (!length) {
1657 dev_dbg(&urb->dev->dev, "%s - no data in urb\n", __func__);
1658 goto exit;
1659 }
1660
1661 dev = &edge_serial->serial->dev->dev;
1662 usb_serial_debug_data(dev, __func__, length, data);
1663
1664 if (length != 2) {
1665 dev_dbg(dev, "%s - expecting packet of size 2, got %d\n", __func__, length);
1666 goto exit;
1667 }
1668
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]);
1673
1674 if (port_number >= edge_serial->serial->num_ports) {
1675 dev_err(dev, "bad port number %d\n", port_number);
1676 goto exit;
1677 }
1678
1679 port = edge_serial->serial->port[port_number];
1680 edge_port = usb_get_serial_port_data(port);
1681 if (!edge_port) {
1682 dev_dbg(dev, "%s - edge_port not found\n", __func__);
1683 return;
1684 }
1685 switch (function) {
1686 case TIUMP_INTERRUPT_CODE_LSR:
1687 lsr = map_line_status(data[1]);
1688 if (lsr & UMP_UART_LSR_DATA_MASK) {
1689 /*
1690 * Save the LSR event for bulk read completion routine
1691 */
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;
1696 } else {
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);
1700 }
1701 break;
1702
1703 case TIUMP_INTERRUPT_CODE_MSR: /* MSR */
1704 /* Copy MSR from UMP */
1705 msr = data[1];
1706 dev_dbg(dev, "%s - ===== Port %u MSR Status = %02x ======\n",
1707 __func__, port_number, msr);
1708 handle_new_msr(edge_port, msr);
1709 break;
1710
1711 default:
1712 dev_err(&urb->dev->dev,
1713 "%s - Unknown Interrupt code from UMP %x\n",
1714 __func__, data[1]);
1715 break;
1716
1717 }
1718
1719 exit:
1720 retval = usb_submit_urb(urb, GFP_ATOMIC);
1721 if (retval)
1722 dev_err(&urb->dev->dev,
1723 "%s - usb_submit_urb failed with result %d\n",
1724 __func__, retval);
1725 }
1726
edge_bulk_in_callback(struct urb * urb)1727 static void edge_bulk_in_callback(struct urb *urb)
1728 {
1729 struct edgeport_port *edge_port = urb->context;
1730 struct device *dev = &edge_port->port->dev;
1731 unsigned char *data = urb->transfer_buffer;
1732 unsigned long flags;
1733 int retval = 0;
1734 int port_number;
1735 int status = urb->status;
1736
1737 switch (status) {
1738 case 0:
1739 /* success */
1740 break;
1741 case -ECONNRESET:
1742 case -ENOENT:
1743 case -ESHUTDOWN:
1744 /* this urb is terminated, clean up */
1745 dev_dbg(&urb->dev->dev, "%s - urb shutting down with status: %d\n", __func__, status);
1746 return;
1747 default:
1748 dev_err(&urb->dev->dev, "%s - nonzero read bulk status received: %d\n", __func__, status);
1749 }
1750
1751 if (status == -EPIPE)
1752 goto exit;
1753
1754 if (status) {
1755 dev_err(&urb->dev->dev, "%s - stopping read!\n", __func__);
1756 return;
1757 }
1758
1759 port_number = edge_port->port->port_number;
1760
1761 if (urb->actual_length > 0 && edge_port->lsr_event) {
1762 edge_port->lsr_event = 0;
1763 dev_dbg(dev, "%s ===== Port %u LSR Status = %02x, Data = %02x ======\n",
1764 __func__, port_number, edge_port->lsr_mask, *data);
1765 handle_new_lsr(edge_port, 1, edge_port->lsr_mask, *data);
1766 /* Adjust buffer length/pointer */
1767 --urb->actual_length;
1768 ++data;
1769 }
1770
1771 if (urb->actual_length) {
1772 usb_serial_debug_data(dev, __func__, urb->actual_length, data);
1773 if (edge_port->close_pending)
1774 dev_dbg(dev, "%s - close pending, dropping data on the floor\n",
1775 __func__);
1776 else
1777 edge_tty_recv(edge_port->port, data,
1778 urb->actual_length);
1779 edge_port->port->icount.rx += urb->actual_length;
1780 }
1781
1782 exit:
1783 /* continue read unless stopped */
1784 spin_lock_irqsave(&edge_port->ep_lock, flags);
1785 if (edge_port->ep_read_urb_state == EDGE_READ_URB_RUNNING)
1786 retval = usb_submit_urb(urb, GFP_ATOMIC);
1787 else if (edge_port->ep_read_urb_state == EDGE_READ_URB_STOPPING)
1788 edge_port->ep_read_urb_state = EDGE_READ_URB_STOPPED;
1789
1790 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
1791 if (retval)
1792 dev_err(dev, "%s - usb_submit_urb failed with result %d\n", __func__, retval);
1793 }
1794
edge_tty_recv(struct usb_serial_port * port,unsigned char * data,int length)1795 static void edge_tty_recv(struct usb_serial_port *port, unsigned char *data,
1796 int length)
1797 {
1798 int queued;
1799
1800 queued = tty_insert_flip_string(&port->port, data, length);
1801 if (queued < length)
1802 dev_err(&port->dev, "%s - dropping data, %d bytes lost\n",
1803 __func__, length - queued);
1804 tty_flip_buffer_push(&port->port);
1805 }
1806
edge_bulk_out_callback(struct urb * urb)1807 static void edge_bulk_out_callback(struct urb *urb)
1808 {
1809 struct usb_serial_port *port = urb->context;
1810 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1811 int status = urb->status;
1812 struct tty_struct *tty;
1813
1814 edge_port->ep_write_urb_in_use = 0;
1815
1816 switch (status) {
1817 case 0:
1818 /* success */
1819 break;
1820 case -ECONNRESET:
1821 case -ENOENT:
1822 case -ESHUTDOWN:
1823 /* this urb is terminated, clean up */
1824 dev_dbg(&urb->dev->dev, "%s - urb shutting down with status: %d\n",
1825 __func__, status);
1826 return;
1827 default:
1828 dev_err_console(port, "%s - nonzero write bulk status "
1829 "received: %d\n", __func__, status);
1830 }
1831
1832 /* send any buffered data */
1833 tty = tty_port_tty_get(&port->port);
1834 edge_send(port, tty);
1835 tty_kref_put(tty);
1836 }
1837
edge_open(struct tty_struct * tty,struct usb_serial_port * port)1838 static int edge_open(struct tty_struct *tty, struct usb_serial_port *port)
1839 {
1840 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1841 struct edgeport_serial *edge_serial;
1842 struct usb_device *dev;
1843 struct urb *urb;
1844 int port_number;
1845 int status;
1846 u16 open_settings;
1847 u8 transaction_timeout;
1848
1849 if (edge_port == NULL)
1850 return -ENODEV;
1851
1852 port_number = port->port_number;
1853
1854 dev = port->serial->dev;
1855
1856 /* turn off loopback */
1857 status = ti_do_config(edge_port, UMPC_SET_CLR_LOOPBACK, 0);
1858 if (status) {
1859 dev_err(&port->dev,
1860 "%s - cannot send clear loopback command, %d\n",
1861 __func__, status);
1862 return status;
1863 }
1864
1865 /* set up the port settings */
1866 if (tty)
1867 edge_set_termios(tty, port, &tty->termios);
1868
1869 /* open up the port */
1870
1871 /* milliseconds to timeout for DMA transfer */
1872 transaction_timeout = 2;
1873
1874 edge_port->ump_read_timeout =
1875 max(20, ((transaction_timeout * 3) / 2));
1876
1877 /* milliseconds to timeout for DMA transfer */
1878 open_settings = (u8)(UMP_DMA_MODE_CONTINOUS |
1879 UMP_PIPE_TRANS_TIMEOUT_ENA |
1880 (transaction_timeout << 2));
1881
1882 dev_dbg(&port->dev, "%s - Sending UMPC_OPEN_PORT\n", __func__);
1883
1884 /* Tell TI to open and start the port */
1885 status = send_cmd(dev, UMPC_OPEN_PORT,
1886 (u8)(UMPM_UART1_PORT + port_number), open_settings, NULL, 0);
1887 if (status) {
1888 dev_err(&port->dev, "%s - cannot send open command, %d\n",
1889 __func__, status);
1890 return status;
1891 }
1892
1893 /* Start the DMA? */
1894 status = send_cmd(dev, UMPC_START_PORT,
1895 (u8)(UMPM_UART1_PORT + port_number), 0, NULL, 0);
1896 if (status) {
1897 dev_err(&port->dev, "%s - cannot send start DMA command, %d\n",
1898 __func__, status);
1899 return status;
1900 }
1901
1902 /* Clear TX and RX buffers in UMP */
1903 status = purge_port(port, UMP_PORT_DIR_OUT | UMP_PORT_DIR_IN);
1904 if (status) {
1905 dev_err(&port->dev,
1906 "%s - cannot send clear buffers command, %d\n",
1907 __func__, status);
1908 return status;
1909 }
1910
1911 /* Read Initial MSR */
1912 status = ti_vread_sync(dev, UMPC_READ_MSR, 0,
1913 (__u16)(UMPM_UART1_PORT + port_number),
1914 &edge_port->shadow_msr, 1);
1915 if (status) {
1916 dev_err(&port->dev, "%s - cannot send read MSR command, %d\n",
1917 __func__, status);
1918 return status;
1919 }
1920
1921 dev_dbg(&port->dev, "ShadowMSR 0x%X\n", edge_port->shadow_msr);
1922
1923 /* Set Initial MCR */
1924 edge_port->shadow_mcr = MCR_RTS | MCR_DTR;
1925 dev_dbg(&port->dev, "ShadowMCR 0x%X\n", edge_port->shadow_mcr);
1926
1927 edge_serial = edge_port->edge_serial;
1928 if (mutex_lock_interruptible(&edge_serial->es_lock))
1929 return -ERESTARTSYS;
1930 if (edge_serial->num_ports_open == 0) {
1931 /* we are the first port to open, post the interrupt urb */
1932 urb = edge_serial->serial->port[0]->interrupt_in_urb;
1933 urb->context = edge_serial;
1934 status = usb_submit_urb(urb, GFP_KERNEL);
1935 if (status) {
1936 dev_err(&port->dev,
1937 "%s - usb_submit_urb failed with value %d\n",
1938 __func__, status);
1939 goto release_es_lock;
1940 }
1941 }
1942
1943 /*
1944 * reset the data toggle on the bulk endpoints to work around bug in
1945 * host controllers where things get out of sync some times
1946 */
1947 usb_clear_halt(dev, port->write_urb->pipe);
1948 usb_clear_halt(dev, port->read_urb->pipe);
1949
1950 /* start up our bulk read urb */
1951 urb = port->read_urb;
1952 edge_port->ep_read_urb_state = EDGE_READ_URB_RUNNING;
1953 urb->context = edge_port;
1954 status = usb_submit_urb(urb, GFP_KERNEL);
1955 if (status) {
1956 dev_err(&port->dev,
1957 "%s - read bulk usb_submit_urb failed with value %d\n",
1958 __func__, status);
1959 goto unlink_int_urb;
1960 }
1961
1962 ++edge_serial->num_ports_open;
1963
1964 goto release_es_lock;
1965
1966 unlink_int_urb:
1967 if (edge_port->edge_serial->num_ports_open == 0)
1968 usb_kill_urb(port->serial->port[0]->interrupt_in_urb);
1969 release_es_lock:
1970 mutex_unlock(&edge_serial->es_lock);
1971 return status;
1972 }
1973
edge_close(struct usb_serial_port * port)1974 static void edge_close(struct usb_serial_port *port)
1975 {
1976 struct edgeport_serial *edge_serial;
1977 struct edgeport_port *edge_port;
1978 struct usb_serial *serial = port->serial;
1979 unsigned long flags;
1980 int port_number;
1981
1982 edge_serial = usb_get_serial_data(port->serial);
1983 edge_port = usb_get_serial_port_data(port);
1984 if (edge_serial == NULL || edge_port == NULL)
1985 return;
1986
1987 /*
1988 * The bulkreadcompletion routine will check
1989 * this flag and dump add read data
1990 */
1991 edge_port->close_pending = 1;
1992
1993 usb_kill_urb(port->read_urb);
1994 usb_kill_urb(port->write_urb);
1995 edge_port->ep_write_urb_in_use = 0;
1996 spin_lock_irqsave(&edge_port->ep_lock, flags);
1997 kfifo_reset_out(&port->write_fifo);
1998 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
1999
2000 dev_dbg(&port->dev, "%s - send umpc_close_port\n", __func__);
2001 port_number = port->port_number;
2002 send_cmd(serial->dev, UMPC_CLOSE_PORT,
2003 (__u8)(UMPM_UART1_PORT + port_number), 0, NULL, 0);
2004
2005 mutex_lock(&edge_serial->es_lock);
2006 --edge_port->edge_serial->num_ports_open;
2007 if (edge_port->edge_serial->num_ports_open <= 0) {
2008 /* last port is now closed, let's shut down our interrupt urb */
2009 usb_kill_urb(port->serial->port[0]->interrupt_in_urb);
2010 edge_port->edge_serial->num_ports_open = 0;
2011 }
2012 mutex_unlock(&edge_serial->es_lock);
2013 edge_port->close_pending = 0;
2014 }
2015
edge_write(struct tty_struct * tty,struct usb_serial_port * port,const unsigned char * data,int count)2016 static int edge_write(struct tty_struct *tty, struct usb_serial_port *port,
2017 const unsigned char *data, int count)
2018 {
2019 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2020
2021 if (count == 0) {
2022 dev_dbg(&port->dev, "%s - write request of 0 bytes\n", __func__);
2023 return 0;
2024 }
2025
2026 if (edge_port == NULL)
2027 return -ENODEV;
2028 if (edge_port->close_pending == 1)
2029 return -ENODEV;
2030
2031 count = kfifo_in_locked(&port->write_fifo, data, count,
2032 &edge_port->ep_lock);
2033 edge_send(port, tty);
2034
2035 return count;
2036 }
2037
edge_send(struct usb_serial_port * port,struct tty_struct * tty)2038 static void edge_send(struct usb_serial_port *port, struct tty_struct *tty)
2039 {
2040 int count, result;
2041 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2042 unsigned long flags;
2043
2044 spin_lock_irqsave(&edge_port->ep_lock, flags);
2045
2046 if (edge_port->ep_write_urb_in_use) {
2047 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2048 return;
2049 }
2050
2051 count = kfifo_out(&port->write_fifo,
2052 port->write_urb->transfer_buffer,
2053 port->bulk_out_size);
2054
2055 if (count == 0) {
2056 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2057 return;
2058 }
2059
2060 edge_port->ep_write_urb_in_use = 1;
2061
2062 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2063
2064 usb_serial_debug_data(&port->dev, __func__, count, port->write_urb->transfer_buffer);
2065
2066 /* set up our urb */
2067 port->write_urb->transfer_buffer_length = count;
2068
2069 /* send the data out the bulk port */
2070 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
2071 if (result) {
2072 dev_err_console(port,
2073 "%s - failed submitting write urb, error %d\n",
2074 __func__, result);
2075 edge_port->ep_write_urb_in_use = 0;
2076 /* TODO: reschedule edge_send */
2077 } else
2078 edge_port->port->icount.tx += count;
2079
2080 /*
2081 * wakeup any process waiting for writes to complete
2082 * there is now more room in the buffer for new writes
2083 */
2084 if (tty)
2085 tty_wakeup(tty);
2086 }
2087
edge_write_room(struct tty_struct * tty)2088 static int edge_write_room(struct tty_struct *tty)
2089 {
2090 struct usb_serial_port *port = tty->driver_data;
2091 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2092 int room = 0;
2093 unsigned long flags;
2094
2095 if (edge_port == NULL)
2096 return 0;
2097 if (edge_port->close_pending == 1)
2098 return 0;
2099
2100 spin_lock_irqsave(&edge_port->ep_lock, flags);
2101 room = kfifo_avail(&port->write_fifo);
2102 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2103
2104 dev_dbg(&port->dev, "%s - returns %d\n", __func__, room);
2105 return room;
2106 }
2107
edge_chars_in_buffer(struct tty_struct * tty)2108 static int edge_chars_in_buffer(struct tty_struct *tty)
2109 {
2110 struct usb_serial_port *port = tty->driver_data;
2111 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2112 int chars = 0;
2113 unsigned long flags;
2114 if (edge_port == NULL)
2115 return 0;
2116
2117 spin_lock_irqsave(&edge_port->ep_lock, flags);
2118 chars = kfifo_len(&port->write_fifo);
2119 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2120
2121 dev_dbg(&port->dev, "%s - returns %d\n", __func__, chars);
2122 return chars;
2123 }
2124
edge_tx_empty(struct usb_serial_port * port)2125 static bool edge_tx_empty(struct usb_serial_port *port)
2126 {
2127 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2128 int ret;
2129
2130 ret = tx_active(edge_port);
2131 if (ret > 0)
2132 return false;
2133
2134 return true;
2135 }
2136
edge_throttle(struct tty_struct * tty)2137 static void edge_throttle(struct tty_struct *tty)
2138 {
2139 struct usb_serial_port *port = tty->driver_data;
2140 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2141 int status;
2142
2143 if (edge_port == NULL)
2144 return;
2145
2146 /* if we are implementing XON/XOFF, send the stop character */
2147 if (I_IXOFF(tty)) {
2148 unsigned char stop_char = STOP_CHAR(tty);
2149 status = edge_write(tty, port, &stop_char, 1);
2150 if (status <= 0) {
2151 dev_err(&port->dev, "%s - failed to write stop character, %d\n", __func__, status);
2152 }
2153 }
2154
2155 /*
2156 * if we are implementing RTS/CTS, stop reads
2157 * and the Edgeport will clear the RTS line
2158 */
2159 if (C_CRTSCTS(tty))
2160 stop_read(edge_port);
2161
2162 }
2163
edge_unthrottle(struct tty_struct * tty)2164 static void edge_unthrottle(struct tty_struct *tty)
2165 {
2166 struct usb_serial_port *port = tty->driver_data;
2167 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2168 int status;
2169
2170 if (edge_port == NULL)
2171 return;
2172
2173 /* if we are implementing XON/XOFF, send the start character */
2174 if (I_IXOFF(tty)) {
2175 unsigned char start_char = START_CHAR(tty);
2176 status = edge_write(tty, port, &start_char, 1);
2177 if (status <= 0) {
2178 dev_err(&port->dev, "%s - failed to write start character, %d\n", __func__, status);
2179 }
2180 }
2181 /*
2182 * if we are implementing RTS/CTS, restart reads
2183 * are the Edgeport will assert the RTS line
2184 */
2185 if (C_CRTSCTS(tty)) {
2186 status = restart_read(edge_port);
2187 if (status)
2188 dev_err(&port->dev,
2189 "%s - read bulk usb_submit_urb failed: %d\n",
2190 __func__, status);
2191 }
2192
2193 }
2194
stop_read(struct edgeport_port * edge_port)2195 static void stop_read(struct edgeport_port *edge_port)
2196 {
2197 unsigned long flags;
2198
2199 spin_lock_irqsave(&edge_port->ep_lock, flags);
2200
2201 if (edge_port->ep_read_urb_state == EDGE_READ_URB_RUNNING)
2202 edge_port->ep_read_urb_state = EDGE_READ_URB_STOPPING;
2203 edge_port->shadow_mcr &= ~MCR_RTS;
2204
2205 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2206 }
2207
restart_read(struct edgeport_port * edge_port)2208 static int restart_read(struct edgeport_port *edge_port)
2209 {
2210 struct urb *urb;
2211 int status = 0;
2212 unsigned long flags;
2213
2214 spin_lock_irqsave(&edge_port->ep_lock, flags);
2215
2216 if (edge_port->ep_read_urb_state == EDGE_READ_URB_STOPPED) {
2217 urb = edge_port->port->read_urb;
2218 status = usb_submit_urb(urb, GFP_ATOMIC);
2219 }
2220 edge_port->ep_read_urb_state = EDGE_READ_URB_RUNNING;
2221 edge_port->shadow_mcr |= MCR_RTS;
2222
2223 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2224
2225 return status;
2226 }
2227
change_port_settings(struct tty_struct * tty,struct edgeport_port * edge_port,struct ktermios * old_termios)2228 static void change_port_settings(struct tty_struct *tty,
2229 struct edgeport_port *edge_port, struct ktermios *old_termios)
2230 {
2231 struct device *dev = &edge_port->port->dev;
2232 struct ump_uart_config *config;
2233 int baud;
2234 unsigned cflag;
2235 int status;
2236 int port_number = edge_port->port->port_number;
2237
2238 config = kmalloc (sizeof (*config), GFP_KERNEL);
2239 if (!config) {
2240 tty->termios = *old_termios;
2241 return;
2242 }
2243
2244 cflag = tty->termios.c_cflag;
2245
2246 config->wFlags = 0;
2247
2248 /* These flags must be set */
2249 config->wFlags |= UMP_MASK_UART_FLAGS_RECEIVE_MS_INT;
2250 config->wFlags |= UMP_MASK_UART_FLAGS_AUTO_START_ON_ERR;
2251 config->bUartMode = (__u8)(edge_port->bUartMode);
2252
2253 switch (cflag & CSIZE) {
2254 case CS5:
2255 config->bDataBits = UMP_UART_CHAR5BITS;
2256 dev_dbg(dev, "%s - data bits = 5\n", __func__);
2257 break;
2258 case CS6:
2259 config->bDataBits = UMP_UART_CHAR6BITS;
2260 dev_dbg(dev, "%s - data bits = 6\n", __func__);
2261 break;
2262 case CS7:
2263 config->bDataBits = UMP_UART_CHAR7BITS;
2264 dev_dbg(dev, "%s - data bits = 7\n", __func__);
2265 break;
2266 default:
2267 case CS8:
2268 config->bDataBits = UMP_UART_CHAR8BITS;
2269 dev_dbg(dev, "%s - data bits = 8\n", __func__);
2270 break;
2271 }
2272
2273 if (cflag & PARENB) {
2274 if (cflag & PARODD) {
2275 config->wFlags |= UMP_MASK_UART_FLAGS_PARITY;
2276 config->bParity = UMP_UART_ODDPARITY;
2277 dev_dbg(dev, "%s - parity = odd\n", __func__);
2278 } else {
2279 config->wFlags |= UMP_MASK_UART_FLAGS_PARITY;
2280 config->bParity = UMP_UART_EVENPARITY;
2281 dev_dbg(dev, "%s - parity = even\n", __func__);
2282 }
2283 } else {
2284 config->bParity = UMP_UART_NOPARITY;
2285 dev_dbg(dev, "%s - parity = none\n", __func__);
2286 }
2287
2288 if (cflag & CSTOPB) {
2289 config->bStopBits = UMP_UART_STOPBIT2;
2290 dev_dbg(dev, "%s - stop bits = 2\n", __func__);
2291 } else {
2292 config->bStopBits = UMP_UART_STOPBIT1;
2293 dev_dbg(dev, "%s - stop bits = 1\n", __func__);
2294 }
2295
2296 /* figure out the flow control settings */
2297 if (cflag & CRTSCTS) {
2298 config->wFlags |= UMP_MASK_UART_FLAGS_OUT_X_CTS_FLOW;
2299 config->wFlags |= UMP_MASK_UART_FLAGS_RTS_FLOW;
2300 dev_dbg(dev, "%s - RTS/CTS is enabled\n", __func__);
2301 } else {
2302 dev_dbg(dev, "%s - RTS/CTS is disabled\n", __func__);
2303 restart_read(edge_port);
2304 }
2305
2306 /*
2307 * if we are implementing XON/XOFF, set the start and stop
2308 * character in the device
2309 */
2310 config->cXon = START_CHAR(tty);
2311 config->cXoff = STOP_CHAR(tty);
2312
2313 /* if we are implementing INBOUND XON/XOFF */
2314 if (I_IXOFF(tty)) {
2315 config->wFlags |= UMP_MASK_UART_FLAGS_IN_X;
2316 dev_dbg(dev, "%s - INBOUND XON/XOFF is enabled, XON = %2x, XOFF = %2x\n",
2317 __func__, config->cXon, config->cXoff);
2318 } else
2319 dev_dbg(dev, "%s - INBOUND XON/XOFF is disabled\n", __func__);
2320
2321 /* if we are implementing OUTBOUND XON/XOFF */
2322 if (I_IXON(tty)) {
2323 config->wFlags |= UMP_MASK_UART_FLAGS_OUT_X;
2324 dev_dbg(dev, "%s - OUTBOUND XON/XOFF is enabled, XON = %2x, XOFF = %2x\n",
2325 __func__, config->cXon, config->cXoff);
2326 } else
2327 dev_dbg(dev, "%s - OUTBOUND XON/XOFF is disabled\n", __func__);
2328
2329 tty->termios.c_cflag &= ~CMSPAR;
2330
2331 /* Round the baud rate */
2332 baud = tty_get_baud_rate(tty);
2333 if (!baud) {
2334 /* pick a default, any default... */
2335 baud = 9600;
2336 } else {
2337 /* Avoid a zero divisor. */
2338 baud = min(baud, 461550);
2339 tty_encode_baud_rate(tty, baud, baud);
2340 }
2341
2342 edge_port->baud_rate = baud;
2343 config->wBaudRate = (__u16)((461550L + baud/2) / baud);
2344
2345 /* FIXME: Recompute actual baud from divisor here */
2346
2347 dev_dbg(dev, "%s - baud rate = %d, wBaudRate = %d\n", __func__, baud, config->wBaudRate);
2348
2349 dev_dbg(dev, "wBaudRate: %d\n", (int)(461550L / config->wBaudRate));
2350 dev_dbg(dev, "wFlags: 0x%x\n", config->wFlags);
2351 dev_dbg(dev, "bDataBits: %d\n", config->bDataBits);
2352 dev_dbg(dev, "bParity: %d\n", config->bParity);
2353 dev_dbg(dev, "bStopBits: %d\n", config->bStopBits);
2354 dev_dbg(dev, "cXon: %d\n", config->cXon);
2355 dev_dbg(dev, "cXoff: %d\n", config->cXoff);
2356 dev_dbg(dev, "bUartMode: %d\n", config->bUartMode);
2357
2358 /* move the word values into big endian mode */
2359 cpu_to_be16s(&config->wFlags);
2360 cpu_to_be16s(&config->wBaudRate);
2361
2362 status = send_cmd(edge_port->port->serial->dev, UMPC_SET_CONFIG,
2363 (__u8)(UMPM_UART1_PORT + port_number),
2364 0, (__u8 *)config, sizeof(*config));
2365 if (status)
2366 dev_dbg(dev, "%s - error %d when trying to write config to device\n",
2367 __func__, status);
2368 kfree(config);
2369 }
2370
edge_set_termios(struct tty_struct * tty,struct usb_serial_port * port,struct ktermios * old_termios)2371 static void edge_set_termios(struct tty_struct *tty,
2372 struct usb_serial_port *port, struct ktermios *old_termios)
2373 {
2374 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2375
2376 if (edge_port == NULL)
2377 return;
2378 /* change the port settings to the new ones specified */
2379 change_port_settings(tty, edge_port, old_termios);
2380 }
2381
edge_tiocmset(struct tty_struct * tty,unsigned int set,unsigned int clear)2382 static int edge_tiocmset(struct tty_struct *tty,
2383 unsigned int set, unsigned int clear)
2384 {
2385 struct usb_serial_port *port = tty->driver_data;
2386 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2387 unsigned int mcr;
2388 unsigned long flags;
2389
2390 spin_lock_irqsave(&edge_port->ep_lock, flags);
2391 mcr = edge_port->shadow_mcr;
2392 if (set & TIOCM_RTS)
2393 mcr |= MCR_RTS;
2394 if (set & TIOCM_DTR)
2395 mcr |= MCR_DTR;
2396 if (set & TIOCM_LOOP)
2397 mcr |= MCR_LOOPBACK;
2398
2399 if (clear & TIOCM_RTS)
2400 mcr &= ~MCR_RTS;
2401 if (clear & TIOCM_DTR)
2402 mcr &= ~MCR_DTR;
2403 if (clear & TIOCM_LOOP)
2404 mcr &= ~MCR_LOOPBACK;
2405
2406 edge_port->shadow_mcr = mcr;
2407 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2408
2409 restore_mcr(edge_port, mcr);
2410 return 0;
2411 }
2412
edge_tiocmget(struct tty_struct * tty)2413 static int edge_tiocmget(struct tty_struct *tty)
2414 {
2415 struct usb_serial_port *port = tty->driver_data;
2416 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2417 unsigned int result = 0;
2418 unsigned int msr;
2419 unsigned int mcr;
2420 unsigned long flags;
2421
2422 spin_lock_irqsave(&edge_port->ep_lock, flags);
2423
2424 msr = edge_port->shadow_msr;
2425 mcr = edge_port->shadow_mcr;
2426 result = ((mcr & MCR_DTR) ? TIOCM_DTR: 0) /* 0x002 */
2427 | ((mcr & MCR_RTS) ? TIOCM_RTS: 0) /* 0x004 */
2428 | ((msr & EDGEPORT_MSR_CTS) ? TIOCM_CTS: 0) /* 0x020 */
2429 | ((msr & EDGEPORT_MSR_CD) ? TIOCM_CAR: 0) /* 0x040 */
2430 | ((msr & EDGEPORT_MSR_RI) ? TIOCM_RI: 0) /* 0x080 */
2431 | ((msr & EDGEPORT_MSR_DSR) ? TIOCM_DSR: 0); /* 0x100 */
2432
2433
2434 dev_dbg(&port->dev, "%s -- %x\n", __func__, result);
2435 spin_unlock_irqrestore(&edge_port->ep_lock, flags);
2436
2437 return result;
2438 }
2439
get_serial_info(struct tty_struct * tty,struct serial_struct * ss)2440 static int get_serial_info(struct tty_struct *tty,
2441 struct serial_struct *ss)
2442 {
2443 struct usb_serial_port *port = tty->driver_data;
2444 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2445 unsigned cwait;
2446
2447 cwait = edge_port->port->port.closing_wait;
2448 if (cwait != ASYNC_CLOSING_WAIT_NONE)
2449 cwait = jiffies_to_msecs(cwait) / 10;
2450
2451 ss->type = PORT_16550A;
2452 ss->line = edge_port->port->minor;
2453 ss->port = edge_port->port->port_number;
2454 ss->irq = 0;
2455 ss->xmit_fifo_size = edge_port->port->bulk_out_size;
2456 ss->baud_base = 9600;
2457 ss->close_delay = 5*HZ;
2458 ss->closing_wait = cwait;
2459 return 0;
2460 }
2461
edge_break(struct tty_struct * tty,int break_state)2462 static void edge_break(struct tty_struct *tty, int break_state)
2463 {
2464 struct usb_serial_port *port = tty->driver_data;
2465 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2466 int status;
2467 int bv = 0; /* Off */
2468
2469 if (break_state == -1)
2470 bv = 1; /* On */
2471 status = ti_do_config(edge_port, UMPC_SET_CLR_BREAK, bv);
2472 if (status)
2473 dev_dbg(&port->dev, "%s - error %d sending break set/clear command.\n",
2474 __func__, status);
2475 }
2476
edge_heartbeat_schedule(struct edgeport_serial * edge_serial)2477 static void edge_heartbeat_schedule(struct edgeport_serial *edge_serial)
2478 {
2479 if (!edge_serial->use_heartbeat)
2480 return;
2481
2482 schedule_delayed_work(&edge_serial->heartbeat_work,
2483 FW_HEARTBEAT_SECS * HZ);
2484 }
2485
edge_heartbeat_work(struct work_struct * work)2486 static void edge_heartbeat_work(struct work_struct *work)
2487 {
2488 struct edgeport_serial *serial;
2489 struct ti_i2c_desc *rom_desc;
2490
2491 serial = container_of(work, struct edgeport_serial,
2492 heartbeat_work.work);
2493
2494 rom_desc = kmalloc(sizeof(*rom_desc), GFP_KERNEL);
2495
2496 /* Descriptor address request is enough to reset the firmware timer */
2497 if (!rom_desc || !get_descriptor_addr(serial, I2C_DESC_TYPE_ION,
2498 rom_desc)) {
2499 dev_err(&serial->serial->interface->dev,
2500 "%s - Incomplete heartbeat\n", __func__);
2501 }
2502 kfree(rom_desc);
2503
2504 edge_heartbeat_schedule(serial);
2505 }
2506
edge_calc_num_ports(struct usb_serial * serial,struct usb_serial_endpoints * epds)2507 static int edge_calc_num_ports(struct usb_serial *serial,
2508 struct usb_serial_endpoints *epds)
2509 {
2510 struct device *dev = &serial->interface->dev;
2511 unsigned char num_ports = serial->type->num_ports;
2512
2513 /* Make sure we have the required endpoints when in download mode. */
2514 if (serial->interface->cur_altsetting->desc.bNumEndpoints > 1) {
2515 if (epds->num_bulk_in < num_ports ||
2516 epds->num_bulk_out < num_ports ||
2517 epds->num_interrupt_in < 1) {
2518 dev_err(dev, "required endpoints missing\n");
2519 return -ENODEV;
2520 }
2521 }
2522
2523 return num_ports;
2524 }
2525
edge_startup(struct usb_serial * serial)2526 static int edge_startup(struct usb_serial *serial)
2527 {
2528 struct edgeport_serial *edge_serial;
2529 int status;
2530 u16 product_id;
2531
2532 /* create our private serial structure */
2533 edge_serial = kzalloc(sizeof(struct edgeport_serial), GFP_KERNEL);
2534 if (!edge_serial)
2535 return -ENOMEM;
2536
2537 mutex_init(&edge_serial->es_lock);
2538 edge_serial->serial = serial;
2539 INIT_DELAYED_WORK(&edge_serial->heartbeat_work, edge_heartbeat_work);
2540 usb_set_serial_data(serial, edge_serial);
2541
2542 status = download_fw(edge_serial);
2543 if (status < 0) {
2544 kfree(edge_serial);
2545 return status;
2546 }
2547
2548 if (status > 0)
2549 return 1; /* bind but do not register any ports */
2550
2551 product_id = le16_to_cpu(
2552 edge_serial->serial->dev->descriptor.idProduct);
2553
2554 /* Currently only the EP/416 models require heartbeat support */
2555 if (edge_serial->fw_version > FW_HEARTBEAT_VERSION_CUTOFF) {
2556 if (product_id == ION_DEVICE_ID_TI_EDGEPORT_416 ||
2557 product_id == ION_DEVICE_ID_TI_EDGEPORT_416B) {
2558 edge_serial->use_heartbeat = true;
2559 }
2560 }
2561
2562 edge_heartbeat_schedule(edge_serial);
2563
2564 return 0;
2565 }
2566
edge_disconnect(struct usb_serial * serial)2567 static void edge_disconnect(struct usb_serial *serial)
2568 {
2569 struct edgeport_serial *edge_serial = usb_get_serial_data(serial);
2570
2571 cancel_delayed_work_sync(&edge_serial->heartbeat_work);
2572 }
2573
edge_release(struct usb_serial * serial)2574 static void edge_release(struct usb_serial *serial)
2575 {
2576 struct edgeport_serial *edge_serial = usb_get_serial_data(serial);
2577
2578 cancel_delayed_work_sync(&edge_serial->heartbeat_work);
2579 kfree(edge_serial);
2580 }
2581
edge_port_probe(struct usb_serial_port * port)2582 static int edge_port_probe(struct usb_serial_port *port)
2583 {
2584 struct edgeport_port *edge_port;
2585 int ret;
2586
2587 edge_port = kzalloc(sizeof(*edge_port), GFP_KERNEL);
2588 if (!edge_port)
2589 return -ENOMEM;
2590
2591 spin_lock_init(&edge_port->ep_lock);
2592 edge_port->port = port;
2593 edge_port->edge_serial = usb_get_serial_data(port->serial);
2594 edge_port->bUartMode = default_uart_mode;
2595
2596 switch (port->port_number) {
2597 case 0:
2598 edge_port->uart_base = UMPMEM_BASE_UART1;
2599 edge_port->dma_address = UMPD_OEDB1_ADDRESS;
2600 break;
2601 case 1:
2602 edge_port->uart_base = UMPMEM_BASE_UART2;
2603 edge_port->dma_address = UMPD_OEDB2_ADDRESS;
2604 break;
2605 default:
2606 dev_err(&port->dev, "unknown port number\n");
2607 ret = -ENODEV;
2608 goto err;
2609 }
2610
2611 dev_dbg(&port->dev,
2612 "%s - port_number = %d, uart_base = %04x, dma_address = %04x\n",
2613 __func__, port->port_number, edge_port->uart_base,
2614 edge_port->dma_address);
2615
2616 usb_set_serial_port_data(port, edge_port);
2617
2618 ret = edge_create_sysfs_attrs(port);
2619 if (ret)
2620 goto err;
2621
2622 port->port.closing_wait = msecs_to_jiffies(closing_wait * 10);
2623 port->port.drain_delay = 1;
2624
2625 return 0;
2626 err:
2627 kfree(edge_port);
2628
2629 return ret;
2630 }
2631
edge_port_remove(struct usb_serial_port * port)2632 static int edge_port_remove(struct usb_serial_port *port)
2633 {
2634 struct edgeport_port *edge_port;
2635
2636 edge_port = usb_get_serial_port_data(port);
2637 edge_remove_sysfs_attrs(port);
2638 kfree(edge_port);
2639
2640 return 0;
2641 }
2642
2643 /* Sysfs Attributes */
2644
uart_mode_show(struct device * dev,struct device_attribute * attr,char * buf)2645 static ssize_t uart_mode_show(struct device *dev,
2646 struct device_attribute *attr, char *buf)
2647 {
2648 struct usb_serial_port *port = to_usb_serial_port(dev);
2649 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2650
2651 return sprintf(buf, "%d\n", edge_port->bUartMode);
2652 }
2653
uart_mode_store(struct device * dev,struct device_attribute * attr,const char * valbuf,size_t count)2654 static ssize_t uart_mode_store(struct device *dev,
2655 struct device_attribute *attr, const char *valbuf, size_t count)
2656 {
2657 struct usb_serial_port *port = to_usb_serial_port(dev);
2658 struct edgeport_port *edge_port = usb_get_serial_port_data(port);
2659 unsigned int v = simple_strtoul(valbuf, NULL, 0);
2660
2661 dev_dbg(dev, "%s: setting uart_mode = %d\n", __func__, v);
2662
2663 if (v < 256)
2664 edge_port->bUartMode = v;
2665 else
2666 dev_err(dev, "%s - uart_mode %d is invalid\n", __func__, v);
2667
2668 return count;
2669 }
2670 static DEVICE_ATTR_RW(uart_mode);
2671
edge_create_sysfs_attrs(struct usb_serial_port * port)2672 static int edge_create_sysfs_attrs(struct usb_serial_port *port)
2673 {
2674 return device_create_file(&port->dev, &dev_attr_uart_mode);
2675 }
2676
edge_remove_sysfs_attrs(struct usb_serial_port * port)2677 static int edge_remove_sysfs_attrs(struct usb_serial_port *port)
2678 {
2679 device_remove_file(&port->dev, &dev_attr_uart_mode);
2680 return 0;
2681 }
2682
2683 #ifdef CONFIG_PM
edge_suspend(struct usb_serial * serial,pm_message_t message)2684 static int edge_suspend(struct usb_serial *serial, pm_message_t message)
2685 {
2686 struct edgeport_serial *edge_serial = usb_get_serial_data(serial);
2687
2688 cancel_delayed_work_sync(&edge_serial->heartbeat_work);
2689
2690 return 0;
2691 }
2692
edge_resume(struct usb_serial * serial)2693 static int edge_resume(struct usb_serial *serial)
2694 {
2695 struct edgeport_serial *edge_serial = usb_get_serial_data(serial);
2696
2697 edge_heartbeat_schedule(edge_serial);
2698
2699 return 0;
2700 }
2701 #endif
2702
2703 static struct usb_serial_driver edgeport_1port_device = {
2704 .driver = {
2705 .owner = THIS_MODULE,
2706 .name = "edgeport_ti_1",
2707 },
2708 .description = "Edgeport TI 1 port adapter",
2709 .id_table = edgeport_1port_id_table,
2710 .num_ports = 1,
2711 .num_bulk_out = 1,
2712 .open = edge_open,
2713 .close = edge_close,
2714 .throttle = edge_throttle,
2715 .unthrottle = edge_unthrottle,
2716 .attach = edge_startup,
2717 .calc_num_ports = edge_calc_num_ports,
2718 .disconnect = edge_disconnect,
2719 .release = edge_release,
2720 .port_probe = edge_port_probe,
2721 .port_remove = edge_port_remove,
2722 .get_serial = get_serial_info,
2723 .set_termios = edge_set_termios,
2724 .tiocmget = edge_tiocmget,
2725 .tiocmset = edge_tiocmset,
2726 .tiocmiwait = usb_serial_generic_tiocmiwait,
2727 .get_icount = usb_serial_generic_get_icount,
2728 .write = edge_write,
2729 .write_room = edge_write_room,
2730 .chars_in_buffer = edge_chars_in_buffer,
2731 .tx_empty = edge_tx_empty,
2732 .break_ctl = edge_break,
2733 .read_int_callback = edge_interrupt_callback,
2734 .read_bulk_callback = edge_bulk_in_callback,
2735 .write_bulk_callback = edge_bulk_out_callback,
2736 #ifdef CONFIG_PM
2737 .suspend = edge_suspend,
2738 .resume = edge_resume,
2739 #endif
2740 };
2741
2742 static struct usb_serial_driver edgeport_2port_device = {
2743 .driver = {
2744 .owner = THIS_MODULE,
2745 .name = "edgeport_ti_2",
2746 },
2747 .description = "Edgeport TI 2 port adapter",
2748 .id_table = edgeport_2port_id_table,
2749 .num_ports = 2,
2750 .num_bulk_out = 1,
2751 .open = edge_open,
2752 .close = edge_close,
2753 .throttle = edge_throttle,
2754 .unthrottle = edge_unthrottle,
2755 .attach = edge_startup,
2756 .calc_num_ports = edge_calc_num_ports,
2757 .disconnect = edge_disconnect,
2758 .release = edge_release,
2759 .port_probe = edge_port_probe,
2760 .port_remove = edge_port_remove,
2761 .get_serial = get_serial_info,
2762 .set_termios = edge_set_termios,
2763 .tiocmget = edge_tiocmget,
2764 .tiocmset = edge_tiocmset,
2765 .tiocmiwait = usb_serial_generic_tiocmiwait,
2766 .get_icount = usb_serial_generic_get_icount,
2767 .write = edge_write,
2768 .write_room = edge_write_room,
2769 .chars_in_buffer = edge_chars_in_buffer,
2770 .tx_empty = edge_tx_empty,
2771 .break_ctl = edge_break,
2772 .read_int_callback = edge_interrupt_callback,
2773 .read_bulk_callback = edge_bulk_in_callback,
2774 .write_bulk_callback = edge_bulk_out_callback,
2775 #ifdef CONFIG_PM
2776 .suspend = edge_suspend,
2777 .resume = edge_resume,
2778 #endif
2779 };
2780
2781 static struct usb_serial_driver * const serial_drivers[] = {
2782 &edgeport_1port_device, &edgeport_2port_device, NULL
2783 };
2784
2785 module_usb_serial_driver(serial_drivers, id_table_combined);
2786
2787 MODULE_AUTHOR(DRIVER_AUTHOR);
2788 MODULE_DESCRIPTION(DRIVER_DESC);
2789 MODULE_LICENSE("GPL");
2790 MODULE_FIRMWARE("edgeport/down3.bin");
2791
2792 module_param(closing_wait, int, S_IRUGO | S_IWUSR);
2793 MODULE_PARM_DESC(closing_wait, "Maximum wait for data to drain, in .01 secs");
2794
2795 module_param(ignore_cpu_rev, bool, S_IRUGO | S_IWUSR);
2796 MODULE_PARM_DESC(ignore_cpu_rev,
2797 "Ignore the cpu revision when connecting to a device");
2798
2799 module_param(default_uart_mode, int, S_IRUGO | S_IWUSR);
2800 MODULE_PARM_DESC(default_uart_mode, "Default uart_mode, 0=RS232, ...");
2801
