bas-gigaset.c 68.4 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 22 23 24 25 26
 *
 * =====================================================================
 *	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/errno.h>
#include <linux/init.h>
#include <linux/slab.h>
#include <linux/timer.h>
#include <linux/usb.h>
#include <linux/module.h>
#include <linux/moduleparam.h>

/* Version Information */
27
#define DRIVER_AUTHOR "Tilman Schmidt <tilman@imap.cc>, Hansjoerg Lipp <hjlipp@web.de>, Stefan Eilers"
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
#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"

46 47
/* length limit according to Siemens 3070usb-protokoll.doc ch. 2.1 */
#define IF_WRITEBUF 264
48 49 50

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

/* table of devices that work with this driver */
57
static const struct usb_device_id gigaset_table [] = {
58 59
	{ USB_DEVICE(USB_GIGA_VENDOR_ID, USB_3070_PRODUCT_ID) },
	{ USB_DEVICE(USB_GIGA_VENDOR_ID, USB_3075_PRODUCT_ID) },
60 61 62 63 64 65 66
	{ 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);

67
/*======================= local function prototypes ==========================*/
68

69
/* function called if a new device belonging to this driver is connected */
70 71 72 73 74 75
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
76 77 78 79 80 81 82 83
/* 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);

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

90
/*============================================================================*/
91 92

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

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

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

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

112
	struct urb		*urb_int_in;	/* URB for interrupt pipe */
113 114 115
	unsigned char		int_in_buf[3];

	spinlock_t		lock;		/* locks all following */
Tilman Schmidt's avatar
Tilman Schmidt committed
116
	int			basstate;	/* bitmap (BS_*) */
117
	int			pending;	/* uncompleted base request */
Tilman Schmidt's avatar
Tilman Schmidt committed
118
	wait_queue_head_t	waitqueue;
119 120 121 122 123 124
	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) */
125 126 127 128 129 130 131 132
#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
133
#define BS_SUSPEND	0x100	/* USB port suspended */
134 135 136 137 138 139 140 141 142 143


static struct gigaset_driver *driver = NULL;

/* 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
144 145 146 147 148
	.suspend =	gigaset_suspend,
	.resume =	gigaset_resume,
	.reset_resume =	gigaset_post_reset,
	.pre_reset =	gigaset_pre_reset,
	.post_reset =	gigaset_post_reset,
149 150
};

151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
/* 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:
		return "too many isochronous frames requested";
	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;
	}
}

192 193 194 195 196 197 198 199 200 201
/* 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:
202
		return "unlinked (sync)";
203 204 205
	case -EINPROGRESS:
		return "pending";
	case -EPROTO:
206
		return "bit stuffing error, timeout, or unknown USB error";
207
	case -EILSEQ:
208
		return "CRC mismatch, timeout, or unknown USB error";
209
	case -ETIME:
210
		return "timed out";
211 212 213 214 215 216 217 218
	case -EPIPE:
		return "endpoint stalled";
	case -ECOMM:
		return "IN buffer overrun";
	case -ENOSR:
		return "OUT buffer underrun";
	case -EOVERFLOW:
		return "too much data";
219 220
	case -EREMOTEIO:
		return "short packet detected";
221 222
	case -ENODEV:
		return "device removed";
223 224 225 226
	case -EXDEV:
		return "partial isochronous transfer";
	case -EINVAL:
		return "invalid argument";
227 228
	case -ECONNRESET:
		return "unlinked (async)";
229
	case -ESHUTDOWN:
230
		return "device shut down";
231
	default:
232
		snprintf(unkmsg, sizeof(unkmsg), "unknown status %d", status);
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
		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,
257
			    struct urb *urb)
258 259 260
{
#ifdef CONFIG_GIGASET_DEBUG
	int i;
261
	gig_dbg(level, "%s urb(0x%08lx)->{", tag, (unsigned long) urb);
262
	if (urb) {
263 264
		gig_dbg(level,
			"  dev=0x%08lx, pipe=%s:EP%d/DV%d:%s, "
265
			"hcpriv=0x%08lx, transfer_flags=0x%x,",
266 267 268 269
			(unsigned long) urb->dev,
			usb_pipetype_str(urb->pipe),
			usb_pipeendpoint(urb->pipe), usb_pipedevice(urb->pipe),
			usb_pipein(urb->pipe) ? "in" : "out",
270
			(unsigned long) urb->hcpriv,
271 272 273
			urb->transfer_flags);
		gig_dbg(level,
			"  transfer_buffer=0x%08lx[%d], actual_length=%d, "
274
			"setup_packet=0x%08lx,",
275 276
			(unsigned long) urb->transfer_buffer,
			urb->transfer_buffer_length, urb->actual_length,
277
			(unsigned long) urb->setup_packet);
278 279 280 281 282 283 284 285 286 287
		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);
288
		for (i = 0; i < urb->number_of_packets; i++) {
289 290
			struct usb_iso_packet_descriptor *pifd
				= &urb->iso_frame_desc[i];
291 292 293 294 295
			gig_dbg(level,
				"    {offset=%u, length=%u, actual_length=%u, "
				"status=%u}",
				pifd->offset, pifd->length, pifd->actual_length,
				pifd->status);
296 297
		}
	}
298
	gig_dbg(level, "}}");
299 300 301 302 303
#endif
}

/* read/set modem control bits etc. (m10x only) */
static int gigaset_set_modem_ctrl(struct cardstate *cs, unsigned old_state,
304
				  unsigned new_state)
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
{
	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;
}

