driver.c 20.4 KB
Newer Older
M
Markus Grabner 已提交
1
/*
2
 * Line 6 Linux USB driver
M
Markus Grabner 已提交
3
 *
4
 * Copyright (C) 2004-2010 Markus Grabner (grabner@icg.tugraz.at)
M
Markus Grabner 已提交
5 6 7 8 9 10 11 12 13
 *
 *	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, version 2.
 *
 */

#include <linux/kernel.h>
#include <linux/module.h>
T
Takashi Iwai 已提交
14
#include <linux/export.h>
15
#include <linux/slab.h>
M
Markus Grabner 已提交
16 17
#include <linux/usb.h>

18 19
#include <sound/core.h>
#include <sound/initval.h>
20
#include <sound/hwdep.h>
21

M
Markus Grabner 已提交
22
#include "capture.h"
23
#include "driver.h"
M
Markus Grabner 已提交
24 25 26 27
#include "midi.h"
#include "playback.h"

#define DRIVER_AUTHOR  "Markus Grabner <grabner@icg.tugraz.at>"
28
#define DRIVER_DESC    "Line 6 USB Driver"
M
Markus Grabner 已提交
29 30

/*
31
	This is Line 6's MIDI manufacturer ID.
M
Markus Grabner 已提交
32
*/
33 34 35
const unsigned char line6_midi_id[] = {
	0x00, 0x01, 0x0c
};
T
Takashi Iwai 已提交
36
EXPORT_SYMBOL_GPL(line6_midi_id);
37 38 39 40 41

/*
	Code to request version of POD, Variax interface
	(and maybe other devices).
*/
42
static const char line6_request_version[] = {
43 44 45
	0xf0, 0x7e, 0x7f, 0x06, 0x01, 0xf7
};

46
/*
M
Markus Grabner 已提交
47 48
	 Class for asynchronous messages.
*/
49
struct message {
M
Markus Grabner 已提交
50 51 52 53 54 55 56 57 58
	struct usb_line6 *line6;
	const char *buffer;
	int size;
	int done;
};

/*
	Forward declarations.
*/
59
static void line6_data_received(struct urb *urb);
60 61
static int line6_send_raw_message_async_part(struct message *msg,
					     struct urb *urb);
M
Markus Grabner 已提交
62 63 64 65 66 67

/*
	Start to listen on endpoint.
*/
static int line6_start_listen(struct usb_line6 *line6)
{
68
	int err;
69

70 71 72 73 74 75 76 77 78 79 80
	if (line6->properties->capabilities & LINE6_CAP_CONTROL_MIDI) {
		usb_fill_int_urb(line6->urb_listen, line6->usbdev,
			usb_rcvintpipe(line6->usbdev, line6->properties->ep_ctrl_r),
			line6->buffer_listen, LINE6_BUFSIZE_LISTEN,
			line6_data_received, line6, line6->interval);
	} else {
		usb_fill_bulk_urb(line6->urb_listen, line6->usbdev,
			usb_rcvbulkpipe(line6->usbdev, line6->properties->ep_ctrl_r),
			line6->buffer_listen, LINE6_BUFSIZE_LISTEN,
			line6_data_received, line6);
	}
M
Markus Grabner 已提交
81
	line6->urb_listen->actual_length = 0;
82
	err = usb_submit_urb(line6->urb_listen, GFP_ATOMIC);
83 84 85 86 87 88 89 90 91
	return err;
}

/*
	Stop listening on endpoint.
*/
static void line6_stop_listen(struct usb_line6 *line6)
{
	usb_kill_urb(line6->urb_listen);
M
Markus Grabner 已提交
92 93 94
}

/*
95
	Send raw message in pieces of wMaxPacketSize bytes.
M
Markus Grabner 已提交
96
*/
97 98
static int line6_send_raw_message(struct usb_line6 *line6, const char *buffer,
				  int size)
