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