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