M
Markus Grabner 已提交
99 100
{
	int i, done = 0;
101
	const struct line6_properties *properties = line6->properties;
M
Markus Grabner 已提交
102

103 104
	for (i = 0; i < size; i += line6->max_packet_size) {
		int partial;
M
Markus Grabner 已提交
105 106
		const char *frag_buf = buffer + i;
		int frag_size = min(line6->max_packet_size, size - i);
107 108
		int retval;

109 110 111 112 113 114 115 116 117 118 119
		if (properties->capabilities & LINE6_CAP_CONTROL_MIDI) {
			retval = usb_interrupt_msg(line6->usbdev,
						usb_sndintpipe(line6->usbdev, properties->ep_ctrl_w),
						(char *)frag_buf, frag_size,
						&partial, LINE6_TIMEOUT * HZ);
		} else {
			retval = usb_bulk_msg(line6->usbdev,
						usb_sndbulkpipe(line6->usbdev, properties->ep_ctrl_w),
						(char *)frag_buf, frag_size,
						&partial, LINE6_TIMEOUT * HZ);
		}
M
Markus Grabner 已提交
120

121 122
		if (retval) {
			dev_err(line6->ifcdev,
123
				"usb_bulk_msg failed (%d)\n", retval);
M
Markus Grabner 已提交
124 125 126
			break;
		}

127
		done += frag_size;
M
Markus Grabner 已提交
128 129 130 131 132 133 134 135
	}

	return done;
}

/*
	Notification of completion of asynchronous request transmission.
*/
136
static void line6_async_request_sent(struct urb *urb)
M
Markus Grabner 已提交
137 138 139
{
	struct message *msg = (struct message *)urb->context;

140
	if (msg->done >= msg->size) {
M
Markus Grabner 已提交
141 142
		usb_free_urb(urb);
		kfree(msg);
143
	} else
M
Markus Grabner 已提交
144 145 146 147 148 149
		line6_send_raw_message_async_part(msg, urb);
}

/*
	Asynchronously send part of a raw message.
*/
150 151
static int line6_send_raw_message_async_part(struct message *msg,
					     struct urb *urb)
M
Markus Grabner 已提交
152 153 154 155 156 157
{
	int retval;
	struct usb_line6 *line6 = msg->line6;
	int done = msg->done;
	int bytes = min(msg->size - done, line6->max_packet_size);

158 159 160 161 162 163 164 165 166 167 168
	if (line6->properties->capabilities & LINE6_CAP_CONTROL_MIDI) {
		usb_fill_int_urb(urb, line6->usbdev,
			usb_sndintpipe(line6->usbdev, line6->properties->ep_ctrl_w),
			(char *)msg->buffer + done, bytes,
			line6_async_request_sent, msg, line6->interval);
	} else {
		usb_fill_bulk_urb(urb, line6->usbdev,
			usb_sndbulkpipe(line6->usbdev, line6->properties->ep_ctrl_w),
			(char *)msg->buffer + done, bytes,
			line6_async_request_sent, msg);
	}
M
Markus Grabner 已提交
169 170 171 172

	msg->done += bytes;
	retval = usb_submit_urb(urb, GFP_ATOMIC);

173 174 175
	if (retval < 0) {
		dev_err(line6->ifcdev, "%s: usb_submit_urb failed (%d)\n",
			__func__, retval);
M
Markus Grabner 已提交
176 177
		usb_free_urb(urb);
		kfree(msg);
178
		return retval;
M
Markus Grabner 已提交
179 180 181 182 183
	}

	return 0;
}

184 185 186
/*
	Setup and start timer.
*/
187
void line6_start_timer(struct timer_list *timer, unsigned long msecs,
188
		       void (*function)(unsigned long), unsigned long data)
189 190
{
	setup_timer(timer, function, data);
191
	mod_timer(timer, jiffies + msecs_to_jiffies(msecs));
192
}
T
Takashi Iwai 已提交
193
EXPORT_SYMBOL_GPL(line6_start_timer);
194

M
Markus Grabner 已提交
195 196 197
/*
	Asynchronously send raw message.
*/
198 199
int line6_send_raw_message_async(struct usb_line6 *line6, const char *buffer,
				 int size)
