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 /*----------------------------------------------------------------*/
163 int __init
snd_seq_queues_init(void)
166 memset(queue_list, 0, sizeof(queue_list));
172 /* delete all existing queues */
173 void __exit
snd_seq_queues_delete(void)
178 for (i
= 0; i
< SNDRV_SEQ_MAX_QUEUES
; i
++) {
180 queue_delete(queue_list
[i
]);
184 static void queue_use(struct snd_seq_queue
*queue
, int client
, int use
);
186 /* allocate a new queue -
187 * return pointer to new queue or ERR_PTR(-errno) for error
188 * The new queue's use_lock is set to 1. It is the caller's responsibility to
189 * call snd_use_lock_free(&q->use_lock).
191 struct snd_seq_queue
*snd_seq_queue_alloc(int client
, int locked
, unsigned int info_flags
)
193 struct snd_seq_queue
*q
;
195 q
= queue_new(client
, locked
);
197 return ERR_PTR(-ENOMEM
);
198 q
->info_flags
= info_flags
;
199 queue_use(q
, client
, 1);
200 snd_use_lock_use(&q
->use_lock
);
201 if (queue_list_add(q
) < 0) {
202 snd_use_lock_free(&q
->use_lock
);
204 return ERR_PTR(-ENOMEM
);
209 /* delete a queue - queue must be owned by the client */
210 int snd_seq_queue_delete(int client
, int queueid
)
212 struct snd_seq_queue
*q
;
214 if (queueid
< 0 || queueid
>= SNDRV_SEQ_MAX_QUEUES
)
216 q
= queue_list_remove(queueid
, client
);
225 /* return pointer to queue structure for specified id */
226 struct snd_seq_queue
*queueptr(int queueid
)
228 struct snd_seq_queue
*q
;
231 if (queueid
< 0 || queueid
>= SNDRV_SEQ_MAX_QUEUES
)
233 spin_lock_irqsave(&queue_list_lock
, flags
);
234 q
= queue_list
[queueid
];
236 snd_use_lock_use(&q
->use_lock
);
237 spin_unlock_irqrestore(&queue_list_lock
, flags
);
241 /* return the (first) queue matching with the specified name */
242 struct snd_seq_queue
*snd_seq_queue_find_name(char *name
)
245 struct snd_seq_queue
*q
;
247 for (i
= 0; i
< SNDRV_SEQ_MAX_QUEUES
; i
++) {
248 if ((q
= queueptr(i
)) != NULL
) {
249 if (strncmp(q
->name
, name
, sizeof(q
->name
)) == 0)
258 /* -------------------------------------------------------- */
260 void snd_seq_check_queue(struct snd_seq_queue
*q
, int atomic
, int hop
)
263 struct snd_seq_event_cell
*cell
;
268 /* make this function non-reentrant */
269 spin_lock_irqsave(&q
->check_lock
, flags
);
270 if (q
->check_blocked
) {
272 spin_unlock_irqrestore(&q
->check_lock
, flags
);
273 return; /* other thread is already checking queues */
275 q
->check_blocked
= 1;
276 spin_unlock_irqrestore(&q
->check_lock
, flags
);
279 /* Process tick queue... */
281 cell
= snd_seq_prioq_cell_out(q
->tickq
,
282 &q
->timer
->tick
.cur_tick
);
285 snd_seq_dispatch_event(cell
, atomic
, hop
);
288 /* Process time queue... */
290 cell
= snd_seq_prioq_cell_out(q
->timeq
, &q
->timer
->cur_time
);
293 snd_seq_dispatch_event(cell
, atomic
, hop
);
297 spin_lock_irqsave(&q
->check_lock
, flags
);
298 if (q
->check_again
) {
300 spin_unlock_irqrestore(&q
->check_lock
, flags
);
303 q
->check_blocked
= 0;
304 spin_unlock_irqrestore(&q
->check_lock
, flags
);
308 /* enqueue a event to singe queue */
309 int snd_seq_enqueue_event(struct snd_seq_event_cell
*cell
, int atomic
, int hop
)
312 struct snd_seq_queue
*q
;
314 if (snd_BUG_ON(!cell
))
316 dest
= cell
->event
.queue
; /* destination queue */
320 /* handle relative time stamps, convert them into absolute */
321 if ((cell
->event
.flags
& SNDRV_SEQ_TIME_MODE_MASK
) == SNDRV_SEQ_TIME_MODE_REL
) {
322 switch (cell
->event
.flags
& SNDRV_SEQ_TIME_STAMP_MASK
) {
323 case SNDRV_SEQ_TIME_STAMP_TICK
:
324 cell
->event
.time
.tick
+= q
->timer
->tick
.cur_tick
;
327 case SNDRV_SEQ_TIME_STAMP_REAL
:
328 snd_seq_inc_real_time(&cell
->event
.time
.time
,
329 &q
->timer
->cur_time
);
332 cell
->event
.flags
&= ~SNDRV_SEQ_TIME_MODE_MASK
;
333 cell
->event
.flags
|= SNDRV_SEQ_TIME_MODE_ABS
;
335 /* enqueue event in the real-time or midi queue */
336 switch (cell
->event
.flags
& SNDRV_SEQ_TIME_STAMP_MASK
) {
337 case SNDRV_SEQ_TIME_STAMP_TICK
:
338 err
= snd_seq_prioq_cell_in(q
->tickq
, cell
);
341 case SNDRV_SEQ_TIME_STAMP_REAL
:
343 err
= snd_seq_prioq_cell_in(q
->timeq
, cell
);
348 queuefree(q
); /* unlock */
352 /* trigger dispatching */
353 snd_seq_check_queue(q
, atomic
, hop
);
355 queuefree(q
); /* unlock */
361 /*----------------------------------------------------------------*/
363 static inline int check_access(struct snd_seq_queue
*q
, int client
)
365 return (q
->owner
== client
) || (!q
->locked
&& !q
->klocked
);
368 /* check if the client has permission to modify queue parameters.
369 * if it does, lock the queue
371 static int queue_access_lock(struct snd_seq_queue
*q
, int client
)
376 spin_lock_irqsave(&q
->owner_lock
, flags
);
377 access_ok
= check_access(q
, client
);
380 spin_unlock_irqrestore(&q
->owner_lock
, flags
);
384 /* unlock the queue */
385 static inline void queue_access_unlock(struct snd_seq_queue
*q
)
389 spin_lock_irqsave(&q
->owner_lock
, flags
);
391 spin_unlock_irqrestore(&q
->owner_lock
, flags
);
394 /* exported - only checking permission */
395 int snd_seq_queue_check_access(int queueid
, int client
)
397 struct snd_seq_queue
*q
= queueptr(queueid
);
403 spin_lock_irqsave(&q
->owner_lock
, flags
);
404 access_ok
= check_access(q
, client
);
405 spin_unlock_irqrestore(&q
->owner_lock
, flags
);
410 /*----------------------------------------------------------------*/
413 * change queue's owner and permission
415 int snd_seq_queue_set_owner(int queueid
, int client
, int locked
)
417 struct snd_seq_queue
*q
= queueptr(queueid
);
422 if (! queue_access_lock(q
, client
)) {
427 q
->locked
= locked
? 1 : 0;
429 queue_access_unlock(q
);
436 /*----------------------------------------------------------------*/
439 * q->use mutex should be down before calling this function to avoid
440 * confliction with snd_seq_queue_use()
442 int snd_seq_queue_timer_open(int queueid
)
445 struct snd_seq_queue
*queue
;
446 struct snd_seq_timer
*tmr
;
448 queue
= queueptr(queueid
);
452 if ((result
= snd_seq_timer_open(queue
)) < 0) {
453 snd_seq_timer_defaults(tmr
);
454 result
= snd_seq_timer_open(queue
);
461 * q->use mutex should be down before calling this function
463 int snd_seq_queue_timer_close(int queueid
)
465 struct snd_seq_queue
*queue
;
468 queue
= queueptr(queueid
);
471 snd_seq_timer_close(queue
);
476 /* change queue tempo and ppq */
477 int snd_seq_queue_timer_set_tempo(int queueid
, int client
,
478 struct snd_seq_queue_tempo
*info
)
480 struct snd_seq_queue
*q
= queueptr(queueid
);
485 if (! queue_access_lock(q
, client
)) {
490 result
= snd_seq_timer_set_tempo_ppq(q
->timer
, info
->tempo
, info
->ppq
);
491 if (result
>= 0 && info
->skew_base
> 0)
492 result
= snd_seq_timer_set_skew(q
->timer
, info
->skew_value
,
494 queue_access_unlock(q
);
499 /* use or unuse this queue */
500 static void queue_use(struct snd_seq_queue
*queue
, int client
, int use
)
503 if (!test_and_set_bit(client
, queue
->clients_bitmap
))
506 if (test_and_clear_bit(client
, queue
->clients_bitmap
))
509 if (queue
->clients
) {
510 if (use
&& queue
->clients
== 1)
511 snd_seq_timer_defaults(queue
->timer
);
512 snd_seq_timer_open(queue
);
514 snd_seq_timer_close(queue
);
518 /* use or unuse this queue -
519 * if it is the first client, starts the timer.
520 * if it is not longer used by any clients, stop the timer.
522 int snd_seq_queue_use(int queueid
, int client
, int use
)
524 struct snd_seq_queue
*queue
;
526 queue
= queueptr(queueid
);
529 mutex_lock(&queue
->timer_mutex
);
530 queue_use(queue
, client
, use
);
531 mutex_unlock(&queue
->timer_mutex
);
537 * check if queue is used by the client
538 * return negative value if the queue is invalid.
539 * return 0 if not used, 1 if used.
541 int snd_seq_queue_is_used(int queueid
, int client
)
543 struct snd_seq_queue
*q
;
546 q
= queueptr(queueid
);
548 return -EINVAL
; /* invalid queue */
549 result
= test_bit(client
, q
->clients_bitmap
) ? 1 : 0;
555 /*----------------------------------------------------------------*/
557 /* notification that client has left the system -
558 * stop the timer on all queues owned by this client
560 void snd_seq_queue_client_termination(int client
)
564 struct snd_seq_queue
*q
;
566 for (i
= 0; i
< SNDRV_SEQ_MAX_QUEUES
; i
++) {
567 if ((q
= queueptr(i
)) == NULL
)
569 spin_lock_irqsave(&q
->owner_lock
, flags
);
570 if (q
->owner
== client
)
572 spin_unlock_irqrestore(&q
->owner_lock
, flags
);
573 if (q
->owner
== client
) {
574 if (q
->timer
->running
)
575 snd_seq_timer_stop(q
->timer
);
576 snd_seq_timer_reset(q
->timer
);
582 /* final stage notification -
583 * remove cells for no longer exist client (for non-owned queue)
584 * or delete this queue (for owned queue)
586 void snd_seq_queue_client_leave(int client
)
589 struct snd_seq_queue
*q
;
591 /* delete own queues from queue list */
592 for (i
= 0; i
< SNDRV_SEQ_MAX_QUEUES
; i
++) {
593 if ((q
= queue_list_remove(i
, client
)) != NULL
)
597 /* remove cells from existing queues -
598 * they are not owned by this client
600 for (i
= 0; i
< SNDRV_SEQ_MAX_QUEUES
; i
++) {
601 if ((q
= queueptr(i
)) == NULL
)
603 if (test_bit(client
, q
->clients_bitmap
)) {
604 snd_seq_prioq_leave(q
->tickq
, client
, 0);
605 snd_seq_prioq_leave(q
->timeq
, client
, 0);
606 snd_seq_queue_use(q
->queue
, client
, 0);
614 /*----------------------------------------------------------------*/
616 /* remove cells from all queues */
617 void snd_seq_queue_client_leave_cells(int client
)
620 struct snd_seq_queue
*q
;
622 for (i
= 0; i
< SNDRV_SEQ_MAX_QUEUES
; i
++) {
623 if ((q
= queueptr(i
)) == NULL
)
625 snd_seq_prioq_leave(q
->tickq
, client
, 0);
626 snd_seq_prioq_leave(q
->timeq
, client
, 0);
631 /* remove cells based on flush criteria */
632 void snd_seq_queue_remove_cells(int client
, struct snd_seq_remove_events
*info
)
635 struct snd_seq_queue
*q
;
637 for (i
= 0; i
< SNDRV_SEQ_MAX_QUEUES
; i
++) {
638 if ((q
= queueptr(i
)) == NULL
)
640 if (test_bit(client
, q
->clients_bitmap
) &&
641 (! (info
->remove_mode
& SNDRV_SEQ_REMOVE_DEST
) ||
642 q
->queue
== info
->queue
)) {
643 snd_seq_prioq_remove_events(q
->tickq
, client
, info
);
644 snd_seq_prioq_remove_events(q
->timeq
, client
, info
);
650 /*----------------------------------------------------------------*/
653 * send events to all subscribed ports
655 static void queue_broadcast_event(struct snd_seq_queue
*q
, struct snd_seq_event
*ev
,
658 struct snd_seq_event sev
;
662 sev
.flags
= SNDRV_SEQ_TIME_STAMP_TICK
|SNDRV_SEQ_TIME_MODE_ABS
;
663 sev
.time
.tick
= q
->timer
->tick
.cur_tick
;
664 sev
.queue
= q
->queue
;
665 sev
.data
.queue
.queue
= q
->queue
;
667 /* broadcast events from Timer port */
668 sev
.source
.client
= SNDRV_SEQ_CLIENT_SYSTEM
;
669 sev
.source
.port
= SNDRV_SEQ_PORT_SYSTEM_TIMER
;
670 sev
.dest
.client
= SNDRV_SEQ_ADDRESS_SUBSCRIBERS
;
671 snd_seq_kernel_client_dispatch(SNDRV_SEQ_CLIENT_SYSTEM
, &sev
, atomic
, hop
);
675 * process a received queue-control event.
676 * this function is exported for seq_sync.c.
678 static void snd_seq_queue_process_event(struct snd_seq_queue
*q
,
679 struct snd_seq_event
*ev
,
683 case SNDRV_SEQ_EVENT_START
:
684 snd_seq_prioq_leave(q
->tickq
, ev
->source
.client
, 1);
685 snd_seq_prioq_leave(q
->timeq
, ev
->source
.client
, 1);
686 if (! snd_seq_timer_start(q
->timer
))
687 queue_broadcast_event(q
, ev
, atomic
, hop
);
690 case SNDRV_SEQ_EVENT_CONTINUE
:
691 if (! snd_seq_timer_continue(q
->timer
))
692 queue_broadcast_event(q
, ev
, atomic
, hop
);
695 case SNDRV_SEQ_EVENT_STOP
:
696 snd_seq_timer_stop(q
->timer
);
697 queue_broadcast_event(q
, ev
, atomic
, hop
);
700 case SNDRV_SEQ_EVENT_TEMPO
:
701 snd_seq_timer_set_tempo(q
->timer
, ev
->data
.queue
.param
.value
);
702 queue_broadcast_event(q
, ev
, atomic
, hop
);
705 case SNDRV_SEQ_EVENT_SETPOS_TICK
:
706 if (snd_seq_timer_set_position_tick(q
->timer
, ev
->data
.queue
.param
.time
.tick
) == 0) {
707 queue_broadcast_event(q
, ev
, atomic
, hop
);
711 case SNDRV_SEQ_EVENT_SETPOS_TIME
:
712 if (snd_seq_timer_set_position_time(q
->timer
, ev
->data
.queue
.param
.time
.time
) == 0) {
713 queue_broadcast_event(q
, ev
, atomic
, hop
);
716 case SNDRV_SEQ_EVENT_QUEUE_SKEW
:
717 if (snd_seq_timer_set_skew(q
->timer
,
718 ev
->data
.queue
.param
.skew
.value
,
719 ev
->data
.queue
.param
.skew
.base
) == 0) {
720 queue_broadcast_event(q
, ev
, atomic
, hop
);
728 * Queue control via timer control port:
729 * this function is exported as a callback of timer port.
731 int snd_seq_control_queue(struct snd_seq_event
*ev
, int atomic
, int hop
)
733 struct snd_seq_queue
*q
;
737 q
= queueptr(ev
->data
.queue
.queue
);
742 if (! queue_access_lock(q
, ev
->source
.client
)) {
747 snd_seq_queue_process_event(q
, ev
, atomic
, hop
);
749 queue_access_unlock(q
);
755 /*----------------------------------------------------------------*/
757 #ifdef CONFIG_SND_PROC_FS
758 /* exported to seq_info.c */
759 void snd_seq_info_queues_read(struct snd_info_entry
*entry
,
760 struct snd_info_buffer
*buffer
)
763 struct snd_seq_queue
*q
;
764 struct snd_seq_timer
*tmr
;
766 for (i
= 0; i
< SNDRV_SEQ_MAX_QUEUES
; i
++) {
767 if ((q
= queueptr(i
)) == NULL
)
772 bpm
= 60000000 / tmr
->tempo
;
776 snd_iprintf(buffer
, "queue %d: [%s]\n", q
->queue
, q
->name
);
777 snd_iprintf(buffer
, "owned by client : %d\n", q
->owner
);
778 snd_iprintf(buffer
, "lock status : %s\n", q
->locked
? "Locked" : "Free");
779 snd_iprintf(buffer
, "queued time events : %d\n", snd_seq_prioq_avail(q
->timeq
));
780 snd_iprintf(buffer
, "queued tick events : %d\n", snd_seq_prioq_avail(q
->tickq
));
781 snd_iprintf(buffer
, "timer state : %s\n", tmr
->running
? "Running" : "Stopped");
782 snd_iprintf(buffer
, "timer PPQ : %d\n", tmr
->ppq
);
783 snd_iprintf(buffer
, "current tempo : %d\n", tmr
->tempo
);
784 snd_iprintf(buffer
, "current BPM : %d\n", bpm
);
785 snd_iprintf(buffer
, "current time : %d.%09d s\n", tmr
->cur_time
.tv_sec
, tmr
->cur_time
.tv_nsec
);
786 snd_iprintf(buffer
, "current tick : %d\n", tmr
->tick
.cur_tick
);
787 snd_iprintf(buffer
, "\n");
791 #endif /* CONFIG_SND_PROC_FS */