[ALSA] semaphore -> mutex (core part)
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / sound / core / seq / seq_clientmgr.c
blobaae6420f5948700ecef66a395c2645ea586fd69a
1 /*
2 * ALSA sequencer Client Manager
3 * Copyright (c) 1998-2001 by Frank van de Pol <fvdpol@coil.demon.nl>
4 * Jaroslav Kysela <perex@suse.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 <sound/driver.h>
25 #include <linux/init.h>
26 #include <linux/smp_lock.h>
27 #include <linux/slab.h>
28 #include <sound/core.h>
29 #include <sound/minors.h>
30 #include <linux/kmod.h>
32 #include <sound/seq_kernel.h>
33 #include "seq_clientmgr.h"
34 #include "seq_memory.h"
35 #include "seq_queue.h"
36 #include "seq_timer.h"
37 #include "seq_info.h"
38 #include "seq_system.h"
39 #include <sound/seq_device.h>
40 #ifdef CONFIG_COMPAT
41 #include <linux/compat.h>
42 #endif
44 /* Client Manager
46 * this module handles the connections of userland and kernel clients
51 * There are four ranges of client numbers (last two shared):
52 * 0..15: global clients
53 * 16..127: statically allocated client numbers for cards 0..27
54 * 128..191: dynamically allocated client numbers for cards 28..31
55 * 128..191: dynamically allocated client numbers for applications
58 /* number of kernel non-card clients */
59 #define SNDRV_SEQ_GLOBAL_CLIENTS 16
60 /* clients per cards, for static clients */
61 #define SNDRV_SEQ_CLIENTS_PER_CARD 4
62 /* dynamically allocated client numbers (both kernel drivers and user space) */
63 #define SNDRV_SEQ_DYNAMIC_CLIENTS_BEGIN 128
65 #define SNDRV_SEQ_LFLG_INPUT 0x0001
66 #define SNDRV_SEQ_LFLG_OUTPUT 0x0002
67 #define SNDRV_SEQ_LFLG_OPEN (SNDRV_SEQ_LFLG_INPUT|SNDRV_SEQ_LFLG_OUTPUT)
69 static DEFINE_SPINLOCK(clients_lock);
70 static DEFINE_MUTEX(register_mutex);
73 * client table
75 static char clienttablock[SNDRV_SEQ_MAX_CLIENTS];
76 static struct snd_seq_client *clienttab[SNDRV_SEQ_MAX_CLIENTS];
77 static struct snd_seq_usage client_usage;
80 * prototypes
82 static int bounce_error_event(struct snd_seq_client *client,
83 struct snd_seq_event *event,
84 int err, int atomic, int hop);
85 static int snd_seq_deliver_single_event(struct snd_seq_client *client,
86 struct snd_seq_event *event,
87 int filter, int atomic, int hop);
92 static inline mm_segment_t snd_enter_user(void)
94 mm_segment_t fs = get_fs();
95 set_fs(get_ds());
96 return fs;
99 static inline void snd_leave_user(mm_segment_t fs)
101 set_fs(fs);
106 static inline unsigned short snd_seq_file_flags(struct file *file)
108 switch (file->f_mode & (FMODE_READ | FMODE_WRITE)) {
109 case FMODE_WRITE:
110 return SNDRV_SEQ_LFLG_OUTPUT;
111 case FMODE_READ:
112 return SNDRV_SEQ_LFLG_INPUT;
113 default:
114 return SNDRV_SEQ_LFLG_OPEN;
118 static inline int snd_seq_write_pool_allocated(struct snd_seq_client *client)
120 return snd_seq_total_cells(client->pool) > 0;
123 /* return pointer to client structure for specified id */
124 static struct snd_seq_client *clientptr(int clientid)
126 if (clientid < 0 || clientid >= SNDRV_SEQ_MAX_CLIENTS) {
127 snd_printd("Seq: oops. Trying to get pointer to client %d\n",
128 clientid);
129 return NULL;
131 return clienttab[clientid];
134 extern int seq_client_load[];
136 struct snd_seq_client *snd_seq_client_use_ptr(int clientid)
138 unsigned long flags;
139 struct snd_seq_client *client;
141 if (clientid < 0 || clientid >= SNDRV_SEQ_MAX_CLIENTS) {
142 snd_printd("Seq: oops. Trying to get pointer to client %d\n",
143 clientid);
144 return NULL;
146 spin_lock_irqsave(&clients_lock, flags);
147 client = clientptr(clientid);
148 if (client)
149 goto __lock;
150 if (clienttablock[clientid]) {
151 spin_unlock_irqrestore(&clients_lock, flags);
152 return NULL;
154 spin_unlock_irqrestore(&clients_lock, flags);
155 #ifdef CONFIG_KMOD
156 if (!in_interrupt() && current->fs->root) {
157 static char client_requested[SNDRV_SEQ_GLOBAL_CLIENTS];
158 static char card_requested[SNDRV_CARDS];
159 if (clientid < SNDRV_SEQ_GLOBAL_CLIENTS) {
160 int idx;
162 if (! client_requested[clientid] && current->fs->root) {
163 client_requested[clientid] = 1;
164 for (idx = 0; idx < 15; idx++) {
165 if (seq_client_load[idx] < 0)
166 break;
167 if (seq_client_load[idx] == clientid) {
168 request_module("snd-seq-client-%i",
169 clientid);
170 break;
174 } else if (clientid < SNDRV_SEQ_DYNAMIC_CLIENTS_BEGIN) {
175 int card = (clientid - SNDRV_SEQ_GLOBAL_CLIENTS) /
176 SNDRV_SEQ_CLIENTS_PER_CARD;
177 if (card < snd_ecards_limit) {
178 if (! card_requested[card]) {
179 card_requested[card] = 1;
180 snd_request_card(card);
182 snd_seq_device_load_drivers();
185 spin_lock_irqsave(&clients_lock, flags);
186 client = clientptr(clientid);
187 if (client)
188 goto __lock;
189 spin_unlock_irqrestore(&clients_lock, flags);
191 #endif
192 return NULL;
194 __lock:
195 snd_use_lock_use(&client->use_lock);
196 spin_unlock_irqrestore(&clients_lock, flags);
197 return client;
200 static void usage_alloc(struct snd_seq_usage *res, int num)
202 res->cur += num;
203 if (res->cur > res->peak)
204 res->peak = res->cur;
207 static void usage_free(struct snd_seq_usage *res, int num)
209 res->cur -= num;
212 /* initialise data structures */
213 int __init client_init_data(void)
215 /* zap out the client table */
216 memset(&clienttablock, 0, sizeof(clienttablock));
217 memset(&clienttab, 0, sizeof(clienttab));
218 return 0;
222 static struct snd_seq_client *seq_create_client1(int client_index, int poolsize)
224 unsigned long flags;
225 int c;
226 struct snd_seq_client *client;
228 /* init client data */
229 client = kzalloc(sizeof(*client), GFP_KERNEL);
230 if (client == NULL)
231 return NULL;
232 client->pool = snd_seq_pool_new(poolsize);
233 if (client->pool == NULL) {
234 kfree(client);
235 return NULL;
237 client->type = NO_CLIENT;
238 snd_use_lock_init(&client->use_lock);
239 rwlock_init(&client->ports_lock);
240 mutex_init(&client->ports_mutex);
241 INIT_LIST_HEAD(&client->ports_list_head);
243 /* find free slot in the client table */
244 spin_lock_irqsave(&clients_lock, flags);
245 if (client_index < 0) {
246 for (c = SNDRV_SEQ_DYNAMIC_CLIENTS_BEGIN;
247 c < SNDRV_SEQ_MAX_CLIENTS;
248 c++) {
249 if (clienttab[c] || clienttablock[c])
250 continue;
251 clienttab[client->number = c] = client;
252 spin_unlock_irqrestore(&clients_lock, flags);
253 return client;
255 } else {
256 if (clienttab[client_index] == NULL && !clienttablock[client_index]) {
257 clienttab[client->number = client_index] = client;
258 spin_unlock_irqrestore(&clients_lock, flags);
259 return client;
262 spin_unlock_irqrestore(&clients_lock, flags);
263 snd_seq_pool_delete(&client->pool);
264 kfree(client);
265 return NULL; /* no free slot found or busy, return failure code */
269 static int seq_free_client1(struct snd_seq_client *client)
271 unsigned long flags;
273 snd_assert(client != NULL, return -EINVAL);
274 snd_seq_delete_all_ports(client);
275 snd_seq_queue_client_leave(client->number);
276 spin_lock_irqsave(&clients_lock, flags);
277 clienttablock[client->number] = 1;
278 clienttab[client->number] = NULL;
279 spin_unlock_irqrestore(&clients_lock, flags);
280 snd_use_lock_sync(&client->use_lock);
281 snd_seq_queue_client_termination(client->number);
282 if (client->pool)
283 snd_seq_pool_delete(&client->pool);
284 spin_lock_irqsave(&clients_lock, flags);
285 clienttablock[client->number] = 0;
286 spin_unlock_irqrestore(&clients_lock, flags);
287 return 0;
291 static void seq_free_client(struct snd_seq_client * client)
293 mutex_lock(&register_mutex);
294 switch (client->type) {
295 case NO_CLIENT:
296 snd_printk(KERN_WARNING "Seq: Trying to free unused client %d\n",
297 client->number);
298 break;
299 case USER_CLIENT:
300 case KERNEL_CLIENT:
301 seq_free_client1(client);
302 usage_free(&client_usage, 1);
303 break;
305 default:
306 snd_printk(KERN_ERR "Seq: Trying to free client %d with undefined type = %d\n",
307 client->number, client->type);
309 mutex_unlock(&register_mutex);
311 snd_seq_system_client_ev_client_exit(client->number);
316 /* -------------------------------------------------------- */
318 /* create a user client */
319 static int snd_seq_open(struct inode *inode, struct file *file)
321 int c, mode; /* client id */
322 struct snd_seq_client *client;
323 struct snd_seq_user_client *user;
325 if (mutex_lock_interruptible(&register_mutex))
326 return -ERESTARTSYS;
327 client = seq_create_client1(-1, SNDRV_SEQ_DEFAULT_EVENTS);
328 if (client == NULL) {
329 mutex_unlock(&register_mutex);
330 return -ENOMEM; /* failure code */
333 mode = snd_seq_file_flags(file);
334 if (mode & SNDRV_SEQ_LFLG_INPUT)
335 client->accept_input = 1;
336 if (mode & SNDRV_SEQ_LFLG_OUTPUT)
337 client->accept_output = 1;
339 user = &client->data.user;
340 user->fifo = NULL;
341 user->fifo_pool_size = 0;
343 if (mode & SNDRV_SEQ_LFLG_INPUT) {
344 user->fifo_pool_size = SNDRV_SEQ_DEFAULT_CLIENT_EVENTS;
345 user->fifo = snd_seq_fifo_new(user->fifo_pool_size);
346 if (user->fifo == NULL) {
347 seq_free_client1(client);
348 kfree(client);
349 mutex_unlock(&register_mutex);
350 return -ENOMEM;
354 usage_alloc(&client_usage, 1);
355 client->type = USER_CLIENT;
356 mutex_unlock(&register_mutex);
358 c = client->number;
359 file->private_data = client;
361 /* fill client data */
362 user->file = file;
363 sprintf(client->name, "Client-%d", c);
365 /* make others aware this new client */
366 snd_seq_system_client_ev_client_start(c);
368 return 0;
371 /* delete a user client */
372 static int snd_seq_release(struct inode *inode, struct file *file)
374 struct snd_seq_client *client = file->private_data;
376 if (client) {
377 seq_free_client(client);
378 if (client->data.user.fifo)
379 snd_seq_fifo_delete(&client->data.user.fifo);
380 kfree(client);
383 return 0;
387 /* handle client read() */
388 /* possible error values:
389 * -ENXIO invalid client or file open mode
390 * -ENOSPC FIFO overflow (the flag is cleared after this error report)
391 * -EINVAL no enough user-space buffer to write the whole event
392 * -EFAULT seg. fault during copy to user space
394 static ssize_t snd_seq_read(struct file *file, char __user *buf, size_t count,
395 loff_t *offset)
397 struct snd_seq_client *client = file->private_data;
398 struct snd_seq_fifo *fifo;
399 int err;
400 long result = 0;
401 struct snd_seq_event_cell *cell;
403 if (!(snd_seq_file_flags(file) & SNDRV_SEQ_LFLG_INPUT))
404 return -ENXIO;
406 if (!access_ok(VERIFY_WRITE, buf, count))
407 return -EFAULT;
409 /* check client structures are in place */
410 snd_assert(client != NULL, return -ENXIO);
412 if (!client->accept_input || (fifo = client->data.user.fifo) == NULL)
413 return -ENXIO;
415 if (atomic_read(&fifo->overflow) > 0) {
416 /* buffer overflow is detected */
417 snd_seq_fifo_clear(fifo);
418 /* return error code */
419 return -ENOSPC;
422 cell = NULL;
423 err = 0;
424 snd_seq_fifo_lock(fifo);
426 /* while data available in queue */
427 while (count >= sizeof(struct snd_seq_event)) {
428 int nonblock;
430 nonblock = (file->f_flags & O_NONBLOCK) || result > 0;
431 if ((err = snd_seq_fifo_cell_out(fifo, &cell, nonblock)) < 0) {
432 break;
434 if (snd_seq_ev_is_variable(&cell->event)) {
435 struct snd_seq_event tmpev;
436 tmpev = cell->event;
437 tmpev.data.ext.len &= ~SNDRV_SEQ_EXT_MASK;
438 if (copy_to_user(buf, &tmpev, sizeof(struct snd_seq_event))) {
439 err = -EFAULT;
440 break;
442 count -= sizeof(struct snd_seq_event);
443 buf += sizeof(struct snd_seq_event);
444 err = snd_seq_expand_var_event(&cell->event, count,
445 (char __force *)buf, 0,
446 sizeof(struct snd_seq_event));
447 if (err < 0)
448 break;
449 result += err;
450 count -= err;
451 buf += err;
452 } else {
453 if (copy_to_user(buf, &cell->event, sizeof(struct snd_seq_event))) {
454 err = -EFAULT;
455 break;
457 count -= sizeof(struct snd_seq_event);
458 buf += sizeof(struct snd_seq_event);
460 snd_seq_cell_free(cell);
461 cell = NULL; /* to be sure */
462 result += sizeof(struct snd_seq_event);
465 if (err < 0) {
466 if (cell)
467 snd_seq_fifo_cell_putback(fifo, cell);
468 if (err == -EAGAIN && result > 0)
469 err = 0;
471 snd_seq_fifo_unlock(fifo);
473 return (err < 0) ? err : result;
478 * check access permission to the port
480 static int check_port_perm(struct snd_seq_client_port *port, unsigned int flags)
482 if ((port->capability & flags) != flags)
483 return 0;
484 return flags;
488 * check if the destination client is available, and return the pointer
489 * if filter is non-zero, client filter bitmap is tested.
491 static struct snd_seq_client *get_event_dest_client(struct snd_seq_event *event,
492 int filter)
494 struct snd_seq_client *dest;
496 dest = snd_seq_client_use_ptr(event->dest.client);
497 if (dest == NULL)
498 return NULL;
499 if (! dest->accept_input)
500 goto __not_avail;
501 if ((dest->filter & SNDRV_SEQ_FILTER_USE_EVENT) &&
502 ! test_bit(event->type, dest->event_filter))
503 goto __not_avail;
504 if (filter && !(dest->filter & filter))
505 goto __not_avail;
507 return dest; /* ok - accessible */
508 __not_avail:
509 snd_seq_client_unlock(dest);
510 return NULL;
515 * Return the error event.
517 * If the receiver client is a user client, the original event is
518 * encapsulated in SNDRV_SEQ_EVENT_BOUNCE as variable length event. If
519 * the original event is also variable length, the external data is
520 * copied after the event record.
521 * If the receiver client is a kernel client, the original event is
522 * quoted in SNDRV_SEQ_EVENT_KERNEL_ERROR, since this requires no extra
523 * kmalloc.
525 static int bounce_error_event(struct snd_seq_client *client,
526 struct snd_seq_event *event,
527 int err, int atomic, int hop)
529 struct snd_seq_event bounce_ev;
530 int result;
532 if (client == NULL ||
533 ! (client->filter & SNDRV_SEQ_FILTER_BOUNCE) ||
534 ! client->accept_input)
535 return 0; /* ignored */
537 /* set up quoted error */
538 memset(&bounce_ev, 0, sizeof(bounce_ev));
539 bounce_ev.type = SNDRV_SEQ_EVENT_KERNEL_ERROR;
540 bounce_ev.flags = SNDRV_SEQ_EVENT_LENGTH_FIXED;
541 bounce_ev.queue = SNDRV_SEQ_QUEUE_DIRECT;
542 bounce_ev.source.client = SNDRV_SEQ_CLIENT_SYSTEM;
543 bounce_ev.source.port = SNDRV_SEQ_PORT_SYSTEM_ANNOUNCE;
544 bounce_ev.dest.client = client->number;
545 bounce_ev.dest.port = event->source.port;
546 bounce_ev.data.quote.origin = event->dest;
547 bounce_ev.data.quote.event = event;
548 bounce_ev.data.quote.value = -err; /* use positive value */
549 result = snd_seq_deliver_single_event(NULL, &bounce_ev, 0, atomic, hop + 1);
550 if (result < 0) {
551 client->event_lost++;
552 return result;
555 return result;
560 * rewrite the time-stamp of the event record with the curren time
561 * of the given queue.
562 * return non-zero if updated.
564 static int update_timestamp_of_queue(struct snd_seq_event *event,
565 int queue, int real_time)
567 struct snd_seq_queue *q;
569 q = queueptr(queue);
570 if (! q)
571 return 0;
572 event->queue = queue;
573 event->flags &= ~SNDRV_SEQ_TIME_STAMP_MASK;
574 if (real_time) {
575 event->time.time = snd_seq_timer_get_cur_time(q->timer);
576 event->flags |= SNDRV_SEQ_TIME_STAMP_REAL;
577 } else {
578 event->time.tick = snd_seq_timer_get_cur_tick(q->timer);
579 event->flags |= SNDRV_SEQ_TIME_STAMP_TICK;
581 queuefree(q);
582 return 1;
587 * deliver an event to the specified destination.
588 * if filter is non-zero, client filter bitmap is tested.
590 * RETURN VALUE: 0 : if succeeded
591 * <0 : error
593 static int snd_seq_deliver_single_event(struct snd_seq_client *client,
594 struct snd_seq_event *event,
595 int filter, int atomic, int hop)
597 struct snd_seq_client *dest = NULL;
598 struct snd_seq_client_port *dest_port = NULL;
599 int result = -ENOENT;
600 int direct;
602 direct = snd_seq_ev_is_direct(event);
604 dest = get_event_dest_client(event, filter);
605 if (dest == NULL)
606 goto __skip;
607 dest_port = snd_seq_port_use_ptr(dest, event->dest.port);
608 if (dest_port == NULL)
609 goto __skip;
611 /* check permission */
612 if (! check_port_perm(dest_port, SNDRV_SEQ_PORT_CAP_WRITE)) {
613 result = -EPERM;
614 goto __skip;
617 if (dest_port->timestamping)
618 update_timestamp_of_queue(event, dest_port->time_queue,
619 dest_port->time_real);
621 switch (dest->type) {
622 case USER_CLIENT:
623 if (dest->data.user.fifo)
624 result = snd_seq_fifo_event_in(dest->data.user.fifo, event);
625 break;
627 case KERNEL_CLIENT:
628 if (dest_port->event_input == NULL)
629 break;
630 result = dest_port->event_input(event, direct,
631 dest_port->private_data,
632 atomic, hop);
633 break;
634 default:
635 break;
638 __skip:
639 if (dest_port)
640 snd_seq_port_unlock(dest_port);
641 if (dest)
642 snd_seq_client_unlock(dest);
644 if (result < 0 && !direct) {
645 result = bounce_error_event(client, event, result, atomic, hop);
647 return result;
652 * send the event to all subscribers:
654 static int deliver_to_subscribers(struct snd_seq_client *client,
655 struct snd_seq_event *event,
656 int atomic, int hop)
658 struct snd_seq_subscribers *subs;
659 int err = 0, num_ev = 0;
660 struct snd_seq_event event_saved;
661 struct snd_seq_client_port *src_port;
662 struct list_head *p;
663 struct snd_seq_port_subs_info *grp;
665 src_port = snd_seq_port_use_ptr(client, event->source.port);
666 if (src_port == NULL)
667 return -EINVAL; /* invalid source port */
668 /* save original event record */
669 event_saved = *event;
670 grp = &src_port->c_src;
672 /* lock list */
673 if (atomic)
674 read_lock(&grp->list_lock);
675 else
676 down_read(&grp->list_mutex);
677 list_for_each(p, &grp->list_head) {
678 subs = list_entry(p, struct snd_seq_subscribers, src_list);
679 event->dest = subs->info.dest;
680 if (subs->info.flags & SNDRV_SEQ_PORT_SUBS_TIMESTAMP)
681 /* convert time according to flag with subscription */
682 update_timestamp_of_queue(event, subs->info.queue,
683 subs->info.flags & SNDRV_SEQ_PORT_SUBS_TIME_REAL);
684 err = snd_seq_deliver_single_event(client, event,
685 0, atomic, hop);
686 if (err < 0)
687 break;
688 num_ev++;
689 /* restore original event record */
690 *event = event_saved;
692 if (atomic)
693 read_unlock(&grp->list_lock);
694 else
695 up_read(&grp->list_mutex);
696 *event = event_saved; /* restore */
697 snd_seq_port_unlock(src_port);
698 return (err < 0) ? err : num_ev;
702 #ifdef SUPPORT_BROADCAST
704 * broadcast to all ports:
706 static int port_broadcast_event(struct snd_seq_client *client,
707 struct snd_seq_event *event,
708 int atomic, int hop)
710 int num_ev = 0, err = 0;
711 struct snd_seq_client *dest_client;
712 struct list_head *p;
714 dest_client = get_event_dest_client(event, SNDRV_SEQ_FILTER_BROADCAST);
715 if (dest_client == NULL)
716 return 0; /* no matching destination */
718 read_lock(&dest_client->ports_lock);
719 list_for_each(p, &dest_client->ports_list_head) {
720 struct snd_seq_client_port *port = list_entry(p, struct snd_seq_client_port, list);
721 event->dest.port = port->addr.port;
722 /* pass NULL as source client to avoid error bounce */
723 err = snd_seq_deliver_single_event(NULL, event,
724 SNDRV_SEQ_FILTER_BROADCAST,
725 atomic, hop);
726 if (err < 0)
727 break;
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 (err < 0) ? err : 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 = 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 break;
764 num_ev += err;
766 event->dest = addr; /* restore */
767 return (err < 0) ? err : num_ev;
771 /* multicast - not supported yet */
772 static int multicast_event(struct snd_seq_client *client, struct snd_seq_event *event,
773 int atomic, int hop)
775 snd_printd("seq: multicast not supported yet.\n");
776 return 0; /* ignored */
778 #endif /* SUPPORT_BROADCAST */
781 /* deliver an event to the destination port(s).
782 * if the event is to subscribers or broadcast, the event is dispatched
783 * to multiple targets.
785 * RETURN VALUE: n > 0 : the number of delivered events.
786 * n == 0 : the event was not passed to any client.
787 * n < 0 : error - event was not processed.
789 static int snd_seq_deliver_event(struct snd_seq_client *client, struct snd_seq_event *event,
790 int atomic, int hop)
792 int result;
794 hop++;
795 if (hop >= SNDRV_SEQ_MAX_HOPS) {
796 snd_printd("too long delivery path (%d:%d->%d:%d)\n",
797 event->source.client, event->source.port,
798 event->dest.client, event->dest.port);
799 return -EMLINK;
802 if (event->queue == SNDRV_SEQ_ADDRESS_SUBSCRIBERS ||
803 event->dest.client == SNDRV_SEQ_ADDRESS_SUBSCRIBERS)
804 result = deliver_to_subscribers(client, event, atomic, hop);
805 #ifdef SUPPORT_BROADCAST
806 else if (event->queue == SNDRV_SEQ_ADDRESS_BROADCAST ||
807 event->dest.client == SNDRV_SEQ_ADDRESS_BROADCAST)
808 result = broadcast_event(client, event, atomic, hop);
809 else if (event->dest.client >= SNDRV_SEQ_MAX_CLIENTS)
810 result = multicast_event(client, event, atomic, hop);
811 else if (event->dest.port == SNDRV_SEQ_ADDRESS_BROADCAST)
812 result = port_broadcast_event(client, event, atomic, hop);
813 #endif
814 else
815 result = snd_seq_deliver_single_event(client, event, 0, atomic, hop);
817 return result;
821 * dispatch an event cell:
822 * This function is called only from queue check routines in timer
823 * interrupts or after enqueued.
824 * The event cell shall be released or re-queued in this function.
826 * RETURN VALUE: n > 0 : the number of delivered events.
827 * n == 0 : the event was not passed to any client.
828 * n < 0 : error - event was not processed.
830 int snd_seq_dispatch_event(struct snd_seq_event_cell *cell, int atomic, int hop)
832 struct snd_seq_client *client;
833 int result;
835 snd_assert(cell != NULL, return -EINVAL);
837 client = snd_seq_client_use_ptr(cell->event.source.client);
838 if (client == NULL) {
839 snd_seq_cell_free(cell); /* release this cell */
840 return -EINVAL;
843 if (cell->event.type == SNDRV_SEQ_EVENT_NOTE) {
844 /* NOTE event:
845 * the event cell is re-used as a NOTE-OFF event and
846 * enqueued again.
848 struct snd_seq_event tmpev, *ev;
850 /* reserve this event to enqueue note-off later */
851 tmpev = cell->event;
852 tmpev.type = SNDRV_SEQ_EVENT_NOTEON;
853 result = snd_seq_deliver_event(client, &tmpev, atomic, hop);
856 * This was originally a note event. We now re-use the
857 * cell for the note-off event.
860 ev = &cell->event;
861 ev->type = SNDRV_SEQ_EVENT_NOTEOFF;
862 ev->flags |= SNDRV_SEQ_PRIORITY_HIGH;
864 /* add the duration time */
865 switch (ev->flags & SNDRV_SEQ_TIME_STAMP_MASK) {
866 case SNDRV_SEQ_TIME_STAMP_TICK:
867 ev->time.tick += ev->data.note.duration;
868 break;
869 case SNDRV_SEQ_TIME_STAMP_REAL:
870 /* unit for duration is ms */
871 ev->time.time.tv_nsec += 1000000 * (ev->data.note.duration % 1000);
872 ev->time.time.tv_sec += ev->data.note.duration / 1000 +
873 ev->time.time.tv_nsec / 1000000000;
874 ev->time.time.tv_nsec %= 1000000000;
875 break;
877 ev->data.note.velocity = ev->data.note.off_velocity;
879 /* Now queue this cell as the note off event */
880 if (snd_seq_enqueue_event(cell, atomic, hop) < 0)
881 snd_seq_cell_free(cell); /* release this cell */
883 } else {
884 /* Normal events:
885 * event cell is freed after processing the event
888 result = snd_seq_deliver_event(client, &cell->event, atomic, hop);
889 snd_seq_cell_free(cell);
892 snd_seq_client_unlock(client);
893 return result;
897 /* Allocate a cell from client pool and enqueue it to queue:
898 * if pool is empty and blocking is TRUE, sleep until a new cell is
899 * available.
901 static int snd_seq_client_enqueue_event(struct snd_seq_client *client,
902 struct snd_seq_event *event,
903 struct file *file, int blocking,
904 int atomic, int hop)
906 struct snd_seq_event_cell *cell;
907 int err;
909 /* special queue values - force direct passing */
910 if (event->queue == SNDRV_SEQ_ADDRESS_SUBSCRIBERS) {
911 event->dest.client = SNDRV_SEQ_ADDRESS_SUBSCRIBERS;
912 event->queue = SNDRV_SEQ_QUEUE_DIRECT;
913 } else
914 #ifdef SUPPORT_BROADCAST
915 if (event->queue == SNDRV_SEQ_ADDRESS_BROADCAST) {
916 event->dest.client = SNDRV_SEQ_ADDRESS_BROADCAST;
917 event->queue = SNDRV_SEQ_QUEUE_DIRECT;
919 #endif
920 if (event->dest.client == SNDRV_SEQ_ADDRESS_SUBSCRIBERS) {
921 /* check presence of source port */
922 struct snd_seq_client_port *src_port = snd_seq_port_use_ptr(client, event->source.port);
923 if (src_port == NULL)
924 return -EINVAL;
925 snd_seq_port_unlock(src_port);
928 /* direct event processing without enqueued */
929 if (snd_seq_ev_is_direct(event)) {
930 if (event->type == SNDRV_SEQ_EVENT_NOTE)
931 return -EINVAL; /* this event must be enqueued! */
932 return snd_seq_deliver_event(client, event, atomic, hop);
935 /* Not direct, normal queuing */
936 if (snd_seq_queue_is_used(event->queue, client->number) <= 0)
937 return -EINVAL; /* invalid queue */
938 if (! snd_seq_write_pool_allocated(client))
939 return -ENXIO; /* queue is not allocated */
941 /* allocate an event cell */
942 err = snd_seq_event_dup(client->pool, event, &cell, !blocking || atomic, file);
943 if (err < 0)
944 return err;
946 /* we got a cell. enqueue it. */
947 if ((err = snd_seq_enqueue_event(cell, atomic, hop)) < 0) {
948 snd_seq_cell_free(cell);
949 return err;
952 return 0;
957 * check validity of event type and data length.
958 * return non-zero if invalid.
960 static int check_event_type_and_length(struct snd_seq_event *ev)
962 switch (snd_seq_ev_length_type(ev)) {
963 case SNDRV_SEQ_EVENT_LENGTH_FIXED:
964 if (snd_seq_ev_is_variable_type(ev))
965 return -EINVAL;
966 break;
967 case SNDRV_SEQ_EVENT_LENGTH_VARIABLE:
968 if (! snd_seq_ev_is_variable_type(ev) ||
969 (ev->data.ext.len & ~SNDRV_SEQ_EXT_MASK) >= SNDRV_SEQ_MAX_EVENT_LEN)
970 return -EINVAL;
971 break;
972 case SNDRV_SEQ_EVENT_LENGTH_VARUSR:
973 if (! snd_seq_ev_is_instr_type(ev) ||
974 ! snd_seq_ev_is_direct(ev))
975 return -EINVAL;
976 break;
978 return 0;
982 /* handle write() */
983 /* possible error values:
984 * -ENXIO invalid client or file open mode
985 * -ENOMEM malloc failed
986 * -EFAULT seg. fault during copy from user space
987 * -EINVAL invalid event
988 * -EAGAIN no space in output pool
989 * -EINTR interrupts while sleep
990 * -EMLINK too many hops
991 * others depends on return value from driver callback
993 static ssize_t snd_seq_write(struct file *file, const char __user *buf,
994 size_t count, loff_t *offset)
996 struct snd_seq_client *client = file->private_data;
997 int written = 0, len;
998 int err = -EINVAL;
999 struct snd_seq_event event;
1001 if (!(snd_seq_file_flags(file) & SNDRV_SEQ_LFLG_OUTPUT))
1002 return -ENXIO;
1004 /* check client structures are in place */
1005 snd_assert(client != NULL, return -ENXIO);
1007 if (!client->accept_output || client->pool == NULL)
1008 return -ENXIO;
1010 /* allocate the pool now if the pool is not allocated yet */
1011 if (client->pool->size > 0 && !snd_seq_write_pool_allocated(client)) {
1012 if (snd_seq_pool_init(client->pool) < 0)
1013 return -ENOMEM;
1016 /* only process whole events */
1017 while (count >= sizeof(struct snd_seq_event)) {
1018 /* Read in the event header from the user */
1019 len = sizeof(event);
1020 if (copy_from_user(&event, buf, len)) {
1021 err = -EFAULT;
1022 break;
1024 event.source.client = client->number; /* fill in client number */
1025 /* Check for extension data length */
1026 if (check_event_type_and_length(&event)) {
1027 err = -EINVAL;
1028 break;
1031 /* check for special events */
1032 if (event.type == SNDRV_SEQ_EVENT_NONE)
1033 goto __skip_event;
1034 else if (snd_seq_ev_is_reserved(&event)) {
1035 err = -EINVAL;
1036 break;
1039 if (snd_seq_ev_is_variable(&event)) {
1040 int extlen = event.data.ext.len & ~SNDRV_SEQ_EXT_MASK;
1041 if ((size_t)(extlen + len) > count) {
1042 /* back out, will get an error this time or next */
1043 err = -EINVAL;
1044 break;
1046 /* set user space pointer */
1047 event.data.ext.len = extlen | SNDRV_SEQ_EXT_USRPTR;
1048 event.data.ext.ptr = (char __force *)buf
1049 + sizeof(struct snd_seq_event);
1050 len += extlen; /* increment data length */
1051 } else {
1052 #ifdef CONFIG_COMPAT
1053 if (client->convert32 && snd_seq_ev_is_varusr(&event)) {
1054 void *ptr = compat_ptr(event.data.raw32.d[1]);
1055 event.data.ext.ptr = ptr;
1057 #endif
1060 /* ok, enqueue it */
1061 err = snd_seq_client_enqueue_event(client, &event, file,
1062 !(file->f_flags & O_NONBLOCK),
1063 0, 0);
1064 if (err < 0)
1065 break;
1067 __skip_event:
1068 /* Update pointers and counts */
1069 count -= len;
1070 buf += len;
1071 written += len;
1074 return written ? written : err;
1079 * handle polling
1081 static unsigned int snd_seq_poll(struct file *file, poll_table * wait)
1083 struct snd_seq_client *client = file->private_data;
1084 unsigned int mask = 0;
1086 /* check client structures are in place */
1087 snd_assert(client != NULL, return -ENXIO);
1089 if ((snd_seq_file_flags(file) & SNDRV_SEQ_LFLG_INPUT) &&
1090 client->data.user.fifo) {
1092 /* check if data is available in the outqueue */
1093 if (snd_seq_fifo_poll_wait(client->data.user.fifo, file, wait))
1094 mask |= POLLIN | POLLRDNORM;
1097 if (snd_seq_file_flags(file) & SNDRV_SEQ_LFLG_OUTPUT) {
1099 /* check if data is available in the pool */
1100 if (!snd_seq_write_pool_allocated(client) ||
1101 snd_seq_pool_poll_wait(client->pool, file, wait))
1102 mask |= POLLOUT | POLLWRNORM;
1105 return mask;
1109 /*-----------------------------------------------------*/
1112 /* SYSTEM_INFO ioctl() */
1113 static int snd_seq_ioctl_system_info(struct snd_seq_client *client, void __user *arg)
1115 struct snd_seq_system_info info;
1117 memset(&info, 0, sizeof(info));
1118 /* fill the info fields */
1119 info.queues = SNDRV_SEQ_MAX_QUEUES;
1120 info.clients = SNDRV_SEQ_MAX_CLIENTS;
1121 info.ports = 256; /* fixed limit */
1122 info.channels = 256; /* fixed limit */
1123 info.cur_clients = client_usage.cur;
1124 info.cur_queues = snd_seq_queue_get_cur_queues();
1126 if (copy_to_user(arg, &info, sizeof(info)))
1127 return -EFAULT;
1128 return 0;
1132 /* RUNNING_MODE ioctl() */
1133 static int snd_seq_ioctl_running_mode(struct snd_seq_client *client, void __user *arg)
1135 struct snd_seq_running_info info;
1136 struct snd_seq_client *cptr;
1137 int err = 0;
1139 if (copy_from_user(&info, arg, sizeof(info)))
1140 return -EFAULT;
1142 /* requested client number */
1143 cptr = snd_seq_client_use_ptr(info.client);
1144 if (cptr == NULL)
1145 return -ENOENT; /* don't change !!! */
1147 #ifdef SNDRV_BIG_ENDIAN
1148 if (! info.big_endian) {
1149 err = -EINVAL;
1150 goto __err;
1152 #else
1153 if (info.big_endian) {
1154 err = -EINVAL;
1155 goto __err;
1158 #endif
1159 if (info.cpu_mode > sizeof(long)) {
1160 err = -EINVAL;
1161 goto __err;
1163 cptr->convert32 = (info.cpu_mode < sizeof(long));
1164 __err:
1165 snd_seq_client_unlock(cptr);
1166 return err;
1169 /* CLIENT_INFO ioctl() */
1170 static void get_client_info(struct snd_seq_client *cptr,
1171 struct snd_seq_client_info *info)
1173 info->client = cptr->number;
1175 /* fill the info fields */
1176 info->type = cptr->type;
1177 strcpy(info->name, cptr->name);
1178 info->filter = cptr->filter;
1179 info->event_lost = cptr->event_lost;
1180 memcpy(info->event_filter, cptr->event_filter, 32);
1181 info->num_ports = cptr->num_ports;
1182 memset(info->reserved, 0, sizeof(info->reserved));
1185 static int snd_seq_ioctl_get_client_info(struct snd_seq_client *client,
1186 void __user *arg)
1188 struct snd_seq_client *cptr;
1189 struct snd_seq_client_info client_info;
1191 if (copy_from_user(&client_info, arg, sizeof(client_info)))
1192 return -EFAULT;
1194 /* requested client number */
1195 cptr = snd_seq_client_use_ptr(client_info.client);
1196 if (cptr == NULL)
1197 return -ENOENT; /* don't change !!! */
1199 get_client_info(cptr, &client_info);
1200 snd_seq_client_unlock(cptr);
1202 if (copy_to_user(arg, &client_info, sizeof(client_info)))
1203 return -EFAULT;
1204 return 0;
1208 /* CLIENT_INFO ioctl() */
1209 static int snd_seq_ioctl_set_client_info(struct snd_seq_client *client,
1210 void __user *arg)
1212 struct snd_seq_client_info client_info;
1214 if (copy_from_user(&client_info, arg, sizeof(client_info)))
1215 return -EFAULT;
1217 /* it is not allowed to set the info fields for an another client */
1218 if (client->number != client_info.client)
1219 return -EPERM;
1220 /* also client type must be set now */
1221 if (client->type != client_info.type)
1222 return -EINVAL;
1224 /* fill the info fields */
1225 if (client_info.name[0])
1226 strlcpy(client->name, client_info.name, sizeof(client->name));
1228 client->filter = client_info.filter;
1229 client->event_lost = client_info.event_lost;
1230 memcpy(client->event_filter, client_info.event_filter, 32);
1232 return 0;
1237 * CREATE PORT ioctl()
1239 static int snd_seq_ioctl_create_port(struct snd_seq_client *client,
1240 void __user *arg)
1242 struct snd_seq_client_port *port;
1243 struct snd_seq_port_info info;
1244 struct snd_seq_port_callback *callback;
1246 if (copy_from_user(&info, arg, sizeof(info)))
1247 return -EFAULT;
1249 /* it is not allowed to create the port for an another client */
1250 if (info.addr.client != client->number)
1251 return -EPERM;
1253 port = snd_seq_create_port(client, (info.flags & SNDRV_SEQ_PORT_FLG_GIVEN_PORT) ? info.addr.port : -1);
1254 if (port == NULL)
1255 return -ENOMEM;
1257 if (client->type == USER_CLIENT && info.kernel) {
1258 snd_seq_delete_port(client, port->addr.port);
1259 return -EINVAL;
1261 if (client->type == KERNEL_CLIENT) {
1262 if ((callback = info.kernel) != NULL) {
1263 if (callback->owner)
1264 port->owner = callback->owner;
1265 port->private_data = callback->private_data;
1266 port->private_free = callback->private_free;
1267 port->callback_all = callback->callback_all;
1268 port->event_input = callback->event_input;
1269 port->c_src.open = callback->subscribe;
1270 port->c_src.close = callback->unsubscribe;
1271 port->c_dest.open = callback->use;
1272 port->c_dest.close = callback->unuse;
1276 info.addr = port->addr;
1278 snd_seq_set_port_info(port, &info);
1279 snd_seq_system_client_ev_port_start(port->addr.client, port->addr.port);
1281 if (copy_to_user(arg, &info, sizeof(info)))
1282 return -EFAULT;
1284 return 0;
1288 * DELETE PORT ioctl()
1290 static int snd_seq_ioctl_delete_port(struct snd_seq_client *client,
1291 void __user *arg)
1293 struct snd_seq_port_info info;
1294 int err;
1296 /* set passed parameters */
1297 if (copy_from_user(&info, arg, sizeof(info)))
1298 return -EFAULT;
1300 /* it is not allowed to remove the port for an another client */
1301 if (info.addr.client != client->number)
1302 return -EPERM;
1304 err = snd_seq_delete_port(client, info.addr.port);
1305 if (err >= 0)
1306 snd_seq_system_client_ev_port_exit(client->number, info.addr.port);
1307 return err;
1312 * GET_PORT_INFO ioctl() (on any client)
1314 static int snd_seq_ioctl_get_port_info(struct snd_seq_client *client,
1315 void __user *arg)
1317 struct snd_seq_client *cptr;
1318 struct snd_seq_client_port *port;
1319 struct snd_seq_port_info info;
1321 if (copy_from_user(&info, arg, sizeof(info)))
1322 return -EFAULT;
1323 cptr = snd_seq_client_use_ptr(info.addr.client);
1324 if (cptr == NULL)
1325 return -ENXIO;
1327 port = snd_seq_port_use_ptr(cptr, info.addr.port);
1328 if (port == NULL) {
1329 snd_seq_client_unlock(cptr);
1330 return -ENOENT; /* don't change */
1333 /* get port info */
1334 snd_seq_get_port_info(port, &info);
1335 snd_seq_port_unlock(port);
1336 snd_seq_client_unlock(cptr);
1338 if (copy_to_user(arg, &info, sizeof(info)))
1339 return -EFAULT;
1340 return 0;
1345 * SET_PORT_INFO ioctl() (only ports on this/own client)
1347 static int snd_seq_ioctl_set_port_info(struct snd_seq_client *client,
1348 void __user *arg)
1350 struct snd_seq_client_port *port;
1351 struct snd_seq_port_info info;
1353 if (copy_from_user(&info, arg, sizeof(info)))
1354 return -EFAULT;
1356 if (info.addr.client != client->number) /* only set our own ports ! */
1357 return -EPERM;
1358 port = snd_seq_port_use_ptr(client, info.addr.port);
1359 if (port) {
1360 snd_seq_set_port_info(port, &info);
1361 snd_seq_port_unlock(port);
1363 return 0;
1368 * port subscription (connection)
1370 #define PERM_RD (SNDRV_SEQ_PORT_CAP_READ|SNDRV_SEQ_PORT_CAP_SUBS_READ)
1371 #define PERM_WR (SNDRV_SEQ_PORT_CAP_WRITE|SNDRV_SEQ_PORT_CAP_SUBS_WRITE)
1373 static int check_subscription_permission(struct snd_seq_client *client,
1374 struct snd_seq_client_port *sport,
1375 struct snd_seq_client_port *dport,
1376 struct snd_seq_port_subscribe *subs)
1378 if (client->number != subs->sender.client &&
1379 client->number != subs->dest.client) {
1380 /* connection by third client - check export permission */
1381 if (check_port_perm(sport, SNDRV_SEQ_PORT_CAP_NO_EXPORT))
1382 return -EPERM;
1383 if (check_port_perm(dport, SNDRV_SEQ_PORT_CAP_NO_EXPORT))
1384 return -EPERM;
1387 /* check read permission */
1388 /* if sender or receiver is the subscribing client itself,
1389 * no permission check is necessary
1391 if (client->number != subs->sender.client) {
1392 if (! check_port_perm(sport, PERM_RD))
1393 return -EPERM;
1395 /* check write permission */
1396 if (client->number != subs->dest.client) {
1397 if (! check_port_perm(dport, PERM_WR))
1398 return -EPERM;
1400 return 0;
1404 * send an subscription notify event to user client:
1405 * client must be user client.
1407 int snd_seq_client_notify_subscription(int client, int port,
1408 struct snd_seq_port_subscribe *info,
1409 int evtype)
1411 struct snd_seq_event event;
1413 memset(&event, 0, sizeof(event));
1414 event.type = evtype;
1415 event.data.connect.dest = info->dest;
1416 event.data.connect.sender = info->sender;
1418 return snd_seq_system_notify(client, port, &event); /* non-atomic */
1423 * add to port's subscription list IOCTL interface
1425 static int snd_seq_ioctl_subscribe_port(struct snd_seq_client *client,
1426 void __user *arg)
1428 int result = -EINVAL;
1429 struct snd_seq_client *receiver = NULL, *sender = NULL;
1430 struct snd_seq_client_port *sport = NULL, *dport = NULL;
1431 struct snd_seq_port_subscribe subs;
1433 if (copy_from_user(&subs, arg, sizeof(subs)))
1434 return -EFAULT;
1436 if ((receiver = snd_seq_client_use_ptr(subs.dest.client)) == NULL)
1437 goto __end;
1438 if ((sender = snd_seq_client_use_ptr(subs.sender.client)) == NULL)
1439 goto __end;
1440 if ((sport = snd_seq_port_use_ptr(sender, subs.sender.port)) == NULL)
1441 goto __end;
1442 if ((dport = snd_seq_port_use_ptr(receiver, subs.dest.port)) == NULL)
1443 goto __end;
1445 result = check_subscription_permission(client, sport, dport, &subs);
1446 if (result < 0)
1447 goto __end;
1449 /* connect them */
1450 result = snd_seq_port_connect(client, sender, sport, receiver, dport, &subs);
1451 if (! result) /* broadcast announce */
1452 snd_seq_client_notify_subscription(SNDRV_SEQ_ADDRESS_SUBSCRIBERS, 0,
1453 &subs, SNDRV_SEQ_EVENT_PORT_SUBSCRIBED);
1454 __end:
1455 if (sport)
1456 snd_seq_port_unlock(sport);
1457 if (dport)
1458 snd_seq_port_unlock(dport);
1459 if (sender)
1460 snd_seq_client_unlock(sender);
1461 if (receiver)
1462 snd_seq_client_unlock(receiver);
1463 return result;
1468 * remove from port's subscription list
1470 static int snd_seq_ioctl_unsubscribe_port(struct snd_seq_client *client,
1471 void __user *arg)
1473 int result = -ENXIO;
1474 struct snd_seq_client *receiver = NULL, *sender = NULL;
1475 struct snd_seq_client_port *sport = NULL, *dport = NULL;
1476 struct snd_seq_port_subscribe subs;
1478 if (copy_from_user(&subs, arg, sizeof(subs)))
1479 return -EFAULT;
1481 if ((receiver = snd_seq_client_use_ptr(subs.dest.client)) == NULL)
1482 goto __end;
1483 if ((sender = snd_seq_client_use_ptr(subs.sender.client)) == NULL)
1484 goto __end;
1485 if ((sport = snd_seq_port_use_ptr(sender, subs.sender.port)) == NULL)
1486 goto __end;
1487 if ((dport = snd_seq_port_use_ptr(receiver, subs.dest.port)) == NULL)
1488 goto __end;
1490 result = check_subscription_permission(client, sport, dport, &subs);
1491 if (result < 0)
1492 goto __end;
1494 result = snd_seq_port_disconnect(client, sender, sport, receiver, dport, &subs);
1495 if (! result) /* broadcast announce */
1496 snd_seq_client_notify_subscription(SNDRV_SEQ_ADDRESS_SUBSCRIBERS, 0,
1497 &subs, SNDRV_SEQ_EVENT_PORT_UNSUBSCRIBED);
1498 __end:
1499 if (sport)
1500 snd_seq_port_unlock(sport);
1501 if (dport)
1502 snd_seq_port_unlock(dport);
1503 if (sender)
1504 snd_seq_client_unlock(sender);
1505 if (receiver)
1506 snd_seq_client_unlock(receiver);
1507 return result;
1511 /* CREATE_QUEUE ioctl() */
1512 static int snd_seq_ioctl_create_queue(struct snd_seq_client *client,
1513 void __user *arg)
1515 struct snd_seq_queue_info info;
1516 int result;
1517 struct snd_seq_queue *q;
1519 if (copy_from_user(&info, arg, sizeof(info)))
1520 return -EFAULT;
1522 result = snd_seq_queue_alloc(client->number, info.locked, info.flags);
1523 if (result < 0)
1524 return result;
1526 q = queueptr(result);
1527 if (q == NULL)
1528 return -EINVAL;
1530 info.queue = q->queue;
1531 info.locked = q->locked;
1532 info.owner = q->owner;
1534 /* set queue name */
1535 if (! info.name[0])
1536 snprintf(info.name, sizeof(info.name), "Queue-%d", q->queue);
1537 strlcpy(q->name, info.name, sizeof(q->name));
1538 queuefree(q);
1540 if (copy_to_user(arg, &info, sizeof(info)))
1541 return -EFAULT;
1543 return 0;
1546 /* DELETE_QUEUE ioctl() */
1547 static int snd_seq_ioctl_delete_queue(struct snd_seq_client *client,
1548 void __user *arg)
1550 struct snd_seq_queue_info info;
1552 if (copy_from_user(&info, arg, sizeof(info)))
1553 return -EFAULT;
1555 return snd_seq_queue_delete(client->number, info.queue);
1558 /* GET_QUEUE_INFO ioctl() */
1559 static int snd_seq_ioctl_get_queue_info(struct snd_seq_client *client,
1560 void __user *arg)
1562 struct snd_seq_queue_info info;
1563 struct snd_seq_queue *q;
1565 if (copy_from_user(&info, arg, sizeof(info)))
1566 return -EFAULT;
1568 q = queueptr(info.queue);
1569 if (q == NULL)
1570 return -EINVAL;
1572 memset(&info, 0, sizeof(info));
1573 info.queue = q->queue;
1574 info.owner = q->owner;
1575 info.locked = q->locked;
1576 strlcpy(info.name, q->name, sizeof(info.name));
1577 queuefree(q);
1579 if (copy_to_user(arg, &info, sizeof(info)))
1580 return -EFAULT;
1582 return 0;
1585 /* SET_QUEUE_INFO ioctl() */
1586 static int snd_seq_ioctl_set_queue_info(struct snd_seq_client *client,
1587 void __user *arg)
1589 struct snd_seq_queue_info info;
1590 struct snd_seq_queue *q;
1592 if (copy_from_user(&info, arg, sizeof(info)))
1593 return -EFAULT;
1595 if (info.owner != client->number)
1596 return -EINVAL;
1598 /* change owner/locked permission */
1599 if (snd_seq_queue_check_access(info.queue, client->number)) {
1600 if (snd_seq_queue_set_owner(info.queue, client->number, info.locked) < 0)
1601 return -EPERM;
1602 if (info.locked)
1603 snd_seq_queue_use(info.queue, client->number, 1);
1604 } else {
1605 return -EPERM;
1608 q = queueptr(info.queue);
1609 if (! q)
1610 return -EINVAL;
1611 if (q->owner != client->number) {
1612 queuefree(q);
1613 return -EPERM;
1615 strlcpy(q->name, info.name, sizeof(q->name));
1616 queuefree(q);
1618 return 0;
1621 /* GET_NAMED_QUEUE ioctl() */
1622 static int snd_seq_ioctl_get_named_queue(struct snd_seq_client *client, void __user *arg)
1624 struct snd_seq_queue_info info;
1625 struct snd_seq_queue *q;
1627 if (copy_from_user(&info, arg, sizeof(info)))
1628 return -EFAULT;
1630 q = snd_seq_queue_find_name(info.name);
1631 if (q == NULL)
1632 return -EINVAL;
1633 info.queue = q->queue;
1634 info.owner = q->owner;
1635 info.locked = q->locked;
1636 queuefree(q);
1638 if (copy_to_user(arg, &info, sizeof(info)))
1639 return -EFAULT;
1641 return 0;
1644 /* GET_QUEUE_STATUS ioctl() */
1645 static int snd_seq_ioctl_get_queue_status(struct snd_seq_client *client,
1646 void __user *arg)
1648 struct snd_seq_queue_status status;
1649 struct snd_seq_queue *queue;
1650 struct snd_seq_timer *tmr;
1652 if (copy_from_user(&status, arg, sizeof(status)))
1653 return -EFAULT;
1655 queue = queueptr(status.queue);
1656 if (queue == NULL)
1657 return -EINVAL;
1658 memset(&status, 0, sizeof(status));
1659 status.queue = queue->queue;
1661 tmr = queue->timer;
1662 status.events = queue->tickq->cells + queue->timeq->cells;
1664 status.time = snd_seq_timer_get_cur_time(tmr);
1665 status.tick = snd_seq_timer_get_cur_tick(tmr);
1667 status.running = tmr->running;
1669 status.flags = queue->flags;
1670 queuefree(queue);
1672 if (copy_to_user(arg, &status, sizeof(status)))
1673 return -EFAULT;
1674 return 0;
1678 /* GET_QUEUE_TEMPO ioctl() */
1679 static int snd_seq_ioctl_get_queue_tempo(struct snd_seq_client *client,
1680 void __user *arg)
1682 struct snd_seq_queue_tempo tempo;
1683 struct snd_seq_queue *queue;
1684 struct snd_seq_timer *tmr;
1686 if (copy_from_user(&tempo, arg, sizeof(tempo)))
1687 return -EFAULT;
1689 queue = queueptr(tempo.queue);
1690 if (queue == NULL)
1691 return -EINVAL;
1692 memset(&tempo, 0, sizeof(tempo));
1693 tempo.queue = queue->queue;
1695 tmr = queue->timer;
1697 tempo.tempo = tmr->tempo;
1698 tempo.ppq = tmr->ppq;
1699 tempo.skew_value = tmr->skew;
1700 tempo.skew_base = tmr->skew_base;
1701 queuefree(queue);
1703 if (copy_to_user(arg, &tempo, sizeof(tempo)))
1704 return -EFAULT;
1705 return 0;
1709 /* SET_QUEUE_TEMPO ioctl() */
1710 int snd_seq_set_queue_tempo(int client, struct snd_seq_queue_tempo *tempo)
1712 if (!snd_seq_queue_check_access(tempo->queue, client))
1713 return -EPERM;
1714 return snd_seq_queue_timer_set_tempo(tempo->queue, client, tempo);
1717 static int snd_seq_ioctl_set_queue_tempo(struct snd_seq_client *client,
1718 void __user *arg)
1720 int result;
1721 struct snd_seq_queue_tempo tempo;
1723 if (copy_from_user(&tempo, arg, sizeof(tempo)))
1724 return -EFAULT;
1726 result = snd_seq_set_queue_tempo(client->number, &tempo);
1727 return result < 0 ? result : 0;
1731 /* GET_QUEUE_TIMER ioctl() */
1732 static int snd_seq_ioctl_get_queue_timer(struct snd_seq_client *client,
1733 void __user *arg)
1735 struct snd_seq_queue_timer timer;
1736 struct snd_seq_queue *queue;
1737 struct snd_seq_timer *tmr;
1739 if (copy_from_user(&timer, arg, sizeof(timer)))
1740 return -EFAULT;
1742 queue = queueptr(timer.queue);
1743 if (queue == NULL)
1744 return -EINVAL;
1746 if (mutex_lock_interruptible(&queue->timer_mutex)) {
1747 queuefree(queue);
1748 return -ERESTARTSYS;
1750 tmr = queue->timer;
1751 memset(&timer, 0, sizeof(timer));
1752 timer.queue = queue->queue;
1754 timer.type = tmr->type;
1755 if (tmr->type == SNDRV_SEQ_TIMER_ALSA) {
1756 timer.u.alsa.id = tmr->alsa_id;
1757 timer.u.alsa.resolution = tmr->preferred_resolution;
1759 mutex_unlock(&queue->timer_mutex);
1760 queuefree(queue);
1762 if (copy_to_user(arg, &timer, sizeof(timer)))
1763 return -EFAULT;
1764 return 0;
1768 /* SET_QUEUE_TIMER ioctl() */
1769 static int snd_seq_ioctl_set_queue_timer(struct snd_seq_client *client,
1770 void __user *arg)
1772 int result = 0;
1773 struct snd_seq_queue_timer timer;
1775 if (copy_from_user(&timer, arg, sizeof(timer)))
1776 return -EFAULT;
1778 if (timer.type != SNDRV_SEQ_TIMER_ALSA)
1779 return -EINVAL;
1781 if (snd_seq_queue_check_access(timer.queue, client->number)) {
1782 struct snd_seq_queue *q;
1783 struct snd_seq_timer *tmr;
1785 q = queueptr(timer.queue);
1786 if (q == NULL)
1787 return -ENXIO;
1788 if (mutex_lock_interruptible(&q->timer_mutex)) {
1789 queuefree(q);
1790 return -ERESTARTSYS;
1792 tmr = q->timer;
1793 snd_seq_queue_timer_close(timer.queue);
1794 tmr->type = timer.type;
1795 if (tmr->type == SNDRV_SEQ_TIMER_ALSA) {
1796 tmr->alsa_id = timer.u.alsa.id;
1797 tmr->preferred_resolution = timer.u.alsa.resolution;
1799 result = snd_seq_queue_timer_open(timer.queue);
1800 mutex_unlock(&q->timer_mutex);
1801 queuefree(q);
1802 } else {
1803 return -EPERM;
1806 return result;
1810 /* GET_QUEUE_CLIENT ioctl() */
1811 static int snd_seq_ioctl_get_queue_client(struct snd_seq_client *client,
1812 void __user *arg)
1814 struct snd_seq_queue_client info;
1815 int used;
1817 if (copy_from_user(&info, arg, sizeof(info)))
1818 return -EFAULT;
1820 used = snd_seq_queue_is_used(info.queue, client->number);
1821 if (used < 0)
1822 return -EINVAL;
1823 info.used = used;
1824 info.client = client->number;
1826 if (copy_to_user(arg, &info, sizeof(info)))
1827 return -EFAULT;
1828 return 0;
1832 /* SET_QUEUE_CLIENT ioctl() */
1833 static int snd_seq_ioctl_set_queue_client(struct snd_seq_client *client,
1834 void __user *arg)
1836 int err;
1837 struct snd_seq_queue_client info;
1839 if (copy_from_user(&info, arg, sizeof(info)))
1840 return -EFAULT;
1842 if (info.used >= 0) {
1843 err = snd_seq_queue_use(info.queue, client->number, info.used);
1844 if (err < 0)
1845 return err;
1848 return snd_seq_ioctl_get_queue_client(client, arg);
1852 /* GET_CLIENT_POOL ioctl() */
1853 static int snd_seq_ioctl_get_client_pool(struct snd_seq_client *client,
1854 void __user *arg)
1856 struct snd_seq_client_pool info;
1857 struct snd_seq_client *cptr;
1859 if (copy_from_user(&info, arg, sizeof(info)))
1860 return -EFAULT;
1862 cptr = snd_seq_client_use_ptr(info.client);
1863 if (cptr == NULL)
1864 return -ENOENT;
1865 memset(&info, 0, sizeof(info));
1866 info.output_pool = cptr->pool->size;
1867 info.output_room = cptr->pool->room;
1868 info.output_free = info.output_pool;
1869 if (cptr->pool)
1870 info.output_free = snd_seq_unused_cells(cptr->pool);
1871 if (cptr->type == USER_CLIENT) {
1872 info.input_pool = cptr->data.user.fifo_pool_size;
1873 info.input_free = info.input_pool;
1874 if (cptr->data.user.fifo)
1875 info.input_free = snd_seq_unused_cells(cptr->data.user.fifo->pool);
1876 } else {
1877 info.input_pool = 0;
1878 info.input_free = 0;
1880 snd_seq_client_unlock(cptr);
1882 if (copy_to_user(arg, &info, sizeof(info)))
1883 return -EFAULT;
1884 return 0;
1887 /* SET_CLIENT_POOL ioctl() */
1888 static int snd_seq_ioctl_set_client_pool(struct snd_seq_client *client,
1889 void __user *arg)
1891 struct snd_seq_client_pool info;
1892 int rc;
1894 if (copy_from_user(&info, arg, sizeof(info)))
1895 return -EFAULT;
1897 if (client->number != info.client)
1898 return -EINVAL; /* can't change other clients */
1900 if (info.output_pool >= 1 && info.output_pool <= SNDRV_SEQ_MAX_EVENTS &&
1901 (! snd_seq_write_pool_allocated(client) ||
1902 info.output_pool != client->pool->size)) {
1903 if (snd_seq_write_pool_allocated(client)) {
1904 /* remove all existing cells */
1905 snd_seq_queue_client_leave_cells(client->number);
1906 snd_seq_pool_done(client->pool);
1908 client->pool->size = info.output_pool;
1909 rc = snd_seq_pool_init(client->pool);
1910 if (rc < 0)
1911 return rc;
1913 if (client->type == USER_CLIENT && client->data.user.fifo != NULL &&
1914 info.input_pool >= 1 &&
1915 info.input_pool <= SNDRV_SEQ_MAX_CLIENT_EVENTS &&
1916 info.input_pool != client->data.user.fifo_pool_size) {
1917 /* change pool size */
1918 rc = snd_seq_fifo_resize(client->data.user.fifo, info.input_pool);
1919 if (rc < 0)
1920 return rc;
1921 client->data.user.fifo_pool_size = info.input_pool;
1923 if (info.output_room >= 1 &&
1924 info.output_room <= client->pool->size) {
1925 client->pool->room = info.output_room;
1928 return snd_seq_ioctl_get_client_pool(client, arg);
1932 /* REMOVE_EVENTS ioctl() */
1933 static int snd_seq_ioctl_remove_events(struct snd_seq_client *client,
1934 void __user *arg)
1936 struct snd_seq_remove_events info;
1938 if (copy_from_user(&info, arg, sizeof(info)))
1939 return -EFAULT;
1942 * Input mostly not implemented XXX.
1944 if (info.remove_mode & SNDRV_SEQ_REMOVE_INPUT) {
1946 * No restrictions so for a user client we can clear
1947 * the whole fifo
1949 if (client->type == USER_CLIENT)
1950 snd_seq_fifo_clear(client->data.user.fifo);
1953 if (info.remove_mode & SNDRV_SEQ_REMOVE_OUTPUT)
1954 snd_seq_queue_remove_cells(client->number, &info);
1956 return 0;
1961 * get subscription info
1963 static int snd_seq_ioctl_get_subscription(struct snd_seq_client *client,
1964 void __user *arg)
1966 int result;
1967 struct snd_seq_client *sender = NULL;
1968 struct snd_seq_client_port *sport = NULL;
1969 struct snd_seq_port_subscribe subs;
1970 struct snd_seq_subscribers *p;
1972 if (copy_from_user(&subs, arg, sizeof(subs)))
1973 return -EFAULT;
1975 result = -EINVAL;
1976 if ((sender = snd_seq_client_use_ptr(subs.sender.client)) == NULL)
1977 goto __end;
1978 if ((sport = snd_seq_port_use_ptr(sender, subs.sender.port)) == NULL)
1979 goto __end;
1980 p = snd_seq_port_get_subscription(&sport->c_src, &subs.dest);
1981 if (p) {
1982 result = 0;
1983 subs = p->info;
1984 } else
1985 result = -ENOENT;
1987 __end:
1988 if (sport)
1989 snd_seq_port_unlock(sport);
1990 if (sender)
1991 snd_seq_client_unlock(sender);
1992 if (result >= 0) {
1993 if (copy_to_user(arg, &subs, sizeof(subs)))
1994 return -EFAULT;
1996 return result;
2001 * get subscription info - check only its presence
2003 static int snd_seq_ioctl_query_subs(struct snd_seq_client *client,
2004 void __user *arg)
2006 int result = -ENXIO;
2007 struct snd_seq_client *cptr = NULL;
2008 struct snd_seq_client_port *port = NULL;
2009 struct snd_seq_query_subs subs;
2010 struct snd_seq_port_subs_info *group;
2011 struct list_head *p;
2012 int i;
2014 if (copy_from_user(&subs, arg, sizeof(subs)))
2015 return -EFAULT;
2017 if ((cptr = snd_seq_client_use_ptr(subs.root.client)) == NULL)
2018 goto __end;
2019 if ((port = snd_seq_port_use_ptr(cptr, subs.root.port)) == NULL)
2020 goto __end;
2022 switch (subs.type) {
2023 case SNDRV_SEQ_QUERY_SUBS_READ:
2024 group = &port->c_src;
2025 break;
2026 case SNDRV_SEQ_QUERY_SUBS_WRITE:
2027 group = &port->c_dest;
2028 break;
2029 default:
2030 goto __end;
2033 down_read(&group->list_mutex);
2034 /* search for the subscriber */
2035 subs.num_subs = group->count;
2036 i = 0;
2037 result = -ENOENT;
2038 list_for_each(p, &group->list_head) {
2039 if (i++ == subs.index) {
2040 /* found! */
2041 struct snd_seq_subscribers *s;
2042 if (subs.type == SNDRV_SEQ_QUERY_SUBS_READ) {
2043 s = list_entry(p, struct snd_seq_subscribers, src_list);
2044 subs.addr = s->info.dest;
2045 } else {
2046 s = list_entry(p, struct snd_seq_subscribers, dest_list);
2047 subs.addr = s->info.sender;
2049 subs.flags = s->info.flags;
2050 subs.queue = s->info.queue;
2051 result = 0;
2052 break;
2055 up_read(&group->list_mutex);
2057 __end:
2058 if (port)
2059 snd_seq_port_unlock(port);
2060 if (cptr)
2061 snd_seq_client_unlock(cptr);
2062 if (result >= 0) {
2063 if (copy_to_user(arg, &subs, sizeof(subs)))
2064 return -EFAULT;
2066 return result;
2071 * query next client
2073 static int snd_seq_ioctl_query_next_client(struct snd_seq_client *client,
2074 void __user *arg)
2076 struct snd_seq_client *cptr = NULL;
2077 struct snd_seq_client_info info;
2079 if (copy_from_user(&info, arg, sizeof(info)))
2080 return -EFAULT;
2082 /* search for next client */
2083 info.client++;
2084 if (info.client < 0)
2085 info.client = 0;
2086 for (; info.client < SNDRV_SEQ_MAX_CLIENTS; info.client++) {
2087 cptr = snd_seq_client_use_ptr(info.client);
2088 if (cptr)
2089 break; /* found */
2091 if (cptr == NULL)
2092 return -ENOENT;
2094 get_client_info(cptr, &info);
2095 snd_seq_client_unlock(cptr);
2097 if (copy_to_user(arg, &info, sizeof(info)))
2098 return -EFAULT;
2099 return 0;
2103 * query next port
2105 static int snd_seq_ioctl_query_next_port(struct snd_seq_client *client,
2106 void __user *arg)
2108 struct snd_seq_client *cptr;
2109 struct snd_seq_client_port *port = NULL;
2110 struct snd_seq_port_info info;
2112 if (copy_from_user(&info, arg, sizeof(info)))
2113 return -EFAULT;
2114 cptr = snd_seq_client_use_ptr(info.addr.client);
2115 if (cptr == NULL)
2116 return -ENXIO;
2118 /* search for next port */
2119 info.addr.port++;
2120 port = snd_seq_port_query_nearest(cptr, &info);
2121 if (port == NULL) {
2122 snd_seq_client_unlock(cptr);
2123 return -ENOENT;
2126 /* get port info */
2127 info.addr = port->addr;
2128 snd_seq_get_port_info(port, &info);
2129 snd_seq_port_unlock(port);
2130 snd_seq_client_unlock(cptr);
2132 if (copy_to_user(arg, &info, sizeof(info)))
2133 return -EFAULT;
2134 return 0;
2137 /* -------------------------------------------------------- */
2139 static struct seq_ioctl_table {
2140 unsigned int cmd;
2141 int (*func)(struct snd_seq_client *client, void __user * arg);
2142 } ioctl_tables[] = {
2143 { SNDRV_SEQ_IOCTL_SYSTEM_INFO, snd_seq_ioctl_system_info },
2144 { SNDRV_SEQ_IOCTL_RUNNING_MODE, snd_seq_ioctl_running_mode },
2145 { SNDRV_SEQ_IOCTL_GET_CLIENT_INFO, snd_seq_ioctl_get_client_info },
2146 { SNDRV_SEQ_IOCTL_SET_CLIENT_INFO, snd_seq_ioctl_set_client_info },
2147 { SNDRV_SEQ_IOCTL_CREATE_PORT, snd_seq_ioctl_create_port },
2148 { SNDRV_SEQ_IOCTL_DELETE_PORT, snd_seq_ioctl_delete_port },
2149 { SNDRV_SEQ_IOCTL_GET_PORT_INFO, snd_seq_ioctl_get_port_info },
2150 { SNDRV_SEQ_IOCTL_SET_PORT_INFO, snd_seq_ioctl_set_port_info },
2151 { SNDRV_SEQ_IOCTL_SUBSCRIBE_PORT, snd_seq_ioctl_subscribe_port },
2152 { SNDRV_SEQ_IOCTL_UNSUBSCRIBE_PORT, snd_seq_ioctl_unsubscribe_port },
2153 { SNDRV_SEQ_IOCTL_CREATE_QUEUE, snd_seq_ioctl_create_queue },
2154 { SNDRV_SEQ_IOCTL_DELETE_QUEUE, snd_seq_ioctl_delete_queue },
2155 { SNDRV_SEQ_IOCTL_GET_QUEUE_INFO, snd_seq_ioctl_get_queue_info },
2156 { SNDRV_SEQ_IOCTL_SET_QUEUE_INFO, snd_seq_ioctl_set_queue_info },
2157 { SNDRV_SEQ_IOCTL_GET_NAMED_QUEUE, snd_seq_ioctl_get_named_queue },
2158 { SNDRV_SEQ_IOCTL_GET_QUEUE_STATUS, snd_seq_ioctl_get_queue_status },
2159 { SNDRV_SEQ_IOCTL_GET_QUEUE_TEMPO, snd_seq_ioctl_get_queue_tempo },
2160 { SNDRV_SEQ_IOCTL_SET_QUEUE_TEMPO, snd_seq_ioctl_set_queue_tempo },
2161 { SNDRV_SEQ_IOCTL_GET_QUEUE_TIMER, snd_seq_ioctl_get_queue_timer },
2162 { SNDRV_SEQ_IOCTL_SET_QUEUE_TIMER, snd_seq_ioctl_set_queue_timer },
2163 { SNDRV_SEQ_IOCTL_GET_QUEUE_CLIENT, snd_seq_ioctl_get_queue_client },
2164 { SNDRV_SEQ_IOCTL_SET_QUEUE_CLIENT, snd_seq_ioctl_set_queue_client },
2165 { SNDRV_SEQ_IOCTL_GET_CLIENT_POOL, snd_seq_ioctl_get_client_pool },
2166 { SNDRV_SEQ_IOCTL_SET_CLIENT_POOL, snd_seq_ioctl_set_client_pool },
2167 { SNDRV_SEQ_IOCTL_GET_SUBSCRIPTION, snd_seq_ioctl_get_subscription },
2168 { SNDRV_SEQ_IOCTL_QUERY_NEXT_CLIENT, snd_seq_ioctl_query_next_client },
2169 { SNDRV_SEQ_IOCTL_QUERY_NEXT_PORT, snd_seq_ioctl_query_next_port },
2170 { SNDRV_SEQ_IOCTL_REMOVE_EVENTS, snd_seq_ioctl_remove_events },
2171 { SNDRV_SEQ_IOCTL_QUERY_SUBS, snd_seq_ioctl_query_subs },
2172 { 0, NULL },
2175 static int snd_seq_do_ioctl(struct snd_seq_client *client, unsigned int cmd,
2176 void __user *arg)
2178 struct seq_ioctl_table *p;
2180 switch (cmd) {
2181 case SNDRV_SEQ_IOCTL_PVERSION:
2182 /* return sequencer version number */
2183 return put_user(SNDRV_SEQ_VERSION, (int __user *)arg) ? -EFAULT : 0;
2184 case SNDRV_SEQ_IOCTL_CLIENT_ID:
2185 /* return the id of this client */
2186 return put_user(client->number, (int __user *)arg) ? -EFAULT : 0;
2189 if (! arg)
2190 return -EFAULT;
2191 for (p = ioctl_tables; p->cmd; p++) {
2192 if (p->cmd == cmd)
2193 return p->func(client, arg);
2195 snd_printd("seq unknown ioctl() 0x%x (type='%c', number=0x%2x)\n",
2196 cmd, _IOC_TYPE(cmd), _IOC_NR(cmd));
2197 return -ENOTTY;
2201 static long snd_seq_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
2203 struct snd_seq_client *client = file->private_data;
2205 snd_assert(client != NULL, return -ENXIO);
2207 return snd_seq_do_ioctl(client, cmd, (void __user *) arg);
2210 #ifdef CONFIG_COMPAT
2211 #include "seq_compat.c"
2212 #else
2213 #define snd_seq_ioctl_compat NULL
2214 #endif
2216 /* -------------------------------------------------------- */
2219 /* exported to kernel modules */
2220 int snd_seq_create_kernel_client(struct snd_card *card, int client_index,
2221 const char *name_fmt, ...)
2223 struct snd_seq_client *client;
2224 va_list args;
2226 snd_assert(! in_interrupt(), return -EBUSY);
2228 if (card && client_index >= SNDRV_SEQ_CLIENTS_PER_CARD)
2229 return -EINVAL;
2230 if (card == NULL && client_index >= SNDRV_SEQ_GLOBAL_CLIENTS)
2231 return -EINVAL;
2233 if (mutex_lock_interruptible(&register_mutex))
2234 return -ERESTARTSYS;
2236 if (card) {
2237 client_index += SNDRV_SEQ_GLOBAL_CLIENTS
2238 + card->number * SNDRV_SEQ_CLIENTS_PER_CARD;
2239 if (client_index >= SNDRV_SEQ_DYNAMIC_CLIENTS_BEGIN)
2240 client_index = -1;
2243 /* empty write queue as default */
2244 client = seq_create_client1(client_index, 0);
2245 if (client == NULL) {
2246 mutex_unlock(&register_mutex);
2247 return -EBUSY; /* failure code */
2249 usage_alloc(&client_usage, 1);
2251 client->accept_input = 1;
2252 client->accept_output = 1;
2254 va_start(args, name_fmt);
2255 vsnprintf(client->name, sizeof(client->name), name_fmt, args);
2256 va_end(args);
2258 client->type = KERNEL_CLIENT;
2259 mutex_unlock(&register_mutex);
2261 /* make others aware this new client */
2262 snd_seq_system_client_ev_client_start(client->number);
2264 /* return client number to caller */
2265 return client->number;
2268 /* exported to kernel modules */
2269 int snd_seq_delete_kernel_client(int client)
2271 struct snd_seq_client *ptr;
2273 snd_assert(! in_interrupt(), return -EBUSY);
2275 ptr = clientptr(client);
2276 if (ptr == NULL)
2277 return -EINVAL;
2279 seq_free_client(ptr);
2280 kfree(ptr);
2281 return 0;
2285 /* skeleton to enqueue event, called from snd_seq_kernel_client_enqueue
2286 * and snd_seq_kernel_client_enqueue_blocking
2288 static int kernel_client_enqueue(int client, struct snd_seq_event *ev,
2289 struct file *file, int blocking,
2290 int atomic, int hop)
2292 struct snd_seq_client *cptr;
2293 int result;
2295 snd_assert(ev != NULL, return -EINVAL);
2297 if (ev->type == SNDRV_SEQ_EVENT_NONE)
2298 return 0; /* ignore this */
2299 if (ev->type == SNDRV_SEQ_EVENT_KERNEL_ERROR)
2300 return -EINVAL; /* quoted events can't be enqueued */
2302 /* fill in client number */
2303 ev->source.client = client;
2305 if (check_event_type_and_length(ev))
2306 return -EINVAL;
2308 cptr = snd_seq_client_use_ptr(client);
2309 if (cptr == NULL)
2310 return -EINVAL;
2312 if (! cptr->accept_output)
2313 result = -EPERM;
2314 else /* send it */
2315 result = snd_seq_client_enqueue_event(cptr, ev, file, blocking, atomic, hop);
2317 snd_seq_client_unlock(cptr);
2318 return result;
2322 * exported, called by kernel clients to enqueue events (w/o blocking)
2324 * RETURN VALUE: zero if succeed, negative if error
2326 int snd_seq_kernel_client_enqueue(int client, struct snd_seq_event * ev,
2327 int atomic, int hop)
2329 return kernel_client_enqueue(client, ev, NULL, 0, atomic, hop);
2333 * exported, called by kernel clients to enqueue events (with blocking)
2335 * RETURN VALUE: zero if succeed, negative if error
2337 int snd_seq_kernel_client_enqueue_blocking(int client, struct snd_seq_event * ev,
2338 struct file *file,
2339 int atomic, int hop)
2341 return kernel_client_enqueue(client, ev, file, 1, atomic, hop);
2346 * exported, called by kernel clients to dispatch events directly to other
2347 * clients, bypassing the queues. Event time-stamp will be updated.
2349 * RETURN VALUE: negative = delivery failed,
2350 * zero, or positive: the number of delivered events
2352 int snd_seq_kernel_client_dispatch(int client, struct snd_seq_event * ev,
2353 int atomic, int hop)
2355 struct snd_seq_client *cptr;
2356 int result;
2358 snd_assert(ev != NULL, return -EINVAL);
2360 /* fill in client number */
2361 ev->queue = SNDRV_SEQ_QUEUE_DIRECT;
2362 ev->source.client = client;
2364 if (check_event_type_and_length(ev))
2365 return -EINVAL;
2367 cptr = snd_seq_client_use_ptr(client);
2368 if (cptr == NULL)
2369 return -EINVAL;
2371 if (!cptr->accept_output)
2372 result = -EPERM;
2373 else
2374 result = snd_seq_deliver_event(cptr, ev, atomic, hop);
2376 snd_seq_client_unlock(cptr);
2377 return result;
2382 * exported, called by kernel clients to perform same functions as with
2383 * userland ioctl()
2385 int snd_seq_kernel_client_ctl(int clientid, unsigned int cmd, void *arg)
2387 struct snd_seq_client *client;
2388 mm_segment_t fs;
2389 int result;
2391 client = clientptr(clientid);
2392 if (client == NULL)
2393 return -ENXIO;
2394 fs = snd_enter_user();
2395 result = snd_seq_do_ioctl(client, cmd, (void __user *)arg);
2396 snd_leave_user(fs);
2397 return result;
2401 /* exported (for OSS emulator) */
2402 int snd_seq_kernel_client_write_poll(int clientid, struct file *file, poll_table *wait)
2404 struct snd_seq_client *client;
2406 client = clientptr(clientid);
2407 if (client == NULL)
2408 return -ENXIO;
2410 if (! snd_seq_write_pool_allocated(client))
2411 return 1;
2412 if (snd_seq_pool_poll_wait(client->pool, file, wait))
2413 return 1;
2414 return 0;
2417 /*---------------------------------------------------------------------------*/
2419 #ifdef CONFIG_PROC_FS
2421 * /proc interface
2423 static void snd_seq_info_dump_subscribers(struct snd_info_buffer *buffer,
2424 struct snd_seq_port_subs_info *group,
2425 int is_src, char *msg)
2427 struct list_head *p;
2428 struct snd_seq_subscribers *s;
2429 int count = 0;
2431 down_read(&group->list_mutex);
2432 if (list_empty(&group->list_head)) {
2433 up_read(&group->list_mutex);
2434 return;
2436 snd_iprintf(buffer, msg);
2437 list_for_each(p, &group->list_head) {
2438 if (is_src)
2439 s = list_entry(p, struct snd_seq_subscribers, src_list);
2440 else
2441 s = list_entry(p, struct snd_seq_subscribers, dest_list);
2442 if (count++)
2443 snd_iprintf(buffer, ", ");
2444 snd_iprintf(buffer, "%d:%d",
2445 is_src ? s->info.dest.client : s->info.sender.client,
2446 is_src ? s->info.dest.port : s->info.sender.port);
2447 if (s->info.flags & SNDRV_SEQ_PORT_SUBS_TIMESTAMP)
2448 snd_iprintf(buffer, "[%c:%d]", ((s->info.flags & SNDRV_SEQ_PORT_SUBS_TIME_REAL) ? 'r' : 't'), s->info.queue);
2449 if (group->exclusive)
2450 snd_iprintf(buffer, "[ex]");
2452 up_read(&group->list_mutex);
2453 snd_iprintf(buffer, "\n");
2456 #define FLAG_PERM_RD(perm) ((perm) & SNDRV_SEQ_PORT_CAP_READ ? ((perm) & SNDRV_SEQ_PORT_CAP_SUBS_READ ? 'R' : 'r') : '-')
2457 #define FLAG_PERM_WR(perm) ((perm) & SNDRV_SEQ_PORT_CAP_WRITE ? ((perm) & SNDRV_SEQ_PORT_CAP_SUBS_WRITE ? 'W' : 'w') : '-')
2458 #define FLAG_PERM_EX(perm) ((perm) & SNDRV_SEQ_PORT_CAP_NO_EXPORT ? '-' : 'e')
2460 #define FLAG_PERM_DUPLEX(perm) ((perm) & SNDRV_SEQ_PORT_CAP_DUPLEX ? 'X' : '-')
2462 static void snd_seq_info_dump_ports(struct snd_info_buffer *buffer,
2463 struct snd_seq_client *client)
2465 struct list_head *l;
2467 mutex_lock(&client->ports_mutex);
2468 list_for_each(l, &client->ports_list_head) {
2469 struct snd_seq_client_port *p = list_entry(l, struct snd_seq_client_port, list);
2470 snd_iprintf(buffer, " Port %3d : \"%s\" (%c%c%c%c)\n",
2471 p->addr.port, p->name,
2472 FLAG_PERM_RD(p->capability),
2473 FLAG_PERM_WR(p->capability),
2474 FLAG_PERM_EX(p->capability),
2475 FLAG_PERM_DUPLEX(p->capability));
2476 snd_seq_info_dump_subscribers(buffer, &p->c_src, 1, " Connecting To: ");
2477 snd_seq_info_dump_subscribers(buffer, &p->c_dest, 0, " Connected From: ");
2479 mutex_unlock(&client->ports_mutex);
2483 void snd_seq_info_pool(struct snd_info_buffer *buffer,
2484 struct snd_seq_pool *pool, char *space);
2486 /* exported to seq_info.c */
2487 void snd_seq_info_clients_read(struct snd_info_entry *entry,
2488 struct snd_info_buffer *buffer)
2490 int c;
2491 struct snd_seq_client *client;
2493 snd_iprintf(buffer, "Client info\n");
2494 snd_iprintf(buffer, " cur clients : %d\n", client_usage.cur);
2495 snd_iprintf(buffer, " peak clients : %d\n", client_usage.peak);
2496 snd_iprintf(buffer, " max clients : %d\n", SNDRV_SEQ_MAX_CLIENTS);
2497 snd_iprintf(buffer, "\n");
2499 /* list the client table */
2500 for (c = 0; c < SNDRV_SEQ_MAX_CLIENTS; c++) {
2501 client = snd_seq_client_use_ptr(c);
2502 if (client == NULL)
2503 continue;
2504 if (client->type == NO_CLIENT) {
2505 snd_seq_client_unlock(client);
2506 continue;
2509 snd_iprintf(buffer, "Client %3d : \"%s\" [%s]\n",
2510 c, client->name,
2511 client->type == USER_CLIENT ? "User" : "Kernel");
2512 snd_seq_info_dump_ports(buffer, client);
2513 if (snd_seq_write_pool_allocated(client)) {
2514 snd_iprintf(buffer, " Output pool :\n");
2515 snd_seq_info_pool(buffer, client->pool, " ");
2517 if (client->type == USER_CLIENT && client->data.user.fifo &&
2518 client->data.user.fifo->pool) {
2519 snd_iprintf(buffer, " Input pool :\n");
2520 snd_seq_info_pool(buffer, client->data.user.fifo->pool, " ");
2522 snd_seq_client_unlock(client);
2525 #endif /* CONFIG_PROC_FS */
2527 /*---------------------------------------------------------------------------*/
2531 * REGISTRATION PART
2534 static struct file_operations snd_seq_f_ops =
2536 .owner = THIS_MODULE,
2537 .read = snd_seq_read,
2538 .write = snd_seq_write,
2539 .open = snd_seq_open,
2540 .release = snd_seq_release,
2541 .poll = snd_seq_poll,
2542 .unlocked_ioctl = snd_seq_ioctl,
2543 .compat_ioctl = snd_seq_ioctl_compat,
2547 * register sequencer device
2549 int __init snd_sequencer_device_init(void)
2551 int err;
2553 if (mutex_lock_interruptible(&register_mutex))
2554 return -ERESTARTSYS;
2556 if ((err = snd_register_device(SNDRV_DEVICE_TYPE_SEQUENCER, NULL, 0,
2557 &snd_seq_f_ops, NULL, "seq")) < 0) {
2558 mutex_unlock(&register_mutex);
2559 return err;
2562 mutex_unlock(&register_mutex);
2564 return 0;
2570 * unregister sequencer device
2572 void __exit snd_sequencer_device_done(void)
2574 snd_unregister_device(SNDRV_DEVICE_TYPE_SEQUENCER, NULL, 0);