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