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