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 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 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 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 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 */ 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 */ 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 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 */ 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 */ 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 */ 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 */ 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 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 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 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 */ 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 */ 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 */ 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 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 if (le16_to_cpu(rom_desc->Size) != sizeof(struct edge_ti_manuf_descriptor)) { 777 dev_err(dev, "unexpected Edge descriptor length: %u\n", 778 le16_to_cpu(rom_desc->Size)); 779 status = -EINVAL; 780 goto exit; 781 } 782 status = read_rom(serial, start_address+sizeof(struct ti_i2c_desc), 783 le16_to_cpu(rom_desc->Size), buffer); 784 if (status) 785 goto exit; 786 787 status = valid_csum(rom_desc, buffer); 788 789 desc = (struct edge_ti_manuf_descriptor *)buffer; 790 dev_dbg(dev, "%s - IonConfig 0x%x\n", __func__, desc->IonConfig); 791 dev_dbg(dev, "%s - Version %d\n", __func__, desc->Version); 792 dev_dbg(dev, "%s - Cpu/Board 0x%x\n", __func__, desc->CpuRev_BoardRev); 793 dev_dbg(dev, "%s - NumPorts %d\n", __func__, desc->NumPorts); 794 dev_dbg(dev, "%s - NumVirtualPorts %d\n", __func__, desc->NumVirtualPorts); 795 dev_dbg(dev, "%s - TotalPorts %d\n", __func__, desc->TotalPorts); 796 797 exit: 798 kfree(rom_desc); 799 return status; 800 } 801 802 /* Build firmware header used for firmware update */ 803 static int build_i2c_fw_hdr(u8 *header, const struct firmware *fw) 804 { 805 u8 *buffer; 806 int buffer_size; 807 int i; 808 u8 cs = 0; 809 struct ti_i2c_desc *i2c_header; 810 struct ti_i2c_image_header *img_header; 811 struct ti_i2c_firmware_rec *firmware_rec; 812 struct edgeport_fw_hdr *fw_hdr = (struct edgeport_fw_hdr *)fw->data; 813 814 /* 815 * In order to update the I2C firmware we must change the type 2 record 816 * to type 0xF2. This will force the UMP to come up in Boot Mode. 817 * Then while in boot mode, the driver will download the latest 818 * firmware (padded to 15.5k) into the UMP ram. And finally when the 819 * device comes back up in download mode the driver will cause the new 820 * firmware to be copied from the UMP Ram to I2C and the firmware will 821 * update the record type from 0xf2 to 0x02. 822 */ 823 824 /* 825 * Allocate a 15.5k buffer + 2 bytes for version number (Firmware 826 * Record) 827 */ 828 buffer_size = (((1024 * 16) - 512 ) + 829 sizeof(struct ti_i2c_firmware_rec)); 830 831 buffer = kmalloc(buffer_size, GFP_KERNEL); 832 if (!buffer) 833 return -ENOMEM; 834 835 /* Set entire image of 0xffs */ 836 memset(buffer, 0xff, buffer_size); 837 838 /* Copy version number into firmware record */ 839 firmware_rec = (struct ti_i2c_firmware_rec *)buffer; 840 841 firmware_rec->Ver_Major = fw_hdr->major_version; 842 firmware_rec->Ver_Minor = fw_hdr->minor_version; 843 844 /* Pointer to fw_down memory image */ 845 img_header = (struct ti_i2c_image_header *)&fw->data[4]; 846 847 if (le16_to_cpu(img_header->Length) > 848 buffer_size - sizeof(struct ti_i2c_firmware_rec)) { 849 kfree(buffer); 850 return -EINVAL; 851 } 852 memcpy(buffer + sizeof(struct ti_i2c_firmware_rec), 853 &fw->data[4 + sizeof(struct ti_i2c_image_header)], 854 le16_to_cpu(img_header->Length)); 855 856 for (i=0; i < buffer_size; i++) { 857 cs = (u8)(cs + buffer[i]); 858 } 859 860 kfree(buffer); 861 862 /* Build new header */ 863 i2c_header = (struct ti_i2c_desc *)header; 864 firmware_rec = (struct ti_i2c_firmware_rec*)i2c_header->Data; 865 866 i2c_header->Type = I2C_DESC_TYPE_FIRMWARE_BLANK; 867 i2c_header->Size = cpu_to_le16(buffer_size); 868 i2c_header->CheckSum = cs; 869 firmware_rec->Ver_Major = fw_hdr->major_version; 870 firmware_rec->Ver_Minor = fw_hdr->minor_version; 871 872 return 0; 873 } 874 875 /* Try to figure out what type of I2c we have */ 876 static int i2c_type_bootmode(struct edgeport_serial *serial) 877 { 878 struct device *dev = &serial->serial->dev->dev; 879 int status; 880 u8 *data; 881 882 data = kmalloc(1, GFP_KERNEL); 883 if (!data) 884 return -ENOMEM; 885 886 /* Try to read type 2 */ 887 status = ti_vread_sync(serial->serial->dev, UMPC_MEMORY_READ, 888 DTK_ADDR_SPACE_I2C_TYPE_II, 0, data, 0x01); 889 if (status) 890 dev_dbg(dev, "%s - read 2 status error = %d\n", __func__, status); 891 else 892 dev_dbg(dev, "%s - read 2 data = 0x%x\n", __func__, *data); 893 if ((!status) && (*data == UMP5152 || *data == UMP3410)) { 894 dev_dbg(dev, "%s - ROM_TYPE_II\n", __func__); 895 serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_II; 896 goto out; 897 } 898 899 /* Try to read type 3 */ 900 status = ti_vread_sync(serial->serial->dev, UMPC_MEMORY_READ, 901 DTK_ADDR_SPACE_I2C_TYPE_III, 0, data, 0x01); 902 if (status) 903 dev_dbg(dev, "%s - read 3 status error = %d\n", __func__, status); 904 else 905 dev_dbg(dev, "%s - read 2 data = 0x%x\n", __func__, *data); 906 if ((!status) && (*data == UMP5152 || *data == UMP3410)) { 907 dev_dbg(dev, "%s - ROM_TYPE_III\n", __func__); 908 serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_III; 909 goto out; 910 } 911 912 dev_dbg(dev, "%s - Unknown\n", __func__); 913 serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_II; 914 status = -ENODEV; 915 out: 916 kfree(data); 917 return status; 918 } 919 920 static int bulk_xfer(struct usb_serial *serial, void *buffer, 921 int length, int *num_sent) 922 { 923 int status; 924 925 status = usb_bulk_msg(serial->dev, 926 usb_sndbulkpipe(serial->dev, 927 serial->port[0]->bulk_out_endpointAddress), 928 buffer, length, num_sent, 1000); 929 return status; 930 } 931 932 /* Download given firmware image to the device (IN BOOT MODE) */ 933 static int download_code(struct edgeport_serial *serial, u8 *image, 934 int image_length) 935 { 936 int status = 0; 937 int pos; 938 int transfer; 939 int done; 940 941 /* Transfer firmware image */ 942 for (pos = 0; pos < image_length; ) { 943 /* Read the next buffer from file */ 944 transfer = image_length - pos; 945 if (transfer > EDGE_FW_BULK_MAX_PACKET_SIZE) 946 transfer = EDGE_FW_BULK_MAX_PACKET_SIZE; 947 948 /* Transfer data */ 949 status = bulk_xfer(serial->serial, &image[pos], 950 transfer, &done); 951 if (status) 952 break; 953 /* Advance buffer pointer */ 954 pos += done; 955 } 956 957 return status; 958 } 959 960 /* FIXME!!! */ 961 static int config_boot_dev(struct usb_device *dev) 962 { 963 return 0; 964 } 965 966 static int ti_cpu_rev(struct edge_ti_manuf_descriptor *desc) 967 { 968 return TI_GET_CPU_REVISION(desc->CpuRev_BoardRev); 969 } 970 971 static int check_fw_sanity(struct edgeport_serial *serial, 972 const struct firmware *fw) 973 { 974 u16 length_total; 975 u8 checksum = 0; 976 int pos; 977 struct device *dev = &serial->serial->interface->dev; 978 struct edgeport_fw_hdr *fw_hdr = (struct edgeport_fw_hdr *)fw->data; 979 980 if (fw->size < sizeof(struct edgeport_fw_hdr)) { 981 dev_err(dev, "incomplete fw header\n"); 982 return -EINVAL; 983 } 984 985 length_total = le16_to_cpu(fw_hdr->length) + 986 sizeof(struct edgeport_fw_hdr); 987 988 if (fw->size != length_total) { 989 dev_err(dev, "bad fw size (expected: %u, got: %zu)\n", 990 length_total, fw->size); 991 return -EINVAL; 992 } 993 994 for (pos = sizeof(struct edgeport_fw_hdr); pos < fw->size; ++pos) 995 checksum += fw->data[pos]; 996 997 if (checksum != fw_hdr->checksum) { 998 dev_err(dev, "bad fw checksum (expected: 0x%x, got: 0x%x)\n", 999 fw_hdr->checksum, checksum); 1000 return -EINVAL; 1001 } 1002 1003 return 0; 1004 } 1005 1006 /* 1007 * DownloadTIFirmware - Download run-time operating firmware to the TI5052 1008 * 1009 * This routine downloads the main operating code into the TI5052, using the 1010 * boot code already burned into E2PROM or ROM. 1011 */ 1012 static int download_fw(struct edgeport_serial *serial) 1013 { 1014 struct device *dev = &serial->serial->interface->dev; 1015 int status = 0; 1016 struct usb_interface_descriptor *interface; 1017 const struct firmware *fw; 1018 const char *fw_name = "edgeport/down3.bin"; 1019 struct edgeport_fw_hdr *fw_hdr; 1020 1021 status = request_firmware(&fw, fw_name, dev); 1022 if (status) { 1023 dev_err(dev, "Failed to load image \"%s\" err %d\n", 1024 fw_name, status); 1025 return status; 1026 } 1027 1028 if (check_fw_sanity(serial, fw)) { 1029 status = -EINVAL; 1030 goto out; 1031 } 1032 1033 fw_hdr = (struct edgeport_fw_hdr *)fw->data; 1034 1035 /* If on-board version is newer, "fw_version" will be updated later. */ 1036 serial->fw_version = (fw_hdr->major_version << 8) + 1037 fw_hdr->minor_version; 1038 1039 /* 1040 * This routine is entered by both the BOOT mode and the Download mode 1041 * We can determine which code is running by the reading the config 1042 * descriptor and if we have only one bulk pipe it is in boot mode 1043 */ 1044 serial->product_info.hardware_type = HARDWARE_TYPE_TIUMP; 1045 1046 /* Default to type 2 i2c */ 1047 serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_II; 1048 1049 status = choose_config(serial->serial->dev); 1050 if (status) 1051 goto out; 1052 1053 interface = &serial->serial->interface->cur_altsetting->desc; 1054 if (!interface) { 1055 dev_err(dev, "%s - no interface set, error!\n", __func__); 1056 status = -ENODEV; 1057 goto out; 1058 } 1059 1060 /* 1061 * Setup initial mode -- the default mode 0 is TI_MODE_CONFIGURING 1062 * if we have more than one endpoint we are definitely in download 1063 * mode 1064 */ 1065 if (interface->bNumEndpoints > 1) { 1066 serial->product_info.TiMode = TI_MODE_DOWNLOAD; 1067 status = do_download_mode(serial, fw); 1068 } else { 1069 /* Otherwise we will remain in configuring mode */ 1070 serial->product_info.TiMode = TI_MODE_CONFIGURING; 1071 status = do_boot_mode(serial, fw); 1072 } 1073 1074 out: 1075 release_firmware(fw); 1076 return status; 1077 } 1078 1079 static int do_download_mode(struct edgeport_serial *serial, 1080 const struct firmware *fw) 1081 { 1082 struct device *dev = &serial->serial->interface->dev; 1083 int status = 0; 1084 int start_address; 1085 struct edge_ti_manuf_descriptor *ti_manuf_desc; 1086 int download_cur_ver; 1087 int download_new_ver; 1088 struct edgeport_fw_hdr *fw_hdr = (struct edgeport_fw_hdr *)fw->data; 1089 struct ti_i2c_desc *rom_desc; 1090 1091 dev_dbg(dev, "%s - RUNNING IN DOWNLOAD MODE\n", __func__); 1092 1093 status = check_i2c_image(serial); 1094 if (status) { 1095 dev_dbg(dev, "%s - DOWNLOAD MODE -- BAD I2C\n", __func__); 1096 return status; 1097 } 1098 1099 /* 1100 * Validate Hardware version number 1101 * Read Manufacturing Descriptor from TI Based Edgeport 1102 */ 1103 ti_manuf_desc = kmalloc_obj(*ti_manuf_desc); 1104 if (!ti_manuf_desc) 1105 return -ENOMEM; 1106 1107 status = get_manuf_info(serial, (u8 *)ti_manuf_desc); 1108 if (status) { 1109 kfree(ti_manuf_desc); 1110 return status; 1111 } 1112 1113 /* Check version number of ION descriptor */ 1114 if (!ignore_cpu_rev && ti_cpu_rev(ti_manuf_desc) < 2) { 1115 dev_dbg(dev, "%s - Wrong CPU Rev %d (Must be 2)\n", 1116 __func__, ti_cpu_rev(ti_manuf_desc)); 1117 kfree(ti_manuf_desc); 1118 return -EINVAL; 1119 } 1120 1121 rom_desc = kmalloc_obj(*rom_desc); 1122 if (!rom_desc) { 1123 kfree(ti_manuf_desc); 1124 return -ENOMEM; 1125 } 1126 1127 /* Search for type 2 record (firmware record) */ 1128 start_address = get_descriptor_addr(serial, 1129 I2C_DESC_TYPE_FIRMWARE_BASIC, rom_desc); 1130 if (start_address != 0) { 1131 struct ti_i2c_firmware_rec *firmware_version; 1132 u8 *record; 1133 1134 dev_dbg(dev, "%s - Found Type FIRMWARE (Type 2) record\n", 1135 __func__); 1136 1137 firmware_version = kmalloc_obj(*firmware_version); 1138 if (!firmware_version) { 1139 kfree(rom_desc); 1140 kfree(ti_manuf_desc); 1141 return -ENOMEM; 1142 } 1143 1144 /* 1145 * Validate version number 1146 * Read the descriptor data 1147 */ 1148 status = read_rom(serial, start_address + 1149 sizeof(struct ti_i2c_desc), 1150 sizeof(struct ti_i2c_firmware_rec), 1151 (u8 *)firmware_version); 1152 if (status) { 1153 kfree(firmware_version); 1154 kfree(rom_desc); 1155 kfree(ti_manuf_desc); 1156 return status; 1157 } 1158 1159 /* 1160 * Check version number of download with current 1161 * version in I2c 1162 */ 1163 download_cur_ver = (firmware_version->Ver_Major << 8) + 1164 (firmware_version->Ver_Minor); 1165 download_new_ver = (fw_hdr->major_version << 8) + 1166 (fw_hdr->minor_version); 1167 1168 dev_dbg(dev, "%s - >> FW Versions Device %d.%d Driver %d.%d\n", 1169 __func__, firmware_version->Ver_Major, 1170 firmware_version->Ver_Minor, 1171 fw_hdr->major_version, fw_hdr->minor_version); 1172 1173 /* 1174 * Check if we have an old version in the I2C and 1175 * update if necessary 1176 */ 1177 if (download_cur_ver < download_new_ver) { 1178 dev_dbg(dev, "%s - Update I2C dld from %d.%d to %d.%d\n", 1179 __func__, 1180 firmware_version->Ver_Major, 1181 firmware_version->Ver_Minor, 1182 fw_hdr->major_version, 1183 fw_hdr->minor_version); 1184 1185 record = kmalloc(1, GFP_KERNEL); 1186 if (!record) { 1187 kfree(firmware_version); 1188 kfree(rom_desc); 1189 kfree(ti_manuf_desc); 1190 return -ENOMEM; 1191 } 1192 /* 1193 * In order to update the I2C firmware we must 1194 * change the type 2 record to type 0xF2. This 1195 * will force the UMP to come up in Boot Mode. 1196 * Then while in boot mode, the driver will 1197 * download the latest firmware (padded to 1198 * 15.5k) into the UMP ram. Finally when the 1199 * device comes back up in download mode the 1200 * driver will cause the new firmware to be 1201 * copied from the UMP Ram to I2C and the 1202 * firmware will update the record type from 1203 * 0xf2 to 0x02. 1204 */ 1205 *record = I2C_DESC_TYPE_FIRMWARE_BLANK; 1206 1207 /* 1208 * Change the I2C Firmware record type to 1209 * 0xf2 to trigger an update 1210 */ 1211 status = write_rom(serial, start_address, 1212 sizeof(*record), record); 1213 if (status) { 1214 kfree(record); 1215 kfree(firmware_version); 1216 kfree(rom_desc); 1217 kfree(ti_manuf_desc); 1218 return status; 1219 } 1220 1221 /* 1222 * verify the write -- must do this in order 1223 * for write to complete before we do the 1224 * hardware reset 1225 */ 1226 status = read_rom(serial, 1227 start_address, 1228 sizeof(*record), 1229 record); 1230 if (status) { 1231 kfree(record); 1232 kfree(firmware_version); 1233 kfree(rom_desc); 1234 kfree(ti_manuf_desc); 1235 return status; 1236 } 1237 1238 if (*record != I2C_DESC_TYPE_FIRMWARE_BLANK) { 1239 dev_err(dev, "%s - error resetting device\n", 1240 __func__); 1241 kfree(record); 1242 kfree(firmware_version); 1243 kfree(rom_desc); 1244 kfree(ti_manuf_desc); 1245 return -ENODEV; 1246 } 1247 1248 dev_dbg(dev, "%s - HARDWARE RESET\n", __func__); 1249 1250 /* Reset UMP -- Back to BOOT MODE */ 1251 status = ti_vsend_sync(serial->serial->dev, 1252 UMPC_HARDWARE_RESET, 1253 0, 0, NULL, 0, 1254 TI_VSEND_TIMEOUT_DEFAULT); 1255 1256 dev_dbg(dev, "%s - HARDWARE RESET return %d\n", 1257 __func__, status); 1258 1259 /* return an error on purpose. */ 1260 kfree(record); 1261 kfree(firmware_version); 1262 kfree(rom_desc); 1263 kfree(ti_manuf_desc); 1264 return -ENODEV; 1265 } 1266 /* Same or newer fw version is already loaded */ 1267 serial->fw_version = download_cur_ver; 1268 kfree(firmware_version); 1269 } 1270 /* Search for type 0xF2 record (firmware blank record) */ 1271 else { 1272 start_address = get_descriptor_addr(serial, 1273 I2C_DESC_TYPE_FIRMWARE_BLANK, rom_desc); 1274 if (start_address != 0) { 1275 #define HEADER_SIZE (sizeof(struct ti_i2c_desc) + \ 1276 sizeof(struct ti_i2c_firmware_rec)) 1277 u8 *header; 1278 u8 *vheader; 1279 1280 header = kmalloc(HEADER_SIZE, GFP_KERNEL); 1281 if (!header) { 1282 kfree(rom_desc); 1283 kfree(ti_manuf_desc); 1284 return -ENOMEM; 1285 } 1286 1287 vheader = kmalloc(HEADER_SIZE, GFP_KERNEL); 1288 if (!vheader) { 1289 kfree(header); 1290 kfree(rom_desc); 1291 kfree(ti_manuf_desc); 1292 return -ENOMEM; 1293 } 1294 1295 dev_dbg(dev, "%s - Found Type BLANK FIRMWARE (Type F2) record\n", 1296 __func__); 1297 1298 /* 1299 * In order to update the I2C firmware we must change 1300 * the type 2 record to type 0xF2. This will force the 1301 * UMP to come up in Boot Mode. Then while in boot 1302 * mode, the driver will download the latest firmware 1303 * (padded to 15.5k) into the UMP ram. Finally when the 1304 * device comes back up in download mode the driver 1305 * will cause the new firmware to be copied from the 1306 * UMP Ram to I2C and the firmware will update the 1307 * record type from 0xf2 to 0x02. 1308 */ 1309 status = build_i2c_fw_hdr(header, fw); 1310 if (status) { 1311 kfree(vheader); 1312 kfree(header); 1313 kfree(rom_desc); 1314 kfree(ti_manuf_desc); 1315 return -EINVAL; 1316 } 1317 1318 /* 1319 * Update I2C with type 0xf2 record with correct 1320 * size and checksum 1321 */ 1322 status = write_rom(serial, 1323 start_address, 1324 HEADER_SIZE, 1325 header); 1326 if (status) { 1327 kfree(vheader); 1328 kfree(header); 1329 kfree(rom_desc); 1330 kfree(ti_manuf_desc); 1331 return -EINVAL; 1332 } 1333 1334 /* 1335 * verify the write -- must do this in order for 1336 * write to complete before we do the hardware reset 1337 */ 1338 status = read_rom(serial, start_address, 1339 HEADER_SIZE, vheader); 1340 1341 if (status) { 1342 dev_dbg(dev, "%s - can't read header back\n", 1343 __func__); 1344 kfree(vheader); 1345 kfree(header); 1346 kfree(rom_desc); 1347 kfree(ti_manuf_desc); 1348 return status; 1349 } 1350 if (memcmp(vheader, header, HEADER_SIZE)) { 1351 dev_dbg(dev, "%s - write download record failed\n", 1352 __func__); 1353 kfree(vheader); 1354 kfree(header); 1355 kfree(rom_desc); 1356 kfree(ti_manuf_desc); 1357 return -EINVAL; 1358 } 1359 1360 kfree(vheader); 1361 kfree(header); 1362 1363 dev_dbg(dev, "%s - Start firmware update\n", __func__); 1364 1365 /* Tell firmware to copy download image into I2C */ 1366 status = ti_vsend_sync(serial->serial->dev, 1367 UMPC_COPY_DNLD_TO_I2C, 1368 0, 0, NULL, 0, 1369 TI_VSEND_TIMEOUT_FW_DOWNLOAD); 1370 1371 dev_dbg(dev, "%s - Update complete 0x%x\n", __func__, 1372 status); 1373 if (status) { 1374 dev_err(dev, 1375 "%s - UMPC_COPY_DNLD_TO_I2C failed\n", 1376 __func__); 1377 kfree(rom_desc); 1378 kfree(ti_manuf_desc); 1379 return status; 1380 } 1381 } 1382 } 1383 1384 /* The device is running the download code */ 1385 kfree(rom_desc); 1386 kfree(ti_manuf_desc); 1387 return 0; 1388 } 1389 1390 static int do_boot_mode(struct edgeport_serial *serial, 1391 const struct firmware *fw) 1392 { 1393 struct device *dev = &serial->serial->interface->dev; 1394 int status = 0; 1395 struct edge_ti_manuf_descriptor *ti_manuf_desc; 1396 struct edgeport_fw_hdr *fw_hdr = (struct edgeport_fw_hdr *)fw->data; 1397 1398 dev_dbg(dev, "%s - RUNNING IN BOOT MODE\n", __func__); 1399 1400 /* Configure the TI device so we can use the BULK pipes for download */ 1401 status = config_boot_dev(serial->serial->dev); 1402 if (status) 1403 return status; 1404 1405 if (le16_to_cpu(serial->serial->dev->descriptor.idVendor) 1406 != USB_VENDOR_ID_ION) { 1407 dev_dbg(dev, "%s - VID = 0x%x\n", __func__, 1408 le16_to_cpu(serial->serial->dev->descriptor.idVendor)); 1409 serial->TI_I2C_Type = DTK_ADDR_SPACE_I2C_TYPE_II; 1410 goto stayinbootmode; 1411 } 1412 1413 /* 1414 * We have an ION device (I2c Must be programmed) 1415 * Determine I2C image type 1416 */ 1417 if (i2c_type_bootmode(serial)) 1418 goto stayinbootmode; 1419 1420 /* Check for ION Vendor ID and that the I2C is valid */ 1421 if (!check_i2c_image(serial)) { 1422 struct ti_i2c_image_header *header; 1423 int i; 1424 u8 cs = 0; 1425 u8 *buffer; 1426 int buffer_size; 1427 1428 /* 1429 * Validate Hardware version number 1430 * Read Manufacturing Descriptor from TI Based Edgeport 1431 */ 1432 ti_manuf_desc = kmalloc_obj(*ti_manuf_desc); 1433 if (!ti_manuf_desc) 1434 return -ENOMEM; 1435 1436 status = get_manuf_info(serial, (u8 *)ti_manuf_desc); 1437 if (status) { 1438 kfree(ti_manuf_desc); 1439 goto stayinbootmode; 1440 } 1441 1442 /* Check for version 2 */ 1443 if (!ignore_cpu_rev && ti_cpu_rev(ti_manuf_desc) < 2) { 1444 dev_dbg(dev, "%s - Wrong CPU Rev %d (Must be 2)\n", 1445 __func__, ti_cpu_rev(ti_manuf_desc)); 1446 kfree(ti_manuf_desc); 1447 goto stayinbootmode; 1448 } 1449 1450 kfree(ti_manuf_desc); 1451 1452 /* 1453 * In order to update the I2C firmware we must change the type 1454 * 2 record to type 0xF2. This will force the UMP to come up 1455 * in Boot Mode. Then while in boot mode, the driver will 1456 * download the latest firmware (padded to 15.5k) into the 1457 * UMP ram. Finally when the device comes back up in download 1458 * mode the driver will cause the new firmware to be copied 1459 * from the UMP Ram to I2C and the firmware will update the 1460 * record type from 0xf2 to 0x02. 1461 * 1462 * Do we really have to copy the whole firmware image, 1463 * or could we do this in place! 1464 */ 1465 1466 /* Allocate a 15.5k buffer + 3 byte header */ 1467 buffer_size = (((1024 * 16) - 512) + 1468 sizeof(struct ti_i2c_image_header)); 1469 buffer = kmalloc(buffer_size, GFP_KERNEL); 1470 if (!buffer) 1471 return -ENOMEM; 1472 1473 /* Initialize the buffer to 0xff (pad the buffer) */ 1474 memset(buffer, 0xff, buffer_size); 1475 memcpy(buffer, &fw->data[4], fw->size - 4); 1476 1477 for (i = sizeof(struct ti_i2c_image_header); 1478 i < buffer_size; i++) { 1479 cs = (u8)(cs + buffer[i]); 1480 } 1481 1482 header = (struct ti_i2c_image_header *)buffer; 1483 1484 /* update length and checksum after padding */ 1485 header->Length = cpu_to_le16((u16)(buffer_size - 1486 sizeof(struct ti_i2c_image_header))); 1487 header->CheckSum = cs; 1488 1489 /* Download the operational code */ 1490 dev_dbg(dev, "%s - Downloading operational code image version %d.%d (TI UMP)\n", 1491 __func__, 1492 fw_hdr->major_version, fw_hdr->minor_version); 1493 status = download_code(serial, buffer, buffer_size); 1494 1495 kfree(buffer); 1496 1497 if (status) { 1498 dev_dbg(dev, "%s - Error downloading operational code image\n", __func__); 1499 return status; 1500 } 1501 1502 /* Device will reboot */ 1503 serial->product_info.TiMode = TI_MODE_TRANSITIONING; 1504 1505 dev_dbg(dev, "%s - Download successful -- Device rebooting...\n", __func__); 1506 1507 return 1; 1508 } 1509 1510 stayinbootmode: 1511 /* Eprom is invalid or blank stay in boot mode */ 1512 dev_dbg(dev, "%s - STAYING IN BOOT MODE\n", __func__); 1513 serial->product_info.TiMode = TI_MODE_BOOT; 1514 1515 return 1; 1516 } 1517 1518 static int ti_do_config(struct edgeport_port *port, int feature, int on) 1519 { 1520 on = !!on; /* 1 or 0 not bitmask */ 1521 1522 return send_port_cmd(port->port, feature, on, NULL, 0); 1523 } 1524 1525 static int restore_mcr(struct edgeport_port *port, u8 mcr) 1526 { 1527 int status = 0; 1528 1529 dev_dbg(&port->port->dev, "%s - %x\n", __func__, mcr); 1530 1531 status = ti_do_config(port, UMPC_SET_CLR_DTR, mcr & MCR_DTR); 1532 if (status) 1533 return status; 1534 status = ti_do_config(port, UMPC_SET_CLR_RTS, mcr & MCR_RTS); 1535 if (status) 1536 return status; 1537 return ti_do_config(port, UMPC_SET_CLR_LOOPBACK, mcr & MCR_LOOPBACK); 1538 } 1539 1540 /* Convert TI LSR to standard UART flags */ 1541 static u8 map_line_status(u8 ti_lsr) 1542 { 1543 u8 lsr = 0; 1544 1545 #define MAP_FLAG(flagUmp, flagUart) \ 1546 if (ti_lsr & flagUmp) \ 1547 lsr |= flagUart; 1548 1549 MAP_FLAG(UMP_UART_LSR_OV_MASK, LSR_OVER_ERR) /* overrun */ 1550 MAP_FLAG(UMP_UART_LSR_PE_MASK, LSR_PAR_ERR) /* parity error */ 1551 MAP_FLAG(UMP_UART_LSR_FE_MASK, LSR_FRM_ERR) /* framing error */ 1552 MAP_FLAG(UMP_UART_LSR_BR_MASK, LSR_BREAK) /* break detected */ 1553 MAP_FLAG(UMP_UART_LSR_RX_MASK, LSR_RX_AVAIL) /* rx data available */ 1554 MAP_FLAG(UMP_UART_LSR_TX_MASK, LSR_TX_EMPTY) /* tx hold reg empty */ 1555 1556 #undef MAP_FLAG 1557 1558 return lsr; 1559 } 1560 1561 static void handle_new_msr(struct edgeport_port *edge_port, u8 msr) 1562 { 1563 struct async_icount *icount; 1564 struct tty_struct *tty; 1565 1566 dev_dbg(&edge_port->port->dev, "%s - %02x\n", __func__, msr); 1567 1568 if (msr & (EDGEPORT_MSR_DELTA_CTS | EDGEPORT_MSR_DELTA_DSR | 1569 EDGEPORT_MSR_DELTA_RI | EDGEPORT_MSR_DELTA_CD)) { 1570 icount = &edge_port->port->icount; 1571 1572 /* update input line counters */ 1573 if (msr & EDGEPORT_MSR_DELTA_CTS) 1574 icount->cts++; 1575 if (msr & EDGEPORT_MSR_DELTA_DSR) 1576 icount->dsr++; 1577 if (msr & EDGEPORT_MSR_DELTA_CD) 1578 icount->dcd++; 1579 if (msr & EDGEPORT_MSR_DELTA_RI) 1580 icount->rng++; 1581 wake_up_interruptible(&edge_port->port->port.delta_msr_wait); 1582 } 1583 1584 /* Save the new modem status */ 1585 edge_port->shadow_msr = msr & 0xf0; 1586 1587 tty = tty_port_tty_get(&edge_port->port->port); 1588 /* handle CTS flow control */ 1589 if (tty && C_CRTSCTS(tty)) { 1590 if (msr & EDGEPORT_MSR_CTS) 1591 tty_wakeup(tty); 1592 } 1593 tty_kref_put(tty); 1594 } 1595 1596 static void handle_new_lsr(struct edgeport_port *edge_port, int lsr_data, 1597 u8 lsr, u8 data) 1598 { 1599 struct async_icount *icount; 1600 u8 new_lsr = (u8)(lsr & (u8)(LSR_OVER_ERR | LSR_PAR_ERR | 1601 LSR_FRM_ERR | LSR_BREAK)); 1602 1603 dev_dbg(&edge_port->port->dev, "%s - %02x\n", __func__, new_lsr); 1604 1605 edge_port->shadow_lsr = lsr; 1606 1607 if (new_lsr & LSR_BREAK) 1608 /* 1609 * Parity and Framing errors only count if they 1610 * occur exclusive of a break being received. 1611 */ 1612 new_lsr &= (u8)(LSR_OVER_ERR | LSR_BREAK); 1613 1614 /* Place LSR data byte into Rx buffer */ 1615 if (lsr_data) 1616 edge_tty_recv(edge_port->port, &data, 1); 1617 1618 /* update input line counters */ 1619 icount = &edge_port->port->icount; 1620 if (new_lsr & LSR_BREAK) 1621 icount->brk++; 1622 if (new_lsr & LSR_OVER_ERR) 1623 icount->overrun++; 1624 if (new_lsr & LSR_PAR_ERR) 1625 icount->parity++; 1626 if (new_lsr & LSR_FRM_ERR) 1627 icount->frame++; 1628 } 1629 1630 static void edge_interrupt_callback(struct urb *urb) 1631 { 1632 struct edgeport_serial *edge_serial = urb->context; 1633 struct usb_serial_port *port; 1634 struct edgeport_port *edge_port; 1635 struct device *dev; 1636 unsigned char *data = urb->transfer_buffer; 1637 int length = urb->actual_length; 1638 int port_number; 1639 int function; 1640 int retval; 1641 u8 lsr; 1642 u8 msr; 1643 int status = urb->status; 1644 1645 switch (status) { 1646 case 0: 1647 /* success */ 1648 break; 1649 case -ECONNRESET: 1650 case -ENOENT: 1651 case -ESHUTDOWN: 1652 /* this urb is terminated, clean up */ 1653 dev_dbg(&urb->dev->dev, "%s - urb shutting down with status: %d\n", 1654 __func__, status); 1655 return; 1656 default: 1657 dev_err(&urb->dev->dev, "%s - nonzero urb status received: " 1658 "%d\n", __func__, status); 1659 goto exit; 1660 } 1661 1662 if (!length) { 1663 dev_dbg(&urb->dev->dev, "%s - no data in urb\n", __func__); 1664 goto exit; 1665 } 1666 1667 dev = &edge_serial->serial->dev->dev; 1668 usb_serial_debug_data(dev, __func__, length, data); 1669 1670 if (length != 2) { 1671 dev_dbg(dev, "%s - expecting packet of size 2, got %d\n", __func__, length); 1672 goto exit; 1673 } 1674 1675 port_number = TIUMP_GET_PORT_FROM_CODE(data[0]); 1676 function = TIUMP_GET_FUNC_FROM_CODE(data[0]); 1677 dev_dbg(dev, "%s - port_number %d, function %d, info 0x%x\n", __func__, 1678 port_number, function, data[1]); 1679 1680 if (port_number >= edge_serial->serial->num_ports) { 1681 dev_err(dev, "bad port number %d\n", port_number); 1682 goto exit; 1683 } 1684 1685 port = edge_serial->serial->port[port_number]; 1686 edge_port = usb_get_serial_port_data(port); 1687 if (!edge_port) { 1688 dev_dbg(dev, "%s - edge_port not found\n", __func__); 1689 return; 1690 } 1691 switch (function) { 1692 case TIUMP_INTERRUPT_CODE_LSR: 1693 lsr = map_line_status(data[1]); 1694 if (lsr & UMP_UART_LSR_DATA_MASK) { 1695 /* 1696 * Save the LSR event for bulk read completion routine 1697 */ 1698 dev_dbg(dev, "%s - LSR Event Port %u LSR Status = %02x\n", 1699 __func__, port_number, lsr); 1700 edge_port->lsr_event = 1; 1701 edge_port->lsr_mask = lsr; 1702 } else { 1703 dev_dbg(dev, "%s - ===== Port %d LSR Status = %02x ======\n", 1704 __func__, port_number, lsr); 1705 handle_new_lsr(edge_port, 0, lsr, 0); 1706 } 1707 break; 1708 1709 case TIUMP_INTERRUPT_CODE_MSR: /* MSR */ 1710 /* Copy MSR from UMP */ 1711 msr = data[1]; 1712 dev_dbg(dev, "%s - ===== Port %u MSR Status = %02x ======\n", 1713 __func__, port_number, msr); 1714 handle_new_msr(edge_port, msr); 1715 break; 1716 1717 default: 1718 dev_err(&urb->dev->dev, 1719 "%s - Unknown Interrupt code from UMP %x\n", 1720 __func__, data[1]); 1721 break; 1722 1723 } 1724 1725 exit: 1726 retval = usb_submit_urb(urb, GFP_ATOMIC); 1727 if (retval) 1728 dev_err(&urb->dev->dev, 1729 "%s - usb_submit_urb failed with result %d\n", 1730 __func__, retval); 1731 } 1732 1733 static void edge_bulk_in_callback(struct urb *urb) 1734 { 1735 struct edgeport_port *edge_port = urb->context; 1736 struct device *dev = &edge_port->port->dev; 1737 unsigned char *data = urb->transfer_buffer; 1738 unsigned long flags; 1739 int retval = 0; 1740 int port_number; 1741 int status = urb->status; 1742 1743 switch (status) { 1744 case 0: 1745 /* success */ 1746 break; 1747 case -ECONNRESET: 1748 case -ENOENT: 1749 case -ESHUTDOWN: 1750 /* this urb is terminated, clean up */ 1751 dev_dbg(&urb->dev->dev, "%s - urb shutting down with status: %d\n", __func__, status); 1752 return; 1753 default: 1754 dev_err(&urb->dev->dev, "%s - nonzero read bulk status received: %d\n", __func__, status); 1755 } 1756 1757 if (status == -EPIPE) 1758 goto exit; 1759 1760 if (status) { 1761 dev_err(&urb->dev->dev, "%s - stopping read!\n", __func__); 1762 return; 1763 } 1764 1765 port_number = edge_port->port->port_number; 1766 1767 if (urb->actual_length > 0 && edge_port->lsr_event) { 1768 edge_port->lsr_event = 0; 1769 dev_dbg(dev, "%s ===== Port %u LSR Status = %02x, Data = %02x ======\n", 1770 __func__, port_number, edge_port->lsr_mask, *data); 1771 handle_new_lsr(edge_port, 1, edge_port->lsr_mask, *data); 1772 /* Adjust buffer length/pointer */ 1773 --urb->actual_length; 1774 ++data; 1775 } 1776 1777 if (urb->actual_length) { 1778 usb_serial_debug_data(dev, __func__, urb->actual_length, data); 1779 if (edge_port->close_pending) 1780 dev_dbg(dev, "%s - close pending, dropping data on the floor\n", 1781 __func__); 1782 else 1783 edge_tty_recv(edge_port->port, data, 1784 urb->actual_length); 1785 edge_port->port->icount.rx += urb->actual_length; 1786 } 1787 1788 exit: 1789 /* continue read unless stopped */ 1790 spin_lock_irqsave(&edge_port->ep_lock, flags); 1791 if (edge_port->ep_read_urb_state == EDGE_READ_URB_RUNNING) 1792 retval = usb_submit_urb(urb, GFP_ATOMIC); 1793 else if (edge_port->ep_read_urb_state == EDGE_READ_URB_STOPPING) 1794 edge_port->ep_read_urb_state = EDGE_READ_URB_STOPPED; 1795 1796 spin_unlock_irqrestore(&edge_port->ep_lock, flags); 1797 if (retval) 1798 dev_err(dev, "%s - usb_submit_urb failed with result %d\n", __func__, retval); 1799 } 1800 1801 static void edge_tty_recv(struct usb_serial_port *port, unsigned char *data, 1802 int length) 1803 { 1804 int queued; 1805 1806 queued = tty_insert_flip_string(&port->port, data, length); 1807 if (queued < length) 1808 dev_err(&port->dev, "%s - dropping data, %d bytes lost\n", 1809 __func__, length - queued); 1810 tty_flip_buffer_push(&port->port); 1811 } 1812 1813 static void edge_bulk_out_callback(struct urb *urb) 1814 { 1815 struct usb_serial_port *port = urb->context; 1816 struct edgeport_port *edge_port = usb_get_serial_port_data(port); 1817 int status = urb->status; 1818 struct tty_struct *tty; 1819 1820 edge_port->ep_write_urb_in_use = 0; 1821 1822 switch (status) { 1823 case 0: 1824 /* success */ 1825 break; 1826 case -ECONNRESET: 1827 case -ENOENT: 1828 case -ESHUTDOWN: 1829 /* this urb is terminated, clean up */ 1830 dev_dbg(&urb->dev->dev, "%s - urb shutting down with status: %d\n", 1831 __func__, status); 1832 return; 1833 default: 1834 dev_err_console(port, "%s - nonzero write bulk status " 1835 "received: %d\n", __func__, status); 1836 } 1837 1838 /* send any buffered data */ 1839 tty = tty_port_tty_get(&port->port); 1840 edge_send(port, tty); 1841 tty_kref_put(tty); 1842 } 1843 1844 static int edge_open(struct tty_struct *tty, struct usb_serial_port *port) 1845 { 1846 struct edgeport_port *edge_port = usb_get_serial_port_data(port); 1847 struct edgeport_serial *edge_serial; 1848 struct usb_device *dev; 1849 struct urb *urb; 1850 int status; 1851 u16 open_settings; 1852 u8 transaction_timeout; 1853 1854 if (edge_port == NULL) 1855 return -ENODEV; 1856 1857 dev = port->serial->dev; 1858 1859 /* turn off loopback */ 1860 status = ti_do_config(edge_port, UMPC_SET_CLR_LOOPBACK, 0); 1861 if (status) { 1862 dev_err(&port->dev, 1863 "%s - cannot send clear loopback command, %d\n", 1864 __func__, status); 1865 return status; 1866 } 1867 1868 /* set up the port settings */ 1869 if (tty) 1870 edge_set_termios(tty, port, &tty->termios); 1871 1872 /* open up the port */ 1873 1874 /* milliseconds to timeout for DMA transfer */ 1875 transaction_timeout = 2; 1876 1877 edge_port->ump_read_timeout = 1878 max(20, ((transaction_timeout * 3) / 2)); 1879 1880 /* milliseconds to timeout for DMA transfer */ 1881 open_settings = (u8)(UMP_DMA_MODE_CONTINOUS | 1882 UMP_PIPE_TRANS_TIMEOUT_ENA | 1883 (transaction_timeout << 2)); 1884 1885 dev_dbg(&port->dev, "%s - Sending UMPC_OPEN_PORT\n", __func__); 1886 1887 /* Tell TI to open and start the port */ 1888 status = send_port_cmd(port, UMPC_OPEN_PORT, open_settings, NULL, 0); 1889 if (status) { 1890 dev_err(&port->dev, "%s - cannot send open command, %d\n", 1891 __func__, status); 1892 return status; 1893 } 1894 1895 /* Start the DMA? */ 1896 status = send_port_cmd(port, UMPC_START_PORT, 0, NULL, 0); 1897 if (status) { 1898 dev_err(&port->dev, "%s - cannot send start DMA command, %d\n", 1899 __func__, status); 1900 return status; 1901 } 1902 1903 /* Clear TX and RX buffers in UMP */ 1904 status = purge_port(port, UMP_PORT_DIR_OUT | UMP_PORT_DIR_IN); 1905 if (status) { 1906 dev_err(&port->dev, 1907 "%s - cannot send clear buffers command, %d\n", 1908 __func__, status); 1909 return status; 1910 } 1911 1912 /* Read Initial MSR */ 1913 status = read_port_cmd(port, UMPC_READ_MSR, 0, &edge_port->shadow_msr, 1); 1914 if (status) { 1915 dev_err(&port->dev, "%s - cannot send read MSR command, %d\n", 1916 __func__, status); 1917 return status; 1918 } 1919 1920 dev_dbg(&port->dev, "ShadowMSR 0x%X\n", edge_port->shadow_msr); 1921 1922 /* Set Initial MCR */ 1923 edge_port->shadow_mcr = MCR_RTS | MCR_DTR; 1924 dev_dbg(&port->dev, "ShadowMCR 0x%X\n", edge_port->shadow_mcr); 1925 1926 edge_serial = edge_port->edge_serial; 1927 if (mutex_lock_interruptible(&edge_serial->es_lock)) 1928 return -ERESTARTSYS; 1929 if (edge_serial->num_ports_open == 0) { 1930 /* we are the first port to open, post the interrupt urb */ 1931 urb = edge_serial->serial->port[0]->interrupt_in_urb; 1932 urb->context = edge_serial; 1933 status = usb_submit_urb(urb, GFP_KERNEL); 1934 if (status) { 1935 dev_err(&port->dev, 1936 "%s - usb_submit_urb failed with value %d\n", 1937 __func__, status); 1938 goto release_es_lock; 1939 } 1940 } 1941 1942 /* 1943 * reset the data toggle on the bulk endpoints to work around bug in 1944 * host controllers where things get out of sync some times 1945 */ 1946 usb_clear_halt(dev, port->write_urb->pipe); 1947 usb_clear_halt(dev, port->read_urb->pipe); 1948 1949 /* start up our bulk read urb */ 1950 urb = port->read_urb; 1951 edge_port->ep_read_urb_state = EDGE_READ_URB_RUNNING; 1952 urb->context = edge_port; 1953 status = usb_submit_urb(urb, GFP_KERNEL); 1954 if (status) { 1955 dev_err(&port->dev, 1956 "%s - read bulk usb_submit_urb failed with value %d\n", 1957 __func__, status); 1958 goto unlink_int_urb; 1959 } 1960 1961 ++edge_serial->num_ports_open; 1962 1963 goto release_es_lock; 1964 1965 unlink_int_urb: 1966 if (edge_port->edge_serial->num_ports_open == 0) 1967 usb_kill_urb(port->serial->port[0]->interrupt_in_urb); 1968 release_es_lock: 1969 mutex_unlock(&edge_serial->es_lock); 1970 return status; 1971 } 1972 1973 static void edge_close(struct usb_serial_port *port) 1974 { 1975 struct edgeport_serial *edge_serial; 1976 struct edgeport_port *edge_port; 1977 unsigned long flags; 1978 1979 edge_serial = usb_get_serial_data(port->serial); 1980 edge_port = usb_get_serial_port_data(port); 1981 if (edge_serial == NULL || edge_port == NULL) 1982 return; 1983 1984 /* 1985 * The bulkreadcompletion routine will check 1986 * this flag and dump add read data 1987 */ 1988 edge_port->close_pending = 1; 1989 1990 usb_kill_urb(port->read_urb); 1991 usb_kill_urb(port->write_urb); 1992 edge_port->ep_write_urb_in_use = 0; 1993 spin_lock_irqsave(&edge_port->ep_lock, flags); 1994 kfifo_reset_out(&port->write_fifo); 1995 spin_unlock_irqrestore(&edge_port->ep_lock, flags); 1996 1997 dev_dbg(&port->dev, "%s - send umpc_close_port\n", __func__); 1998 send_port_cmd(port, UMPC_CLOSE_PORT, 0, NULL, 0); 1999 2000 mutex_lock(&edge_serial->es_lock); 2001 --edge_port->edge_serial->num_ports_open; 2002 if (edge_port->edge_serial->num_ports_open <= 0) { 2003 /* last port is now closed, let's shut down our interrupt urb */ 2004 usb_kill_urb(port->serial->port[0]->interrupt_in_urb); 2005 edge_port->edge_serial->num_ports_open = 0; 2006 } 2007 mutex_unlock(&edge_serial->es_lock); 2008 edge_port->close_pending = 0; 2009 } 2010 2011 static int edge_write(struct tty_struct *tty, struct usb_serial_port *port, 2012 const unsigned char *data, int count) 2013 { 2014 struct edgeport_port *edge_port = usb_get_serial_port_data(port); 2015 2016 if (count == 0) { 2017 dev_dbg(&port->dev, "%s - write request of 0 bytes\n", __func__); 2018 return 0; 2019 } 2020 2021 if (edge_port == NULL) 2022 return -ENODEV; 2023 if (edge_port->close_pending == 1) 2024 return -ENODEV; 2025 2026 count = kfifo_in_locked(&port->write_fifo, data, count, 2027 &edge_port->ep_lock); 2028 edge_send(port, tty); 2029 2030 return count; 2031 } 2032 2033 static void edge_send(struct usb_serial_port *port, struct tty_struct *tty) 2034 { 2035 int count, result; 2036 struct edgeport_port *edge_port = usb_get_serial_port_data(port); 2037 unsigned long flags; 2038 2039 spin_lock_irqsave(&edge_port->ep_lock, flags); 2040 2041 if (edge_port->ep_write_urb_in_use) { 2042 spin_unlock_irqrestore(&edge_port->ep_lock, flags); 2043 return; 2044 } 2045 2046 count = kfifo_out(&port->write_fifo, 2047 port->write_urb->transfer_buffer, 2048 port->bulk_out_size); 2049 2050 if (count == 0) { 2051 spin_unlock_irqrestore(&edge_port->ep_lock, flags); 2052 return; 2053 } 2054 2055 edge_port->ep_write_urb_in_use = 1; 2056 2057 spin_unlock_irqrestore(&edge_port->ep_lock, flags); 2058 2059 usb_serial_debug_data(&port->dev, __func__, count, port->write_urb->transfer_buffer); 2060 2061 /* set up our urb */ 2062 port->write_urb->transfer_buffer_length = count; 2063 2064 /* send the data out the bulk port */ 2065 result = usb_submit_urb(port->write_urb, GFP_ATOMIC); 2066 if (result) { 2067 dev_err_console(port, 2068 "%s - failed submitting write urb, error %d\n", 2069 __func__, result); 2070 edge_port->ep_write_urb_in_use = 0; 2071 /* TODO: reschedule edge_send */ 2072 } else 2073 edge_port->port->icount.tx += count; 2074 2075 /* 2076 * wakeup any process waiting for writes to complete 2077 * there is now more room in the buffer for new writes 2078 */ 2079 if (tty) 2080 tty_wakeup(tty); 2081 } 2082 2083 static unsigned int edge_write_room(struct tty_struct *tty) 2084 { 2085 struct usb_serial_port *port = tty->driver_data; 2086 struct edgeport_port *edge_port = usb_get_serial_port_data(port); 2087 unsigned int room; 2088 unsigned long flags; 2089 2090 if (edge_port == NULL) 2091 return 0; 2092 if (edge_port->close_pending == 1) 2093 return 0; 2094 2095 spin_lock_irqsave(&edge_port->ep_lock, flags); 2096 room = kfifo_avail(&port->write_fifo); 2097 spin_unlock_irqrestore(&edge_port->ep_lock, flags); 2098 2099 dev_dbg(&port->dev, "%s - returns %u\n", __func__, room); 2100 return room; 2101 } 2102 2103 static unsigned int edge_chars_in_buffer(struct tty_struct *tty) 2104 { 2105 struct usb_serial_port *port = tty->driver_data; 2106 struct edgeport_port *edge_port = usb_get_serial_port_data(port); 2107 unsigned int chars; 2108 unsigned long flags; 2109 if (edge_port == NULL) 2110 return 0; 2111 2112 spin_lock_irqsave(&edge_port->ep_lock, flags); 2113 chars = kfifo_len(&port->write_fifo); 2114 spin_unlock_irqrestore(&edge_port->ep_lock, flags); 2115 2116 dev_dbg(&port->dev, "%s - returns %u\n", __func__, chars); 2117 return chars; 2118 } 2119 2120 static bool edge_tx_empty(struct usb_serial_port *port) 2121 { 2122 struct edgeport_port *edge_port = usb_get_serial_port_data(port); 2123 int ret; 2124 2125 ret = tx_active(edge_port); 2126 if (ret > 0) 2127 return false; 2128 2129 return true; 2130 } 2131 2132 static void edge_throttle(struct tty_struct *tty) 2133 { 2134 struct usb_serial_port *port = tty->driver_data; 2135 struct edgeport_port *edge_port = usb_get_serial_port_data(port); 2136 int status; 2137 2138 if (edge_port == NULL) 2139 return; 2140 2141 /* if we are implementing XON/XOFF, send the stop character */ 2142 if (I_IXOFF(tty)) { 2143 unsigned char stop_char = STOP_CHAR(tty); 2144 status = edge_write(tty, port, &stop_char, 1); 2145 if (status <= 0) { 2146 dev_err(&port->dev, "%s - failed to write stop character, %d\n", __func__, status); 2147 } 2148 } 2149 2150 /* 2151 * if we are implementing RTS/CTS, stop reads 2152 * and the Edgeport will clear the RTS line 2153 */ 2154 if (C_CRTSCTS(tty)) 2155 stop_read(edge_port); 2156 2157 } 2158 2159 static void edge_unthrottle(struct tty_struct *tty) 2160 { 2161 struct usb_serial_port *port = tty->driver_data; 2162 struct edgeport_port *edge_port = usb_get_serial_port_data(port); 2163 int status; 2164 2165 if (edge_port == NULL) 2166 return; 2167 2168 /* if we are implementing XON/XOFF, send the start character */ 2169 if (I_IXOFF(tty)) { 2170 unsigned char start_char = START_CHAR(tty); 2171 status = edge_write(tty, port, &start_char, 1); 2172 if (status <= 0) { 2173 dev_err(&port->dev, "%s - failed to write start character, %d\n", __func__, status); 2174 } 2175 } 2176 /* 2177 * if we are implementing RTS/CTS, restart reads 2178 * are the Edgeport will assert the RTS line 2179 */ 2180 if (C_CRTSCTS(tty)) { 2181 status = restart_read(edge_port); 2182 if (status) 2183 dev_err(&port->dev, 2184 "%s - read bulk usb_submit_urb failed: %d\n", 2185 __func__, status); 2186 } 2187 2188 } 2189 2190 static void stop_read(struct edgeport_port *edge_port) 2191 { 2192 unsigned long flags; 2193 2194 spin_lock_irqsave(&edge_port->ep_lock, flags); 2195 2196 if (edge_port->ep_read_urb_state == EDGE_READ_URB_RUNNING) 2197 edge_port->ep_read_urb_state = EDGE_READ_URB_STOPPING; 2198 edge_port->shadow_mcr &= ~MCR_RTS; 2199 2200 spin_unlock_irqrestore(&edge_port->ep_lock, flags); 2201 } 2202 2203 static int restart_read(struct edgeport_port *edge_port) 2204 { 2205 struct urb *urb; 2206 int status = 0; 2207 unsigned long flags; 2208 2209 spin_lock_irqsave(&edge_port->ep_lock, flags); 2210 2211 if (edge_port->ep_read_urb_state == EDGE_READ_URB_STOPPED) { 2212 urb = edge_port->port->read_urb; 2213 status = usb_submit_urb(urb, GFP_ATOMIC); 2214 } 2215 edge_port->ep_read_urb_state = EDGE_READ_URB_RUNNING; 2216 edge_port->shadow_mcr |= MCR_RTS; 2217 2218 spin_unlock_irqrestore(&edge_port->ep_lock, flags); 2219 2220 return status; 2221 } 2222 2223 static void change_port_settings(struct tty_struct *tty, 2224 struct edgeport_port *edge_port, const struct ktermios *old_termios) 2225 { 2226 struct device *dev = &edge_port->port->dev; 2227 struct ump_uart_config *config; 2228 int baud; 2229 unsigned cflag; 2230 int status; 2231 2232 config = kmalloc_obj(*config); 2233 if (!config) { 2234 tty->termios = *old_termios; 2235 return; 2236 } 2237 2238 cflag = tty->termios.c_cflag; 2239 2240 config->wFlags = 0; 2241 2242 /* These flags must be set */ 2243 config->wFlags |= UMP_MASK_UART_FLAGS_RECEIVE_MS_INT; 2244 config->wFlags |= UMP_MASK_UART_FLAGS_AUTO_START_ON_ERR; 2245 config->bUartMode = (u8)(edge_port->bUartMode); 2246 2247 switch (cflag & CSIZE) { 2248 case CS5: 2249 config->bDataBits = UMP_UART_CHAR5BITS; 2250 dev_dbg(dev, "%s - data bits = 5\n", __func__); 2251 break; 2252 case CS6: 2253 config->bDataBits = UMP_UART_CHAR6BITS; 2254 dev_dbg(dev, "%s - data bits = 6\n", __func__); 2255 break; 2256 case CS7: 2257 config->bDataBits = UMP_UART_CHAR7BITS; 2258 dev_dbg(dev, "%s - data bits = 7\n", __func__); 2259 break; 2260 default: 2261 case CS8: 2262 config->bDataBits = UMP_UART_CHAR8BITS; 2263 dev_dbg(dev, "%s - data bits = 8\n", __func__); 2264 break; 2265 } 2266 2267 if (cflag & PARENB) { 2268 if (cflag & PARODD) { 2269 config->wFlags |= UMP_MASK_UART_FLAGS_PARITY; 2270 config->bParity = UMP_UART_ODDPARITY; 2271 dev_dbg(dev, "%s - parity = odd\n", __func__); 2272 } else { 2273 config->wFlags |= UMP_MASK_UART_FLAGS_PARITY; 2274 config->bParity = UMP_UART_EVENPARITY; 2275 dev_dbg(dev, "%s - parity = even\n", __func__); 2276 } 2277 } else { 2278 config->bParity = UMP_UART_NOPARITY; 2279 dev_dbg(dev, "%s - parity = none\n", __func__); 2280 } 2281 2282 if (cflag & CSTOPB) { 2283 config->bStopBits = UMP_UART_STOPBIT2; 2284 dev_dbg(dev, "%s - stop bits = 2\n", __func__); 2285 } else { 2286 config->bStopBits = UMP_UART_STOPBIT1; 2287 dev_dbg(dev, "%s - stop bits = 1\n", __func__); 2288 } 2289 2290 /* figure out the flow control settings */ 2291 if (cflag & CRTSCTS) { 2292 config->wFlags |= UMP_MASK_UART_FLAGS_OUT_X_CTS_FLOW; 2293 config->wFlags |= UMP_MASK_UART_FLAGS_RTS_FLOW; 2294 dev_dbg(dev, "%s - RTS/CTS is enabled\n", __func__); 2295 } else { 2296 dev_dbg(dev, "%s - RTS/CTS is disabled\n", __func__); 2297 restart_read(edge_port); 2298 } 2299 2300 /* 2301 * if we are implementing XON/XOFF, set the start and stop 2302 * character in the device 2303 */ 2304 config->cXon = START_CHAR(tty); 2305 config->cXoff = STOP_CHAR(tty); 2306 2307 /* if we are implementing INBOUND XON/XOFF */ 2308 if (I_IXOFF(tty)) { 2309 config->wFlags |= UMP_MASK_UART_FLAGS_IN_X; 2310 dev_dbg(dev, "%s - INBOUND XON/XOFF is enabled, XON = %2x, XOFF = %2x\n", 2311 __func__, config->cXon, config->cXoff); 2312 } else 2313 dev_dbg(dev, "%s - INBOUND XON/XOFF is disabled\n", __func__); 2314 2315 /* if we are implementing OUTBOUND XON/XOFF */ 2316 if (I_IXON(tty)) { 2317 config->wFlags |= UMP_MASK_UART_FLAGS_OUT_X; 2318 dev_dbg(dev, "%s - OUTBOUND XON/XOFF is enabled, XON = %2x, XOFF = %2x\n", 2319 __func__, config->cXon, config->cXoff); 2320 } else 2321 dev_dbg(dev, "%s - OUTBOUND XON/XOFF is disabled\n", __func__); 2322 2323 tty->termios.c_cflag &= ~CMSPAR; 2324 2325 /* Round the baud rate */ 2326 baud = tty_get_baud_rate(tty); 2327 if (!baud) { 2328 /* pick a default, any default... */ 2329 baud = 9600; 2330 } else { 2331 /* Avoid a zero divisor. */ 2332 baud = min(baud, 461550); 2333 tty_encode_baud_rate(tty, baud, baud); 2334 } 2335 2336 edge_port->baud_rate = baud; 2337 config->wBaudRate = (u16)((461550L + baud/2) / baud); 2338 2339 /* FIXME: Recompute actual baud from divisor here */ 2340 2341 dev_dbg(dev, "%s - baud rate = %d, wBaudRate = %d\n", __func__, baud, config->wBaudRate); 2342 2343 dev_dbg(dev, "wBaudRate: %d\n", (int)(461550L / config->wBaudRate)); 2344 dev_dbg(dev, "wFlags: 0x%x\n", config->wFlags); 2345 dev_dbg(dev, "bDataBits: %d\n", config->bDataBits); 2346 dev_dbg(dev, "bParity: %d\n", config->bParity); 2347 dev_dbg(dev, "bStopBits: %d\n", config->bStopBits); 2348 dev_dbg(dev, "cXon: %d\n", config->cXon); 2349 dev_dbg(dev, "cXoff: %d\n", config->cXoff); 2350 dev_dbg(dev, "bUartMode: %d\n", config->bUartMode); 2351 2352 /* move the word values into big endian mode */ 2353 cpu_to_be16s(&config->wFlags); 2354 cpu_to_be16s(&config->wBaudRate); 2355 2356 status = send_port_cmd(edge_port->port, UMPC_SET_CONFIG, 0, config, 2357 sizeof(*config)); 2358 if (status) 2359 dev_dbg(dev, "%s - error %d when trying to write config to device\n", 2360 __func__, status); 2361 kfree(config); 2362 } 2363 2364 static void edge_set_termios(struct tty_struct *tty, 2365 struct usb_serial_port *port, 2366 const struct ktermios *old_termios) 2367 { 2368 struct edgeport_port *edge_port = usb_get_serial_port_data(port); 2369 2370 if (edge_port == NULL) 2371 return; 2372 /* change the port settings to the new ones specified */ 2373 change_port_settings(tty, edge_port, old_termios); 2374 } 2375 2376 static int edge_tiocmset(struct tty_struct *tty, 2377 unsigned int set, unsigned int clear) 2378 { 2379 struct usb_serial_port *port = tty->driver_data; 2380 struct edgeport_port *edge_port = usb_get_serial_port_data(port); 2381 unsigned int mcr; 2382 unsigned long flags; 2383 2384 spin_lock_irqsave(&edge_port->ep_lock, flags); 2385 mcr = edge_port->shadow_mcr; 2386 if (set & TIOCM_RTS) 2387 mcr |= MCR_RTS; 2388 if (set & TIOCM_DTR) 2389 mcr |= MCR_DTR; 2390 if (set & TIOCM_LOOP) 2391 mcr |= MCR_LOOPBACK; 2392 2393 if (clear & TIOCM_RTS) 2394 mcr &= ~MCR_RTS; 2395 if (clear & TIOCM_DTR) 2396 mcr &= ~MCR_DTR; 2397 if (clear & TIOCM_LOOP) 2398 mcr &= ~MCR_LOOPBACK; 2399 2400 edge_port->shadow_mcr = mcr; 2401 spin_unlock_irqrestore(&edge_port->ep_lock, flags); 2402 2403 restore_mcr(edge_port, mcr); 2404 return 0; 2405 } 2406 2407 static int edge_tiocmget(struct tty_struct *tty) 2408 { 2409 struct usb_serial_port *port = tty->driver_data; 2410 struct edgeport_port *edge_port = usb_get_serial_port_data(port); 2411 unsigned int result = 0; 2412 unsigned int msr; 2413 unsigned int mcr; 2414 unsigned long flags; 2415 2416 spin_lock_irqsave(&edge_port->ep_lock, flags); 2417 2418 msr = edge_port->shadow_msr; 2419 mcr = edge_port->shadow_mcr; 2420 result = ((mcr & MCR_DTR) ? TIOCM_DTR: 0) /* 0x002 */ 2421 | ((mcr & MCR_RTS) ? TIOCM_RTS: 0) /* 0x004 */ 2422 | ((msr & EDGEPORT_MSR_CTS) ? TIOCM_CTS: 0) /* 0x020 */ 2423 | ((msr & EDGEPORT_MSR_CD) ? TIOCM_CAR: 0) /* 0x040 */ 2424 | ((msr & EDGEPORT_MSR_RI) ? TIOCM_RI: 0) /* 0x080 */ 2425 | ((msr & EDGEPORT_MSR_DSR) ? TIOCM_DSR: 0); /* 0x100 */ 2426 2427 2428 dev_dbg(&port->dev, "%s -- %x\n", __func__, result); 2429 spin_unlock_irqrestore(&edge_port->ep_lock, flags); 2430 2431 return result; 2432 } 2433 2434 static int edge_break(struct tty_struct *tty, int break_state) 2435 { 2436 struct usb_serial_port *port = tty->driver_data; 2437 struct edgeport_port *edge_port = usb_get_serial_port_data(port); 2438 int status; 2439 int bv = 0; /* Off */ 2440 2441 if (break_state == -1) 2442 bv = 1; /* On */ 2443 2444 status = ti_do_config(edge_port, UMPC_SET_CLR_BREAK, bv); 2445 if (status) { 2446 dev_dbg(&port->dev, "%s - error %d sending break set/clear command.\n", 2447 __func__, status); 2448 return status; 2449 } 2450 2451 return 0; 2452 } 2453 2454 static void edge_heartbeat_schedule(struct edgeport_serial *edge_serial) 2455 { 2456 if (!edge_serial->use_heartbeat) 2457 return; 2458 2459 schedule_delayed_work(&edge_serial->heartbeat_work, 2460 FW_HEARTBEAT_SECS * HZ); 2461 } 2462 2463 static void edge_heartbeat_work(struct work_struct *work) 2464 { 2465 struct edgeport_serial *serial; 2466 struct ti_i2c_desc *rom_desc; 2467 2468 serial = container_of(work, struct edgeport_serial, 2469 heartbeat_work.work); 2470 2471 rom_desc = kmalloc_obj(*rom_desc); 2472 2473 /* Descriptor address request is enough to reset the firmware timer */ 2474 if (!rom_desc || !get_descriptor_addr(serial, I2C_DESC_TYPE_ION, 2475 rom_desc)) { 2476 dev_err(&serial->serial->interface->dev, 2477 "%s - Incomplete heartbeat\n", __func__); 2478 } 2479 kfree(rom_desc); 2480 2481 edge_heartbeat_schedule(serial); 2482 } 2483 2484 static int edge_calc_num_ports(struct usb_serial *serial, 2485 struct usb_serial_endpoints *epds) 2486 { 2487 struct device *dev = &serial->interface->dev; 2488 unsigned char num_ports = serial->type->num_ports; 2489 2490 /* Make sure we have the required endpoints when in download mode. */ 2491 if (serial->interface->cur_altsetting->desc.bNumEndpoints > 1) { 2492 if (epds->num_bulk_in < num_ports || 2493 epds->num_bulk_out < num_ports || 2494 epds->num_interrupt_in < 1) { 2495 dev_err(dev, "required endpoints missing\n"); 2496 return -ENODEV; 2497 } 2498 } 2499 2500 return num_ports; 2501 } 2502 2503 static int edge_startup(struct usb_serial *serial) 2504 { 2505 struct edgeport_serial *edge_serial; 2506 int status; 2507 u16 product_id; 2508 2509 /* create our private serial structure */ 2510 edge_serial = kzalloc_obj(struct edgeport_serial); 2511 if (!edge_serial) 2512 return -ENOMEM; 2513 2514 mutex_init(&edge_serial->es_lock); 2515 edge_serial->serial = serial; 2516 INIT_DELAYED_WORK(&edge_serial->heartbeat_work, edge_heartbeat_work); 2517 usb_set_serial_data(serial, edge_serial); 2518 2519 status = download_fw(edge_serial); 2520 if (status < 0) { 2521 kfree(edge_serial); 2522 return status; 2523 } 2524 2525 if (status > 0) 2526 return 1; /* bind but do not register any ports */ 2527 2528 product_id = le16_to_cpu( 2529 edge_serial->serial->dev->descriptor.idProduct); 2530 2531 /* Currently only the EP/416 models require heartbeat support */ 2532 if (edge_serial->fw_version > FW_HEARTBEAT_VERSION_CUTOFF) { 2533 if (product_id == ION_DEVICE_ID_TI_EDGEPORT_416 || 2534 product_id == ION_DEVICE_ID_TI_EDGEPORT_416B) { 2535 edge_serial->use_heartbeat = true; 2536 } 2537 } 2538 2539 edge_heartbeat_schedule(edge_serial); 2540 2541 return 0; 2542 } 2543 2544 static void edge_disconnect(struct usb_serial *serial) 2545 { 2546 struct edgeport_serial *edge_serial = usb_get_serial_data(serial); 2547 2548 cancel_delayed_work_sync(&edge_serial->heartbeat_work); 2549 } 2550 2551 static void edge_release(struct usb_serial *serial) 2552 { 2553 struct edgeport_serial *edge_serial = usb_get_serial_data(serial); 2554 2555 cancel_delayed_work_sync(&edge_serial->heartbeat_work); 2556 kfree(edge_serial); 2557 } 2558 2559 static int edge_port_probe(struct usb_serial_port *port) 2560 { 2561 struct edgeport_port *edge_port; 2562 int ret; 2563 2564 edge_port = kzalloc_obj(*edge_port); 2565 if (!edge_port) 2566 return -ENOMEM; 2567 2568 spin_lock_init(&edge_port->ep_lock); 2569 edge_port->port = port; 2570 edge_port->edge_serial = usb_get_serial_data(port->serial); 2571 edge_port->bUartMode = default_uart_mode; 2572 2573 switch (port->port_number) { 2574 case 0: 2575 edge_port->uart_base = UMPMEM_BASE_UART1; 2576 edge_port->dma_address = UMPD_OEDB1_ADDRESS; 2577 break; 2578 case 1: 2579 edge_port->uart_base = UMPMEM_BASE_UART2; 2580 edge_port->dma_address = UMPD_OEDB2_ADDRESS; 2581 break; 2582 default: 2583 dev_err(&port->dev, "unknown port number\n"); 2584 ret = -ENODEV; 2585 goto err; 2586 } 2587 2588 dev_dbg(&port->dev, 2589 "%s - port_number = %d, uart_base = %04x, dma_address = %04x\n", 2590 __func__, port->port_number, edge_port->uart_base, 2591 edge_port->dma_address); 2592 2593 usb_set_serial_port_data(port, edge_port); 2594 2595 ret = edge_create_sysfs_attrs(port); 2596 if (ret) 2597 goto err; 2598 2599 /* 2600 * The LSR does not tell when the transmitter shift register has 2601 * emptied so add a one-character drain delay. 2602 */ 2603 port->port.drain_delay = 1; 2604 2605 return 0; 2606 err: 2607 kfree(edge_port); 2608 2609 return ret; 2610 } 2611 2612 static void edge_port_remove(struct usb_serial_port *port) 2613 { 2614 struct edgeport_port *edge_port; 2615 2616 edge_port = usb_get_serial_port_data(port); 2617 edge_remove_sysfs_attrs(port); 2618 kfree(edge_port); 2619 } 2620 2621 /* Sysfs Attributes */ 2622 2623 static ssize_t uart_mode_show(struct device *dev, 2624 struct device_attribute *attr, char *buf) 2625 { 2626 struct usb_serial_port *port = to_usb_serial_port(dev); 2627 struct edgeport_port *edge_port = usb_get_serial_port_data(port); 2628 2629 return sprintf(buf, "%d\n", edge_port->bUartMode); 2630 } 2631 2632 static ssize_t uart_mode_store(struct device *dev, 2633 struct device_attribute *attr, const char *valbuf, size_t count) 2634 { 2635 struct usb_serial_port *port = to_usb_serial_port(dev); 2636 struct edgeport_port *edge_port = usb_get_serial_port_data(port); 2637 unsigned int v = simple_strtoul(valbuf, NULL, 0); 2638 2639 dev_dbg(dev, "%s: setting uart_mode = %d\n", __func__, v); 2640 2641 if (v < 256) 2642 edge_port->bUartMode = v; 2643 else 2644 dev_err(dev, "%s - uart_mode %d is invalid\n", __func__, v); 2645 2646 return count; 2647 } 2648 static DEVICE_ATTR_RW(uart_mode); 2649 2650 static int edge_create_sysfs_attrs(struct usb_serial_port *port) 2651 { 2652 return device_create_file(&port->dev, &dev_attr_uart_mode); 2653 } 2654 2655 static int edge_remove_sysfs_attrs(struct usb_serial_port *port) 2656 { 2657 device_remove_file(&port->dev, &dev_attr_uart_mode); 2658 return 0; 2659 } 2660 2661 #ifdef CONFIG_PM 2662 static int edge_suspend(struct usb_serial *serial, pm_message_t message) 2663 { 2664 struct edgeport_serial *edge_serial = usb_get_serial_data(serial); 2665 2666 cancel_delayed_work_sync(&edge_serial->heartbeat_work); 2667 2668 return 0; 2669 } 2670 2671 static int edge_resume(struct usb_serial *serial) 2672 { 2673 struct edgeport_serial *edge_serial = usb_get_serial_data(serial); 2674 2675 edge_heartbeat_schedule(edge_serial); 2676 2677 return 0; 2678 } 2679 #endif 2680 2681 static struct usb_serial_driver edgeport_1port_device = { 2682 .driver = { 2683 .name = "edgeport_ti_1", 2684 }, 2685 .description = "Edgeport TI 1 port adapter", 2686 .id_table = edgeport_1port_id_table, 2687 .num_ports = 1, 2688 .num_bulk_out = 1, 2689 .open = edge_open, 2690 .close = edge_close, 2691 .throttle = edge_throttle, 2692 .unthrottle = edge_unthrottle, 2693 .attach = edge_startup, 2694 .calc_num_ports = edge_calc_num_ports, 2695 .disconnect = edge_disconnect, 2696 .release = edge_release, 2697 .port_probe = edge_port_probe, 2698 .port_remove = edge_port_remove, 2699 .set_termios = edge_set_termios, 2700 .tiocmget = edge_tiocmget, 2701 .tiocmset = edge_tiocmset, 2702 .tiocmiwait = usb_serial_generic_tiocmiwait, 2703 .get_icount = usb_serial_generic_get_icount, 2704 .write = edge_write, 2705 .write_room = edge_write_room, 2706 .chars_in_buffer = edge_chars_in_buffer, 2707 .tx_empty = edge_tx_empty, 2708 .break_ctl = edge_break, 2709 .read_int_callback = edge_interrupt_callback, 2710 .read_bulk_callback = edge_bulk_in_callback, 2711 .write_bulk_callback = edge_bulk_out_callback, 2712 #ifdef CONFIG_PM 2713 .suspend = edge_suspend, 2714 .resume = edge_resume, 2715 #endif 2716 }; 2717 2718 static struct usb_serial_driver edgeport_2port_device = { 2719 .driver = { 2720 .name = "edgeport_ti_2", 2721 }, 2722 .description = "Edgeport TI 2 port adapter", 2723 .id_table = edgeport_2port_id_table, 2724 .num_ports = 2, 2725 .num_bulk_out = 1, 2726 .open = edge_open, 2727 .close = edge_close, 2728 .throttle = edge_throttle, 2729 .unthrottle = edge_unthrottle, 2730 .attach = edge_startup, 2731 .calc_num_ports = edge_calc_num_ports, 2732 .disconnect = edge_disconnect, 2733 .release = edge_release, 2734 .port_probe = edge_port_probe, 2735 .port_remove = edge_port_remove, 2736 .set_termios = edge_set_termios, 2737 .tiocmget = edge_tiocmget, 2738 .tiocmset = edge_tiocmset, 2739 .tiocmiwait = usb_serial_generic_tiocmiwait, 2740 .get_icount = usb_serial_generic_get_icount, 2741 .write = edge_write, 2742 .write_room = edge_write_room, 2743 .chars_in_buffer = edge_chars_in_buffer, 2744 .tx_empty = edge_tx_empty, 2745 .break_ctl = edge_break, 2746 .read_int_callback = edge_interrupt_callback, 2747 .read_bulk_callback = edge_bulk_in_callback, 2748 .write_bulk_callback = edge_bulk_out_callback, 2749 #ifdef CONFIG_PM 2750 .suspend = edge_suspend, 2751 .resume = edge_resume, 2752 #endif 2753 }; 2754 2755 static struct usb_serial_driver * const serial_drivers[] = { 2756 &edgeport_1port_device, &edgeport_2port_device, NULL 2757 }; 2758 2759 module_usb_serial_driver(serial_drivers, id_table_combined); 2760 2761 MODULE_AUTHOR(DRIVER_AUTHOR); 2762 MODULE_DESCRIPTION(DRIVER_DESC); 2763 MODULE_LICENSE("GPL"); 2764 MODULE_FIRMWARE("edgeport/down3.bin"); 2765 2766 module_param(ignore_cpu_rev, bool, 0644); 2767 MODULE_PARM_DESC(ignore_cpu_rev, 2768 "Ignore the cpu revision when connecting to a device"); 2769 2770 module_param(default_uart_mode, int, 0644); 2771 MODULE_PARM_DESC(default_uart_mode, "Default uart_mode, 0=RS232, ..."); 2772