Linux Audio

Check our new training course

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