1 // SPDX-License-Identifier: GPL-2.0-only 2 /****************************************************************************** 3 * 4 * Driver for Option High Speed Mobile Devices. 5 * 6 * Copyright (C) 2008 Option International 7 * Filip Aben <f.aben@option.com> 8 * Denis Joseph Barrow <d.barow@option.com> 9 * Jan Dumon <j.dumon@option.com> 10 * Copyright (C) 2007 Andrew Bird (Sphere Systems Ltd) 11 * <ajb@spheresystems.co.uk> 12 * Copyright (C) 2008 Greg Kroah-Hartman <gregkh@suse.de> 13 * Copyright (C) 2008 Novell, Inc. 14 * 15 *****************************************************************************/ 16 17 /****************************************************************************** 18 * 19 * Description of the device: 20 * 21 * Interface 0: Contains the IP network interface on the bulk end points. 22 * The multiplexed serial ports are using the interrupt and 23 * control endpoints. 24 * Interrupt contains a bitmap telling which multiplexed 25 * serialport needs servicing. 26 * 27 * Interface 1: Diagnostics port, uses bulk only, do not submit urbs until the 28 * port is opened, as this have a huge impact on the network port 29 * throughput. 30 * 31 * Interface 2: Standard modem interface - circuit switched interface, this 32 * can be used to make a standard ppp connection however it 33 * should not be used in conjunction with the IP network interface 34 * enabled for USB performance reasons i.e. if using this set 35 * ideally disable_net=1. 36 * 37 *****************************************************************************/ 38 39 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt 40 41 #include <linux/sched/signal.h> 42 #include <linux/slab.h> 43 #include <linux/init.h> 44 #include <linux/delay.h> 45 #include <linux/netdevice.h> 46 #include <linux/module.h> 47 #include <linux/ethtool.h> 48 #include <linux/usb.h> 49 #include <linux/tty.h> 50 #include <linux/tty_driver.h> 51 #include <linux/tty_flip.h> 52 #include <linux/kmod.h> 53 #include <linux/rfkill.h> 54 #include <linux/ip.h> 55 #include <linux/uaccess.h> 56 #include <linux/usb/cdc.h> 57 #include <net/arp.h> 58 #include <asm/byteorder.h> 59 #include <linux/serial_core.h> 60 #include <linux/serial.h> 61 62 63 #define MOD_AUTHOR "Option Wireless" 64 #define MOD_DESCRIPTION "USB High Speed Option driver" 65 66 #define HSO_MAX_NET_DEVICES 10 67 #define HSO__MAX_MTU 2048 68 #define DEFAULT_MTU 1500 69 #define DEFAULT_MRU 1500 70 71 #define CTRL_URB_RX_SIZE 1024 72 #define CTRL_URB_TX_SIZE 64 73 74 #define BULK_URB_RX_SIZE 4096 75 #define BULK_URB_TX_SIZE 8192 76 77 #define MUX_BULK_RX_BUF_SIZE HSO__MAX_MTU 78 #define MUX_BULK_TX_BUF_SIZE HSO__MAX_MTU 79 #define MUX_BULK_RX_BUF_COUNT 4 80 #define USB_TYPE_OPTION_VENDOR 0x20 81 82 /* These definitions are used with the struct hso_net flags element */ 83 /* - use *_bit operations on it. (bit indices not values.) */ 84 #define HSO_NET_RUNNING 0 85 86 #define HSO_NET_TX_TIMEOUT (HZ*10) 87 88 #define HSO_SERIAL_MAGIC 0x48534f31 89 90 /* Number of ttys to handle */ 91 #define HSO_SERIAL_TTY_MINORS 256 92 93 #define MAX_RX_URBS 2 94 95 /*****************************************************************************/ 96 /* Debugging functions */ 97 /*****************************************************************************/ 98 #define hso_dbg(lvl, fmt, ...) \ 99 do { \ 100 if ((lvl) & debug) \ 101 pr_info("[%d:%s] " fmt, \ 102 __LINE__, __func__, ##__VA_ARGS__); \ 103 } while (0) 104 105 /*****************************************************************************/ 106 /* Enumerators */ 107 /*****************************************************************************/ 108 enum pkt_parse_state { 109 WAIT_IP, 110 WAIT_DATA, 111 WAIT_SYNC 112 }; 113 114 /*****************************************************************************/ 115 /* Structs */ 116 /*****************************************************************************/ 117 118 struct hso_shared_int { 119 struct usb_endpoint_descriptor *intr_endp; 120 void *shared_intr_buf; 121 struct urb *shared_intr_urb; 122 struct usb_device *usb; 123 int use_count; 124 int ref_count; 125 struct mutex shared_int_lock; 126 }; 127 128 struct hso_net { 129 struct hso_device *parent; 130 struct net_device *net; 131 struct rfkill *rfkill; 132 char name[24]; 133 134 struct usb_endpoint_descriptor *in_endp; 135 struct usb_endpoint_descriptor *out_endp; 136 137 struct urb *mux_bulk_rx_urb_pool[MUX_BULK_RX_BUF_COUNT]; 138 struct urb *mux_bulk_tx_urb; 139 void *mux_bulk_rx_buf_pool[MUX_BULK_RX_BUF_COUNT]; 140 void *mux_bulk_tx_buf; 141 142 struct sk_buff *skb_rx_buf; 143 struct sk_buff *skb_tx_buf; 144 145 enum pkt_parse_state rx_parse_state; 146 spinlock_t net_lock; 147 148 unsigned short rx_buf_size; 149 unsigned short rx_buf_missing; 150 struct iphdr rx_ip_hdr; 151 152 unsigned long flags; 153 }; 154 155 enum rx_ctrl_state{ 156 RX_IDLE, 157 RX_SENT, 158 RX_PENDING 159 }; 160 161 #define BM_REQUEST_TYPE (0xa1) 162 #define B_NOTIFICATION (0x20) 163 #define W_VALUE (0x0) 164 #define W_LENGTH (0x2) 165 166 #define B_OVERRUN (0x1<<6) 167 #define B_PARITY (0x1<<5) 168 #define B_FRAMING (0x1<<4) 169 #define B_RING_SIGNAL (0x1<<3) 170 #define B_BREAK (0x1<<2) 171 #define B_TX_CARRIER (0x1<<1) 172 #define B_RX_CARRIER (0x1<<0) 173 174 struct hso_serial_state_notification { 175 u8 bmRequestType; 176 u8 bNotification; 177 u16 wValue; 178 u16 wIndex; 179 u16 wLength; 180 u16 UART_state_bitmap; 181 } __packed; 182 183 struct hso_tiocmget { 184 struct mutex mutex; 185 wait_queue_head_t waitq; 186 int intr_completed; 187 struct usb_endpoint_descriptor *endp; 188 struct urb *urb; 189 struct hso_serial_state_notification *serial_state_notification; 190 u16 prev_UART_state_bitmap; 191 struct uart_icount icount; 192 }; 193 194 195 struct hso_serial { 196 struct hso_device *parent; 197 int magic; 198 u8 minor; 199 200 struct hso_shared_int *shared_int; 201 202 /* rx/tx urb could be either a bulk urb or a control urb depending 203 on which serial port it is used on. */ 204 struct urb *rx_urb[MAX_RX_URBS]; 205 u8 num_rx_urbs; 206 u8 *rx_data[MAX_RX_URBS]; 207 u16 rx_data_length; /* should contain allocated length */ 208 209 struct urb *tx_urb; 210 u8 *tx_data; 211 u8 *tx_buffer; 212 u16 tx_data_length; /* should contain allocated length */ 213 u16 tx_data_count; 214 u16 tx_buffer_count; 215 struct usb_ctrlrequest ctrl_req_tx; 216 struct usb_ctrlrequest ctrl_req_rx; 217 218 struct usb_endpoint_descriptor *in_endp; 219 struct usb_endpoint_descriptor *out_endp; 220 221 enum rx_ctrl_state rx_state; 222 u8 rts_state; 223 u8 dtr_state; 224 unsigned tx_urb_used:1; 225 226 struct tty_port port; 227 /* from usb_serial_port */ 228 spinlock_t serial_lock; 229 230 int (*write_data) (struct hso_serial *serial); 231 struct hso_tiocmget *tiocmget; 232 /* Hacks required to get flow control 233 * working on the serial receive buffers 234 * so as not to drop characters on the floor. 235 */ 236 int curr_rx_urb_idx; 237 u8 rx_urb_filled[MAX_RX_URBS]; 238 struct tasklet_struct unthrottle_tasklet; 239 }; 240 241 struct hso_device { 242 union { 243 struct hso_serial *dev_serial; 244 struct hso_net *dev_net; 245 } port_data; 246 247 u32 port_spec; 248 249 u8 is_active; 250 u8 usb_gone; 251 struct work_struct async_get_intf; 252 struct work_struct async_put_intf; 253 254 struct usb_device *usb; 255 struct usb_interface *interface; 256 257 struct device *dev; 258 struct kref ref; 259 struct mutex mutex; 260 }; 261 262 /* Type of interface */ 263 #define HSO_INTF_MASK 0xFF00 264 #define HSO_INTF_MUX 0x0100 265 #define HSO_INTF_BULK 0x0200 266 267 /* Type of port */ 268 #define HSO_PORT_MASK 0xFF 269 #define HSO_PORT_NO_PORT 0x0 270 #define HSO_PORT_CONTROL 0x1 271 #define HSO_PORT_APP 0x2 272 #define HSO_PORT_GPS 0x3 273 #define HSO_PORT_PCSC 0x4 274 #define HSO_PORT_APP2 0x5 275 #define HSO_PORT_GPS_CONTROL 0x6 276 #define HSO_PORT_MSD 0x7 277 #define HSO_PORT_VOICE 0x8 278 #define HSO_PORT_DIAG2 0x9 279 #define HSO_PORT_DIAG 0x10 280 #define HSO_PORT_MODEM 0x11 281 #define HSO_PORT_NETWORK 0x12 282 283 /* Additional device info */ 284 #define HSO_INFO_MASK 0xFF000000 285 #define HSO_INFO_CRC_BUG 0x01000000 286 287 /*****************************************************************************/ 288 /* Prototypes */ 289 /*****************************************************************************/ 290 /* Serial driver functions */ 291 static int hso_serial_tiocmset(struct tty_struct *tty, 292 unsigned int set, unsigned int clear); 293 static void ctrl_callback(struct urb *urb); 294 static int put_rxbuf_data(struct urb *urb, struct hso_serial *serial); 295 static void hso_kick_transmit(struct hso_serial *serial); 296 /* Helper functions */ 297 static int hso_mux_submit_intr_urb(struct hso_shared_int *mux_int, 298 struct usb_device *usb, gfp_t gfp); 299 static void handle_usb_error(int status, const char *function, 300 struct hso_device *hso_dev); 301 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf, 302 int type, int dir); 303 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports); 304 static void hso_free_interface(struct usb_interface *intf); 305 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags); 306 static int hso_stop_serial_device(struct hso_device *hso_dev); 307 static int hso_start_net_device(struct hso_device *hso_dev); 308 static void hso_free_shared_int(struct hso_shared_int *shared_int); 309 static int hso_stop_net_device(struct hso_device *hso_dev); 310 static void hso_serial_ref_free(struct kref *ref); 311 static void hso_std_serial_read_bulk_callback(struct urb *urb); 312 static int hso_mux_serial_read(struct hso_serial *serial); 313 static void async_get_intf(struct work_struct *data); 314 static void async_put_intf(struct work_struct *data); 315 static int hso_put_activity(struct hso_device *hso_dev); 316 static int hso_get_activity(struct hso_device *hso_dev); 317 static void tiocmget_intr_callback(struct urb *urb); 318 /*****************************************************************************/ 319 /* Helping functions */ 320 /*****************************************************************************/ 321 322 /* #define DEBUG */ 323 324 static inline struct hso_net *dev2net(struct hso_device *hso_dev) 325 { 326 return hso_dev->port_data.dev_net; 327 } 328 329 static inline struct hso_serial *dev2ser(struct hso_device *hso_dev) 330 { 331 return hso_dev->port_data.dev_serial; 332 } 333 334 /* Debugging functions */ 335 #ifdef DEBUG 336 static void dbg_dump(int line_count, const char *func_name, unsigned char *buf, 337 unsigned int len) 338 { 339 static char name[255]; 340 341 sprintf(name, "hso[%d:%s]", line_count, func_name); 342 print_hex_dump_bytes(name, DUMP_PREFIX_NONE, buf, len); 343 } 344 345 #define DUMP(buf_, len_) \ 346 dbg_dump(__LINE__, __func__, (unsigned char *)buf_, len_) 347 348 #define DUMP1(buf_, len_) \ 349 do { \ 350 if (0x01 & debug) \ 351 DUMP(buf_, len_); \ 352 } while (0) 353 #else 354 #define DUMP(buf_, len_) 355 #define DUMP1(buf_, len_) 356 #endif 357 358 /* module parameters */ 359 static int debug; 360 static int tty_major; 361 static int disable_net; 362 363 /* driver info */ 364 static const char driver_name[] = "hso"; 365 static const char tty_filename[] = "ttyHS"; 366 static const char *version = __FILE__ ": " MOD_AUTHOR; 367 /* the usb driver itself (registered in hso_init) */ 368 static struct usb_driver hso_driver; 369 /* serial structures */ 370 static struct tty_driver *tty_drv; 371 static struct hso_device *serial_table[HSO_SERIAL_TTY_MINORS]; 372 static struct hso_device *network_table[HSO_MAX_NET_DEVICES]; 373 static DEFINE_SPINLOCK(serial_table_lock); 374 375 static const s32 default_port_spec[] = { 376 HSO_INTF_MUX | HSO_PORT_NETWORK, 377 HSO_INTF_BULK | HSO_PORT_DIAG, 378 HSO_INTF_BULK | HSO_PORT_MODEM, 379 0 380 }; 381 382 static const s32 icon321_port_spec[] = { 383 HSO_INTF_MUX | HSO_PORT_NETWORK, 384 HSO_INTF_BULK | HSO_PORT_DIAG2, 385 HSO_INTF_BULK | HSO_PORT_MODEM, 386 HSO_INTF_BULK | HSO_PORT_DIAG, 387 0 388 }; 389 390 #define default_port_device(vendor, product) \ 391 USB_DEVICE(vendor, product), \ 392 .driver_info = (kernel_ulong_t)default_port_spec 393 394 #define icon321_port_device(vendor, product) \ 395 USB_DEVICE(vendor, product), \ 396 .driver_info = (kernel_ulong_t)icon321_port_spec 397 398 /* list of devices we support */ 399 static const struct usb_device_id hso_ids[] = { 400 {default_port_device(0x0af0, 0x6711)}, 401 {default_port_device(0x0af0, 0x6731)}, 402 {default_port_device(0x0af0, 0x6751)}, 403 {default_port_device(0x0af0, 0x6771)}, 404 {default_port_device(0x0af0, 0x6791)}, 405 {default_port_device(0x0af0, 0x6811)}, 406 {default_port_device(0x0af0, 0x6911)}, 407 {default_port_device(0x0af0, 0x6951)}, 408 {default_port_device(0x0af0, 0x6971)}, 409 {default_port_device(0x0af0, 0x7011)}, 410 {default_port_device(0x0af0, 0x7031)}, 411 {default_port_device(0x0af0, 0x7051)}, 412 {default_port_device(0x0af0, 0x7071)}, 413 {default_port_device(0x0af0, 0x7111)}, 414 {default_port_device(0x0af0, 0x7211)}, 415 {default_port_device(0x0af0, 0x7251)}, 416 {default_port_device(0x0af0, 0x7271)}, 417 {default_port_device(0x0af0, 0x7311)}, 418 {default_port_device(0x0af0, 0xc031)}, /* Icon-Edge */ 419 {icon321_port_device(0x0af0, 0xd013)}, /* Module HSxPA */ 420 {icon321_port_device(0x0af0, 0xd031)}, /* Icon-321 */ 421 {icon321_port_device(0x0af0, 0xd033)}, /* Icon-322 */ 422 {USB_DEVICE(0x0af0, 0x7301)}, /* GE40x */ 423 {USB_DEVICE(0x0af0, 0x7361)}, /* GE40x */ 424 {USB_DEVICE(0x0af0, 0x7381)}, /* GE40x */ 425 {USB_DEVICE(0x0af0, 0x7401)}, /* GI 0401 */ 426 {USB_DEVICE(0x0af0, 0x7501)}, /* GTM 382 */ 427 {USB_DEVICE(0x0af0, 0x7601)}, /* GE40x */ 428 {USB_DEVICE(0x0af0, 0x7701)}, 429 {USB_DEVICE(0x0af0, 0x7706)}, 430 {USB_DEVICE(0x0af0, 0x7801)}, 431 {USB_DEVICE(0x0af0, 0x7901)}, 432 {USB_DEVICE(0x0af0, 0x7A01)}, 433 {USB_DEVICE(0x0af0, 0x7A05)}, 434 {USB_DEVICE(0x0af0, 0x8200)}, 435 {USB_DEVICE(0x0af0, 0x8201)}, 436 {USB_DEVICE(0x0af0, 0x8300)}, 437 {USB_DEVICE(0x0af0, 0x8302)}, 438 {USB_DEVICE(0x0af0, 0x8304)}, 439 {USB_DEVICE(0x0af0, 0x8400)}, 440 {USB_DEVICE(0x0af0, 0x8600)}, 441 {USB_DEVICE(0x0af0, 0x8800)}, 442 {USB_DEVICE(0x0af0, 0x8900)}, 443 {USB_DEVICE(0x0af0, 0x9000)}, 444 {USB_DEVICE(0x0af0, 0x9200)}, /* Option GTM671WFS */ 445 {USB_DEVICE(0x0af0, 0xd035)}, 446 {USB_DEVICE(0x0af0, 0xd055)}, 447 {USB_DEVICE(0x0af0, 0xd155)}, 448 {USB_DEVICE(0x0af0, 0xd255)}, 449 {USB_DEVICE(0x0af0, 0xd057)}, 450 {USB_DEVICE(0x0af0, 0xd157)}, 451 {USB_DEVICE(0x0af0, 0xd257)}, 452 {USB_DEVICE(0x0af0, 0xd357)}, 453 {USB_DEVICE(0x0af0, 0xd058)}, 454 {USB_DEVICE(0x0af0, 0xc100)}, 455 {} 456 }; 457 MODULE_DEVICE_TABLE(usb, hso_ids); 458 459 /* Sysfs attribute */ 460 static ssize_t hsotype_show(struct device *dev, 461 struct device_attribute *attr, char *buf) 462 { 463 struct hso_device *hso_dev = dev_get_drvdata(dev); 464 char *port_name; 465 466 if (!hso_dev) 467 return 0; 468 469 switch (hso_dev->port_spec & HSO_PORT_MASK) { 470 case HSO_PORT_CONTROL: 471 port_name = "Control"; 472 break; 473 case HSO_PORT_APP: 474 port_name = "Application"; 475 break; 476 case HSO_PORT_APP2: 477 port_name = "Application2"; 478 break; 479 case HSO_PORT_GPS: 480 port_name = "GPS"; 481 break; 482 case HSO_PORT_GPS_CONTROL: 483 port_name = "GPS Control"; 484 break; 485 case HSO_PORT_PCSC: 486 port_name = "PCSC"; 487 break; 488 case HSO_PORT_DIAG: 489 port_name = "Diagnostic"; 490 break; 491 case HSO_PORT_DIAG2: 492 port_name = "Diagnostic2"; 493 break; 494 case HSO_PORT_MODEM: 495 port_name = "Modem"; 496 break; 497 case HSO_PORT_NETWORK: 498 port_name = "Network"; 499 break; 500 default: 501 port_name = "Unknown"; 502 break; 503 } 504 505 return sprintf(buf, "%s\n", port_name); 506 } 507 static DEVICE_ATTR_RO(hsotype); 508 509 static struct attribute *hso_serial_dev_attrs[] = { 510 &dev_attr_hsotype.attr, 511 NULL 512 }; 513 514 ATTRIBUTE_GROUPS(hso_serial_dev); 515 516 static int hso_urb_to_index(struct hso_serial *serial, struct urb *urb) 517 { 518 int idx; 519 520 for (idx = 0; idx < serial->num_rx_urbs; idx++) 521 if (serial->rx_urb[idx] == urb) 522 return idx; 523 dev_err(serial->parent->dev, "hso_urb_to_index failed\n"); 524 return -1; 525 } 526 527 /* converts mux value to a port spec value */ 528 static u32 hso_mux_to_port(int mux) 529 { 530 u32 result; 531 532 switch (mux) { 533 case 0x1: 534 result = HSO_PORT_CONTROL; 535 break; 536 case 0x2: 537 result = HSO_PORT_APP; 538 break; 539 case 0x4: 540 result = HSO_PORT_PCSC; 541 break; 542 case 0x8: 543 result = HSO_PORT_GPS; 544 break; 545 case 0x10: 546 result = HSO_PORT_APP2; 547 break; 548 default: 549 result = HSO_PORT_NO_PORT; 550 } 551 return result; 552 } 553 554 /* converts port spec value to a mux value */ 555 static u32 hso_port_to_mux(int port) 556 { 557 u32 result; 558 559 switch (port & HSO_PORT_MASK) { 560 case HSO_PORT_CONTROL: 561 result = 0x0; 562 break; 563 case HSO_PORT_APP: 564 result = 0x1; 565 break; 566 case HSO_PORT_PCSC: 567 result = 0x2; 568 break; 569 case HSO_PORT_GPS: 570 result = 0x3; 571 break; 572 case HSO_PORT_APP2: 573 result = 0x4; 574 break; 575 default: 576 result = 0x0; 577 } 578 return result; 579 } 580 581 static struct hso_serial *get_serial_by_shared_int_and_type( 582 struct hso_shared_int *shared_int, 583 int mux) 584 { 585 int i, port; 586 587 port = hso_mux_to_port(mux); 588 589 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) { 590 if (serial_table[i] && 591 (dev2ser(serial_table[i])->shared_int == shared_int) && 592 ((serial_table[i]->port_spec & HSO_PORT_MASK) == port)) { 593 return dev2ser(serial_table[i]); 594 } 595 } 596 597 return NULL; 598 } 599 600 static struct hso_serial *get_serial_by_index(unsigned index) 601 { 602 struct hso_serial *serial = NULL; 603 unsigned long flags; 604 605 spin_lock_irqsave(&serial_table_lock, flags); 606 if (serial_table[index]) 607 serial = dev2ser(serial_table[index]); 608 spin_unlock_irqrestore(&serial_table_lock, flags); 609 610 return serial; 611 } 612 613 static int obtain_minor(struct hso_serial *serial) 614 { 615 int index; 616 unsigned long flags; 617 618 spin_lock_irqsave(&serial_table_lock, flags); 619 for (index = 0; index < HSO_SERIAL_TTY_MINORS; index++) { 620 if (serial_table[index] == NULL) { 621 serial_table[index] = serial->parent; 622 serial->minor = index; 623 spin_unlock_irqrestore(&serial_table_lock, flags); 624 return 0; 625 } 626 } 627 spin_unlock_irqrestore(&serial_table_lock, flags); 628 629 pr_err("%s: no free serial devices in table\n", __func__); 630 return -1; 631 } 632 633 static void release_minor(struct hso_serial *serial) 634 { 635 unsigned long flags; 636 637 spin_lock_irqsave(&serial_table_lock, flags); 638 serial_table[serial->minor] = NULL; 639 spin_unlock_irqrestore(&serial_table_lock, flags); 640 } 641 642 static void handle_usb_error(int status, const char *function, 643 struct hso_device *hso_dev) 644 { 645 char *explanation; 646 647 switch (status) { 648 case -ENODEV: 649 explanation = "no device"; 650 break; 651 case -ENOENT: 652 explanation = "endpoint not enabled"; 653 break; 654 case -EPIPE: 655 explanation = "endpoint stalled"; 656 break; 657 case -ENOSPC: 658 explanation = "not enough bandwidth"; 659 break; 660 case -ESHUTDOWN: 661 explanation = "device disabled"; 662 break; 663 case -EHOSTUNREACH: 664 explanation = "device suspended"; 665 break; 666 case -EINVAL: 667 case -EAGAIN: 668 case -EFBIG: 669 case -EMSGSIZE: 670 explanation = "internal error"; 671 break; 672 case -EILSEQ: 673 case -EPROTO: 674 case -ETIME: 675 case -ETIMEDOUT: 676 explanation = "protocol error"; 677 if (hso_dev) 678 usb_queue_reset_device(hso_dev->interface); 679 break; 680 default: 681 explanation = "unknown status"; 682 break; 683 } 684 685 /* log a meaningful explanation of an USB status */ 686 hso_dbg(0x1, "%s: received USB status - %s (%d)\n", 687 function, explanation, status); 688 } 689 690 /* Network interface functions */ 691 692 /* called when net interface is brought up by ifconfig */ 693 static int hso_net_open(struct net_device *net) 694 { 695 struct hso_net *odev = netdev_priv(net); 696 unsigned long flags = 0; 697 698 if (!odev) { 699 dev_err(&net->dev, "No net device !\n"); 700 return -ENODEV; 701 } 702 703 odev->skb_tx_buf = NULL; 704 705 /* setup environment */ 706 spin_lock_irqsave(&odev->net_lock, flags); 707 odev->rx_parse_state = WAIT_IP; 708 odev->rx_buf_size = 0; 709 odev->rx_buf_missing = sizeof(struct iphdr); 710 spin_unlock_irqrestore(&odev->net_lock, flags); 711 712 /* We are up and running. */ 713 set_bit(HSO_NET_RUNNING, &odev->flags); 714 hso_start_net_device(odev->parent); 715 716 /* Tell the kernel we are ready to start receiving from it */ 717 netif_start_queue(net); 718 719 return 0; 720 } 721 722 /* called when interface is brought down by ifconfig */ 723 static int hso_net_close(struct net_device *net) 724 { 725 struct hso_net *odev = netdev_priv(net); 726 727 /* we don't need the queue anymore */ 728 netif_stop_queue(net); 729 /* no longer running */ 730 clear_bit(HSO_NET_RUNNING, &odev->flags); 731 732 hso_stop_net_device(odev->parent); 733 734 /* done */ 735 return 0; 736 } 737 738 /* USB tells is xmit done, we should start the netqueue again */ 739 static void write_bulk_callback(struct urb *urb) 740 { 741 struct hso_net *odev = urb->context; 742 int status = urb->status; 743 744 /* Sanity check */ 745 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) { 746 dev_err(&urb->dev->dev, "%s: device not running\n", __func__); 747 return; 748 } 749 750 /* Do we still have a valid kernel network device? */ 751 if (!netif_device_present(odev->net)) { 752 dev_err(&urb->dev->dev, "%s: net device not present\n", 753 __func__); 754 return; 755 } 756 757 /* log status, but don't act on it, we don't need to resubmit anything 758 * anyhow */ 759 if (status) 760 handle_usb_error(status, __func__, odev->parent); 761 762 hso_put_activity(odev->parent); 763 764 /* Tell the network interface we are ready for another frame */ 765 netif_wake_queue(odev->net); 766 } 767 768 /* called by kernel when we need to transmit a packet */ 769 static netdev_tx_t hso_net_start_xmit(struct sk_buff *skb, 770 struct net_device *net) 771 { 772 struct hso_net *odev = netdev_priv(net); 773 int result; 774 775 /* Tell the kernel, "No more frames 'til we are done with this one." */ 776 netif_stop_queue(net); 777 if (hso_get_activity(odev->parent) == -EAGAIN) { 778 odev->skb_tx_buf = skb; 779 return NETDEV_TX_OK; 780 } 781 782 /* log if asked */ 783 DUMP1(skb->data, skb->len); 784 /* Copy it from kernel memory to OUR memory */ 785 memcpy(odev->mux_bulk_tx_buf, skb->data, skb->len); 786 hso_dbg(0x1, "len: %d/%d\n", skb->len, MUX_BULK_TX_BUF_SIZE); 787 788 /* Fill in the URB for shipping it out. */ 789 usb_fill_bulk_urb(odev->mux_bulk_tx_urb, 790 odev->parent->usb, 791 usb_sndbulkpipe(odev->parent->usb, 792 odev->out_endp-> 793 bEndpointAddress & 0x7F), 794 odev->mux_bulk_tx_buf, skb->len, write_bulk_callback, 795 odev); 796 797 /* Deal with the Zero Length packet problem, I hope */ 798 odev->mux_bulk_tx_urb->transfer_flags |= URB_ZERO_PACKET; 799 800 /* Send the URB on its merry way. */ 801 result = usb_submit_urb(odev->mux_bulk_tx_urb, GFP_ATOMIC); 802 if (result) { 803 dev_warn(&odev->parent->interface->dev, 804 "failed mux_bulk_tx_urb %d\n", result); 805 net->stats.tx_errors++; 806 netif_start_queue(net); 807 } else { 808 net->stats.tx_packets++; 809 net->stats.tx_bytes += skb->len; 810 } 811 dev_kfree_skb(skb); 812 /* we're done */ 813 return NETDEV_TX_OK; 814 } 815 816 static const struct ethtool_ops ops = { 817 .get_link = ethtool_op_get_link 818 }; 819 820 /* called when a packet did not ack after watchdogtimeout */ 821 static void hso_net_tx_timeout(struct net_device *net, unsigned int txqueue) 822 { 823 struct hso_net *odev = netdev_priv(net); 824 825 if (!odev) 826 return; 827 828 /* Tell syslog we are hosed. */ 829 dev_warn(&net->dev, "Tx timed out.\n"); 830 831 /* Tear the waiting frame off the list */ 832 if (odev->mux_bulk_tx_urb) 833 usb_unlink_urb(odev->mux_bulk_tx_urb); 834 835 /* Update statistics */ 836 net->stats.tx_errors++; 837 } 838 839 /* make a real packet from the received USB buffer */ 840 static void packetizeRx(struct hso_net *odev, unsigned char *ip_pkt, 841 unsigned int count, unsigned char is_eop) 842 { 843 unsigned short temp_bytes; 844 unsigned short buffer_offset = 0; 845 unsigned short frame_len; 846 847 /* log if needed */ 848 hso_dbg(0x1, "Rx %d bytes\n", count); 849 DUMP(ip_pkt, min(128, (int)count)); 850 851 while (count) { 852 switch (odev->rx_parse_state) { 853 case WAIT_IP: 854 /* waiting for IP header. */ 855 /* wanted bytes - size of ip header */ 856 temp_bytes = 857 (count < 858 odev->rx_buf_missing) ? count : odev-> 859 rx_buf_missing; 860 861 memcpy(((unsigned char *)(&odev->rx_ip_hdr)) + 862 odev->rx_buf_size, ip_pkt + buffer_offset, 863 temp_bytes); 864 865 odev->rx_buf_size += temp_bytes; 866 buffer_offset += temp_bytes; 867 odev->rx_buf_missing -= temp_bytes; 868 count -= temp_bytes; 869 870 if (!odev->rx_buf_missing) { 871 /* header is complete allocate an sk_buffer and 872 * continue to WAIT_DATA */ 873 frame_len = ntohs(odev->rx_ip_hdr.tot_len); 874 875 if ((frame_len > DEFAULT_MRU) || 876 (frame_len < sizeof(struct iphdr))) { 877 dev_err(&odev->net->dev, 878 "Invalid frame (%d) length\n", 879 frame_len); 880 odev->rx_parse_state = WAIT_SYNC; 881 continue; 882 } 883 /* Allocate an sk_buff */ 884 odev->skb_rx_buf = netdev_alloc_skb(odev->net, 885 frame_len); 886 if (!odev->skb_rx_buf) { 887 /* We got no receive buffer. */ 888 hso_dbg(0x1, "could not allocate memory\n"); 889 odev->rx_parse_state = WAIT_SYNC; 890 continue; 891 } 892 893 /* Copy what we got so far. make room for iphdr 894 * after tail. */ 895 skb_put_data(odev->skb_rx_buf, 896 (char *)&(odev->rx_ip_hdr), 897 sizeof(struct iphdr)); 898 899 /* ETH_HLEN */ 900 odev->rx_buf_size = sizeof(struct iphdr); 901 902 /* Filip actually use .tot_len */ 903 odev->rx_buf_missing = 904 frame_len - sizeof(struct iphdr); 905 odev->rx_parse_state = WAIT_DATA; 906 } 907 break; 908 909 case WAIT_DATA: 910 temp_bytes = (count < odev->rx_buf_missing) 911 ? count : odev->rx_buf_missing; 912 913 /* Copy the rest of the bytes that are left in the 914 * buffer into the waiting sk_buf. */ 915 /* Make room for temp_bytes after tail. */ 916 skb_put_data(odev->skb_rx_buf, 917 ip_pkt + buffer_offset, 918 temp_bytes); 919 920 odev->rx_buf_missing -= temp_bytes; 921 count -= temp_bytes; 922 buffer_offset += temp_bytes; 923 odev->rx_buf_size += temp_bytes; 924 if (!odev->rx_buf_missing) { 925 /* Packet is complete. Inject into stack. */ 926 /* We have IP packet here */ 927 odev->skb_rx_buf->protocol = cpu_to_be16(ETH_P_IP); 928 skb_reset_mac_header(odev->skb_rx_buf); 929 930 /* Ship it off to the kernel */ 931 netif_rx(odev->skb_rx_buf); 932 /* No longer our buffer. */ 933 odev->skb_rx_buf = NULL; 934 935 /* update out statistics */ 936 odev->net->stats.rx_packets++; 937 938 odev->net->stats.rx_bytes += odev->rx_buf_size; 939 940 odev->rx_buf_size = 0; 941 odev->rx_buf_missing = sizeof(struct iphdr); 942 odev->rx_parse_state = WAIT_IP; 943 } 944 break; 945 946 case WAIT_SYNC: 947 hso_dbg(0x1, " W_S\n"); 948 count = 0; 949 break; 950 default: 951 hso_dbg(0x1, "\n"); 952 count--; 953 break; 954 } 955 } 956 957 /* Recovery mechanism for WAIT_SYNC state. */ 958 if (is_eop) { 959 if (odev->rx_parse_state == WAIT_SYNC) { 960 odev->rx_parse_state = WAIT_IP; 961 odev->rx_buf_size = 0; 962 odev->rx_buf_missing = sizeof(struct iphdr); 963 } 964 } 965 } 966 967 static void fix_crc_bug(struct urb *urb, __le16 max_packet_size) 968 { 969 static const u8 crc_check[4] = { 0xDE, 0xAD, 0xBE, 0xEF }; 970 u32 rest = urb->actual_length % le16_to_cpu(max_packet_size); 971 972 if (((rest == 5) || (rest == 6)) && 973 !memcmp(((u8 *)urb->transfer_buffer) + urb->actual_length - 4, 974 crc_check, 4)) { 975 urb->actual_length -= 4; 976 } 977 } 978 979 /* Moving data from usb to kernel (in interrupt state) */ 980 static void read_bulk_callback(struct urb *urb) 981 { 982 struct hso_net *odev = urb->context; 983 struct net_device *net; 984 int result; 985 unsigned long flags; 986 int status = urb->status; 987 988 /* is al ok? (Filip: Who's Al ?) */ 989 if (status) { 990 handle_usb_error(status, __func__, odev->parent); 991 return; 992 } 993 994 /* Sanity check */ 995 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) { 996 hso_dbg(0x1, "BULK IN callback but driver is not active!\n"); 997 return; 998 } 999 usb_mark_last_busy(urb->dev); 1000 1001 net = odev->net; 1002 1003 if (!netif_device_present(net)) { 1004 /* Somebody killed our network interface... */ 1005 return; 1006 } 1007 1008 if (odev->parent->port_spec & HSO_INFO_CRC_BUG) 1009 fix_crc_bug(urb, odev->in_endp->wMaxPacketSize); 1010 1011 /* do we even have a packet? */ 1012 if (urb->actual_length) { 1013 /* Handle the IP stream, add header and push it onto network 1014 * stack if the packet is complete. */ 1015 spin_lock_irqsave(&odev->net_lock, flags); 1016 packetizeRx(odev, urb->transfer_buffer, urb->actual_length, 1017 (urb->transfer_buffer_length > 1018 urb->actual_length) ? 1 : 0); 1019 spin_unlock_irqrestore(&odev->net_lock, flags); 1020 } 1021 1022 /* We are done with this URB, resubmit it. Prep the USB to wait for 1023 * another frame. Reuse same as received. */ 1024 usb_fill_bulk_urb(urb, 1025 odev->parent->usb, 1026 usb_rcvbulkpipe(odev->parent->usb, 1027 odev->in_endp-> 1028 bEndpointAddress & 0x7F), 1029 urb->transfer_buffer, MUX_BULK_RX_BUF_SIZE, 1030 read_bulk_callback, odev); 1031 1032 /* Give this to the USB subsystem so it can tell us when more data 1033 * arrives. */ 1034 result = usb_submit_urb(urb, GFP_ATOMIC); 1035 if (result) 1036 dev_warn(&odev->parent->interface->dev, 1037 "%s failed submit mux_bulk_rx_urb %d\n", __func__, 1038 result); 1039 } 1040 1041 /* Serial driver functions */ 1042 1043 static void hso_init_termios(struct ktermios *termios) 1044 { 1045 /* 1046 * The default requirements for this device are: 1047 */ 1048 termios->c_iflag &= 1049 ~(IGNBRK /* disable ignore break */ 1050 | BRKINT /* disable break causes interrupt */ 1051 | PARMRK /* disable mark parity errors */ 1052 | ISTRIP /* disable clear high bit of input characters */ 1053 | INLCR /* disable translate NL to CR */ 1054 | IGNCR /* disable ignore CR */ 1055 | ICRNL /* disable translate CR to NL */ 1056 | IXON); /* disable enable XON/XOFF flow control */ 1057 1058 /* disable postprocess output characters */ 1059 termios->c_oflag &= ~OPOST; 1060 1061 termios->c_lflag &= 1062 ~(ECHO /* disable echo input characters */ 1063 | ECHONL /* disable echo new line */ 1064 | ICANON /* disable erase, kill, werase, and rprnt 1065 special characters */ 1066 | ISIG /* disable interrupt, quit, and suspend special 1067 characters */ 1068 | IEXTEN); /* disable non-POSIX special characters */ 1069 1070 termios->c_cflag &= 1071 ~(CSIZE /* no size */ 1072 | PARENB /* disable parity bit */ 1073 | CBAUD /* clear current baud rate */ 1074 | CBAUDEX); /* clear current buad rate */ 1075 1076 termios->c_cflag |= CS8; /* character size 8 bits */ 1077 1078 /* baud rate 115200 */ 1079 tty_termios_encode_baud_rate(termios, 115200, 115200); 1080 } 1081 1082 static void _hso_serial_set_termios(struct tty_struct *tty, 1083 struct ktermios *old) 1084 { 1085 struct hso_serial *serial = tty->driver_data; 1086 1087 if (!serial) { 1088 pr_err("%s: no tty structures", __func__); 1089 return; 1090 } 1091 1092 hso_dbg(0x8, "port %d\n", serial->minor); 1093 1094 /* 1095 * Fix up unsupported bits 1096 */ 1097 tty->termios.c_iflag &= ~IXON; /* disable enable XON/XOFF flow control */ 1098 1099 tty->termios.c_cflag &= 1100 ~(CSIZE /* no size */ 1101 | PARENB /* disable parity bit */ 1102 | CBAUD /* clear current baud rate */ 1103 | CBAUDEX); /* clear current buad rate */ 1104 1105 tty->termios.c_cflag |= CS8; /* character size 8 bits */ 1106 1107 /* baud rate 115200 */ 1108 tty_encode_baud_rate(tty, 115200, 115200); 1109 } 1110 1111 static void hso_resubmit_rx_bulk_urb(struct hso_serial *serial, struct urb *urb) 1112 { 1113 int result; 1114 /* We are done with this URB, resubmit it. Prep the USB to wait for 1115 * another frame */ 1116 usb_fill_bulk_urb(urb, serial->parent->usb, 1117 usb_rcvbulkpipe(serial->parent->usb, 1118 serial->in_endp-> 1119 bEndpointAddress & 0x7F), 1120 urb->transfer_buffer, serial->rx_data_length, 1121 hso_std_serial_read_bulk_callback, serial); 1122 /* Give this to the USB subsystem so it can tell us when more data 1123 * arrives. */ 1124 result = usb_submit_urb(urb, GFP_ATOMIC); 1125 if (result) { 1126 dev_err(&urb->dev->dev, "%s failed submit serial rx_urb %d\n", 1127 __func__, result); 1128 } 1129 } 1130 1131 1132 1133 1134 static void put_rxbuf_data_and_resubmit_bulk_urb(struct hso_serial *serial) 1135 { 1136 int count; 1137 struct urb *curr_urb; 1138 1139 while (serial->rx_urb_filled[serial->curr_rx_urb_idx]) { 1140 curr_urb = serial->rx_urb[serial->curr_rx_urb_idx]; 1141 count = put_rxbuf_data(curr_urb, serial); 1142 if (count == -1) 1143 return; 1144 if (count == 0) { 1145 serial->curr_rx_urb_idx++; 1146 if (serial->curr_rx_urb_idx >= serial->num_rx_urbs) 1147 serial->curr_rx_urb_idx = 0; 1148 hso_resubmit_rx_bulk_urb(serial, curr_urb); 1149 } 1150 } 1151 } 1152 1153 static void put_rxbuf_data_and_resubmit_ctrl_urb(struct hso_serial *serial) 1154 { 1155 int count = 0; 1156 struct urb *urb; 1157 1158 urb = serial->rx_urb[0]; 1159 if (serial->port.count > 0) { 1160 count = put_rxbuf_data(urb, serial); 1161 if (count == -1) 1162 return; 1163 } 1164 /* Re issue a read as long as we receive data. */ 1165 1166 if (count == 0 && ((urb->actual_length != 0) || 1167 (serial->rx_state == RX_PENDING))) { 1168 serial->rx_state = RX_SENT; 1169 hso_mux_serial_read(serial); 1170 } else 1171 serial->rx_state = RX_IDLE; 1172 } 1173 1174 1175 /* read callback for Diag and CS port */ 1176 static void hso_std_serial_read_bulk_callback(struct urb *urb) 1177 { 1178 struct hso_serial *serial = urb->context; 1179 int status = urb->status; 1180 unsigned long flags; 1181 1182 hso_dbg(0x8, "--- Got serial_read_bulk callback %02x ---\n", status); 1183 1184 /* sanity check */ 1185 if (!serial) { 1186 hso_dbg(0x1, "serial == NULL\n"); 1187 return; 1188 } 1189 if (status) { 1190 handle_usb_error(status, __func__, serial->parent); 1191 return; 1192 } 1193 1194 hso_dbg(0x1, "Actual length = %d\n", urb->actual_length); 1195 DUMP1(urb->transfer_buffer, urb->actual_length); 1196 1197 /* Anyone listening? */ 1198 if (serial->port.count == 0) 1199 return; 1200 1201 if (serial->parent->port_spec & HSO_INFO_CRC_BUG) 1202 fix_crc_bug(urb, serial->in_endp->wMaxPacketSize); 1203 /* Valid data, handle RX data */ 1204 spin_lock_irqsave(&serial->serial_lock, flags); 1205 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 1; 1206 put_rxbuf_data_and_resubmit_bulk_urb(serial); 1207 spin_unlock_irqrestore(&serial->serial_lock, flags); 1208 } 1209 1210 /* 1211 * This needs to be a tasklet otherwise we will 1212 * end up recursively calling this function. 1213 */ 1214 static void hso_unthrottle_tasklet(struct tasklet_struct *t) 1215 { 1216 struct hso_serial *serial = from_tasklet(serial, t, 1217 unthrottle_tasklet); 1218 unsigned long flags; 1219 1220 spin_lock_irqsave(&serial->serial_lock, flags); 1221 if ((serial->parent->port_spec & HSO_INTF_MUX)) 1222 put_rxbuf_data_and_resubmit_ctrl_urb(serial); 1223 else 1224 put_rxbuf_data_and_resubmit_bulk_urb(serial); 1225 spin_unlock_irqrestore(&serial->serial_lock, flags); 1226 } 1227 1228 static void hso_unthrottle(struct tty_struct *tty) 1229 { 1230 struct hso_serial *serial = tty->driver_data; 1231 1232 tasklet_hi_schedule(&serial->unthrottle_tasklet); 1233 } 1234 1235 /* open the requested serial port */ 1236 static int hso_serial_open(struct tty_struct *tty, struct file *filp) 1237 { 1238 struct hso_serial *serial = get_serial_by_index(tty->index); 1239 int result; 1240 1241 /* sanity check */ 1242 if (serial == NULL || serial->magic != HSO_SERIAL_MAGIC) { 1243 WARN_ON(1); 1244 tty->driver_data = NULL; 1245 hso_dbg(0x1, "Failed to open port\n"); 1246 return -ENODEV; 1247 } 1248 1249 mutex_lock(&serial->parent->mutex); 1250 result = usb_autopm_get_interface(serial->parent->interface); 1251 if (result < 0) 1252 goto err_out; 1253 1254 hso_dbg(0x1, "Opening %d\n", serial->minor); 1255 1256 /* setup */ 1257 tty->driver_data = serial; 1258 tty_port_tty_set(&serial->port, tty); 1259 1260 /* check for port already opened, if not set the termios */ 1261 serial->port.count++; 1262 if (serial->port.count == 1) { 1263 serial->rx_state = RX_IDLE; 1264 /* Force default termio settings */ 1265 _hso_serial_set_termios(tty, NULL); 1266 tasklet_setup(&serial->unthrottle_tasklet, 1267 hso_unthrottle_tasklet); 1268 result = hso_start_serial_device(serial->parent, GFP_KERNEL); 1269 if (result) { 1270 hso_stop_serial_device(serial->parent); 1271 serial->port.count--; 1272 } else { 1273 kref_get(&serial->parent->ref); 1274 } 1275 } else { 1276 hso_dbg(0x1, "Port was already open\n"); 1277 } 1278 1279 usb_autopm_put_interface(serial->parent->interface); 1280 1281 /* done */ 1282 if (result) 1283 hso_serial_tiocmset(tty, TIOCM_RTS | TIOCM_DTR, 0); 1284 err_out: 1285 mutex_unlock(&serial->parent->mutex); 1286 return result; 1287 } 1288 1289 /* close the requested serial port */ 1290 static void hso_serial_close(struct tty_struct *tty, struct file *filp) 1291 { 1292 struct hso_serial *serial = tty->driver_data; 1293 u8 usb_gone; 1294 1295 hso_dbg(0x1, "Closing serial port\n"); 1296 1297 /* Open failed, no close cleanup required */ 1298 if (serial == NULL) 1299 return; 1300 1301 mutex_lock(&serial->parent->mutex); 1302 usb_gone = serial->parent->usb_gone; 1303 1304 if (!usb_gone) 1305 usb_autopm_get_interface(serial->parent->interface); 1306 1307 /* reset the rts and dtr */ 1308 /* do the actual close */ 1309 serial->port.count--; 1310 1311 if (serial->port.count <= 0) { 1312 serial->port.count = 0; 1313 tty_port_tty_set(&serial->port, NULL); 1314 if (!usb_gone) 1315 hso_stop_serial_device(serial->parent); 1316 tasklet_kill(&serial->unthrottle_tasklet); 1317 } 1318 1319 if (!usb_gone) 1320 usb_autopm_put_interface(serial->parent->interface); 1321 1322 mutex_unlock(&serial->parent->mutex); 1323 } 1324 1325 /* close the requested serial port */ 1326 static int hso_serial_write(struct tty_struct *tty, const unsigned char *buf, 1327 int count) 1328 { 1329 struct hso_serial *serial = tty->driver_data; 1330 int space, tx_bytes; 1331 unsigned long flags; 1332 1333 /* sanity check */ 1334 if (serial == NULL) { 1335 pr_err("%s: serial is NULL\n", __func__); 1336 return -ENODEV; 1337 } 1338 1339 spin_lock_irqsave(&serial->serial_lock, flags); 1340 1341 space = serial->tx_data_length - serial->tx_buffer_count; 1342 tx_bytes = (count < space) ? count : space; 1343 1344 if (!tx_bytes) 1345 goto out; 1346 1347 memcpy(serial->tx_buffer + serial->tx_buffer_count, buf, tx_bytes); 1348 serial->tx_buffer_count += tx_bytes; 1349 1350 out: 1351 spin_unlock_irqrestore(&serial->serial_lock, flags); 1352 1353 hso_kick_transmit(serial); 1354 /* done */ 1355 return tx_bytes; 1356 } 1357 1358 /* how much room is there for writing */ 1359 static unsigned int hso_serial_write_room(struct tty_struct *tty) 1360 { 1361 struct hso_serial *serial = tty->driver_data; 1362 unsigned int room; 1363 unsigned long flags; 1364 1365 spin_lock_irqsave(&serial->serial_lock, flags); 1366 room = serial->tx_data_length - serial->tx_buffer_count; 1367 spin_unlock_irqrestore(&serial->serial_lock, flags); 1368 1369 /* return free room */ 1370 return room; 1371 } 1372 1373 static void hso_serial_cleanup(struct tty_struct *tty) 1374 { 1375 struct hso_serial *serial = tty->driver_data; 1376 1377 if (!serial) 1378 return; 1379 1380 kref_put(&serial->parent->ref, hso_serial_ref_free); 1381 } 1382 1383 /* setup the term */ 1384 static void hso_serial_set_termios(struct tty_struct *tty, struct ktermios *old) 1385 { 1386 struct hso_serial *serial = tty->driver_data; 1387 unsigned long flags; 1388 1389 if (old) 1390 hso_dbg(0x16, "Termios called with: cflags new[%u] - old[%u]\n", 1391 (unsigned int)tty->termios.c_cflag, 1392 (unsigned int)old->c_cflag); 1393 1394 /* the actual setup */ 1395 spin_lock_irqsave(&serial->serial_lock, flags); 1396 if (serial->port.count) 1397 _hso_serial_set_termios(tty, old); 1398 else 1399 tty->termios = *old; 1400 spin_unlock_irqrestore(&serial->serial_lock, flags); 1401 1402 /* done */ 1403 } 1404 1405 /* how many characters in the buffer */ 1406 static unsigned int hso_serial_chars_in_buffer(struct tty_struct *tty) 1407 { 1408 struct hso_serial *serial = tty->driver_data; 1409 unsigned long flags; 1410 unsigned int chars; 1411 1412 /* sanity check */ 1413 if (serial == NULL) 1414 return 0; 1415 1416 spin_lock_irqsave(&serial->serial_lock, flags); 1417 chars = serial->tx_buffer_count; 1418 spin_unlock_irqrestore(&serial->serial_lock, flags); 1419 1420 return chars; 1421 } 1422 static int tiocmget_submit_urb(struct hso_serial *serial, 1423 struct hso_tiocmget *tiocmget, 1424 struct usb_device *usb) 1425 { 1426 int result; 1427 1428 if (serial->parent->usb_gone) 1429 return -ENODEV; 1430 usb_fill_int_urb(tiocmget->urb, usb, 1431 usb_rcvintpipe(usb, 1432 tiocmget->endp-> 1433 bEndpointAddress & 0x7F), 1434 tiocmget->serial_state_notification, 1435 sizeof(struct hso_serial_state_notification), 1436 tiocmget_intr_callback, serial, 1437 tiocmget->endp->bInterval); 1438 result = usb_submit_urb(tiocmget->urb, GFP_ATOMIC); 1439 if (result) { 1440 dev_warn(&usb->dev, "%s usb_submit_urb failed %d\n", __func__, 1441 result); 1442 } 1443 return result; 1444 1445 } 1446 1447 static void tiocmget_intr_callback(struct urb *urb) 1448 { 1449 struct hso_serial *serial = urb->context; 1450 struct hso_tiocmget *tiocmget; 1451 int status = urb->status; 1452 u16 UART_state_bitmap, prev_UART_state_bitmap; 1453 struct uart_icount *icount; 1454 struct hso_serial_state_notification *serial_state_notification; 1455 struct usb_device *usb; 1456 struct usb_interface *interface; 1457 int if_num; 1458 1459 /* Sanity checks */ 1460 if (!serial) 1461 return; 1462 if (status) { 1463 handle_usb_error(status, __func__, serial->parent); 1464 return; 1465 } 1466 1467 /* tiocmget is only supported on HSO_PORT_MODEM */ 1468 tiocmget = serial->tiocmget; 1469 if (!tiocmget) 1470 return; 1471 BUG_ON((serial->parent->port_spec & HSO_PORT_MASK) != HSO_PORT_MODEM); 1472 1473 usb = serial->parent->usb; 1474 interface = serial->parent->interface; 1475 1476 if_num = interface->cur_altsetting->desc.bInterfaceNumber; 1477 1478 /* wIndex should be the USB interface number of the port to which the 1479 * notification applies, which should always be the Modem port. 1480 */ 1481 serial_state_notification = tiocmget->serial_state_notification; 1482 if (serial_state_notification->bmRequestType != BM_REQUEST_TYPE || 1483 serial_state_notification->bNotification != B_NOTIFICATION || 1484 le16_to_cpu(serial_state_notification->wValue) != W_VALUE || 1485 le16_to_cpu(serial_state_notification->wIndex) != if_num || 1486 le16_to_cpu(serial_state_notification->wLength) != W_LENGTH) { 1487 dev_warn(&usb->dev, 1488 "hso received invalid serial state notification\n"); 1489 DUMP(serial_state_notification, 1490 sizeof(struct hso_serial_state_notification)); 1491 } else { 1492 unsigned long flags; 1493 1494 UART_state_bitmap = le16_to_cpu(serial_state_notification-> 1495 UART_state_bitmap); 1496 prev_UART_state_bitmap = tiocmget->prev_UART_state_bitmap; 1497 icount = &tiocmget->icount; 1498 spin_lock_irqsave(&serial->serial_lock, flags); 1499 if ((UART_state_bitmap & B_OVERRUN) != 1500 (prev_UART_state_bitmap & B_OVERRUN)) 1501 icount->parity++; 1502 if ((UART_state_bitmap & B_PARITY) != 1503 (prev_UART_state_bitmap & B_PARITY)) 1504 icount->parity++; 1505 if ((UART_state_bitmap & B_FRAMING) != 1506 (prev_UART_state_bitmap & B_FRAMING)) 1507 icount->frame++; 1508 if ((UART_state_bitmap & B_RING_SIGNAL) && 1509 !(prev_UART_state_bitmap & B_RING_SIGNAL)) 1510 icount->rng++; 1511 if ((UART_state_bitmap & B_BREAK) != 1512 (prev_UART_state_bitmap & B_BREAK)) 1513 icount->brk++; 1514 if ((UART_state_bitmap & B_TX_CARRIER) != 1515 (prev_UART_state_bitmap & B_TX_CARRIER)) 1516 icount->dsr++; 1517 if ((UART_state_bitmap & B_RX_CARRIER) != 1518 (prev_UART_state_bitmap & B_RX_CARRIER)) 1519 icount->dcd++; 1520 tiocmget->prev_UART_state_bitmap = UART_state_bitmap; 1521 spin_unlock_irqrestore(&serial->serial_lock, flags); 1522 tiocmget->intr_completed = 1; 1523 wake_up_interruptible(&tiocmget->waitq); 1524 } 1525 memset(serial_state_notification, 0, 1526 sizeof(struct hso_serial_state_notification)); 1527 tiocmget_submit_urb(serial, 1528 tiocmget, 1529 serial->parent->usb); 1530 } 1531 1532 /* 1533 * next few functions largely stolen from drivers/serial/serial_core.c 1534 */ 1535 /* Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change 1536 * - mask passed in arg for lines of interest 1537 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking) 1538 * Caller should use TIOCGICOUNT to see which one it was 1539 */ 1540 static int 1541 hso_wait_modem_status(struct hso_serial *serial, unsigned long arg) 1542 { 1543 DECLARE_WAITQUEUE(wait, current); 1544 struct uart_icount cprev, cnow; 1545 struct hso_tiocmget *tiocmget; 1546 int ret; 1547 1548 tiocmget = serial->tiocmget; 1549 if (!tiocmget) 1550 return -ENOENT; 1551 /* 1552 * note the counters on entry 1553 */ 1554 spin_lock_irq(&serial->serial_lock); 1555 memcpy(&cprev, &tiocmget->icount, sizeof(struct uart_icount)); 1556 spin_unlock_irq(&serial->serial_lock); 1557 add_wait_queue(&tiocmget->waitq, &wait); 1558 for (;;) { 1559 spin_lock_irq(&serial->serial_lock); 1560 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount)); 1561 spin_unlock_irq(&serial->serial_lock); 1562 set_current_state(TASK_INTERRUPTIBLE); 1563 if (((arg & TIOCM_RNG) && (cnow.rng != cprev.rng)) || 1564 ((arg & TIOCM_DSR) && (cnow.dsr != cprev.dsr)) || 1565 ((arg & TIOCM_CD) && (cnow.dcd != cprev.dcd))) { 1566 ret = 0; 1567 break; 1568 } 1569 schedule(); 1570 /* see if a signal did it */ 1571 if (signal_pending(current)) { 1572 ret = -ERESTARTSYS; 1573 break; 1574 } 1575 cprev = cnow; 1576 } 1577 __set_current_state(TASK_RUNNING); 1578 remove_wait_queue(&tiocmget->waitq, &wait); 1579 1580 return ret; 1581 } 1582 1583 /* 1584 * Get counter of input serial line interrupts (DCD,RI,DSR,CTS) 1585 * Return: write counters to the user passed counter struct 1586 * NB: both 1->0 and 0->1 transitions are counted except for 1587 * RI where only 0->1 is counted. 1588 */ 1589 static int hso_get_count(struct tty_struct *tty, 1590 struct serial_icounter_struct *icount) 1591 { 1592 struct uart_icount cnow; 1593 struct hso_serial *serial = tty->driver_data; 1594 struct hso_tiocmget *tiocmget = serial->tiocmget; 1595 1596 memset(icount, 0, sizeof(struct serial_icounter_struct)); 1597 1598 if (!tiocmget) 1599 return -ENOENT; 1600 spin_lock_irq(&serial->serial_lock); 1601 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount)); 1602 spin_unlock_irq(&serial->serial_lock); 1603 1604 icount->cts = cnow.cts; 1605 icount->dsr = cnow.dsr; 1606 icount->rng = cnow.rng; 1607 icount->dcd = cnow.dcd; 1608 icount->rx = cnow.rx; 1609 icount->tx = cnow.tx; 1610 icount->frame = cnow.frame; 1611 icount->overrun = cnow.overrun; 1612 icount->parity = cnow.parity; 1613 icount->brk = cnow.brk; 1614 icount->buf_overrun = cnow.buf_overrun; 1615 1616 return 0; 1617 } 1618 1619 1620 static int hso_serial_tiocmget(struct tty_struct *tty) 1621 { 1622 int retval; 1623 struct hso_serial *serial = tty->driver_data; 1624 struct hso_tiocmget *tiocmget; 1625 u16 UART_state_bitmap; 1626 1627 /* sanity check */ 1628 if (!serial) { 1629 hso_dbg(0x1, "no tty structures\n"); 1630 return -EINVAL; 1631 } 1632 spin_lock_irq(&serial->serial_lock); 1633 retval = ((serial->rts_state) ? TIOCM_RTS : 0) | 1634 ((serial->dtr_state) ? TIOCM_DTR : 0); 1635 tiocmget = serial->tiocmget; 1636 if (tiocmget) { 1637 1638 UART_state_bitmap = le16_to_cpu( 1639 tiocmget->prev_UART_state_bitmap); 1640 if (UART_state_bitmap & B_RING_SIGNAL) 1641 retval |= TIOCM_RNG; 1642 if (UART_state_bitmap & B_RX_CARRIER) 1643 retval |= TIOCM_CD; 1644 if (UART_state_bitmap & B_TX_CARRIER) 1645 retval |= TIOCM_DSR; 1646 } 1647 spin_unlock_irq(&serial->serial_lock); 1648 return retval; 1649 } 1650 1651 static int hso_serial_tiocmset(struct tty_struct *tty, 1652 unsigned int set, unsigned int clear) 1653 { 1654 int val = 0; 1655 unsigned long flags; 1656 int if_num; 1657 struct hso_serial *serial = tty->driver_data; 1658 struct usb_interface *interface; 1659 1660 /* sanity check */ 1661 if (!serial) { 1662 hso_dbg(0x1, "no tty structures\n"); 1663 return -EINVAL; 1664 } 1665 1666 if ((serial->parent->port_spec & HSO_PORT_MASK) != HSO_PORT_MODEM) 1667 return -EINVAL; 1668 1669 interface = serial->parent->interface; 1670 if_num = interface->cur_altsetting->desc.bInterfaceNumber; 1671 1672 spin_lock_irqsave(&serial->serial_lock, flags); 1673 if (set & TIOCM_RTS) 1674 serial->rts_state = 1; 1675 if (set & TIOCM_DTR) 1676 serial->dtr_state = 1; 1677 1678 if (clear & TIOCM_RTS) 1679 serial->rts_state = 0; 1680 if (clear & TIOCM_DTR) 1681 serial->dtr_state = 0; 1682 1683 if (serial->dtr_state) 1684 val |= 0x01; 1685 if (serial->rts_state) 1686 val |= 0x02; 1687 1688 spin_unlock_irqrestore(&serial->serial_lock, flags); 1689 1690 return usb_control_msg(serial->parent->usb, 1691 usb_sndctrlpipe(serial->parent->usb, 0), 0x22, 1692 0x21, val, if_num, NULL, 0, 1693 USB_CTRL_SET_TIMEOUT); 1694 } 1695 1696 static int hso_serial_ioctl(struct tty_struct *tty, 1697 unsigned int cmd, unsigned long arg) 1698 { 1699 struct hso_serial *serial = tty->driver_data; 1700 int ret = 0; 1701 hso_dbg(0x8, "IOCTL cmd: %d, arg: %ld\n", cmd, arg); 1702 1703 if (!serial) 1704 return -ENODEV; 1705 switch (cmd) { 1706 case TIOCMIWAIT: 1707 ret = hso_wait_modem_status(serial, arg); 1708 break; 1709 default: 1710 ret = -ENOIOCTLCMD; 1711 break; 1712 } 1713 return ret; 1714 } 1715 1716 1717 /* starts a transmit */ 1718 static void hso_kick_transmit(struct hso_serial *serial) 1719 { 1720 unsigned long flags; 1721 int res; 1722 1723 spin_lock_irqsave(&serial->serial_lock, flags); 1724 if (!serial->tx_buffer_count) 1725 goto out; 1726 1727 if (serial->tx_urb_used) 1728 goto out; 1729 1730 /* Wakeup USB interface if necessary */ 1731 if (hso_get_activity(serial->parent) == -EAGAIN) 1732 goto out; 1733 1734 /* Switch pointers around to avoid memcpy */ 1735 swap(serial->tx_buffer, serial->tx_data); 1736 serial->tx_data_count = serial->tx_buffer_count; 1737 serial->tx_buffer_count = 0; 1738 1739 /* If serial->tx_data is set, it means we switched buffers */ 1740 if (serial->tx_data && serial->write_data) { 1741 res = serial->write_data(serial); 1742 if (res >= 0) 1743 serial->tx_urb_used = 1; 1744 } 1745 out: 1746 spin_unlock_irqrestore(&serial->serial_lock, flags); 1747 } 1748 1749 /* make a request (for reading and writing data to muxed serial port) */ 1750 static int mux_device_request(struct hso_serial *serial, u8 type, u16 port, 1751 struct urb *ctrl_urb, 1752 struct usb_ctrlrequest *ctrl_req, 1753 u8 *ctrl_urb_data, u32 size) 1754 { 1755 int result; 1756 int pipe; 1757 1758 /* Sanity check */ 1759 if (!serial || !ctrl_urb || !ctrl_req) { 1760 pr_err("%s: Wrong arguments\n", __func__); 1761 return -EINVAL; 1762 } 1763 1764 /* initialize */ 1765 ctrl_req->wValue = 0; 1766 ctrl_req->wIndex = cpu_to_le16(hso_port_to_mux(port)); 1767 ctrl_req->wLength = cpu_to_le16(size); 1768 1769 if (type == USB_CDC_GET_ENCAPSULATED_RESPONSE) { 1770 /* Reading command */ 1771 ctrl_req->bRequestType = USB_DIR_IN | 1772 USB_TYPE_OPTION_VENDOR | 1773 USB_RECIP_INTERFACE; 1774 ctrl_req->bRequest = USB_CDC_GET_ENCAPSULATED_RESPONSE; 1775 pipe = usb_rcvctrlpipe(serial->parent->usb, 0); 1776 } else { 1777 /* Writing command */ 1778 ctrl_req->bRequestType = USB_DIR_OUT | 1779 USB_TYPE_OPTION_VENDOR | 1780 USB_RECIP_INTERFACE; 1781 ctrl_req->bRequest = USB_CDC_SEND_ENCAPSULATED_COMMAND; 1782 pipe = usb_sndctrlpipe(serial->parent->usb, 0); 1783 } 1784 /* syslog */ 1785 hso_dbg(0x2, "%s command (%02x) len: %d, port: %d\n", 1786 type == USB_CDC_GET_ENCAPSULATED_RESPONSE ? "Read" : "Write", 1787 ctrl_req->bRequestType, ctrl_req->wLength, port); 1788 1789 /* Load ctrl urb */ 1790 ctrl_urb->transfer_flags = 0; 1791 usb_fill_control_urb(ctrl_urb, 1792 serial->parent->usb, 1793 pipe, 1794 (u8 *) ctrl_req, 1795 ctrl_urb_data, size, ctrl_callback, serial); 1796 /* Send it on merry way */ 1797 result = usb_submit_urb(ctrl_urb, GFP_ATOMIC); 1798 if (result) { 1799 dev_err(&ctrl_urb->dev->dev, 1800 "%s failed submit ctrl_urb %d type %d\n", __func__, 1801 result, type); 1802 return result; 1803 } 1804 1805 /* done */ 1806 return size; 1807 } 1808 1809 /* called by intr_callback when read occurs */ 1810 static int hso_mux_serial_read(struct hso_serial *serial) 1811 { 1812 if (!serial) 1813 return -EINVAL; 1814 1815 /* clean data */ 1816 memset(serial->rx_data[0], 0, CTRL_URB_RX_SIZE); 1817 /* make the request */ 1818 1819 if (serial->num_rx_urbs != 1) { 1820 dev_err(&serial->parent->interface->dev, 1821 "ERROR: mux'd reads with multiple buffers " 1822 "not possible\n"); 1823 return 0; 1824 } 1825 return mux_device_request(serial, 1826 USB_CDC_GET_ENCAPSULATED_RESPONSE, 1827 serial->parent->port_spec & HSO_PORT_MASK, 1828 serial->rx_urb[0], 1829 &serial->ctrl_req_rx, 1830 serial->rx_data[0], serial->rx_data_length); 1831 } 1832 1833 /* used for muxed serial port callback (muxed serial read) */ 1834 static void intr_callback(struct urb *urb) 1835 { 1836 struct hso_shared_int *shared_int = urb->context; 1837 struct hso_serial *serial; 1838 unsigned char *port_req; 1839 int status = urb->status; 1840 unsigned long flags; 1841 int i; 1842 1843 usb_mark_last_busy(urb->dev); 1844 1845 /* sanity check */ 1846 if (!shared_int) 1847 return; 1848 1849 /* status check */ 1850 if (status) { 1851 handle_usb_error(status, __func__, NULL); 1852 return; 1853 } 1854 hso_dbg(0x8, "--- Got intr callback 0x%02X ---\n", status); 1855 1856 /* what request? */ 1857 port_req = urb->transfer_buffer; 1858 hso_dbg(0x8, "port_req = 0x%.2X\n", *port_req); 1859 /* loop over all muxed ports to find the one sending this */ 1860 for (i = 0; i < 8; i++) { 1861 /* max 8 channels on MUX */ 1862 if (*port_req & (1 << i)) { 1863 serial = get_serial_by_shared_int_and_type(shared_int, 1864 (1 << i)); 1865 if (serial != NULL) { 1866 hso_dbg(0x1, "Pending read interrupt on port %d\n", 1867 i); 1868 spin_lock_irqsave(&serial->serial_lock, flags); 1869 if (serial->rx_state == RX_IDLE && 1870 serial->port.count > 0) { 1871 /* Setup and send a ctrl req read on 1872 * port i */ 1873 if (!serial->rx_urb_filled[0]) { 1874 serial->rx_state = RX_SENT; 1875 hso_mux_serial_read(serial); 1876 } else 1877 serial->rx_state = RX_PENDING; 1878 } else { 1879 hso_dbg(0x1, "Already a read pending on port %d or port not open\n", 1880 i); 1881 } 1882 spin_unlock_irqrestore(&serial->serial_lock, 1883 flags); 1884 } 1885 } 1886 } 1887 /* Resubmit interrupt urb */ 1888 hso_mux_submit_intr_urb(shared_int, urb->dev, GFP_ATOMIC); 1889 } 1890 1891 /* called for writing to muxed serial port */ 1892 static int hso_mux_serial_write_data(struct hso_serial *serial) 1893 { 1894 if (NULL == serial) 1895 return -EINVAL; 1896 1897 return mux_device_request(serial, 1898 USB_CDC_SEND_ENCAPSULATED_COMMAND, 1899 serial->parent->port_spec & HSO_PORT_MASK, 1900 serial->tx_urb, 1901 &serial->ctrl_req_tx, 1902 serial->tx_data, serial->tx_data_count); 1903 } 1904 1905 /* write callback for Diag and CS port */ 1906 static void hso_std_serial_write_bulk_callback(struct urb *urb) 1907 { 1908 struct hso_serial *serial = urb->context; 1909 int status = urb->status; 1910 unsigned long flags; 1911 1912 /* sanity check */ 1913 if (!serial) { 1914 hso_dbg(0x1, "serial == NULL\n"); 1915 return; 1916 } 1917 1918 spin_lock_irqsave(&serial->serial_lock, flags); 1919 serial->tx_urb_used = 0; 1920 spin_unlock_irqrestore(&serial->serial_lock, flags); 1921 if (status) { 1922 handle_usb_error(status, __func__, serial->parent); 1923 return; 1924 } 1925 hso_put_activity(serial->parent); 1926 tty_port_tty_wakeup(&serial->port); 1927 hso_kick_transmit(serial); 1928 1929 hso_dbg(0x1, "\n"); 1930 } 1931 1932 /* called for writing diag or CS serial port */ 1933 static int hso_std_serial_write_data(struct hso_serial *serial) 1934 { 1935 int count = serial->tx_data_count; 1936 int result; 1937 1938 usb_fill_bulk_urb(serial->tx_urb, 1939 serial->parent->usb, 1940 usb_sndbulkpipe(serial->parent->usb, 1941 serial->out_endp-> 1942 bEndpointAddress & 0x7F), 1943 serial->tx_data, serial->tx_data_count, 1944 hso_std_serial_write_bulk_callback, serial); 1945 1946 result = usb_submit_urb(serial->tx_urb, GFP_ATOMIC); 1947 if (result) { 1948 dev_warn(&serial->parent->usb->dev, 1949 "Failed to submit urb - res %d\n", result); 1950 return result; 1951 } 1952 1953 return count; 1954 } 1955 1956 /* callback after read or write on muxed serial port */ 1957 static void ctrl_callback(struct urb *urb) 1958 { 1959 struct hso_serial *serial = urb->context; 1960 struct usb_ctrlrequest *req; 1961 int status = urb->status; 1962 unsigned long flags; 1963 1964 /* sanity check */ 1965 if (!serial) 1966 return; 1967 1968 spin_lock_irqsave(&serial->serial_lock, flags); 1969 serial->tx_urb_used = 0; 1970 spin_unlock_irqrestore(&serial->serial_lock, flags); 1971 if (status) { 1972 handle_usb_error(status, __func__, serial->parent); 1973 return; 1974 } 1975 1976 /* what request? */ 1977 req = (struct usb_ctrlrequest *)(urb->setup_packet); 1978 hso_dbg(0x8, "--- Got muxed ctrl callback 0x%02X ---\n", status); 1979 hso_dbg(0x8, "Actual length of urb = %d\n", urb->actual_length); 1980 DUMP1(urb->transfer_buffer, urb->actual_length); 1981 1982 if (req->bRequestType == 1983 (USB_DIR_IN | USB_TYPE_OPTION_VENDOR | USB_RECIP_INTERFACE)) { 1984 /* response to a read command */ 1985 serial->rx_urb_filled[0] = 1; 1986 spin_lock_irqsave(&serial->serial_lock, flags); 1987 put_rxbuf_data_and_resubmit_ctrl_urb(serial); 1988 spin_unlock_irqrestore(&serial->serial_lock, flags); 1989 } else { 1990 hso_put_activity(serial->parent); 1991 tty_port_tty_wakeup(&serial->port); 1992 /* response to a write command */ 1993 hso_kick_transmit(serial); 1994 } 1995 } 1996 1997 /* handle RX data for serial port */ 1998 static int put_rxbuf_data(struct urb *urb, struct hso_serial *serial) 1999 { 2000 struct tty_struct *tty; 2001 int count; 2002 2003 /* Sanity check */ 2004 if (urb == NULL || serial == NULL) { 2005 hso_dbg(0x1, "serial = NULL\n"); 2006 return -2; 2007 } 2008 2009 tty = tty_port_tty_get(&serial->port); 2010 2011 if (tty && tty_throttled(tty)) { 2012 tty_kref_put(tty); 2013 return -1; 2014 } 2015 2016 /* Push data to tty */ 2017 hso_dbg(0x1, "data to push to tty\n"); 2018 count = tty_buffer_request_room(&serial->port, urb->actual_length); 2019 if (count >= urb->actual_length) { 2020 tty_insert_flip_string(&serial->port, urb->transfer_buffer, 2021 urb->actual_length); 2022 tty_flip_buffer_push(&serial->port); 2023 } else { 2024 dev_warn(&serial->parent->usb->dev, 2025 "dropping data, %d bytes lost\n", urb->actual_length); 2026 } 2027 2028 tty_kref_put(tty); 2029 2030 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 0; 2031 2032 return 0; 2033 } 2034 2035 2036 /* Base driver functions */ 2037 2038 static void hso_log_port(struct hso_device *hso_dev) 2039 { 2040 char *port_type; 2041 char port_dev[20]; 2042 2043 switch (hso_dev->port_spec & HSO_PORT_MASK) { 2044 case HSO_PORT_CONTROL: 2045 port_type = "Control"; 2046 break; 2047 case HSO_PORT_APP: 2048 port_type = "Application"; 2049 break; 2050 case HSO_PORT_GPS: 2051 port_type = "GPS"; 2052 break; 2053 case HSO_PORT_GPS_CONTROL: 2054 port_type = "GPS control"; 2055 break; 2056 case HSO_PORT_APP2: 2057 port_type = "Application2"; 2058 break; 2059 case HSO_PORT_PCSC: 2060 port_type = "PCSC"; 2061 break; 2062 case HSO_PORT_DIAG: 2063 port_type = "Diagnostic"; 2064 break; 2065 case HSO_PORT_DIAG2: 2066 port_type = "Diagnostic2"; 2067 break; 2068 case HSO_PORT_MODEM: 2069 port_type = "Modem"; 2070 break; 2071 case HSO_PORT_NETWORK: 2072 port_type = "Network"; 2073 break; 2074 default: 2075 port_type = "Unknown"; 2076 break; 2077 } 2078 if ((hso_dev->port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) { 2079 sprintf(port_dev, "%s", dev2net(hso_dev)->net->name); 2080 } else 2081 sprintf(port_dev, "/dev/%s%d", tty_filename, 2082 dev2ser(hso_dev)->minor); 2083 2084 dev_dbg(&hso_dev->interface->dev, "HSO: Found %s port %s\n", 2085 port_type, port_dev); 2086 } 2087 2088 static int hso_start_net_device(struct hso_device *hso_dev) 2089 { 2090 int i, result = 0; 2091 struct hso_net *hso_net = dev2net(hso_dev); 2092 2093 if (!hso_net) 2094 return -ENODEV; 2095 2096 /* send URBs for all read buffers */ 2097 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) { 2098 2099 /* Prep a receive URB */ 2100 usb_fill_bulk_urb(hso_net->mux_bulk_rx_urb_pool[i], 2101 hso_dev->usb, 2102 usb_rcvbulkpipe(hso_dev->usb, 2103 hso_net->in_endp-> 2104 bEndpointAddress & 0x7F), 2105 hso_net->mux_bulk_rx_buf_pool[i], 2106 MUX_BULK_RX_BUF_SIZE, read_bulk_callback, 2107 hso_net); 2108 2109 /* Put it out there so the device can send us stuff */ 2110 result = usb_submit_urb(hso_net->mux_bulk_rx_urb_pool[i], 2111 GFP_NOIO); 2112 if (result) 2113 dev_warn(&hso_dev->usb->dev, 2114 "%s failed mux_bulk_rx_urb[%d] %d\n", __func__, 2115 i, result); 2116 } 2117 2118 return result; 2119 } 2120 2121 static int hso_stop_net_device(struct hso_device *hso_dev) 2122 { 2123 int i; 2124 struct hso_net *hso_net = dev2net(hso_dev); 2125 2126 if (!hso_net) 2127 return -ENODEV; 2128 2129 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) { 2130 if (hso_net->mux_bulk_rx_urb_pool[i]) 2131 usb_kill_urb(hso_net->mux_bulk_rx_urb_pool[i]); 2132 2133 } 2134 if (hso_net->mux_bulk_tx_urb) 2135 usb_kill_urb(hso_net->mux_bulk_tx_urb); 2136 2137 return 0; 2138 } 2139 2140 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags) 2141 { 2142 int i, result = 0; 2143 struct hso_serial *serial = dev2ser(hso_dev); 2144 2145 if (!serial) 2146 return -ENODEV; 2147 2148 /* If it is not the MUX port fill in and submit a bulk urb (already 2149 * allocated in hso_serial_start) */ 2150 if (!(serial->parent->port_spec & HSO_INTF_MUX)) { 2151 for (i = 0; i < serial->num_rx_urbs; i++) { 2152 usb_fill_bulk_urb(serial->rx_urb[i], 2153 serial->parent->usb, 2154 usb_rcvbulkpipe(serial->parent->usb, 2155 serial->in_endp-> 2156 bEndpointAddress & 2157 0x7F), 2158 serial->rx_data[i], 2159 serial->rx_data_length, 2160 hso_std_serial_read_bulk_callback, 2161 serial); 2162 result = usb_submit_urb(serial->rx_urb[i], flags); 2163 if (result) { 2164 dev_warn(&serial->parent->usb->dev, 2165 "Failed to submit urb - res %d\n", 2166 result); 2167 break; 2168 } 2169 } 2170 } else { 2171 mutex_lock(&serial->shared_int->shared_int_lock); 2172 if (!serial->shared_int->use_count) { 2173 result = 2174 hso_mux_submit_intr_urb(serial->shared_int, 2175 hso_dev->usb, flags); 2176 } 2177 serial->shared_int->use_count++; 2178 mutex_unlock(&serial->shared_int->shared_int_lock); 2179 } 2180 if (serial->tiocmget) 2181 tiocmget_submit_urb(serial, 2182 serial->tiocmget, 2183 serial->parent->usb); 2184 return result; 2185 } 2186 2187 static int hso_stop_serial_device(struct hso_device *hso_dev) 2188 { 2189 int i; 2190 struct hso_serial *serial = dev2ser(hso_dev); 2191 struct hso_tiocmget *tiocmget; 2192 2193 if (!serial) 2194 return -ENODEV; 2195 2196 for (i = 0; i < serial->num_rx_urbs; i++) { 2197 if (serial->rx_urb[i]) { 2198 usb_kill_urb(serial->rx_urb[i]); 2199 serial->rx_urb_filled[i] = 0; 2200 } 2201 } 2202 serial->curr_rx_urb_idx = 0; 2203 2204 if (serial->tx_urb) 2205 usb_kill_urb(serial->tx_urb); 2206 2207 if (serial->shared_int) { 2208 mutex_lock(&serial->shared_int->shared_int_lock); 2209 if (serial->shared_int->use_count && 2210 (--serial->shared_int->use_count == 0)) { 2211 struct urb *urb; 2212 2213 urb = serial->shared_int->shared_intr_urb; 2214 if (urb) 2215 usb_kill_urb(urb); 2216 } 2217 mutex_unlock(&serial->shared_int->shared_int_lock); 2218 } 2219 tiocmget = serial->tiocmget; 2220 if (tiocmget) { 2221 wake_up_interruptible(&tiocmget->waitq); 2222 usb_kill_urb(tiocmget->urb); 2223 } 2224 2225 return 0; 2226 } 2227 2228 static void hso_serial_tty_unregister(struct hso_serial *serial) 2229 { 2230 tty_unregister_device(tty_drv, serial->minor); 2231 release_minor(serial); 2232 } 2233 2234 static void hso_serial_common_free(struct hso_serial *serial) 2235 { 2236 int i; 2237 2238 for (i = 0; i < serial->num_rx_urbs; i++) { 2239 /* unlink and free RX URB */ 2240 usb_free_urb(serial->rx_urb[i]); 2241 /* free the RX buffer */ 2242 kfree(serial->rx_data[i]); 2243 } 2244 2245 /* unlink and free TX URB */ 2246 usb_free_urb(serial->tx_urb); 2247 kfree(serial->tx_buffer); 2248 kfree(serial->tx_data); 2249 tty_port_destroy(&serial->port); 2250 } 2251 2252 static int hso_serial_common_create(struct hso_serial *serial, int num_urbs, 2253 int rx_size, int tx_size) 2254 { 2255 int i; 2256 2257 tty_port_init(&serial->port); 2258 2259 if (obtain_minor(serial)) 2260 goto exit2; 2261 2262 /* register our minor number */ 2263 serial->parent->dev = tty_port_register_device_attr(&serial->port, 2264 tty_drv, serial->minor, &serial->parent->interface->dev, 2265 serial->parent, hso_serial_dev_groups); 2266 if (IS_ERR(serial->parent->dev)) { 2267 release_minor(serial); 2268 goto exit2; 2269 } 2270 2271 serial->magic = HSO_SERIAL_MAGIC; 2272 spin_lock_init(&serial->serial_lock); 2273 serial->num_rx_urbs = num_urbs; 2274 2275 /* RX, allocate urb and initialize */ 2276 2277 /* prepare our RX buffer */ 2278 serial->rx_data_length = rx_size; 2279 for (i = 0; i < serial->num_rx_urbs; i++) { 2280 serial->rx_urb[i] = usb_alloc_urb(0, GFP_KERNEL); 2281 if (!serial->rx_urb[i]) 2282 goto exit; 2283 serial->rx_urb[i]->transfer_buffer = NULL; 2284 serial->rx_urb[i]->transfer_buffer_length = 0; 2285 serial->rx_data[i] = kzalloc(serial->rx_data_length, 2286 GFP_KERNEL); 2287 if (!serial->rx_data[i]) 2288 goto exit; 2289 } 2290 2291 /* TX, allocate urb and initialize */ 2292 serial->tx_urb = usb_alloc_urb(0, GFP_KERNEL); 2293 if (!serial->tx_urb) 2294 goto exit; 2295 serial->tx_urb->transfer_buffer = NULL; 2296 serial->tx_urb->transfer_buffer_length = 0; 2297 /* prepare our TX buffer */ 2298 serial->tx_data_count = 0; 2299 serial->tx_buffer_count = 0; 2300 serial->tx_data_length = tx_size; 2301 serial->tx_data = kzalloc(serial->tx_data_length, GFP_KERNEL); 2302 if (!serial->tx_data) 2303 goto exit; 2304 2305 serial->tx_buffer = kzalloc(serial->tx_data_length, GFP_KERNEL); 2306 if (!serial->tx_buffer) 2307 goto exit; 2308 2309 return 0; 2310 exit: 2311 hso_serial_tty_unregister(serial); 2312 exit2: 2313 hso_serial_common_free(serial); 2314 return -1; 2315 } 2316 2317 /* Creates a general hso device */ 2318 static struct hso_device *hso_create_device(struct usb_interface *intf, 2319 int port_spec) 2320 { 2321 struct hso_device *hso_dev; 2322 2323 hso_dev = kzalloc(sizeof(*hso_dev), GFP_ATOMIC); 2324 if (!hso_dev) 2325 return NULL; 2326 2327 hso_dev->port_spec = port_spec; 2328 hso_dev->usb = interface_to_usbdev(intf); 2329 hso_dev->interface = intf; 2330 kref_init(&hso_dev->ref); 2331 mutex_init(&hso_dev->mutex); 2332 2333 INIT_WORK(&hso_dev->async_get_intf, async_get_intf); 2334 INIT_WORK(&hso_dev->async_put_intf, async_put_intf); 2335 2336 return hso_dev; 2337 } 2338 2339 /* Removes a network device in the network device table */ 2340 static int remove_net_device(struct hso_device *hso_dev) 2341 { 2342 int i; 2343 2344 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) { 2345 if (network_table[i] == hso_dev) { 2346 network_table[i] = NULL; 2347 break; 2348 } 2349 } 2350 if (i == HSO_MAX_NET_DEVICES) 2351 return -1; 2352 return 0; 2353 } 2354 2355 /* Frees our network device */ 2356 static void hso_free_net_device(struct hso_device *hso_dev, bool bailout) 2357 { 2358 int i; 2359 struct hso_net *hso_net = dev2net(hso_dev); 2360 2361 if (!hso_net) 2362 return; 2363 2364 remove_net_device(hso_net->parent); 2365 2366 if (hso_net->net) 2367 unregister_netdev(hso_net->net); 2368 2369 /* start freeing */ 2370 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) { 2371 usb_free_urb(hso_net->mux_bulk_rx_urb_pool[i]); 2372 kfree(hso_net->mux_bulk_rx_buf_pool[i]); 2373 hso_net->mux_bulk_rx_buf_pool[i] = NULL; 2374 } 2375 usb_free_urb(hso_net->mux_bulk_tx_urb); 2376 kfree(hso_net->mux_bulk_tx_buf); 2377 hso_net->mux_bulk_tx_buf = NULL; 2378 2379 if (hso_net->net && !bailout) 2380 free_netdev(hso_net->net); 2381 2382 kfree(hso_dev); 2383 } 2384 2385 static const struct net_device_ops hso_netdev_ops = { 2386 .ndo_open = hso_net_open, 2387 .ndo_stop = hso_net_close, 2388 .ndo_start_xmit = hso_net_start_xmit, 2389 .ndo_tx_timeout = hso_net_tx_timeout, 2390 }; 2391 2392 /* initialize the network interface */ 2393 static void hso_net_init(struct net_device *net) 2394 { 2395 struct hso_net *hso_net = netdev_priv(net); 2396 2397 hso_dbg(0x1, "sizeof hso_net is %zu\n", sizeof(*hso_net)); 2398 2399 /* fill in the other fields */ 2400 net->netdev_ops = &hso_netdev_ops; 2401 net->watchdog_timeo = HSO_NET_TX_TIMEOUT; 2402 net->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST; 2403 net->type = ARPHRD_NONE; 2404 net->mtu = DEFAULT_MTU - 14; 2405 net->tx_queue_len = 10; 2406 net->ethtool_ops = &ops; 2407 2408 /* and initialize the semaphore */ 2409 spin_lock_init(&hso_net->net_lock); 2410 } 2411 2412 /* Adds a network device in the network device table */ 2413 static int add_net_device(struct hso_device *hso_dev) 2414 { 2415 int i; 2416 2417 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) { 2418 if (network_table[i] == NULL) { 2419 network_table[i] = hso_dev; 2420 break; 2421 } 2422 } 2423 if (i == HSO_MAX_NET_DEVICES) 2424 return -1; 2425 return 0; 2426 } 2427 2428 static int hso_rfkill_set_block(void *data, bool blocked) 2429 { 2430 struct hso_device *hso_dev = data; 2431 int enabled = !blocked; 2432 int rv; 2433 2434 mutex_lock(&hso_dev->mutex); 2435 if (hso_dev->usb_gone) 2436 rv = 0; 2437 else 2438 rv = usb_control_msg(hso_dev->usb, usb_sndctrlpipe(hso_dev->usb, 0), 2439 enabled ? 0x82 : 0x81, 0x40, 0, 0, NULL, 0, 2440 USB_CTRL_SET_TIMEOUT); 2441 mutex_unlock(&hso_dev->mutex); 2442 return rv; 2443 } 2444 2445 static const struct rfkill_ops hso_rfkill_ops = { 2446 .set_block = hso_rfkill_set_block, 2447 }; 2448 2449 /* Creates and sets up everything for rfkill */ 2450 static void hso_create_rfkill(struct hso_device *hso_dev, 2451 struct usb_interface *interface) 2452 { 2453 struct hso_net *hso_net = dev2net(hso_dev); 2454 struct device *dev = &hso_net->net->dev; 2455 static u32 rfkill_counter; 2456 2457 snprintf(hso_net->name, sizeof(hso_net->name), "hso-%d", 2458 rfkill_counter++); 2459 2460 hso_net->rfkill = rfkill_alloc(hso_net->name, 2461 &interface_to_usbdev(interface)->dev, 2462 RFKILL_TYPE_WWAN, 2463 &hso_rfkill_ops, hso_dev); 2464 if (!hso_net->rfkill) 2465 return; 2466 2467 if (rfkill_register(hso_net->rfkill) < 0) { 2468 rfkill_destroy(hso_net->rfkill); 2469 hso_net->rfkill = NULL; 2470 dev_err(dev, "%s - Failed to register rfkill\n", __func__); 2471 return; 2472 } 2473 } 2474 2475 static struct device_type hso_type = { 2476 .name = "wwan", 2477 }; 2478 2479 /* Creates our network device */ 2480 static struct hso_device *hso_create_net_device(struct usb_interface *interface, 2481 int port_spec) 2482 { 2483 int result, i; 2484 struct net_device *net; 2485 struct hso_net *hso_net; 2486 struct hso_device *hso_dev; 2487 2488 hso_dev = hso_create_device(interface, port_spec); 2489 if (!hso_dev) 2490 return NULL; 2491 2492 /* allocate our network device, then we can put in our private data */ 2493 /* call hso_net_init to do the basic initialization */ 2494 net = alloc_netdev(sizeof(struct hso_net), "hso%d", NET_NAME_UNKNOWN, 2495 hso_net_init); 2496 if (!net) { 2497 dev_err(&interface->dev, "Unable to create ethernet device\n"); 2498 goto exit; 2499 } 2500 2501 hso_net = netdev_priv(net); 2502 2503 hso_dev->port_data.dev_net = hso_net; 2504 hso_net->net = net; 2505 hso_net->parent = hso_dev; 2506 2507 hso_net->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK, 2508 USB_DIR_IN); 2509 if (!hso_net->in_endp) { 2510 dev_err(&interface->dev, "Can't find BULK IN endpoint\n"); 2511 goto exit; 2512 } 2513 hso_net->out_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK, 2514 USB_DIR_OUT); 2515 if (!hso_net->out_endp) { 2516 dev_err(&interface->dev, "Can't find BULK OUT endpoint\n"); 2517 goto exit; 2518 } 2519 SET_NETDEV_DEV(net, &interface->dev); 2520 SET_NETDEV_DEVTYPE(net, &hso_type); 2521 2522 /* start allocating */ 2523 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) { 2524 hso_net->mux_bulk_rx_urb_pool[i] = usb_alloc_urb(0, GFP_KERNEL); 2525 if (!hso_net->mux_bulk_rx_urb_pool[i]) 2526 goto exit; 2527 hso_net->mux_bulk_rx_buf_pool[i] = kzalloc(MUX_BULK_RX_BUF_SIZE, 2528 GFP_KERNEL); 2529 if (!hso_net->mux_bulk_rx_buf_pool[i]) 2530 goto exit; 2531 } 2532 hso_net->mux_bulk_tx_urb = usb_alloc_urb(0, GFP_KERNEL); 2533 if (!hso_net->mux_bulk_tx_urb) 2534 goto exit; 2535 hso_net->mux_bulk_tx_buf = kzalloc(MUX_BULK_TX_BUF_SIZE, GFP_KERNEL); 2536 if (!hso_net->mux_bulk_tx_buf) 2537 goto exit; 2538 2539 add_net_device(hso_dev); 2540 2541 /* registering our net device */ 2542 result = register_netdev(net); 2543 if (result) { 2544 dev_err(&interface->dev, "Failed to register device\n"); 2545 goto exit; 2546 } 2547 2548 hso_log_port(hso_dev); 2549 2550 hso_create_rfkill(hso_dev, interface); 2551 2552 return hso_dev; 2553 exit: 2554 hso_free_net_device(hso_dev, true); 2555 return NULL; 2556 } 2557 2558 static void hso_free_tiomget(struct hso_serial *serial) 2559 { 2560 struct hso_tiocmget *tiocmget; 2561 if (!serial) 2562 return; 2563 tiocmget = serial->tiocmget; 2564 if (tiocmget) { 2565 usb_free_urb(tiocmget->urb); 2566 tiocmget->urb = NULL; 2567 serial->tiocmget = NULL; 2568 kfree(tiocmget->serial_state_notification); 2569 tiocmget->serial_state_notification = NULL; 2570 kfree(tiocmget); 2571 } 2572 } 2573 2574 /* Frees an AT channel ( goes for both mux and non-mux ) */ 2575 static void hso_free_serial_device(struct hso_device *hso_dev) 2576 { 2577 struct hso_serial *serial = dev2ser(hso_dev); 2578 2579 if (!serial) 2580 return; 2581 2582 hso_serial_common_free(serial); 2583 2584 if (serial->shared_int) { 2585 mutex_lock(&serial->shared_int->shared_int_lock); 2586 if (--serial->shared_int->ref_count == 0) 2587 hso_free_shared_int(serial->shared_int); 2588 else 2589 mutex_unlock(&serial->shared_int->shared_int_lock); 2590 } 2591 hso_free_tiomget(serial); 2592 kfree(serial); 2593 kfree(hso_dev); 2594 } 2595 2596 /* Creates a bulk AT channel */ 2597 static struct hso_device *hso_create_bulk_serial_device( 2598 struct usb_interface *interface, int port) 2599 { 2600 struct hso_device *hso_dev; 2601 struct hso_serial *serial; 2602 int num_urbs; 2603 struct hso_tiocmget *tiocmget; 2604 2605 hso_dev = hso_create_device(interface, port); 2606 if (!hso_dev) 2607 return NULL; 2608 2609 serial = kzalloc(sizeof(*serial), GFP_KERNEL); 2610 if (!serial) 2611 goto exit; 2612 2613 serial->parent = hso_dev; 2614 hso_dev->port_data.dev_serial = serial; 2615 2616 if ((port & HSO_PORT_MASK) == HSO_PORT_MODEM) { 2617 num_urbs = 2; 2618 serial->tiocmget = kzalloc(sizeof(struct hso_tiocmget), 2619 GFP_KERNEL); 2620 if (!serial->tiocmget) 2621 goto exit; 2622 serial->tiocmget->serial_state_notification 2623 = kzalloc(sizeof(struct hso_serial_state_notification), 2624 GFP_KERNEL); 2625 if (!serial->tiocmget->serial_state_notification) 2626 goto exit; 2627 tiocmget = serial->tiocmget; 2628 tiocmget->endp = hso_get_ep(interface, 2629 USB_ENDPOINT_XFER_INT, 2630 USB_DIR_IN); 2631 if (!tiocmget->endp) { 2632 dev_err(&interface->dev, "Failed to find INT IN ep\n"); 2633 goto exit; 2634 } 2635 2636 tiocmget->urb = usb_alloc_urb(0, GFP_KERNEL); 2637 if (!tiocmget->urb) 2638 goto exit; 2639 2640 mutex_init(&tiocmget->mutex); 2641 init_waitqueue_head(&tiocmget->waitq); 2642 } else { 2643 num_urbs = 1; 2644 } 2645 2646 if (hso_serial_common_create(serial, num_urbs, BULK_URB_RX_SIZE, 2647 BULK_URB_TX_SIZE)) 2648 goto exit; 2649 2650 serial->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK, 2651 USB_DIR_IN); 2652 if (!serial->in_endp) { 2653 dev_err(&interface->dev, "Failed to find BULK IN ep\n"); 2654 goto exit2; 2655 } 2656 2657 if (! 2658 (serial->out_endp = 2659 hso_get_ep(interface, USB_ENDPOINT_XFER_BULK, USB_DIR_OUT))) { 2660 dev_err(&interface->dev, "Failed to find BULK OUT ep\n"); 2661 goto exit2; 2662 } 2663 2664 serial->write_data = hso_std_serial_write_data; 2665 2666 /* setup the proc dirs and files if needed */ 2667 hso_log_port(hso_dev); 2668 2669 /* done, return it */ 2670 return hso_dev; 2671 2672 exit2: 2673 hso_serial_tty_unregister(serial); 2674 hso_serial_common_free(serial); 2675 exit: 2676 hso_free_tiomget(serial); 2677 kfree(serial); 2678 kfree(hso_dev); 2679 return NULL; 2680 } 2681 2682 /* Creates a multiplexed AT channel */ 2683 static 2684 struct hso_device *hso_create_mux_serial_device(struct usb_interface *interface, 2685 int port, 2686 struct hso_shared_int *mux) 2687 { 2688 struct hso_device *hso_dev; 2689 struct hso_serial *serial; 2690 int port_spec; 2691 2692 port_spec = HSO_INTF_MUX; 2693 port_spec &= ~HSO_PORT_MASK; 2694 2695 port_spec |= hso_mux_to_port(port); 2696 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NO_PORT) 2697 return NULL; 2698 2699 hso_dev = hso_create_device(interface, port_spec); 2700 if (!hso_dev) 2701 return NULL; 2702 2703 serial = kzalloc(sizeof(*serial), GFP_KERNEL); 2704 if (!serial) 2705 goto exit; 2706 2707 hso_dev->port_data.dev_serial = serial; 2708 serial->parent = hso_dev; 2709 2710 if (hso_serial_common_create 2711 (serial, 1, CTRL_URB_RX_SIZE, CTRL_URB_TX_SIZE)) 2712 goto exit; 2713 2714 serial->tx_data_length--; 2715 serial->write_data = hso_mux_serial_write_data; 2716 2717 serial->shared_int = mux; 2718 mutex_lock(&serial->shared_int->shared_int_lock); 2719 serial->shared_int->ref_count++; 2720 mutex_unlock(&serial->shared_int->shared_int_lock); 2721 2722 /* setup the proc dirs and files if needed */ 2723 hso_log_port(hso_dev); 2724 2725 /* done, return it */ 2726 return hso_dev; 2727 2728 exit: 2729 if (serial) { 2730 tty_unregister_device(tty_drv, serial->minor); 2731 kfree(serial); 2732 } 2733 kfree(hso_dev); 2734 return NULL; 2735 2736 } 2737 2738 static void hso_free_shared_int(struct hso_shared_int *mux) 2739 { 2740 usb_free_urb(mux->shared_intr_urb); 2741 kfree(mux->shared_intr_buf); 2742 mutex_unlock(&mux->shared_int_lock); 2743 kfree(mux); 2744 } 2745 2746 static 2747 struct hso_shared_int *hso_create_shared_int(struct usb_interface *interface) 2748 { 2749 struct hso_shared_int *mux = kzalloc(sizeof(*mux), GFP_KERNEL); 2750 2751 if (!mux) 2752 return NULL; 2753 2754 mux->intr_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_INT, 2755 USB_DIR_IN); 2756 if (!mux->intr_endp) { 2757 dev_err(&interface->dev, "Can't find INT IN endpoint\n"); 2758 goto exit; 2759 } 2760 2761 mux->shared_intr_urb = usb_alloc_urb(0, GFP_KERNEL); 2762 if (!mux->shared_intr_urb) 2763 goto exit; 2764 mux->shared_intr_buf = 2765 kzalloc(le16_to_cpu(mux->intr_endp->wMaxPacketSize), 2766 GFP_KERNEL); 2767 if (!mux->shared_intr_buf) 2768 goto exit; 2769 2770 mutex_init(&mux->shared_int_lock); 2771 2772 return mux; 2773 2774 exit: 2775 kfree(mux->shared_intr_buf); 2776 usb_free_urb(mux->shared_intr_urb); 2777 kfree(mux); 2778 return NULL; 2779 } 2780 2781 /* Gets the port spec for a certain interface */ 2782 static int hso_get_config_data(struct usb_interface *interface) 2783 { 2784 struct usb_device *usbdev = interface_to_usbdev(interface); 2785 u8 *config_data = kmalloc(17, GFP_KERNEL); 2786 u32 if_num = interface->cur_altsetting->desc.bInterfaceNumber; 2787 s32 result; 2788 2789 if (!config_data) 2790 return -ENOMEM; 2791 if (usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev, 0), 2792 0x86, 0xC0, 0, 0, config_data, 17, 2793 USB_CTRL_SET_TIMEOUT) != 0x11) { 2794 kfree(config_data); 2795 return -EIO; 2796 } 2797 2798 /* check if we have a valid interface */ 2799 if (if_num > 16) { 2800 kfree(config_data); 2801 return -EINVAL; 2802 } 2803 2804 switch (config_data[if_num]) { 2805 case 0x0: 2806 result = 0; 2807 break; 2808 case 0x1: 2809 result = HSO_PORT_DIAG; 2810 break; 2811 case 0x2: 2812 result = HSO_PORT_GPS; 2813 break; 2814 case 0x3: 2815 result = HSO_PORT_GPS_CONTROL; 2816 break; 2817 case 0x4: 2818 result = HSO_PORT_APP; 2819 break; 2820 case 0x5: 2821 result = HSO_PORT_APP2; 2822 break; 2823 case 0x6: 2824 result = HSO_PORT_CONTROL; 2825 break; 2826 case 0x7: 2827 result = HSO_PORT_NETWORK; 2828 break; 2829 case 0x8: 2830 result = HSO_PORT_MODEM; 2831 break; 2832 case 0x9: 2833 result = HSO_PORT_MSD; 2834 break; 2835 case 0xa: 2836 result = HSO_PORT_PCSC; 2837 break; 2838 case 0xb: 2839 result = HSO_PORT_VOICE; 2840 break; 2841 default: 2842 result = 0; 2843 } 2844 2845 if (result) 2846 result |= HSO_INTF_BULK; 2847 2848 if (config_data[16] & 0x1) 2849 result |= HSO_INFO_CRC_BUG; 2850 2851 kfree(config_data); 2852 return result; 2853 } 2854 2855 /* called once for each interface upon device insertion */ 2856 static int hso_probe(struct usb_interface *interface, 2857 const struct usb_device_id *id) 2858 { 2859 int mux, i, if_num, port_spec; 2860 unsigned char port_mask; 2861 struct hso_device *hso_dev = NULL; 2862 struct hso_shared_int *shared_int; 2863 struct hso_device *tmp_dev = NULL; 2864 2865 if (interface->cur_altsetting->desc.bInterfaceClass != 0xFF) { 2866 dev_err(&interface->dev, "Not our interface\n"); 2867 return -ENODEV; 2868 } 2869 2870 if_num = interface->cur_altsetting->desc.bInterfaceNumber; 2871 2872 /* Get the interface/port specification from either driver_info or from 2873 * the device itself */ 2874 if (id->driver_info) { 2875 /* if_num is controlled by the device, driver_info is a 0 terminated 2876 * array. Make sure, the access is in bounds! */ 2877 for (i = 0; i <= if_num; ++i) 2878 if (((u32 *)(id->driver_info))[i] == 0) 2879 goto exit; 2880 port_spec = ((u32 *)(id->driver_info))[if_num]; 2881 } else { 2882 port_spec = hso_get_config_data(interface); 2883 if (port_spec < 0) 2884 goto exit; 2885 } 2886 2887 /* Check if we need to switch to alt interfaces prior to port 2888 * configuration */ 2889 if (interface->num_altsetting > 1) 2890 usb_set_interface(interface_to_usbdev(interface), if_num, 1); 2891 interface->needs_remote_wakeup = 1; 2892 2893 /* Allocate new hso device(s) */ 2894 switch (port_spec & HSO_INTF_MASK) { 2895 case HSO_INTF_MUX: 2896 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) { 2897 /* Create the network device */ 2898 if (!disable_net) { 2899 hso_dev = hso_create_net_device(interface, 2900 port_spec); 2901 if (!hso_dev) 2902 goto exit; 2903 tmp_dev = hso_dev; 2904 } 2905 } 2906 2907 if (hso_get_mux_ports(interface, &port_mask)) 2908 /* TODO: de-allocate everything */ 2909 goto exit; 2910 2911 shared_int = hso_create_shared_int(interface); 2912 if (!shared_int) 2913 goto exit; 2914 2915 for (i = 1, mux = 0; i < 0x100; i = i << 1, mux++) { 2916 if (port_mask & i) { 2917 hso_dev = hso_create_mux_serial_device( 2918 interface, i, shared_int); 2919 if (!hso_dev) 2920 goto exit; 2921 } 2922 } 2923 2924 if (tmp_dev) 2925 hso_dev = tmp_dev; 2926 break; 2927 2928 case HSO_INTF_BULK: 2929 /* It's a regular bulk interface */ 2930 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) { 2931 if (!disable_net) 2932 hso_dev = 2933 hso_create_net_device(interface, port_spec); 2934 } else { 2935 hso_dev = 2936 hso_create_bulk_serial_device(interface, port_spec); 2937 } 2938 if (!hso_dev) 2939 goto exit; 2940 break; 2941 default: 2942 goto exit; 2943 } 2944 2945 /* save our data pointer in this device */ 2946 usb_set_intfdata(interface, hso_dev); 2947 2948 /* done */ 2949 return 0; 2950 exit: 2951 hso_free_interface(interface); 2952 return -ENODEV; 2953 } 2954 2955 /* device removed, cleaning up */ 2956 static void hso_disconnect(struct usb_interface *interface) 2957 { 2958 hso_free_interface(interface); 2959 2960 /* remove reference of our private data */ 2961 usb_set_intfdata(interface, NULL); 2962 } 2963 2964 static void async_get_intf(struct work_struct *data) 2965 { 2966 struct hso_device *hso_dev = 2967 container_of(data, struct hso_device, async_get_intf); 2968 usb_autopm_get_interface(hso_dev->interface); 2969 } 2970 2971 static void async_put_intf(struct work_struct *data) 2972 { 2973 struct hso_device *hso_dev = 2974 container_of(data, struct hso_device, async_put_intf); 2975 usb_autopm_put_interface(hso_dev->interface); 2976 } 2977 2978 static int hso_get_activity(struct hso_device *hso_dev) 2979 { 2980 if (hso_dev->usb->state == USB_STATE_SUSPENDED) { 2981 if (!hso_dev->is_active) { 2982 hso_dev->is_active = 1; 2983 schedule_work(&hso_dev->async_get_intf); 2984 } 2985 } 2986 2987 if (hso_dev->usb->state != USB_STATE_CONFIGURED) 2988 return -EAGAIN; 2989 2990 usb_mark_last_busy(hso_dev->usb); 2991 2992 return 0; 2993 } 2994 2995 static int hso_put_activity(struct hso_device *hso_dev) 2996 { 2997 if (hso_dev->usb->state != USB_STATE_SUSPENDED) { 2998 if (hso_dev->is_active) { 2999 hso_dev->is_active = 0; 3000 schedule_work(&hso_dev->async_put_intf); 3001 return -EAGAIN; 3002 } 3003 } 3004 hso_dev->is_active = 0; 3005 return 0; 3006 } 3007 3008 /* called by kernel when we need to suspend device */ 3009 static int hso_suspend(struct usb_interface *iface, pm_message_t message) 3010 { 3011 int i, result; 3012 3013 /* Stop all serial ports */ 3014 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) { 3015 if (serial_table[i] && (serial_table[i]->interface == iface)) { 3016 result = hso_stop_serial_device(serial_table[i]); 3017 if (result) 3018 goto out; 3019 } 3020 } 3021 3022 /* Stop all network ports */ 3023 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) { 3024 if (network_table[i] && 3025 (network_table[i]->interface == iface)) { 3026 result = hso_stop_net_device(network_table[i]); 3027 if (result) 3028 goto out; 3029 } 3030 } 3031 3032 out: 3033 return 0; 3034 } 3035 3036 /* called by kernel when we need to resume device */ 3037 static int hso_resume(struct usb_interface *iface) 3038 { 3039 int i, result = 0; 3040 struct hso_net *hso_net; 3041 3042 /* Start all serial ports */ 3043 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) { 3044 if (serial_table[i] && (serial_table[i]->interface == iface)) { 3045 if (dev2ser(serial_table[i])->port.count) { 3046 result = 3047 hso_start_serial_device(serial_table[i], GFP_NOIO); 3048 hso_kick_transmit(dev2ser(serial_table[i])); 3049 if (result) 3050 goto out; 3051 } 3052 } 3053 } 3054 3055 /* Start all network ports */ 3056 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) { 3057 if (network_table[i] && 3058 (network_table[i]->interface == iface)) { 3059 hso_net = dev2net(network_table[i]); 3060 if (hso_net->flags & IFF_UP) { 3061 /* First transmit any lingering data, 3062 then restart the device. */ 3063 if (hso_net->skb_tx_buf) { 3064 dev_dbg(&iface->dev, 3065 "Transmitting" 3066 " lingering data\n"); 3067 hso_net_start_xmit(hso_net->skb_tx_buf, 3068 hso_net->net); 3069 hso_net->skb_tx_buf = NULL; 3070 } 3071 result = hso_start_net_device(network_table[i]); 3072 if (result) 3073 goto out; 3074 } 3075 } 3076 } 3077 3078 out: 3079 return result; 3080 } 3081 3082 static void hso_serial_ref_free(struct kref *ref) 3083 { 3084 struct hso_device *hso_dev = container_of(ref, struct hso_device, ref); 3085 3086 hso_free_serial_device(hso_dev); 3087 } 3088 3089 static void hso_free_interface(struct usb_interface *interface) 3090 { 3091 struct hso_serial *serial; 3092 int i; 3093 3094 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) { 3095 if (serial_table[i] && 3096 (serial_table[i]->interface == interface)) { 3097 serial = dev2ser(serial_table[i]); 3098 tty_port_tty_hangup(&serial->port, false); 3099 mutex_lock(&serial->parent->mutex); 3100 serial->parent->usb_gone = 1; 3101 mutex_unlock(&serial->parent->mutex); 3102 cancel_work_sync(&serial_table[i]->async_put_intf); 3103 cancel_work_sync(&serial_table[i]->async_get_intf); 3104 hso_serial_tty_unregister(serial); 3105 kref_put(&serial->parent->ref, hso_serial_ref_free); 3106 } 3107 } 3108 3109 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) { 3110 if (network_table[i] && 3111 (network_table[i]->interface == interface)) { 3112 struct rfkill *rfk = dev2net(network_table[i])->rfkill; 3113 /* hso_stop_net_device doesn't stop the net queue since 3114 * traffic needs to start it again when suspended */ 3115 netif_stop_queue(dev2net(network_table[i])->net); 3116 hso_stop_net_device(network_table[i]); 3117 cancel_work_sync(&network_table[i]->async_put_intf); 3118 cancel_work_sync(&network_table[i]->async_get_intf); 3119 if (rfk) { 3120 rfkill_unregister(rfk); 3121 rfkill_destroy(rfk); 3122 } 3123 hso_free_net_device(network_table[i], false); 3124 } 3125 } 3126 } 3127 3128 /* Helper functions */ 3129 3130 /* Get the endpoint ! */ 3131 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf, 3132 int type, int dir) 3133 { 3134 int i; 3135 struct usb_host_interface *iface = intf->cur_altsetting; 3136 struct usb_endpoint_descriptor *endp; 3137 3138 for (i = 0; i < iface->desc.bNumEndpoints; i++) { 3139 endp = &iface->endpoint[i].desc; 3140 if (((endp->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == dir) && 3141 (usb_endpoint_type(endp) == type)) 3142 return endp; 3143 } 3144 3145 return NULL; 3146 } 3147 3148 /* Get the byte that describes which ports are enabled */ 3149 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports) 3150 { 3151 int i; 3152 struct usb_host_interface *iface = intf->cur_altsetting; 3153 3154 if (iface->extralen == 3) { 3155 *ports = iface->extra[2]; 3156 return 0; 3157 } 3158 3159 for (i = 0; i < iface->desc.bNumEndpoints; i++) { 3160 if (iface->endpoint[i].extralen == 3) { 3161 *ports = iface->endpoint[i].extra[2]; 3162 return 0; 3163 } 3164 } 3165 3166 return -1; 3167 } 3168 3169 /* interrupt urb needs to be submitted, used for serial read of muxed port */ 3170 static int hso_mux_submit_intr_urb(struct hso_shared_int *shared_int, 3171 struct usb_device *usb, gfp_t gfp) 3172 { 3173 int result; 3174 3175 usb_fill_int_urb(shared_int->shared_intr_urb, usb, 3176 usb_rcvintpipe(usb, 3177 shared_int->intr_endp->bEndpointAddress & 0x7F), 3178 shared_int->shared_intr_buf, 3179 1, 3180 intr_callback, shared_int, 3181 shared_int->intr_endp->bInterval); 3182 3183 result = usb_submit_urb(shared_int->shared_intr_urb, gfp); 3184 if (result) 3185 dev_warn(&usb->dev, "%s failed mux_intr_urb %d\n", __func__, 3186 result); 3187 3188 return result; 3189 } 3190 3191 /* operations setup of the serial interface */ 3192 static const struct tty_operations hso_serial_ops = { 3193 .open = hso_serial_open, 3194 .close = hso_serial_close, 3195 .write = hso_serial_write, 3196 .write_room = hso_serial_write_room, 3197 .cleanup = hso_serial_cleanup, 3198 .ioctl = hso_serial_ioctl, 3199 .set_termios = hso_serial_set_termios, 3200 .chars_in_buffer = hso_serial_chars_in_buffer, 3201 .tiocmget = hso_serial_tiocmget, 3202 .tiocmset = hso_serial_tiocmset, 3203 .get_icount = hso_get_count, 3204 .unthrottle = hso_unthrottle 3205 }; 3206 3207 static struct usb_driver hso_driver = { 3208 .name = driver_name, 3209 .probe = hso_probe, 3210 .disconnect = hso_disconnect, 3211 .id_table = hso_ids, 3212 .suspend = hso_suspend, 3213 .resume = hso_resume, 3214 .reset_resume = hso_resume, 3215 .supports_autosuspend = 1, 3216 .disable_hub_initiated_lpm = 1, 3217 }; 3218 3219 static int __init hso_init(void) 3220 { 3221 int i; 3222 int result; 3223 3224 /* put it in the log */ 3225 pr_info("%s\n", version); 3226 3227 /* Initialise the serial table semaphore and table */ 3228 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) 3229 serial_table[i] = NULL; 3230 3231 /* allocate our driver using the proper amount of supported minors */ 3232 tty_drv = alloc_tty_driver(HSO_SERIAL_TTY_MINORS); 3233 if (!tty_drv) 3234 return -ENOMEM; 3235 3236 /* fill in all needed values */ 3237 tty_drv->driver_name = driver_name; 3238 tty_drv->name = tty_filename; 3239 3240 /* if major number is provided as parameter, use that one */ 3241 if (tty_major) 3242 tty_drv->major = tty_major; 3243 3244 tty_drv->minor_start = 0; 3245 tty_drv->type = TTY_DRIVER_TYPE_SERIAL; 3246 tty_drv->subtype = SERIAL_TYPE_NORMAL; 3247 tty_drv->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV; 3248 tty_drv->init_termios = tty_std_termios; 3249 hso_init_termios(&tty_drv->init_termios); 3250 tty_set_operations(tty_drv, &hso_serial_ops); 3251 3252 /* register the tty driver */ 3253 result = tty_register_driver(tty_drv); 3254 if (result) { 3255 pr_err("%s - tty_register_driver failed(%d)\n", 3256 __func__, result); 3257 goto err_free_tty; 3258 } 3259 3260 /* register this module as an usb driver */ 3261 result = usb_register(&hso_driver); 3262 if (result) { 3263 pr_err("Could not register hso driver - error: %d\n", result); 3264 goto err_unreg_tty; 3265 } 3266 3267 /* done */ 3268 return 0; 3269 err_unreg_tty: 3270 tty_unregister_driver(tty_drv); 3271 err_free_tty: 3272 put_tty_driver(tty_drv); 3273 return result; 3274 } 3275 3276 static void __exit hso_exit(void) 3277 { 3278 pr_info("unloaded\n"); 3279 3280 tty_unregister_driver(tty_drv); 3281 /* deregister the usb driver */ 3282 usb_deregister(&hso_driver); 3283 put_tty_driver(tty_drv); 3284 } 3285 3286 /* Module definitions */ 3287 module_init(hso_init); 3288 module_exit(hso_exit); 3289 3290 MODULE_AUTHOR(MOD_AUTHOR); 3291 MODULE_DESCRIPTION(MOD_DESCRIPTION); 3292 MODULE_LICENSE("GPL"); 3293 3294 /* change the debug level (eg: insmod hso.ko debug=0x04) */ 3295 MODULE_PARM_DESC(debug, "debug level mask [0x01 | 0x02 | 0x04 | 0x08 | 0x10]"); 3296 module_param(debug, int, 0644); 3297 3298 /* set the major tty number (eg: insmod hso.ko tty_major=245) */ 3299 MODULE_PARM_DESC(tty_major, "Set the major tty number"); 3300 module_param(tty_major, int, 0644); 3301 3302 /* disable network interface (eg: insmod hso.ko disable_net=1) */ 3303 MODULE_PARM_DESC(disable_net, "Disable the network interface"); 3304 module_param(disable_net, int, 0644); 3305