bas-gigaset.c 71.3 KB
Newer Older
1 2 3 4 5
/*
 * USB driver for Gigaset 307x base via direct USB connection.
 *
 * Copyright (c) 2001 by Hansjoerg Lipp <hjlipp@web.de>,
 *                       Tilman Schmidt <tilman@imap.cc>,
6
 *                       Stefan Eilers.
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
 *
 * =====================================================================
 *	This program is free software; you can redistribute it and/or
 *	modify it under the terms of the GNU General Public License as
 *	published by the Free Software Foundation; either version 2 of
 *	the License, or (at your option) any later version.
 * =====================================================================
 */

#include "gigaset.h"
#include <linux/usb.h>
#include <linux/module.h>
#include <linux/moduleparam.h>

/* Version Information */
22
#define DRIVER_AUTHOR "Tilman Schmidt <tilman@imap.cc>, Hansjoerg Lipp <hjlipp@web.de>, Stefan Eilers"
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
#define DRIVER_DESC "USB Driver for Gigaset 307x"


/* Module parameters */

static int startmode = SM_ISDN;
static int cidmode = 1;

module_param(startmode, int, S_IRUGO);
module_param(cidmode, int, S_IRUGO);
MODULE_PARM_DESC(startmode, "start in isdn4linux mode");
MODULE_PARM_DESC(cidmode, "Call-ID mode");

#define GIGASET_MINORS     1
#define GIGASET_MINOR      16
#define GIGASET_MODULENAME "bas_gigaset"
#define GIGASET_DEVNAME    "ttyGB"

41 42
/* length limit according to Siemens 3070usb-protokoll.doc ch. 2.1 */
#define IF_WRITEBUF 264
43

44 45 46
/* interrupt pipe message size according to ibid. ch. 2.2 */
#define IP_MSGSIZE 3

47 48
/* Values for the Gigaset 307x */
#define USB_GIGA_VENDOR_ID      0x0681
49 50
#define USB_3070_PRODUCT_ID     0x0001
#define USB_3075_PRODUCT_ID     0x0002
51 52 53 54
#define USB_SX303_PRODUCT_ID    0x0021
#define USB_SX353_PRODUCT_ID    0x0022

/* table of devices that work with this driver */
55
static const struct usb_device_id gigaset_table[] = {
56 57
	{ USB_DEVICE(USB_GIGA_VENDOR_ID, USB_3070_PRODUCT_ID) },
	{ USB_DEVICE(USB_GIGA_VENDOR_ID, USB_3075_PRODUCT_ID) },
58 59 60 61 62 63 64
	{ USB_DEVICE(USB_GIGA_VENDOR_ID, USB_SX303_PRODUCT_ID) },
	{ USB_DEVICE(USB_GIGA_VENDOR_ID, USB_SX353_PRODUCT_ID) },
	{ } /* Terminating entry */
};

MODULE_DEVICE_TABLE(usb, gigaset_table);

65
/*======================= local function prototypes ==========================*/
66

67
/* function called if a new device belonging to this driver is connected */
68 69 70 71 72 73
static int gigaset_probe(struct usb_interface *interface,
			 const struct usb_device_id *id);

/* Function will be called if the device is unplugged */
static void gigaset_disconnect(struct usb_interface *interface);

Tilman Schmidt's avatar
Tilman Schmidt committed
74 75 76 77 78 79 80 81
/* functions called before/after suspend */
static int gigaset_suspend(struct usb_interface *intf, pm_message_t message);
static int gigaset_resume(struct usb_interface *intf);

/* functions called before/after device reset */
static int gigaset_pre_reset(struct usb_interface *intf);
static int gigaset_post_reset(struct usb_interface *intf);

82
static int atread_submit(struct cardstate *, int);
83
static void stopurbs(struct bas_bc_state *);
84
static int req_submit(struct bc_state *, int, int, int);
85 86
static int atwrite_submit(struct cardstate *, unsigned char *, int);
static int start_cbsend(struct cardstate *);
87

88
/*============================================================================*/
89 90

struct bas_cardstate {
91 92
	struct usb_device	*udev;		/* USB device pointer */
	struct usb_interface	*interface;	/* interface for this device */
93 94
	unsigned char		minor;		/* starting minor number */

95
	struct urb		*urb_ctrl;	/* control pipe default URB */
96 97
	struct usb_ctrlrequest	dr_ctrl;
	struct timer_list	timer_ctrl;	/* control request timeout */
98
	int			retry_ctrl;
99 100

	struct timer_list	timer_atrdy;	/* AT command ready timeout */
101
	struct urb		*urb_cmd_out;	/* for sending AT commands */
102 103 104
	struct usb_ctrlrequest	dr_cmd_out;
	int			retry_cmd_out;

105
	struct urb		*urb_cmd_in;	/* for receiving AT replies */
106 107
	struct usb_ctrlrequest	dr_cmd_in;
	struct timer_list	timer_cmd_in;	/* receive request timeout */
108
	unsigned char		*rcvbuf;	/* AT reply receive buffer */
109

110
	struct urb		*urb_int_in;	/* URB for interrupt pipe */
111
	unsigned char		*int_in_buf;
112 113 114
	struct work_struct	int_in_wq;	/* for usb_clear_halt() */
	struct timer_list	timer_int_in;	/* int read retry delay */
	int			retry_int_in;
115 116

	spinlock_t		lock;		/* locks all following */
Tilman Schmidt's avatar
Tilman Schmidt committed
117
	int			basstate;	/* bitmap (BS_*) */
118
	int			pending;	/* uncompleted base request */
Tilman Schmidt's avatar
Tilman Schmidt committed
119
	wait_queue_head_t	waitqueue;
120 121 122 123 124 125
	int			rcvbuf_size;	/* size of AT receive buffer */
						/* 0: no receive in progress */
	int			retry_cmd_in;	/* receive req retry count */
};

