Linux Audio

Check our new training course

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