Linux Audio

Check our new training course

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