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