/* status of direct USB connection to 307x base (bits in basstate) */
126 127 128 129 130 131 132 133
#define BS_ATOPEN	0x001	/* AT channel open */
#define BS_B1OPEN	0x002	/* B channel 1 open */
#define BS_B2OPEN	0x004	/* B channel 2 open */
#define BS_ATREADY	0x008	/* base ready for AT command */
#define BS_INIT		0x010	/* base has signalled INIT_OK */
#define BS_ATTIMER	0x020	/* waiting for HD_READY_SEND_ATDATA */
#define BS_ATRDPEND	0x040	/* urb_cmd_in in use */
#define BS_ATWRPEND	0x080	/* urb_cmd_out in use */
Tilman Schmidt's avatar
Tilman Schmidt committed
134
#define BS_SUSPEND	0x100	/* USB port suspended */
135
#define BS_RESETTING	0x200	/* waiting for HD_RESET_INTERRUPT_PIPE_ACK */
136 137


138
static struct gigaset_driver *driver;
139 140 141 142 143 144 145

/* usb specific object needed to register this driver with the usb subsystem */
static struct usb_driver gigaset_usb_driver = {
	.name =         GIGASET_MODULENAME,
	.probe =        gigaset_probe,
	.disconnect =   gigaset_disconnect,
	.id_table =     gigaset_table,
Tilman Schmidt's avatar
Tilman Schmidt committed
146 147 148 149 150
	.suspend =	gigaset_suspend,
	.resume =	gigaset_resume,
	.reset_resume =	gigaset_post_reset,
	.pre_reset =	gigaset_pre_reset,
	.post_reset =	gigaset_post_reset,
151
	.disable_hub_initiated_lpm = 1,
152 153
};

154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
/* get message text for usb_submit_urb return code
 */
static char *get_usb_rcmsg(int rc)
{
	static char unkmsg[28];

	switch (rc) {
	case 0:
		return "success";
	case -ENOMEM:
		return "out of memory";
	case -ENODEV:
		return "device not present";
	case -ENOENT:
		return "endpoint not present";
	case -ENXIO:
		return "URB type not supported";
	case -EINVAL:
		return "invalid argument";
	case -EAGAIN:
		return "start frame too early or too much scheduled";
	case -EFBIG:
176
		return "too many isoc frames requested";
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
	case -EPIPE:
		return "endpoint stalled";
	case -EMSGSIZE:
		return "invalid packet size";
	case -ENOSPC:
		return "would overcommit USB bandwidth";
	case -ESHUTDOWN:
		return "device shut down";
	case -EPERM:
		return "reject flag set";
	case -EHOSTUNREACH:
		return "device suspended";
	default:
		snprintf(unkmsg, sizeof(unkmsg), "unknown error %d", rc);
		return unkmsg;
	}
}

195 196 197 198 199 200 201 202 203 204
/* get message text for USB status code
 */
static char *get_usb_statmsg(int status)
{
	static char unkmsg[28];

	switch (status) {
	case 0:
		return "success";
	case -ENOENT:
205
		return "unlinked (sync)";
206
	case -EINPROGRESS:
207
		return "URB still pending";
208
	case -EPROTO:
209
		return "bitstuff error, timeout, or unknown USB error";
210
	case -EILSEQ:
211
		return "CRC mismatch, timeout, or unknown USB error";
212
	case -ETIME:
213
		return "USB response timeout";
214 215 216 217 218 219 220
	case -EPIPE:
		return "endpoint stalled";
	case -ECOMM:
		return "IN buffer overrun";
	case -ENOSR:
		return "OUT buffer underrun";
	case -EOVERFLOW:
221
		return "endpoint babble";
222
	case -EREMOTEIO:
223
		return "short packet";
224 225
	case -ENODEV:
		return "device removed";
226
	case -EXDEV:
227
		return "partial isoc transfer";
228
	case -EINVAL:
229
		return "ISO madness";
230 231
	case -ECONNRESET:
		return "unlinked (async)";
232
	case -ESHUTDOWN:
233
		return "device shut down";
234
	default:
235
		snprintf(unkmsg, sizeof(unkmsg), "unknown status %d", status);
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
		return unkmsg;
	}
}

/* usb_pipetype_str
 * retrieve string representation of USB pipe type
 */
static inline char *usb_pipetype_str(int pipe)
{
	if (usb_pipeisoc(pipe))
		return "Isoc";
	if (usb_pipeint(pipe))
		return "Int";
	if (usb_pipecontrol(pipe))
		return "Ctrl";
	if (usb_pipebulk(pipe))
		return "Bulk";
	return "?";
}

/* dump_urb
 * write content of URB to syslog for debugging
 */
static inline void dump_urb(enum debuglevel level, const char *tag,
260
			    struct urb *urb)
