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 mutex_lock(&q
->timer_mutex
);
146 snd_seq_timer_stop(q
->timer
);
147 snd_seq_timer_close(q
);
148 mutex_unlock(&q
->timer_mutex
);
149 /* wait until access free */
150 snd_use_lock_sync(&q
->use_lock
);
151 /* release resources... */
152 snd_seq_prioq_delete(&q
->tickq
);
153 snd_seq_prioq_delete(&q
->timeq
);
154 snd_seq_timer_delete(&q
->timer
);
160 /*----------------------------------------------------------------*/
162 /* delete all existing queues */
163 void snd_seq_queues_delete(void)
168 for (i
= 0; i
< SNDRV_SEQ_MAX_QUEUES
; i
++) {
170 queue_delete(queue_list
[i
]);
174 static void queue_use(struct snd_seq_queue
*queue
, int client
, int use
);
176 /* allocate a new queue -
177 * return pointer to new queue or ERR_PTR(-errno) for error
178 * The new queue's use_lock is set to 1. It is the caller's responsibility to
179 * call snd_use_lock_free(&q->use_lock).
181 struct snd_seq_queue
*snd_seq_queue_alloc(int client
, int locked
, unsigned int info_flags
)
183 struct snd_seq_queue
*q
;
185 q
= queue_new(client
, locked
);
187 return ERR_PTR(-ENOMEM
);
188 q
->info_flags
= info_flags
;
189 queue_use(q
, client
, 1);
190 snd_use_lock_use(&q
->use_lock
);
191 if (queue_list_add(q
) < 0) {
192 snd_use_lock_free(&q
->use_lock
);
194 return ERR_PTR(-ENOMEM
);
199 /* delete a queue - queue must be owned by the client */
200 int snd_seq_queue_delete(int client
, int queueid
)
202 struct snd_seq_queue
*q
;
204 if (queueid
< 0 || queueid
>= SNDRV_SEQ_MAX_QUEUES
)
206 q
= queue_list_remove(queueid
, client
);
215 /* return pointer to queue structure for specified id */
216 struct snd_seq_queue
*queueptr(int queueid
)
218 struct snd_seq_queue
*q
;
221 if (queueid
< 0 || queueid
>= SNDRV_SEQ_MAX_QUEUES
)
223 spin_lock_irqsave(&queue_list_lock
, flags
);
224 q
= queue_list
[queueid
];
226 snd_use_lock_use(&q
->use_lock
);
227 spin_unlock_irqrestore(&queue_list_lock
, flags
);
231 /* return the (first) queue matching with the specified name */
232 struct snd_seq_queue
*snd_seq_queue_find_name(char *name
)
235 struct snd_seq_queue
*q
;
237 for (i
= 0; i
< SNDRV_SEQ_MAX_QUEUES
; i
++) {
238 if ((q
= queueptr(i
)) != NULL
) {
239 if (strncmp(q
->name
, name
, sizeof(q
->name
)) == 0)
248 /* -------------------------------------------------------- */
250 void snd_seq_check_queue(struct snd_seq_queue
*q
, int atomic
, int hop
)
253 struct snd_seq_event_cell
*cell
;
258 /* make this function non-reentrant */
259 spin_lock_irqsave(&q
->check_lock
, flags
);
260 if (q
->check_blocked
) {
262 spin_unlock_irqrestore(&q
->check_lock
, flags
);
263 return; /* other thread is already checking queues */
265 q
->check_blocked
= 1;
266 spin_unlock_irqrestore(&q
->check_lock
, flags
);
269 /* Process tick queue... */
271 cell
= snd_seq_prioq_cell_out(q
->tickq
,
272 &q
->timer
->tick
.cur_tick
);
275 snd_seq_dispatch_event(cell
, atomic
, hop
);
278 /* Process time queue... */
280 cell
= snd_seq_prioq_cell_out(q
->timeq
, &q
->timer
->cur_time
);
283 snd_seq_dispatch_event(cell
, atomic
, hop
);
287 spin_lock_irqsave(&q
->check_lock
, flags
);
288 if (q
->check_again
) {
290 spin_unlock_irqrestore(&q
->check_lock
, flags
);
293 q
->check_blocked
= 0;
294 spin_unlock_irqrestore(&q
->check_lock
, flags
);
298 /* enqueue a event to singe queue */
299 int snd_seq_enqueue_event(struct snd_seq_event_cell
*cell
, int atomic
, int hop
)
302 struct snd_seq_queue
*q
;
304 if (snd_BUG_ON(!cell
))
306 dest
= cell
->event
.queue
; /* destination queue */
310 /* handle relative time stamps, convert them into absolute */
311 if ((cell
->event
.flags
& SNDRV_SEQ_TIME_MODE_MASK
) == SNDRV_SEQ_TIME_MODE_REL
) {
312 switch (cell
->event
.flags
& SNDRV_SEQ_TIME_STAMP_MASK
) {
313 case SNDRV_SEQ_TIME_STAMP_TICK
:
314 cell
->event
.time
.tick
+= q
->timer
->tick
.cur_tick
;
317 case SNDRV_SEQ_TIME_STAMP_REAL
:
318 snd_seq_inc_real_time(&cell
->event
.time
.time
,
319 &q
->timer
->cur_time
);
322 cell
->event
.flags
&= ~SNDRV_SEQ_TIME_MODE_MASK
;
323 cell
->event
.flags
|= SNDRV_SEQ_TIME_MODE_ABS
;
325 /* enqueue event in the real-time or midi queue */
326 switch (cell
->event
.flags
& SNDRV_SEQ_TIME_STAMP_MASK
) {
327 case SNDRV_SEQ_TIME_STAMP_TICK
:
328 err
= snd_seq_prioq_cell_in(q
->tickq
, cell
);
331 case SNDRV_SEQ_TIME_STAMP_REAL
:
333 err
= snd_seq_prioq_cell_in(q
->timeq
, cell
);
338 queuefree(q
); /* unlock */
342 /* trigger dispatching */
343 snd_seq_check_queue(q
, atomic
, hop
);
345 queuefree(q
); /* unlock */
351 /*----------------------------------------------------------------*/
353 static inline int check_access(struct snd_seq_queue
*q
, int client
)
355 return (q
->owner
== client
) || (!q
->locked
&& !q
->klocked
);
358 /* check if the client has permission to modify queue parameters.
359 * if it does, lock the queue
361 static int queue_access_lock(struct snd_seq_queue
*q
, int client
)
366 spin_lock_irqsave(&q
->owner_lock
, flags
);
367 access_ok
= check_access(q
, client
);
370 spin_unlock_irqrestore(&q
->owner_lock
, flags
);
374 /* unlock the queue */
375 static inline void queue_access_unlock(struct snd_seq_queue
*q
)
379 spin_lock_irqsave(&q
->owner_lock
, flags
);
381 spin_unlock_irqrestore(&q
->owner_lock
, flags
);
384 /* exported - only checking permission */
385 int snd_seq_queue_check_access(int queueid
, int client
)
387 struct snd_seq_queue
*q
= queueptr(queueid
);
393 spin_lock_irqsave(&q
->owner_lock
, flags
);
394 access_ok
= check_access(q
, client
);
395 spin_unlock_irqrestore(&q
->owner_lock
, flags
);
400 /*----------------------------------------------------------------*/
403 * change queue's owner and permission
405 int snd_seq_queue_set_owner(int queueid
, int client
, int locked
)
407 struct snd_seq_queue
*q
= queueptr(queueid
);
412 if (! queue_access_lock(q
, client
)) {
417 q
->locked
= locked
? 1 : 0;
419 queue_access_unlock(q
);
426 /*----------------------------------------------------------------*/
429 * q->use mutex should be down before calling this function to avoid
430 * confliction with snd_seq_queue_use()
432 int snd_seq_queue_timer_open(int queueid
)
435 struct snd_seq_queue
*queue
;
436 struct snd_seq_timer
*tmr
;
438 queue
= queueptr(queueid
);
442 if ((result
= snd_seq_timer_open(queue
)) < 0) {
443 snd_seq_timer_defaults(tmr
);
444 result
= snd_seq_timer_open(queue
);
451 * q->use mutex should be down before calling this function
453 int snd_seq_queue_timer_close(int queueid
)
455 struct snd_seq_queue
*queue
;
458 queue
= queueptr(queueid
);
461 snd_seq_timer_close(queue
);
466 /* change queue tempo and ppq */
467 int snd_seq_queue_timer_set_tempo(int queueid
, int client
,
468 struct snd_seq_queue_tempo
*info
)
470 struct snd_seq_queue
*q
= queueptr(queueid
);
475 if (! queue_access_lock(q
, client
)) {
480 result
= snd_seq_timer_set_tempo_ppq(q
->timer
, info
->tempo
, info
->ppq
);
481 if (result
>= 0 && info
->skew_base
> 0)
482 result
= snd_seq_timer_set_skew(q
->timer
, info
->skew_value
,
484 queue_access_unlock(q
);
489 /* use or unuse this queue */
490 static void queue_use(struct snd_seq_queue
*queue
, int client
, int use
)
493 if (!test_and_set_bit(client
, queue
->clients_bitmap
))
496 if (test_and_clear_bit(client
, queue
->clients_bitmap
))
499 if (queue
->clients
) {
500 if (use
&& queue
->clients
== 1)
501 snd_seq_timer_defaults(queue
->timer
);
502 snd_seq_timer_open(queue
);
504 snd_seq_timer_close(queue
);
508 /* use or unuse this queue -
509 * if it is the first client, starts the timer.
510 * if it is not longer used by any clients, stop the timer.
512 int snd_seq_queue_use(int queueid
, int client
, int use
)
514 struct snd_seq_queue
*queue
;
516 queue
= queueptr(queueid
);
519 mutex_lock(&queue
->timer_mutex
);
520 queue_use(queue
, client
, use
);
521 mutex_unlock(&queue
->timer_mutex
);
527 * check if queue is used by the client
528 * return negative value if the queue is invalid.
529 * return 0 if not used, 1 if used.
531 int snd_seq_queue_is_used(int queueid
, int client
)
533 struct snd_seq_queue
*q
;
536 q
= queueptr(queueid
);
538 return -EINVAL
; /* invalid queue */
539 result
= test_bit(client
, q
->clients_bitmap
) ? 1 : 0;
545 /*----------------------------------------------------------------*/
547 /* notification that client has left the system -
548 * stop the timer on all queues owned by this client
550 void snd_seq_queue_client_termination(int client
)
554 struct snd_seq_queue
*q
;
556 for (i
= 0; i
< SNDRV_SEQ_MAX_QUEUES
; i
++) {
557 if ((q
= queueptr(i
)) == NULL
)
559 spin_lock_irqsave(&q
->owner_lock
, flags
);
560 if (q
->owner
== client
)
562 spin_unlock_irqrestore(&q
->owner_lock
, flags
);
563 if (q
->owner
== client
) {
564 if (q
->timer
->running
)
565 snd_seq_timer_stop(q
->timer
);
566 snd_seq_timer_reset(q
->timer
);
572 /* final stage notification -
573 * remove cells for no longer exist client (for non-owned queue)
574 * or delete this queue (for owned queue)
576 void snd_seq_queue_client_leave(int client
)
579 struct snd_seq_queue
*q
;
581 /* delete own queues from queue list */
582 for (i
= 0; i
< SNDRV_SEQ_MAX_QUEUES
; i
++) {
583 if ((q
= queue_list_remove(i
, client
)) != NULL
)
587 /* remove cells from existing queues -
588 * they are not owned by this client
590 for (i
= 0; i
< SNDRV_SEQ_MAX_QUEUES
; i
++) {
591 if ((q
= queueptr(i
)) == NULL
)
593 if (test_bit(client
, q
->clients_bitmap
)) {
594 snd_seq_prioq_leave(q
->tickq
, client
, 0);
595 snd_seq_prioq_leave(q
->timeq
, client
, 0);
596 snd_seq_queue_use(q
->queue
, client
, 0);
604 /*----------------------------------------------------------------*/
606 /* remove cells from all queues */
607 void snd_seq_queue_client_leave_cells(int client
)
610 struct snd_seq_queue
*q
;
612 for (i
= 0; i
< SNDRV_SEQ_MAX_QUEUES
; i
++) {
613 if ((q
= queueptr(i
)) == NULL
)
615 snd_seq_prioq_leave(q
->tickq
, client
, 0);
616 snd_seq_prioq_leave(q
->timeq
, client
, 0);
621 /* remove cells based on flush criteria */
622 void snd_seq_queue_remove_cells(int client
, struct snd_seq_remove_events
*info
)
625 struct snd_seq_queue
*q
;
627 for (i
= 0; i
< SNDRV_SEQ_MAX_QUEUES
; i
++) {
628 if ((q
= queueptr(i
)) == NULL
)
630 if (test_bit(client
, q
->clients_bitmap
) &&
631 (! (info
->remove_mode
& SNDRV_SEQ_REMOVE_DEST
) ||
632 q
->queue
== info
->queue
)) {
633 snd_seq_prioq_remove_events(q
->tickq
, client
, info
);
634 snd_seq_prioq_remove_events(q
->timeq
, client
, info
);
640 /*----------------------------------------------------------------*/
643 * send events to all subscribed ports
645 static void queue_broadcast_event(struct snd_seq_queue
*q
, struct snd_seq_event
*ev
,
648 struct snd_seq_event sev
;
652 sev
.flags
= SNDRV_SEQ_TIME_STAMP_TICK
|SNDRV_SEQ_TIME_MODE_ABS
;
653 sev
.time
.tick
= q
->timer
->tick
.cur_tick
;
654 sev
.queue
= q
->queue
;
655 sev
.data
.queue
.queue
= q
->queue
;
657 /* broadcast events from Timer port */
658 sev
.source
.client
= SNDRV_SEQ_CLIENT_SYSTEM
;
659 sev
.source
.port
= SNDRV_SEQ_PORT_SYSTEM_TIMER
;
660 sev
.dest
.client
= SNDRV_SEQ_ADDRESS_SUBSCRIBERS
;
661 snd_seq_kernel_client_dispatch(SNDRV_SEQ_CLIENT_SYSTEM
, &sev
, atomic
, hop
);
665 * process a received queue-control event.
666 * this function is exported for seq_sync.c.
668 static void snd_seq_queue_process_event(struct snd_seq_queue
*q
,
669 struct snd_seq_event
*ev
,
673 case SNDRV_SEQ_EVENT_START
:
674 snd_seq_prioq_leave(q
->tickq
, ev
->source
.client
, 1);
675 snd_seq_prioq_leave(q
->timeq
, ev
->source
.client
, 1);
676 if (! snd_seq_timer_start(q
->timer
))
677 queue_broadcast_event(q
, ev
, atomic
, hop
);
680 case SNDRV_SEQ_EVENT_CONTINUE
:
681 if (! snd_seq_timer_continue(q
->timer
))
682 queue_broadcast_event(q
, ev
, atomic
, hop
);
685 case SNDRV_SEQ_EVENT_STOP
:
686 snd_seq_timer_stop(q
->timer
);
687 queue_broadcast_event(q
, ev
, atomic
, hop
);
690 case SNDRV_SEQ_EVENT_TEMPO
:
691 snd_seq_timer_set_tempo(q
->timer
, ev
->data
.queue
.param
.value
);
692 queue_broadcast_event(q
, ev
, atomic
, hop
);
695 case SNDRV_SEQ_EVENT_SETPOS_TICK
:
696 if (snd_seq_timer_set_position_tick(q
->timer
, ev
->data
.queue
.param
.time
.tick
) == 0) {
697 queue_broadcast_event(q
, ev
, atomic
, hop
);
701 case SNDRV_SEQ_EVENT_SETPOS_TIME
:
702 if (snd_seq_timer_set_position_time(q
->timer
, ev
->data
.queue
.param
.time
.time
) == 0) {
703 queue_broadcast_event(q
, ev
, atomic
, hop
);
706 case SNDRV_SEQ_EVENT_QUEUE_SKEW
:
707 if (snd_seq_timer_set_skew(q
->timer
,
708 ev
->data
.queue
.param
.skew
.value
,
709 ev
->data
.queue
.param
.skew
.base
) == 0) {
710 queue_broadcast_event(q
, ev
, atomic
, hop
);
718 * Queue control via timer control port:
719 * this function is exported as a callback of timer port.
721 int snd_seq_control_queue(struct snd_seq_event
*ev
, int atomic
, int hop
)
723 struct snd_seq_queue
*q
;
727 q
= queueptr(ev
->data
.queue
.queue
);
732 if (! queue_access_lock(q
, ev
->source
.client
)) {
737 snd_seq_queue_process_event(q
, ev
, atomic
, hop
);
739 queue_access_unlock(q
);
745 /*----------------------------------------------------------------*/
747 #ifdef CONFIG_SND_PROC_FS
748 /* exported to seq_info.c */
749 void snd_seq_info_queues_read(struct snd_info_entry
*entry
,
750 struct snd_info_buffer
*buffer
)
753 struct snd_seq_queue
*q
;
754 struct snd_seq_timer
*tmr
;
756 for (i
= 0; i
< SNDRV_SEQ_MAX_QUEUES
; i
++) {
757 if ((q
= queueptr(i
)) == NULL
)
762 bpm
= 60000000 / tmr
->tempo
;
766 snd_iprintf(buffer
, "queue %d: [%s]\n", q
->queue
, q
->name
);
767 snd_iprintf(buffer
, "owned by client : %d\n", q
->owner
);
768 snd_iprintf(buffer
, "lock status : %s\n", q
->locked
? "Locked" : "Free");
769 snd_iprintf(buffer
, "queued time events : %d\n", snd_seq_prioq_avail(q
->timeq
));
770 snd_iprintf(buffer
, "queued tick events : %d\n", snd_seq_prioq_avail(q
->tickq
));
771 snd_iprintf(buffer
, "timer state : %s\n", tmr
->running
? "Running" : "Stopped");
772 snd_iprintf(buffer
, "timer PPQ : %d\n", tmr
->ppq
);
773 snd_iprintf(buffer
, "current tempo : %d\n", tmr
->tempo
);
774 snd_iprintf(buffer
, "current BPM : %d\n", bpm
);
775 snd_iprintf(buffer
, "current time : %d.%09d s\n", tmr
->cur_time
.tv_sec
, tmr
->cur_time
.tv_nsec
);
776 snd_iprintf(buffer
, "current tick : %d\n", tmr
->tick
.cur_tick
);
777 snd_iprintf(buffer
, "\n");
781 #endif /* CONFIG_SND_PROC_FS */