M
Markus Grabner 已提交
200 201 202 203 204 205
{
	struct message *msg;
	struct urb *urb;

	/* create message: */
	msg = kmalloc(sizeof(struct message), GFP_ATOMIC);
206
	if (msg == NULL)
M
Markus Grabner 已提交
207 208 209 210 211
		return -ENOMEM;

	/* create URB: */
	urb = usb_alloc_urb(0, GFP_ATOMIC);

212
	if (urb == NULL) {
M
Markus Grabner 已提交
213 214 215 216 217 218 219 220 221 222 223 224 225
		kfree(msg);
		return -ENOMEM;
	}

	/* set message data: */
	msg->line6 = line6;
	msg->buffer = buffer;
	msg->size = size;
	msg->done = 0;

	/* start sending: */
	return line6_send_raw_message_async_part(msg, urb);
}
T
Takashi Iwai 已提交
226
EXPORT_SYMBOL_GPL(line6_send_raw_message_async);
M
Markus Grabner 已提交
227

228 229 230 231 232
/*
	Send asynchronous device version request.
*/
int line6_version_request_async(struct usb_line6 *line6)
{
233 234 235
	char *buffer;
	int retval;

236 237
	buffer = kmemdup(line6_request_version,
			sizeof(line6_request_version), GFP_ATOMIC);
238
	if (buffer == NULL)
239 240 241 242 243 244
		return -ENOMEM;

	retval = line6_send_raw_message_async(line6, buffer,
					      sizeof(line6_request_version));
	kfree(buffer);
	return retval;
245
}
T
Takashi Iwai 已提交
246
EXPORT_SYMBOL_GPL(line6_version_request_async);
247

M
Markus Grabner 已提交
248 249 250
/*
	Send sysex message in pieces of wMaxPacketSize bytes.
*/
251 252
int line6_send_sysex_message(struct usb_line6 *line6, const char *buffer,
			     int size)
M
Markus Grabner 已提交
253
{
254 255 256
	return line6_send_raw_message(line6, buffer,
				      size + SYSEX_EXTRA_SIZE) -
	    SYSEX_EXTRA_SIZE;
M
Markus Grabner 已提交
257
}
T
Takashi Iwai 已提交
258
EXPORT_SYMBOL_GPL(line6_send_sysex_message);
M
Markus Grabner 已提交
259 260 261 262 263 264

/*
	Allocate buffer for sysex message and prepare header.
	@param code sysex message code
	@param size number of bytes between code and sysex end
*/
265 266
char *line6_alloc_sysex_buffer(struct usb_line6 *line6, int code1, int code2,
			       int size)
M
Markus Grabner 已提交
267
{
268
	char *buffer = kmalloc(size + SYSEX_EXTRA_SIZE, GFP_ATOMIC);
M
Markus Grabner 已提交
269

270
	if (!buffer)
271
		return NULL;
M
Markus Grabner 已提交
272 273 274 275 276 277 278 279

	buffer[0] = LINE6_SYSEX_BEGIN;
	memcpy(buffer + 1, line6_midi_id, sizeof(line6_midi_id));
	buffer[sizeof(line6_midi_id) + 1] = code1;
	buffer[sizeof(line6_midi_id) + 2] = code2;
	buffer[sizeof(line6_midi_id) + 3 + size] = LINE6_SYSEX_END;
	return buffer;
}
T
Takashi Iwai 已提交
280
EXPORT_SYMBOL_GPL(line6_alloc_sysex_buffer);
M
Markus Grabner 已提交
281 282

/*
283
	Notification of data received from the Line 6 device.
M
Markus Grabner 已提交
284
*/
285
static void line6_data_received(struct urb *urb)
M
Markus Grabner 已提交
286 287
{
	struct usb_line6 *line6 = (struct usb_line6 *)urb->context;
288
	struct midi_buffer *mb = &line6->line6midi->midibuf_in;
M
Markus Grabner 已提交
289 290
	int done;

291
	if (urb->status == -ESHUTDOWN)
M
Markus Grabner 已提交
292 293
		return;

294 295 296
	if (line6->properties->capabilities & LINE6_CAP_CONTROL_MIDI) {
		done =
			line6_midibuf_write(mb, urb->transfer_buffer, urb->actual_length);
M
Markus Grabner 已提交
297

298 299 300 301 302
		if (done < urb->actual_length) {
			line6_midibuf_ignore(mb, done);
			dev_dbg(line6->ifcdev, "%d %d buffer overflow - message skipped\n",
				done, urb->actual_length);
		}
M
Markus Grabner 已提交
303

304 305 306
		for (;;) {
			done =
				line6_midibuf_read(mb, line6->buffer_message,
307
						LINE6_MIDI_MESSAGE_MAXLEN);
M
Markus Grabner 已提交
308

309 310
			if (done == 0)
				break;
M
Markus Grabner 已提交
311

312 313
			line6->message_length = done;
			line6_midi_receive(line6, line6->buffer_message, done);
M
Markus Grabner 已提交
314

315 316 317 318
			if (line6->process_message)
				line6->process_message(line6);
		}
	} else {
319 320
		line6->buffer_message = urb->transfer_buffer;
		line6->message_length = urb->actual_length;
321 322
		if (line6->process_message)
			line6->process_message(line6);
323
		line6->buffer_message = NULL;
M
Markus Grabner 已提交
324 325 326 327 328
	}

	line6_start_listen(line6);
}

