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		pr_debug("ALSA: 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		pr_debug("ALSA: 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		pr_warn("ALSA: 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		pr_err("ALSA: 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, result = 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		/* both ports ready? */
682		if (atomic_read(&subs->ref_count) != 2)
683			continue;
684		event->dest = subs->info.dest;
685		if (subs->info.flags & SNDRV_SEQ_PORT_SUBS_TIMESTAMP)
686			/* convert time according to flag with subscription */
687			update_timestamp_of_queue(event, subs->info.queue,
688						  subs->info.flags & SNDRV_SEQ_PORT_SUBS_TIME_REAL);
689		err = snd_seq_deliver_single_event(client, event,
690						   0, atomic, hop);
691		if (err < 0) {
692			/* save first error that occurs and continue */
693			if (!result)
694				result = err;
695			continue;
696		}
697		num_ev++;
698		/* restore original event record */
699		*event = event_saved;
700	}
701	if (atomic)
702		read_unlock(&grp->list_lock);
703	else
704		up_read(&grp->list_mutex);
705	*event = event_saved; /* restore */
706	snd_seq_port_unlock(src_port);
707	return (result < 0) ? result : num_ev;
708}
709
710
711#ifdef SUPPORT_BROADCAST
712/*
713 * broadcast to all ports:
714 */
715static int port_broadcast_event(struct snd_seq_client *client,
716				struct snd_seq_event *event,
717				int atomic, int hop)
718{
719	int num_ev = 0, err, result = 0;
720	struct snd_seq_client *dest_client;
721	struct snd_seq_client_port *port;
722
723	dest_client = get_event_dest_client(event, SNDRV_SEQ_FILTER_BROADCAST);
724	if (dest_client == NULL)
725		return 0; /* no matching destination */
726
727	read_lock(&dest_client->ports_lock);
728	list_for_each_entry(port, &dest_client->ports_list_head, list) {
729		event->dest.port = port->addr.port;
730		/* pass NULL as source client to avoid error bounce */
731		err = snd_seq_deliver_single_event(NULL, event,
732						   SNDRV_SEQ_FILTER_BROADCAST,
733						   atomic, hop);
734		if (err < 0) {
735			/* save first error that occurs and continue */
736			if (!result)
737				result = err;
738			continue;
739		}
740		num_ev++;
741	}
742	read_unlock(&dest_client->ports_lock);
743	snd_seq_client_unlock(dest_client);
744	event->dest.port = SNDRV_SEQ_ADDRESS_BROADCAST; /* restore */
745	return (result < 0) ? result : num_ev;
746}
747
748/*
749 * send the event to all clients:
750 * if destination port is also ADDRESS_BROADCAST, deliver to all ports.
751 */
752static int broadcast_event(struct snd_seq_client *client,
753			   struct snd_seq_event *event, int atomic, int hop)
754{
755	int err, result = 0, num_ev = 0;
756	int dest;
757	struct snd_seq_addr addr;
758
759	addr = event->dest; /* save */
760
761	for (dest = 0; dest < SNDRV_SEQ_MAX_CLIENTS; dest++) {
762		/* don't send to itself */
763		if (dest == client->number)
764			continue;
765		event->dest.client = dest;
766		event->dest.port = addr.port;
767		if (addr.port == SNDRV_SEQ_ADDRESS_BROADCAST)
768			err = port_broadcast_event(client, event, atomic, hop);
769		else
770			/* pass NULL as source client to avoid error bounce */
771			err = snd_seq_deliver_single_event(NULL, event,
772							   SNDRV_SEQ_FILTER_BROADCAST,
773							   atomic, hop);
774		if (err < 0) {
775			/* save first error that occurs and continue */
776			if (!result)
777				result = err;
778			continue;
779		}
780		num_ev += err;
781	}
782	event->dest = addr; /* restore */
783	return (result < 0) ? result : num_ev;
784}
785
786
787/* multicast - not supported yet */
788static int multicast_event(struct snd_seq_client *client, struct snd_seq_event *event,
789			   int atomic, int hop)
790{
791	pr_debug("ALSA: seq: multicast not supported yet.\n");
792	return 0; /* ignored */
793}
794#endif /* SUPPORT_BROADCAST */
795
796
797/* deliver an event to the destination port(s).
798 * if the event is to subscribers or broadcast, the event is dispatched
799 * to multiple targets.
800 *
801 * RETURN VALUE: n > 0  : the number of delivered events.
802 *               n == 0 : the event was not passed to any client.
803 *               n < 0  : error - event was not processed.
804 */
805static int snd_seq_deliver_event(struct snd_seq_client *client, struct snd_seq_event *event,
806				 int atomic, int hop)
807{
808	int result;
809
810	hop++;
811	if (hop >= SNDRV_SEQ_MAX_HOPS) {
812		pr_debug("ALSA: seq: too long delivery path (%d:%d->%d:%d)\n",
813			   event->source.client, event->source.port,
814			   event->dest.client, event->dest.port);
815		return -EMLINK;
816	}
817
818	if (event->queue == SNDRV_SEQ_ADDRESS_SUBSCRIBERS ||
819	    event->dest.client == SNDRV_SEQ_ADDRESS_SUBSCRIBERS)
820		result = deliver_to_subscribers(client, event, atomic, hop);
821#ifdef SUPPORT_BROADCAST
822	else if (event->queue == SNDRV_SEQ_ADDRESS_BROADCAST ||
823		 event->dest.client == SNDRV_SEQ_ADDRESS_BROADCAST)
824		result = broadcast_event(client, event, atomic, hop);
825	else if (event->dest.client >= SNDRV_SEQ_MAX_CLIENTS)
826		result = multicast_event(client, event, atomic, hop);
827	else if (event->dest.port == SNDRV_SEQ_ADDRESS_BROADCAST)
828		result = port_broadcast_event(client, event, atomic, hop);
829#endif
830	else
831		result = snd_seq_deliver_single_event(client, event, 0, atomic, hop);
832
833	return result;
834}
835
836/*
837 * dispatch an event cell:
838 * This function is called only from queue check routines in timer
839 * interrupts or after enqueued.
840 * The event cell shall be released or re-queued in this function.
841 *
842 * RETURN VALUE: n > 0  : the number of delivered events.
843 *		 n == 0 : the event was not passed to any client.
844 *		 n < 0  : error - event was not processed.
845 */
846int snd_seq_dispatch_event(struct snd_seq_event_cell *cell, int atomic, int hop)
847{
848	struct snd_seq_client *client;
849	int result;
850
851	if (snd_BUG_ON(!cell))
852		return -EINVAL;
853
854	client = snd_seq_client_use_ptr(cell->event.source.client);
855	if (client == NULL) {
856		snd_seq_cell_free(cell); /* release this cell */
857		return -EINVAL;
858	}
859
860	if (cell->event.type == SNDRV_SEQ_EVENT_NOTE) {
861		/* NOTE event:
862		 * the event cell is re-used as a NOTE-OFF event and
863		 * enqueued again.
864		 */
865		struct snd_seq_event tmpev, *ev;
866
867		/* reserve this event to enqueue note-off later */
868		tmpev = cell->event;
869		tmpev.type = SNDRV_SEQ_EVENT_NOTEON;
870		result = snd_seq_deliver_event(client, &tmpev, atomic, hop);
871
872		/*
873		 * This was originally a note event.  We now re-use the
874		 * cell for the note-off event.
875		 */
876
877		ev = &cell->event;
878		ev->type = SNDRV_SEQ_EVENT_NOTEOFF;
879		ev->flags |= SNDRV_SEQ_PRIORITY_HIGH;
880
881		/* add the duration time */
882		switch (ev->flags & SNDRV_SEQ_TIME_STAMP_MASK) {
883		case SNDRV_SEQ_TIME_STAMP_TICK:
884			ev->time.tick += ev->data.note.duration;
885			break;
886		case SNDRV_SEQ_TIME_STAMP_REAL:
887			/* unit for duration is ms */
888			ev->time.time.tv_nsec += 1000000 * (ev->data.note.duration % 1000);
889			ev->time.time.tv_sec += ev->data.note.duration / 1000 +
890						ev->time.time.tv_nsec / 1000000000;
891			ev->time.time.tv_nsec %= 1000000000;
892			break;
893		}
894		ev->data.note.velocity = ev->data.note.off_velocity;
895
896		/* Now queue this cell as the note off event */
897		if (snd_seq_enqueue_event(cell, atomic, hop) < 0)
898			snd_seq_cell_free(cell); /* release this cell */
899
900	} else {
901		/* Normal events:
902		 * event cell is freed after processing the event
903		 */
904
905		result = snd_seq_deliver_event(client, &cell->event, atomic, hop);
906		snd_seq_cell_free(cell);
907	}
908
909	snd_seq_client_unlock(client);
910	return result;
911}
912
913
914/* Allocate a cell from client pool and enqueue it to queue:
915 * if pool is empty and blocking is TRUE, sleep until a new cell is
916 * available.
917 */
918static int snd_seq_client_enqueue_event(struct snd_seq_client *client,
919					struct snd_seq_event *event,
920					struct file *file, int blocking,
921					int atomic, int hop)
922{
923	struct snd_seq_event_cell *cell;
924	int err;
925
926	/* special queue values - force direct passing */
927	if (event->queue == SNDRV_SEQ_ADDRESS_SUBSCRIBERS) {
928		event->dest.client = SNDRV_SEQ_ADDRESS_SUBSCRIBERS;
929		event->queue = SNDRV_SEQ_QUEUE_DIRECT;
930	} else
931#ifdef SUPPORT_BROADCAST
932		if (event->queue == SNDRV_SEQ_ADDRESS_BROADCAST) {
933			event->dest.client = SNDRV_SEQ_ADDRESS_BROADCAST;
934			event->queue = SNDRV_SEQ_QUEUE_DIRECT;
935		}
936#endif
937	if (event->dest.client == SNDRV_SEQ_ADDRESS_SUBSCRIBERS) {
938		/* check presence of source port */
939		struct snd_seq_client_port *src_port = snd_seq_port_use_ptr(client, event->source.port);
940		if (src_port == NULL)
941			return -EINVAL;
942		snd_seq_port_unlock(src_port);
943	}
944
945	/* direct event processing without enqueued */
946	if (snd_seq_ev_is_direct(event)) {
947		if (event->type == SNDRV_SEQ_EVENT_NOTE)
948			return -EINVAL; /* this event must be enqueued! */
949		return snd_seq_deliver_event(client, event, atomic, hop);
950	}
951
952	/* Not direct, normal queuing */
953	if (snd_seq_queue_is_used(event->queue, client->number) <= 0)
954		return -EINVAL;  /* invalid queue */
955	if (! snd_seq_write_pool_allocated(client))
956		return -ENXIO; /* queue is not allocated */
957
958	/* allocate an event cell */
959	err = snd_seq_event_dup(client->pool, event, &cell, !blocking || atomic, file);
960	if (err < 0)
961		return err;
962
963	/* we got a cell. enqueue it. */
964	if ((err = snd_seq_enqueue_event(cell, atomic, hop)) < 0) {
965		snd_seq_cell_free(cell);
966		return err;
967	}
968
969	return 0;
970}
971
972
973/*
974 * check validity of event type and data length.
975 * return non-zero if invalid.
976 */
977static int check_event_type_and_length(struct snd_seq_event *ev)
978{
979	switch (snd_seq_ev_length_type(ev)) {
980	case SNDRV_SEQ_EVENT_LENGTH_FIXED:
981		if (snd_seq_ev_is_variable_type(ev))
982			return -EINVAL;
983		break;
984	case SNDRV_SEQ_EVENT_LENGTH_VARIABLE:
985		if (! snd_seq_ev_is_variable_type(ev) ||
986		    (ev->data.ext.len & ~SNDRV_SEQ_EXT_MASK) >= SNDRV_SEQ_MAX_EVENT_LEN)
987			return -EINVAL;
988		break;
989	case SNDRV_SEQ_EVENT_LENGTH_VARUSR:
990		if (! snd_seq_ev_is_direct(ev))
991			return -EINVAL;
992		break;
993	}
994	return 0;
995}
996
997
998/* handle write() */
999/* possible error values:
1000 *	-ENXIO	invalid client or file open mode
1001 *	-ENOMEM	malloc failed
1002 *	-EFAULT	seg. fault during copy from user space
1003 *	-EINVAL	invalid event
1004 *	-EAGAIN	no space in output pool
1005 *	-EINTR	interrupts while sleep
1006 *	-EMLINK	too many hops
1007 *	others	depends on return value from driver callback
1008 */
1009static ssize_t snd_seq_write(struct file *file, const char __user *buf,
1010			     size_t count, loff_t *offset)
1011{
1012	struct snd_seq_client *client = file->private_data;
1013	int written = 0, len;
1014	int err = -EINVAL;
1015	struct snd_seq_event event;
1016
1017	if (!(snd_seq_file_flags(file) & SNDRV_SEQ_LFLG_OUTPUT))
1018		return -ENXIO;
1019
1020	/* check client structures are in place */
1021	if (snd_BUG_ON(!client))
1022		return -ENXIO;
1023
1024	if (!client->accept_output || client->pool == NULL)
1025		return -ENXIO;
1026
1027	/* allocate the pool now if the pool is not allocated yet */
1028	if (client->pool->size > 0 && !snd_seq_write_pool_allocated(client)) {
1029		if (snd_seq_pool_init(client->pool) < 0)
1030			return -ENOMEM;
1031	}
1032
1033	/* only process whole events */
1034	while (count >= sizeof(struct snd_seq_event)) {
1035		/* Read in the event header from the user */
1036		len = sizeof(event);
1037		if (copy_from_user(&event, buf, len)) {
1038			err = -EFAULT;
1039			break;
1040		}
1041		event.source.client = client->number;	/* fill in client number */
1042		/* Check for extension data length */
1043		if (check_event_type_and_length(&event)) {
1044			err = -EINVAL;
1045			break;
1046		}
1047
1048		/* check for special events */
1049		if (event.type == SNDRV_SEQ_EVENT_NONE)
1050			goto __skip_event;
1051		else if (snd_seq_ev_is_reserved(&event)) {
1052			err = -EINVAL;
1053			break;
1054		}
1055
1056		if (snd_seq_ev_is_variable(&event)) {
1057			int extlen = event.data.ext.len & ~SNDRV_SEQ_EXT_MASK;
1058			if ((size_t)(extlen + len) > count) {
1059				/* back out, will get an error this time or next */
1060				err = -EINVAL;
1061				break;
1062			}
1063			/* set user space pointer */
1064			event.data.ext.len = extlen | SNDRV_SEQ_EXT_USRPTR;
1065			event.data.ext.ptr = (char __force *)buf
1066						+ sizeof(struct snd_seq_event);
1067			len += extlen; /* increment data length */
1068		} else {
1069#ifdef CONFIG_COMPAT
1070			if (client->convert32 && snd_seq_ev_is_varusr(&event)) {
1071				void *ptr = (void __force *)compat_ptr(event.data.raw32.d[1]);
1072				event.data.ext.ptr = ptr;
1073			}
1074#endif
1075		}
1076
1077		/* ok, enqueue it */
1078		err = snd_seq_client_enqueue_event(client, &event, file,
1079						   !(file->f_flags & O_NONBLOCK),
1080						   0, 0);
1081		if (err < 0)
1082			break;
1083
1084	__skip_event:
1085		/* Update pointers and counts */
1086		count -= len;
1087		buf += len;
1088		written += len;
1089	}
1090
1091	return written ? written : err;
1092}
1093
1094
1095/*
1096 * handle polling
1097 */
1098static unsigned int snd_seq_poll(struct file *file, poll_table * wait)
1099{
1100	struct snd_seq_client *client = file->private_data;
1101	unsigned int mask = 0;
1102
1103	/* check client structures are in place */
1104	if (snd_BUG_ON(!client))
1105		return -ENXIO;
1106
1107	if ((snd_seq_file_flags(file) & SNDRV_SEQ_LFLG_INPUT) &&
1108	    client->data.user.fifo) {
1109
1110		/* check if data is available in the outqueue */
1111		if (snd_seq_fifo_poll_wait(client->data.user.fifo, file, wait))
1112			mask |= POLLIN | POLLRDNORM;
1113	}
1114
1115	if (snd_seq_file_flags(file) & SNDRV_SEQ_LFLG_OUTPUT) {
1116
1117		/* check if data is available in the pool */
1118		if (!snd_seq_write_pool_allocated(client) ||
1119		    snd_seq_pool_poll_wait(client->pool, file, wait))
1120			mask |= POLLOUT | POLLWRNORM;
1121	}
1122
1123	return mask;
1124}
1125
1126
1127/*-----------------------------------------------------*/
1128
1129
1130/* SYSTEM_INFO ioctl() */
1131static int snd_seq_ioctl_system_info(struct snd_seq_client *client, void __user *arg)
1132{
1133	struct snd_seq_system_info info;
1134
1135	memset(&info, 0, sizeof(info));
1136	/* fill the info fields */
1137	info.queues = SNDRV_SEQ_MAX_QUEUES;
1138	info.clients = SNDRV_SEQ_MAX_CLIENTS;
1139	info.ports = SNDRV_SEQ_MAX_PORTS;
1140	info.channels = 256;	/* fixed limit */
1141	info.cur_clients = client_usage.cur;
1142	info.cur_queues = snd_seq_queue_get_cur_queues();
1143
1144	if (copy_to_user(arg, &info, sizeof(info)))
1145		return -EFAULT;
1146	return 0;
1147}
1148
1149
1150/* RUNNING_MODE ioctl() */
1151static int snd_seq_ioctl_running_mode(struct snd_seq_client *client, void __user *arg)
1152{
1153	struct snd_seq_running_info info;
1154	struct snd_seq_client *cptr;
1155	int err = 0;
1156
1157	if (copy_from_user(&info, arg, sizeof(info)))
1158		return -EFAULT;
1159
1160	/* requested client number */
1161	cptr = snd_seq_client_use_ptr(info.client);
1162	if (cptr == NULL)
1163		return -ENOENT;		/* don't change !!! */
1164
1165#ifdef SNDRV_BIG_ENDIAN
1166	if (! info.big_endian) {
1167		err = -EINVAL;
1168		goto __err;
1169	}
1170#else
1171	if (info.big_endian) {
1172		err = -EINVAL;
1173		goto __err;
1174	}
1175
1176#endif
1177	if (info.cpu_mode > sizeof(long)) {
1178		err = -EINVAL;
1179		goto __err;
1180	}
1181	cptr->convert32 = (info.cpu_mode < sizeof(long));
1182 __err:
1183	snd_seq_client_unlock(cptr);
1184	return err;
1185}
1186
1187/* CLIENT_INFO ioctl() */
1188static void get_client_info(struct snd_seq_client *cptr,
1189			    struct snd_seq_client_info *info)
1190{
1191	info->client = cptr->number;
1192
1193	/* fill the info fields */
1194	info->type = cptr->type;
1195	strcpy(info->name, cptr->name);
1196	info->filter = cptr->filter;
1197	info->event_lost = cptr->event_lost;
1198	memcpy(info->event_filter, cptr->event_filter, 32);
1199	info->num_ports = cptr->num_ports;
1200	memset(info->reserved, 0, sizeof(info->reserved));
1201}
1202
1203static int snd_seq_ioctl_get_client_info(struct snd_seq_client *client,
1204					 void __user *arg)
1205{
1206	struct snd_seq_client *cptr;
1207	struct snd_seq_client_info client_info;
1208
1209	if (copy_from_user(&client_info, arg, sizeof(client_info)))
1210		return -EFAULT;
1211
1212	/* requested client number */
1213	cptr = snd_seq_client_use_ptr(client_info.client);
1214	if (cptr == NULL)
1215		return -ENOENT;		/* don't change !!! */
1216
1217	get_client_info(cptr, &client_info);
1218	snd_seq_client_unlock(cptr);
1219
1220	if (copy_to_user(arg, &client_info, sizeof(client_info)))
1221		return -EFAULT;
1222	return 0;
1223}
1224
1225
1226/* CLIENT_INFO ioctl() */
1227static int snd_seq_ioctl_set_client_info(struct snd_seq_client *client,
1228					 void __user *arg)
1229{
1230	struct snd_seq_client_info client_info;
1231
1232	if (copy_from_user(&client_info, arg, sizeof(client_info)))
1233		return -EFAULT;
1234
1235	/* it is not allowed to set the info fields for an another client */
1236	if (client->number != client_info.client)
1237		return -EPERM;
1238	/* also client type must be set now */
1239	if (client->type != client_info.type)
1240		return -EINVAL;
1241
1242	/* fill the info fields */
1243	if (client_info.name[0])
1244		strlcpy(client->name, client_info.name, sizeof(client->name));
1245
1246	client->filter = client_info.filter;
1247	client->event_lost = client_info.event_lost;
1248	memcpy(client->event_filter, client_info.event_filter, 32);
1249
1250	return 0;
1251}
1252
1253
1254/*
1255 * CREATE PORT ioctl()
1256 */
1257static int snd_seq_ioctl_create_port(struct snd_seq_client *client,
1258				     void __user *arg)
1259{
1260	struct snd_seq_client_port *port;
1261	struct snd_seq_port_info info;
1262	struct snd_seq_port_callback *callback;
1263
1264	if (copy_from_user(&info, arg, sizeof(info)))
1265		return -EFAULT;
1266
1267	/* it is not allowed to create the port for an another client */
1268	if (info.addr.client != client->number)
1269		return -EPERM;
1270
1271	port = snd_seq_create_port(client, (info.flags & SNDRV_SEQ_PORT_FLG_GIVEN_PORT) ? info.addr.port : -1);
1272	if (port == NULL)
1273		return -ENOMEM;
1274
1275	if (client->type == USER_CLIENT && info.kernel) {
1276		snd_seq_delete_port(client, port->addr.port);
1277		return -EINVAL;
1278	}
1279	if (client->type == KERNEL_CLIENT) {
1280		if ((callback = info.kernel) != NULL) {
1281			if (callback->owner)
1282				port->owner = callback->owner;
1283			port->private_data = callback->private_data;
1284			port->private_free = callback->private_free;
1285			port->event_input = callback->event_input;
1286			port->c_src.open = callback->subscribe;
1287			port->c_src.close = callback->unsubscribe;
1288			port->c_dest.open = callback->use;
1289			port->c_dest.close = callback->unuse;
1290		}
1291	}
1292
1293	info.addr = port->addr;
1294
1295	snd_seq_set_port_info(port, &info);
1296	snd_seq_system_client_ev_port_start(port->addr.client, port->addr.port);
1297
1298	if (copy_to_user(arg, &info, sizeof(info)))
1299		return -EFAULT;
1300
1301	return 0;
1302}
1303
1304/*
1305 * DELETE PORT ioctl()
1306 */
1307static int snd_seq_ioctl_delete_port(struct snd_seq_client *client,
1308				     void __user *arg)
1309{
1310	struct snd_seq_port_info info;
1311	int err;
1312
1313	/* set passed parameters */
1314	if (copy_from_user(&info, arg, sizeof(info)))
1315		return -EFAULT;
1316
1317	/* it is not allowed to remove the port for an another client */
1318	if (info.addr.client != client->number)
1319		return -EPERM;
1320
1321	err = snd_seq_delete_port(client, info.addr.port);
1322	if (err >= 0)
1323		snd_seq_system_client_ev_port_exit(client->number, info.addr.port);
1324	return err;
1325}
1326
1327
1328/*
1329 * GET_PORT_INFO ioctl() (on any client)
1330 */
1331static int snd_seq_ioctl_get_port_info(struct snd_seq_client *client,
1332				       void __user *arg)
1333{
1334	struct snd_seq_client *cptr;
1335	struct snd_seq_client_port *port;
1336	struct snd_seq_port_info info;
1337
1338	if (copy_from_user(&info, arg, sizeof(info)))
1339		return -EFAULT;
1340	cptr = snd_seq_client_use_ptr(info.addr.client);
1341	if (cptr == NULL)
1342		return -ENXIO;
1343
1344	port = snd_seq_port_use_ptr(cptr, info.addr.port);
1345	if (port == NULL) {
1346		snd_seq_client_unlock(cptr);
1347		return -ENOENT;			/* don't change */
1348	}
1349
1350	/* get port info */
1351	snd_seq_get_port_info(port, &info);
1352	snd_seq_port_unlock(port);
1353	snd_seq_client_unlock(cptr);
1354
1355	if (copy_to_user(arg, &info, sizeof(info)))
1356		return -EFAULT;
1357	return 0;
1358}
1359
1360
1361/*
1362 * SET_PORT_INFO ioctl() (only ports on this/own client)
1363 */
1364static int snd_seq_ioctl_set_port_info(struct snd_seq_client *client,
1365				       void __user *arg)
1366{
1367	struct snd_seq_client_port *port;
1368	struct snd_seq_port_info info;
1369
1370	if (copy_from_user(&info, arg, sizeof(info)))
1371		return -EFAULT;
1372
1373	if (info.addr.client != client->number) /* only set our own ports ! */
1374		return -EPERM;
1375	port = snd_seq_port_use_ptr(client, info.addr.port);
1376	if (port) {
1377		snd_seq_set_port_info(port, &info);
1378		snd_seq_port_unlock(port);
1379	}
1380	return 0;
1381}
1382
1383
1384/*
1385 * port subscription (connection)
1386 */
1387#define PERM_RD		(SNDRV_SEQ_PORT_CAP_READ|SNDRV_SEQ_PORT_CAP_SUBS_READ)
1388#define PERM_WR		(SNDRV_SEQ_PORT_CAP_WRITE|SNDRV_SEQ_PORT_CAP_SUBS_WRITE)
1389
1390static int check_subscription_permission(struct snd_seq_client *client,
1391					 struct snd_seq_client_port *sport,
1392					 struct snd_seq_client_port *dport,
1393					 struct snd_seq_port_subscribe *subs)
1394{
1395	if (client->number != subs->sender.client &&
1396	    client->number != subs->dest.client) {
1397		/* connection by third client - check export permission */
1398		if (check_port_perm(sport, SNDRV_SEQ_PORT_CAP_NO_EXPORT))
1399			return -EPERM;
1400		if (check_port_perm(dport, SNDRV_SEQ_PORT_CAP_NO_EXPORT))
1401			return -EPERM;
1402	}
1403
1404	/* check read permission */
1405	/* if sender or receiver is the subscribing client itself,
1406	 * no permission check is necessary
1407	 */
1408	if (client->number != subs->sender.client) {
1409		if (! check_port_perm(sport, PERM_RD))
1410			return -EPERM;
1411	}
1412	/* check write permission */
1413	if (client->number != subs->dest.client) {
1414		if (! check_port_perm(dport, PERM_WR))
1415			return -EPERM;
1416	}
1417	return 0;
1418}
1419
1420/*
1421 * send an subscription notify event to user client:
1422 * client must be user client.
1423 */
1424int snd_seq_client_notify_subscription(int client, int port,
1425				       struct snd_seq_port_subscribe *info,
1426				       int evtype)
1427{
1428	struct snd_seq_event event;
1429
1430	memset(&event, 0, sizeof(event));
1431	event.type = evtype;
1432	event.data.connect.dest = info->dest;
1433	event.data.connect.sender = info->sender;
1434
1435	return snd_seq_system_notify(client, port, &event);  /* non-atomic */
1436}
1437
1438
1439/*
1440 * add to port's subscription list IOCTL interface
1441 */
1442static int snd_seq_ioctl_subscribe_port(struct snd_seq_client *client,
1443					void __user *arg)
1444{
1445	int result = -EINVAL;
1446	struct snd_seq_client *receiver = NULL, *sender = NULL;
1447	struct snd_seq_client_port *sport = NULL, *dport = NULL;
1448	struct snd_seq_port_subscribe subs;
1449
1450	if (copy_from_user(&subs, arg, sizeof(subs)))
1451		return -EFAULT;
1452
1453	if ((receiver = snd_seq_client_use_ptr(subs.dest.client)) == NULL)
1454		goto __end;
1455	if ((sender = snd_seq_client_use_ptr(subs.sender.client)) == NULL)
1456		goto __end;
1457	if ((sport = snd_seq_port_use_ptr(sender, subs.sender.port)) == NULL)
1458		goto __end;
1459	if ((dport = snd_seq_port_use_ptr(receiver, subs.dest.port)) == NULL)
1460		goto __end;
1461
1462	result = check_subscription_permission(client, sport, dport, &subs);
1463	if (result < 0)
1464		goto __end;
1465
1466	/* connect them */
1467	result = snd_seq_port_connect(client, sender, sport, receiver, dport, &subs);
1468	if (! result) /* broadcast announce */
1469		snd_seq_client_notify_subscription(SNDRV_SEQ_ADDRESS_SUBSCRIBERS, 0,
1470						   &subs, SNDRV_SEQ_EVENT_PORT_SUBSCRIBED);
1471      __end:
1472      	if (sport)
1473		snd_seq_port_unlock(sport);
1474	if (dport)
1475		snd_seq_port_unlock(dport);
1476	if (sender)
1477		snd_seq_client_unlock(sender);
1478	if (receiver)
1479		snd_seq_client_unlock(receiver);
1480	return result;
1481}
1482
1483
1484/*
1485 * remove from port's subscription list
1486 */
1487static int snd_seq_ioctl_unsubscribe_port(struct snd_seq_client *client,
1488					  void __user *arg)
1489{
1490	int result = -ENXIO;
1491	struct snd_seq_client *receiver = NULL, *sender = NULL;
1492	struct snd_seq_client_port *sport = NULL, *dport = NULL;
1493	struct snd_seq_port_subscribe subs;
1494
1495	if (copy_from_user(&subs, arg, sizeof(subs)))
1496		return -EFAULT;
1497
1498	if ((receiver = snd_seq_client_use_ptr(subs.dest.client)) == NULL)
1499		goto __end;
1500	if ((sender = snd_seq_client_use_ptr(subs.sender.client)) == NULL)
1501		goto __end;
1502	if ((sport = snd_seq_port_use_ptr(sender, subs.sender.port)) == NULL)
1503		goto __end;
1504	if ((dport = snd_seq_port_use_ptr(receiver, subs.dest.port)) == NULL)
1505		goto __end;
1506
1507	result = check_subscription_permission(client, sport, dport, &subs);
1508	if (result < 0)
1509		goto __end;
1510
1511	result = snd_seq_port_disconnect(client, sender, sport, receiver, dport, &subs);
1512	if (! result) /* broadcast announce */
1513		snd_seq_client_notify_subscription(SNDRV_SEQ_ADDRESS_SUBSCRIBERS, 0,
1514						   &subs, SNDRV_SEQ_EVENT_PORT_UNSUBSCRIBED);
1515      __end:
1516      	if (sport)
1517		snd_seq_port_unlock(sport);
1518	if (dport)
1519		snd_seq_port_unlock(dport);
1520	if (sender)
1521		snd_seq_client_unlock(sender);
1522	if (receiver)
1523		snd_seq_client_unlock(receiver);
1524	return result;
1525}
1526
1527
1528/* CREATE_QUEUE ioctl() */
1529static int snd_seq_ioctl_create_queue(struct snd_seq_client *client,
1530				      void __user *arg)
1531{
1532	struct snd_seq_queue_info info;
1533	int result;
1534	struct snd_seq_queue *q;
1535
1536	if (copy_from_user(&info, arg, sizeof(info)))
1537		return -EFAULT;
1538
1539	result = snd_seq_queue_alloc(client->number, info.locked, info.flags);
1540	if (result < 0)
1541		return result;
1542
1543	q = queueptr(result);
1544	if (q == NULL)
1545		return -EINVAL;
1546
1547	info.queue = q->queue;
1548	info.locked = q->locked;
1549	info.owner = q->owner;
1550
1551	/* set queue name */
1552	if (! info.name[0])
1553		snprintf(info.name, sizeof(info.name), "Queue-%d", q->queue);
1554	strlcpy(q->name, info.name, sizeof(q->name));
1555	queuefree(q);
1556
1557	if (copy_to_user(arg, &info, sizeof(info)))
1558		return -EFAULT;
1559
1560	return 0;
1561}
1562
1563/* DELETE_QUEUE ioctl() */
1564static int snd_seq_ioctl_delete_queue(struct snd_seq_client *client,
1565				      void __user *arg)
1566{
1567	struct snd_seq_queue_info info;
1568
1569	if (copy_from_user(&info, arg, sizeof(info)))
1570		return -EFAULT;
1571
1572	return snd_seq_queue_delete(client->number, info.queue);
1573}
1574
1575/* GET_QUEUE_INFO ioctl() */
1576static int snd_seq_ioctl_get_queue_info(struct snd_seq_client *client,
1577					void __user *arg)
1578{
1579	struct snd_seq_queue_info info;
1580	struct snd_seq_queue *q;
1581
1582	if (copy_from_user(&info, arg, sizeof(info)))
1583		return -EFAULT;
1584
1585	q = queueptr(info.queue);
1586	if (q == NULL)
1587		return -EINVAL;
1588
1589	memset(&info, 0, sizeof(info));
1590	info.queue = q->queue;
1591	info.owner = q->owner;
1592	info.locked = q->locked;
1593	strlcpy(info.name, q->name, sizeof(info.name));
1594	queuefree(q);
1595
1596	if (copy_to_user(arg, &info, sizeof(info)))
1597		return -EFAULT;
1598
1599	return 0;
1600}
1601
1602/* SET_QUEUE_INFO ioctl() */
1603static int snd_seq_ioctl_set_queue_info(struct snd_seq_client *client,
1604					void __user *arg)
1605{
1606	struct snd_seq_queue_info info;
1607	struct snd_seq_queue *q;
1608
1609	if (copy_from_user(&info, arg, sizeof(info)))
1610		return -EFAULT;
1611
1612	if (info.owner != client->number)
1613		return -EINVAL;
1614
1615	/* change owner/locked permission */
1616	if (snd_seq_queue_check_access(info.queue, client->number)) {
1617		if (snd_seq_queue_set_owner(info.queue, client->number, info.locked) < 0)
1618			return -EPERM;
1619		if (info.locked)
1620			snd_seq_queue_use(info.queue, client->number, 1);
1621	} else {
1622		return -EPERM;
1623	}
1624
1625	q = queueptr(info.queue);
1626	if (! q)
1627		return -EINVAL;
1628	if (q->owner != client->number) {
1629		queuefree(q);
1630		return -EPERM;
1631	}
1632	strlcpy(q->name, info.name, sizeof(q->name));
1633	queuefree(q);
1634
1635	return 0;
1636}
1637
1638/* GET_NAMED_QUEUE ioctl() */
1639static int snd_seq_ioctl_get_named_queue(struct snd_seq_client *client, void __user *arg)
1640{
1641	struct snd_seq_queue_info info;
1642	struct snd_seq_queue *q;
1643
1644	if (copy_from_user(&info, arg, sizeof(info)))
1645		return -EFAULT;
1646
1647	q = snd_seq_queue_find_name(info.name);
1648	if (q == NULL)
1649		return -EINVAL;
1650	info.queue = q->queue;
1651	info.owner = q->owner;
1652	info.locked = q->locked;
1653	queuefree(q);
1654
1655	if (copy_to_user(arg, &info, sizeof(info)))
1656		return -EFAULT;
1657
1658	return 0;
1659}
1660
1661/* GET_QUEUE_STATUS ioctl() */
1662static int snd_seq_ioctl_get_queue_status(struct snd_seq_client *client,
1663					  void __user *arg)
1664{
1665	struct snd_seq_queue_status status;
1666	struct snd_seq_queue *queue;
1667	struct snd_seq_timer *tmr;
1668
1669	if (copy_from_user(&status, arg, sizeof(status)))
1670		return -EFAULT;
1671
1672	queue = queueptr(status.queue);
1673	if (queue == NULL)
1674		return -EINVAL;
1675	memset(&status, 0, sizeof(status));
1676	status.queue = queue->queue;
1677
1678	tmr = queue->timer;
1679	status.events = queue->tickq->cells + queue->timeq->cells;
1680
1681	status.time = snd_seq_timer_get_cur_time(tmr);
1682	status.tick = snd_seq_timer_get_cur_tick(tmr);
1683
1684	status.running = tmr->running;
1685
1686	status.flags = queue->flags;
1687	queuefree(queue);
1688
1689	if (copy_to_user(arg, &status, sizeof(status)))
1690		return -EFAULT;
1691	return 0;
1692}
1693
1694
1695/* GET_QUEUE_TEMPO ioctl() */
1696static int snd_seq_ioctl_get_queue_tempo(struct snd_seq_client *client,
1697					 void __user *arg)
1698{
1699	struct snd_seq_queue_tempo tempo;
1700	struct snd_seq_queue *queue;
1701	struct snd_seq_timer *tmr;
1702
1703	if (copy_from_user(&tempo, arg, sizeof(tempo)))
1704		return -EFAULT;
1705
1706	queue = queueptr(tempo.queue);
1707	if (queue == NULL)
1708		return -EINVAL;
1709	memset(&tempo, 0, sizeof(tempo));
1710	tempo.queue = queue->queue;
1711
1712	tmr = queue->timer;
1713
1714	tempo.tempo = tmr->tempo;
1715	tempo.ppq = tmr->ppq;
1716	tempo.skew_value = tmr->skew;
1717	tempo.skew_base = tmr->skew_base;
1718	queuefree(queue);
1719
1720	if (copy_to_user(arg, &tempo, sizeof(tempo)))
1721		return -EFAULT;
1722	return 0;
1723}
1724
1725
1726/* SET_QUEUE_TEMPO ioctl() */
1727int snd_seq_set_queue_tempo(int client, struct snd_seq_queue_tempo *tempo)
1728{
1729	if (!snd_seq_queue_check_access(tempo->queue, client))
1730		return -EPERM;
1731	return snd_seq_queue_timer_set_tempo(tempo->queue, client, tempo);
1732}
1733
1734EXPORT_SYMBOL(snd_seq_set_queue_tempo);
1735
1736static int snd_seq_ioctl_set_queue_tempo(struct snd_seq_client *client,
1737					 void __user *arg)
1738{
1739	int result;
1740	struct snd_seq_queue_tempo tempo;
1741
1742	if (copy_from_user(&tempo, arg, sizeof(tempo)))
1743		return -EFAULT;
1744
1745	result = snd_seq_set_queue_tempo(client->number, &tempo);
1746	return result < 0 ? result : 0;
1747}
1748
1749
1750/* GET_QUEUE_TIMER ioctl() */
1751static int snd_seq_ioctl_get_queue_timer(struct snd_seq_client *client,
1752					 void __user *arg)
1753{
1754	struct snd_seq_queue_timer timer;
1755	struct snd_seq_queue *queue;
1756	struct snd_seq_timer *tmr;
1757
1758	if (copy_from_user(&timer, arg, sizeof(timer)))
1759		return -EFAULT;
1760
1761	queue = queueptr(timer.queue);
1762	if (queue == NULL)
1763		return -EINVAL;
1764
1765	if (mutex_lock_interruptible(&queue->timer_mutex)) {
1766		queuefree(queue);
1767		return -ERESTARTSYS;
1768	}
1769	tmr = queue->timer;
1770	memset(&timer, 0, sizeof(timer));
1771	timer.queue = queue->queue;
1772
1773	timer.type = tmr->type;
1774	if (tmr->type == SNDRV_SEQ_TIMER_ALSA) {
1775		timer.u.alsa.id = tmr->alsa_id;
1776		timer.u.alsa.resolution = tmr->preferred_resolution;
1777	}
1778	mutex_unlock(&queue->timer_mutex);
1779	queuefree(queue);
1780
1781	if (copy_to_user(arg, &timer, sizeof(timer)))
1782		return -EFAULT;
1783	return 0;
1784}
1785
1786
1787/* SET_QUEUE_TIMER ioctl() */
1788static int snd_seq_ioctl_set_queue_timer(struct snd_seq_client *client,
1789					 void __user *arg)
1790{
1791	int result = 0;
1792	struct snd_seq_queue_timer timer;
1793
1794	if (copy_from_user(&timer, arg, sizeof(timer)))
1795		return -EFAULT;
1796
1797	if (timer.type != SNDRV_SEQ_TIMER_ALSA)
1798		return -EINVAL;
1799
1800	if (snd_seq_queue_check_access(timer.queue, client->number)) {
1801		struct snd_seq_queue *q;
1802		struct snd_seq_timer *tmr;
1803
1804		q = queueptr(timer.queue);
1805		if (q == NULL)
1806			return -ENXIO;
1807		if (mutex_lock_interruptible(&q->timer_mutex)) {
1808			queuefree(q);
1809			return -ERESTARTSYS;
1810		}
1811		tmr = q->timer;
1812		snd_seq_queue_timer_close(timer.queue);
1813		tmr->type = timer.type;
1814		if (tmr->type == SNDRV_SEQ_TIMER_ALSA) {
1815			tmr->alsa_id = timer.u.alsa.id;
1816			tmr->preferred_resolution = timer.u.alsa.resolution;
1817		}
1818		result = snd_seq_queue_timer_open(timer.queue);
1819		mutex_unlock(&q->timer_mutex);
1820		queuefree(q);
1821	} else {
1822		return -EPERM;
1823	}
1824
1825	return result;
1826}
1827
1828
1829/* GET_QUEUE_CLIENT ioctl() */
1830static int snd_seq_ioctl_get_queue_client(struct snd_seq_client *client,
1831					  void __user *arg)
1832{
1833	struct snd_seq_queue_client info;
1834	int used;
1835
1836	if (copy_from_user(&info, arg, sizeof(info)))
1837		return -EFAULT;
1838
1839	used = snd_seq_queue_is_used(info.queue, client->number);
1840	if (used < 0)
1841		return -EINVAL;
1842	info.used = used;
1843	info.client = client->number;
1844
1845	if (copy_to_user(arg, &info, sizeof(info)))
1846		return -EFAULT;
1847	return 0;
1848}
1849
1850
1851/* SET_QUEUE_CLIENT ioctl() */
1852static int snd_seq_ioctl_set_queue_client(struct snd_seq_client *client,
1853					  void __user *arg)
1854{
1855	int err;
1856	struct snd_seq_queue_client info;
1857
1858	if (copy_from_user(&info, arg, sizeof(info)))
1859		return -EFAULT;
1860
1861	if (info.used >= 0) {
1862		err = snd_seq_queue_use(info.queue, client->number, info.used);
1863		if (err < 0)
1864			return err;
1865	}
1866
1867	return snd_seq_ioctl_get_queue_client(client, arg);
1868}
1869
1870
1871/* GET_CLIENT_POOL ioctl() */
1872static int snd_seq_ioctl_get_client_pool(struct snd_seq_client *client,
1873					 void __user *arg)
1874{
1875	struct snd_seq_client_pool info;
1876	struct snd_seq_client *cptr;
1877
1878	if (copy_from_user(&info, arg, sizeof(info)))
1879		return -EFAULT;
1880
1881	cptr = snd_seq_client_use_ptr(info.client);
1882	if (cptr == NULL)
1883		return -ENOENT;
1884	memset(&info, 0, sizeof(info));
1885	info.client = cptr->number;
1886	info.output_pool = cptr->pool->size;
1887	info.output_room = cptr->pool->room;
1888	info.output_free = info.output_pool;
1889	info.output_free = snd_seq_unused_cells(cptr->pool);
1890	if (cptr->type == USER_CLIENT) {
1891		info.input_pool = cptr->data.user.fifo_pool_size;
1892		info.input_free = info.input_pool;
1893		if (cptr->data.user.fifo)
1894			info.input_free = snd_seq_unused_cells(cptr->data.user.fifo->pool);
1895	} else {
1896		info.input_pool = 0;
1897		info.input_free = 0;
1898	}
1899	snd_seq_client_unlock(cptr);
1900
1901	if (copy_to_user(arg, &info, sizeof(info)))
1902		return -EFAULT;
1903	return 0;
1904}
1905
1906/* SET_CLIENT_POOL ioctl() */
1907static int snd_seq_ioctl_set_client_pool(struct snd_seq_client *client,
1908					 void __user *arg)
1909{
1910	struct snd_seq_client_pool info;
1911	int rc;
1912
1913	if (copy_from_user(&info, arg, sizeof(info)))
1914		return -EFAULT;
1915
1916	if (client->number != info.client)
1917		return -EINVAL; /* can't change other clients */
1918
1919	if (info.output_pool >= 1 && info.output_pool <= SNDRV_SEQ_MAX_EVENTS &&
1920	    (! snd_seq_write_pool_allocated(client) ||
1921	     info.output_pool != client->pool->size)) {
1922		if (snd_seq_write_pool_allocated(client)) {
1923			/* remove all existing cells */
1924			snd_seq_queue_client_leave_cells(client->number);
1925			snd_seq_pool_done(client->pool);
1926		}
1927		client->pool->size = info.output_pool;
1928		rc = snd_seq_pool_init(client->pool);
1929		if (rc < 0)
1930			return rc;
1931	}
1932	if (client->type == USER_CLIENT && client->data.user.fifo != NULL &&
1933	    info.input_pool >= 1 &&
1934	    info.input_pool <= SNDRV_SEQ_MAX_CLIENT_EVENTS &&
1935	    info.input_pool != client->data.user.fifo_pool_size) {
1936		/* change pool size */
1937		rc = snd_seq_fifo_resize(client->data.user.fifo, info.input_pool);
1938		if (rc < 0)
1939			return rc;
1940		client->data.user.fifo_pool_size = info.input_pool;
1941	}
1942	if (info.output_room >= 1 &&
1943	    info.output_room <= client->pool->size) {
1944		client->pool->room  = info.output_room;
1945	}
1946
1947	return snd_seq_ioctl_get_client_pool(client, arg);
1948}
1949
1950
1951/* REMOVE_EVENTS ioctl() */
1952static int snd_seq_ioctl_remove_events(struct snd_seq_client *client,
1953				       void __user *arg)
1954{
1955	struct snd_seq_remove_events info;
1956
1957	if (copy_from_user(&info, arg, sizeof(info)))
1958		return -EFAULT;
1959
1960	/*
1961	 * Input mostly not implemented XXX.
1962	 */
1963	if (info.remove_mode & SNDRV_SEQ_REMOVE_INPUT) {
1964		/*
1965		 * No restrictions so for a user client we can clear
1966		 * the whole fifo
1967		 */
1968		if (client->type == USER_CLIENT && client->data.user.fifo)
1969			snd_seq_fifo_clear(client->data.user.fifo);
1970	}
1971
1972	if (info.remove_mode & SNDRV_SEQ_REMOVE_OUTPUT)
1973		snd_seq_queue_remove_cells(client->number, &info);
1974
1975	return 0;
1976}
1977
1978
1979/*
1980 * get subscription info
1981 */
1982static int snd_seq_ioctl_get_subscription(struct snd_seq_client *client,
1983					  void __user *arg)
1984{
1985	int result;
1986	struct snd_seq_client *sender = NULL;
1987	struct snd_seq_client_port *sport = NULL;
1988	struct snd_seq_port_subscribe subs;
1989	struct snd_seq_subscribers *p;
1990
1991	if (copy_from_user(&subs, arg, sizeof(subs)))
1992		return -EFAULT;
1993
1994	result = -EINVAL;
1995	if ((sender = snd_seq_client_use_ptr(subs.sender.client)) == NULL)
1996		goto __end;
1997	if ((sport = snd_seq_port_use_ptr(sender, subs.sender.port)) == NULL)
1998		goto __end;
1999	p = snd_seq_port_get_subscription(&sport->c_src, &subs.dest);
2000	if (p) {
2001		result = 0;
2002		subs = p->info;
2003	} else
2004		result = -ENOENT;
2005
2006      __end:
2007      	if (sport)
2008		snd_seq_port_unlock(sport);
2009	if (sender)
2010		snd_seq_client_unlock(sender);
2011	if (result >= 0) {
2012		if (copy_to_user(arg, &subs, sizeof(subs)))
2013			return -EFAULT;
2014	}
2015	return result;
2016}
2017
2018
2019/*
2020 * get subscription info - check only its presence
2021 */
2022static int snd_seq_ioctl_query_subs(struct snd_seq_client *client,
2023				    void __user *arg)
2024{
2025	int result = -ENXIO;
2026	struct snd_seq_client *cptr = NULL;
2027	struct snd_seq_client_port *port = NULL;
2028	struct snd_seq_query_subs subs;
2029	struct snd_seq_port_subs_info *group;
2030	struct list_head *p;
2031	int i;
2032
2033	if (copy_from_user(&subs, arg, sizeof(subs)))
2034		return -EFAULT;
2035
2036	if ((cptr = snd_seq_client_use_ptr(subs.root.client)) == NULL)
2037		goto __end;
2038	if ((port = snd_seq_port_use_ptr(cptr, subs.root.port)) == NULL)
2039		goto __end;
2040
2041	switch (subs.type) {
2042	case SNDRV_SEQ_QUERY_SUBS_READ:
2043		group = &port->c_src;
2044		break;
2045	case SNDRV_SEQ_QUERY_SUBS_WRITE:
2046		group = &port->c_dest;
2047		break;
2048	default:
2049		goto __end;
2050	}
2051
2052	down_read(&group->list_mutex);
2053	/* search for the subscriber */
2054	subs.num_subs = group->count;
2055	i = 0;
2056	result = -ENOENT;
2057	list_for_each(p, &group->list_head) {
2058		if (i++ == subs.index) {
2059			/* found! */
2060			struct snd_seq_subscribers *s;
2061			if (subs.type == SNDRV_SEQ_QUERY_SUBS_READ) {
2062				s = list_entry(p, struct snd_seq_subscribers, src_list);
2063				subs.addr = s->info.dest;
2064			} else {
2065				s = list_entry(p, struct snd_seq_subscribers, dest_list);
2066				subs.addr = s->info.sender;
2067			}
2068			subs.flags = s->info.flags;
2069			subs.queue = s->info.queue;
2070			result = 0;
2071			break;
2072		}
2073	}
2074	up_read(&group->list_mutex);
2075
2076      __end:
2077   	if (port)
2078		snd_seq_port_unlock(port);
2079	if (cptr)
2080		snd_seq_client_unlock(cptr);
2081	if (result >= 0) {
2082		if (copy_to_user(arg, &subs, sizeof(subs)))
2083			return -EFAULT;
2084	}
2085	return result;
2086}
2087
2088
2089/*
2090 * query next client
2091 */
2092static int snd_seq_ioctl_query_next_client(struct snd_seq_client *client,
2093					   void __user *arg)
2094{
2095	struct snd_seq_client *cptr = NULL;
2096	struct snd_seq_client_info info;
2097
2098	if (copy_from_user(&info, arg, sizeof(info)))
2099		return -EFAULT;
2100
2101	/* search for next client */
2102	info.client++;
2103	if (info.client < 0)
2104		info.client = 0;
2105	for (; info.client < SNDRV_SEQ_MAX_CLIENTS; info.client++) {
2106		cptr = snd_seq_client_use_ptr(info.client);
2107		if (cptr)
2108			break; /* found */
2109	}
2110	if (cptr == NULL)
2111		return -ENOENT;
2112
2113	get_client_info(cptr, &info);
2114	snd_seq_client_unlock(cptr);
2115
2116	if (copy_to_user(arg, &info, sizeof(info)))
2117		return -EFAULT;
2118	return 0;
2119}
2120
2121/*
2122 * query next port
2123 */
2124static int snd_seq_ioctl_query_next_port(struct snd_seq_client *client,
2125					 void __user *arg)
2126{
2127	struct snd_seq_client *cptr;
2128	struct snd_seq_client_port *port = NULL;
2129	struct snd_seq_port_info info;
2130
2131	if (copy_from_user(&info, arg, sizeof(info)))
2132		return -EFAULT;
2133	cptr = snd_seq_client_use_ptr(info.addr.client);
2134	if (cptr == NULL)
2135		return -ENXIO;
2136
2137	/* search for next port */
2138	info.addr.port++;
2139	port = snd_seq_port_query_nearest(cptr, &info);
2140	if (port == NULL) {
2141		snd_seq_client_unlock(cptr);
2142		return -ENOENT;
2143	}
2144
2145	/* get port info */
2146	info.addr = port->addr;
2147	snd_seq_get_port_info(port, &info);
2148	snd_seq_port_unlock(port);
2149	snd_seq_client_unlock(cptr);
2150
2151	if (copy_to_user(arg, &info, sizeof(info)))
2152		return -EFAULT;
2153	return 0;
2154}
2155
2156/* -------------------------------------------------------- */
2157
2158static struct seq_ioctl_table {
2159	unsigned int cmd;
2160	int (*func)(struct snd_seq_client *client, void __user * arg);
2161} ioctl_tables[] = {
2162	{ SNDRV_SEQ_IOCTL_SYSTEM_INFO, snd_seq_ioctl_system_info },
2163	{ SNDRV_SEQ_IOCTL_RUNNING_MODE, snd_seq_ioctl_running_mode },
2164	{ SNDRV_SEQ_IOCTL_GET_CLIENT_INFO, snd_seq_ioctl_get_client_info },
2165	{ SNDRV_SEQ_IOCTL_SET_CLIENT_INFO, snd_seq_ioctl_set_client_info },
2166	{ SNDRV_SEQ_IOCTL_CREATE_PORT, snd_seq_ioctl_create_port },
2167	{ SNDRV_SEQ_IOCTL_DELETE_PORT, snd_seq_ioctl_delete_port },
2168	{ SNDRV_SEQ_IOCTL_GET_PORT_INFO, snd_seq_ioctl_get_port_info },
2169	{ SNDRV_SEQ_IOCTL_SET_PORT_INFO, snd_seq_ioctl_set_port_info },
2170	{ SNDRV_SEQ_IOCTL_SUBSCRIBE_PORT, snd_seq_ioctl_subscribe_port },
2171	{ SNDRV_SEQ_IOCTL_UNSUBSCRIBE_PORT, snd_seq_ioctl_unsubscribe_port },
2172	{ SNDRV_SEQ_IOCTL_CREATE_QUEUE, snd_seq_ioctl_create_queue },
2173	{ SNDRV_SEQ_IOCTL_DELETE_QUEUE, snd_seq_ioctl_delete_queue },
2174	{ SNDRV_SEQ_IOCTL_GET_QUEUE_INFO, snd_seq_ioctl_get_queue_info },
2175	{ SNDRV_SEQ_IOCTL_SET_QUEUE_INFO, snd_seq_ioctl_set_queue_info },
2176	{ SNDRV_SEQ_IOCTL_GET_NAMED_QUEUE, snd_seq_ioctl_get_named_queue },
2177	{ SNDRV_SEQ_IOCTL_GET_QUEUE_STATUS, snd_seq_ioctl_get_queue_status },
2178	{ SNDRV_SEQ_IOCTL_GET_QUEUE_TEMPO, snd_seq_ioctl_get_queue_tempo },
2179	{ SNDRV_SEQ_IOCTL_SET_QUEUE_TEMPO, snd_seq_ioctl_set_queue_tempo },
2180	{ SNDRV_SEQ_IOCTL_GET_QUEUE_TIMER, snd_seq_ioctl_get_queue_timer },
2181	{ SNDRV_SEQ_IOCTL_SET_QUEUE_TIMER, snd_seq_ioctl_set_queue_timer },
2182	{ SNDRV_SEQ_IOCTL_GET_QUEUE_CLIENT, snd_seq_ioctl_get_queue_client },
2183	{ SNDRV_SEQ_IOCTL_SET_QUEUE_CLIENT, snd_seq_ioctl_set_queue_client },
2184	{ SNDRV_SEQ_IOCTL_GET_CLIENT_POOL, snd_seq_ioctl_get_client_pool },
2185	{ SNDRV_SEQ_IOCTL_SET_CLIENT_POOL, snd_seq_ioctl_set_client_pool },
2186	{ SNDRV_SEQ_IOCTL_GET_SUBSCRIPTION, snd_seq_ioctl_get_subscription },
2187	{ SNDRV_SEQ_IOCTL_QUERY_NEXT_CLIENT, snd_seq_ioctl_query_next_client },
2188	{ SNDRV_SEQ_IOCTL_QUERY_NEXT_PORT, snd_seq_ioctl_query_next_port },
2189	{ SNDRV_SEQ_IOCTL_REMOVE_EVENTS, snd_seq_ioctl_remove_events },
2190	{ SNDRV_SEQ_IOCTL_QUERY_SUBS, snd_seq_ioctl_query_subs },
2191	{ 0, NULL },
2192};
2193
2194static int snd_seq_do_ioctl(struct snd_seq_client *client, unsigned int cmd,
2195			    void __user *arg)
2196{
2197	struct seq_ioctl_table *p;
2198
2199	switch (cmd) {
2200	case SNDRV_SEQ_IOCTL_PVERSION:
2201		/* return sequencer version number */
2202		return put_user(SNDRV_SEQ_VERSION, (int __user *)arg) ? -EFAULT : 0;
2203	case SNDRV_SEQ_IOCTL_CLIENT_ID:
2204		/* return the id of this client */
2205		return put_user(client->number, (int __user *)arg) ? -EFAULT : 0;
2206	}
2207
2208	if (! arg)
2209		return -EFAULT;
2210	for (p = ioctl_tables; p->cmd; p++) {
2211		if (p->cmd == cmd)
2212			return p->func(client, arg);
2213	}
2214	pr_debug("ALSA: seq unknown ioctl() 0x%x (type='%c', number=0x%02x)\n",
2215		   cmd, _IOC_TYPE(cmd), _IOC_NR(cmd));
2216	return -ENOTTY;
2217}
2218
2219
2220static long snd_seq_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
2221{
2222	struct snd_seq_client *client = file->private_data;
2223
2224	if (snd_BUG_ON(!client))
2225		return -ENXIO;
2226
2227	return snd_seq_do_ioctl(client, cmd, (void __user *) arg);
2228}
2229
2230#ifdef CONFIG_COMPAT
2231#include "seq_compat.c"
2232#else
2233#define snd_seq_ioctl_compat	NULL
2234#endif
2235
2236/* -------------------------------------------------------- */
2237
2238
2239/* exported to kernel modules */
2240int snd_seq_create_kernel_client(struct snd_card *card, int client_index,
2241				 const char *name_fmt, ...)
2242{
2243	struct snd_seq_client *client;
2244	va_list args;
2245
2246	if (snd_BUG_ON(in_interrupt()))
2247		return -EBUSY;
2248
2249	if (card && client_index >= SNDRV_SEQ_CLIENTS_PER_CARD)
2250		return -EINVAL;
2251	if (card == NULL && client_index >= SNDRV_SEQ_GLOBAL_CLIENTS)
2252		return -EINVAL;
2253
2254	if (mutex_lock_interruptible(&register_mutex))
2255		return -ERESTARTSYS;
2256
2257	if (card) {
2258		client_index += SNDRV_SEQ_GLOBAL_CLIENTS
2259			+ card->number * SNDRV_SEQ_CLIENTS_PER_CARD;
2260		if (client_index >= SNDRV_SEQ_DYNAMIC_CLIENTS_BEGIN)
2261			client_index = -1;
2262	}
2263
2264	/* empty write queue as default */
2265	client = seq_create_client1(client_index, 0);
2266	if (client == NULL) {
2267		mutex_unlock(&register_mutex);
2268		return -EBUSY;	/* failure code */
2269	}
2270	usage_alloc(&client_usage, 1);
2271
2272	client->accept_input = 1;
2273	client->accept_output = 1;
2274
2275	va_start(args, name_fmt);
2276	vsnprintf(client->name, sizeof(client->name), name_fmt, args);
2277	va_end(args);
2278
2279	client->type = KERNEL_CLIENT;
2280	mutex_unlock(&register_mutex);
2281
2282	/* make others aware this new client */
2283	snd_seq_system_client_ev_client_start(client->number);
2284
2285	/* return client number to caller */
2286	return client->number;
2287}
2288
2289EXPORT_SYMBOL(snd_seq_create_kernel_client);
2290
2291/* exported to kernel modules */
2292int snd_seq_delete_kernel_client(int client)
2293{
2294	struct snd_seq_client *ptr;
2295
2296	if (snd_BUG_ON(in_interrupt()))
2297		return -EBUSY;
2298
2299	ptr = clientptr(client);
2300	if (ptr == NULL)
2301		return -EINVAL;
2302
2303	seq_free_client(ptr);
2304	kfree(ptr);
2305	return 0;
2306}
2307
2308EXPORT_SYMBOL(snd_seq_delete_kernel_client);
2309
2310/* skeleton to enqueue event, called from snd_seq_kernel_client_enqueue
2311 * and snd_seq_kernel_client_enqueue_blocking
2312 */
2313static int kernel_client_enqueue(int client, struct snd_seq_event *ev,
2314				 struct file *file, int blocking,
2315				 int atomic, int hop)
2316{
2317	struct snd_seq_client *cptr;
2318	int result;
2319
2320	if (snd_BUG_ON(!ev))
2321		return -EINVAL;
2322
2323	if (ev->type == SNDRV_SEQ_EVENT_NONE)
2324		return 0; /* ignore this */
2325	if (ev->type == SNDRV_SEQ_EVENT_KERNEL_ERROR)
2326		return -EINVAL; /* quoted events can't be enqueued */
2327
2328	/* fill in client number */
2329	ev->source.client = client;
2330
2331	if (check_event_type_and_length(ev))
2332		return -EINVAL;
2333
2334	cptr = snd_seq_client_use_ptr(client);
2335	if (cptr == NULL)
2336		return -EINVAL;
2337
2338	if (! cptr->accept_output)
2339		result = -EPERM;
2340	else /* send it */
2341		result = snd_seq_client_enqueue_event(cptr, ev, file, blocking, atomic, hop);
2342
2343	snd_seq_client_unlock(cptr);
2344	return result;
2345}
2346
2347/*
2348 * exported, called by kernel clients to enqueue events (w/o blocking)
2349 *
2350 * RETURN VALUE: zero if succeed, negative if error
2351 */
2352int snd_seq_kernel_client_enqueue(int client, struct snd_seq_event * ev,
2353				  int atomic, int hop)
2354{
2355	return kernel_client_enqueue(client, ev, NULL, 0, atomic, hop);
2356}
2357
2358EXPORT_SYMBOL(snd_seq_kernel_client_enqueue);
2359
2360/*
2361 * exported, called by kernel clients to enqueue events (with blocking)
2362 *
2363 * RETURN VALUE: zero if succeed, negative if error
2364 */
2365int snd_seq_kernel_client_enqueue_blocking(int client, struct snd_seq_event * ev,
2366					   struct file *file,
2367					   int atomic, int hop)
2368{
2369	return kernel_client_enqueue(client, ev, file, 1, atomic, hop);
2370}
2371
2372EXPORT_SYMBOL(snd_seq_kernel_client_enqueue_blocking);
2373
2374/*
2375 * exported, called by kernel clients to dispatch events directly to other
2376 * clients, bypassing the queues.  Event time-stamp will be updated.
2377 *
2378 * RETURN VALUE: negative = delivery failed,
2379 *		 zero, or positive: the number of delivered events
2380 */
2381int snd_seq_kernel_client_dispatch(int client, struct snd_seq_event * ev,
2382				   int atomic, int hop)
2383{
2384	struct snd_seq_client *cptr;
2385	int result;
2386
2387	if (snd_BUG_ON(!ev))
2388		return -EINVAL;
2389
2390	/* fill in client number */
2391	ev->queue = SNDRV_SEQ_QUEUE_DIRECT;
2392	ev->source.client = client;
2393
2394	if (check_event_type_and_length(ev))
2395		return -EINVAL;
2396
2397	cptr = snd_seq_client_use_ptr(client);
2398	if (cptr == NULL)
2399		return -EINVAL;
2400
2401	if (!cptr->accept_output)
2402		result = -EPERM;
2403	else
2404		result = snd_seq_deliver_event(cptr, ev, atomic, hop);
2405
2406	snd_seq_client_unlock(cptr);
2407	return result;
2408}
2409
2410EXPORT_SYMBOL(snd_seq_kernel_client_dispatch);
2411
2412/*
2413 * exported, called by kernel clients to perform same functions as with
2414 * userland ioctl()
2415 */
2416int snd_seq_kernel_client_ctl(int clientid, unsigned int cmd, void *arg)
2417{
2418	struct snd_seq_client *client;
2419	mm_segment_t fs;
2420	int result;
2421
2422	client = clientptr(clientid);
2423	if (client == NULL)
2424		return -ENXIO;
2425	fs = snd_enter_user();
2426	result = snd_seq_do_ioctl(client, cmd, (void __force __user *)arg);
2427	snd_leave_user(fs);
2428	return result;
2429}
2430
2431EXPORT_SYMBOL(snd_seq_kernel_client_ctl);
2432
2433/* exported (for OSS emulator) */
2434int snd_seq_kernel_client_write_poll(int clientid, struct file *file, poll_table *wait)
2435{
2436	struct snd_seq_client *client;
2437
2438	client = clientptr(clientid);
2439	if (client == NULL)
2440		return -ENXIO;
2441
2442	if (! snd_seq_write_pool_allocated(client))
2443		return 1;
2444	if (snd_seq_pool_poll_wait(client->pool, file, wait))
2445		return 1;
2446	return 0;
2447}
2448
2449EXPORT_SYMBOL(snd_seq_kernel_client_write_poll);
2450
2451/*---------------------------------------------------------------------------*/
2452
2453#ifdef CONFIG_PROC_FS
2454/*
2455 *  /proc interface
2456 */
2457static void snd_seq_info_dump_subscribers(struct snd_info_buffer *buffer,
2458					  struct snd_seq_port_subs_info *group,
2459					  int is_src, char *msg)
2460{
2461	struct list_head *p;
2462	struct snd_seq_subscribers *s;
2463	int count = 0;
2464
2465	down_read(&group->list_mutex);
2466	if (list_empty(&group->list_head)) {
2467		up_read(&group->list_mutex);
2468		return;
2469	}
2470	snd_iprintf(buffer, msg);
2471	list_for_each(p, &group->list_head) {
2472		if (is_src)
2473			s = list_entry(p, struct snd_seq_subscribers, src_list);
2474		else
2475			s = list_entry(p, struct snd_seq_subscribers, dest_list);
2476		if (count++)
2477			snd_iprintf(buffer, ", ");
2478		snd_iprintf(buffer, "%d:%d",
2479			    is_src ? s->info.dest.client : s->info.sender.client,
2480			    is_src ? s->info.dest.port : s->info.sender.port);
2481		if (s->info.flags & SNDRV_SEQ_PORT_SUBS_TIMESTAMP)
2482			snd_iprintf(buffer, "[%c:%d]", ((s->info.flags & SNDRV_SEQ_PORT_SUBS_TIME_REAL) ? 'r' : 't'), s->info.queue);
2483		if (group->exclusive)
2484			snd_iprintf(buffer, "[ex]");
2485	}
2486	up_read(&group->list_mutex);
2487	snd_iprintf(buffer, "\n");
2488}
2489
2490#define FLAG_PERM_RD(perm) ((perm) & SNDRV_SEQ_PORT_CAP_READ ? ((perm) & SNDRV_SEQ_PORT_CAP_SUBS_READ ? 'R' : 'r') : '-')
2491#define FLAG_PERM_WR(perm) ((perm) & SNDRV_SEQ_PORT_CAP_WRITE ? ((perm) & SNDRV_SEQ_PORT_CAP_SUBS_WRITE ? 'W' : 'w') : '-')
2492#define FLAG_PERM_EX(perm) ((perm) & SNDRV_SEQ_PORT_CAP_NO_EXPORT ? '-' : 'e')
2493
2494#define FLAG_PERM_DUPLEX(perm) ((perm) & SNDRV_SEQ_PORT_CAP_DUPLEX ? 'X' : '-')
2495
2496static void snd_seq_info_dump_ports(struct snd_info_buffer *buffer,
2497				    struct snd_seq_client *client)
2498{
2499	struct snd_seq_client_port *p;
2500
2501	mutex_lock(&client->ports_mutex);
2502	list_for_each_entry(p, &client->ports_list_head, list) {
2503		snd_iprintf(buffer, "  Port %3d : \"%s\" (%c%c%c%c)\n",
2504			    p->addr.port, p->name,
2505			    FLAG_PERM_RD(p->capability),
2506			    FLAG_PERM_WR(p->capability),
2507			    FLAG_PERM_EX(p->capability),
2508			    FLAG_PERM_DUPLEX(p->capability));
2509		snd_seq_info_dump_subscribers(buffer, &p->c_src, 1, "    Connecting To: ");
2510		snd_seq_info_dump_subscribers(buffer, &p->c_dest, 0, "    Connected From: ");
2511	}
2512	mutex_unlock(&client->ports_mutex);
2513}
2514
2515
2516/* exported to seq_info.c */
2517void snd_seq_info_clients_read(struct snd_info_entry *entry,
2518			       struct snd_info_buffer *buffer)
2519{
2520	int c;
2521	struct snd_seq_client *client;
2522
2523	snd_iprintf(buffer, "Client info\n");
2524	snd_iprintf(buffer, "  cur  clients : %d\n", client_usage.cur);
2525	snd_iprintf(buffer, "  peak clients : %d\n", client_usage.peak);
2526	snd_iprintf(buffer, "  max  clients : %d\n", SNDRV_SEQ_MAX_CLIENTS);
2527	snd_iprintf(buffer, "\n");
2528
2529	/* list the client table */
2530	for (c = 0; c < SNDRV_SEQ_MAX_CLIENTS; c++) {
2531		client = snd_seq_client_use_ptr(c);
2532		if (client == NULL)
2533			continue;
2534		if (client->type == NO_CLIENT) {
2535			snd_seq_client_unlock(client);
2536			continue;
2537		}
2538
2539		snd_iprintf(buffer, "Client %3d : \"%s\" [%s]\n",
2540			    c, client->name,
2541			    client->type == USER_CLIENT ? "User" : "Kernel");
2542		snd_seq_info_dump_ports(buffer, client);
2543		if (snd_seq_write_pool_allocated(client)) {
2544			snd_iprintf(buffer, "  Output pool :\n");
2545			snd_seq_info_pool(buffer, client->pool, "    ");
2546		}
2547		if (client->type == USER_CLIENT && client->data.user.fifo &&
2548		    client->data.user.fifo->pool) {
2549			snd_iprintf(buffer, "  Input pool :\n");
2550			snd_seq_info_pool(buffer, client->data.user.fifo->pool, "    ");
2551		}
2552		snd_seq_client_unlock(client);
2553	}
2554}
2555#endif /* CONFIG_PROC_FS */
2556
2557/*---------------------------------------------------------------------------*/
2558
2559
2560/*
2561 *  REGISTRATION PART
2562 */
2563
2564static const struct file_operations snd_seq_f_ops =
2565{
2566	.owner =	THIS_MODULE,
2567	.read =		snd_seq_read,
2568	.write =	snd_seq_write,
2569	.open =		snd_seq_open,
2570	.release =	snd_seq_release,
2571	.llseek =	no_llseek,
2572	.poll =		snd_seq_poll,
2573	.unlocked_ioctl =	snd_seq_ioctl,
2574	.compat_ioctl =	snd_seq_ioctl_compat,
2575};
2576
2577static struct device seq_dev;
2578
2579/*
2580 * register sequencer device
2581 */
2582int __init snd_sequencer_device_init(void)
2583{
2584	int err;
2585
2586	snd_device_initialize(&seq_dev, NULL);
2587	dev_set_name(&seq_dev, "seq");
2588
2589	if (mutex_lock_interruptible(&register_mutex))
2590		return -ERESTARTSYS;
2591
2592	err = snd_register_device(SNDRV_DEVICE_TYPE_SEQUENCER, NULL, 0,
2593				  &snd_seq_f_ops, NULL, &seq_dev);
2594	if (err < 0) {
2595		mutex_unlock(&register_mutex);
2596		put_device(&seq_dev);
2597		return err;
2598	}
2599
2600	mutex_unlock(&register_mutex);
2601
2602	return 0;
2603}
2604
2605
2606
2607/*
2608 * unregister sequencer device
2609 */
2610void __exit snd_sequencer_device_done(void)
2611{
2612	snd_unregister_device(&seq_dev);
2613	put_device(&seq_dev);
2614}
2615