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