/* 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.
323
 * cs->lock must not be held.
324 325 326 327 328 329 330
 * argument:
 *	B channel control structure
 */
static inline void error_hangup(struct bc_state *bcs)
{
	struct cardstate *cs = bcs->cs;

331 332
	gig_dbg(DEBUG_ANY, "%s: scheduling HUP for channel %d",
		__func__, bcs->channel);
333

334 335
	if (!gigaset_add_event(cs, &bcs->at_state, EV_HUP, NULL, 0, NULL))
		dev_err(cs->dev, "event queue full\n");
336 337 338 339 340 341

	gigaset_schedule_event(cs);
}

/* error_reset
 * reset Gigaset device because of an unrecoverable error
342
 * This function may be called from any context, and takes care of
343
 * scheduling the necessary actions for execution outside of interrupt context.
344
 * cs->lock must not be held.
345 346 347 348 349
 * argument:
 *	controller state structure
 */
static inline void error_reset(struct cardstate *cs)
{
350 351 352
	/* close AT command channel to recover (ignore errors) */
	req_submit(cs->bcs, HD_CLOSE_ATCHANNEL, 0, BAS_TIMEOUT);

353
	//FIXME try to recover without bothering the user
354 355
	dev_err(cs->dev,
	    "unrecoverable error - please disconnect Gigaset base to reset\n");
356 357 358 359 360
}

/* check_pending
 * check for completion of pending control request
 * parameter:
361
 *	ucs	hardware specific controller state structure
362 363 364 365 366 367 368 369 370 371
 */
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
372
		if (ucs->basstate & BS_ATOPEN)
373 374 375
			ucs->pending = 0;
		break;
	case HD_OPEN_B1CHANNEL:
Tilman Schmidt's avatar
Tilman Schmidt committed
376
		if (ucs->basstate & BS_B1OPEN)
377 378 379
			ucs->pending = 0;
		break;
	case HD_OPEN_B2CHANNEL:
Tilman Schmidt's avatar
Tilman Schmidt committed
380
		if (ucs->basstate & BS_B2OPEN)
381 382 383
			ucs->pending = 0;
		break;
	case HD_CLOSE_ATCHANNEL:
Tilman Schmidt's avatar
Tilman Schmidt committed
384
		if (!(ucs->basstate & BS_ATOPEN))
385 386 387
			ucs->pending = 0;
		break;
	case HD_CLOSE_B1CHANNEL:
Tilman Schmidt's avatar
Tilman Schmidt committed
388
		if (!(ucs->basstate & BS_B1OPEN))
389 390 391
			ucs->pending = 0;
		break;
	case HD_CLOSE_B2CHANNEL:
Tilman Schmidt's avatar
Tilman Schmidt committed
392
		if (!(ucs->basstate & BS_B2OPEN))
393 394 395 396 397 398 399 400 401
			ucs->pending = 0;
		break;
	case HD_DEVICE_INIT_ACK:		/* no reply expected */
		ucs->pending = 0;
		break;
	/* HD_READ_ATMESSAGE, HD_WRITE_ATMESSAGE, HD_RESET_INTERRUPTPIPE
	 * are handled separately and should never end up here
	 */
	default:
402 403 404
		dev_warn(&ucs->interface->dev,
			 "unknown pending request 0x%02x cleared\n",
			 ucs->pending);
405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
		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;
422
	struct bas_cardstate *ucs = cs->hw.bas;
423
	int rc;
424 425

	if (!ucs->rcvbuf_size) {
426
		gig_dbg(DEBUG_USBREQ, "%s: no receive in progress", __func__);
427 428 429
		return;
	}

430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446
	if (ucs->retry_cmd_in++ < BAS_RETRY) {
		dev_notice(cs->dev, "control read: timeout, retry %d\n",
			   ucs->retry_cmd_in);
		rc = atread_submit(cs, BAS_TIMEOUT);
		if (rc >= 0 || rc == -ENODEV)
			/* resubmitted or disconnected */
			/* - bypass regular exit block */
			return;
	} else {
		dev_err(cs->dev,
			"control read: timeout, giving up after %d tries\n",
			ucs->retry_cmd_in);
	}
	kfree(ucs->rcvbuf);
	ucs->rcvbuf = NULL;
	ucs->rcvbuf_size = 0;
	error_reset(cs);
447 448
}

449 450 451 452 453 454 455
/* set/clear bits in base connection state, return previous state
 */
inline static int update_basstate(struct bas_cardstate *ucs,
				  int set, int clear)
{
	unsigned long flags;
	int state;
456

457
	spin_lock_irqsave(&ucs->lock, flags);
Tilman Schmidt's avatar
Tilman Schmidt committed
458 459
	state = ucs->basstate;
	ucs->basstate = (state & ~clear) | set;
460 461 462
	spin_unlock_irqrestore(&ucs->lock, flags);
	return state;
}
463

464 465 466 467 468 469 470
/* 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
 */
471
static void read_ctrl_callback(struct urb *urb)
472 473 474 475
{
	struct inbuf_t *inbuf = urb->context;
	struct cardstate *cs = inbuf->cs;
	struct bas_cardstate *ucs = cs->hw.bas;
476
	int status = urb->status;
477 478 479 480 481
	int have_data = 0;
	unsigned numbytes;
	int rc;

	update_basstate(ucs, 0, BS_ATRDPEND);
Tilman Schmidt's avatar
Tilman Schmidt committed
482
	wake_up(&ucs->waitqueue);
483 484 485 486 487 488 489 490

	if (!ucs->rcvbuf_size) {
		dev_warn(cs->dev, "%s: no receive in progress\n", __func__);
		return;
	}

	del_timer(&ucs->timer_cmd_in);

491
	switch (status) {
492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524
	case 0:				/* normal completion */
		numbytes = urb->actual_length;
		if (unlikely(numbytes != ucs->rcvbuf_size)) {
			dev_warn(cs->dev,
			       "control read: received %d chars, expected %d\n",
				 numbytes, ucs->rcvbuf_size);
			if (numbytes > ucs->rcvbuf_size)
				numbytes = ucs->rcvbuf_size;
		}

		/* copy received bytes to inbuf */
		have_data = gigaset_fill_inbuf(inbuf, ucs->rcvbuf, numbytes);

		if (unlikely(numbytes < ucs->rcvbuf_size)) {
			/* incomplete - resubmit for remaining bytes */
			ucs->rcvbuf_size -= numbytes;
			ucs->retry_cmd_in = 0;
			rc = atread_submit(cs, BAS_TIMEOUT);
			if (rc >= 0 || rc == -ENODEV)
				/* resubmitted or disconnected */
				/* - bypass regular exit block */
				return;
			error_reset(cs);
		}
		break;

	case -ENOENT:			/* cancelled */
	case -ECONNRESET:		/* cancelled (async) */
	case -EINPROGRESS:		/* pending */
	case -ENODEV:			/* device removed */
	case -ESHUTDOWN:		/* device shut down */
		/* no action necessary */
		gig_dbg(DEBUG_USBREQ, "%s: %s",
525
			__func__, get_usb_statmsg(status));
526 527 528 529
		break;

	default:			/* severe trouble */
		dev_warn(cs->dev, "control read: %s\n",
530
			 get_usb_statmsg(status));
531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555
		if (ucs->retry_cmd_in++ < BAS_RETRY) {
			dev_notice(cs->dev, "control read: retry %d\n",
				   ucs->retry_cmd_in);
			rc = atread_submit(cs, BAS_TIMEOUT);
			if (rc >= 0 || rc == -ENODEV)
				/* resubmitted or disconnected */
				/* - bypass regular exit block */
				return;
		} else {
			dev_err(cs->dev,
				"control read: giving up after %d tries\n",
				ucs->retry_cmd_in);
		}
		error_reset(cs);
	}

	kfree(ucs->rcvbuf);
	ucs->rcvbuf = NULL;
	ucs->rcvbuf_size = 0;
	if (have_data) {
		gig_dbg(DEBUG_INTR, "%s-->BH", __func__);
		gigaset_schedule_event(cs);
	}
}