261 262 263
{
#ifdef CONFIG_GIGASET_DEBUG
	int i;
264
	gig_dbg(level, "%s urb(0x%08lx)->{", tag, (unsigned long) urb);
265
	if (urb) {
266 267
		gig_dbg(level,
			"  dev=0x%08lx, pipe=%s:EP%d/DV%d:%s, "
268
			"hcpriv=0x%08lx, transfer_flags=0x%x,",
269 270 271 272
			(unsigned long) urb->dev,
			usb_pipetype_str(urb->pipe),
			usb_pipeendpoint(urb->pipe), usb_pipedevice(urb->pipe),
			usb_pipein(urb->pipe) ? "in" : "out",
273
			(unsigned long) urb->hcpriv,
274 275 276
			urb->transfer_flags);
		gig_dbg(level,
			"  transfer_buffer=0x%08lx[%d], actual_length=%d, "
277
			"setup_packet=0x%08lx,",
278 279
			(unsigned long) urb->transfer_buffer,
			urb->transfer_buffer_length, urb->actual_length,
280
			(unsigned long) urb->setup_packet);
281 282 283 284 285 286 287 288 289 290
		gig_dbg(level,
			"  start_frame=%d, number_of_packets=%d, interval=%d, "
			"error_count=%d,",
			urb->start_frame, urb->number_of_packets, urb->interval,
			urb->error_count);
		gig_dbg(level,
			"  context=0x%08lx, complete=0x%08lx, "
			"iso_frame_desc[]={",
			(unsigned long) urb->context,
			(unsigned long) urb->complete);
291
		for (i = 0; i < urb->number_of_packets; i++) {
292 293
			struct usb_iso_packet_descriptor *pifd
				= &urb->iso_frame_desc[i];
294 295 296 297 298
			gig_dbg(level,
				"    {offset=%u, length=%u, actual_length=%u, "
				"status=%u}",
				pifd->offset, pifd->length, pifd->actual_length,
				pifd->status);
299 300
		}
	}
301
	gig_dbg(level, "}}");
302 303 304 305 306
#endif
}

/* read/set modem control bits etc. (m10x only) */
static int gigaset_set_modem_ctrl(struct cardstate *cs, unsigned old_state,
307
				  unsigned new_state)
308 309 310 311 312 313 314 315 316 317 318 319 320 321
{
	return -EINVAL;
}

static int gigaset_baud_rate(struct cardstate *cs, unsigned cflag)
{
	return -EINVAL;
}

static int gigaset_set_line_ctrl(struct cardstate *cs, unsigned cflag)
{
	return -EINVAL;
}

322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
/* set/clear bits in base connection state, return previous state
 */
static inline int update_basstate(struct bas_cardstate *ucs,
				  int set, int clear)
{
	unsigned long flags;
	int state;

	spin_lock_irqsave(&ucs->lock, flags);
	state = ucs->basstate;
	ucs->basstate = (state & ~clear) | set;
	spin_unlock_irqrestore(&ucs->lock, flags);
	return state;
}

337 338 339 340
/* error_hangup
 * hang up any existing connection because of an unrecoverable error
 * This function may be called from any context and takes care of scheduling
 * the necessary actions for execution outside of interrupt context.
341
 * cs->lock must not be held.
342 343 344 345 346 347 348
 * argument:
 *	B channel control structure
 */
static inline void error_hangup(struct bc_state *bcs)
{
	struct cardstate *cs = bcs->cs;

349
	gigaset_add_event(cs, &bcs->at_state, EV_HUP, NULL, 0, NULL);
350 351 352 353 354
	gigaset_schedule_event(cs);
}

/* error_reset
 * reset Gigaset device because of an unrecoverable error
355
 * This function may be called from any context, and takes care of
356
 * scheduling the necessary actions for execution outside of interrupt context.
357
 * cs->hw.bas->lock must not be held.
358 359 360 361 362
 * argument:
 *	controller state structure
 */
static inline void error_reset(struct cardstate *cs)
{
363 364
	/* reset interrupt pipe to recover (ignore errors) */
	update_basstate(cs->hw.bas, BS_RESETTING, 0);
365 366 367
	if (req_submit(cs->bcs, HD_RESET_INTERRUPT_PIPE, 0, BAS_TIMEOUT))
		/* submission failed, escalate to USB port reset */
		usb_queue_reset_device(cs->hw.bas->interface);
368 369 370 371 372
}

/* check_pending
 * check for completion of pending control request
 * parameter:
373
 *	ucs	hardware specific controller state structure
374 375 376 377 378 379 380 381 382 383
 */
static void check_pending(struct bas_cardstate *ucs)
{
	unsigned long flags;

	spin_lock_irqsave(&ucs->lock, flags);
	switch (ucs->pending) {
	case 0:
		break;
	case HD_OPEN_ATCHANNEL:
Tilman Schmidt's avatar
Tilman Schmidt committed
384
		if (ucs->basstate & BS_ATOPEN)
385 386 387
			ucs->pending = 0;
		break;
	case HD_OPEN_B1CHANNEL:
Tilman Schmidt's avatar
Tilman Schmidt committed
388
		if (ucs->basstate & BS_B1OPEN)
389 390 391
			ucs->pending = 0;
		break;
	case HD_OPEN_B2CHANNEL:
Tilman Schmidt's avatar
Tilman Schmidt committed
392
		if (ucs->basstate & BS_B2OPEN)
393 394 395
			ucs->pending = 0;
		break;
	case HD_CLOSE_ATCHANNEL:
Tilman Schmidt's avatar
Tilman Schmidt committed
396
		if (!(ucs->basstate & BS_ATOPEN))
397 398 399
			ucs->pending = 0;
		break;
	case HD_CLOSE_B1CHANNEL:
Tilman Schmidt's avatar
Tilman Schmidt committed
400
		if (!(ucs->basstate & BS_B1OPEN))
401 402 403
			ucs->pending = 0;
		break;
	case HD_CLOSE_B2CHANNEL:
Tilman Schmidt's avatar
Tilman Schmidt committed
404
		if (!(ucs->basstate & BS_B2OPEN))
405 406 407 408 409
			ucs->pending = 0;
		break;
	case HD_DEVICE_INIT_ACK:		/* no reply expected */
		ucs->pending = 0;
		break;
410 411 412 413
	case HD_RESET_INTERRUPT_PIPE:
		if (!(ucs->basstate & BS_RESETTING))
			ucs->pending = 0;
		break;
414 415 416 417
	/*
	 * HD_READ_ATMESSAGE and HD_WRITE_ATMESSAGE are handled separately
	 * and should never end up here
	 */
418
	default:
419 420 421
		dev_warn(&ucs->interface->dev,
			 "unknown pending request 0x%02x cleared\n",
			 ucs->pending);
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438
		ucs->pending = 0;
	}

	if (!ucs->pending)
		del_timer(&ucs->timer_ctrl);

	spin_unlock_irqrestore(&ucs->lock, flags);
}

