1/*
   2 *  ALSA sequencer Client Manager
   3 *  Copyright (c) 1998-2001 by Frank van de Pol <fvdpol@coil.demon.nl>
   4 *                             Jaroslav Kysela <perex@perex.cz>
   5 *                             Takashi Iwai <tiwai@suse.de>
   6 *
   7 *
   8 *   This program is free software; you can redistribute it and/or modify
   9 *   it under the terms of the GNU General Public License as published by
  10 *   the Free Software Foundation; either version 2 of the License, or
  11 *   (at your option) any later version.
  12 *
  13 *   This program is distributed in the hope that it will be useful,
  14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 *   GNU General Public License for more details.
  17 *
  18 *   You should have received a copy of the GNU General Public License
  19 *   along with this program; if not, write to the Free Software
  20 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  21 *
  22 */
  23
  24#include <linux/init.h>
  25#include <linux/export.h>
  26#include <linux/slab.h>
  27#include <sound/core.h>
  28#include <sound/minors.h>
  29#include <linux/kmod.h>
  30
  31#include <sound/seq_kernel.h>
  32#include "seq_clientmgr.h"
  33#include "seq_memory.h"
  34#include "seq_queue.h"
  35#include "seq_timer.h"
  36#include "seq_info.h"
  37#include "seq_system.h"
  38#include <sound/seq_device.h>
  39#ifdef CONFIG_COMPAT
  40#include <linux/compat.h>
  41#endif
  42
  43/* Client Manager
  44
  45 * this module handles the connections of userland and kernel clients
  46 * 
  47 */
  48
  49/*
  50 * There are four ranges of client numbers (last two shared):
  51 * 0..15: global clients
  52 * 16..127: statically allocated client numbers for cards 0..27
  53 * 128..191: dynamically allocated client numbers for cards 28..31
  54 * 128..191: dynamically allocated client numbers for applications
  55 */
  56
  57/* number of kernel non-card clients */
  58#define SNDRV_SEQ_GLOBAL_CLIENTS	16
  59/* clients per cards, for static clients */
  60#define SNDRV_SEQ_CLIENTS_PER_CARD	4
  61/* dynamically allocated client numbers (both kernel drivers and user space) */
  62#define SNDRV_SEQ_DYNAMIC_CLIENTS_BEGIN	128
  63
  64#define SNDRV_SEQ_LFLG_INPUT	0x0001
  65#define SNDRV_SEQ_LFLG_OUTPUT	0x0002
  66#define SNDRV_SEQ_LFLG_OPEN	(SNDRV_SEQ_LFLG_INPUT|SNDRV_SEQ_LFLG_OUTPUT)
  67
  68static DEFINE_SPINLOCK(clients_lock);
  69static DEFINE_MUTEX(register_mutex);
  70
  71/*
  72 * client table
  73 */
  74static char clienttablock[SNDRV_SEQ_MAX_CLIENTS];
  75static struct snd_seq_client *clienttab[SNDRV_SEQ_MAX_CLIENTS];
  76static struct snd_seq_usage client_usage;
  77
  78/*
  79 * prototypes
  80 */
  81static int bounce_error_event(struct snd_seq_client *client,
  82			      struct snd_seq_event *event,
  83			      int err, int atomic, int hop);
  84static int snd_seq_deliver_single_event(struct snd_seq_client *client,
  85					struct snd_seq_event *event,
  86					int filter, int atomic, int hop);
  87
  88/*
  89 */
  90 
  91static inline mm_segment_t snd_enter_user(void)
  92{
  93	mm_segment_t fs = get_fs();
  94	set_fs(get_ds());
  95	return fs;
  96}
  97
  98static inline void snd_leave_user(mm_segment_t fs)
  99{
 100	set_fs(fs);
 101}
 102
 103/*
 104 */
 105static inline unsigned short snd_seq_file_flags(struct file *file)
 106{
 107        switch (file->f_mode & (FMODE_READ | FMODE_WRITE)) {
 108        case FMODE_WRITE:
 109                return SNDRV_SEQ_LFLG_OUTPUT;
 110        case FMODE_READ:
 111                return SNDRV_SEQ_LFLG_INPUT;
 112        default:
 113                return SNDRV_SEQ_LFLG_OPEN;
 114        }
 115}
 116
 117static inline int snd_seq_write_pool_allocated(struct snd_seq_client *client)
 118{
 119	return snd_seq_total_cells(client->pool) > 0;
 120}
 121
 122/* return pointer to client structure for specified id */
 123static struct snd_seq_client *clientptr(int clientid)
 124{
 125	if (clientid < 0 || clientid >= SNDRV_SEQ_MAX_CLIENTS) {
 126		snd_printd("Seq: oops. Trying to get pointer to client %d\n",
 127			   clientid);
 128		return NULL;
 129	}
 130	return clienttab[clientid];
 131}
 132
 133struct snd_seq_client *snd_seq_client_use_ptr(int clientid)
 134{
 135	unsigned long flags;
 136	struct snd_seq_client *client;
 137
 138	if (clientid < 0 || clientid >= SNDRV_SEQ_MAX_CLIENTS) {
 139		snd_printd("Seq: oops. Trying to get pointer to client %d\n",
 140			   clientid);
 141		return NULL;
 142	}
 143	spin_lock_irqsave(&clients_lock, flags);
 144	client = clientptr(clientid);
 145	if (client)
 146		goto __lock;
 147	if (clienttablock[clientid]) {
 148		spin_unlock_irqrestore(&clients_lock, flags);
 149		return NULL;
 150	}
 151	spin_unlock_irqrestore(&clients_lock, flags);
 152#ifdef CONFIG_MODULES
 153	if (!in_interrupt()) {
 154		static char client_requested[SNDRV_SEQ_GLOBAL_CLIENTS];
 155		static char card_requested[SNDRV_CARDS];
 156		if (clientid < SNDRV_SEQ_GLOBAL_CLIENTS) {
 157			int idx;
 158			
 159			if (!client_requested[clientid]) {
 160				client_requested[clientid] = 1;
 161				for (idx = 0; idx < 15; idx++) {
 162					if (seq_client_load[idx] < 0)
 163						break;
 164					if (seq_client_load[idx] == clientid) {
 165						request_module("snd-seq-client-%i",
 166							       clientid);
 167						break;
 168					}
 169				}
 170			}
 171		} else if (clientid < SNDRV_SEQ_DYNAMIC_CLIENTS_BEGIN) {
 172			int card = (clientid - SNDRV_SEQ_GLOBAL_CLIENTS) /
 173				SNDRV_SEQ_CLIENTS_PER_CARD;
 174			if (card < snd_ecards_limit) {
 175				if (! card_requested[card]) {
 176					card_requested[card] = 1;
 177					snd_request_card(card);
 178				}
 179				snd_seq_device_load_drivers();
 180			}
 181		}
 182		spin_lock_irqsave(&clients_lock, flags);
 183		client = clientptr(clientid);
 184		if (client)
 185			goto __lock;
 186		spin_unlock_irqrestore(&clients_lock, flags);
 187	}
 188#endif
 189	return NULL;
 190
 191      __lock:
 192	snd_use_lock_use(&client->use_lock);
 193	spin_unlock_irqrestore(&clients_lock, flags);
 194	return client;
 195}
 196
 197static void usage_alloc(struct snd_seq_usage *res, int num)
 198{
 199	res->cur += num;
 200	if (res->cur > res->peak)
 201		res->peak = res->cur;
 202}
 203
 204static void usage_free(struct snd_seq_usage *res, int num)
 205{
 206	res->cur -= num;
 207}
 208
 209/* initialise data structures */
 210int __init client_init_data(void)
 211{
 212	/* zap out the client table */
 213	memset(&clienttablock, 0, sizeof(clienttablock));
 214	memset(&clienttab, 0, sizeof(clienttab));
 215	return 0;
 216}
 217
 218
 219static struct snd_seq_client *seq_create_client1(int client_index, int poolsize)
 220{
 221	unsigned long flags;
 222	int c;
 223	struct snd_seq_client *client;
 224
 225	/* init client data */
 226	client = kzalloc(sizeof(*client), GFP_KERNEL);
 227	if (client == NULL)
 228		return NULL;
 229	client->pool = snd_seq_pool_new(poolsize);
 230	if (client->pool == NULL) {
 231		kfree(client);
 232		return NULL;
 233	}
 234	client->type = NO_CLIENT;
 235	snd_use_lock_init(&client->use_lock);
 236	rwlock_init(&client->ports_lock);
 237	mutex_init(&client->ports_mutex);
 238	INIT_LIST_HEAD(&client->ports_list_head);
 239
 240	/* find free slot in the client table */
 241	spin_lock_irqsave(&clients_lock, flags);
 242	if (client_index < 0) {
 243		for (c = SNDRV_SEQ_DYNAMIC_CLIENTS_BEGIN;
 244		     c < SNDRV_SEQ_MAX_CLIENTS;
 245		     c++) {
 246			if (clienttab[c] || clienttablock[c])
 247				continue;
 248			clienttab[client->number = c] = client;
 249			spin_unlock_irqrestore(&clients_lock, flags);
 250			return client;
 251		}
 252	} else {
 253		if (clienttab[client_index] == NULL && !clienttablock[client_index]) {
 254			clienttab[client->number = client_index] = client;
 255			spin_unlock_irqrestore(&clients_lock, flags);
 256			return client;
 257		}
 258	}
 259	spin_unlock_irqrestore(&clients_lock, flags);
 260	snd_seq_pool_delete(&client->pool);
 261	kfree(client);
 262	return NULL;	/* no free slot found or busy, return failure code */
 263}
 264
 265
 266static int seq_free_client1(struct snd_seq_client *client)
 267{
 268	unsigned long flags;
 269
 270	if (!client)
 271		return 0;
 272	snd_seq_delete_all_ports(client);
 273	snd_seq_queue_client_leave(client->number);
 274	spin_lock_irqsave(&clients_lock, flags);
 275	clienttablock[client->number] = 1;
 276	clienttab[client->number] = NULL;
 277	spin_unlock_irqrestore(&clients_lock, flags);
 278	snd_use_lock_sync(&client->use_lock);
 279	snd_seq_queue_client_termination(client->number);
 280	if (client->pool)
 281		snd_seq_pool_delete(&client->pool);
 282	spin_lock_irqsave(&clients_lock, flags);
 283	clienttablock[client->number] = 0;
 284	spin_unlock_irqrestore(&clients_lock, flags);
 285	return 0;
 286}
 287
 288
 289static void seq_free_client(struct snd_seq_client * client)
 290{
 291	mutex_lock(&register_mutex);
 292	switch (client->type) {
 293	case NO_CLIENT:
 294		snd_printk(KERN_WARNING "Seq: Trying to free unused client %d\n",
 295			   client->number);
 296		break;
 297	case USER_CLIENT:
 298	case KERNEL_CLIENT:
 299		seq_free_client1(client);
 300		usage_free(&client_usage, 1);
 301		break;
 302
 303	default:
 304		snd_printk(KERN_ERR "Seq: Trying to free client %d with undefined type = %d\n",
 305			   client->number, client->type);
 306	}
 307	mutex_unlock(&register_mutex);
 308
 309	snd_seq_system_client_ev_client_exit(client->number);
 310}
 311
 312
 313
 314/* -------------------------------------------------------- */
 315
 316/* create a user client */
 317static int snd_seq_open(struct inode *inode, struct file *file)
 318{
 319	int c, mode;			/* client id */
 320	struct snd_seq_client *client;
 321	struct snd_seq_user_client *user;
 322	int err;
 323
 324	err = nonseekable_open(inode, file);
 325	if (err < 0)
 326		return err;
 327
 328	if (mutex_lock_interruptible(&register_mutex))
 329		return -ERESTARTSYS;
 330	client = seq_create_client1(-1, SNDRV_SEQ_DEFAULT_EVENTS);
 331	if (client == NULL) {
 332		mutex_unlock(&register_mutex);
 333		return -ENOMEM;	/* failure code */
 334	}
 335
 336	mode = snd_seq_file_flags(file);
 337	if (mode & SNDRV_SEQ_LFLG_INPUT)
 338		client->accept_input = 1;
 339	if (mode & SNDRV_SEQ_LFLG_OUTPUT)
 340		client->accept_output = 1;
 341
 342	user = &client->data.user;
 343	user->fifo = NULL;
 344	user->fifo_pool_size = 0;
 345
 346	if (mode & SNDRV_SEQ_LFLG_INPUT) {
 347		user->fifo_pool_size = SNDRV_SEQ_DEFAULT_CLIENT_EVENTS;
 348		user->fifo = snd_seq_fifo_new(user->fifo_pool_size);
 349		if (user->fifo == NULL) {
 350			seq_free_client1(client);
 351			kfree(client);
 352			mutex_unlock(&register_mutex);
 353			return -ENOMEM;
 354		}
 355	}
 356
 357	usage_alloc(&client_usage, 1);
 358	client->type = USER_CLIENT;
 359	mutex_unlock(&register_mutex);
 360
 361	c = client->number;
 362	file->private_data = client;
 363
 364	/* fill client data */
 365	user->file = file;
 366	sprintf(client->name, "Client-%d", c);
 367
 368	/* make others aware this new client */
 369	snd_seq_system_client_ev_client_start(c);
 370
 371	return 0;
 372}
 373
 374/* delete a user client */
 375static int snd_seq_release(struct inode *inode, struct file *file)
 376{
 377	struct snd_seq_client *client = file->private_data;
 378
 379	if (client) {
 380		seq_free_client(client);
 381		if (client->data.user.fifo)
 382			snd_seq_fifo_delete(&client->data.user.fifo);
 383		kfree(client);
 384	}
 385
 386	return 0;
 387}
 388
 389
 390/* handle client read() */
 391/* possible error values:
 392 *	-ENXIO	invalid client or file open mode
 393 *	-ENOSPC	FIFO overflow (the flag is cleared after this error report)
 394 *	-EINVAL	no enough user-space buffer to write the whole event
 395 *	-EFAULT	seg. fault during copy to user space
 396 */
 397static ssize_t snd_seq_read(struct file *file, char __user *buf, size_t count,
 398			    loff_t *offset)
 399{
 400	struct snd_seq_client *client = file->private_data;
 401	struct snd_seq_fifo *fifo;
 402	int err;
 403	long result = 0;
 404	struct snd_seq_event_cell *cell;
 405
 406	if (!(snd_seq_file_flags(file) & SNDRV_SEQ_LFLG_INPUT))
 407		return -ENXIO;
 408
 409	if (!access_ok(VERIFY_WRITE, buf, count))
 410		return -EFAULT;
 411
 412	/* check client structures are in place */
 413	if (snd_BUG_ON(!client))
 414		return -ENXIO;
 415
 416	if (!client->accept_input || (fifo = client->data.user.fifo) == NULL)
 417		return -ENXIO;
 418
 419	if (atomic_read(&fifo->overflow) > 0) {
 420		/* buffer overflow is detected */
 421		snd_seq_fifo_clear(fifo);
 422		/* return error code */
 423		return -ENOSPC;
 424	}
 425
 426	cell = NULL;
 427	err = 0;
 428	snd_seq_fifo_lock(fifo);
 429
 430	/* while data available in queue */
 431	while (count >= sizeof(struct snd_seq_event)) {
 432		int nonblock;
 433
 434		nonblock = (file->f_flags & O_NONBLOCK) || result > 0;
 435		if ((err = snd_seq_fifo_cell_out(fifo, &cell, nonblock)) < 0) {
 436			break;
 437		}
 438		if (snd_seq_ev_is_variable(&cell->event)) {
 439			struct snd_seq_event tmpev;
 440			tmpev = cell->event;
 441			tmpev.data.ext.len &= ~SNDRV_SEQ_EXT_MASK;
 442			if (copy_to_user(buf, &tmpev, sizeof(struct snd_seq_event))) {
 443				err = -EFAULT;
 444				break;
 445			}
 446			count -= sizeof(struct snd_seq_event);
 447			buf += sizeof(struct snd_seq_event);
 448			err = snd_seq_expand_var_event(&cell->event, count,
 449						       (char __force *)buf, 0,
 450						       sizeof(struct snd_seq_event));
 451			if (err < 0)
 452				break;
 453			result += err;
 454			count -= err;
 455			buf += err;
 456		} else {
 457			if (copy_to_user(buf, &cell->event, sizeof(struct snd_seq_event))) {
 458				err = -EFAULT;
 459				break;
 460			}
 461			count -= sizeof(struct snd_seq_event);
 462			buf += sizeof(struct snd_seq_event);
 463		}
 464		snd_seq_cell_free(cell);
 465		cell = NULL; /* to be sure */
 466		result += sizeof(struct snd_seq_event);
 467	}
 468
 469	if (err < 0) {
 470		if (cell)
 471			snd_seq_fifo_cell_putback(fifo, cell);
 472		if (err == -EAGAIN && result > 0)
 473			err = 0;
 474	}
 475	snd_seq_fifo_unlock(fifo);
 476
 477	return (err < 0) ? err : result;
 478}
 479
 480
 481/*
 482 * check access permission to the port
 483 */
 484static int check_port_perm(struct snd_seq_client_port *port, unsigned int flags)
 485{
 486	if ((port->capability & flags) != flags)
 487		return 0;
 488	return flags;
 489}
 490
 491/*
 492 * check if the destination client is available, and return the pointer
 493 * if filter is non-zero, client filter bitmap is tested.
 494 */
 495static struct snd_seq_client *get_event_dest_client(struct snd_seq_event *event,
 496						    int filter)
 497{
 498	struct snd_seq_client *dest;
 499
 500	dest = snd_seq_client_use_ptr(event->dest.client);
 501	if (dest == NULL)
 502		return NULL;
 503	if (! dest->accept_input)
 504		goto __not_avail;
 505	if ((dest->filter & SNDRV_SEQ_FILTER_USE_EVENT) &&
 506	    ! test_bit(event->type, dest->event_filter))
 507		goto __not_avail;
 508	if (filter && !(dest->filter & filter))
 509		goto __not_avail;
 510
 511	return dest; /* ok - accessible */
 512__not_avail:
 513	snd_seq_client_unlock(dest);
 514	return NULL;
 515}
 516
 517
 518/*
 519 * Return the error event.
 520 *
 521 * If the receiver client is a user client, the original event is
 522 * encapsulated in SNDRV_SEQ_EVENT_BOUNCE as variable length event.  If
 523 * the original event is also variable length, the external data is
 524 * copied after the event record. 
 525 * If the receiver client is a kernel client, the original event is
 526 * quoted in SNDRV_SEQ_EVENT_KERNEL_ERROR, since this requires no extra
 527 * kmalloc.
 528 */
 529static int bounce_error_event(struct snd_seq_client *client,
 530			      struct snd_seq_event *event,
 531			      int err, int atomic, int hop)
 532{
 533	struct snd_seq_event bounce_ev;
 534	int result;
 535
 536	if (client == NULL ||
 537	    ! (client->filter & SNDRV_SEQ_FILTER_BOUNCE) ||
 538	    ! client->accept_input)
 539		return 0; /* ignored */
 540
 541	/* set up quoted error */
 542	memset(&bounce_ev, 0, sizeof(bounce_ev));
 543	bounce_ev.type = SNDRV_SEQ_EVENT_KERNEL_ERROR;
 544	bounce_ev.flags = SNDRV_SEQ_EVENT_LENGTH_FIXED;
 545	bounce_ev.queue = SNDRV_SEQ_QUEUE_DIRECT;
 546	bounce_ev.source.client = SNDRV_SEQ_CLIENT_SYSTEM;
 547	bounce_ev.source.port = SNDRV_SEQ_PORT_SYSTEM_ANNOUNCE;
 548	bounce_ev.dest.client = client->number;
 549	bounce_ev.dest.port = event->source.port;
 550	bounce_ev.data.quote.origin = event->dest;
 551	bounce_ev.data.quote.event = event;
 552	bounce_ev.data.quote.value = -err; /* use positive value */
 553	result = snd_seq_deliver_single_event(NULL, &bounce_ev, 0, atomic, hop + 1);
 554	if (result < 0) {
 555		client->event_lost++;
 556		return result;
 557	}
 558
 559	return result;
 560}
 561
 562
 563/*
 564 * rewrite the time-stamp of the event record with the curren time
 565 * of the given queue.
 566 * return non-zero if updated.
 567 */
 568static int update_timestamp_of_queue(struct snd_seq_event *event,
 569				     int queue, int real_time)
 570{
 571	struct snd_seq_queue *q;
 572
 573	q = queueptr(queue);
 574	if (! q)
 575		return 0;
 576	event->queue = queue;
 577	event->flags &= ~SNDRV_SEQ_TIME_STAMP_MASK;
 578	if (real_time) {
 579		event->time.time = snd_seq_timer_get_cur_time(q->timer);
 580		event->flags |= SNDRV_SEQ_TIME_STAMP_REAL;
 581	} else {
 582		event->time.tick = snd_seq_timer_get_cur_tick(q->timer);
 583		event->flags |= SNDRV_SEQ_TIME_STAMP_TICK;
 584	}
 585	queuefree(q);
 586	return 1;
 587}
 588
 589
 590/*
 591 * deliver an event to the specified destination.
 592 * if filter is non-zero, client filter bitmap is tested.
 593 *
 594 *  RETURN VALUE: 0 : if succeeded
 595 *		 <0 : error
 596 */
 597static int snd_seq_deliver_single_event(struct snd_seq_client *client,
 598					struct snd_seq_event *event,
 599					int filter, int atomic, int hop)
 600{
 601	struct snd_seq_client *dest = NULL;
 602	struct snd_seq_client_port *dest_port = NULL;
 603	int result = -ENOENT;
 604	int direct;
 605
 606	direct = snd_seq_ev_is_direct(event);
 607
 608	dest = get_event_dest_client(event, filter);
 609	if (dest == NULL)
 610		goto __skip;
 611	dest_port = snd_seq_port_use_ptr(dest, event->dest.port);
 612	if (dest_port == NULL)
 613		goto __skip;
 614
 615	/* check permission */
 616	if (! check_port_perm(dest_port, SNDRV_SEQ_PORT_CAP_WRITE)) {
 617		result = -EPERM;
 618		goto __skip;
 619	}
 620		
 621	if (dest_port->timestamping)
 622		update_timestamp_of_queue(event, dest_port->time_queue,
 623					  dest_port->time_real);
 624
 625	switch (dest->type) {
 626	case USER_CLIENT:
 627		if (dest->data.user.fifo)
 628			result = snd_seq_fifo_event_in(dest->data.user.fifo, event);
 629		break;
 630
 631	case KERNEL_CLIENT:
 632		if (dest_port->event_input == NULL)
 633			break;
 634		result = dest_port->event_input(event, direct,
 635						dest_port->private_data,
 636						atomic, hop);
 637		break;
 638	default:
 639		break;
 640	}
 641
 642  __skip:
 643	if (dest_port)
 644		snd_seq_port_unlock(dest_port);
 645	if (dest)
 646		snd_seq_client_unlock(dest);
 647
 648	if (result < 0 && !direct) {
 649		result = bounce_error_event(client, event, result, atomic, hop);
 650	}
 651	return result;
 652}
 653
 654
 655/*
 656 * send the event to all subscribers:
 657 */
 658static int deliver_to_subscribers(struct snd_seq_client *client,
 659				  struct snd_seq_event *event,
 660				  int atomic, int hop)
 661{
 662	struct snd_seq_subscribers *subs;
 663	int err = 0, num_ev = 0;
 664	struct snd_seq_event event_saved;
 665	struct snd_seq_client_port *src_port;
 666	struct snd_seq_port_subs_info *grp;
 667
 668	src_port = snd_seq_port_use_ptr(client, event->source.port);
 669	if (src_port == NULL)
 670		return -EINVAL; /* invalid source port */
 671	/* save original event record */
 672	event_saved = *event;
 673	grp = &src_port->c_src;
 674	
 675	/* lock list */
 676	if (atomic)
 677		read_lock(&grp->list_lock);
 678	else
 679		down_read(&grp->list_mutex);
 680	list_for_each_entry(subs, &grp->list_head, src_list) {
 681		event->dest = subs->info.dest;
 682		if (subs->info.flags & SNDRV_SEQ_PORT_SUBS_TIMESTAMP)
 683			/* convert time according to flag with subscription */
 684			update_timestamp_of_queue(event, subs->info.queue,
 685						  subs->info.flags & SNDRV_SEQ_PORT_SUBS_TIME_REAL);
 686		err = snd_seq_deliver_single_event(client, event,
 687						   0, atomic, hop);
 688		if (err < 0)
 689			break;
 690		num_ev++;
 691		/* restore original event record */
 692		*event = event_saved;
 693	}
 694	if (atomic)
 695		read_unlock(&grp->list_lock);
 696	else
 697		up_read(&grp->list_mutex);
 698	*event = event_saved; /* restore */
 699	snd_seq_port_unlock(src_port);
 700	return (err < 0) ? err : num_ev;
 701}
 702
 703
 704#ifdef SUPPORT_BROADCAST 
 705/*
 706 * broadcast to all ports:
 707 */
 708static int port_broadcast_event(struct snd_seq_client *client,
 709				struct snd_seq_event *event,
 710				int atomic, int hop)
 711{
 712	int num_ev = 0, err = 0;
 713	struct snd_seq_client *dest_client;
 714	struct snd_seq_client_port *port;
 715
 716	dest_client = get_event_dest_client(event, SNDRV_SEQ_FILTER_BROADCAST);
 717	if (dest_client == NULL)
 718		return 0; /* no matching destination */
 719
 720	read_lock(&dest_client->ports_lock);
 721	list_for_each_entry(port, &dest_client->ports_list_head, list) {
 722		event->dest.port = port->addr.port;
 723		/* pass NULL as source client to avoid error bounce */
 724		err = snd_seq_deliver_single_event(NULL, event,
 725						   SNDRV_SEQ_FILTER_BROADCAST,
 726						   atomic, hop);
 727		if (err < 0)
 728			break;
 729		num_ev++;
 730	}
 731	read_unlock(&dest_client->ports_lock);
 732	snd_seq_client_unlock(dest_client);
 733	event->dest.port = SNDRV_SEQ_ADDRESS_BROADCAST; /* restore */
 734	return (err < 0) ? err : num_ev;
 735}
 736
 737/*
 738 * send the event to all clients:
 739 * if destination port is also ADDRESS_BROADCAST, deliver to all ports.
 740 */
 741static int broadcast_event(struct snd_seq_client *client,
 742			   struct snd_seq_event *event, int atomic, int hop)
 743{
 744	int err = 0, num_ev = 0;
 745	int dest;
 746	struct snd_seq_addr addr;
 747
 748	addr = event->dest; /* save */
 749
 750	for (dest = 0; dest < SNDRV_SEQ_MAX_CLIENTS; dest++) {
 751		/* don't send to itself */
 752		if (dest == client->number)
 753			continue;
 754		event->dest.client = dest;
 755		event->dest.port = addr.port;
 756		if (addr.port == SNDRV_SEQ_ADDRESS_BROADCAST)
 757			err = port_broadcast_event(client, event, atomic, hop);
 758		else
 759			/* pass NULL as source client to avoid error bounce */
 760			err = snd_seq_deliver_single_event(NULL, event,
 761							   SNDRV_SEQ_FILTER_BROADCAST,
 762							   atomic, hop);
 763		if (err < 0)
 764			break;
 765		num_ev += err;
 766	}
 767	event->dest = addr; /* restore */
 768	return (err < 0) ? err : num_ev;
 769}
 770
 771
 772/* multicast - not supported yet */
 773static int multicast_event(struct snd_seq_client *client, struct snd_seq_event *event,
 774			   int atomic, int hop)
 775{
 776	snd_printd("seq: multicast not supported yet.\n");
 777	return 0; /* ignored */
 778}
 779#endif /* SUPPORT_BROADCAST */
 780
 781
 782/* deliver an event to the destination port(s).
 783 * if the event is to subscribers or broadcast, the event is dispatched
 784 * to multiple targets.
 785 *
 786 * RETURN VALUE: n > 0  : the number of delivered events.
 787 *               n == 0 : the event was not passed to any client.
 788 *               n < 0  : error - event was not processed.
 789 */
 790static int snd_seq_deliver_event(struct snd_seq_client *client, struct snd_seq_event *event,
 791				 int atomic, int hop)
 792{
 793	int result;
 794
 795	hop++;
 796	if (hop >= SNDRV_SEQ_MAX_HOPS) {
 797		snd_printd("too long delivery path (%d:%d->%d:%d)\n",
 798			   event->source.client, event->source.port,
 799			   event->dest.client, event->dest.port);
 800		return -EMLINK;
 801	}
 802
 803	if (event->queue == SNDRV_SEQ_ADDRESS_SUBSCRIBERS ||
 804	    event->dest.client == SNDRV_SEQ_ADDRESS_SUBSCRIBERS)
 805		result = deliver_to_subscribers(client, event, atomic, hop);
 806#ifdef SUPPORT_BROADCAST
 807	else if (event->queue == SNDRV_SEQ_ADDRESS_BROADCAST ||
 808		 event->dest.client == SNDRV_SEQ_ADDRESS_BROADCAST)
 809		result = broadcast_event(client, event, atomic, hop);
 810	else if (event->dest.client >= SNDRV_SEQ_MAX_CLIENTS)
 811		result = multicast_event(client, event, atomic, hop);
 812	else if (event->dest.port == SNDRV_SEQ_ADDRESS_BROADCAST)
 813		result = port_broadcast_event(client, event, atomic, hop);
 814#endif
 815	else
 816		result = snd_seq_deliver_single_event(client, event, 0, atomic, hop);
 817
 818	return result;
 819}
 820
 821/*
 822 * dispatch an event cell:
 823 * This function is called only from queue check routines in timer
 824 * interrupts or after enqueued.
 825 * The event cell shall be released or re-queued in this function.
 826 *
 827 * RETURN VALUE: n > 0  : the number of delivered events.
 828 *		 n == 0 : the event was not passed to any client.
 829 *		 n < 0  : error - event was not processed.
 830 */
 831int snd_seq_dispatch_event(struct snd_seq_event_cell *cell, int atomic, int hop)
 832{
 833	struct snd_seq_client *client;
 834	int result;
 835
 836	if (snd_BUG_ON(!cell))
 837		return -EINVAL;
 838
 839	client = snd_seq_client_use_ptr(cell->event.source.client);
 840	if (client == NULL) {
 841		snd_seq_cell_free(cell); /* release this cell */
 842		return -EINVAL;
 843	}
 844
 845	if (cell->event.type == SNDRV_SEQ_EVENT_NOTE) {
 846		/* NOTE event:
 847		 * the event cell is re-used as a NOTE-OFF event and
 848		 * enqueued again.
 849		 */
 850		struct snd_seq_event tmpev, *ev;
 851
 852		/* reserve this event to enqueue note-off later */
 853		tmpev = cell->event;
 854		tmpev.type = SNDRV_SEQ_EVENT_NOTEON;
 855		result = snd_seq_deliver_event(client, &tmpev, atomic, hop);
 856
 857		/*
 858		 * This was originally a note event.  We now re-use the
 859		 * cell for the note-off event.
 860		 */
 861
 862		ev = &cell->event;
 863		ev->type = SNDRV_SEQ_EVENT_NOTEOFF;
 864		ev->flags |= SNDRV_SEQ_PRIORITY_HIGH;
 865
 866		/* add the duration time */
 867		switch (ev->flags & SNDRV_SEQ_TIME_STAMP_MASK) {
 868		case SNDRV_SEQ_TIME_STAMP_TICK:
 869			ev->time.tick += ev->data.note.duration;
 870			break;
 871		case SNDRV_SEQ_TIME_STAMP_REAL:
 872			/* unit for duration is ms */
 873			ev->time.time.tv_nsec += 1000000 * (ev->data.note.duration % 1000);
 874			ev->time.time.tv_sec += ev->data.note.duration / 1000 +
 875						ev->time.time.tv_nsec / 1000000000;
 876			ev->time.time.tv_nsec %= 1000000000;
 877			break;
 878		}
 879		ev->data.note.velocity = ev->data.note.off_velocity;
 880
 881		/* Now queue this cell as the note off event */
 882		if (snd_seq_enqueue_event(cell, atomic, hop) < 0)
 883			snd_seq_cell_free(cell); /* release this cell */
 884
 885	} else {
 886		/* Normal events:
 887		 * event cell is freed after processing the event
 888		 */
 889
 890		result = snd_seq_deliver_event(client, &cell->event, atomic, hop);
 891		snd_seq_cell_free(cell);
 892	}
 893
 894	snd_seq_client_unlock(client);
 895	return result;
 896}
 897
 898
 899/* Allocate a cell from client pool and enqueue it to queue:
 900 * if pool is empty and blocking is TRUE, sleep until a new cell is
 901 * available.
 902 */
 903static int snd_seq_client_enqueue_event(struct snd_seq_client *client,
 904					struct snd_seq_event *event,
 905					struct file *file, int blocking,
 906					int atomic, int hop)
 907{
 908	struct snd_seq_event_cell *cell;
 909	int err;
 910
 911	/* special queue values - force direct passing */
 912	if (event->queue == SNDRV_SEQ_ADDRESS_SUBSCRIBERS) {
 913		event->dest.client = SNDRV_SEQ_ADDRESS_SUBSCRIBERS;
 914		event->queue = SNDRV_SEQ_QUEUE_DIRECT;
 915	} else
 916#ifdef SUPPORT_BROADCAST
 917		if (event->queue == SNDRV_SEQ_ADDRESS_BROADCAST) {
 918			event->dest.client = SNDRV_SEQ_ADDRESS_BROADCAST;
 919			event->queue = SNDRV_SEQ_QUEUE_DIRECT;
 920		}
 921#endif
 922	if (event->dest.client == SNDRV_SEQ_ADDRESS_SUBSCRIBERS) {
 923		/* check presence of source port */
 924		struct snd_seq_client_port *src_port = snd_seq_port_use_ptr(client, event->source.port);
 925		if (src_port == NULL)
 926			return -EINVAL;
 927		snd_seq_port_unlock(src_port);
 928	}
 929
 930	/* direct event processing without enqueued */
 931	if (snd_seq_ev_is_direct(event)) {
 932		if (event->type == SNDRV_SEQ_EVENT_NOTE)
 933			return -EINVAL; /* this event must be enqueued! */
 934		return snd_seq_deliver_event(client, event, atomic, hop);
 935	}
 936
 937	/* Not direct, normal queuing */
 938	if (snd_seq_queue_is_used(event->queue, client->number) <= 0)
 939		return -EINVAL;  /* invalid queue */
 940	if (! snd_seq_write_pool_allocated(client))
 941		return -ENXIO; /* queue is not allocated */
 942
 943	/* allocate an event cell */
 944	err = snd_seq_event_dup(client->pool, event, &cell, !blocking || atomic, file);
 945	if (err < 0)
 946		return err;
 947
 948	/* we got a cell. enqueue it. */
 949	if ((err = snd_seq_enqueue_event(cell, atomic, hop)) < 0) {
 950		snd_seq_cell_free(cell);
 951		return err;
 952	}
 953
 954	return 0;
 955}
 956
 957
 958/*
 959 * check validity of event type and data length.
 960 * return non-zero if invalid.
 961 */
 962static int check_event_type_and_length(struct snd_seq_event *ev)
 963{
 964	switch (snd_seq_ev_length_type(ev)) {
 965	case SNDRV_SEQ_EVENT_LENGTH_FIXED:
 966		if (snd_seq_ev_is_variable_type(ev))
 967			return -EINVAL;
 968		break;
 969	case SNDRV_SEQ_EVENT_LENGTH_VARIABLE:
 970		if (! snd_seq_ev_is_variable_type(ev) ||
 971		    (ev->data.ext.len & ~SNDRV_SEQ_EXT_MASK) >= SNDRV_SEQ_MAX_EVENT_LEN)
 972			return -EINVAL;
 973		break;
 974	case SNDRV_SEQ_EVENT_LENGTH_VARUSR:
 975		if (! snd_seq_ev_is_direct(ev))
 976			return -EINVAL;
 977		break;
 978	}
 979	return 0;
 980}
 981
 982
 983/* handle write() */
 984/* possible error values:
 985 *	-ENXIO	invalid client or file open mode
 986 *	-ENOMEM	malloc failed
 987 *	-EFAULT	seg. fault during copy from user space
 988 *	-EINVAL	invalid event
 989 *	-EAGAIN	no space in output pool
 990 *	-EINTR	interrupts while sleep
 991 *	-EMLINK	too many hops
 992 *	others	depends on return value from driver callback
 993 */
 994static ssize_t snd_seq_write(struct file *file, const char __user *buf,
 995			     size_t count, loff_t *offset)
 996{
 997	struct snd_seq_client *client = file->private_data;
 998	int written = 0, len;
 999	int err = -EINVAL;
1000	struct snd_seq_event event;
1001
1002	if (!(snd_seq_file_flags(file) & SNDRV_SEQ_LFLG_OUTPUT))
1003		return -ENXIO;
1004
1005	/* check client structures are in place */
1006	if (snd_BUG_ON(!client))
1007		return -ENXIO;
1008		
1009	if (!client->accept_output || client->pool == NULL)
1010		return -ENXIO;
1011
1012	/* allocate the pool now if the pool is not allocated yet */ 
1013	if (client->pool->size > 0 && !snd_seq_write_pool_allocated(client)) {
1014		if (snd_seq_pool_init(client->pool) < 0)
1015			return -ENOMEM;
1016	}
1017
1018	/* only process whole events */
1019	while (count >= sizeof(struct snd_seq_event)) {
1020		/* Read in the event header from the user */
1021		len = sizeof(event);
1022		if (copy_from_user(&event, buf, len)) {
1023			err = -EFAULT;
1024			break;
1025		}
1026		event.source.client = client->number;	/* fill in client number */
1027		/* Check for extension data length */
1028		if (check_event_type_and_length(&event)) {
1029			err = -EINVAL;
1030			break;
1031		}
1032
1033		/* check for special events */
1034		if (event.type == SNDRV_SEQ_EVENT_NONE)
1035			goto __skip_event;
1036		else if (snd_seq_ev_is_reserved(&event)) {
1037			err = -EINVAL;
1038			break;
1039		}
1040
1041		if (snd_seq_ev_is_variable(&event)) {
1042			int extlen = event.data.ext.len & ~SNDRV_SEQ_EXT_MASK;
1043			if ((size_t)(extlen + len) > count) {
1044				/* back out, will get an error this time or next */
1045				err = -EINVAL;
1046				break;
1047			}
1048			/* set user space pointer */
1049			event.data.ext.len = extlen | SNDRV_SEQ_EXT_USRPTR;
1050			event.data.ext.ptr = (char __force *)buf
1051						+ sizeof(struct snd_seq_event);
1052			len += extlen; /* increment data length */
1053		} else {
1054#ifdef CONFIG_COMPAT
1055			if (client->convert32 && snd_seq_ev_is_varusr(&event)) {
1056				void *ptr = (void __force *)compat_ptr(event.data.raw32.d[1]);
1057				event.data.ext.ptr = ptr;
1058			}
1059#endif
1060		}
1061
1062		/* ok, enqueue it */
1063		err = snd_seq_client_enqueue_event(client, &event, file,
1064						   !(file->f_flags & O_NONBLOCK),
1065						   0, 0);
1066		if (err < 0)
1067			break;
1068
1069	__skip_event:
1070		/* Update pointers and counts */
1071		count -= len;
1072		buf += len;
1073		written += len;
1074	}
1075
1076	return written ? written : err;
1077}
1078
1079
1080/*
1081 * handle polling
1082 */
1083static unsigned int snd_seq_poll(struct file *file, poll_table * wait)
1084{
1085	struct snd_seq_client *client = file->private_data;
1086	unsigned int mask = 0;
1087
1088	/* check client structures are in place */
1089	if (snd_BUG_ON(!client))
1090		return -ENXIO;
1091
1092	if ((snd_seq_file_flags(file) & SNDRV_SEQ_LFLG_INPUT) &&
1093	    client->data.user.fifo) {
1094
1095		/* check if data is available in the outqueue */
1096		if (snd_seq_fifo_poll_wait(client->data.user.fifo, file, wait))
1097			mask |= POLLIN | POLLRDNORM;
1098	}
1099
1100	if (snd_seq_file_flags(file) & SNDRV_SEQ_LFLG_OUTPUT) {
1101
1102		/* check if data is available in the pool */
1103		if (!snd_seq_write_pool_allocated(client) ||
1104		    snd_seq_pool_poll_wait(client->pool, file, wait))
1105			mask |= POLLOUT | POLLWRNORM;
1106	}
1107
1108	return mask;
1109}
1110
1111
1112/*-----------------------------------------------------*/
1113
1114
1115/* SYSTEM_INFO ioctl() */
1116static int snd_seq_ioctl_system_info(struct snd_seq_client *client, void __user *arg)
1117{
1118	struct snd_seq_system_info info;
1119
1120	memset(&info, 0, sizeof(info));
1121	/* fill the info fields */
1122	info.queues = SNDRV_SEQ_MAX_QUEUES;
1123	info.clients = SNDRV_SEQ_MAX_CLIENTS;
1124	info.ports = 256;	/* fixed limit */
1125	info.channels = 256;	/* fixed limit */
1126	info.cur_clients = client_usage.cur;
1127	info.cur_queues = snd_seq_queue_get_cur_queues();
1128
1129	if (copy_to_user(arg, &info, sizeof(info)))
1130		return -EFAULT;
1131	return 0;
1132}
1133
1134
1135/* RUNNING_MODE ioctl() */
1136static int snd_seq_ioctl_running_mode(struct snd_seq_client *client, void __user *arg)
1137{
1138	struct snd_seq_running_info info;
1139	struct snd_seq_client *cptr;
1140	int err = 0;
1141
1142	if (copy_from_user(&info, arg, sizeof(info)))
1143		return -EFAULT;
1144
1145	/* requested client number */
1146	cptr = snd_seq_client_use_ptr(info.client);
1147	if (cptr == NULL)
1148		return -ENOENT;		/* don't change !!! */
1149
1150#ifdef SNDRV_BIG_ENDIAN
1151	if (! info.big_endian) {
1152		err = -EINVAL;
1153		goto __err;
1154	}
1155#else
1156	if (info.big_endian) {
1157		err = -EINVAL;
1158		goto __err;
1159	}
1160
1161#endif
1162	if (info.cpu_mode > sizeof(long)) {
1163		err = -EINVAL;
1164		goto __err;
1165	}
1166	cptr->convert32 = (info.cpu_mode < sizeof(long));
1167 __err:
1168	snd_seq_client_unlock(cptr);
1169	return err;
1170}
1171
1172/* CLIENT_INFO ioctl() */
1173static void get_client_info(struct snd_seq_client *cptr,
1174			    struct snd_seq_client_info *info)
1175{
1176	info->client = cptr->number;
1177
1178	/* fill the info fields */
1179	info->type = cptr->type;
1180	strcpy(info->name, cptr->name);
1181	info->filter = cptr->filter;
1182	info->event_lost = cptr->event_lost;
1183	memcpy(info->event_filter, cptr->event_filter, 32);
1184	info->num_ports = cptr->num_ports;
1185	memset(info->reserved, 0, sizeof(info->reserved));
1186}
1187
1188static int snd_seq_ioctl_get_client_info(struct snd_seq_client *client,
1189					 void __user *arg)
1190{
1191	struct snd_seq_client *cptr;
1192	struct snd_seq_client_info client_info;
1193
1194	if (copy_from_user(&client_info, arg, sizeof(client_info)))
1195		return -EFAULT;
1196
1197	/* requested client number */
1198	cptr = snd_seq_client_use_ptr(client_info.client);
1199	if (cptr == NULL)
1200		return -ENOENT;		/* don't change !!! */
1201
1202	get_client_info(cptr, &client_info);
1203	snd_seq_client_unlock(cptr);
1204
1205	if (copy_to_user(arg, &client_info, sizeof(client_info)))
1206		return -EFAULT;
1207	return 0;
1208}
1209
1210
1211/* CLIENT_INFO ioctl() */
1212static int snd_seq_ioctl_set_client_info(struct snd_seq_client *client,
1213					 void __user *arg)
1214{
1215	struct snd_seq_client_info client_info;
1216
1217	if (copy_from_user(&client_info, arg, sizeof(client_info)))
1218		return -EFAULT;
1219
1220	/* it is not allowed to set the info fields for an another client */
1221	if (client->number != client_info.client)
1222		return -EPERM;
1223	/* also client type must be set now */
1224	if (client->type != client_info.type)
1225		return -EINVAL;
1226
1227	/* fill the info fields */
1228	if (client_info.name[0])
1229		strlcpy(client->name, client_info.name, sizeof(client->name));
1230
1231	client->filter = client_info.filter;
1232	client->event_lost = client_info.event_lost;
1233	memcpy(client->event_filter, client_info.event_filter, 32);
1234
1235	return 0;
1236}
1237
1238
1239/* 
1240 * CREATE PORT ioctl() 
1241 */
1242static int snd_seq_ioctl_create_port(struct snd_seq_client *client,
1243				     void __user *arg)
1244{
1245	struct snd_seq_client_port *port;
1246	struct snd_seq_port_info info;
1247	struct snd_seq_port_callback *callback;
1248
1249	if (copy_from_user(&info, arg, sizeof(info)))
1250		return -EFAULT;
1251
1252	/* it is not allowed to create the port for an another client */
1253	if (info.addr.client != client->number)
1254		return -EPERM;
1255
1256	port = snd_seq_create_port(client, (info.flags & SNDRV_SEQ_PORT_FLG_GIVEN_PORT) ? info.addr.port : -1);
1257	if (port == NULL)
1258		return -ENOMEM;
1259
1260	if (client->type == USER_CLIENT && info.kernel) {
1261		snd_seq_delete_port(client, port->addr.port);
1262		return -EINVAL;
1263	}
1264	if (client->type == KERNEL_CLIENT) {
1265		if ((callback = info.kernel) != NULL) {
1266			if (callback->owner)
1267				port->owner = callback->owner;
1268			port->private_data = callback->private_data;
1269			port->private_free = callback->private_free;
1270			port->callback_all = callback->callback_all;
1271			port->event_input = callback->event_input;
1272			port->c_src.open = callback->subscribe;
1273			port->c_src.close = callback->unsubscribe;
1274			port->c_dest.open = callback->use;
1275			port->c_dest.close = callback->unuse;
1276		}
1277	}
1278
1279	info.addr = port->addr;
1280
1281	snd_seq_set_port_info(port, &info);
1282	snd_seq_system_client_ev_port_start(port->addr.client, port->addr.port);
1283
1284	if (copy_to_user(arg, &info, sizeof(info)))
1285		return -EFAULT;
1286
1287	return 0;
1288}
1289
1290/* 
1291 * DELETE PORT ioctl() 
1292 */
1293static int snd_seq_ioctl_delete_port(struct snd_seq_client *client,
1294				     void __user *arg)
1295{
1296	struct snd_seq_port_info info;
1297	int err;
1298
1299	/* set passed parameters */
1300	if (copy_from_user(&info, arg, sizeof(info)))
1301		return -EFAULT;
1302	
1303	/* it is not allowed to remove the port for an another client */
1304	if (info.addr.client != client->number)
1305		return -EPERM;
1306
1307	err = snd_seq_delete_port(client, info.addr.port);
1308	if (err >= 0)
1309		snd_seq_system_client_ev_port_exit(client->number, info.addr.port);
1310	return err;
1311}
1312
1313
1314/* 
1315 * GET_PORT_INFO ioctl() (on any client) 
1316 */
1317static int snd_seq_ioctl_get_port_info(struct snd_seq_client *client,
1318				       void __user *arg)
1319{
1320	struct snd_seq_client *cptr;
1321	struct snd_seq_client_port *port;
1322	struct snd_seq_port_info info;
1323
1324	if (copy_from_user(&info, arg, sizeof(info)))
1325		return -EFAULT;
1326	cptr = snd_seq_client_use_ptr(info.addr.client);
1327	if (cptr == NULL)
1328		return -ENXIO;
1329
1330	port = snd_seq_port_use_ptr(cptr, info.addr.port);
1331	if (port == NULL) {
1332		snd_seq_client_unlock(cptr);
1333		return -ENOENT;			/* don't change */
1334	}
1335
1336	/* get port info */
1337	snd_seq_get_port_info(port, &info);
1338	snd_seq_port_unlock(port);
1339	snd_seq_client_unlock(cptr);
1340
1341	if (copy_to_user(arg, &info, sizeof(info)))
1342		return -EFAULT;
1343	return 0;
1344}
1345
1346
1347/* 
1348 * SET_PORT_INFO ioctl() (only ports on this/own client) 
1349 */
1350static int snd_seq_ioctl_set_port_info(struct snd_seq_client *client,
1351				       void __user *arg)
1352{
1353	struct snd_seq_client_port *port;
1354	struct snd_seq_port_info info;
1355
1356	if (copy_from_user(&info, arg, sizeof(info)))
1357		return -EFAULT;
1358
1359	if (info.addr.client != client->number) /* only set our own ports ! */
1360		return -EPERM;
1361	port = snd_seq_port_use_ptr(client, info.addr.port);
1362	if (port) {
1363		snd_seq_set_port_info(port, &info);
1364		snd_seq_port_unlock(port);
1365	}
1366	return 0;
1367}
1368
1369
1370/*
1371 * port subscription (connection)
1372 */
1373#define PERM_RD		(SNDRV_SEQ_PORT_CAP_READ|SNDRV_SEQ_PORT_CAP_SUBS_READ)
1374#define PERM_WR		(SNDRV_SEQ_PORT_CAP_WRITE|SNDRV_SEQ_PORT_CAP_SUBS_WRITE)
1375
1376static int check_subscription_permission(struct snd_seq_client *client,
1377					 struct snd_seq_client_port *sport,
1378					 struct snd_seq_client_port *dport,
1379					 struct snd_seq_port_subscribe *subs)
1380{
1381	if (client->number != subs->sender.client &&
1382	    client->number != subs->dest.client) {
1383		/* connection by third client - check export permission */
1384		if (check_port_perm(sport, SNDRV_SEQ_PORT_CAP_NO_EXPORT))
1385			return -EPERM;
1386		if (check_port_perm(dport, SNDRV_SEQ_PORT_CAP_NO_EXPORT))
1387			return -EPERM;
1388	}
1389
1390	/* check read permission */
1391	/* if sender or receiver is the subscribing client itself,
1392	 * no permission check is necessary
1393	 */
1394	if (client->number != subs->sender.client) {
1395		if (! check_port_perm(sport, PERM_RD))
1396			return -EPERM;
1397	}
1398	/* check write permission */
1399	if (client->number != subs->dest.client) {
1400		if (! check_port_perm(dport, PERM_WR))
1401			return -EPERM;
1402	}
1403	return 0;
1404}
1405
1406/*
1407 * send an subscription notify event to user client:
1408 * client must be user client.
1409 */
1410int snd_seq_client_notify_subscription(int client, int port,
1411				       struct snd_seq_port_subscribe *info,
1412				       int evtype)
1413{
1414	struct snd_seq_event event;
1415
1416	memset(&event, 0, sizeof(event));
1417	event.type = evtype;
1418	event.data.connect.dest = info->dest;
1419	event.data.connect.sender = info->sender;
1420
1421	return snd_seq_system_notify(client, port, &event);  /* non-atomic */
1422}
1423
1424
1425/* 
1426 * add to port's subscription list IOCTL interface 
1427 */
1428static int snd_seq_ioctl_subscribe_port(struct snd_seq_client *client,
1429					void __user *arg)
1430{
1431	int result = -EINVAL;
1432	struct snd_seq_client *receiver = NULL, *sender = NULL;
1433	struct snd_seq_client_port *sport = NULL, *dport = NULL;
1434	struct snd_seq_port_subscribe subs;
1435
1436	if (copy_from_user(&subs, arg, sizeof(subs)))
1437		return -EFAULT;
1438
1439	if ((receiver = snd_seq_client_use_ptr(subs.dest.client)) == NULL)
1440		goto __end;
1441	if ((sender = snd_seq_client_use_ptr(subs.sender.client)) == NULL)
1442		goto __end;
1443	if ((sport = snd_seq_port_use_ptr(sender, subs.sender.port)) == NULL)
1444		goto __end;
1445	if ((dport = snd_seq_port_use_ptr(receiver, subs.dest.port)) == NULL)
1446		goto __end;
1447
1448	result = check_subscription_permission(client, sport, dport, &subs);
1449	if (result < 0)
1450		goto __end;
1451
1452	/* connect them */
1453	result = snd_seq_port_connect(client, sender, sport, receiver, dport, &subs);
1454	if (! result) /* broadcast announce */
1455		snd_seq_client_notify_subscription(SNDRV_SEQ_ADDRESS_SUBSCRIBERS, 0,
1456						   &subs, SNDRV_SEQ_EVENT_PORT_SUBSCRIBED);
1457      __end:
1458      	if (sport)
1459		snd_seq_port_unlock(sport);
1460	if (dport)
1461		snd_seq_port_unlock(dport);
1462	if (sender)
1463		snd_seq_client_unlock(sender);
1464	if (receiver)
1465		snd_seq_client_unlock(receiver);
1466	return result;
1467}
1468
1469
1470/* 
1471 * remove from port's subscription list 
1472 */
1473static int snd_seq_ioctl_unsubscribe_port(struct snd_seq_client *client,
1474					  void __user *arg)
1475{
1476	int result = -ENXIO;
1477	struct snd_seq_client *receiver = NULL, *sender = NULL;
1478	struct snd_seq_client_port *sport = NULL, *dport = NULL;
1479	struct snd_seq_port_subscribe subs;
1480
1481	if (copy_from_user(&subs, arg, sizeof(subs)))
1482		return -EFAULT;
1483
1484	if ((receiver = snd_seq_client_use_ptr(subs.dest.client)) == NULL)
1485		goto __end;
1486	if ((sender = snd_seq_client_use_ptr(subs.sender.client)) == NULL)
1487		goto __end;
1488	if ((sport = snd_seq_port_use_ptr(sender, subs.sender.port)) == NULL)
1489		goto __end;
1490	if ((dport = snd_seq_port_use_ptr(receiver, subs.dest.port)) == NULL)
1491		goto __end;
1492
1493	result = check_subscription_permission(client, sport, dport, &subs);
1494	if (result < 0)
1495		goto __end;
1496
1497	result = snd_seq_port_disconnect(client, sender, sport, receiver, dport, &subs);
1498	if (! result) /* broadcast announce */
1499		snd_seq_client_notify_subscription(SNDRV_SEQ_ADDRESS_SUBSCRIBERS, 0,
1500						   &subs, SNDRV_SEQ_EVENT_PORT_UNSUBSCRIBED);
1501      __end:
1502      	if (sport)
1503		snd_seq_port_unlock(sport);
1504	if (dport)
1505		snd_seq_port_unlock(dport);
1506	if (sender)
1507		snd_seq_client_unlock(sender);
1508	if (receiver)
1509		snd_seq_client_unlock(receiver);
1510	return result;
1511}
1512
1513
1514/* CREATE_QUEUE ioctl() */
1515static int snd_seq_ioctl_create_queue(struct snd_seq_client *client,
1516				      void __user *arg)
1517{
1518	struct snd_seq_queue_info info;
1519	int result;
1520	struct snd_seq_queue *q;
1521
1522	if (copy_from_user(&info, arg, sizeof(info)))
1523		return -EFAULT;
1524
1525	result = snd_seq_queue_alloc(client->number, info.locked, info.flags);
1526	if (result < 0)
1527		return result;
1528
1529	q = queueptr(result);
1530	if (q == NULL)
1531		return -EINVAL;
1532
1533	info.queue = q->queue;
1534	info.locked = q->locked;
1535	info.owner = q->owner;
1536
1537	/* set queue name */
1538	if (! info.name[0])
1539		snprintf(info.name, sizeof(info.name), "Queue-%d", q->queue);
1540	strlcpy(q->name, info.name, sizeof(q->name));
1541	queuefree(q);
1542
1543	if (copy_to_user(arg, &info, sizeof(info)))
1544		return -EFAULT;
1545
1546	return 0;
1547}
1548
1549/* DELETE_QUEUE ioctl() */
1550static int snd_seq_ioctl_delete_queue(struct snd_seq_client *client,
1551				      void __user *arg)
1552{
1553	struct snd_seq_queue_info info;
1554
1555	if (copy_from_user(&info, arg, sizeof(info)))
1556		return -EFAULT;
1557
1558	return snd_seq_queue_delete(client->number, info.queue);
1559}
1560
1561/* GET_QUEUE_INFO ioctl() */
1562static int snd_seq_ioctl_get_queue_info(struct snd_seq_client *client,
1563					void __user *arg)
1564{
1565	struct snd_seq_queue_info info;
1566	struct snd_seq_queue *q;
1567
1568	if (copy_from_user(&info, arg, sizeof(info)))
1569		return -EFAULT;
1570
1571	q = queueptr(info.queue);
1572	if (q == NULL)
1573		return -EINVAL;
1574
1575	memset(&info, 0, sizeof(info));
1576	info.queue = q->queue;
1577	info.owner = q->owner;
1578	info.locked = q->locked;
1579	strlcpy(info.name, q->name, sizeof(info.name));
1580	queuefree(q);
1581
1582	if (copy_to_user(arg, &info, sizeof(info)))
1583		return -EFAULT;
1584
1585	return 0;
1586}
1587
1588/* SET_QUEUE_INFO ioctl() */
1589static int snd_seq_ioctl_set_queue_info(struct snd_seq_client *client,
1590					void __user *arg)
1591{
1592	struct snd_seq_queue_info info;
1593	struct snd_seq_queue *q;
1594
1595	if (copy_from_user(&info, arg, sizeof(info)))
1596		return -EFAULT;
1597
1598	if (info.owner != client->number)
1599		return -EINVAL;
1600
1601	/* change owner/locked permission */
1602	if (snd_seq_queue_check_access(info.queue, client->number)) {
1603		if (snd_seq_queue_set_owner(info.queue, client->number, info.locked) < 0)
1604			return -EPERM;
1605		if (info.locked)
1606			snd_seq_queue_use(info.queue, client->number, 1);
1607	} else {
1608		return -EPERM;
1609	}	
1610
1611	q = queueptr(info.queue);
1612	if (! q)
1613		return -EINVAL;
1614	if (q->owner != client->number) {
1615		queuefree(q);
1616		return -EPERM;
1617	}
1618	strlcpy(q->name, info.name, sizeof(q->name));
1619	queuefree(q);
1620
1621	return 0;
1622}
1623
1624/* GET_NAMED_QUEUE ioctl() */
1625static int snd_seq_ioctl_get_named_queue(struct snd_seq_client *client, void __user *arg)
1626{
1627	struct snd_seq_queue_info info;
1628	struct snd_seq_queue *q;
1629
1630	if (copy_from_user(&info, arg, sizeof(info)))
1631		return -EFAULT;
1632
1633	q = snd_seq_queue_find_name(info.name);
1634	if (q == NULL)
1635		return -EINVAL;
1636	info.queue = q->queue;
1637	info.owner = q->owner;
1638	info.locked = q->locked;
1639	queuefree(q);
1640
1641	if (copy_to_user(arg, &info, sizeof(info)))
1642		return -EFAULT;
1643
1644	return 0;
1645}
1646
1647/* GET_QUEUE_STATUS ioctl() */
1648static int snd_seq_ioctl_get_queue_status(struct snd_seq_client *client,
1649					  void __user *arg)
1650{
1651	struct snd_seq_queue_status status;
1652	struct snd_seq_queue *queue;
1653	struct snd_seq_timer *tmr;
1654
1655	if (copy_from_user(&status, arg, sizeof(status)))
1656		return -EFAULT;
1657
1658	queue = queueptr(status.queue);
1659	if (queue == NULL)
1660		return -EINVAL;
1661	memset(&status, 0, sizeof(status));
1662	status.queue = queue->queue;
1663	
1664	tmr = queue->timer;
1665	status.events = queue->tickq->cells + queue->timeq->cells;
1666
1667	status.time = snd_seq_timer_get_cur_time(tmr);
1668	status.tick = snd_seq_timer_get_cur_tick(tmr);
1669
1670	status.running = tmr->running;
1671
1672	status.flags = queue->flags;
1673	queuefree(queue);
1674
1675	if (copy_to_user(arg, &status, sizeof(status)))
1676		return -EFAULT;
1677	return 0;
1678}
1679
1680
1681/* GET_QUEUE_TEMPO ioctl() */
1682static int snd_seq_ioctl_get_queue_tempo(struct snd_seq_client *client,
1683					 void __user *arg)
1684{
1685	struct snd_seq_queue_tempo tempo;
1686	struct snd_seq_queue *queue;
1687	struct snd_seq_timer *tmr;
1688
1689	if (copy_from_user(&tempo, arg, sizeof(tempo)))
1690		return -EFAULT;
1691
1692	queue = queueptr(tempo.queue);
1693	if (queue == NULL)
1694		return -EINVAL;
1695	memset(&tempo, 0, sizeof(tempo));
1696	tempo.queue = queue->queue;
1697	
1698	tmr = queue->timer;
1699
1700	tempo.tempo = tmr->tempo;
1701	tempo.ppq = tmr->ppq;
1702	tempo.skew_value = tmr->skew;
1703	tempo.skew_base = tmr->skew_base;
1704	queuefree(queue);
1705
1706	if (copy_to_user(arg, &tempo, sizeof(tempo)))
1707		return -EFAULT;
1708	return 0;
1709}
1710
1711
1712/* SET_QUEUE_TEMPO ioctl() */
1713int snd_seq_set_queue_tempo(int client, struct snd_seq_queue_tempo *tempo)
1714{
1715	if (!snd_seq_queue_check_access(tempo->queue, client))
1716		return -EPERM;
1717	return snd_seq_queue_timer_set_tempo(tempo->queue, client, tempo);
1718}
1719
1720EXPORT_SYMBOL(snd_seq_set_queue_tempo);
1721
1722static int snd_seq_ioctl_set_queue_tempo(struct snd_seq_client *client,
1723					 void __user *arg)
1724{
1725	int result;
1726	struct snd_seq_queue_tempo tempo;
1727
1728	if (copy_from_user(&tempo, arg, sizeof(tempo)))
1729		return -EFAULT;
1730
1731	result = snd_seq_set_queue_tempo(client->number, &tempo);
1732	return result < 0 ? result : 0;
1733}
1734
1735
1736/* GET_QUEUE_TIMER ioctl() */
1737static int snd_seq_ioctl_get_queue_timer(struct snd_seq_client *client,
1738					 void __user *arg)
1739{
1740	struct snd_seq_queue_timer timer;
1741	struct snd_seq_queue *queue;
1742	struct snd_seq_timer *tmr;
1743
1744	if (copy_from_user(&timer, arg, sizeof(timer)))
1745		return -EFAULT;
1746
1747	queue = queueptr(timer.queue);
1748	if (queue == NULL)
1749		return -EINVAL;
1750
1751	if (mutex_lock_interruptible(&queue->timer_mutex)) {
1752		queuefree(queue);
1753		return -ERESTARTSYS;
1754	}
1755	tmr = queue->timer;
1756	memset(&timer, 0, sizeof(timer));
1757	timer.queue = queue->queue;
1758
1759	timer.type = tmr->type;
1760	if (tmr->type == SNDRV_SEQ_TIMER_ALSA) {
1761		timer.u.alsa.id = tmr->alsa_id;
1762		timer.u.alsa.resolution = tmr->preferred_resolution;
1763	}
1764	mutex_unlock(&queue->timer_mutex);
1765	queuefree(queue);
1766	
1767	if (copy_to_user(arg, &timer, sizeof(timer)))
1768		return -EFAULT;
1769	return 0;
1770}
1771
1772
1773/* SET_QUEUE_TIMER ioctl() */
1774static int snd_seq_ioctl_set_queue_timer(struct snd_seq_client *client,
1775					 void __user *arg)
1776{
1777	int result = 0;
1778	struct snd_seq_queue_timer timer;
1779
1780	if (copy_from_user(&timer, arg, sizeof(timer)))
1781		return -EFAULT;
1782
1783	if (timer.type != SNDRV_SEQ_TIMER_ALSA)
1784		return -EINVAL;
1785
1786	if (snd_seq_queue_check_access(timer.queue, client->number)) {
1787		struct snd_seq_queue *q;
1788		struct snd_seq_timer *tmr;
1789
1790		q = queueptr(timer.queue);
1791		if (q == NULL)
1792			return -ENXIO;
1793		if (mutex_lock_interruptible(&q->timer_mutex)) {
1794			queuefree(q);
1795			return -ERESTARTSYS;
1796		}
1797		tmr = q->timer;
1798		snd_seq_queue_timer_close(timer.queue);
1799		tmr->type = timer.type;
1800		if (tmr->type == SNDRV_SEQ_TIMER_ALSA) {
1801			tmr->alsa_id = timer.u.alsa.id;
1802			tmr->preferred_resolution = timer.u.alsa.resolution;
1803		}
1804		result = snd_seq_queue_timer_open(timer.queue);
1805		mutex_unlock(&q->timer_mutex);
1806		queuefree(q);
1807	} else {
1808		return -EPERM;
1809	}	
1810
1811	return result;
1812}
1813
1814
1815/* GET_QUEUE_CLIENT ioctl() */
1816static int snd_seq_ioctl_get_queue_client(struct snd_seq_client *client,
1817					  void __user *arg)
1818{
1819	struct snd_seq_queue_client info;
1820	int used;
1821
1822	if (copy_from_user(&info, arg, sizeof(info)))
1823		return -EFAULT;
1824
1825	used = snd_seq_queue_is_used(info.queue, client->number);
1826	if (used < 0)
1827		return -EINVAL;
1828	info.used = used;
1829	info.client = client->number;
1830
1831	if (copy_to_user(arg, &info, sizeof(info)))
1832		return -EFAULT;
1833	return 0;
1834}
1835
1836
1837/* SET_QUEUE_CLIENT ioctl() */
1838static int snd_seq_ioctl_set_queue_client(struct snd_seq_client *client,
1839					  void __user *arg)
1840{
1841	int err;
1842	struct snd_seq_queue_client info;
1843
1844	if (copy_from_user(&info, arg, sizeof(info)))
1845		return -EFAULT;
1846
1847	if (info.used >= 0) {
1848		err = snd_seq_queue_use(info.queue, client->number, info.used);
1849		if (err < 0)
1850			return err;
1851	}
1852
1853	return snd_seq_ioctl_get_queue_client(client, arg);
1854}
1855
1856
1857/* GET_CLIENT_POOL ioctl() */
1858static int snd_seq_ioctl_get_client_pool(struct snd_seq_client *client,
1859					 void __user *arg)
1860{
1861	struct snd_seq_client_pool info;
1862	struct snd_seq_client *cptr;
1863
1864	if (copy_from_user(&info, arg, sizeof(info)))
1865		return -EFAULT;
1866
1867	cptr = snd_seq_client_use_ptr(info.client);
1868	if (cptr == NULL)
1869		return -ENOENT;
1870	memset(&info, 0, sizeof(info));
1871	info.output_pool = cptr->pool->size;
1872	info.output_room = cptr->pool->room;
1873	info.output_free = info.output_pool;
1874	info.output_free = snd_seq_unused_cells(cptr->pool);
1875	if (cptr->type == USER_CLIENT) {
1876		info.input_pool = cptr->data.user.fifo_pool_size;
1877		info.input_free = info.input_pool;
1878		if (cptr->data.user.fifo)
1879			info.input_free = snd_seq_unused_cells(cptr->data.user.fifo->pool);
1880	} else {
1881		info.input_pool = 0;
1882		info.input_free = 0;
1883	}
1884	snd_seq_client_unlock(cptr);
1885	
1886	if (copy_to_user(arg, &info, sizeof(info)))
1887		return -EFAULT;
1888	return 0;
1889}
1890
1891/* SET_CLIENT_POOL ioctl() */
1892static int snd_seq_ioctl_set_client_pool(struct snd_seq_client *client,
1893					 void __user *arg)
1894{
1895	struct snd_seq_client_pool info;
1896	int rc;
1897
1898	if (copy_from_user(&info, arg, sizeof(info)))
1899		return -EFAULT;
1900
1901	if (client->number != info.client)
1902		return -EINVAL; /* can't change other clients */
1903
1904	if (info.output_pool >= 1 && info.output_pool <= SNDRV_SEQ_MAX_EVENTS &&
1905	    (! snd_seq_write_pool_allocated(client) ||
1906	     info.output_pool != client->pool->size)) {
1907		if (snd_seq_write_pool_allocated(client)) {
1908			/* remove all existing cells */
1909			snd_seq_queue_client_leave_cells(client->number);
1910			snd_seq_pool_done(client->pool);
1911		}
1912		client->pool->size = info.output_pool;
1913		rc = snd_seq_pool_init(client->pool);
1914		if (rc < 0)
1915			return rc;
1916	}
1917	if (client->type == USER_CLIENT && client->data.user.fifo != NULL &&
1918	    info.input_pool >= 1 &&
1919	    info.input_pool <= SNDRV_SEQ_MAX_CLIENT_EVENTS &&
1920	    info.input_pool != client->data.user.fifo_pool_size) {
1921		/* change pool size */
1922		rc = snd_seq_fifo_resize(client->data.user.fifo, info.input_pool);
1923		if (rc < 0)
1924			return rc;
1925		client->data.user.fifo_pool_size = info.input_pool;
1926	}
1927	if (info.output_room >= 1 &&
1928	    info.output_room <= client->pool->size) {
1929		client->pool->room  = info.output_room;
1930	}
1931
1932	return snd_seq_ioctl_get_client_pool(client, arg);
1933}
1934
1935
1936/* REMOVE_EVENTS ioctl() */
1937static int snd_seq_ioctl_remove_events(struct snd_seq_client *client,
1938				       void __user *arg)
1939{
1940	struct snd_seq_remove_events info;
1941
1942	if (copy_from_user(&info, arg, sizeof(info)))
1943		return -EFAULT;
1944
1945	/*
1946	 * Input mostly not implemented XXX.
1947	 */
1948	if (info.remove_mode & SNDRV_SEQ_REMOVE_INPUT) {
1949		/*
1950		 * No restrictions so for a user client we can clear
1951		 * the whole fifo
1952		 */
1953		if (client->type == USER_CLIENT)
1954			snd_seq_fifo_clear(client->data.user.fifo);
1955	}
1956
1957	if (info.remove_mode & SNDRV_SEQ_REMOVE_OUTPUT)
1958		snd_seq_queue_remove_cells(client->number, &info);
1959
1960	return 0;
1961}
1962
1963
1964/*
1965 * get subscription info
1966 */
1967static int snd_seq_ioctl_get_subscription(struct snd_seq_client *client,
1968					  void __user *arg)
1969{
1970	int result;
1971	struct snd_seq_client *sender = NULL;
1972	struct snd_seq_client_port *sport = NULL;
1973	struct snd_seq_port_subscribe subs;
1974	struct snd_seq_subscribers *p;
1975
1976	if (copy_from_user(&subs, arg, sizeof(subs)))
1977		return -EFAULT;
1978
1979	result = -EINVAL;
1980	if ((sender = snd_seq_client_use_ptr(subs.sender.client)) == NULL)
1981		goto __end;
1982	if ((sport = snd_seq_port_use_ptr(sender, subs.sender.port)) == NULL)
1983		goto __end;
1984	p = snd_seq_port_get_subscription(&sport->c_src, &subs.dest);
1985	if (p) {
1986		result = 0;
1987		subs = p->info;
1988	} else
1989		result = -ENOENT;
1990
1991      __end:
1992      	if (sport)
1993		snd_seq_port_unlock(sport);
1994	if (sender)
1995		snd_seq_client_unlock(sender);
1996	if (result >= 0) {
1997		if (copy_to_user(arg, &subs, sizeof(subs)))
1998			return -EFAULT;
1999	}
2000	return result;
2001}
2002
2003
2004/*
2005 * get subscription info - check only its presence
2006 */
2007static int snd_seq_ioctl_query_subs(struct snd_seq_client *client,
2008				    void __user *arg)
2009{
2010	int result = -ENXIO;
2011	struct snd_seq_client *cptr = NULL;
2012	struct snd_seq_client_port *port = NULL;
2013	struct snd_seq_query_subs subs;
2014	struct snd_seq_port_subs_info *group;
2015	struct list_head *p;
2016	int i;
2017
2018	if (copy_from_user(&subs, arg, sizeof(subs)))
2019		return -EFAULT;
2020
2021	if ((cptr = snd_seq_client_use_ptr(subs.root.client)) == NULL)
2022		goto __end;
2023	if ((port = snd_seq_port_use_ptr(cptr, subs.root.port)) == NULL)
2024		goto __end;
2025
2026	switch (subs.type) {
2027	case SNDRV_SEQ_QUERY_SUBS_READ:
2028		group = &port->c_src;
2029		break;
2030	case SNDRV_SEQ_QUERY_SUBS_WRITE:
2031		group = &port->c_dest;
2032		break;
2033	default:
2034		goto __end;
2035	}
2036
2037	down_read(&group->list_mutex);
2038	/* search for the subscriber */
2039	subs.num_subs = group->count;
2040	i = 0;
2041	result = -ENOENT;
2042	list_for_each(p, &group->list_head) {
2043		if (i++ == subs.index) {
2044			/* found! */
2045			struct snd_seq_subscribers *s;
2046			if (subs.type == SNDRV_SEQ_QUERY_SUBS_READ) {
2047				s = list_entry(p, struct snd_seq_subscribers, src_list);
2048				subs.addr = s->info.dest;
2049			} else {
2050				s = list_entry(p, struct snd_seq_subscribers, dest_list);
2051				subs.addr = s->info.sender;
2052			}
2053			subs.flags = s->info.flags;
2054			subs.queue = s->info.queue;
2055			result = 0;
2056			break;
2057		}
2058	}
2059	up_read(&group->list_mutex);
2060
2061      __end:
2062   	if (port)
2063		snd_seq_port_unlock(port);
2064	if (cptr)
2065		snd_seq_client_unlock(cptr);
2066	if (result >= 0) {
2067		if (copy_to_user(arg, &subs, sizeof(subs)))
2068			return -EFAULT;
2069	}
2070	return result;
2071}
2072
2073
2074/*
2075 * query next client
2076 */
2077static int snd_seq_ioctl_query_next_client(struct snd_seq_client *client,
2078					   void __user *arg)
2079{
2080	struct snd_seq_client *cptr = NULL;
2081	struct snd_seq_client_info info;
2082
2083	if (copy_from_user(&info, arg, sizeof(info)))
2084		return -EFAULT;
2085
2086	/* search for next client */
2087	info.client++;
2088	if (info.client < 0)
2089		info.client = 0;
2090	for (; info.client < SNDRV_SEQ_MAX_CLIENTS; info.client++) {
2091		cptr = snd_seq_client_use_ptr(info.client);
2092		if (cptr)
2093			break; /* found */
2094	}
2095	if (cptr == NULL)
2096		return -ENOENT;
2097
2098	get_client_info(cptr, &info);
2099	snd_seq_client_unlock(cptr);
2100
2101	if (copy_to_user(arg, &info, sizeof(info)))
2102		return -EFAULT;
2103	return 0;
2104}
2105
2106/* 
2107 * query next port
2108 */
2109static int snd_seq_ioctl_query_next_port(struct snd_seq_client *client,
2110					 void __user *arg)
2111{
2112	struct snd_seq_client *cptr;
2113	struct snd_seq_client_port *port = NULL;
2114	struct snd_seq_port_info info;
2115
2116	if (copy_from_user(&info, arg, sizeof(info)))
2117		return -EFAULT;
2118	cptr = snd_seq_client_use_ptr(info.addr.client);
2119	if (cptr == NULL)
2120		return -ENXIO;
2121
2122	/* search for next port */
2123	info.addr.port++;
2124	port = snd_seq_port_query_nearest(cptr, &info);
2125	if (port == NULL) {
2126		snd_seq_client_unlock(cptr);
2127		return -ENOENT;
2128	}
2129
2130	/* get port info */
2131	info.addr = port->addr;
2132	snd_seq_get_port_info(port, &info);
2133	snd_seq_port_unlock(port);
2134	snd_seq_client_unlock(cptr);
2135
2136	if (copy_to_user(arg, &info, sizeof(info)))
2137		return -EFAULT;
2138	return 0;
2139}
2140
2141/* -------------------------------------------------------- */
2142
2143static struct seq_ioctl_table {
2144	unsigned int cmd;
2145	int (*func)(struct snd_seq_client *client, void __user * arg);
2146} ioctl_tables[] = {
2147	{ SNDRV_SEQ_IOCTL_SYSTEM_INFO, snd_seq_ioctl_system_info },
2148	{ SNDRV_SEQ_IOCTL_RUNNING_MODE, snd_seq_ioctl_running_mode },
2149	{ SNDRV_SEQ_IOCTL_GET_CLIENT_INFO, snd_seq_ioctl_get_client_info },
2150	{ SNDRV_SEQ_IOCTL_SET_CLIENT_INFO, snd_seq_ioctl_set_client_info },
2151	{ SNDRV_SEQ_IOCTL_CREATE_PORT, snd_seq_ioctl_create_port },
2152	{ SNDRV_SEQ_IOCTL_DELETE_PORT, snd_seq_ioctl_delete_port },
2153	{ SNDRV_SEQ_IOCTL_GET_PORT_INFO, snd_seq_ioctl_get_port_info },
2154	{ SNDRV_SEQ_IOCTL_SET_PORT_INFO, snd_seq_ioctl_set_port_info },
2155	{ SNDRV_SEQ_IOCTL_SUBSCRIBE_PORT, snd_seq_ioctl_subscribe_port },
2156	{ SNDRV_SEQ_IOCTL_UNSUBSCRIBE_PORT, snd_seq_ioctl_unsubscribe_port },
2157	{ SNDRV_SEQ_IOCTL_CREATE_QUEUE, snd_seq_ioctl_create_queue },
2158	{ SNDRV_SEQ_IOCTL_DELETE_QUEUE, snd_seq_ioctl_delete_queue },
2159	{ SNDRV_SEQ_IOCTL_GET_QUEUE_INFO, snd_seq_ioctl_get_queue_info },
2160	{ SNDRV_SEQ_IOCTL_SET_QUEUE_INFO, snd_seq_ioctl_set_queue_info },
2161	{ SNDRV_SEQ_IOCTL_GET_NAMED_QUEUE, snd_seq_ioctl_get_named_queue },
2162	{ SNDRV_SEQ_IOCTL_GET_QUEUE_STATUS, snd_seq_ioctl_get_queue_status },
2163	{ SNDRV_SEQ_IOCTL_GET_QUEUE_TEMPO, snd_seq_ioctl_get_queue_tempo },
2164	{ SNDRV_SEQ_IOCTL_SET_QUEUE_TEMPO, snd_seq_ioctl_set_queue_tempo },
2165	{ SNDRV_SEQ_IOCTL_GET_QUEUE_TIMER, snd_seq_ioctl_get_queue_timer },
2166	{ SNDRV_SEQ_IOCTL_SET_QUEUE_TIMER, snd_seq_ioctl_set_queue_timer },
2167	{ SNDRV_SEQ_IOCTL_GET_QUEUE_CLIENT, snd_seq_ioctl_get_queue_client },
2168	{ SNDRV_SEQ_IOCTL_SET_QUEUE_CLIENT, snd_seq_ioctl_set_queue_client },
2169	{ SNDRV_SEQ_IOCTL_GET_CLIENT_POOL, snd_seq_ioctl_get_client_pool },
2170	{ SNDRV_SEQ_IOCTL_SET_CLIENT_POOL, snd_seq_ioctl_set_client_pool },
2171	{ SNDRV_SEQ_IOCTL_GET_SUBSCRIPTION, snd_seq_ioctl_get_subscription },
2172	{ SNDRV_SEQ_IOCTL_QUERY_NEXT_CLIENT, snd_seq_ioctl_query_next_client },
2173	{ SNDRV_SEQ_IOCTL_QUERY_NEXT_PORT, snd_seq_ioctl_query_next_port },
2174	{ SNDRV_SEQ_IOCTL_REMOVE_EVENTS, snd_seq_ioctl_remove_events },
2175	{ SNDRV_SEQ_IOCTL_QUERY_SUBS, snd_seq_ioctl_query_subs },
2176	{ 0, NULL },
2177};
2178
2179static int snd_seq_do_ioctl(struct snd_seq_client *client, unsigned int cmd,
2180			    void __user *arg)
2181{
2182	struct seq_ioctl_table *p;
2183
2184	switch (cmd) {
2185	case SNDRV_SEQ_IOCTL_PVERSION:
2186		/* return sequencer version number */
2187		return put_user(SNDRV_SEQ_VERSION, (int __user *)arg) ? -EFAULT : 0;
2188	case SNDRV_SEQ_IOCTL_CLIENT_ID:
2189		/* return the id of this client */
2190		return put_user(client->number, (int __user *)arg) ? -EFAULT : 0;
2191	}
2192
2193	if (! arg)
2194		return -EFAULT;
2195	for (p = ioctl_tables; p->cmd; p++) {
2196		if (p->cmd == cmd)
2197			return p->func(client, arg);
2198	}
2199	snd_printd("seq unknown ioctl() 0x%x (type='%c', number=0x%02x)\n",
2200		   cmd, _IOC_TYPE(cmd), _IOC_NR(cmd));
2201	return -ENOTTY;
2202}
2203
2204
2205static long snd_seq_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
2206{
2207	struct snd_seq_client *client = file->private_data;
2208
2209	if (snd_BUG_ON(!client))
2210		return -ENXIO;
2211		
2212	return snd_seq_do_ioctl(client, cmd, (void __user *) arg);
2213}
2214
2215#ifdef CONFIG_COMPAT
2216#include "seq_compat.c"
2217#else
2218#define snd_seq_ioctl_compat	NULL
2219#endif
2220
2221/* -------------------------------------------------------- */
2222
2223
2224/* exported to kernel modules */
2225int snd_seq_create_kernel_client(struct snd_card *card, int client_index,
2226				 const char *name_fmt, ...)
2227{
2228	struct snd_seq_client *client;
2229	va_list args;
2230
2231	if (snd_BUG_ON(in_interrupt()))
2232		return -EBUSY;
2233
2234	if (card && client_index >= SNDRV_SEQ_CLIENTS_PER_CARD)
2235		return -EINVAL;
2236	if (card == NULL && client_index >= SNDRV_SEQ_GLOBAL_CLIENTS)
2237		return -EINVAL;
2238
2239	if (mutex_lock_interruptible(&register_mutex))
2240		return -ERESTARTSYS;
2241
2242	if (card) {
2243		client_index += SNDRV_SEQ_GLOBAL_CLIENTS
2244			+ card->number * SNDRV_SEQ_CLIENTS_PER_CARD;
2245		if (client_index >= SNDRV_SEQ_DYNAMIC_CLIENTS_BEGIN)
2246			client_index = -1;
2247	}
2248
2249	/* empty write queue as default */
2250	client = seq_create_client1(client_index, 0);
2251	if (client == NULL) {
2252		mutex_unlock(&register_mutex);
2253		return -EBUSY;	/* failure code */
2254	}
2255	usage_alloc(&client_usage, 1);
2256
2257	client->accept_input = 1;
2258	client->accept_output = 1;
2259		
2260	va_start(args, name_fmt);
2261	vsnprintf(client->name, sizeof(client->name), name_fmt, args);
2262	va_end(args);
2263
2264	client->type = KERNEL_CLIENT;
2265	mutex_unlock(&register_mutex);
2266
2267	/* make others aware this new client */
2268	snd_seq_system_client_ev_client_start(client->number);
2269	
2270	/* return client number to caller */
2271	return client->number;
2272}
2273
2274EXPORT_SYMBOL(snd_seq_create_kernel_client);
2275
2276/* exported to kernel modules */
2277int snd_seq_delete_kernel_client(int client)
2278{
2279	struct snd_seq_client *ptr;
2280
2281	if (snd_BUG_ON(in_interrupt()))
2282		return -EBUSY;
2283
2284	ptr = clientptr(client);
2285	if (ptr == NULL)
2286		return -EINVAL;
2287
2288	seq_free_client(ptr);
2289	kfree(ptr);
2290	return 0;
2291}
2292
2293EXPORT_SYMBOL(snd_seq_delete_kernel_client);
2294
2295/* skeleton to enqueue event, called from snd_seq_kernel_client_enqueue
2296 * and snd_seq_kernel_client_enqueue_blocking
2297 */
2298static int kernel_client_enqueue(int client, struct snd_seq_event *ev,
2299				 struct file *file, int blocking,
2300				 int atomic, int hop)
2301{
2302	struct snd_seq_client *cptr;
2303	int result;
2304
2305	if (snd_BUG_ON(!ev))
2306		return -EINVAL;
2307
2308	if (ev->type == SNDRV_SEQ_EVENT_NONE)
2309		return 0; /* ignore this */
2310	if (ev->type == SNDRV_SEQ_EVENT_KERNEL_ERROR)
2311		return -EINVAL; /* quoted events can't be enqueued */
2312
2313	/* fill in client number */
2314	ev->source.client = client;
2315
2316	if (check_event_type_and_length(ev))
2317		return -EINVAL;
2318
2319	cptr = snd_seq_client_use_ptr(client);
2320	if (cptr == NULL)
2321		return -EINVAL;
2322	
2323	if (! cptr->accept_output)
2324		result = -EPERM;
2325	else /* send it */
2326		result = snd_seq_client_enqueue_event(cptr, ev, file, blocking, atomic, hop);
2327
2328	snd_seq_client_unlock(cptr);
2329	return result;
2330}
2331
2332/*
2333 * exported, called by kernel clients to enqueue events (w/o blocking)
2334 *
2335 * RETURN VALUE: zero if succeed, negative if error
2336 */
2337int snd_seq_kernel_client_enqueue(int client, struct snd_seq_event * ev,
2338				  int atomic, int hop)
2339{
2340	return kernel_client_enqueue(client, ev, NULL, 0, atomic, hop);
2341}
2342
2343EXPORT_SYMBOL(snd_seq_kernel_client_enqueue);
2344
2345/*
2346 * exported, called by kernel clients to enqueue events (with blocking)
2347 *
2348 * RETURN VALUE: zero if succeed, negative if error
2349 */
2350int snd_seq_kernel_client_enqueue_blocking(int client, struct snd_seq_event * ev,
2351					   struct file *file,
2352					   int atomic, int hop)
2353{
2354	return kernel_client_enqueue(client, ev, file, 1, atomic, hop);
2355}
2356
2357EXPORT_SYMBOL(snd_seq_kernel_client_enqueue_blocking);
2358
2359/* 
2360 * exported, called by kernel clients to dispatch events directly to other
2361 * clients, bypassing the queues.  Event time-stamp will be updated.
2362 *
2363 * RETURN VALUE: negative = delivery failed,
2364 *		 zero, or positive: the number of delivered events
2365 */
2366int snd_seq_kernel_client_dispatch(int client, struct snd_seq_event * ev,
2367				   int atomic, int hop)
2368{
2369	struct snd_seq_client *cptr;
2370	int result;
2371
2372	if (snd_BUG_ON(!ev))
2373		return -EINVAL;
2374
2375	/* fill in client number */
2376	ev->queue = SNDRV_SEQ_QUEUE_DIRECT;
2377	ev->source.client = client;
2378
2379	if (check_event_type_and_length(ev))
2380		return -EINVAL;
2381
2382	cptr = snd_seq_client_use_ptr(client);
2383	if (cptr == NULL)
2384		return -EINVAL;
2385
2386	if (!cptr->accept_output)
2387		result = -EPERM;
2388	else
2389		result = snd_seq_deliver_event(cptr, ev, atomic, hop);
2390
2391	snd_seq_client_unlock(cptr);
2392	return result;
2393}
2394
2395EXPORT_SYMBOL(snd_seq_kernel_client_dispatch);
2396
2397/*
2398 * exported, called by kernel clients to perform same functions as with
2399 * userland ioctl() 
2400 */
2401int snd_seq_kernel_client_ctl(int clientid, unsigned int cmd, void *arg)
2402{
2403	struct snd_seq_client *client;
2404	mm_segment_t fs;
2405	int result;
2406
2407	client = clientptr(clientid);
2408	if (client == NULL)
2409		return -ENXIO;
2410	fs = snd_enter_user();
2411	result = snd_seq_do_ioctl(client, cmd, (void __force __user *)arg);
2412	snd_leave_user(fs);
2413	return result;
2414}
2415
2416EXPORT_SYMBOL(snd_seq_kernel_client_ctl);
2417
2418/* exported (for OSS emulator) */
2419int snd_seq_kernel_client_write_poll(int clientid, struct file *file, poll_table *wait)
2420{
2421	struct snd_seq_client *client;
2422
2423	client = clientptr(clientid);
2424	if (client == NULL)
2425		return -ENXIO;
2426
2427	if (! snd_seq_write_pool_allocated(client))
2428		return 1;
2429	if (snd_seq_pool_poll_wait(client->pool, file, wait))
2430		return 1;
2431	return 0;
2432}
2433
2434EXPORT_SYMBOL(snd_seq_kernel_client_write_poll);
2435
2436/*---------------------------------------------------------------------------*/
2437
2438#ifdef CONFIG_PROC_FS
2439/*
2440 *  /proc interface
2441 */
2442static void snd_seq_info_dump_subscribers(struct snd_info_buffer *buffer,
2443					  struct snd_seq_port_subs_info *group,
2444					  int is_src, char *msg)
2445{
2446	struct list_head *p;
2447	struct snd_seq_subscribers *s;
2448	int count = 0;
2449
2450	down_read(&group->list_mutex);
2451	if (list_empty(&group->list_head)) {
2452		up_read(&group->list_mutex);
2453		return;
2454	}
2455	snd_iprintf(buffer, msg);
2456	list_for_each(p, &group->list_head) {
2457		if (is_src)
2458			s = list_entry(p, struct snd_seq_subscribers, src_list);
2459		else
2460			s = list_entry(p, struct snd_seq_subscribers, dest_list);
2461		if (count++)
2462			snd_iprintf(buffer, ", ");
2463		snd_iprintf(buffer, "%d:%d",
2464			    is_src ? s->info.dest.client : s->info.sender.client,
2465			    is_src ? s->info.dest.port : s->info.sender.port);
2466		if (s->info.flags & SNDRV_SEQ_PORT_SUBS_TIMESTAMP)
2467			snd_iprintf(buffer, "[%c:%d]", ((s->info.flags & SNDRV_SEQ_PORT_SUBS_TIME_REAL) ? 'r' : 't'), s->info.queue);
2468		if (group->exclusive)
2469			snd_iprintf(buffer, "[ex]");
2470	}
2471	up_read(&group->list_mutex);
2472	snd_iprintf(buffer, "\n");
2473}
2474
2475#define FLAG_PERM_RD(perm) ((perm) & SNDRV_SEQ_PORT_CAP_READ ? ((perm) & SNDRV_SEQ_PORT_CAP_SUBS_READ ? 'R' : 'r') : '-')
2476#define FLAG_PERM_WR(perm) ((perm) & SNDRV_SEQ_PORT_CAP_WRITE ? ((perm) & SNDRV_SEQ_PORT_CAP_SUBS_WRITE ? 'W' : 'w') : '-')
2477#define FLAG_PERM_EX(perm) ((perm) & SNDRV_SEQ_PORT_CAP_NO_EXPORT ? '-' : 'e')
2478
2479#define FLAG_PERM_DUPLEX(perm) ((perm) & SNDRV_SEQ_PORT_CAP_DUPLEX ? 'X' : '-')
2480
2481static void snd_seq_info_dump_ports(struct snd_info_buffer *buffer,
2482				    struct snd_seq_client *client)
2483{
2484	struct snd_seq_client_port *p;
2485
2486	mutex_lock(&client->ports_mutex);
2487	list_for_each_entry(p, &client->ports_list_head, list) {
2488		snd_iprintf(buffer, "  Port %3d : \"%s\" (%c%c%c%c)\n",
2489			    p->addr.port, p->name,
2490			    FLAG_PERM_RD(p->capability),
2491			    FLAG_PERM_WR(p->capability),
2492			    FLAG_PERM_EX(p->capability),
2493			    FLAG_PERM_DUPLEX(p->capability));
2494		snd_seq_info_dump_subscribers(buffer, &p->c_src, 1, "    Connecting To: ");
2495		snd_seq_info_dump_subscribers(buffer, &p->c_dest, 0, "    Connected From: ");
2496	}
2497	mutex_unlock(&client->ports_mutex);
2498}
2499
2500
2501/* exported to seq_info.c */
2502void snd_seq_info_clients_read(struct snd_info_entry *entry, 
2503			       struct snd_info_buffer *buffer)
2504{
2505	int c;
2506	struct snd_seq_client *client;
2507
2508	snd_iprintf(buffer, "Client info\n");
2509	snd_iprintf(buffer, "  cur  clients : %d\n", client_usage.cur);
2510	snd_iprintf(buffer, "  peak clients : %d\n", client_usage.peak);
2511	snd_iprintf(buffer, "  max  clients : %d\n", SNDRV_SEQ_MAX_CLIENTS);
2512	snd_iprintf(buffer, "\n");
2513
2514	/* list the client table */
2515	for (c = 0; c < SNDRV_SEQ_MAX_CLIENTS; c++) {
2516		client = snd_seq_client_use_ptr(c);
2517		if (client == NULL)
2518			continue;
2519		if (client->type == NO_CLIENT) {
2520			snd_seq_client_unlock(client);
2521			continue;
2522		}
2523
2524		snd_iprintf(buffer, "Client %3d : \"%s\" [%s]\n",
2525			    c, client->name,
2526			    client->type == USER_CLIENT ? "User" : "Kernel");
2527		snd_seq_info_dump_ports(buffer, client);
2528		if (snd_seq_write_pool_allocated(client)) {
2529			snd_iprintf(buffer, "  Output pool :\n");
2530			snd_seq_info_pool(buffer, client->pool, "    ");
2531		}
2532		if (client->type == USER_CLIENT && client->data.user.fifo &&
2533		    client->data.user.fifo->pool) {
2534			snd_iprintf(buffer, "  Input pool :\n");
2535			snd_seq_info_pool(buffer, client->data.user.fifo->pool, "    ");
2536		}
2537		snd_seq_client_unlock(client);
2538	}
2539}
2540#endif /* CONFIG_PROC_FS */
2541
2542/*---------------------------------------------------------------------------*/
2543
2544
2545/*
2546 *  REGISTRATION PART
2547 */
2548
2549static const struct file_operations snd_seq_f_ops =
2550{
2551	.owner =	THIS_MODULE,
2552	.read =		snd_seq_read,
2553	.write =	snd_seq_write,
2554	.open =		snd_seq_open,
2555	.release =	snd_seq_release,
2556	.llseek =	no_llseek,
2557	.poll =		snd_seq_poll,
2558	.unlocked_ioctl =	snd_seq_ioctl,
2559	.compat_ioctl =	snd_seq_ioctl_compat,
2560};
2561
2562/* 
2563 * register sequencer device 
2564 */
2565int __init snd_sequencer_device_init(void)
2566{
2567	int err;
2568
2569	if (mutex_lock_interruptible(&register_mutex))
2570		return -ERESTARTSYS;
2571
2572	if ((err = snd_register_device(SNDRV_DEVICE_TYPE_SEQUENCER, NULL, 0,
2573				       &snd_seq_f_ops, NULL, "seq")) < 0) {
2574		mutex_unlock(&register_mutex);
2575		return err;
2576	}
2577	
2578	mutex_unlock(&register_mutex);
2579
2580	return 0;
2581}
2582
2583
2584
2585/* 
2586 * unregister sequencer device 
2587 */
2588void __exit snd_sequencer_device_done(void)
2589{
2590	snd_unregister_device(SNDRV_DEVICE_TYPE_SEQUENCER, NULL, 0);
2591}