2 * ALSA sequencer Timing queue handling
3 * Copyright (c) 1998-1999 by Frank van de Pol <fvdpol@coil.demon.nl>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 * Nov. 13, 1999 Takashi Iwai <iwai@ww.uni-erlangen.de>
21 * - Queues are allocated dynamically via ioctl.
22 * - When owner client is deleted, all owned queues are deleted, too.
23 * - Owner of unlocked queue is kept unmodified even if it is
24 * manipulated by other clients.
25 * - Owner field in SET_QUEUE_OWNER ioctl must be identical with the
26 * caller client. i.e. Changing owner to a third client is not
29 * Aug. 30, 2000 Takashi Iwai
30 * - Queues are managed in static array again, but with better way.
31 * The API itself is identical.
32 * - The queue is locked when struct snd_seq_queue pointer is returned via
33 * queueptr(). This pointer *MUST* be released afterward by
35 * - Addition of experimental sync support.
38 #include <linux/init.h>
39 #include <linux/slab.h>
40 #include <sound/core.h>
42 #include "seq_memory.h"
43 #include "seq_queue.h"
44 #include "seq_clientmgr.h"
46 #include "seq_timer.h"
49 /* list of allocated queues */
50 static struct snd_seq_queue
*queue_list
[SNDRV_SEQ_MAX_QUEUES
];
51 static DEFINE_SPINLOCK(queue_list_lock
);
52 /* number of queues allocated */
53 static int num_queues
;
55 int snd_seq_queue_get_cur_queues(void)
60 /*----------------------------------------------------------------*/
62 /* assign queue id and insert to list */
63 static int queue_list_add(struct snd_seq_queue
*q
)
68 spin_lock_irqsave(&queue_list_lock
, flags
);
69 for (i
= 0; i
< SNDRV_SEQ_MAX_QUEUES
; i
++) {
70 if (! queue_list
[i
]) {
74 spin_unlock_irqrestore(&queue_list_lock
, flags
);
78 spin_unlock_irqrestore(&queue_list_lock
, flags
);
82 static struct snd_seq_queue
*queue_list_remove(int id
, int client
)
84 struct snd_seq_queue
*q
;
87 spin_lock_irqsave(&queue_list_lock
, flags
);
90 spin_lock(&q
->owner_lock
);
91 if (q
->owner
== client
) {
94 spin_unlock(&q
->owner_lock
);
95 queue_list
[id
] = NULL
;
97 spin_unlock_irqrestore(&queue_list_lock
, flags
);
100 spin_unlock(&q
->owner_lock
);
102 spin_unlock_irqrestore(&queue_list_lock
, flags
);
106 /*----------------------------------------------------------------*/
108 /* create new queue (constructor) */
109 static struct snd_seq_queue
*queue_new(int owner
, int locked
)
111 struct snd_seq_queue
*q
;
113 q
= kzalloc(sizeof(*q
), GFP_KERNEL
);
117 spin_lock_init(&q
->owner_lock
);
118 spin_lock_init(&q
->check_lock
);
119 mutex_init(&q
->timer_mutex
);
120 snd_use_lock_init(&q
->use_lock
);
123 q
->tickq
= snd_seq_prioq_new();
124 q
->timeq
= snd_seq_prioq_new();
125 q
->timer
= snd_seq_timer_new();
126 if (q
->tickq
== NULL
|| q
->timeq
== NULL
|| q
->timer
== NULL
) {
127 snd_seq_prioq_delete(&q
->tickq
);
128 snd_seq_prioq_delete(&q
->timeq
);
129 snd_seq_timer_delete(&q
->timer
);
141 /* delete queue (destructor) */
142 static void queue_delete(struct snd_seq_queue
*q
)
144 /* stop and release the timer */
145 snd_seq_timer_stop(q
->timer
);
146 snd_seq_timer_close(q
);
147 /* wait until access free */
148 snd_use_lock_sync(&q
->use_lock
);
149 /* release resources... */
150 snd_seq_prioq_delete(&q
->tickq
);
151 snd_seq_prioq_delete(&q
->timeq
);
152 snd_seq_timer_delete(&q
->timer
);
158 /*----------------------------------------------------------------*/
161 int __init
snd_seq_queues_init(void)
164 memset(queue_list, 0, sizeof(queue_list));
170 /* delete all existing queues */
171 void __exit
snd_seq_queues_delete(void)
176 for (i
= 0; i
< SNDRV_SEQ_MAX_QUEUES
; i
++) {
178 queue_delete(queue_list
[i
]);
182 /* allocate a new queue -
183 * return queue index value or negative value for error
185 int snd_seq_queue_alloc(int client
, int locked
, unsigned int info_flags
)
187 struct snd_seq_queue
*q
;
189 q
= queue_new(client
, locked
);
192 q
->info_flags
= info_flags
;
193 if (queue_list_add(q
) < 0) {
197 snd_seq_queue_use(q
->queue
, client
, 1); /* use this queue */
201 /* delete a queue - queue must be owned by the client */
202 int snd_seq_queue_delete(int client
, int queueid
)
204 struct snd_seq_queue
*q
;
206 if (queueid
< 0 || queueid
>= SNDRV_SEQ_MAX_QUEUES
)
208 q
= queue_list_remove(queueid
, client
);
217 /* return pointer to queue structure for specified id */
218 struct snd_seq_queue
*queueptr(int queueid
)
220 struct snd_seq_queue
*q
;
223 if (queueid
< 0 || queueid
>= SNDRV_SEQ_MAX_QUEUES
)
225 spin_lock_irqsave(&queue_list_lock
, flags
);
226 q
= queue_list
[queueid
];
228 snd_use_lock_use(&q
->use_lock
);
229 spin_unlock_irqrestore(&queue_list_lock
, flags
);
233 /* return the (first) queue matching with the specified name */
234 struct snd_seq_queue
*snd_seq_queue_find_name(char *name
)
237 struct snd_seq_queue
*q
;
239 for (i
= 0; i
< SNDRV_SEQ_MAX_QUEUES
; i
++) {
240 if ((q
= queueptr(i
)) != NULL
) {
241 if (strncmp(q
->name
, name
, sizeof(q
->name
)) == 0)
250 /* -------------------------------------------------------- */
252 void snd_seq_check_queue(struct snd_seq_queue
*q
, int atomic
, int hop
)
255 struct snd_seq_event_cell
*cell
;
260 /* make this function non-reentrant */
261 spin_lock_irqsave(&q
->check_lock
, flags
);
262 if (q
->check_blocked
) {
264 spin_unlock_irqrestore(&q
->check_lock
, flags
);
265 return; /* other thread is already checking queues */
267 q
->check_blocked
= 1;
268 spin_unlock_irqrestore(&q
->check_lock
, flags
);
271 /* Process tick queue... */
272 while ((cell
= snd_seq_prioq_cell_peek(q
->tickq
)) != NULL
) {
273 if (snd_seq_compare_tick_time(&q
->timer
->tick
.cur_tick
,
274 &cell
->event
.time
.tick
)) {
275 cell
= snd_seq_prioq_cell_out(q
->tickq
);
277 snd_seq_dispatch_event(cell
, atomic
, hop
);
279 /* event remains in the queue */
285 /* Process time queue... */
286 while ((cell
= snd_seq_prioq_cell_peek(q
->timeq
)) != NULL
) {
287 if (snd_seq_compare_real_time(&q
->timer
->cur_time
,
288 &cell
->event
.time
.time
)) {
289 cell
= snd_seq_prioq_cell_out(q
->timeq
);
291 snd_seq_dispatch_event(cell
, atomic
, hop
);
293 /* event remains in the queue */
299 spin_lock_irqsave(&q
->check_lock
, flags
);
300 if (q
->check_again
) {
302 spin_unlock_irqrestore(&q
->check_lock
, flags
);
305 q
->check_blocked
= 0;
306 spin_unlock_irqrestore(&q
->check_lock
, flags
);
310 /* enqueue a event to singe queue */
311 int snd_seq_enqueue_event(struct snd_seq_event_cell
*cell
, int atomic
, int hop
)
314 struct snd_seq_queue
*q
;
316 if (snd_BUG_ON(!cell
))
318 dest
= cell
->event
.queue
; /* destination queue */
322 /* handle relative time stamps, convert them into absolute */
323 if ((cell
->event
.flags
& SNDRV_SEQ_TIME_MODE_MASK
) == SNDRV_SEQ_TIME_MODE_REL
) {
324 switch (cell
->event
.flags
& SNDRV_SEQ_TIME_STAMP_MASK
) {
325 case SNDRV_SEQ_TIME_STAMP_TICK
:
326 cell
->event
.time
.tick
+= q
->timer
->tick
.cur_tick
;
329 case SNDRV_SEQ_TIME_STAMP_REAL
:
330 snd_seq_inc_real_time(&cell
->event
.time
.time
,
331 &q
->timer
->cur_time
);
334 cell
->event
.flags
&= ~SNDRV_SEQ_TIME_MODE_MASK
;
335 cell
->event
.flags
|= SNDRV_SEQ_TIME_MODE_ABS
;
337 /* enqueue event in the real-time or midi queue */
338 switch (cell
->event
.flags
& SNDRV_SEQ_TIME_STAMP_MASK
) {
339 case SNDRV_SEQ_TIME_STAMP_TICK
:
340 err
= snd_seq_prioq_cell_in(q
->tickq
, cell
);
343 case SNDRV_SEQ_TIME_STAMP_REAL
:
345 err
= snd_seq_prioq_cell_in(q
->timeq
, cell
);
350 queuefree(q
); /* unlock */
354 /* trigger dispatching */
355 snd_seq_check_queue(q
, atomic
, hop
);
357 queuefree(q
); /* unlock */
363 /*----------------------------------------------------------------*/
365 static inline int check_access(struct snd_seq_queue
*q
, int client
)
367 return (q
->owner
== client
) || (!q
->locked
&& !q
->klocked
);
370 /* check if the client has permission to modify queue parameters.
371 * if it does, lock the queue
373 static int queue_access_lock(struct snd_seq_queue
*q
, int client
)
378 spin_lock_irqsave(&q
->owner_lock
, flags
);
379 access_ok
= check_access(q
, client
);
382 spin_unlock_irqrestore(&q
->owner_lock
, flags
);
386 /* unlock the queue */
387 static inline void queue_access_unlock(struct snd_seq_queue
*q
)
391 spin_lock_irqsave(&q
->owner_lock
, flags
);
393 spin_unlock_irqrestore(&q
->owner_lock
, flags
);
396 /* exported - only checking permission */
397 int snd_seq_queue_check_access(int queueid
, int client
)
399 struct snd_seq_queue
*q
= queueptr(queueid
);
405 spin_lock_irqsave(&q
->owner_lock
, flags
);
406 access_ok
= check_access(q
, client
);
407 spin_unlock_irqrestore(&q
->owner_lock
, flags
);
412 /*----------------------------------------------------------------*/
415 * change queue's owner and permission
417 int snd_seq_queue_set_owner(int queueid
, int client
, int locked
)
419 struct snd_seq_queue
*q
= queueptr(queueid
);
424 if (! queue_access_lock(q
, client
)) {
429 q
->locked
= locked
? 1 : 0;
431 queue_access_unlock(q
);
438 /*----------------------------------------------------------------*/
441 * q->use mutex should be down before calling this function to avoid
442 * confliction with snd_seq_queue_use()
444 int snd_seq_queue_timer_open(int queueid
)
447 struct snd_seq_queue
*queue
;
448 struct snd_seq_timer
*tmr
;
450 queue
= queueptr(queueid
);
454 if ((result
= snd_seq_timer_open(queue
)) < 0) {
455 snd_seq_timer_defaults(tmr
);
456 result
= snd_seq_timer_open(queue
);
463 * q->use mutex should be down before calling this function
465 int snd_seq_queue_timer_close(int queueid
)
467 struct snd_seq_queue
*queue
;
470 queue
= queueptr(queueid
);
473 snd_seq_timer_close(queue
);
478 /* change queue tempo and ppq */
479 int snd_seq_queue_timer_set_tempo(int queueid
, int client
,
480 struct snd_seq_queue_tempo
*info
)
482 struct snd_seq_queue
*q
= queueptr(queueid
);
487 if (! queue_access_lock(q
, client
)) {
492 result
= snd_seq_timer_set_tempo(q
->timer
, info
->tempo
);
494 result
= snd_seq_timer_set_ppq(q
->timer
, info
->ppq
);
495 if (result
>= 0 && info
->skew_base
> 0)
496 result
= snd_seq_timer_set_skew(q
->timer
, info
->skew_value
,
498 queue_access_unlock(q
);
504 /* use or unuse this queue -
505 * if it is the first client, starts the timer.
506 * if it is not longer used by any clients, stop the timer.
508 int snd_seq_queue_use(int queueid
, int client
, int use
)
510 struct snd_seq_queue
*queue
;
512 queue
= queueptr(queueid
);
515 mutex_lock(&queue
->timer_mutex
);
517 if (!test_and_set_bit(client
, queue
->clients_bitmap
))
520 if (test_and_clear_bit(client
, queue
->clients_bitmap
))
523 if (queue
->clients
) {
524 if (use
&& queue
->clients
== 1)
525 snd_seq_timer_defaults(queue
->timer
);
526 snd_seq_timer_open(queue
);
528 snd_seq_timer_close(queue
);
530 mutex_unlock(&queue
->timer_mutex
);
536 * check if queue is used by the client
537 * return negative value if the queue is invalid.
538 * return 0 if not used, 1 if used.
540 int snd_seq_queue_is_used(int queueid
, int client
)
542 struct snd_seq_queue
*q
;
545 q
= queueptr(queueid
);
547 return -EINVAL
; /* invalid queue */
548 result
= test_bit(client
, q
->clients_bitmap
) ? 1 : 0;
554 /*----------------------------------------------------------------*/
556 /* notification that client has left the system -
557 * stop the timer on all queues owned by this client
559 void snd_seq_queue_client_termination(int client
)
563 struct snd_seq_queue
*q
;
565 for (i
= 0; i
< SNDRV_SEQ_MAX_QUEUES
; i
++) {
566 if ((q
= queueptr(i
)) == NULL
)
568 spin_lock_irqsave(&q
->owner_lock
, flags
);
569 if (q
->owner
== client
)
571 spin_unlock_irqrestore(&q
->owner_lock
, flags
);
572 if (q
->owner
== client
) {
573 if (q
->timer
->running
)
574 snd_seq_timer_stop(q
->timer
);
575 snd_seq_timer_reset(q
->timer
);
581 /* final stage notification -
582 * remove cells for no longer exist client (for non-owned queue)
583 * or delete this queue (for owned queue)
585 void snd_seq_queue_client_leave(int client
)
588 struct snd_seq_queue
*q
;
590 /* delete own queues from queue list */
591 for (i
= 0; i
< SNDRV_SEQ_MAX_QUEUES
; i
++) {
592 if ((q
= queue_list_remove(i
, client
)) != NULL
)
596 /* remove cells from existing queues -
597 * they are not owned by this client
599 for (i
= 0; i
< SNDRV_SEQ_MAX_QUEUES
; i
++) {
600 if ((q
= queueptr(i
)) == NULL
)
602 if (test_bit(client
, q
->clients_bitmap
)) {
603 snd_seq_prioq_leave(q
->tickq
, client
, 0);
604 snd_seq_prioq_leave(q
->timeq
, client
, 0);
605 snd_seq_queue_use(q
->queue
, client
, 0);
613 /*----------------------------------------------------------------*/
615 /* remove cells from all queues */
616 void snd_seq_queue_client_leave_cells(int client
)
619 struct snd_seq_queue
*q
;
621 for (i
= 0; i
< SNDRV_SEQ_MAX_QUEUES
; i
++) {
622 if ((q
= queueptr(i
)) == NULL
)
624 snd_seq_prioq_leave(q
->tickq
, client
, 0);
625 snd_seq_prioq_leave(q
->timeq
, client
, 0);
630 /* remove cells based on flush criteria */
631 void snd_seq_queue_remove_cells(int client
, struct snd_seq_remove_events
*info
)
634 struct snd_seq_queue
*q
;
636 for (i
= 0; i
< SNDRV_SEQ_MAX_QUEUES
; i
++) {
637 if ((q
= queueptr(i
)) == NULL
)
639 if (test_bit(client
, q
->clients_bitmap
) &&
640 (! (info
->remove_mode
& SNDRV_SEQ_REMOVE_DEST
) ||
641 q
->queue
== info
->queue
)) {
642 snd_seq_prioq_remove_events(q
->tickq
, client
, info
);
643 snd_seq_prioq_remove_events(q
->timeq
, client
, info
);
649 /*----------------------------------------------------------------*/
652 * send events to all subscribed ports
654 static void queue_broadcast_event(struct snd_seq_queue
*q
, struct snd_seq_event
*ev
,
657 struct snd_seq_event sev
;
661 sev
.flags
= SNDRV_SEQ_TIME_STAMP_TICK
|SNDRV_SEQ_TIME_MODE_ABS
;
662 sev
.time
.tick
= q
->timer
->tick
.cur_tick
;
663 sev
.queue
= q
->queue
;
664 sev
.data
.queue
.queue
= q
->queue
;
666 /* broadcast events from Timer port */
667 sev
.source
.client
= SNDRV_SEQ_CLIENT_SYSTEM
;
668 sev
.source
.port
= SNDRV_SEQ_PORT_SYSTEM_TIMER
;
669 sev
.dest
.client
= SNDRV_SEQ_ADDRESS_SUBSCRIBERS
;
670 snd_seq_kernel_client_dispatch(SNDRV_SEQ_CLIENT_SYSTEM
, &sev
, atomic
, hop
);
674 * process a received queue-control event.
675 * this function is exported for seq_sync.c.
677 static void snd_seq_queue_process_event(struct snd_seq_queue
*q
,
678 struct snd_seq_event
*ev
,
682 case SNDRV_SEQ_EVENT_START
:
683 snd_seq_prioq_leave(q
->tickq
, ev
->source
.client
, 1);
684 snd_seq_prioq_leave(q
->timeq
, ev
->source
.client
, 1);
685 if (! snd_seq_timer_start(q
->timer
))
686 queue_broadcast_event(q
, ev
, atomic
, hop
);
689 case SNDRV_SEQ_EVENT_CONTINUE
:
690 if (! snd_seq_timer_continue(q
->timer
))
691 queue_broadcast_event(q
, ev
, atomic
, hop
);
694 case SNDRV_SEQ_EVENT_STOP
:
695 snd_seq_timer_stop(q
->timer
);
696 queue_broadcast_event(q
, ev
, atomic
, hop
);
699 case SNDRV_SEQ_EVENT_TEMPO
:
700 snd_seq_timer_set_tempo(q
->timer
, ev
->data
.queue
.param
.value
);
701 queue_broadcast_event(q
, ev
, atomic
, hop
);
704 case SNDRV_SEQ_EVENT_SETPOS_TICK
:
705 if (snd_seq_timer_set_position_tick(q
->timer
, ev
->data
.queue
.param
.time
.tick
) == 0) {
706 queue_broadcast_event(q
, ev
, atomic
, hop
);
710 case SNDRV_SEQ_EVENT_SETPOS_TIME
:
711 if (snd_seq_timer_set_position_time(q
->timer
, ev
->data
.queue
.param
.time
.time
) == 0) {
712 queue_broadcast_event(q
, ev
, atomic
, hop
);
715 case SNDRV_SEQ_EVENT_QUEUE_SKEW
:
716 if (snd_seq_timer_set_skew(q
->timer
,
717 ev
->data
.queue
.param
.skew
.value
,
718 ev
->data
.queue
.param
.skew
.base
) == 0) {
719 queue_broadcast_event(q
, ev
, atomic
, hop
);
727 * Queue control via timer control port:
728 * this function is exported as a callback of timer port.
730 int snd_seq_control_queue(struct snd_seq_event
*ev
, int atomic
, int hop
)
732 struct snd_seq_queue
*q
;
736 q
= queueptr(ev
->data
.queue
.queue
);
741 if (! queue_access_lock(q
, ev
->source
.client
)) {
746 snd_seq_queue_process_event(q
, ev
, atomic
, hop
);
748 queue_access_unlock(q
);
754 /*----------------------------------------------------------------*/
756 #ifdef CONFIG_SND_PROC_FS
757 /* exported to seq_info.c */
758 void snd_seq_info_queues_read(struct snd_info_entry
*entry
,
759 struct snd_info_buffer
*buffer
)
762 struct snd_seq_queue
*q
;
763 struct snd_seq_timer
*tmr
;
765 for (i
= 0; i
< SNDRV_SEQ_MAX_QUEUES
; i
++) {
766 if ((q
= queueptr(i
)) == NULL
)
771 bpm
= 60000000 / tmr
->tempo
;
775 snd_iprintf(buffer
, "queue %d: [%s]\n", q
->queue
, q
->name
);
776 snd_iprintf(buffer
, "owned by client : %d\n", q
->owner
);
777 snd_iprintf(buffer
, "lock status : %s\n", q
->locked
? "Locked" : "Free");
778 snd_iprintf(buffer
, "queued time events : %d\n", snd_seq_prioq_avail(q
->timeq
));
779 snd_iprintf(buffer
, "queued tick events : %d\n", snd_seq_prioq_avail(q
->tickq
));
780 snd_iprintf(buffer
, "timer state : %s\n", tmr
->running
? "Running" : "Stopped");
781 snd_iprintf(buffer
, "timer PPQ : %d\n", tmr
->ppq
);
782 snd_iprintf(buffer
, "current tempo : %d\n", tmr
->tempo
);
783 snd_iprintf(buffer
, "current BPM : %d\n", bpm
);
784 snd_iprintf(buffer
, "current time : %d.%09d s\n", tmr
->cur_time
.tv_sec
, tmr
->cur_time
.tv_nsec
);
785 snd_iprintf(buffer
, "current tick : %d\n", tmr
->tick
.cur_tick
);
786 snd_iprintf(buffer
, "\n");
790 #endif /* CONFIG_SND_PROC_FS */