329
#define LINE6_READ_WRITE_STATUS_DELAY 2  /* milliseconds */
330
#define LINE6_READ_WRITE_MAX_RETRIES 50
331

M
Markus Grabner 已提交
332 333 334
/*
	Read data from device.
*/
335 336
int line6_read_data(struct usb_line6 *line6, unsigned address, void *data,
		    unsigned datalen)
M
Markus Grabner 已提交
337 338 339 340
{
	struct usb_device *usbdev = line6->usbdev;
	int ret;
	unsigned char len;
341
	unsigned count;
M
Markus Grabner 已提交
342

343 344 345
	if (address > 0xffff || datalen > 0xff)
		return -EINVAL;

M
Markus Grabner 已提交
346 347
	/* query the serial number: */
	ret = usb_control_msg(usbdev, usb_sndctrlpipe(usbdev, 0), 0x67,
348 349 350
			      USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT,
			      (datalen << 8) | 0x21, address,
			      NULL, 0, LINE6_TIMEOUT * HZ);
M
Markus Grabner 已提交
351

352
	if (ret < 0) {
M
Markus Grabner 已提交
353 354 355 356
		dev_err(line6->ifcdev, "read request failed (error %d)\n", ret);
		return ret;
	}

357
	/* Wait for data length. We'll get 0xff until length arrives. */
358
	for (count = 0; count < LINE6_READ_WRITE_MAX_RETRIES; count++) {
359 360
		mdelay(LINE6_READ_WRITE_STATUS_DELAY);

M
Markus Grabner 已提交
361
		ret = usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev, 0), 0x67,
362 363 364 365 366 367 368
				      USB_TYPE_VENDOR | USB_RECIP_DEVICE |
				      USB_DIR_IN,
				      0x0012, 0x0000, &len, 1,
				      LINE6_TIMEOUT * HZ);
		if (ret < 0) {
			dev_err(line6->ifcdev,
				"receive length failed (error %d)\n", ret);
M
Markus Grabner 已提交
369 370
			return ret;
		}
371

372 373 374 375 376 377 378 379 380
		if (len != 0xff)
			break;
	}

	if (len == 0xff) {
		dev_err(line6->ifcdev, "read failed after %d retries\n",
			count);
		return -EIO;
	} else if (len != datalen) {
381 382 383 384
		/* should be equal or something went wrong */
		dev_err(line6->ifcdev,
			"length mismatch (expected %d, got %d)\n",
			(int)datalen, (int)len);
385
		return -EIO;
M
Markus Grabner 已提交
386 387 388 389
	}

	/* receive the result: */
	ret = usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev, 0), 0x67,
390 391 392
			      USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN,
			      0x0013, 0x0000, data, datalen,
			      LINE6_TIMEOUT * HZ);
M
Markus Grabner 已提交
393

394
	if (ret < 0) {
M
Markus Grabner 已提交
395 396 397 398 399 400
		dev_err(line6->ifcdev, "read failed (error %d)\n", ret);
		return ret;
	}

	return 0;
}
T
Takashi Iwai 已提交
401
EXPORT_SYMBOL_GPL(line6_read_data);
M
Markus Grabner 已提交
402 403 404 405

/*
	Write data to device.
*/
406 407
int line6_write_data(struct usb_line6 *line6, unsigned address, void *data,
		     unsigned datalen)