556
/* atread_submit
557
 * submit an HD_READ_ATMESSAGE command URB and optionally start a timeout
558 559 560 561 562 563 564 565 566 567
 * 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)
{
568
	struct bas_cardstate *ucs = cs->hw.bas;
Tilman Schmidt's avatar
Tilman Schmidt committed
569
	int basstate;
570 571
	int ret;

572 573
	gig_dbg(DEBUG_USBREQ, "-------> HD_READ_ATMESSAGE (%d)",
		ucs->rcvbuf_size);
574

Tilman Schmidt's avatar
Tilman Schmidt committed
575 576
	basstate = update_basstate(ucs, BS_ATRDPEND, 0);
	if (basstate & BS_ATRDPEND) {
577 578
		dev_err(cs->dev,
			"could not submit HD_READ_ATMESSAGE: URB busy\n");
579 580 581
		return -EBUSY;
	}

Tilman Schmidt's avatar
Tilman Schmidt committed
582 583 584 585 586 587 588 589 590
	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;
	}

591 592 593 594 595 596
	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,
597 598 599 600
			     usb_rcvctrlpipe(ucs->udev, 0),
			     (unsigned char*) & ucs->dr_cmd_in,
			     ucs->rcvbuf, ucs->rcvbuf_size,
			     read_ctrl_callback, cs->inbuf);
601

602
	if ((ret = usb_submit_urb(ucs->urb_cmd_in, GFP_ATOMIC)) != 0) {
603
		update_basstate(ucs, 0, BS_ATRDPEND);
604
		dev_err(cs->dev, "could not submit HD_READ_ATMESSAGE: %s\n",
605
			get_usb_rcmsg(ret));
606 607 608 609
		return ret;
	}

	if (timeout > 0) {
610
		gig_dbg(DEBUG_USBREQ, "setting timeout of %d/10 secs", timeout);
611 612 613 614 615 616 617 618 619 620 621 622 623 624 625
		ucs->timer_cmd_in.expires = jiffies + timeout * HZ / 10;
		ucs->timer_cmd_in.data = (unsigned long) cs;
		ucs->timer_cmd_in.function = cmd_in_timeout;
		add_timer(&ucs->timer_cmd_in);
	}
	return 0;
}

/* 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
 */
626
static void read_int_callback(struct urb *urb)
627
{
628 629
	struct cardstate *cs = urb->context;
	struct bas_cardstate *ucs = cs->hw.bas;
630
	struct bc_state *bcs;
631
	int status = urb->status;
632
	unsigned long flags;
633
	int rc;
634 635 636
	unsigned l;
	int channel;

637
	switch (status) {
638 639
	case 0:			/* success */
		break;
640 641
	case -ENOENT:			/* cancelled */
	case -ECONNRESET:		/* cancelled (async) */
642 643
	case -EINPROGRESS:		/* pending */
		/* ignore silently */
644
		gig_dbg(DEBUG_USBREQ, "%s: %s",
645
			__func__, get_usb_statmsg(status));
646
		return;
647 648 649 650 651
	case -ENODEV:			/* device removed */
	case -ESHUTDOWN:		/* device shut down */
		//FIXME use this as disconnect indicator?
		gig_dbg(DEBUG_USBREQ, "%s: device disconnected", __func__);
		return;
652
	default:		/* severe trouble */
653
		dev_warn(cs->dev, "interrupt read: %s\n",
654
			 get_usb_statmsg(status));
655 656 657 658
		//FIXME corrective action? resubmission always ok?
		goto resubmit;
	}

659 660 661 662 663 664 665
	/* drop incomplete packets even if the missing bytes wouldn't matter */
	if (unlikely(urb->actual_length < 3)) {
		dev_warn(cs->dev, "incomplete interrupt packet (%d bytes)\n",
			 urb->actual_length);
		goto resubmit;
	}

666 667 668
	l = (unsigned) ucs->int_in_buf[1] +
	    (((unsigned) ucs->int_in_buf[2]) << 8);

669 670 671
	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]);
