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