M
Markus Grabner 已提交
408 409 410 411
{
	struct usb_device *usbdev = line6->usbdev;
	int ret;
	unsigned char status;
412
	int count;
M
Markus Grabner 已提交
413

414 415 416
	if (address > 0xffff || datalen > 0xffff)
		return -EINVAL;

417 418 419 420
	ret = usb_control_msg(usbdev, usb_sndctrlpipe(usbdev, 0), 0x67,
			      USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT,
			      0x0022, address, data, datalen,
			      LINE6_TIMEOUT * HZ);
M
Markus Grabner 已提交
421

422 423 424
	if (ret < 0) {
		dev_err(line6->ifcdev,
			"write request failed (error %d)\n", ret);
M
Markus Grabner 已提交
425 426 427
		return ret;
	}

428
	for (count = 0; count < LINE6_READ_WRITE_MAX_RETRIES; count++) {
429 430
		mdelay(LINE6_READ_WRITE_STATUS_DELAY);

431 432 433 434 435 436 437 438 439 440
		ret = usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev, 0),
				      0x67,
				      USB_TYPE_VENDOR | USB_RECIP_DEVICE |
				      USB_DIR_IN,
				      0x0012, 0x0000,
				      &status, 1, LINE6_TIMEOUT * HZ);

		if (ret < 0) {
			dev_err(line6->ifcdev,
				"receiving status failed (error %d)\n", ret);
M
Markus Grabner 已提交
441 442 443
			return ret;
		}

444 445 446 447 448 449 450 451 452
		if (status != 0xff)
			break;
	}

	if (status == 0xff) {
		dev_err(line6->ifcdev, "write failed after %d retries\n",
			count);
		return -EIO;
	} else if (status != 0) {
M
Markus Grabner 已提交
453
		dev_err(line6->ifcdev, "write failed (error %d)\n", ret);
454
		return -EIO;
M
Markus Grabner 已提交
455 456 457 458
	}

	return 0;
}
T
Takashi Iwai 已提交
459
EXPORT_SYMBOL_GPL(line6_write_data);
M
Markus Grabner 已提交
460 461

/*
462
	Read Line 6 device serial number.
M
Markus Grabner 已提交
463 464
	(POD, TonePort, GuitarPort)
*/
465
int line6_read_serial_number(struct usb_line6 *line6, u32 *serial_number)
M
Markus Grabner 已提交
466
{
467 468
	return line6_read_data(line6, 0x80d0, serial_number,
			       sizeof(*serial_number));
M
Markus Grabner 已提交
469
}
T
Takashi Iwai 已提交
470
EXPORT_SYMBOL_GPL(line6_read_serial_number);
M
Markus Grabner 已提交
471 472

/*
473
	Card destructor.
M
Markus Grabner 已提交
474
*/
475
static void line6_destruct(struct snd_card *card)
M
Markus Grabner 已提交
476
{
477
	struct usb_line6 *line6 = card->private_data;
478
	struct usb_device *usbdev = line6->usbdev;
M
Markus Grabner 已提交
479

480 481 482
	/* Free buffer memory first. We cannot depend on the existence of private
	 * data from the (podhd) module, it may be gone already during this call
	 */
483
	kfree(line6->buffer_message);
484

485
	kfree(line6->buffer_listen);
M
Markus Grabner 已提交
486 487

	/* then free URBs: */
488
	usb_free_urb(line6->urb_listen);
489
	line6->urb_listen = NULL;
M
Markus Grabner 已提交
490

491 492
	/* decrement reference counters: */
	usb_put_dev(usbdev);
M
Markus Grabner 已提交
493 494
}

T
Takashi Iwai 已提交
495 496 497 498
/* get data from endpoint descriptor (see usb_maxpacket): */
static void line6_get_interval(struct usb_line6 *line6)
{
	struct usb_device *usbdev = line6->usbdev;
499 500 501 502 503 504 505 506 507 508 509 510
	const struct line6_properties *properties = line6->properties;
	int pipe;
	struct usb_host_endpoint *ep;

	if (properties->capabilities & LINE6_CAP_CONTROL_MIDI) {
		pipe =
			usb_rcvintpipe(line6->usbdev, line6->properties->ep_ctrl_r);
	} else {
		pipe =
			usb_rcvbulkpipe(line6->usbdev, line6->properties->ep_ctrl_r);
	}
	ep = usbdev->ep_in[usb_pipeendpoint(pipe)];
T
Takashi Iwai 已提交
511 512 513

	if (ep) {
		line6->interval = ep->desc.bInterval;
514 515 516 517 518 519 520 521
		if (usbdev->speed == USB_SPEED_LOW) {
			line6->intervals_per_second = USB_LOW_INTERVALS_PER_SECOND;
			line6->iso_buffers = USB_LOW_ISO_BUFFERS;
		} else {
			line6->intervals_per_second = USB_HIGH_INTERVALS_PER_SECOND;
			line6->iso_buffers = USB_HIGH_ISO_BUFFERS;
		}

T
Takashi Iwai 已提交
522 523 524 525 526 527 528 529 530
		line6->max_packet_size = le16_to_cpu(ep->desc.wMaxPacketSize);
	} else {
		dev_err(line6->ifcdev,
			"endpoint not available, using fallback values");
		line6->interval = LINE6_FALLBACK_INTERVAL;
		line6->max_packet_size = LINE6_FALLBACK_MAXPACKETSIZE;
	}
}

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 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 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