672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716

	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,
717 718 719 720 721
			   &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));
722 723 724 725
		break;

	case HD_RECEIVEATDATA_ACK:	/* AT response ready to be received */
		if (!l) {
726 727
			dev_warn(cs->dev,
				"HD_RECEIVEATDATA_ACK with length 0 ignored\n");
728 729 730 731
			break;
		}
		spin_lock_irqsave(&cs->lock, flags);
		if (ucs->rcvbuf_size) {
732
			/* throw away previous buffer - we have no queue */
733
			dev_err(cs->dev,
734 735 736 737
				"receive AT data overrun, %d bytes lost\n",
				ucs->rcvbuf_size);
			kfree(ucs->rcvbuf);
			ucs->rcvbuf_size = 0;
738 739 740
		}
		if ((ucs->rcvbuf = kmalloc(l, GFP_ATOMIC)) == NULL) {
			spin_unlock_irqrestore(&cs->lock, flags);
741 742
			dev_err(cs->dev, "out of memory receiving AT data\n");
			error_reset(cs);
743 744 745 746
			break;
		}
		ucs->rcvbuf_size = l;
		ucs->retry_cmd_in = 0;
747
		if ((rc = atread_submit(cs, BAS_TIMEOUT)) < 0) {
748 749 750
			kfree(ucs->rcvbuf);
			ucs->rcvbuf = NULL;
			ucs->rcvbuf_size = 0;
751
			if (rc != -ENODEV) {
752
				//FIXME corrective action?
753
				spin_unlock_irqrestore(&cs->lock, flags);
754
				error_reset(cs);
755 756
				break;
			}
757 758 759 760 761
		}
		spin_unlock_irqrestore(&cs->lock, flags);
		break;

	case HD_RESET_INTERRUPT_PIPE_ACK:
762
		gig_dbg(DEBUG_USBREQ, "HD_RESET_INTERRUPT_PIPE_ACK");
763 764 765
		break;

	case HD_SUSPEND_END:
766
		gig_dbg(DEBUG_USBREQ, "HD_SUSPEND_END");
767 768 769
		break;

	default:
770 771 772
		dev_warn(cs->dev,
			 "unknown Gigaset signal 0x%02x (%u) ignored\n",
			 (int) ucs->int_in_buf[0], l);
773 774 775
	}

	check_pending(ucs);
Tilman Schmidt's avatar
Tilman Schmidt committed
776
	wake_up(&ucs->waitqueue);
777 778

resubmit:
779
	rc = usb_submit_urb(urb, GFP_ATOMIC);
