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