/* Enable buffering of incoming messages, flush the buffer */
static int line6_hwdep_open(struct snd_hwdep *hw, struct file *file)
{
	struct usb_line6 *line6 = hw->private_data;

	/* NOTE: hwdep layer provides atomicity here */

	line6->messages.active = 1;

	return 0;
}

/* Stop buffering */
static int line6_hwdep_release(struct snd_hwdep *hw, struct file *file)
{
	struct usb_line6 *line6 = hw->private_data;

	line6->messages.active = 0;

	return 0;
}

/* Read from circular buffer, return to user */
static long
line6_hwdep_read(struct snd_hwdep *hwdep, char __user *buf, long count,
					loff_t *offset)
{
	struct usb_line6 *line6 = hwdep->private_data;
	long rv = 0;
	unsigned int out_count;

	if (mutex_lock_interruptible(&line6->messages.read_lock))
		return -ERESTARTSYS;

	while (kfifo_len(&line6->messages.fifo) == 0) {
		mutex_unlock(&line6->messages.read_lock);

		rv = wait_event_interruptible(
			line6->messages.wait_queue,
			kfifo_len(&line6->messages.fifo) != 0);
		if (rv < 0)
			return rv;

		if (mutex_lock_interruptible(&line6->messages.read_lock))
			return -ERESTARTSYS;
	}

	if (kfifo_peek_len(&line6->messages.fifo) > count) {
		/* Buffer too small; allow re-read of the current item... */
		rv = -EINVAL;
	} else {
		rv = kfifo_to_user(&line6->messages.fifo, buf, count, &out_count);
		if (rv == 0)
			rv = out_count;
	}

	mutex_unlock(&line6->messages.read_lock);
	return rv;
}

/* Write directly (no buffering) to device by user*/
static long
line6_hwdep_write(struct snd_hwdep *hwdep, const char __user *data, long count,
					loff_t *offset)
{
	struct usb_line6 *line6 = hwdep->private_data;
	int rv;
	char *data_copy;

	if (count > line6->max_packet_size * LINE6_RAW_MESSAGES_MAXCOUNT) {
		/* This is an arbitrary limit - still better than nothing... */
		return -EINVAL;
	}

	data_copy = memdup_user(data, count);
	if (IS_ERR(ERR_PTR))
		return -ENOMEM;

	rv = line6_send_raw_message(line6, data_copy, count);

	kfree(data_copy);
	return rv;
}

static const struct snd_hwdep_ops hwdep_ops = {
	.open    = line6_hwdep_open,
	.release = line6_hwdep_release,
	.read    = line6_hwdep_read,
	.write   = line6_hwdep_write,
};

/* Insert into circular buffer */
static void line6_hwdep_push_message(struct usb_line6 *line6)
{
	if (!line6->messages.active)
		return;

	if (kfifo_avail(&line6->messages.fifo) >= line6->message_length) {
		/* No race condition here, there's only one writer */
		kfifo_in(&line6->messages.fifo,
			line6->buffer_message, line6->message_length);
	} /* else TODO: signal overflow */

	wake_up_interruptible(&line6->messages.wait_queue);
}

