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;
254 snd_seq_tick_time_t cur_tick;
255 snd_seq_real_time_t cur_time;
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 cur_tick = snd_seq_timer_get_cur_tick(q->timer);
274 cell = snd_seq_prioq_cell_out(q->tickq, &cur_tick);
277 snd_seq_dispatch_event(cell, atomic, hop);
280 /* Process time queue... */
281 cur_time = snd_seq_timer_get_cur_time(q->timer, false);
283 cell = snd_seq_prioq_cell_out(q->timeq, &cur_time);
286 snd_seq_dispatch_event(cell, atomic, hop);
290 spin_lock_irqsave(&q->check_lock, flags);
291 if (q->check_again) {
293 spin_unlock_irqrestore(&q->check_lock, flags);
296 q->check_blocked = 0;
297 spin_unlock_irqrestore(&q->check_lock, flags);
301 /* enqueue a event to singe queue */
302 int snd_seq_enqueue_event(struct snd_seq_event_cell *cell, int atomic, int hop)
305 struct snd_seq_queue *q;
307 if (snd_BUG_ON(!cell))
309 dest = cell->event.queue; /* destination queue */
313 /* handle relative time stamps, convert them into absolute */
314 if ((cell->event.flags & SNDRV_SEQ_TIME_MODE_MASK) == SNDRV_SEQ_TIME_MODE_REL) {
315 switch (cell->event.flags & SNDRV_SEQ_TIME_STAMP_MASK) {
316 case SNDRV_SEQ_TIME_STAMP_TICK:
317 cell->event.time.tick += q->timer->tick.cur_tick;
320 case SNDRV_SEQ_TIME_STAMP_REAL:
321 snd_seq_inc_real_time(&cell->event.time.time,
322 &q->timer->cur_time);
325 cell->event.flags &= ~SNDRV_SEQ_TIME_MODE_MASK;
326 cell->event.flags |= SNDRV_SEQ_TIME_MODE_ABS;
328 /* enqueue event in the real-time or midi queue */
329 switch (cell->event.flags & SNDRV_SEQ_TIME_STAMP_MASK) {
330 case SNDRV_SEQ_TIME_STAMP_TICK:
331 err = snd_seq_prioq_cell_in(q->tickq, cell);
334 case SNDRV_SEQ_TIME_STAMP_REAL:
336 err = snd_seq_prioq_cell_in(q->timeq, cell);
341 queuefree(q); /* unlock */
345 /* trigger dispatching */
346 snd_seq_check_queue(q, atomic, hop);
348 queuefree(q); /* unlock */
354 /*----------------------------------------------------------------*/
356 static inline int check_access(struct snd_seq_queue *q, int client)
358 return (q->owner == client) || (!q->locked && !q->klocked);
361 /* check if the client has permission to modify queue parameters.
362 * if it does, lock the queue
364 static int queue_access_lock(struct snd_seq_queue *q, int client)
369 spin_lock_irqsave(&q->owner_lock, flags);
370 access_ok = check_access(q, client);
373 spin_unlock_irqrestore(&q->owner_lock, flags);
377 /* unlock the queue */
378 static inline void queue_access_unlock(struct snd_seq_queue *q)
382 spin_lock_irqsave(&q->owner_lock, flags);
384 spin_unlock_irqrestore(&q->owner_lock, flags);
387 /* exported - only checking permission */
388 int snd_seq_queue_check_access(int queueid, int client)
390 struct snd_seq_queue *q = queueptr(queueid);
396 spin_lock_irqsave(&q->owner_lock, flags);
397 access_ok = check_access(q, client);
398 spin_unlock_irqrestore(&q->owner_lock, flags);
403 /*----------------------------------------------------------------*/
406 * change queue's owner and permission
408 int snd_seq_queue_set_owner(int queueid, int client, int locked)
410 struct snd_seq_queue *q = queueptr(queueid);
416 if (! queue_access_lock(q, client)) {
421 spin_lock_irqsave(&q->owner_lock, flags);
422 q->locked = locked ? 1 : 0;
424 spin_unlock_irqrestore(&q->owner_lock, flags);
425 queue_access_unlock(q);
432 /*----------------------------------------------------------------*/
435 * q->use mutex should be down before calling this function to avoid
436 * confliction with snd_seq_queue_use()
438 int snd_seq_queue_timer_open(int queueid)
441 struct snd_seq_queue *queue;
442 struct snd_seq_timer *tmr;
444 queue = queueptr(queueid);
448 if ((result = snd_seq_timer_open(queue)) < 0) {
449 snd_seq_timer_defaults(tmr);
450 result = snd_seq_timer_open(queue);
457 * q->use mutex should be down before calling this function
459 int snd_seq_queue_timer_close(int queueid)
461 struct snd_seq_queue *queue;
464 queue = queueptr(queueid);
467 snd_seq_timer_close(queue);
472 /* change queue tempo and ppq */
473 int snd_seq_queue_timer_set_tempo(int queueid, int client,
474 struct snd_seq_queue_tempo *info)
476 struct snd_seq_queue *q = queueptr(queueid);
481 if (! queue_access_lock(q, client)) {
486 result = snd_seq_timer_set_tempo_ppq(q->timer, info->tempo, info->ppq);
487 if (result >= 0 && info->skew_base > 0)
488 result = snd_seq_timer_set_skew(q->timer, info->skew_value,
490 queue_access_unlock(q);
495 /* use or unuse this queue */
496 static void queue_use(struct snd_seq_queue *queue, int client, int use)
499 if (!test_and_set_bit(client, queue->clients_bitmap))
502 if (test_and_clear_bit(client, queue->clients_bitmap))
505 if (queue->clients) {
506 if (use && queue->clients == 1)
507 snd_seq_timer_defaults(queue->timer);
508 snd_seq_timer_open(queue);
510 snd_seq_timer_close(queue);
514 /* use or unuse this queue -
515 * if it is the first client, starts the timer.
516 * if it is not longer used by any clients, stop the timer.
518 int snd_seq_queue_use(int queueid, int client, int use)
520 struct snd_seq_queue *queue;
522 queue = queueptr(queueid);
525 mutex_lock(&queue->timer_mutex);
526 queue_use(queue, client, use);
527 mutex_unlock(&queue->timer_mutex);
533 * check if queue is used by the client
534 * return negative value if the queue is invalid.
535 * return 0 if not used, 1 if used.
537 int snd_seq_queue_is_used(int queueid, int client)
539 struct snd_seq_queue *q;
542 q = queueptr(queueid);
544 return -EINVAL; /* invalid queue */
545 result = test_bit(client, q->clients_bitmap) ? 1 : 0;
551 /*----------------------------------------------------------------*/
553 /* notification that client has left the system -
554 * stop the timer on all queues owned by this client
556 void snd_seq_queue_client_termination(int client)
560 struct snd_seq_queue *q;
563 for (i = 0; i < SNDRV_SEQ_MAX_QUEUES; i++) {
564 if ((q = queueptr(i)) == NULL)
566 spin_lock_irqsave(&q->owner_lock, flags);
567 matched = (q->owner == client);
570 spin_unlock_irqrestore(&q->owner_lock, flags);
572 if (q->timer->running)
573 snd_seq_timer_stop(q->timer);
574 snd_seq_timer_reset(q->timer);
580 /* final stage notification -
581 * remove cells for no longer exist client (for non-owned queue)
582 * or delete this queue (for owned queue)
584 void snd_seq_queue_client_leave(int client)
587 struct snd_seq_queue *q;
589 /* delete own queues from queue list */
590 for (i = 0; i < SNDRV_SEQ_MAX_QUEUES; i++) {
591 if ((q = queue_list_remove(i, client)) != NULL)
595 /* remove cells from existing queues -
596 * they are not owned by this client
598 for (i = 0; i < SNDRV_SEQ_MAX_QUEUES; i++) {
599 if ((q = queueptr(i)) == NULL)
601 if (test_bit(client, q->clients_bitmap)) {
602 snd_seq_prioq_leave(q->tickq, client, 0);
603 snd_seq_prioq_leave(q->timeq, client, 0);
604 snd_seq_queue_use(q->queue, client, 0);
612 /*----------------------------------------------------------------*/
614 /* remove cells from all queues */
615 void snd_seq_queue_client_leave_cells(int client)
618 struct snd_seq_queue *q;
620 for (i = 0; i < SNDRV_SEQ_MAX_QUEUES; i++) {
621 if ((q = queueptr(i)) == NULL)
623 snd_seq_prioq_leave(q->tickq, client, 0);
624 snd_seq_prioq_leave(q->timeq, client, 0);
629 /* remove cells based on flush criteria */
630 void snd_seq_queue_remove_cells(int client, struct snd_seq_remove_events *info)
633 struct snd_seq_queue *q;
635 for (i = 0; i < SNDRV_SEQ_MAX_QUEUES; i++) {
636 if ((q = queueptr(i)) == NULL)
638 if (test_bit(client, q->clients_bitmap) &&
639 (! (info->remove_mode & SNDRV_SEQ_REMOVE_DEST) ||
640 q->queue == info->queue)) {
641 snd_seq_prioq_remove_events(q->tickq, client, info);
642 snd_seq_prioq_remove_events(q->timeq, client, info);
648 /*----------------------------------------------------------------*/
651 * send events to all subscribed ports
653 static void queue_broadcast_event(struct snd_seq_queue *q, struct snd_seq_event *ev,
656 struct snd_seq_event sev;
660 sev.flags = SNDRV_SEQ_TIME_STAMP_TICK|SNDRV_SEQ_TIME_MODE_ABS;
661 sev.time.tick = q->timer->tick.cur_tick;
662 sev.queue = q->queue;
663 sev.data.queue.queue = q->queue;
665 /* broadcast events from Timer port */
666 sev.source.client = SNDRV_SEQ_CLIENT_SYSTEM;
667 sev.source.port = SNDRV_SEQ_PORT_SYSTEM_TIMER;
668 sev.dest.client = SNDRV_SEQ_ADDRESS_SUBSCRIBERS;
669 snd_seq_kernel_client_dispatch(SNDRV_SEQ_CLIENT_SYSTEM, &sev, atomic, hop);
673 * process a received queue-control event.
674 * this function is exported for seq_sync.c.
676 static void snd_seq_queue_process_event(struct snd_seq_queue *q,
677 struct snd_seq_event *ev,
681 case SNDRV_SEQ_EVENT_START:
682 snd_seq_prioq_leave(q->tickq, ev->source.client, 1);
683 snd_seq_prioq_leave(q->timeq, ev->source.client, 1);
684 if (! snd_seq_timer_start(q->timer))
685 queue_broadcast_event(q, ev, atomic, hop);
688 case SNDRV_SEQ_EVENT_CONTINUE:
689 if (! snd_seq_timer_continue(q->timer))
690 queue_broadcast_event(q, ev, atomic, hop);
693 case SNDRV_SEQ_EVENT_STOP:
694 snd_seq_timer_stop(q->timer);
695 queue_broadcast_event(q, ev, atomic, hop);
698 case SNDRV_SEQ_EVENT_TEMPO:
699 snd_seq_timer_set_tempo(q->timer, ev->data.queue.param.value);
700 queue_broadcast_event(q, ev, atomic, hop);
703 case SNDRV_SEQ_EVENT_SETPOS_TICK:
704 if (snd_seq_timer_set_position_tick(q->timer, ev->data.queue.param.time.tick) == 0) {
705 queue_broadcast_event(q, ev, atomic, hop);
709 case SNDRV_SEQ_EVENT_SETPOS_TIME:
710 if (snd_seq_timer_set_position_time(q->timer, ev->data.queue.param.time.time) == 0) {
711 queue_broadcast_event(q, ev, atomic, hop);
714 case SNDRV_SEQ_EVENT_QUEUE_SKEW:
715 if (snd_seq_timer_set_skew(q->timer,
716 ev->data.queue.param.skew.value,
717 ev->data.queue.param.skew.base) == 0) {
718 queue_broadcast_event(q, ev, atomic, hop);
726 * Queue control via timer control port:
727 * this function is exported as a callback of timer port.
729 int snd_seq_control_queue(struct snd_seq_event *ev, int atomic, int hop)
731 struct snd_seq_queue *q;
735 q = queueptr(ev->data.queue.queue);
740 if (! queue_access_lock(q, ev->source.client)) {
745 snd_seq_queue_process_event(q, ev, atomic, hop);
747 queue_access_unlock(q);
753 /*----------------------------------------------------------------*/
755 #ifdef CONFIG_SND_PROC_FS
756 /* exported to seq_info.c */
757 void snd_seq_info_queues_read(struct snd_info_entry *entry,
758 struct snd_info_buffer *buffer)
761 struct snd_seq_queue *q;
762 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 spin_lock_irq(&q->owner_lock);
779 spin_unlock_irq(&q->owner_lock);
781 snd_iprintf(buffer, "queue %d: [%s]\n", q->queue, q->name);
782 snd_iprintf(buffer, "owned by client : %d\n", owner);
783 snd_iprintf(buffer, "lock status : %s\n", locked ? "Locked" : "Free");
784 snd_iprintf(buffer, "queued time events : %d\n", snd_seq_prioq_avail(q->timeq));
785 snd_iprintf(buffer, "queued tick events : %d\n", snd_seq_prioq_avail(q->tickq));
786 snd_iprintf(buffer, "timer state : %s\n", tmr->running ? "Running" : "Stopped");
787 snd_iprintf(buffer, "timer PPQ : %d\n", tmr->ppq);
788 snd_iprintf(buffer, "current tempo : %d\n", tmr->tempo);
789 snd_iprintf(buffer, "current BPM : %d\n", bpm);
790 snd_iprintf(buffer, "current time : %d.%09d s\n", tmr->cur_time.tv_sec, tmr->cur_time.tv_nsec);
791 snd_iprintf(buffer, "current tick : %d\n", tmr->tick.cur_tick);
792 snd_iprintf(buffer, "\n");
796 #endif /* CONFIG_SND_PROC_FS */