/* cmd_in_timeout
 * timeout routine for command input request
 * argument:
 *	controller state structure
 */
static void cmd_in_timeout(unsigned long data)
{
	struct cardstate *cs = (struct cardstate *) data;
439
	struct bas_cardstate *ucs = cs->hw.bas;
440
	int rc;
441 442

	if (!ucs->rcvbuf_size) {
443
		gig_dbg(DEBUG_USBREQ, "%s: no receive in progress", __func__);
444 445 446
		return;
	}

447
	if (ucs->retry_cmd_in++ >= BAS_RETRY) {
448 449 450
		dev_err(cs->dev,
			"control read: timeout, giving up after %d tries\n",
			ucs->retry_cmd_in);
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466
		kfree(ucs->rcvbuf);
		ucs->rcvbuf = NULL;
		ucs->rcvbuf_size = 0;
		error_reset(cs);
		return;
	}

	gig_dbg(DEBUG_USBREQ, "%s: timeout, retry %d",
		__func__, ucs->retry_cmd_in);
	rc = atread_submit(cs, BAS_TIMEOUT);
	if (rc < 0) {
		kfree(ucs->rcvbuf);
		ucs->rcvbuf = NULL;
		ucs->rcvbuf_size = 0;
		if (rc != -ENODEV)
			error_reset(cs);
467
	}
468 469
}

470 471 472 473 474 475 476
/* read_ctrl_callback
 * USB completion handler for control pipe input
 * called by the USB subsystem in interrupt context
 * parameter:
 *	urb	USB request block
 *		urb->context = inbuf structure for controller state
 */
477
static void read_ctrl_callback(struct urb *urb)
478 479 480 481
{
	struct inbuf_t *inbuf = urb->context;
	struct cardstate *cs = inbuf->cs;
	struct bas_cardstate *ucs = cs->hw.bas;
482
	int status = urb->status;
483 484 485 486
	unsigned numbytes;
	int rc;

	update_basstate(ucs, 0, BS_ATRDPEND);
Tilman Schmidt's avatar
Tilman Schmidt committed
487
	wake_up(&ucs->waitqueue);
488 489
	del_timer(&ucs->timer_cmd_in);

490
	switch (status) {
491 492 493 494
	case 0:				/* normal completion */
		numbytes = urb->actual_length;
		if (unlikely(numbytes != ucs->rcvbuf_size)) {
			dev_warn(cs->dev,
495
				 "control read: received %d chars, expected %d\n",
496 497 498 499 500
				 numbytes, ucs->rcvbuf_size);
			if (numbytes > ucs->rcvbuf_size)
				numbytes = ucs->rcvbuf_size;
		}

501 502 503 504
		/* copy received bytes to inbuf, notify event layer */
		if (gigaset_fill_inbuf(inbuf, ucs->rcvbuf, numbytes)) {
			gig_dbg(DEBUG_INTR, "%s-->BH", __func__);
			gigaset_schedule_event(cs);
505 506 507 508 509 510 511 512
		}
		break;

	case -ENOENT:			/* cancelled */
	case -ECONNRESET:		/* cancelled (async) */
	case -EINPROGRESS:		/* pending */
	case -ENODEV:			/* device removed */
	case -ESHUTDOWN:		/* device shut down */
513
		/* no further action necessary */
514
		gig_dbg(DEBUG_USBREQ, "%s: %s",
515
			__func__, get_usb_statmsg(status));
516 517
		break;

518
	default:			/* other errors: retry */
519
		if (ucs->retry_cmd_in++ < BAS_RETRY) {
520 521
			gig_dbg(DEBUG_USBREQ, "%s: %s, retry %d", __func__,
				get_usb_statmsg(status), ucs->retry_cmd_in);
522
			rc = atread_submit(cs, BAS_TIMEOUT);
523 524
			if (rc >= 0)
				/* successfully resubmitted, skip freeing */
525
				return;
526 527 528
			if (rc == -ENODEV)
				/* disconnect, no further action necessary */
				break;
529
		}
530 531
		dev_err(cs->dev, "control read: %s, giving up after %d tries\n",
			get_usb_statmsg(status), ucs->retry_cmd_in);
532 533 534
		error_reset(cs);
	}

535
	/* read finished, free buffer */
536 537 538 539 540
	kfree(ucs->rcvbuf);
	ucs->rcvbuf = NULL;
	ucs->rcvbuf_size = 0;
}

541
/* atread_submit
542
 * submit an HD_READ_ATMESSAGE command URB and optionally start a timeout
543 544 545 546 547 548 549 550 551 552
 * parameters:
 *	cs	controller state structure
 *	timeout	timeout in 1/10 sec., 0: none
 * return value:
 *	0 on success
 *	-EBUSY if another request is pending
 *	any URB submission error code
 */
