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