3 * Copyright (c) 1998 by Frank van de Pol <fvdpol@coil.demon.nl>
4 * Jaroslav Kysela <perex@perex.cz>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 #include <sound/driver.h>
24 #include <sound/core.h>
25 #include <linux/slab.h>
26 #include "seq_system.h"
27 #include "seq_ports.h"
28 #include "seq_clientmgr.h"
32 registration of client ports
39 NOTE: the current implementation of the port structure as a linked list is
40 not optimal for clients that have many ports. For sending messages to all
41 subscribers of a port we first need to find the address of the port
42 structure, which means we have to traverse the list. A direct access table
43 (array) would be better, but big preallocated arrays waste memory.
47 1) leave it this way, a client does normaly does not have more than a few
50 2) replace the linked list of ports by a array of pointers which is
51 dynamicly kmalloced. When a port is added or deleted we can simply allocate
52 a new array, copy the corresponding pointers, and delete the old one. We
53 then only need a pointer to this array, and an integer that tells us how
54 much elements are in array.
58 /* return pointer to port structure - port is locked if found */
59 struct snd_seq_client_port
*snd_seq_port_use_ptr(struct snd_seq_client
*client
,
62 struct snd_seq_client_port
*port
;
66 read_lock(&client
->ports_lock
);
67 list_for_each_entry(port
, &client
->ports_list_head
, list
) {
68 if (port
->addr
.port
== num
) {
70 break; /* deleting now */
71 snd_use_lock_use(&port
->use_lock
);
72 read_unlock(&client
->ports_lock
);
76 read_unlock(&client
->ports_lock
);
77 return NULL
; /* not found */
81 /* search for the next port - port is locked if found */
82 struct snd_seq_client_port
*snd_seq_port_query_nearest(struct snd_seq_client
*client
,
83 struct snd_seq_port_info
*pinfo
)
86 struct snd_seq_client_port
*port
, *found
;
88 num
= pinfo
->addr
.port
;
90 read_lock(&client
->ports_lock
);
91 list_for_each_entry(port
, &client
->ports_list_head
, list
) {
92 if (port
->addr
.port
< num
)
94 if (port
->addr
.port
== num
) {
98 if (found
== NULL
|| port
->addr
.port
< found
->addr
.port
)
105 snd_use_lock_use(&found
->use_lock
);
107 read_unlock(&client
->ports_lock
);
112 /* initialize snd_seq_port_subs_info */
113 static void port_subs_info_init(struct snd_seq_port_subs_info
*grp
)
115 INIT_LIST_HEAD(&grp
->list_head
);
118 rwlock_init(&grp
->list_lock
);
119 init_rwsem(&grp
->list_mutex
);
125 /* create a port, port number is returned (-1 on failure) */
126 struct snd_seq_client_port
*snd_seq_create_port(struct snd_seq_client
*client
,
130 struct snd_seq_client_port
*new_port
, *p
;
134 snd_assert(client
, return NULL
);
136 if (client
->num_ports
>= SNDRV_SEQ_MAX_PORTS
- 1) {
137 snd_printk(KERN_WARNING
"too many ports for client %d\n", client
->number
);
141 /* create a new port */
142 new_port
= kzalloc(sizeof(*new_port
), GFP_KERNEL
);
144 snd_printd("malloc failed for registering client port\n");
145 return NULL
; /* failure, out of memory */
148 new_port
->addr
.client
= client
->number
;
149 new_port
->addr
.port
= -1;
150 new_port
->owner
= THIS_MODULE
;
151 sprintf(new_port
->name
, "port-%d", num
);
152 snd_use_lock_init(&new_port
->use_lock
);
153 port_subs_info_init(&new_port
->c_src
);
154 port_subs_info_init(&new_port
->c_dest
);
156 num
= port
>= 0 ? port
: 0;
157 mutex_lock(&client
->ports_mutex
);
158 write_lock_irqsave(&client
->ports_lock
, flags
);
159 list_for_each_entry(p
, &client
->ports_list_head
, list
) {
160 if (p
->addr
.port
> num
)
162 if (port
< 0) /* auto-probe mode */
163 num
= p
->addr
.port
+ 1;
165 /* insert the new port */
166 list_add_tail(&new_port
->list
, &p
->list
);
168 new_port
->addr
.port
= num
; /* store the port number in the port */
169 write_unlock_irqrestore(&client
->ports_lock
, flags
);
170 mutex_unlock(&client
->ports_mutex
);
171 sprintf(new_port
->name
, "port-%d", num
);
181 static int subscribe_port(struct snd_seq_client
*client
,
182 struct snd_seq_client_port
*port
,
183 struct snd_seq_port_subs_info
*grp
,
184 struct snd_seq_port_subscribe
*info
, int send_ack
);
185 static int unsubscribe_port(struct snd_seq_client
*client
,
186 struct snd_seq_client_port
*port
,
187 struct snd_seq_port_subs_info
*grp
,
188 struct snd_seq_port_subscribe
*info
, int send_ack
);
191 static struct snd_seq_client_port
*get_client_port(struct snd_seq_addr
*addr
,
192 struct snd_seq_client
**cp
)
194 struct snd_seq_client_port
*p
;
195 *cp
= snd_seq_client_use_ptr(addr
->client
);
197 p
= snd_seq_port_use_ptr(*cp
, addr
->port
);
199 snd_seq_client_unlock(*cp
);
208 * remove all subscribers on the list
209 * this is called from port_delete, for each src and dest list.
211 static void clear_subscriber_list(struct snd_seq_client
*client
,
212 struct snd_seq_client_port
*port
,
213 struct snd_seq_port_subs_info
*grp
,
216 struct list_head
*p
, *n
;
218 list_for_each_safe(p
, n
, &grp
->list_head
) {
219 struct snd_seq_subscribers
*subs
;
220 struct snd_seq_client
*c
;
221 struct snd_seq_client_port
*aport
;
223 if (grptype
== SRC_LIST
) {
224 subs
= list_entry(p
, struct snd_seq_subscribers
, src_list
);
225 aport
= get_client_port(&subs
->info
.dest
, &c
);
227 subs
= list_entry(p
, struct snd_seq_subscribers
, dest_list
);
228 aport
= get_client_port(&subs
->info
.sender
, &c
);
231 unsubscribe_port(client
, port
, grp
, &subs
->info
, 0);
233 /* looks like the connected port is being deleted.
234 * we decrease the counter, and when both ports are deleted
235 * remove the subscriber info
237 if (atomic_dec_and_test(&subs
->ref_count
))
240 /* ok we got the connected port */
241 struct snd_seq_port_subs_info
*agrp
;
242 agrp
= (grptype
== SRC_LIST
) ? &aport
->c_dest
: &aport
->c_src
;
243 down_write(&agrp
->list_mutex
);
244 if (grptype
== SRC_LIST
)
245 list_del(&subs
->dest_list
);
247 list_del(&subs
->src_list
);
248 up_write(&agrp
->list_mutex
);
249 unsubscribe_port(c
, aport
, agrp
, &subs
->info
, 1);
251 snd_seq_port_unlock(aport
);
252 snd_seq_client_unlock(c
);
257 /* delete port data */
258 static int port_delete(struct snd_seq_client
*client
,
259 struct snd_seq_client_port
*port
)
261 /* set closing flag and wait for all port access are gone */
263 snd_use_lock_sync(&port
->use_lock
);
265 /* clear subscribers info */
266 clear_subscriber_list(client
, port
, &port
->c_src
, SRC_LIST
);
267 clear_subscriber_list(client
, port
, &port
->c_dest
, DEST_LIST
);
269 if (port
->private_free
)
270 port
->private_free(port
->private_data
);
272 snd_assert(port
->c_src
.count
== 0,);
273 snd_assert(port
->c_dest
.count
== 0,);
280 /* delete a port with the given port id */
281 int snd_seq_delete_port(struct snd_seq_client
*client
, int port
)
284 struct snd_seq_client_port
*found
= NULL
, *p
;
286 mutex_lock(&client
->ports_mutex
);
287 write_lock_irqsave(&client
->ports_lock
, flags
);
288 list_for_each_entry(p
, &client
->ports_list_head
, list
) {
289 if (p
->addr
.port
== port
) {
290 /* ok found. delete from the list at first */
297 write_unlock_irqrestore(&client
->ports_lock
, flags
);
298 mutex_unlock(&client
->ports_mutex
);
300 return port_delete(client
, found
);
305 /* delete the all ports belonging to the given client */
306 int snd_seq_delete_all_ports(struct snd_seq_client
*client
)
309 struct list_head deleted_list
;
310 struct snd_seq_client_port
*port
, *tmp
;
312 /* move the port list to deleted_list, and
313 * clear the port list in the client data.
315 mutex_lock(&client
->ports_mutex
);
316 write_lock_irqsave(&client
->ports_lock
, flags
);
317 if (! list_empty(&client
->ports_list_head
)) {
318 list_add(&deleted_list
, &client
->ports_list_head
);
319 list_del_init(&client
->ports_list_head
);
321 INIT_LIST_HEAD(&deleted_list
);
323 client
->num_ports
= 0;
324 write_unlock_irqrestore(&client
->ports_lock
, flags
);
326 /* remove each port in deleted_list */
327 list_for_each_entry_safe(port
, tmp
, &deleted_list
, list
) {
328 list_del(&port
->list
);
329 snd_seq_system_client_ev_port_exit(port
->addr
.client
, port
->addr
.port
);
330 port_delete(client
, port
);
332 mutex_unlock(&client
->ports_mutex
);
336 /* set port info fields */
337 int snd_seq_set_port_info(struct snd_seq_client_port
* port
,
338 struct snd_seq_port_info
* info
)
340 snd_assert(port
&& info
, return -EINVAL
);
344 strlcpy(port
->name
, info
->name
, sizeof(port
->name
));
346 /* set capabilities */
347 port
->capability
= info
->capability
;
350 port
->type
= info
->type
;
352 /* information about supported channels/voices */
353 port
->midi_channels
= info
->midi_channels
;
354 port
->midi_voices
= info
->midi_voices
;
355 port
->synth_voices
= info
->synth_voices
;
358 port
->timestamping
= (info
->flags
& SNDRV_SEQ_PORT_FLG_TIMESTAMP
) ? 1 : 0;
359 port
->time_real
= (info
->flags
& SNDRV_SEQ_PORT_FLG_TIME_REAL
) ? 1 : 0;
360 port
->time_queue
= info
->time_queue
;
365 /* get port info fields */
366 int snd_seq_get_port_info(struct snd_seq_client_port
* port
,
367 struct snd_seq_port_info
* info
)
369 snd_assert(port
&& info
, return -EINVAL
);
372 strlcpy(info
->name
, port
->name
, sizeof(info
->name
));
374 /* get capabilities */
375 info
->capability
= port
->capability
;
378 info
->type
= port
->type
;
380 /* information about supported channels/voices */
381 info
->midi_channels
= port
->midi_channels
;
382 info
->midi_voices
= port
->midi_voices
;
383 info
->synth_voices
= port
->synth_voices
;
385 /* get subscriber counts */
386 info
->read_use
= port
->c_src
.count
;
387 info
->write_use
= port
->c_dest
.count
;
391 if (port
->timestamping
) {
392 info
->flags
|= SNDRV_SEQ_PORT_FLG_TIMESTAMP
;
394 info
->flags
|= SNDRV_SEQ_PORT_FLG_TIME_REAL
;
395 info
->time_queue
= port
->time_queue
;
404 * call callback functions (if any):
405 * the callbacks are invoked only when the first (for connection) or
406 * the last subscription (for disconnection) is done. Second or later
407 * subscription results in increment of counter, but no callback is
409 * This feature is useful if these callbacks are associated with
410 * initialization or termination of devices (see seq_midi.c).
412 * If callback_all option is set, the callback function is invoked
413 * at each connnection/disconnection.
416 static int subscribe_port(struct snd_seq_client
*client
,
417 struct snd_seq_client_port
*port
,
418 struct snd_seq_port_subs_info
*grp
,
419 struct snd_seq_port_subscribe
*info
,
424 if (!try_module_get(port
->owner
))
427 if (grp
->open
&& (port
->callback_all
|| grp
->count
== 1)) {
428 err
= grp
->open(port
->private_data
, info
);
430 module_put(port
->owner
);
434 if (err
>= 0 && send_ack
&& client
->type
== USER_CLIENT
)
435 snd_seq_client_notify_subscription(port
->addr
.client
, port
->addr
.port
,
436 info
, SNDRV_SEQ_EVENT_PORT_SUBSCRIBED
);
441 static int unsubscribe_port(struct snd_seq_client
*client
,
442 struct snd_seq_client_port
*port
,
443 struct snd_seq_port_subs_info
*grp
,
444 struct snd_seq_port_subscribe
*info
,
452 if (grp
->close
&& (port
->callback_all
|| grp
->count
== 0))
453 err
= grp
->close(port
->private_data
, info
);
454 if (send_ack
&& client
->type
== USER_CLIENT
)
455 snd_seq_client_notify_subscription(port
->addr
.client
, port
->addr
.port
,
456 info
, SNDRV_SEQ_EVENT_PORT_UNSUBSCRIBED
);
457 module_put(port
->owner
);
463 /* check if both addresses are identical */
464 static inline int addr_match(struct snd_seq_addr
*r
, struct snd_seq_addr
*s
)
466 return (r
->client
== s
->client
) && (r
->port
== s
->port
);
469 /* check the two subscribe info match */
470 /* if flags is zero, checks only sender and destination addresses */
471 static int match_subs_info(struct snd_seq_port_subscribe
*r
,
472 struct snd_seq_port_subscribe
*s
)
474 if (addr_match(&r
->sender
, &s
->sender
) &&
475 addr_match(&r
->dest
, &s
->dest
)) {
476 if (r
->flags
&& r
->flags
== s
->flags
)
477 return r
->queue
== s
->queue
;
485 /* connect two ports */
486 int snd_seq_port_connect(struct snd_seq_client
*connector
,
487 struct snd_seq_client
*src_client
,
488 struct snd_seq_client_port
*src_port
,
489 struct snd_seq_client
*dest_client
,
490 struct snd_seq_client_port
*dest_port
,
491 struct snd_seq_port_subscribe
*info
)
493 struct snd_seq_port_subs_info
*src
= &src_port
->c_src
;
494 struct snd_seq_port_subs_info
*dest
= &dest_port
->c_dest
;
495 struct snd_seq_subscribers
*subs
, *s
;
496 int err
, src_called
= 0;
500 subs
= kzalloc(sizeof(*subs
), GFP_KERNEL
);
505 atomic_set(&subs
->ref_count
, 2);
507 down_write(&src
->list_mutex
);
508 down_write_nested(&dest
->list_mutex
, SINGLE_DEPTH_NESTING
);
510 exclusive
= info
->flags
& SNDRV_SEQ_PORT_SUBS_EXCLUSIVE
? 1 : 0;
513 if (! list_empty(&src
->list_head
) || ! list_empty(&dest
->list_head
))
516 if (src
->exclusive
|| dest
->exclusive
)
518 /* check whether already exists */
519 list_for_each_entry(s
, &src
->list_head
, src_list
) {
520 if (match_subs_info(info
, &s
->info
))
523 list_for_each_entry(s
, &dest
->list_head
, dest_list
) {
524 if (match_subs_info(info
, &s
->info
))
529 if ((err
= subscribe_port(src_client
, src_port
, src
, info
,
530 connector
->number
!= src_client
->number
)) < 0)
534 if ((err
= subscribe_port(dest_client
, dest_port
, dest
, info
,
535 connector
->number
!= dest_client
->number
)) < 0)
539 write_lock_irqsave(&src
->list_lock
, flags
);
540 // write_lock(&dest->list_lock); // no other lock yet
541 list_add_tail(&subs
->src_list
, &src
->list_head
);
542 list_add_tail(&subs
->dest_list
, &dest
->list_head
);
543 // write_unlock(&dest->list_lock); // no other lock yet
544 write_unlock_irqrestore(&src
->list_lock
, flags
);
546 src
->exclusive
= dest
->exclusive
= exclusive
;
548 up_write(&dest
->list_mutex
);
549 up_write(&src
->list_mutex
);
554 unsubscribe_port(src_client
, src_port
, src
, info
,
555 connector
->number
!= src_client
->number
);
557 up_write(&dest
->list_mutex
);
558 up_write(&src
->list_mutex
);
563 /* remove the connection */
564 int snd_seq_port_disconnect(struct snd_seq_client
*connector
,
565 struct snd_seq_client
*src_client
,
566 struct snd_seq_client_port
*src_port
,
567 struct snd_seq_client
*dest_client
,
568 struct snd_seq_client_port
*dest_port
,
569 struct snd_seq_port_subscribe
*info
)
571 struct snd_seq_port_subs_info
*src
= &src_port
->c_src
;
572 struct snd_seq_port_subs_info
*dest
= &dest_port
->c_dest
;
573 struct snd_seq_subscribers
*subs
;
577 down_write(&src
->list_mutex
);
578 down_write_nested(&dest
->list_mutex
, SINGLE_DEPTH_NESTING
);
580 /* look for the connection */
581 list_for_each_entry(subs
, &src
->list_head
, src_list
) {
582 if (match_subs_info(info
, &subs
->info
)) {
583 write_lock_irqsave(&src
->list_lock
, flags
);
584 // write_lock(&dest->list_lock); // no lock yet
585 list_del(&subs
->src_list
);
586 list_del(&subs
->dest_list
);
587 // write_unlock(&dest->list_lock);
588 write_unlock_irqrestore(&src
->list_lock
, flags
);
589 src
->exclusive
= dest
->exclusive
= 0;
590 unsubscribe_port(src_client
, src_port
, src
, info
,
591 connector
->number
!= src_client
->number
);
592 unsubscribe_port(dest_client
, dest_port
, dest
, info
,
593 connector
->number
!= dest_client
->number
);
600 up_write(&dest
->list_mutex
);
601 up_write(&src
->list_mutex
);
606 /* get matched subscriber */
607 struct snd_seq_subscribers
*snd_seq_port_get_subscription(struct snd_seq_port_subs_info
*src_grp
,
608 struct snd_seq_addr
*dest_addr
)
610 struct snd_seq_subscribers
*s
, *found
= NULL
;
612 down_read(&src_grp
->list_mutex
);
613 list_for_each_entry(s
, &src_grp
->list_head
, src_list
) {
614 if (addr_match(dest_addr
, &s
->info
.dest
)) {
619 up_read(&src_grp
->list_mutex
);
624 * Attach a device driver that wants to receive events from the
625 * sequencer. Returns the new port number on success.
626 * A driver that wants to receive the events converted to midi, will
627 * use snd_seq_midisynth_register_port().
630 int snd_seq_event_port_attach(int client
,
631 struct snd_seq_port_callback
*pcbp
,
632 int cap
, int type
, int midi_channels
,
633 int midi_voices
, char *portname
)
635 struct snd_seq_port_info portinfo
;
638 /* Set up the port */
639 memset(&portinfo
, 0, sizeof(portinfo
));
640 portinfo
.addr
.client
= client
;
641 strlcpy(portinfo
.name
, portname
? portname
: "Unamed port",
642 sizeof(portinfo
.name
));
644 portinfo
.capability
= cap
;
645 portinfo
.type
= type
;
646 portinfo
.kernel
= pcbp
;
647 portinfo
.midi_channels
= midi_channels
;
648 portinfo
.midi_voices
= midi_voices
;
651 ret
= snd_seq_kernel_client_ctl(client
,
652 SNDRV_SEQ_IOCTL_CREATE_PORT
,
656 ret
= portinfo
.addr
.port
;
661 EXPORT_SYMBOL(snd_seq_event_port_attach
);
664 * Detach the driver from a port.
667 int snd_seq_event_port_detach(int client
, int port
)
669 struct snd_seq_port_info portinfo
;
672 memset(&portinfo
, 0, sizeof(portinfo
));
673 portinfo
.addr
.client
= client
;
674 portinfo
.addr
.port
= port
;
675 err
= snd_seq_kernel_client_ctl(client
,
676 SNDRV_SEQ_IOCTL_DELETE_PORT
,
682 EXPORT_SYMBOL(snd_seq_event_port_detach
);