static int atread_submit(struct cardstate *cs, int timeout)
{
553
	struct bas_cardstate *ucs = cs->hw.bas;
Tilman Schmidt's avatar
Tilman Schmidt committed
554
	int basstate;
555 556
	int ret;

557 558
	gig_dbg(DEBUG_USBREQ, "-------> HD_READ_ATMESSAGE (%d)",
		ucs->rcvbuf_size);
559

Tilman Schmidt's avatar
Tilman Schmidt committed
560 561
	basstate = update_basstate(ucs, BS_ATRDPEND, 0);
	if (basstate & BS_ATRDPEND) {
562 563
		dev_err(cs->dev,
			"could not submit HD_READ_ATMESSAGE: URB busy\n");
564 565 566
		return -EBUSY;
	}

Tilman Schmidt's avatar
Tilman Schmidt committed
567 568 569 570 571 572 573 574 575
	if (basstate & BS_SUSPEND) {
		dev_notice(cs->dev,
			   "HD_READ_ATMESSAGE not submitted, "
			   "suspend in progress\n");
		update_basstate(ucs, 0, BS_ATRDPEND);
		/* treat like disconnect */
		return -ENODEV;
	}

576 577 578 579 580 581
	ucs->dr_cmd_in.bRequestType = IN_VENDOR_REQ;
	ucs->dr_cmd_in.bRequest = HD_READ_ATMESSAGE;
	ucs->dr_cmd_in.wValue = 0;
	ucs->dr_cmd_in.wIndex = 0;
	ucs->dr_cmd_in.wLength = cpu_to_le16(ucs->rcvbuf_size);
	usb_fill_control_urb(ucs->urb_cmd_in, ucs->udev,
582
			     usb_rcvctrlpipe(ucs->udev, 0),
583
			     (unsigned char *) &ucs->dr_cmd_in,
584 585
			     ucs->rcvbuf, ucs->rcvbuf_size,
			     read_ctrl_callback, cs->inbuf);
586

587 588
	ret = usb_submit_urb(ucs->urb_cmd_in, GFP_ATOMIC);
	if (ret != 0) {
589
		update_basstate(ucs, 0, BS_ATRDPEND);
590
		dev_err(cs->dev, "could not submit HD_READ_ATMESSAGE: %s\n",
591
			get_usb_rcmsg(ret));
592 593 594 595
		return ret;
	}

	if (timeout > 0) {
596
		gig_dbg(DEBUG_USBREQ, "setting timeout of %d/10 secs", timeout);
597
		mod_timer(&ucs->timer_cmd_in, jiffies + timeout * HZ / 10);
598 599 600 601
	}
	return 0;
}

602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619
/* int_in_work
 * workqueue routine to clear halt on interrupt in endpoint
 */

static void int_in_work(struct work_struct *work)
{
	struct bas_cardstate *ucs =
		container_of(work, struct bas_cardstate, int_in_wq);
	struct urb *urb = ucs->urb_int_in;
	struct cardstate *cs = urb->context;
	int rc;

	/* clear halt condition */
	rc = usb_clear_halt(ucs->udev, urb->pipe);
	gig_dbg(DEBUG_USBREQ, "clear_halt: %s", get_usb_rcmsg(rc));
	if (rc == 0)
		/* success, resubmit interrupt read URB */
		rc = usb_submit_urb(urb, GFP_ATOMIC);
620 621 622 623 624 625 626

	switch (rc) {
	case 0:		/* success */
	case -ENODEV:	/* device gone */
	case -EINVAL:	/* URB already resubmitted, or terminal badness */
		break;
	default:	/* failure: try to recover by resetting the device */
627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663
		dev_err(cs->dev, "clear halt failed: %s\n", get_usb_rcmsg(rc));
		rc = usb_lock_device_for_reset(ucs->udev, ucs->interface);
		if (rc == 0) {
			rc = usb_reset_device(ucs->udev);
			usb_unlock_device(ucs->udev);
		}
	}
	ucs->retry_int_in = 0;
}

/* int_in_resubmit
 * timer routine for interrupt read delayed resubmit
 * argument:
 *	controller state structure
 */
static void int_in_resubmit(unsigned long data)
{
	struct cardstate *cs = (struct cardstate *) data;
	struct bas_cardstate *ucs = cs->hw.bas;
	int rc;

	if (ucs->retry_int_in++ >= BAS_RETRY) {
		dev_err(cs->dev, "interrupt read: giving up after %d tries\n",
			ucs->retry_int_in);
		usb_queue_reset_device(ucs->interface);
		return;
	}

	gig_dbg(DEBUG_USBREQ, "%s: retry %d", __func__, ucs->retry_int_in);
	rc = usb_submit_urb(ucs->urb_int_in, GFP_ATOMIC);
	if (rc != 0 && rc != -ENODEV) {
		dev_err(cs->dev, "could not resubmit interrupt URB: %s\n",
			get_usb_rcmsg(rc));
		usb_queue_reset_device(ucs->interface);
	}
}

664 665 666 667 668 669 670
/* read_int_callback
 * USB completion handler for interrupt pipe input
 * called by the USB subsystem in interrupt context
 * parameter:
 *	urb	USB request block
 *		urb->context = controller state structure
 */
