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