Merge branch 'locking-urgent-for-linus' of git://git.kernel.org/pub/scm/linux/kernel...
[cris-mirror.git] / sound / core / seq / seq_clientmgr.c
blob04d4db44fae5c9199754aa80066ae0c1220a41d5
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>
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.
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.
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
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>
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
43 /* Client Manager
45 * this module handles the connections of userland and kernel clients
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
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
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)
68 static DEFINE_SPINLOCK(clients_lock);
69 static DEFINE_MUTEX(register_mutex);
72 * client table
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;
79 * prototypes
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);
90 static inline unsigned short snd_seq_file_flags(struct file *file)
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;
102 static inline int snd_seq_write_pool_allocated(struct snd_seq_client *client)
104 return snd_seq_total_cells(client->pool) > 0;
107 /* return pointer to client structure for specified id */
108 static struct snd_seq_client *clientptr(int clientid)
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;
115 return clienttab[clientid];
118 struct snd_seq_client *snd_seq_client_use_ptr(int clientid)
120 unsigned long flags;
121 struct snd_seq_client *client;
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;
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;
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;
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;
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);
164 snd_seq_device_load_drivers();
167 spin_lock_irqsave(&clients_lock, flags);
168 client = clientptr(clientid);
169 if (client)
170 goto __lock;
171 spin_unlock_irqrestore(&clients_lock, flags);
173 #endif
174 return NULL;
176 __lock:
177 snd_use_lock_use(&client->use_lock);
178 spin_unlock_irqrestore(&clients_lock, flags);
179 return client;
182 static void usage_alloc(struct snd_seq_usage *res, int num)
184 res->cur += num;
185 if (res->cur > res->peak)
186 res->peak = res->cur;
189 static void usage_free(struct snd_seq_usage *res, int num)
191 res->cur -= num;
194 /* initialise data structures */
195 int __init client_init_data(void)
197 /* zap out the client table */
198 memset(&clienttablock, 0, sizeof(clienttablock));
199 memset(&clienttab, 0, sizeof(clienttab));
200 return 0;
204 static struct snd_seq_client *seq_create_client1(int client_index, int poolsize)
206 unsigned long flags;
207 int c;
208 struct snd_seq_client *client;
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;
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);
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;
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;
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 */
252 static int seq_free_client1(struct snd_seq_client *client)
254 unsigned long flags;
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;
275 static void seq_free_client(struct snd_seq_client * client)
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;
289 default:
290 pr_err("ALSA: seq: Trying to free client %d with undefined type = %d\n",
291 client->number, client->type);
293 mutex_unlock(&register_mutex);
295 snd_seq_system_client_ev_client_exit(client->number);
300 /* -------------------------------------------------------- */
302 /* create a user client */
303 static int snd_seq_open(struct inode *inode, struct file *file)
305 int c, mode; /* client id */
306 struct snd_seq_client *client;
307 struct snd_seq_user_client *user;
308 int err;
310 err = nonseekable_open(inode, file);
311 if (err < 0)
312 return err;
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 */
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;
328 user = &client->data.user;
329 user->fifo = NULL;
330 user->fifo_pool_size = 0;
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;
343 usage_alloc(&client_usage, 1);
344 client->type = USER_CLIENT;
345 mutex_unlock(&register_mutex);
347 c = client->number;
348 file->private_data = client;
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));
355 /* make others aware this new client */
356 snd_seq_system_client_ev_client_start(c);
358 return 0;
361 /* delete a user client */
362 static int snd_seq_release(struct inode *inode, struct file *file)
364 struct snd_seq_client *client = file->private_data;
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);
374 return 0;
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
385 static ssize_t snd_seq_read(struct file *file, char __user *buf, size_t count,
386 loff_t *offset)
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;
394 if (!(snd_seq_file_flags(file) & SNDRV_SEQ_LFLG_INPUT))
395 return -ENXIO;
397 if (!access_ok(VERIFY_WRITE, buf, count))
398 return -EFAULT;
400 /* check client structures are in place */
401 if (snd_BUG_ON(!client))
402 return -ENXIO;
404 if (!client->accept_input || (fifo = client->data.user.fifo) == NULL)
405 return -ENXIO;
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;
414 cell = NULL;
415 err = 0;
416 snd_seq_fifo_lock(fifo);
418 /* while data available in queue */
419 while (count >= sizeof(struct snd_seq_event)) {
420 int nonblock;
422 nonblock = (file->f_flags & O_NONBLOCK) || result > 0;
423 if ((err = snd_seq_fifo_cell_out(fifo, &cell, nonblock)) < 0) {
424 break;
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;
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;
449 count -= sizeof(struct snd_seq_event);
450 buf += sizeof(struct snd_seq_event);
452 snd_seq_cell_free(cell);
453 cell = NULL; /* to be sure */
454 result += sizeof(struct snd_seq_event);
457 if (err < 0) {
458 if (cell)
459 snd_seq_fifo_cell_putback(fifo, cell);
460 if (err == -EAGAIN && result > 0)
461 err = 0;
463 snd_seq_fifo_unlock(fifo);
465 return (err < 0) ? err : result;
470 * check access permission to the port
472 static int check_port_perm(struct snd_seq_client_port *port, unsigned int flags)
474 if ((port->capability & flags) != flags)
475 return 0;
476 return flags;
480 * check if the destination client is available, and return the pointer
481 * if filter is non-zero, client filter bitmap is tested.
483 static struct snd_seq_client *get_event_dest_client(struct snd_seq_event *event,
484 int filter)
486 struct snd_seq_client *dest;
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;
499 return dest; /* ok - accessible */
500 __not_avail:
501 snd_seq_client_unlock(dest);
502 return NULL;
507 * Return the error event.
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.
517 static int bounce_error_event(struct snd_seq_client *client,
518 struct snd_seq_event *event,
519 int err, int atomic, int hop)
521 struct snd_seq_event bounce_ev;
522 int result;
524 if (client == NULL ||
525 ! (client->filter & SNDRV_SEQ_FILTER_BOUNCE) ||
526 ! client->accept_input)
527 return 0; /* ignored */
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;
547 return result;
552 * rewrite the time-stamp of the event record with the curren time
553 * of the given queue.
554 * return non-zero if updated.
556 static int update_timestamp_of_queue(struct snd_seq_event *event,
557 int queue, int real_time)
559 struct snd_seq_queue *q;
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;
573 queuefree(q);
574 return 1;
579 * deliver an event to the specified destination.
580 * if filter is non-zero, client filter bitmap is tested.
582 * RETURN VALUE: 0 : if succeeded
583 * <0 : error
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)
589 struct snd_seq_client *dest = NULL;
590 struct snd_seq_client_port *dest_port = NULL;
591 int result = -ENOENT;
592 int direct;
594 direct = snd_seq_ev_is_direct(event);
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;
603 /* check permission */
604 if (! check_port_perm(dest_port, SNDRV_SEQ_PORT_CAP_WRITE)) {
605 result = -EPERM;
606 goto __skip;
609 if (dest_port->timestamping)
610 update_timestamp_of_queue(event, dest_port->time_queue,
611 dest_port->time_real);
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;
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;
630 __skip:
631 if (dest_port)
632 snd_seq_port_unlock(dest_port);
633 if (dest)
634 snd_seq_client_unlock(dest);
636 if (result < 0 && !direct) {
637 result = bounce_error_event(client, event, result, atomic, hop);
639 return result;
644 * send the event to all subscribers:
646 static int deliver_to_subscribers(struct snd_seq_client *client,
647 struct snd_seq_event *event,
648 int atomic, int hop)
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;
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;
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;
685 num_ev++;
686 /* restore original event record */
687 *event = event_saved;
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;
699 #ifdef SUPPORT_BROADCAST
701 * broadcast to all ports:
703 static int port_broadcast_event(struct snd_seq_client *client,
704 struct snd_seq_event *event,
705 int atomic, int hop)
707 int num_ev = 0, err, result = 0;
708 struct snd_seq_client *dest_client;
709 struct snd_seq_client_port *port;
711 dest_client = get_event_dest_client(event, SNDRV_SEQ_FILTER_BROADCAST);
712 if (dest_client == NULL)
713 return 0; /* no matching destination */
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;
728 num_ev++;
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;
737 * send the event to all clients:
738 * if destination port is also ADDRESS_BROADCAST, deliver to all ports.
740 static int broadcast_event(struct snd_seq_client *client,
741 struct snd_seq_event *event, int atomic, int hop)
743 int err, result = 0, num_ev = 0;
744 int dest;
745 struct snd_seq_addr addr;
747 addr = event->dest; /* save */
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;
768 num_ev += err;
770 event->dest = addr; /* restore */
771 return (result < 0) ? result : num_ev;
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)
779 pr_debug("ALSA: seq: multicast not supported yet.\n");
780 return 0; /* ignored */
782 #endif /* SUPPORT_BROADCAST */
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.
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.
793 static int snd_seq_deliver_event(struct snd_seq_client *client, struct snd_seq_event *event,
794 int atomic, int hop)
796 int result;
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;
806 if (snd_seq_ev_is_variable(event) &&
807 snd_BUG_ON(atomic && (event->data.ext.len & SNDRV_SEQ_EXT_USRPTR)))
808 return -EINVAL;
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);
825 return result;
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.
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.
838 int snd_seq_dispatch_event(struct snd_seq_event_cell *cell, int atomic, int hop)
840 struct snd_seq_client *client;
841 int result;
843 if (snd_BUG_ON(!cell))
844 return -EINVAL;
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;
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.
857 struct snd_seq_event tmpev, *ev;
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);
865 * This was originally a note event. We now re-use the
866 * cell for the note-off event.
869 ev = &cell->event;
870 ev->type = SNDRV_SEQ_EVENT_NOTEOFF;
871 ev->flags |= SNDRV_SEQ_PRIORITY_HIGH;
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;
886 ev->data.note.velocity = ev->data.note.off_velocity;
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 */
892 } else {
893 /* Normal events:
894 * event cell is freed after processing the event
897 result = snd_seq_deliver_event(client, &cell->event, atomic, hop);
898 snd_seq_cell_free(cell);
901 snd_seq_client_unlock(client);
902 return result;
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.
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)
915 struct snd_seq_event_cell *cell;
916 int err;
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;
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);
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);
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 */
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;
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;
961 return 0;
966 * check validity of event type and data length.
967 * return non-zero if invalid.
969 static int check_event_type_and_length(struct snd_seq_event *ev)
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;
986 return 0;
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
1001 static ssize_t snd_seq_write(struct file *file, const char __user *buf,
1002 size_t count, loff_t *offset)
1004 struct snd_seq_client *client = file->private_data;
1005 int written = 0, len;
1006 int err;
1007 struct snd_seq_event event;
1009 if (!(snd_seq_file_flags(file) & SNDRV_SEQ_LFLG_OUTPUT))
1010 return -ENXIO;
1012 /* check client structures are in place */
1013 if (snd_BUG_ON(!client))
1014 return -ENXIO;
1016 if (!client->accept_output || client->pool == NULL)
1017 return -ENXIO;
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 mutex_lock(&client->ioctl_mutex);
1022 err = snd_seq_pool_init(client->pool);
1023 mutex_unlock(&client->ioctl_mutex);
1024 if (err < 0)
1025 return -ENOMEM;
1028 /* only process whole events */
1029 err = -EINVAL;
1030 while (count >= sizeof(struct snd_seq_event)) {
1031 /* Read in the event header from the user */
1032 len = sizeof(event);
1033 if (copy_from_user(&event, buf, len)) {
1034 err = -EFAULT;
1035 break;
1037 event.source.client = client->number; /* fill in client number */
1038 /* Check for extension data length */
1039 if (check_event_type_and_length(&event)) {
1040 err = -EINVAL;
1041 break;
1044 /* check for special events */
1045 if (event.type == SNDRV_SEQ_EVENT_NONE)
1046 goto __skip_event;
1047 else if (snd_seq_ev_is_reserved(&event)) {
1048 err = -EINVAL;
1049 break;
1052 if (snd_seq_ev_is_variable(&event)) {
1053 int extlen = event.data.ext.len & ~SNDRV_SEQ_EXT_MASK;
1054 if ((size_t)(extlen + len) > count) {
1055 /* back out, will get an error this time or next */
1056 err = -EINVAL;
1057 break;
1059 /* set user space pointer */
1060 event.data.ext.len = extlen | SNDRV_SEQ_EXT_USRPTR;
1061 event.data.ext.ptr = (char __force *)buf
1062 + sizeof(struct snd_seq_event);
1063 len += extlen; /* increment data length */
1064 } else {
1065 #ifdef CONFIG_COMPAT
1066 if (client->convert32 && snd_seq_ev_is_varusr(&event)) {
1067 void *ptr = (void __force *)compat_ptr(event.data.raw32.d[1]);
1068 event.data.ext.ptr = ptr;
1070 #endif
1073 /* ok, enqueue it */
1074 err = snd_seq_client_enqueue_event(client, &event, file,
1075 !(file->f_flags & O_NONBLOCK),
1076 0, 0);
1077 if (err < 0)
1078 break;
1080 __skip_event:
1081 /* Update pointers and counts */
1082 count -= len;
1083 buf += len;
1084 written += len;
1087 return written ? written : err;
1092 * handle polling
1094 static __poll_t snd_seq_poll(struct file *file, poll_table * wait)
1096 struct snd_seq_client *client = file->private_data;
1097 __poll_t mask = 0;
1099 /* check client structures are in place */
1100 if (snd_BUG_ON(!client))
1101 return -ENXIO;
1103 if ((snd_seq_file_flags(file) & SNDRV_SEQ_LFLG_INPUT) &&
1104 client->data.user.fifo) {
1106 /* check if data is available in the outqueue */
1107 if (snd_seq_fifo_poll_wait(client->data.user.fifo, file, wait))
1108 mask |= EPOLLIN | EPOLLRDNORM;
1111 if (snd_seq_file_flags(file) & SNDRV_SEQ_LFLG_OUTPUT) {
1113 /* check if data is available in the pool */
1114 if (!snd_seq_write_pool_allocated(client) ||
1115 snd_seq_pool_poll_wait(client->pool, file, wait))
1116 mask |= EPOLLOUT | EPOLLWRNORM;
1119 return mask;
1123 /*-----------------------------------------------------*/
1125 static int snd_seq_ioctl_pversion(struct snd_seq_client *client, void *arg)
1127 int *pversion = arg;
1129 *pversion = SNDRV_SEQ_VERSION;
1130 return 0;
1133 static int snd_seq_ioctl_client_id(struct snd_seq_client *client, void *arg)
1135 int *client_id = arg;
1137 *client_id = client->number;
1138 return 0;
1141 /* SYSTEM_INFO ioctl() */
1142 static int snd_seq_ioctl_system_info(struct snd_seq_client *client, void *arg)
1144 struct snd_seq_system_info *info = arg;
1146 memset(info, 0, sizeof(*info));
1147 /* fill the info fields */
1148 info->queues = SNDRV_SEQ_MAX_QUEUES;
1149 info->clients = SNDRV_SEQ_MAX_CLIENTS;
1150 info->ports = SNDRV_SEQ_MAX_PORTS;
1151 info->channels = 256; /* fixed limit */
1152 info->cur_clients = client_usage.cur;
1153 info->cur_queues = snd_seq_queue_get_cur_queues();
1155 return 0;
1159 /* RUNNING_MODE ioctl() */
1160 static int snd_seq_ioctl_running_mode(struct snd_seq_client *client, void *arg)
1162 struct snd_seq_running_info *info = arg;
1163 struct snd_seq_client *cptr;
1164 int err = 0;
1166 /* requested client number */
1167 cptr = snd_seq_client_use_ptr(info->client);
1168 if (cptr == NULL)
1169 return -ENOENT; /* don't change !!! */
1171 #ifdef SNDRV_BIG_ENDIAN
1172 if (!info->big_endian) {
1173 err = -EINVAL;
1174 goto __err;
1176 #else
1177 if (info->big_endian) {
1178 err = -EINVAL;
1179 goto __err;
1182 #endif
1183 if (info->cpu_mode > sizeof(long)) {
1184 err = -EINVAL;
1185 goto __err;
1187 cptr->convert32 = (info->cpu_mode < sizeof(long));
1188 __err:
1189 snd_seq_client_unlock(cptr);
1190 return err;
1193 /* CLIENT_INFO ioctl() */
1194 static void get_client_info(struct snd_seq_client *cptr,
1195 struct snd_seq_client_info *info)
1197 info->client = cptr->number;
1199 /* fill the info fields */
1200 info->type = cptr->type;
1201 strcpy(info->name, cptr->name);
1202 info->filter = cptr->filter;
1203 info->event_lost = cptr->event_lost;
1204 memcpy(info->event_filter, cptr->event_filter, 32);
1205 info->num_ports = cptr->num_ports;
1207 if (cptr->type == USER_CLIENT)
1208 info->pid = pid_vnr(cptr->data.user.owner);
1209 else
1210 info->pid = -1;
1212 if (cptr->type == KERNEL_CLIENT)
1213 info->card = cptr->data.kernel.card ? cptr->data.kernel.card->number : -1;
1214 else
1215 info->card = -1;
1217 memset(info->reserved, 0, sizeof(info->reserved));
1220 static int snd_seq_ioctl_get_client_info(struct snd_seq_client *client,
1221 void *arg)
1223 struct snd_seq_client_info *client_info = arg;
1224 struct snd_seq_client *cptr;
1226 /* requested client number */
1227 cptr = snd_seq_client_use_ptr(client_info->client);
1228 if (cptr == NULL)
1229 return -ENOENT; /* don't change !!! */
1231 get_client_info(cptr, client_info);
1232 snd_seq_client_unlock(cptr);
1234 return 0;
1238 /* CLIENT_INFO ioctl() */
1239 static int snd_seq_ioctl_set_client_info(struct snd_seq_client *client,
1240 void *arg)
1242 struct snd_seq_client_info *client_info = arg;
1244 /* it is not allowed to set the info fields for an another client */
1245 if (client->number != client_info->client)
1246 return -EPERM;
1247 /* also client type must be set now */
1248 if (client->type != client_info->type)
1249 return -EINVAL;
1251 /* fill the info fields */
1252 if (client_info->name[0])
1253 strlcpy(client->name, client_info->name, sizeof(client->name));
1255 client->filter = client_info->filter;
1256 client->event_lost = client_info->event_lost;
1257 memcpy(client->event_filter, client_info->event_filter, 32);
1259 return 0;
1264 * CREATE PORT ioctl()
1266 static int snd_seq_ioctl_create_port(struct snd_seq_client *client, void *arg)
1268 struct snd_seq_port_info *info = arg;
1269 struct snd_seq_client_port *port;
1270 struct snd_seq_port_callback *callback;
1271 int port_idx;
1273 /* it is not allowed to create the port for an another client */
1274 if (info->addr.client != client->number)
1275 return -EPERM;
1277 port = snd_seq_create_port(client, (info->flags & SNDRV_SEQ_PORT_FLG_GIVEN_PORT) ? info->addr.port : -1);
1278 if (port == NULL)
1279 return -ENOMEM;
1281 if (client->type == USER_CLIENT && info->kernel) {
1282 port_idx = port->addr.port;
1283 snd_seq_port_unlock(port);
1284 snd_seq_delete_port(client, port_idx);
1285 return -EINVAL;
1287 if (client->type == KERNEL_CLIENT) {
1288 if ((callback = info->kernel) != NULL) {
1289 if (callback->owner)
1290 port->owner = callback->owner;
1291 port->private_data = callback->private_data;
1292 port->private_free = callback->private_free;
1293 port->event_input = callback->event_input;
1294 port->c_src.open = callback->subscribe;
1295 port->c_src.close = callback->unsubscribe;
1296 port->c_dest.open = callback->use;
1297 port->c_dest.close = callback->unuse;
1301 info->addr = port->addr;
1303 snd_seq_set_port_info(port, info);
1304 snd_seq_system_client_ev_port_start(port->addr.client, port->addr.port);
1305 snd_seq_port_unlock(port);
1307 return 0;
1311 * DELETE PORT ioctl()
1313 static int snd_seq_ioctl_delete_port(struct snd_seq_client *client, void *arg)
1315 struct snd_seq_port_info *info = arg;
1316 int err;
1318 /* it is not allowed to remove the port for an another client */
1319 if (info->addr.client != client->number)
1320 return -EPERM;
1322 err = snd_seq_delete_port(client, info->addr.port);
1323 if (err >= 0)
1324 snd_seq_system_client_ev_port_exit(client->number, info->addr.port);
1325 return err;
1330 * GET_PORT_INFO ioctl() (on any client)
1332 static int snd_seq_ioctl_get_port_info(struct snd_seq_client *client, void *arg)
1334 struct snd_seq_port_info *info = arg;
1335 struct snd_seq_client *cptr;
1336 struct snd_seq_client_port *port;
1338 cptr = snd_seq_client_use_ptr(info->addr.client);
1339 if (cptr == NULL)
1340 return -ENXIO;
1342 port = snd_seq_port_use_ptr(cptr, info->addr.port);
1343 if (port == NULL) {
1344 snd_seq_client_unlock(cptr);
1345 return -ENOENT; /* don't change */
1348 /* get port info */
1349 snd_seq_get_port_info(port, info);
1350 snd_seq_port_unlock(port);
1351 snd_seq_client_unlock(cptr);
1353 return 0;
1358 * SET_PORT_INFO ioctl() (only ports on this/own client)
1360 static int snd_seq_ioctl_set_port_info(struct snd_seq_client *client, void *arg)
1362 struct snd_seq_port_info *info = arg;
1363 struct snd_seq_client_port *port;
1365 if (info->addr.client != client->number) /* only set our own ports ! */
1366 return -EPERM;
1367 port = snd_seq_port_use_ptr(client, info->addr.port);
1368 if (port) {
1369 snd_seq_set_port_info(port, info);
1370 snd_seq_port_unlock(port);
1372 return 0;
1377 * port subscription (connection)
1379 #define PERM_RD (SNDRV_SEQ_PORT_CAP_READ|SNDRV_SEQ_PORT_CAP_SUBS_READ)
1380 #define PERM_WR (SNDRV_SEQ_PORT_CAP_WRITE|SNDRV_SEQ_PORT_CAP_SUBS_WRITE)
1382 static int check_subscription_permission(struct snd_seq_client *client,
1383 struct snd_seq_client_port *sport,
1384 struct snd_seq_client_port *dport,
1385 struct snd_seq_port_subscribe *subs)
1387 if (client->number != subs->sender.client &&
1388 client->number != subs->dest.client) {
1389 /* connection by third client - check export permission */
1390 if (check_port_perm(sport, SNDRV_SEQ_PORT_CAP_NO_EXPORT))
1391 return -EPERM;
1392 if (check_port_perm(dport, SNDRV_SEQ_PORT_CAP_NO_EXPORT))
1393 return -EPERM;
1396 /* check read permission */
1397 /* if sender or receiver is the subscribing client itself,
1398 * no permission check is necessary
1400 if (client->number != subs->sender.client) {
1401 if (! check_port_perm(sport, PERM_RD))
1402 return -EPERM;
1404 /* check write permission */
1405 if (client->number != subs->dest.client) {
1406 if (! check_port_perm(dport, PERM_WR))
1407 return -EPERM;
1409 return 0;
1413 * send an subscription notify event to user client:
1414 * client must be user client.
1416 int snd_seq_client_notify_subscription(int client, int port,
1417 struct snd_seq_port_subscribe *info,
1418 int evtype)
1420 struct snd_seq_event event;
1422 memset(&event, 0, sizeof(event));
1423 event.type = evtype;
1424 event.data.connect.dest = info->dest;
1425 event.data.connect.sender = info->sender;
1427 return snd_seq_system_notify(client, port, &event); /* non-atomic */
1432 * add to port's subscription list IOCTL interface
1434 static int snd_seq_ioctl_subscribe_port(struct snd_seq_client *client,
1435 void *arg)
1437 struct snd_seq_port_subscribe *subs = arg;
1438 int result = -EINVAL;
1439 struct snd_seq_client *receiver = NULL, *sender = NULL;
1440 struct snd_seq_client_port *sport = NULL, *dport = NULL;
1442 if ((receiver = snd_seq_client_use_ptr(subs->dest.client)) == NULL)
1443 goto __end;
1444 if ((sender = snd_seq_client_use_ptr(subs->sender.client)) == NULL)
1445 goto __end;
1446 if ((sport = snd_seq_port_use_ptr(sender, subs->sender.port)) == NULL)
1447 goto __end;
1448 if ((dport = snd_seq_port_use_ptr(receiver, subs->dest.port)) == NULL)
1449 goto __end;
1451 result = check_subscription_permission(client, sport, dport, subs);
1452 if (result < 0)
1453 goto __end;
1455 /* connect them */
1456 result = snd_seq_port_connect(client, sender, sport, receiver, dport, subs);
1457 if (! result) /* broadcast announce */
1458 snd_seq_client_notify_subscription(SNDRV_SEQ_ADDRESS_SUBSCRIBERS, 0,
1459 subs, SNDRV_SEQ_EVENT_PORT_SUBSCRIBED);
1460 __end:
1461 if (sport)
1462 snd_seq_port_unlock(sport);
1463 if (dport)
1464 snd_seq_port_unlock(dport);
1465 if (sender)
1466 snd_seq_client_unlock(sender);
1467 if (receiver)
1468 snd_seq_client_unlock(receiver);
1469 return result;
1474 * remove from port's subscription list
1476 static int snd_seq_ioctl_unsubscribe_port(struct snd_seq_client *client,
1477 void *arg)
1479 struct snd_seq_port_subscribe *subs = arg;
1480 int result = -ENXIO;
1481 struct snd_seq_client *receiver = NULL, *sender = NULL;
1482 struct snd_seq_client_port *sport = NULL, *dport = NULL;
1484 if ((receiver = snd_seq_client_use_ptr(subs->dest.client)) == NULL)
1485 goto __end;
1486 if ((sender = snd_seq_client_use_ptr(subs->sender.client)) == NULL)
1487 goto __end;
1488 if ((sport = snd_seq_port_use_ptr(sender, subs->sender.port)) == NULL)
1489 goto __end;
1490 if ((dport = snd_seq_port_use_ptr(receiver, subs->dest.port)) == NULL)
1491 goto __end;
1493 result = check_subscription_permission(client, sport, dport, subs);
1494 if (result < 0)
1495 goto __end;
1497 result = snd_seq_port_disconnect(client, sender, sport, receiver, dport, subs);
1498 if (! result) /* broadcast announce */
1499 snd_seq_client_notify_subscription(SNDRV_SEQ_ADDRESS_SUBSCRIBERS, 0,
1500 subs, SNDRV_SEQ_EVENT_PORT_UNSUBSCRIBED);
1501 __end:
1502 if (sport)
1503 snd_seq_port_unlock(sport);
1504 if (dport)
1505 snd_seq_port_unlock(dport);
1506 if (sender)
1507 snd_seq_client_unlock(sender);
1508 if (receiver)
1509 snd_seq_client_unlock(receiver);
1510 return result;
1514 /* CREATE_QUEUE ioctl() */
1515 static int snd_seq_ioctl_create_queue(struct snd_seq_client *client, void *arg)
1517 struct snd_seq_queue_info *info = arg;
1518 struct snd_seq_queue *q;
1520 q = snd_seq_queue_alloc(client->number, info->locked, info->flags);
1521 if (IS_ERR(q))
1522 return PTR_ERR(q);
1524 info->queue = q->queue;
1525 info->locked = q->locked;
1526 info->owner = q->owner;
1528 /* set queue name */
1529 if (!info->name[0])
1530 snprintf(info->name, sizeof(info->name), "Queue-%d", q->queue);
1531 strlcpy(q->name, info->name, sizeof(q->name));
1532 snd_use_lock_free(&q->use_lock);
1534 return 0;
1537 /* DELETE_QUEUE ioctl() */
1538 static int snd_seq_ioctl_delete_queue(struct snd_seq_client *client, void *arg)
1540 struct snd_seq_queue_info *info = arg;
1542 return snd_seq_queue_delete(client->number, info->queue);
1545 /* GET_QUEUE_INFO ioctl() */
1546 static int snd_seq_ioctl_get_queue_info(struct snd_seq_client *client,
1547 void *arg)
1549 struct snd_seq_queue_info *info = arg;
1550 struct snd_seq_queue *q;
1552 q = queueptr(info->queue);
1553 if (q == NULL)
1554 return -EINVAL;
1556 memset(info, 0, sizeof(*info));
1557 info->queue = q->queue;
1558 info->owner = q->owner;
1559 info->locked = q->locked;
1560 strlcpy(info->name, q->name, sizeof(info->name));
1561 queuefree(q);
1563 return 0;
1566 /* SET_QUEUE_INFO ioctl() */
1567 static int snd_seq_ioctl_set_queue_info(struct snd_seq_client *client,
1568 void *arg)
1570 struct snd_seq_queue_info *info = arg;
1571 struct snd_seq_queue *q;
1573 if (info->owner != client->number)
1574 return -EINVAL;
1576 /* change owner/locked permission */
1577 if (snd_seq_queue_check_access(info->queue, client->number)) {
1578 if (snd_seq_queue_set_owner(info->queue, client->number, info->locked) < 0)
1579 return -EPERM;
1580 if (info->locked)
1581 snd_seq_queue_use(info->queue, client->number, 1);
1582 } else {
1583 return -EPERM;
1586 q = queueptr(info->queue);
1587 if (! q)
1588 return -EINVAL;
1589 if (q->owner != client->number) {
1590 queuefree(q);
1591 return -EPERM;
1593 strlcpy(q->name, info->name, sizeof(q->name));
1594 queuefree(q);
1596 return 0;
1599 /* GET_NAMED_QUEUE ioctl() */
1600 static int snd_seq_ioctl_get_named_queue(struct snd_seq_client *client,
1601 void *arg)
1603 struct snd_seq_queue_info *info = arg;
1604 struct snd_seq_queue *q;
1606 q = snd_seq_queue_find_name(info->name);
1607 if (q == NULL)
1608 return -EINVAL;
1609 info->queue = q->queue;
1610 info->owner = q->owner;
1611 info->locked = q->locked;
1612 queuefree(q);
1614 return 0;
1617 /* GET_QUEUE_STATUS ioctl() */
1618 static int snd_seq_ioctl_get_queue_status(struct snd_seq_client *client,
1619 void *arg)
1621 struct snd_seq_queue_status *status = arg;
1622 struct snd_seq_queue *queue;
1623 struct snd_seq_timer *tmr;
1625 queue = queueptr(status->queue);
1626 if (queue == NULL)
1627 return -EINVAL;
1628 memset(status, 0, sizeof(*status));
1629 status->queue = queue->queue;
1631 tmr = queue->timer;
1632 status->events = queue->tickq->cells + queue->timeq->cells;
1634 status->time = snd_seq_timer_get_cur_time(tmr);
1635 status->tick = snd_seq_timer_get_cur_tick(tmr);
1637 status->running = tmr->running;
1639 status->flags = queue->flags;
1640 queuefree(queue);
1642 return 0;
1646 /* GET_QUEUE_TEMPO ioctl() */
1647 static int snd_seq_ioctl_get_queue_tempo(struct snd_seq_client *client,
1648 void *arg)
1650 struct snd_seq_queue_tempo *tempo = arg;
1651 struct snd_seq_queue *queue;
1652 struct snd_seq_timer *tmr;
1654 queue = queueptr(tempo->queue);
1655 if (queue == NULL)
1656 return -EINVAL;
1657 memset(tempo, 0, sizeof(*tempo));
1658 tempo->queue = queue->queue;
1660 tmr = queue->timer;
1662 tempo->tempo = tmr->tempo;
1663 tempo->ppq = tmr->ppq;
1664 tempo->skew_value = tmr->skew;
1665 tempo->skew_base = tmr->skew_base;
1666 queuefree(queue);
1668 return 0;
1672 /* SET_QUEUE_TEMPO ioctl() */
1673 int snd_seq_set_queue_tempo(int client, struct snd_seq_queue_tempo *tempo)
1675 if (!snd_seq_queue_check_access(tempo->queue, client))
1676 return -EPERM;
1677 return snd_seq_queue_timer_set_tempo(tempo->queue, client, tempo);
1679 EXPORT_SYMBOL(snd_seq_set_queue_tempo);
1681 static int snd_seq_ioctl_set_queue_tempo(struct snd_seq_client *client,
1682 void *arg)
1684 struct snd_seq_queue_tempo *tempo = arg;
1685 int result;
1687 result = snd_seq_set_queue_tempo(client->number, tempo);
1688 return result < 0 ? result : 0;
1692 /* GET_QUEUE_TIMER ioctl() */
1693 static int snd_seq_ioctl_get_queue_timer(struct snd_seq_client *client,
1694 void *arg)
1696 struct snd_seq_queue_timer *timer = arg;
1697 struct snd_seq_queue *queue;
1698 struct snd_seq_timer *tmr;
1700 queue = queueptr(timer->queue);
1701 if (queue == NULL)
1702 return -EINVAL;
1704 if (mutex_lock_interruptible(&queue->timer_mutex)) {
1705 queuefree(queue);
1706 return -ERESTARTSYS;
1708 tmr = queue->timer;
1709 memset(timer, 0, sizeof(*timer));
1710 timer->queue = queue->queue;
1712 timer->type = tmr->type;
1713 if (tmr->type == SNDRV_SEQ_TIMER_ALSA) {
1714 timer->u.alsa.id = tmr->alsa_id;
1715 timer->u.alsa.resolution = tmr->preferred_resolution;
1717 mutex_unlock(&queue->timer_mutex);
1718 queuefree(queue);
1720 return 0;
1724 /* SET_QUEUE_TIMER ioctl() */
1725 static int snd_seq_ioctl_set_queue_timer(struct snd_seq_client *client,
1726 void *arg)
1728 struct snd_seq_queue_timer *timer = arg;
1729 int result = 0;
1731 if (timer->type != SNDRV_SEQ_TIMER_ALSA)
1732 return -EINVAL;
1734 if (snd_seq_queue_check_access(timer->queue, client->number)) {
1735 struct snd_seq_queue *q;
1736 struct snd_seq_timer *tmr;
1738 q = queueptr(timer->queue);
1739 if (q == NULL)
1740 return -ENXIO;
1741 if (mutex_lock_interruptible(&q->timer_mutex)) {
1742 queuefree(q);
1743 return -ERESTARTSYS;
1745 tmr = q->timer;
1746 snd_seq_queue_timer_close(timer->queue);
1747 tmr->type = timer->type;
1748 if (tmr->type == SNDRV_SEQ_TIMER_ALSA) {
1749 tmr->alsa_id = timer->u.alsa.id;
1750 tmr->preferred_resolution = timer->u.alsa.resolution;
1752 result = snd_seq_queue_timer_open(timer->queue);
1753 mutex_unlock(&q->timer_mutex);
1754 queuefree(q);
1755 } else {
1756 return -EPERM;
1759 return result;
1763 /* GET_QUEUE_CLIENT ioctl() */
1764 static int snd_seq_ioctl_get_queue_client(struct snd_seq_client *client,
1765 void *arg)
1767 struct snd_seq_queue_client *info = arg;
1768 int used;
1770 used = snd_seq_queue_is_used(info->queue, client->number);
1771 if (used < 0)
1772 return -EINVAL;
1773 info->used = used;
1774 info->client = client->number;
1776 return 0;
1780 /* SET_QUEUE_CLIENT ioctl() */
1781 static int snd_seq_ioctl_set_queue_client(struct snd_seq_client *client,
1782 void *arg)
1784 struct snd_seq_queue_client *info = arg;
1785 int err;
1787 if (info->used >= 0) {
1788 err = snd_seq_queue_use(info->queue, client->number, info->used);
1789 if (err < 0)
1790 return err;
1793 return snd_seq_ioctl_get_queue_client(client, arg);
1797 /* GET_CLIENT_POOL ioctl() */
1798 static int snd_seq_ioctl_get_client_pool(struct snd_seq_client *client,
1799 void *arg)
1801 struct snd_seq_client_pool *info = arg;
1802 struct snd_seq_client *cptr;
1804 cptr = snd_seq_client_use_ptr(info->client);
1805 if (cptr == NULL)
1806 return -ENOENT;
1807 memset(info, 0, sizeof(*info));
1808 info->client = cptr->number;
1809 info->output_pool = cptr->pool->size;
1810 info->output_room = cptr->pool->room;
1811 info->output_free = info->output_pool;
1812 info->output_free = snd_seq_unused_cells(cptr->pool);
1813 if (cptr->type == USER_CLIENT) {
1814 info->input_pool = cptr->data.user.fifo_pool_size;
1815 info->input_free = info->input_pool;
1816 if (cptr->data.user.fifo)
1817 info->input_free = snd_seq_unused_cells(cptr->data.user.fifo->pool);
1818 } else {
1819 info->input_pool = 0;
1820 info->input_free = 0;
1822 snd_seq_client_unlock(cptr);
1824 return 0;
1827 /* SET_CLIENT_POOL ioctl() */
1828 static int snd_seq_ioctl_set_client_pool(struct snd_seq_client *client,
1829 void *arg)
1831 struct snd_seq_client_pool *info = arg;
1832 int rc;
1834 if (client->number != info->client)
1835 return -EINVAL; /* can't change other clients */
1837 if (info->output_pool >= 1 && info->output_pool <= SNDRV_SEQ_MAX_EVENTS &&
1838 (! snd_seq_write_pool_allocated(client) ||
1839 info->output_pool != client->pool->size)) {
1840 if (snd_seq_write_pool_allocated(client)) {
1841 /* remove all existing cells */
1842 snd_seq_pool_mark_closing(client->pool);
1843 snd_seq_queue_client_leave_cells(client->number);
1844 snd_seq_pool_done(client->pool);
1846 client->pool->size = info->output_pool;
1847 rc = snd_seq_pool_init(client->pool);
1848 if (rc < 0)
1849 return rc;
1851 if (client->type == USER_CLIENT && client->data.user.fifo != NULL &&
1852 info->input_pool >= 1 &&
1853 info->input_pool <= SNDRV_SEQ_MAX_CLIENT_EVENTS &&
1854 info->input_pool != client->data.user.fifo_pool_size) {
1855 /* change pool size */
1856 rc = snd_seq_fifo_resize(client->data.user.fifo, info->input_pool);
1857 if (rc < 0)
1858 return rc;
1859 client->data.user.fifo_pool_size = info->input_pool;
1861 if (info->output_room >= 1 &&
1862 info->output_room <= client->pool->size) {
1863 client->pool->room = info->output_room;
1866 return snd_seq_ioctl_get_client_pool(client, arg);
1870 /* REMOVE_EVENTS ioctl() */
1871 static int snd_seq_ioctl_remove_events(struct snd_seq_client *client,
1872 void *arg)
1874 struct snd_seq_remove_events *info = arg;
1877 * Input mostly not implemented XXX.
1879 if (info->remove_mode & SNDRV_SEQ_REMOVE_INPUT) {
1881 * No restrictions so for a user client we can clear
1882 * the whole fifo
1884 if (client->type == USER_CLIENT && client->data.user.fifo)
1885 snd_seq_fifo_clear(client->data.user.fifo);
1888 if (info->remove_mode & SNDRV_SEQ_REMOVE_OUTPUT)
1889 snd_seq_queue_remove_cells(client->number, info);
1891 return 0;
1896 * get subscription info
1898 static int snd_seq_ioctl_get_subscription(struct snd_seq_client *client,
1899 void *arg)
1901 struct snd_seq_port_subscribe *subs = arg;
1902 int result;
1903 struct snd_seq_client *sender = NULL;
1904 struct snd_seq_client_port *sport = NULL;
1905 struct snd_seq_subscribers *p;
1907 result = -EINVAL;
1908 if ((sender = snd_seq_client_use_ptr(subs->sender.client)) == NULL)
1909 goto __end;
1910 if ((sport = snd_seq_port_use_ptr(sender, subs->sender.port)) == NULL)
1911 goto __end;
1912 p = snd_seq_port_get_subscription(&sport->c_src, &subs->dest);
1913 if (p) {
1914 result = 0;
1915 *subs = p->info;
1916 } else
1917 result = -ENOENT;
1919 __end:
1920 if (sport)
1921 snd_seq_port_unlock(sport);
1922 if (sender)
1923 snd_seq_client_unlock(sender);
1925 return result;
1930 * get subscription info - check only its presence
1932 static int snd_seq_ioctl_query_subs(struct snd_seq_client *client, void *arg)
1934 struct snd_seq_query_subs *subs = arg;
1935 int result = -ENXIO;
1936 struct snd_seq_client *cptr = NULL;
1937 struct snd_seq_client_port *port = NULL;
1938 struct snd_seq_port_subs_info *group;
1939 struct list_head *p;
1940 int i;
1942 if ((cptr = snd_seq_client_use_ptr(subs->root.client)) == NULL)
1943 goto __end;
1944 if ((port = snd_seq_port_use_ptr(cptr, subs->root.port)) == NULL)
1945 goto __end;
1947 switch (subs->type) {
1948 case SNDRV_SEQ_QUERY_SUBS_READ:
1949 group = &port->c_src;
1950 break;
1951 case SNDRV_SEQ_QUERY_SUBS_WRITE:
1952 group = &port->c_dest;
1953 break;
1954 default:
1955 goto __end;
1958 down_read(&group->list_mutex);
1959 /* search for the subscriber */
1960 subs->num_subs = group->count;
1961 i = 0;
1962 result = -ENOENT;
1963 list_for_each(p, &group->list_head) {
1964 if (i++ == subs->index) {
1965 /* found! */
1966 struct snd_seq_subscribers *s;
1967 if (subs->type == SNDRV_SEQ_QUERY_SUBS_READ) {
1968 s = list_entry(p, struct snd_seq_subscribers, src_list);
1969 subs->addr = s->info.dest;
1970 } else {
1971 s = list_entry(p, struct snd_seq_subscribers, dest_list);
1972 subs->addr = s->info.sender;
1974 subs->flags = s->info.flags;
1975 subs->queue = s->info.queue;
1976 result = 0;
1977 break;
1980 up_read(&group->list_mutex);
1982 __end:
1983 if (port)
1984 snd_seq_port_unlock(port);
1985 if (cptr)
1986 snd_seq_client_unlock(cptr);
1988 return result;
1993 * query next client
1995 static int snd_seq_ioctl_query_next_client(struct snd_seq_client *client,
1996 void *arg)
1998 struct snd_seq_client_info *info = arg;
1999 struct snd_seq_client *cptr = NULL;
2001 /* search for next client */
2002 info->client++;
2003 if (info->client < 0)
2004 info->client = 0;
2005 for (; info->client < SNDRV_SEQ_MAX_CLIENTS; info->client++) {
2006 cptr = snd_seq_client_use_ptr(info->client);
2007 if (cptr)
2008 break; /* found */
2010 if (cptr == NULL)
2011 return -ENOENT;
2013 get_client_info(cptr, info);
2014 snd_seq_client_unlock(cptr);
2016 return 0;
2020 * query next port
2022 static int snd_seq_ioctl_query_next_port(struct snd_seq_client *client,
2023 void *arg)
2025 struct snd_seq_port_info *info = arg;
2026 struct snd_seq_client *cptr;
2027 struct snd_seq_client_port *port = NULL;
2029 cptr = snd_seq_client_use_ptr(info->addr.client);
2030 if (cptr == NULL)
2031 return -ENXIO;
2033 /* search for next port */
2034 info->addr.port++;
2035 port = snd_seq_port_query_nearest(cptr, info);
2036 if (port == NULL) {
2037 snd_seq_client_unlock(cptr);
2038 return -ENOENT;
2041 /* get port info */
2042 info->addr = port->addr;
2043 snd_seq_get_port_info(port, info);
2044 snd_seq_port_unlock(port);
2045 snd_seq_client_unlock(cptr);
2047 return 0;
2050 /* -------------------------------------------------------- */
2052 static const struct ioctl_handler {
2053 unsigned int cmd;
2054 int (*func)(struct snd_seq_client *client, void *arg);
2055 } ioctl_handlers[] = {
2056 { SNDRV_SEQ_IOCTL_PVERSION, snd_seq_ioctl_pversion },
2057 { SNDRV_SEQ_IOCTL_CLIENT_ID, snd_seq_ioctl_client_id },
2058 { SNDRV_SEQ_IOCTL_SYSTEM_INFO, snd_seq_ioctl_system_info },
2059 { SNDRV_SEQ_IOCTL_RUNNING_MODE, snd_seq_ioctl_running_mode },
2060 { SNDRV_SEQ_IOCTL_GET_CLIENT_INFO, snd_seq_ioctl_get_client_info },
2061 { SNDRV_SEQ_IOCTL_SET_CLIENT_INFO, snd_seq_ioctl_set_client_info },
2062 { SNDRV_SEQ_IOCTL_CREATE_PORT, snd_seq_ioctl_create_port },
2063 { SNDRV_SEQ_IOCTL_DELETE_PORT, snd_seq_ioctl_delete_port },
2064 { SNDRV_SEQ_IOCTL_GET_PORT_INFO, snd_seq_ioctl_get_port_info },
2065 { SNDRV_SEQ_IOCTL_SET_PORT_INFO, snd_seq_ioctl_set_port_info },
2066 { SNDRV_SEQ_IOCTL_SUBSCRIBE_PORT, snd_seq_ioctl_subscribe_port },
2067 { SNDRV_SEQ_IOCTL_UNSUBSCRIBE_PORT, snd_seq_ioctl_unsubscribe_port },
2068 { SNDRV_SEQ_IOCTL_CREATE_QUEUE, snd_seq_ioctl_create_queue },
2069 { SNDRV_SEQ_IOCTL_DELETE_QUEUE, snd_seq_ioctl_delete_queue },
2070 { SNDRV_SEQ_IOCTL_GET_QUEUE_INFO, snd_seq_ioctl_get_queue_info },
2071 { SNDRV_SEQ_IOCTL_SET_QUEUE_INFO, snd_seq_ioctl_set_queue_info },
2072 { SNDRV_SEQ_IOCTL_GET_NAMED_QUEUE, snd_seq_ioctl_get_named_queue },
2073 { SNDRV_SEQ_IOCTL_GET_QUEUE_STATUS, snd_seq_ioctl_get_queue_status },
2074 { SNDRV_SEQ_IOCTL_GET_QUEUE_TEMPO, snd_seq_ioctl_get_queue_tempo },
2075 { SNDRV_SEQ_IOCTL_SET_QUEUE_TEMPO, snd_seq_ioctl_set_queue_tempo },
2076 { SNDRV_SEQ_IOCTL_GET_QUEUE_TIMER, snd_seq_ioctl_get_queue_timer },
2077 { SNDRV_SEQ_IOCTL_SET_QUEUE_TIMER, snd_seq_ioctl_set_queue_timer },
2078 { SNDRV_SEQ_IOCTL_GET_QUEUE_CLIENT, snd_seq_ioctl_get_queue_client },
2079 { SNDRV_SEQ_IOCTL_SET_QUEUE_CLIENT, snd_seq_ioctl_set_queue_client },
2080 { SNDRV_SEQ_IOCTL_GET_CLIENT_POOL, snd_seq_ioctl_get_client_pool },
2081 { SNDRV_SEQ_IOCTL_SET_CLIENT_POOL, snd_seq_ioctl_set_client_pool },
2082 { SNDRV_SEQ_IOCTL_GET_SUBSCRIPTION, snd_seq_ioctl_get_subscription },
2083 { SNDRV_SEQ_IOCTL_QUERY_NEXT_CLIENT, snd_seq_ioctl_query_next_client },
2084 { SNDRV_SEQ_IOCTL_QUERY_NEXT_PORT, snd_seq_ioctl_query_next_port },
2085 { SNDRV_SEQ_IOCTL_REMOVE_EVENTS, snd_seq_ioctl_remove_events },
2086 { SNDRV_SEQ_IOCTL_QUERY_SUBS, snd_seq_ioctl_query_subs },
2087 { 0, NULL },
2090 static long snd_seq_ioctl(struct file *file, unsigned int cmd,
2091 unsigned long arg)
2093 struct snd_seq_client *client = file->private_data;
2094 /* To use kernel stack for ioctl data. */
2095 union {
2096 int pversion;
2097 int client_id;
2098 struct snd_seq_system_info system_info;
2099 struct snd_seq_running_info running_info;
2100 struct snd_seq_client_info client_info;
2101 struct snd_seq_port_info port_info;
2102 struct snd_seq_port_subscribe port_subscribe;
2103 struct snd_seq_queue_info queue_info;
2104 struct snd_seq_queue_status queue_status;
2105 struct snd_seq_queue_tempo tempo;
2106 struct snd_seq_queue_timer queue_timer;
2107 struct snd_seq_queue_client queue_client;
2108 struct snd_seq_client_pool client_pool;
2109 struct snd_seq_remove_events remove_events;
2110 struct snd_seq_query_subs query_subs;
2111 } buf;
2112 const struct ioctl_handler *handler;
2113 unsigned long size;
2114 int err;
2116 if (snd_BUG_ON(!client))
2117 return -ENXIO;
2119 for (handler = ioctl_handlers; handler->cmd > 0; ++handler) {
2120 if (handler->cmd == cmd)
2121 break;
2123 if (handler->cmd == 0)
2124 return -ENOTTY;
2126 memset(&buf, 0, sizeof(buf));
2129 * All of ioctl commands for ALSA sequencer get an argument of size
2130 * within 13 bits. We can safely pick up the size from the command.
2132 size = _IOC_SIZE(handler->cmd);
2133 if (handler->cmd & IOC_IN) {
2134 if (copy_from_user(&buf, (const void __user *)arg, size))
2135 return -EFAULT;
2138 mutex_lock(&client->ioctl_mutex);
2139 err = handler->func(client, &buf);
2140 mutex_unlock(&client->ioctl_mutex);
2141 if (err >= 0) {
2142 /* Some commands includes a bug in 'dir' field. */
2143 if (handler->cmd == SNDRV_SEQ_IOCTL_SET_QUEUE_CLIENT ||
2144 handler->cmd == SNDRV_SEQ_IOCTL_SET_CLIENT_POOL ||
2145 (handler->cmd & IOC_OUT))
2146 if (copy_to_user((void __user *)arg, &buf, size))
2147 return -EFAULT;
2150 return err;
2153 #ifdef CONFIG_COMPAT
2154 #include "seq_compat.c"
2155 #else
2156 #define snd_seq_ioctl_compat NULL
2157 #endif
2159 /* -------------------------------------------------------- */
2162 /* exported to kernel modules */
2163 int snd_seq_create_kernel_client(struct snd_card *card, int client_index,
2164 const char *name_fmt, ...)
2166 struct snd_seq_client *client;
2167 va_list args;
2169 if (snd_BUG_ON(in_interrupt()))
2170 return -EBUSY;
2172 if (card && client_index >= SNDRV_SEQ_CLIENTS_PER_CARD)
2173 return -EINVAL;
2174 if (card == NULL && client_index >= SNDRV_SEQ_GLOBAL_CLIENTS)
2175 return -EINVAL;
2177 if (mutex_lock_interruptible(&register_mutex))
2178 return -ERESTARTSYS;
2180 if (card) {
2181 client_index += SNDRV_SEQ_GLOBAL_CLIENTS
2182 + card->number * SNDRV_SEQ_CLIENTS_PER_CARD;
2183 if (client_index >= SNDRV_SEQ_DYNAMIC_CLIENTS_BEGIN)
2184 client_index = -1;
2187 /* empty write queue as default */
2188 client = seq_create_client1(client_index, 0);
2189 if (client == NULL) {
2190 mutex_unlock(&register_mutex);
2191 return -EBUSY; /* failure code */
2193 usage_alloc(&client_usage, 1);
2195 client->accept_input = 1;
2196 client->accept_output = 1;
2197 client->data.kernel.card = card;
2199 va_start(args, name_fmt);
2200 vsnprintf(client->name, sizeof(client->name), name_fmt, args);
2201 va_end(args);
2203 client->type = KERNEL_CLIENT;
2204 mutex_unlock(&register_mutex);
2206 /* make others aware this new client */
2207 snd_seq_system_client_ev_client_start(client->number);
2209 /* return client number to caller */
2210 return client->number;
2212 EXPORT_SYMBOL(snd_seq_create_kernel_client);
2214 /* exported to kernel modules */
2215 int snd_seq_delete_kernel_client(int client)
2217 struct snd_seq_client *ptr;
2219 if (snd_BUG_ON(in_interrupt()))
2220 return -EBUSY;
2222 ptr = clientptr(client);
2223 if (ptr == NULL)
2224 return -EINVAL;
2226 seq_free_client(ptr);
2227 kfree(ptr);
2228 return 0;
2230 EXPORT_SYMBOL(snd_seq_delete_kernel_client);
2232 /* skeleton to enqueue event, called from snd_seq_kernel_client_enqueue
2233 * and snd_seq_kernel_client_enqueue_blocking
2235 static int kernel_client_enqueue(int client, struct snd_seq_event *ev,
2236 struct file *file, int blocking,
2237 int atomic, int hop)
2239 struct snd_seq_client *cptr;
2240 int result;
2242 if (snd_BUG_ON(!ev))
2243 return -EINVAL;
2245 if (ev->type == SNDRV_SEQ_EVENT_NONE)
2246 return 0; /* ignore this */
2247 if (ev->type == SNDRV_SEQ_EVENT_KERNEL_ERROR)
2248 return -EINVAL; /* quoted events can't be enqueued */
2250 /* fill in client number */
2251 ev->source.client = client;
2253 if (check_event_type_and_length(ev))
2254 return -EINVAL;
2256 cptr = snd_seq_client_use_ptr(client);
2257 if (cptr == NULL)
2258 return -EINVAL;
2260 if (! cptr->accept_output)
2261 result = -EPERM;
2262 else /* send it */
2263 result = snd_seq_client_enqueue_event(cptr, ev, file, blocking, atomic, hop);
2265 snd_seq_client_unlock(cptr);
2266 return result;
2270 * exported, called by kernel clients to enqueue events (w/o blocking)
2272 * RETURN VALUE: zero if succeed, negative if error
2274 int snd_seq_kernel_client_enqueue(int client, struct snd_seq_event * ev,
2275 int atomic, int hop)
2277 return kernel_client_enqueue(client, ev, NULL, 0, atomic, hop);
2279 EXPORT_SYMBOL(snd_seq_kernel_client_enqueue);
2282 * exported, called by kernel clients to enqueue events (with blocking)
2284 * RETURN VALUE: zero if succeed, negative if error
2286 int snd_seq_kernel_client_enqueue_blocking(int client, struct snd_seq_event * ev,
2287 struct file *file,
2288 int atomic, int hop)
2290 return kernel_client_enqueue(client, ev, file, 1, atomic, hop);
2292 EXPORT_SYMBOL(snd_seq_kernel_client_enqueue_blocking);
2295 * exported, called by kernel clients to dispatch events directly to other
2296 * clients, bypassing the queues. Event time-stamp will be updated.
2298 * RETURN VALUE: negative = delivery failed,
2299 * zero, or positive: the number of delivered events
2301 int snd_seq_kernel_client_dispatch(int client, struct snd_seq_event * ev,
2302 int atomic, int hop)
2304 struct snd_seq_client *cptr;
2305 int result;
2307 if (snd_BUG_ON(!ev))
2308 return -EINVAL;
2310 /* fill in client number */
2311 ev->queue = SNDRV_SEQ_QUEUE_DIRECT;
2312 ev->source.client = client;
2314 if (check_event_type_and_length(ev))
2315 return -EINVAL;
2317 cptr = snd_seq_client_use_ptr(client);
2318 if (cptr == NULL)
2319 return -EINVAL;
2321 if (!cptr->accept_output)
2322 result = -EPERM;
2323 else
2324 result = snd_seq_deliver_event(cptr, ev, atomic, hop);
2326 snd_seq_client_unlock(cptr);
2327 return result;
2329 EXPORT_SYMBOL(snd_seq_kernel_client_dispatch);
2332 * snd_seq_kernel_client_ctl - operate a command for a client with data in
2333 * kernel space.
2334 * @clientid: A numerical ID for a client.
2335 * @cmd: An ioctl(2) command for ALSA sequencer operation.
2336 * @arg: A pointer to data in kernel space.
2338 * Against its name, both kernel/application client can be handled by this
2339 * kernel API. A pointer of 'arg' argument should be in kernel space.
2341 * Return: 0 at success. Negative error code at failure.
2343 int snd_seq_kernel_client_ctl(int clientid, unsigned int cmd, void *arg)
2345 const struct ioctl_handler *handler;
2346 struct snd_seq_client *client;
2348 client = clientptr(clientid);
2349 if (client == NULL)
2350 return -ENXIO;
2352 for (handler = ioctl_handlers; handler->cmd > 0; ++handler) {
2353 if (handler->cmd == cmd)
2354 return handler->func(client, arg);
2357 pr_debug("ALSA: seq unknown ioctl() 0x%x (type='%c', number=0x%02x)\n",
2358 cmd, _IOC_TYPE(cmd), _IOC_NR(cmd));
2359 return -ENOTTY;
2361 EXPORT_SYMBOL(snd_seq_kernel_client_ctl);
2363 /* exported (for OSS emulator) */
2364 int snd_seq_kernel_client_write_poll(int clientid, struct file *file, poll_table *wait)
2366 struct snd_seq_client *client;
2368 client = clientptr(clientid);
2369 if (client == NULL)
2370 return -ENXIO;
2372 if (! snd_seq_write_pool_allocated(client))
2373 return 1;
2374 if (snd_seq_pool_poll_wait(client->pool, file, wait))
2375 return 1;
2376 return 0;
2378 EXPORT_SYMBOL(snd_seq_kernel_client_write_poll);
2380 /*---------------------------------------------------------------------------*/
2382 #ifdef CONFIG_SND_PROC_FS
2384 * /proc interface
2386 static void snd_seq_info_dump_subscribers(struct snd_info_buffer *buffer,
2387 struct snd_seq_port_subs_info *group,
2388 int is_src, char *msg)
2390 struct list_head *p;
2391 struct snd_seq_subscribers *s;
2392 int count = 0;
2394 down_read(&group->list_mutex);
2395 if (list_empty(&group->list_head)) {
2396 up_read(&group->list_mutex);
2397 return;
2399 snd_iprintf(buffer, msg);
2400 list_for_each(p, &group->list_head) {
2401 if (is_src)
2402 s = list_entry(p, struct snd_seq_subscribers, src_list);
2403 else
2404 s = list_entry(p, struct snd_seq_subscribers, dest_list);
2405 if (count++)
2406 snd_iprintf(buffer, ", ");
2407 snd_iprintf(buffer, "%d:%d",
2408 is_src ? s->info.dest.client : s->info.sender.client,
2409 is_src ? s->info.dest.port : s->info.sender.port);
2410 if (s->info.flags & SNDRV_SEQ_PORT_SUBS_TIMESTAMP)
2411 snd_iprintf(buffer, "[%c:%d]", ((s->info.flags & SNDRV_SEQ_PORT_SUBS_TIME_REAL) ? 'r' : 't'), s->info.queue);
2412 if (group->exclusive)
2413 snd_iprintf(buffer, "[ex]");
2415 up_read(&group->list_mutex);
2416 snd_iprintf(buffer, "\n");
2419 #define FLAG_PERM_RD(perm) ((perm) & SNDRV_SEQ_PORT_CAP_READ ? ((perm) & SNDRV_SEQ_PORT_CAP_SUBS_READ ? 'R' : 'r') : '-')
2420 #define FLAG_PERM_WR(perm) ((perm) & SNDRV_SEQ_PORT_CAP_WRITE ? ((perm) & SNDRV_SEQ_PORT_CAP_SUBS_WRITE ? 'W' : 'w') : '-')
2421 #define FLAG_PERM_EX(perm) ((perm) & SNDRV_SEQ_PORT_CAP_NO_EXPORT ? '-' : 'e')
2423 #define FLAG_PERM_DUPLEX(perm) ((perm) & SNDRV_SEQ_PORT_CAP_DUPLEX ? 'X' : '-')
2425 static void snd_seq_info_dump_ports(struct snd_info_buffer *buffer,
2426 struct snd_seq_client *client)
2428 struct snd_seq_client_port *p;
2430 mutex_lock(&client->ports_mutex);
2431 list_for_each_entry(p, &client->ports_list_head, list) {
2432 snd_iprintf(buffer, " Port %3d : \"%s\" (%c%c%c%c)\n",
2433 p->addr.port, p->name,
2434 FLAG_PERM_RD(p->capability),
2435 FLAG_PERM_WR(p->capability),
2436 FLAG_PERM_EX(p->capability),
2437 FLAG_PERM_DUPLEX(p->capability));
2438 snd_seq_info_dump_subscribers(buffer, &p->c_src, 1, " Connecting To: ");
2439 snd_seq_info_dump_subscribers(buffer, &p->c_dest, 0, " Connected From: ");
2441 mutex_unlock(&client->ports_mutex);
2445 /* exported to seq_info.c */
2446 void snd_seq_info_clients_read(struct snd_info_entry *entry,
2447 struct snd_info_buffer *buffer)
2449 int c;
2450 struct snd_seq_client *client;
2452 snd_iprintf(buffer, "Client info\n");
2453 snd_iprintf(buffer, " cur clients : %d\n", client_usage.cur);
2454 snd_iprintf(buffer, " peak clients : %d\n", client_usage.peak);
2455 snd_iprintf(buffer, " max clients : %d\n", SNDRV_SEQ_MAX_CLIENTS);
2456 snd_iprintf(buffer, "\n");
2458 /* list the client table */
2459 for (c = 0; c < SNDRV_SEQ_MAX_CLIENTS; c++) {
2460 client = snd_seq_client_use_ptr(c);
2461 if (client == NULL)
2462 continue;
2463 if (client->type == NO_CLIENT) {
2464 snd_seq_client_unlock(client);
2465 continue;
2468 snd_iprintf(buffer, "Client %3d : \"%s\" [%s]\n",
2469 c, client->name,
2470 client->type == USER_CLIENT ? "User" : "Kernel");
2471 snd_seq_info_dump_ports(buffer, client);
2472 if (snd_seq_write_pool_allocated(client)) {
2473 snd_iprintf(buffer, " Output pool :\n");
2474 snd_seq_info_pool(buffer, client->pool, " ");
2476 if (client->type == USER_CLIENT && client->data.user.fifo &&
2477 client->data.user.fifo->pool) {
2478 snd_iprintf(buffer, " Input pool :\n");
2479 snd_seq_info_pool(buffer, client->data.user.fifo->pool, " ");
2481 snd_seq_client_unlock(client);
2484 #endif /* CONFIG_SND_PROC_FS */
2486 /*---------------------------------------------------------------------------*/
2490 * REGISTRATION PART
2493 static const struct file_operations snd_seq_f_ops =
2495 .owner = THIS_MODULE,
2496 .read = snd_seq_read,
2497 .write = snd_seq_write,
2498 .open = snd_seq_open,
2499 .release = snd_seq_release,
2500 .llseek = no_llseek,
2501 .poll = snd_seq_poll,
2502 .unlocked_ioctl = snd_seq_ioctl,
2503 .compat_ioctl = snd_seq_ioctl_compat,
2506 static struct device seq_dev;
2509 * register sequencer device
2511 int __init snd_sequencer_device_init(void)
2513 int err;
2515 snd_device_initialize(&seq_dev, NULL);
2516 dev_set_name(&seq_dev, "seq");
2518 if (mutex_lock_interruptible(&register_mutex))
2519 return -ERESTARTSYS;
2521 err = snd_register_device(SNDRV_DEVICE_TYPE_SEQUENCER, NULL, 0,
2522 &snd_seq_f_ops, NULL, &seq_dev);
2523 if (err < 0) {
2524 mutex_unlock(&register_mutex);
2525 put_device(&seq_dev);
2526 return err;
2529 mutex_unlock(&register_mutex);
2531 return 0;
2537 * unregister sequencer device
2539 void __exit snd_sequencer_device_done(void)
2541 snd_unregister_device(&seq_dev);
2542 put_device(&seq_dev);