671
static void read_int_callback(struct urb *urb)
672
{
673 674
	struct cardstate *cs = urb->context;
	struct bas_cardstate *ucs = cs->hw.bas;
675
	struct bc_state *bcs;
676
	int status = urb->status;
677
	unsigned long flags;
678
	int rc;
679 680 681
	unsigned l;
	int channel;

682
	switch (status) {
683
	case 0:			/* success */
684
		ucs->retry_int_in = 0;
685
		break;
686 687 688
	case -EPIPE:			/* endpoint stalled */
		schedule_work(&ucs->int_in_wq);
		/* fall through */
689 690
	case -ENOENT:			/* cancelled */
	case -ECONNRESET:		/* cancelled (async) */
691
	case -EINPROGRESS:		/* pending */
692 693 694
	case -ENODEV:			/* device removed */
	case -ESHUTDOWN:		/* device shut down */
		/* no further action necessary */
695
		gig_dbg(DEBUG_USBREQ, "%s: %s",
696
			__func__, get_usb_statmsg(status));
697
		return;
698 699 700 701 702 703 704
	case -EPROTO:			/* protocol error or unplug */
	case -EILSEQ:
	case -ETIME:
		/* resubmit after delay */
		gig_dbg(DEBUG_USBREQ, "%s: %s",
			__func__, get_usb_statmsg(status));
		mod_timer(&ucs->timer_int_in, jiffies + HZ / 10);
705
		return;
706
	default:		/* other errors: just resubmit */
707
		dev_warn(cs->dev, "interrupt read: %s\n",
708
			 get_usb_statmsg(status));
709 710 711
		goto resubmit;
	}

712
	/* drop incomplete packets even if the missing bytes wouldn't matter */
713
	if (unlikely(urb->actual_length < IP_MSGSIZE)) {
714 715 716 717 718
		dev_warn(cs->dev, "incomplete interrupt packet (%d bytes)\n",
			 urb->actual_length);
		goto resubmit;
	}

719
	l = (unsigned) ucs->int_in_buf[1] +
720
		(((unsigned) ucs->int_in_buf[2]) << 8);
721

722 723 724
	gig_dbg(DEBUG_USBREQ, "<-------%d: 0x%02x (%u [0x%02x 0x%02x])",
		urb->actual_length, (int)ucs->int_in_buf[0], l,
		(int)ucs->int_in_buf[1], (int)ucs->int_in_buf[2]);
725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769

	channel = 0;

	switch (ucs->int_in_buf[0]) {
	case HD_DEVICE_INIT_OK:
		update_basstate(ucs, BS_INIT, 0);
		break;

	case HD_READY_SEND_ATDATA:
		del_timer(&ucs->timer_atrdy);
		update_basstate(ucs, BS_ATREADY, BS_ATTIMER);
		start_cbsend(cs);
		break;

	case HD_OPEN_B2CHANNEL_ACK:
		++channel;
	case HD_OPEN_B1CHANNEL_ACK:
		bcs = cs->bcs + channel;
		update_basstate(ucs, BS_B1OPEN << channel, 0);
		gigaset_bchannel_up(bcs);
		break;

	case HD_OPEN_ATCHANNEL_ACK:
		update_basstate(ucs, BS_ATOPEN, 0);
		start_cbsend(cs);
		break;

	case HD_CLOSE_B2CHANNEL_ACK:
		++channel;
	case HD_CLOSE_B1CHANNEL_ACK:
		bcs = cs->bcs + channel;
		update_basstate(ucs, 0, BS_B1OPEN << channel);
		stopurbs(bcs->hw.bas);
		gigaset_bchannel_down(bcs);
		break;

	case HD_CLOSE_ATCHANNEL_ACK:
		update_basstate(ucs, 0, BS_ATOPEN);
		break;

	case HD_B2_FLOW_CONTROL:
		++channel;
	case HD_B1_FLOW_CONTROL:
		bcs = cs->bcs + channel;
		atomic_add((l - BAS_NORMFRAME) * BAS_CORRFRAMES,
770 771 772 773 774
			   &bcs->hw.bas->corrbytes);
		gig_dbg(DEBUG_ISO,
			"Flow control (channel %d, sub %d): 0x%02x => %d",
			channel, bcs->hw.bas->numsub, l,
			atomic_read(&bcs->hw.bas->corrbytes));
775 776 777 778
		break;

	case HD_RECEIVEATDATA_ACK:	/* AT response ready to be received */
		if (!l) {
779
			dev_warn(cs->dev,
780
				 "HD_RECEIVEATDATA_ACK with length 0 ignored\n");
781 782 783
			break;
		}
		spin_lock_irqsave(&cs->lock, flags);
784 785 786
		if (ucs->basstate & BS_ATRDPEND) {
			spin_unlock_irqrestore(&cs->lock, flags);
			dev_warn(cs->dev,
787
				 "HD_RECEIVEATDATA_ACK(%d) during HD_READ_ATMESSAGE(%d) ignored\n",
788 789 790
				 l, ucs->rcvbuf_size);
			break;
		}
791
		if (ucs->rcvbuf_size) {
792
			/* throw away previous buffer - we have no queue */
793
			dev_err(cs->dev,
794 795 796 797
				"receive AT data overrun, %d bytes lost\n",
				ucs->rcvbuf_size);
			kfree(ucs->rcvbuf);
			ucs->rcvbuf_size = 0;
798
		}
799 800
		ucs->rcvbuf = kmalloc(l, GFP_ATOMIC);
		if (ucs->rcvbuf == NULL) {
801
			spin_unlock_irqrestore(&cs->lock, flags);
802
			dev_err(cs->dev, "out of memory receiving AT data\n");
803 804 805 806
			break;
		}
		ucs->rcvbuf_size = l;
		ucs->retry_cmd_in = 0;
807 808
		rc = atread_submit(cs, BAS_TIMEOUT);
		if (rc < 0) {
809 810 811 812 813
			kfree(ucs->rcvbuf);
			ucs->rcvbuf = NULL;
			ucs->rcvbuf_size = 0;
		}
		spin_unlock_irqrestore(&cs->lock, flags);
814 815
		if (rc < 0 && rc != -ENODEV)
			error_reset(cs);
816 817 818
		break;

	case HD_RESET_INTERRUPT_PIPE_ACK:
819 820
		update_basstate(ucs, 0, BS_RESETTING);
		dev_notice(cs->dev, "interrupt pipe reset\n");
821 822 823
		break;

	case HD_SUSPEND_END:
824
		gig_dbg(DEBUG_USBREQ, "HD_SUSPEND_END");
825 826 827
		break;

	default:
828 829 830
		dev_warn(cs->dev,
			 "unknown Gigaset signal 0x%02x (%u) ignored\n",
			 (int) ucs->int_in_buf[0], l);
831 832 833
	}

	check_pending(ucs);
Tilman Schmidt's avatar
Tilman Schmidt committed
834
	wake_up(&ucs->waitqueue);
835 836

resubmit:
837
	rc = usb_submit_urb(urb, GFP_ATOMIC);
838
	if (unlikely(rc != 0 && rc != -ENODEV)) {
839
		dev_err(cs->dev, "could not resubmit interrupt URB: %s\n",
840
			get_usb_rcmsg(rc));
841 842 843 844 845 846 847 848 849 850 851
		error_reset(cs);
	}
}