static int line6_hwdep_init(struct usb_line6 *line6)
{
	int err;
	struct snd_hwdep *hwdep;

	/* TODO: usb_driver_claim_interface(); */
	line6->process_message = line6_hwdep_push_message;
	line6->messages.active = 0;
	init_waitqueue_head(&line6->messages.wait_queue);
	mutex_init(&line6->messages.read_lock);
	INIT_KFIFO(line6->messages.fifo);

	err = snd_hwdep_new(line6->card, "config", 0, &hwdep);
	if (err < 0)
		goto end;
	strcpy(hwdep->name, "config");
	hwdep->iface = SNDRV_HWDEP_IFACE_LINE6;
	hwdep->ops = hwdep_ops;
	hwdep->private_data = line6;
	hwdep->exclusive = true;

end:
	return err;
}

663
static int line6_init_cap_control(struct usb_line6 *line6)
T
Takashi Iwai 已提交
664 665 666 667 668 669 670 671 672 673 674 675
{
	int ret;

	/* initialize USB buffers: */
	line6->buffer_listen = kmalloc(LINE6_BUFSIZE_LISTEN, GFP_KERNEL);
	if (!line6->buffer_listen)
		return -ENOMEM;

	line6->urb_listen = usb_alloc_urb(0, GFP_KERNEL);
	if (!line6->urb_listen)
		return -ENOMEM;

676
	if (line6->properties->capabilities & LINE6_CAP_CONTROL_MIDI) {
677
		line6->buffer_message = kmalloc(LINE6_MIDI_MESSAGE_MAXLEN, GFP_KERNEL);
678 679
		if (!line6->buffer_message)
			return -ENOMEM;
680 681 682 683
	} else {
		ret = line6_hwdep_init(line6);
		if (ret < 0)
			return ret;
684 685
	}

T
Takashi Iwai 已提交
686 687 688 689 690 691 692 693 694
	ret = line6_start_listen(line6);
	if (ret < 0) {
		dev_err(line6->ifcdev, "cannot start listening: %d\n", ret);
		return ret;
	}

	return 0;
}

M
Markus Grabner 已提交
695 696 697
/*
	Probe USB device.
*/
T
Takashi Iwai 已提交
698
int line6_probe(struct usb_interface *interface,
699
		const struct usb_device_id *id,
700
		const char *driver_name,
T
Takashi Iwai 已提交
701
		const struct line6_properties *properties,
702 703
		int (*private_init)(struct usb_line6 *, const struct usb_device_id *id),
		size_t data_size)
M
Markus Grabner 已提交
704
{
705
	struct usb_device *usbdev = interface_to_usbdev(interface);
706
	struct snd_card *card;
707
	struct usb_line6 *line6;
708
	int interface_number;
M
Markus Grabner 已提交
709 710
	int ret;

711 712 713
	if (WARN_ON(data_size < sizeof(*line6)))
		return -EINVAL;

714 715 716 717
	/* we don't handle multiple configurations */
	if (usbdev->descriptor.bNumConfigurations != 1)
		return -ENODEV;

718 719
	ret = snd_card_new(&interface->dev,
			   SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1,
720 721
			   THIS_MODULE, data_size, &card);
	if (ret < 0)
722
		return ret;
M
Markus Grabner 已提交
723 724

	/* store basic data: */
725
	line6 = card->private_data;
726
	line6->card = card;
M
Markus Grabner 已提交
727 728 729 730
	line6->properties = properties;
	line6->usbdev = usbdev;
	line6->ifcdev = &interface->dev;

731
	strcpy(card->id, properties->id);
732
	strcpy(card->driver, driver_name);
733 734
	strcpy(card->shortname, properties->name);
	sprintf(card->longname, "Line 6 %s at USB %s", properties->name,
735 736 737
		dev_name(line6->ifcdev));
	card->private_free = line6_destruct;

M
Markus Grabner 已提交
738 739
	usb_set_intfdata(interface, line6);

740 741 742
	/* increment reference counters: */
	usb_get_dev(usbdev);

743 744 745 746 747 748
	/* initialize device info: */
	dev_info(&interface->dev, "Line 6 %s found\n", properties->name);

	/* query interface number */
	interface_number = interface->cur_altsetting->desc.bInterfaceNumber;

749
	/* TODO reserves the bus bandwidth even without actual transfer */
750
	ret = usb_set_interface(usbdev, interface_number,
751
				properties->altsetting);
752 753 754 755 756
	if (ret < 0) {
		dev_err(&interface->dev, "set_interface failed\n");
		goto error;
	}

757
	if (properties->capabilities & LINE6_CAP_CONTROL) {
758
		line6_get_interval(line6);
759
		ret = line6_init_cap_control(line6);
T
Takashi Iwai 已提交
760
		if (ret < 0)
761
			goto error;
M
Markus Grabner 已提交
762 763
	}

764
	/* initialize device data based on device: */
765
	ret = private_init(line6, id);
766
	if (ret < 0)
767
		goto error;
M
Markus Grabner 已提交
768

769 770
	/* creation of additional special files should go here */

771
	dev_info(&interface->dev, "Line 6 %s now attached\n",
772
		 properties->name);
773

774 775
	return 0;

776
 error:
777
	if (line6->disconnect)
778
		line6->disconnect(line6);
779
	snd_card_free(card);
M
Markus Grabner 已提交
780 781
	return ret;
}
T
Takashi Iwai 已提交
782
EXPORT_SYMBOL_GPL(line6_probe);
M
Markus Grabner 已提交
783 784

