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