/* read_iso_callback
 * USB completion handler for B channel isochronous input
 * called by the USB subsystem in interrupt context
 * parameter:
 *	urb	USB request block of completed request
 *		urb->context = bc_state structure
 */
852
static void read_iso_callback(struct urb *urb)
853 854 855
{
	struct bc_state *bcs;
	struct bas_bc_state *ubc;
856
	int status = urb->status;
857 858 859 860
	unsigned long flags;
	int i, rc;

	/* status codes not worth bothering the tasklet with */
861 862 863 864 865
	if (unlikely(status == -ENOENT ||
		     status == -ECONNRESET ||
		     status == -EINPROGRESS ||
		     status == -ENODEV ||
		     status == -ESHUTDOWN)) {
866
		gig_dbg(DEBUG_ISO, "%s: %s",
867
			__func__, get_usb_statmsg(status));
868 869 870
		return;
	}

871
	bcs = urb->context;
872 873 874 875 876 877
	ubc = bcs->hw.bas;

	spin_lock_irqsave(&ubc->isoinlock, flags);
	if (likely(ubc->isoindone == NULL)) {
		/* pass URB to tasklet */
		ubc->isoindone = urb;
878
		ubc->isoinstatus = status;
879
		tasklet_hi_schedule(&ubc->rcvd_tasklet);
880 881
	} else {
		/* tasklet still busy, drop data and resubmit URB */
882
		gig_dbg(DEBUG_ISO, "%s: overrun", __func__);
883
		ubc->loststatus = status;
884 885 886
		for (i = 0; i < BAS_NUMFRAMES; i++) {
			ubc->isoinlost += urb->iso_frame_desc[i].actual_length;
			if (unlikely(urb->iso_frame_desc[i].status != 0 &&
887
				     urb->iso_frame_desc[i].status != -EINPROGRESS))
888 889 890 891
				ubc->loststatus = urb->iso_frame_desc[i].status;
			urb->iso_frame_desc[i].status = 0;
			urb->iso_frame_desc[i].actual_length = 0;
		}
Tilman Schmidt's avatar
Tilman Schmidt committed
892
		if (likely(ubc->running)) {
893 894
			/* urb->dev is clobbered by USB subsystem */
			urb->dev = bcs->cs->hw.bas->udev;
895 896
			urb->transfer_flags = URB_ISO_ASAP;
			urb->number_of_packets = BAS_NUMFRAMES;
897
			rc = usb_submit_urb(urb, GFP_ATOMIC);
898
			if (unlikely(rc != 0 && rc != -ENODEV)) {
899
				dev_err(bcs->cs->dev,
900
					"could not resubmit isoc read URB: %s\n",
901
					get_usb_rcmsg(rc));
902 903 904 905 906 907 908 909 910 911 912 913 914 915 916
				dump_urb(DEBUG_ISO, "isoc read", urb);
				error_hangup(bcs);
			}
		}
	}
	spin_unlock_irqrestore(&ubc->isoinlock, flags);
}

/* write_iso_callback
 * USB completion handler for B channel isochronous output
 * called by the USB subsystem in interrupt context
 * parameter:
 *	urb	USB request block of completed request
 *		urb->context = isow_urbctx_t structure
 */
917
static void write_iso_callback(struct urb *urb)
918 919 920
{
	struct isow_urbctx_t *ucx;
	struct bas_bc_state *ubc;
921
	int status = urb->status;
922 923 924
	unsigned long flags;

	/* status codes not worth bothering the tasklet with */
925 926 927 928 929
	if (unlikely(status == -ENOENT ||
		     status == -ECONNRESET ||
		     status == -EINPROGRESS ||
		     status == -ENODEV ||
		     status == -ESHUTDOWN)) {
930
		gig_dbg(DEBUG_ISO, "%s: %s",
931
			__func__, get_usb_statmsg(status));
932 933 934 935
		return;
	}

	/* pass URB context to tasklet */
936
	ucx = urb->context;
937
	ubc = ucx->bcs->hw.bas;
938
	ucx->status = status;
939 940 941 942 943

	spin_lock_irqsave(&ubc->isooutlock, flags);
	ubc->isooutovfl = ubc->isooutdone;
	ubc->isooutdone = ucx;
	spin_unlock_irqrestore(&ubc->isooutlock, flags);
944
	tasklet_hi_schedule(&ubc->sent_tasklet);
945 946 947 948 949 950 951 952 953 954 955 956
}

/* starturbs
 * prepare and submit USB request blocks for isochronous input and output
 * argument:
 *	B channel control structure
 * return value:
 *	0 on success
 *	< 0 on error (no URBs submitted)
 */