/*
785
	Line 6 device disconnected.
M
Markus Grabner 已提交
786
*/
T
Takashi Iwai 已提交
787
void line6_disconnect(struct usb_interface *interface)
M
Markus Grabner 已提交
788
{
789 790
	struct usb_line6 *line6 = usb_get_intfdata(interface);
	struct usb_device *usbdev = interface_to_usbdev(interface);
M
Markus Grabner 已提交
791

792 793
	if (!line6)
		return;
M
Markus Grabner 已提交
794

795 796 797
	if (WARN_ON(usbdev != line6->usbdev))
		return;

798 799
	if (line6->urb_listen != NULL)
		line6_stop_listen(line6);
M
Markus Grabner 已提交
800

801
	snd_card_disconnect(line6->card);
802 803
	if (line6->line6pcm)
		line6_pcm_disconnect(line6->line6pcm);
804
	if (line6->disconnect)
805
		line6->disconnect(line6);
M
Markus Grabner 已提交
806

807
	dev_info(&interface->dev, "Line 6 %s now disconnected\n",
808
		 line6->properties->name);
M
Markus Grabner 已提交
809

810 811
	/* make sure the device isn't destructed twice: */
	usb_set_intfdata(interface, NULL);
T
Takashi Iwai 已提交
812

813
	snd_card_free_when_closed(line6->card);
814
}
T
Takashi Iwai 已提交
815
EXPORT_SYMBOL_GPL(line6_disconnect);
816 817 818 819

#ifdef CONFIG_PM

/*
820
	Suspend Line 6 device.
821
*/
T
Takashi Iwai 已提交
822
int line6_suspend(struct usb_interface *interface, pm_message_t message)
823 824 825 826 827 828
{
	struct usb_line6 *line6 = usb_get_intfdata(interface);
	struct snd_line6_pcm *line6pcm = line6->line6pcm;

	snd_power_change_state(line6->card, SNDRV_CTL_POWER_D3hot);

829
	if (line6->properties->capabilities & LINE6_CAP_CONTROL)
830 831 832 833 834 835 836 837 838
		line6_stop_listen(line6);

	if (line6pcm != NULL) {
		snd_pcm_suspend_all(line6pcm->pcm);
		line6pcm->flags = 0;
	}

	return 0;
}
T
Takashi Iwai 已提交
839
EXPORT_SYMBOL_GPL(line6_suspend);
840 841

/*
842
	Resume Line 6 device.
843
*/
T
Takashi Iwai 已提交
844
int line6_resume(struct usb_interface *interface)
845 846 847
{
	struct usb_line6 *line6 = usb_get_intfdata(interface);

848
	if (line6->properties->capabilities & LINE6_CAP_CONTROL)
849 850 851 852 853
		line6_start_listen(line6);

	snd_power_change_state(line6->card, SNDRV_CTL_POWER_D0);
	return 0;
}
T
Takashi Iwai 已提交
854
EXPORT_SYMBOL_GPL(line6_resume);
M
Markus Grabner 已提交
855

856
#endif /* CONFIG_PM */
857

M
Markus Grabner 已提交
858 859 860
MODULE_AUTHOR(DRIVER_AUTHOR);
MODULE_DESCRIPTION(DRIVER_DESC);
MODULE_LICENSE("GPL");
861