780
	if (unlikely(rc != 0 && rc != -ENODEV)) {
781
		dev_err(cs->dev, "could not resubmit interrupt URB: %s\n",
782
			get_usb_rcmsg(rc));
783 784 785 786 787 788 789 790 791 792 793
		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
 */
794
static void read_iso_callback(struct urb *urb)
795 796 797
{
	struct bc_state *bcs;
	struct bas_bc_state *ubc;
798
	int status = urb->status;
799 800 801 802
	unsigned long flags;
	int i, rc;

	/* status codes not worth bothering the tasklet with */
803 804 805 806 807
	if (unlikely(status == -ENOENT ||
		     status == -ECONNRESET ||
		     status == -EINPROGRESS ||
		     status == -ENODEV ||
		     status == -ESHUTDOWN)) {
808
		gig_dbg(DEBUG_ISO, "%s: %s",
809
			__func__, get_usb_statmsg(status));
810 811 812
		return;
	}

813
	bcs = urb->context;
814 815 816 817 818 819
	ubc = bcs->hw.bas;

	spin_lock_irqsave(&ubc->isoinlock, flags);
	if (likely(ubc->isoindone == NULL)) {
		/* pass URB to tasklet */
		ubc->isoindone = urb;
820
		ubc->isoinstatus = status;
821 822 823
		tasklet_schedule(&ubc->rcvd_tasklet);
	} else {
		/* tasklet still busy, drop data and resubmit URB */
824
		ubc->loststatus = status;
825 826 827
		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 &&
828 829
				     urb->iso_frame_desc[i].status !=
								-EINPROGRESS))
830 831 832 833
				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
834
		if (likely(ubc->running)) {
835 836
			/* urb->dev is clobbered by USB subsystem */
			urb->dev = bcs->cs->hw.bas->udev;
837 838
			urb->transfer_flags = URB_ISO_ASAP;
			urb->number_of_packets = BAS_NUMFRAMES;
839 840
			gig_dbg(DEBUG_ISO, "%s: isoc read overrun/resubmit",
				__func__);
841
			rc = usb_submit_urb(urb, GFP_ATOMIC);
842
			if (unlikely(rc != 0 && rc != -ENODEV)) {
843 844
				dev_err(bcs->cs->dev,
					"could not resubmit isochronous read "
845
					"URB: %s\n", get_usb_rcmsg(rc));
846 847 848 849 850 851 852 853 854 855 856 857 858 859 860
				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
 */
861
static void write_iso_callback(struct urb *urb)
862 863 864
{
	struct isow_urbctx_t *ucx;
	struct bas_bc_state *ubc;
865
	int status = urb->status;
866 867 868
	unsigned long flags;

	/* status codes not worth bothering the tasklet with */
869 870 871 872 873
	if (unlikely(status == -ENOENT ||
		     status == -ECONNRESET ||
		     status == -EINPROGRESS ||
		     status == -ENODEV ||
		     status == -ESHUTDOWN)) {
874
		gig_dbg(DEBUG_ISO, "%s: %s",
875
			__func__, get_usb_statmsg(status));
876 877 878 879
		return;
	}

	/* pass URB context to tasklet */
880
	ucx = urb->context;
881
	ubc = ucx->bcs->hw.bas;
882
	ucx->status = status;
883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900

	spin_lock_irqsave(&ubc->isooutlock, flags);
	ubc->isooutovfl = ubc->isooutdone;
	ubc->isooutdone = ucx;
	spin_unlock_irqrestore(&ubc->isooutlock, flags);
	tasklet_schedule(&ubc->sent_tasklet);
}

/* 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)
{
901
	struct bas_bc_state *ubc = bcs->hw.bas;
902 903 904 905 906 907 908 909 910
	struct urb *urb;
	int j, k;
	int rc;

	/* initialize L2 reception */
	if (bcs->proto2 == ISDN_PROTO_L2_HDLC)
		bcs->inputstate |= INS_flag_hunt;

	/* submit all isochronous input URBs */
Tilman Schmidt's avatar
Tilman Schmidt committed
911
	ubc->running = 1;
912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935
	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);
936
		if ((rc = usb_submit_urb(urb, GFP_ATOMIC)) != 0)
937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967
			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
968 969
	/* keep one URB free, submit the others */
	for (k = 0; k < BAS_OUTURBS-1; ++k) {
970
		dump_urb(DEBUG_ISO, "Initial isoc write", urb);
971
		rc = usb_submit_urb(ubc->isoouturbs[k].urb, GFP_ATOMIC);
972
		if (rc != 0)
973 974 975
			goto error;
	}
	dump_urb(DEBUG_ISO, "Initial isoc write (free)", urb);
Tilman Schmidt's avatar
Tilman Schmidt committed
976
	ubc->isooutfree = &ubc->isoouturbs[BAS_OUTURBS-1];
977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993
	ubc->isooutdone = ubc->isooutovfl = NULL;
	return 0;
 error:
	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
994
	ubc->running = 0;
995 996 997

	for (k = 0; k < BAS_INURBS; ++k) {
		rc = usb_unlink_urb(ubc->isoinurbs[k]);
998
		gig_dbg(DEBUG_ISO,
999 1000
			"%s: isoc input URB %d unlinked, result = %s",
			__func__, k, get_usb_rcmsg(rc));
1001 1002 1003 1004
	}

	for (k = 0; k < BAS_OUTURBS; ++k) {
		rc = usb_unlink_urb(ubc->isoouturbs[k].urb);
1005
		gig_dbg(DEBUG_ISO,
1006 1007
			"%s: isoc output URB %d unlinked, result = %s",
			__func__, k, get_usb_rcmsg(rc));
1008 1009 1010 1011 1012 1013 1014 1015 1016
	}
}

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

/* submit_iso_write_urb
 * fill and submit the next isochronous write URB
 * parameters:
1017
 *	ucx	context structure containing URB
1018 1019 1020 1021 1022 1023 1024
 * 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)
{
1025 1026
	struct urb *urb = ucx->urb;
	struct bas_bc_state *ubc = ucx->bcs->hw.bas;
1027 1028 1029
	struct usb_iso_packet_descriptor *ifd;
	int corrbytes, nframe, rc;

1030 1031
	/* urb->dev is clobbered by USB subsystem */
	urb->dev = ucx->bcs->cs->hw.bas->udev;
1032 1033 1034 1035 1036 1037 1038 1039 1040 1041
	urb->transfer_flags = URB_ISO_ASAP;
	urb->transfer_buffer = ubc->isooutbuf->data;
	urb->transfer_buffer_length = sizeof(ubc->isooutbuf->data);

	for (nframe = 0; nframe < BAS_NUMFRAMES; nframe++) {
		ifd = &urb->iso_frame_desc[nframe];

		/* compute frame length according to flow control */
		ifd->length = BAS_NORMFRAME;
		if ((corrbytes = atomic_read(&ubc->corrbytes)) != 0) {
1042 1043
			gig_dbg(DEBUG_ISO, "%s: corrbytes=%d",
				__func__, corrbytes);
1044 1045 1046 1047 1048 1049 1050 1051 1052
			if (corrbytes > BAS_HIGHFRAME - BAS_NORMFRAME)
				corrbytes = BAS_HIGHFRAME - BAS_NORMFRAME;
			else if (corrbytes < BAS_LOWFRAME - BAS_NORMFRAME)
				corrbytes = BAS_LOWFRAME - BAS_NORMFRAME;
			ifd->length += corrbytes;
			atomic_add(-corrbytes, &ubc->corrbytes);
		}

		/* retrieve block of data to send */
1053 1054
		ifd->offset = gigaset_isowbuf_getbytes(ubc->isooutbuf,
						       ifd->length);
1055 1056
		if (ifd->offset < 0) {
			if (ifd->offset == -EBUSY) {
1057 1058 1059 1060 1061
				gig_dbg(DEBUG_ISO,
					"%s: buffer busy at frame %d",
					__func__, nframe);
				/* tasklet will be restarted from
				   gigaset_send_skb() */
1062
			} else {
1063 1064 1065
				dev_err(ucx->bcs->cs->dev,
					"%s: buffer error %d at frame %d\n",
					__func__, ifd->offset, nframe);
1066 1067 1068 1069
				return ifd->offset;
			}
			break;
		}
Tilman Schmidt's avatar
Tilman Schmidt committed
1070
		ucx->limit = ubc->isooutbuf->nextread;
1071 1072 1073
		ifd->status = 0;
		ifd->actual_length = 0;
	}
1074 1075 1076
	if (unlikely(nframe == 0))
		return 0;	/* no data to send */
	urb->number_of_packets = nframe;
1077

1078
	rc = usb_submit_urb(urb, GFP_ATOMIC);
1079 1080 1081 1082 1083
	if (unlikely(rc)) {
		if (rc == -ENODEV)
			/* device removed - give up silently */
			gig_dbg(DEBUG_ISO, "%s: disconnected", __func__);
		else
1084 1085
			dev_err(ucx->bcs->cs->dev,
				"could not submit isochronous write URB: %s\n",
1086 1087
				get_usb_rcmsg(rc));
		return rc;
1088
	}
1089
	++ubc->numsub;
1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100
	return nframe;
}

/* write_iso_tasklet
 * tasklet scheduled when an isochronous output URB from the Gigaset device
 * has completed
 * parameter:
 *	data	B channel state structure
 */
static void write_iso_tasklet(unsigned long data)
{
1101 1102 1103
	struct bc_state *bcs = (struct bc_state *) data;
	struct bas_bc_state *ubc = bcs->hw.bas;
	struct cardstate *cs = bcs->cs;
1104 1105
	struct isow_urbctx_t *done, *next, *ovfl;
	struct urb *urb;