static int starturbs(struct bc_state *bcs)
{
957
	struct bas_bc_state *ubc = bcs->hw.bas;
958 959 960 961 962
	struct urb *urb;
	int j, k;
	int rc;

	/* initialize L2 reception */
963
	if (bcs->proto2 == L2_HDLC)
964 965 966
		bcs->inputstate |= INS_flag_hunt;

	/* submit all isochronous input URBs */
Tilman Schmidt's avatar
Tilman Schmidt committed
967
	ubc->running = 1;
968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991
	for (k = 0; k < BAS_INURBS; k++) {
		urb = ubc->isoinurbs[k];
		if (!urb) {
			rc = -EFAULT;
			goto error;
		}

		urb->dev = bcs->cs->hw.bas->udev;
		urb->pipe = usb_rcvisocpipe(urb->dev, 3 + 2 * bcs->channel);
		urb->transfer_flags = URB_ISO_ASAP;
		urb->transfer_buffer = ubc->isoinbuf + k * BAS_INBUFSIZE;
		urb->transfer_buffer_length = BAS_INBUFSIZE;
		urb->number_of_packets = BAS_NUMFRAMES;
		urb->interval = BAS_FRAMETIME;
		urb->complete = read_iso_callback;
		urb->context = bcs;
		for (j = 0; j < BAS_NUMFRAMES; j++) {
			urb->iso_frame_desc[j].offset = j * BAS_MAXFRAME;
			urb->iso_frame_desc[j].length = BAS_MAXFRAME;
			urb->iso_frame_desc[j].status = 0;
			urb->iso_frame_desc[j].actual_length = 0;
		}

		dump_urb(DEBUG_ISO, "Initial isoc read", urb);
992 993
		rc = usb_submit_urb(urb, GFP_ATOMIC);
		if (rc != 0)
994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024
			goto error;
	}

	/* initialize L2 transmission */
	gigaset_isowbuf_init(ubc->isooutbuf, PPP_FLAG);

	/* set up isochronous output URBs for flag idling */
	for (k = 0; k < BAS_OUTURBS; ++k) {
		urb = ubc->isoouturbs[k].urb;
		if (!urb) {
			rc = -EFAULT;
			goto error;
		}
		urb->dev = bcs->cs->hw.bas->udev;
		urb->pipe = usb_sndisocpipe(urb->dev, 4 + 2 * bcs->channel);
		urb->transfer_flags = URB_ISO_ASAP;
		urb->transfer_buffer = ubc->isooutbuf->data;
		urb->transfer_buffer_length = sizeof(ubc->isooutbuf->data);
		urb->number_of_packets = BAS_NUMFRAMES;
		urb->interval = BAS_FRAMETIME;
		urb->complete = write_iso_callback;
		urb->context = &ubc->isoouturbs[k];
		for (j = 0; j < BAS_NUMFRAMES; ++j) {
			urb->iso_frame_desc[j].offset = BAS_OUTBUFSIZE;
			urb->iso_frame_desc[j].length = BAS_NORMFRAME;
			urb->iso_frame_desc[j].status = 0;
			urb->iso_frame_desc[j].actual_length = 0;
		}
		ubc->isoouturbs[k].limit = -1;
	}

Tilman Schmidt's avatar
Tilman Schmidt committed
1025
	/* keep one URB free, submit the others */
1026
	for (k = 0; k < BAS_OUTURBS - 1; ++k) {
1027
		dump_urb(DEBUG_ISO, "Initial isoc write", urb);
1028
		rc = usb_submit_urb(ubc->isoouturbs[k].urb, GFP_ATOMIC);
1029
		if (rc != 0)
1030 1031 1032
			goto error;
	}
	dump_urb(DEBUG_ISO, "Initial isoc write (free)", urb);
1033
	ubc->isooutfree = &ubc->isoouturbs[BAS_OUTURBS - 1];
1034 1035
	ubc->isooutdone = ubc->isooutovfl = NULL;
	return 0;
1036
error:
1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050
	stopurbs(ubc);
	return rc;
}

/* stopurbs
 * cancel the USB request blocks for isochronous input and output
 * errors are silently ignored
 * argument:
 *	B channel control structure
 */
static void stopurbs(struct bas_bc_state *ubc)
{
	int k, rc;

Tilman Schmidt's avatar
Tilman Schmidt committed
1051
	ubc->running = 0;
1052 1053 1054

	for (k = 0; k < BAS_INURBS; ++k) {
		rc = usb_unlink_urb(ubc->isoinurbs[k]);
1055
		gig_dbg(DEBUG_ISO,
1056 1057
			"%s: isoc input URB %d unlinked, result = %s",
			__func__, k, get_usb_rcmsg(rc));
1058 1059 1060 1061
	}

	for (k = 0; k < BAS_OUTURBS; ++k) {
		rc = usb_unlink_urb(ubc->isoouturbs[k].urb);
1062
		gig_dbg(DEBUG_ISO,
1063 1064
			"%s: isoc output URB %d unlinked, result = %s",
			__func__, k, get_usb_rcmsg(rc));
1065 1066 1067 1068 1069 1070 1071 1072 1073
	}
}

/* Isochronous Write - Bottom Half */
/* =============================== */

/* submit_iso_write_urb
 * fill and submit the next isochronous write URB
 * parameters:
1074
 *	ucx	context structure containing URB
1075 1076 1077 1078 1079 1080 1081
 * return value:
 *	number of frames submitted in URB
 *	0 if URB not submitted because no data available (isooutbuf busy)
 *	error code < 0 on error
 */
static int submit_iso_write_urb(struct isow_urbctx_t *ucx)
{
1082 1083
	struct urb *urb = ucx->urb;
	struct bas_bc_state *ubc = ucx->bcs->hw.bas;
1084 1085