1 // SPDX-License-Identifier: GPL-2.0-or-later
4 * Copyright (c) 1998-1999 by Frank van de Pol <fvdpol@coil.demon.nl>
5 * Jaroslav Kysela <perex@perex.cz>
8 #include <sound/core.h>
9 #include <linux/slab.h>
10 #include "seq_timer.h"
11 #include "seq_queue.h"
14 /* allowed sequencer timer frequencies, in Hz */
15 #define MIN_FREQUENCY 10
16 #define MAX_FREQUENCY 6250
17 #define DEFAULT_FREQUENCY 1000
19 #define SKEW_BASE 0x10000 /* 16bit shift */
21 static void snd_seq_timer_set_tick_resolution(struct snd_seq_timer
*tmr
)
23 if (tmr
->tempo
< 1000000)
24 tmr
->tick
.resolution
= (tmr
->tempo
* 1000) / tmr
->ppq
;
26 /* might overflow.. */
28 s
= tmr
->tempo
% tmr
->ppq
;
29 s
= (s
* 1000) / tmr
->ppq
;
30 tmr
->tick
.resolution
= (tmr
->tempo
/ tmr
->ppq
) * 1000;
31 tmr
->tick
.resolution
+= s
;
33 if (tmr
->tick
.resolution
<= 0)
34 tmr
->tick
.resolution
= 1;
35 snd_seq_timer_update_tick(&tmr
->tick
, 0);
38 /* create new timer (constructor) */
39 struct snd_seq_timer
*snd_seq_timer_new(void)
41 struct snd_seq_timer
*tmr
;
43 tmr
= kzalloc(sizeof(*tmr
), GFP_KERNEL
);
46 spin_lock_init(&tmr
->lock
);
48 /* reset setup to defaults */
49 snd_seq_timer_defaults(tmr
);
52 snd_seq_timer_reset(tmr
);
57 /* delete timer (destructor) */
58 void snd_seq_timer_delete(struct snd_seq_timer
**tmr
)
60 struct snd_seq_timer
*t
= *tmr
;
64 pr_debug("ALSA: seq: snd_seq_timer_delete() called with NULL timer\n");
70 snd_seq_timer_stop(t
);
71 snd_seq_timer_reset(t
);
76 void snd_seq_timer_defaults(struct snd_seq_timer
* tmr
)
80 spin_lock_irqsave(&tmr
->lock
, flags
);
82 tmr
->ppq
= 96; /* 96 PPQ */
83 tmr
->tempo
= 500000; /* 120 BPM */
84 snd_seq_timer_set_tick_resolution(tmr
);
87 tmr
->type
= SNDRV_SEQ_TIMER_ALSA
;
88 tmr
->alsa_id
.dev_class
= seq_default_timer_class
;
89 tmr
->alsa_id
.dev_sclass
= seq_default_timer_sclass
;
90 tmr
->alsa_id
.card
= seq_default_timer_card
;
91 tmr
->alsa_id
.device
= seq_default_timer_device
;
92 tmr
->alsa_id
.subdevice
= seq_default_timer_subdevice
;
93 tmr
->preferred_resolution
= seq_default_timer_resolution
;
95 tmr
->skew
= tmr
->skew_base
= SKEW_BASE
;
96 spin_unlock_irqrestore(&tmr
->lock
, flags
);
99 static void seq_timer_reset(struct snd_seq_timer
*tmr
)
101 /* reset time & songposition */
102 tmr
->cur_time
.tv_sec
= 0;
103 tmr
->cur_time
.tv_nsec
= 0;
105 tmr
->tick
.cur_tick
= 0;
106 tmr
->tick
.fraction
= 0;
109 void snd_seq_timer_reset(struct snd_seq_timer
*tmr
)
113 spin_lock_irqsave(&tmr
->lock
, flags
);
114 seq_timer_reset(tmr
);
115 spin_unlock_irqrestore(&tmr
->lock
, flags
);
119 /* called by timer interrupt routine. the period time since previous invocation is passed */
120 static void snd_seq_timer_interrupt(struct snd_timer_instance
*timeri
,
121 unsigned long resolution
,
125 struct snd_seq_queue
*q
= timeri
->callback_data
;
126 struct snd_seq_timer
*tmr
;
133 spin_lock_irqsave(&tmr
->lock
, flags
);
135 spin_unlock_irqrestore(&tmr
->lock
, flags
);
140 if (tmr
->skew
!= tmr
->skew_base
) {
141 /* FIXME: assuming skew_base = 0x10000 */
142 resolution
= (resolution
>> 16) * tmr
->skew
+
143 (((resolution
& 0xffff) * tmr
->skew
) >> 16);
147 snd_seq_inc_time_nsec(&tmr
->cur_time
, resolution
);
149 /* calculate current tick */
150 snd_seq_timer_update_tick(&tmr
->tick
, resolution
);
152 /* register actual time of this timer update */
153 ktime_get_ts64(&tmr
->last_update
);
155 spin_unlock_irqrestore(&tmr
->lock
, flags
);
157 /* check queues and dispatch events */
158 snd_seq_check_queue(q
, 1, 0);
161 /* set current tempo */
162 int snd_seq_timer_set_tempo(struct snd_seq_timer
* tmr
, int tempo
)
166 if (snd_BUG_ON(!tmr
))
170 spin_lock_irqsave(&tmr
->lock
, flags
);
171 if ((unsigned int)tempo
!= tmr
->tempo
) {
173 snd_seq_timer_set_tick_resolution(tmr
);
175 spin_unlock_irqrestore(&tmr
->lock
, flags
);
179 /* set current tempo and ppq in a shot */
180 int snd_seq_timer_set_tempo_ppq(struct snd_seq_timer
*tmr
, int tempo
, int ppq
)
185 if (snd_BUG_ON(!tmr
))
187 if (tempo
<= 0 || ppq
<= 0)
189 spin_lock_irqsave(&tmr
->lock
, flags
);
190 if (tmr
->running
&& (ppq
!= tmr
->ppq
)) {
191 /* refuse to change ppq on running timers */
192 /* because it will upset the song position (ticks) */
193 spin_unlock_irqrestore(&tmr
->lock
, flags
);
194 pr_debug("ALSA: seq: cannot change ppq of a running timer\n");
197 changed
= (tempo
!= tmr
->tempo
) || (ppq
!= tmr
->ppq
);
201 snd_seq_timer_set_tick_resolution(tmr
);
202 spin_unlock_irqrestore(&tmr
->lock
, flags
);
206 /* set current tick position */
207 int snd_seq_timer_set_position_tick(struct snd_seq_timer
*tmr
,
208 snd_seq_tick_time_t position
)
212 if (snd_BUG_ON(!tmr
))
215 spin_lock_irqsave(&tmr
->lock
, flags
);
216 tmr
->tick
.cur_tick
= position
;
217 tmr
->tick
.fraction
= 0;
218 spin_unlock_irqrestore(&tmr
->lock
, flags
);
222 /* set current real-time position */
223 int snd_seq_timer_set_position_time(struct snd_seq_timer
*tmr
,
224 snd_seq_real_time_t position
)
228 if (snd_BUG_ON(!tmr
))
231 snd_seq_sanity_real_time(&position
);
232 spin_lock_irqsave(&tmr
->lock
, flags
);
233 tmr
->cur_time
= position
;
234 spin_unlock_irqrestore(&tmr
->lock
, flags
);
239 int snd_seq_timer_set_skew(struct snd_seq_timer
*tmr
, unsigned int skew
,
244 if (snd_BUG_ON(!tmr
))
248 if (base
!= SKEW_BASE
) {
249 pr_debug("ALSA: seq: invalid skew base 0x%x\n", base
);
252 spin_lock_irqsave(&tmr
->lock
, flags
);
254 spin_unlock_irqrestore(&tmr
->lock
, flags
);
258 int snd_seq_timer_open(struct snd_seq_queue
*q
)
260 struct snd_timer_instance
*t
;
261 struct snd_seq_timer
*tmr
;
266 if (snd_BUG_ON(!tmr
))
270 sprintf(str
, "sequencer queue %i", q
->queue
);
271 if (tmr
->type
!= SNDRV_SEQ_TIMER_ALSA
) /* standard ALSA timer */
273 if (tmr
->alsa_id
.dev_class
!= SNDRV_TIMER_CLASS_SLAVE
)
274 tmr
->alsa_id
.dev_sclass
= SNDRV_TIMER_SCLASS_SEQUENCER
;
275 err
= snd_timer_open(&t
, str
, &tmr
->alsa_id
, q
->queue
);
276 if (err
< 0 && tmr
->alsa_id
.dev_class
!= SNDRV_TIMER_CLASS_SLAVE
) {
277 if (tmr
->alsa_id
.dev_class
!= SNDRV_TIMER_CLASS_GLOBAL
||
278 tmr
->alsa_id
.device
!= SNDRV_TIMER_GLOBAL_SYSTEM
) {
279 struct snd_timer_id tid
;
280 memset(&tid
, 0, sizeof(tid
));
281 tid
.dev_class
= SNDRV_TIMER_CLASS_GLOBAL
;
282 tid
.dev_sclass
= SNDRV_TIMER_SCLASS_SEQUENCER
;
284 tid
.device
= SNDRV_TIMER_GLOBAL_SYSTEM
;
285 err
= snd_timer_open(&t
, str
, &tid
, q
->queue
);
289 pr_err("ALSA: seq fatal error: cannot create timer (%i)\n", err
);
292 t
->callback
= snd_seq_timer_interrupt
;
293 t
->callback_data
= q
;
294 t
->flags
|= SNDRV_TIMER_IFLG_AUTO
;
295 spin_lock_irq(&tmr
->lock
);
297 spin_unlock_irq(&tmr
->lock
);
301 int snd_seq_timer_close(struct snd_seq_queue
*q
)
303 struct snd_seq_timer
*tmr
;
304 struct snd_timer_instance
*t
;
307 if (snd_BUG_ON(!tmr
))
309 spin_lock_irq(&tmr
->lock
);
312 spin_unlock_irq(&tmr
->lock
);
318 static int seq_timer_stop(struct snd_seq_timer
*tmr
)
325 snd_timer_pause(tmr
->timeri
);
329 int snd_seq_timer_stop(struct snd_seq_timer
*tmr
)
334 spin_lock_irqsave(&tmr
->lock
, flags
);
335 err
= seq_timer_stop(tmr
);
336 spin_unlock_irqrestore(&tmr
->lock
, flags
);
340 static int initialize_timer(struct snd_seq_timer
*tmr
)
345 t
= tmr
->timeri
->timer
;
349 freq
= tmr
->preferred_resolution
;
351 freq
= DEFAULT_FREQUENCY
;
352 else if (freq
< MIN_FREQUENCY
)
353 freq
= MIN_FREQUENCY
;
354 else if (freq
> MAX_FREQUENCY
)
355 freq
= MAX_FREQUENCY
;
358 if (!(t
->hw
.flags
& SNDRV_TIMER_HW_SLAVE
)) {
359 unsigned long r
= snd_timer_resolution(tmr
->timeri
);
361 tmr
->ticks
= (unsigned int)(1000000000uL / (r
* freq
));
366 tmr
->initialized
= 1;
370 static int seq_timer_start(struct snd_seq_timer
*tmr
)
376 seq_timer_reset(tmr
);
377 if (initialize_timer(tmr
) < 0)
379 snd_timer_start(tmr
->timeri
, tmr
->ticks
);
381 ktime_get_ts64(&tmr
->last_update
);
385 int snd_seq_timer_start(struct snd_seq_timer
*tmr
)
390 spin_lock_irqsave(&tmr
->lock
, flags
);
391 err
= seq_timer_start(tmr
);
392 spin_unlock_irqrestore(&tmr
->lock
, flags
);
396 static int seq_timer_continue(struct snd_seq_timer
*tmr
)
402 if (! tmr
->initialized
) {
403 seq_timer_reset(tmr
);
404 if (initialize_timer(tmr
) < 0)
407 snd_timer_start(tmr
->timeri
, tmr
->ticks
);
409 ktime_get_ts64(&tmr
->last_update
);
413 int snd_seq_timer_continue(struct snd_seq_timer
*tmr
)
418 spin_lock_irqsave(&tmr
->lock
, flags
);
419 err
= seq_timer_continue(tmr
);
420 spin_unlock_irqrestore(&tmr
->lock
, flags
);
424 /* return current 'real' time. use timeofday() to get better granularity. */
425 snd_seq_real_time_t
snd_seq_timer_get_cur_time(struct snd_seq_timer
*tmr
)
427 snd_seq_real_time_t cur_time
;
430 spin_lock_irqsave(&tmr
->lock
, flags
);
431 cur_time
= tmr
->cur_time
;
433 struct timespec64 tm
;
436 tm
= timespec64_sub(tm
, tmr
->last_update
);
437 cur_time
.tv_nsec
+= tm
.tv_nsec
;
438 cur_time
.tv_sec
+= tm
.tv_sec
;
439 snd_seq_sanity_real_time(&cur_time
);
441 spin_unlock_irqrestore(&tmr
->lock
, flags
);
445 /* TODO: use interpolation on tick queue (will only be useful for very
447 snd_seq_tick_time_t
snd_seq_timer_get_cur_tick(struct snd_seq_timer
*tmr
)
449 return tmr
->tick
.cur_tick
;
453 #ifdef CONFIG_SND_PROC_FS
454 /* exported to seq_info.c */
455 void snd_seq_info_timer_read(struct snd_info_entry
*entry
,
456 struct snd_info_buffer
*buffer
)
459 struct snd_seq_queue
*q
;
460 struct snd_seq_timer
*tmr
;
461 struct snd_timer_instance
*ti
;
462 unsigned long resolution
;
464 for (idx
= 0; idx
< SNDRV_SEQ_MAX_QUEUES
; idx
++) {
468 if ((tmr
= q
->timer
) == NULL
||
469 (ti
= tmr
->timeri
) == NULL
) {
473 snd_iprintf(buffer
, "Timer for queue %i : %s\n", q
->queue
, ti
->timer
->name
);
474 resolution
= snd_timer_resolution(ti
) * tmr
->ticks
;
475 snd_iprintf(buffer
, " Period time : %lu.%09lu\n", resolution
/ 1000000000, resolution
% 1000000000);
476 snd_iprintf(buffer
, " Skew : %u / %u\n", tmr
->skew
, tmr
->skew_base
);
480 #endif /* CONFIG_SND_PROC_FS */