[linux-2.6-block.git] / include / sound / timer.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
#ifndef __SOUND_TIMER_H
#define __SOUND_TIMER_H

/*
 *  Timer abstract layer
 *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>,
 *		     Abramo Bagnara <abramo@alsa-project.org>
 */

#include <sound/asound.h>
#include <linux/interrupt.h>

#define snd_timer_chip(timer) ((timer)->private_data)

#define SNDRV_TIMER_DEVICES	16

#define SNDRV_TIMER_DEV_FLG_PCM	0x10000000

#define SNDRV_TIMER_HW_AUTO	0x00000001	/* auto trigger is supported */
#define SNDRV_TIMER_HW_STOP	0x00000002	/* call stop before start */
#define SNDRV_TIMER_HW_SLAVE	0x00000004	/* only slave timer (variable resolution) */
#define SNDRV_TIMER_HW_FIRST	0x00000008	/* first tick can be incomplete */
#define SNDRV_TIMER_HW_TASKLET	0x00000010	/* timer is called from tasklet */

#define SNDRV_TIMER_IFLG_SLAVE	  0x00000001
#define SNDRV_TIMER_IFLG_RUNNING  0x00000002
#define SNDRV_TIMER_IFLG_START	  0x00000004
#define SNDRV_TIMER_IFLG_AUTO	  0x00000008	/* auto restart */
#define SNDRV_TIMER_IFLG_FAST	  0x00000010	/* fast callback (do not use tasklet) */
#define SNDRV_TIMER_IFLG_CALLBACK 0x00000020	/* timer callback is active */
#define SNDRV_TIMER_IFLG_EXCLUSIVE 0x00000040	/* exclusive owner - no more instances */
#define SNDRV_TIMER_IFLG_EARLY_EVENT 0x00000080	/* write early event to the poll queue */

#define SNDRV_TIMER_FLG_CHANGE	0x00000001
#define SNDRV_TIMER_FLG_RESCHED	0x00000002	/* need reschedule */

struct snd_timer;

struct snd_timer_hardware {
	/* -- must be filled with low-level driver */
	unsigned int flags;		/* various flags */
	unsigned long resolution;	/* average timer resolution for one tick in nsec */
	unsigned long resolution_min;	/* minimal resolution */
	unsigned long resolution_max;	/* maximal resolution */
	unsigned long ticks;		/* max timer ticks per interrupt */
	/* -- low-level functions -- */
	int (*open) (struct snd_timer * timer);
	int (*close) (struct snd_timer * timer);
	unsigned long (*c_resolution) (struct snd_timer * timer);
	int (*start) (struct snd_timer * timer);
	int (*stop) (struct snd_timer * timer);
	int (*set_period) (struct snd_timer * timer, unsigned long period_num, unsigned long period_den);
	int (*precise_resolution) (struct snd_timer * timer, unsigned long *num, unsigned long *den);
};

struct snd_timer {
	int tmr_class;
	struct snd_card *card;
	struct module *module;
	int tmr_device;
	int tmr_subdevice;
	char id[64];
	char name[80];
	unsigned int flags;
	int running;			/* running instances */
	unsigned long sticks;		/* schedule ticks */
	void *private_data;
	void (*private_free) (struct snd_timer *timer);
	struct snd_timer_hardware hw;
	spinlock_t lock;
	struct list_head device_list;
	struct list_head open_list_head;
	struct list_head active_list_head;
	struct list_head ack_list_head;
	struct list_head sack_list_head; /* slow ack list head */
	struct tasklet_struct task_queue;
	int max_instances;	/* upper limit of timer instances */
	int num_instances;	/* current number of timer instances */
};

struct snd_timer_instance {
	struct snd_timer *timer;
	char *owner;
	unsigned int flags;
	void *private_data;
	void (*private_free) (struct snd_timer_instance *ti);
	void (*callback) (struct snd_timer_instance *timeri,
			  unsigned long ticks, unsigned long resolution);
	void (*ccallback) (struct snd_timer_instance * timeri,
			   int event,
			   struct timespec * tstamp,
			   unsigned long resolution);
	void (*disconnect)(struct snd_timer_instance *timeri);
	void *callback_data;
	unsigned long ticks;		/* auto-load ticks when expired */
	unsigned long cticks;		/* current ticks */
	unsigned long pticks;		/* accumulated ticks for callback */
	unsigned long resolution;	/* current resolution for tasklet */
	unsigned long lost;		/* lost ticks */
	int slave_class;
	unsigned int slave_id;
	struct list_head open_list;
	struct list_head active_list;
	struct list_head ack_list;
	struct list_head slave_list_head;
	struct list_head slave_active_head;
	struct snd_timer_instance *master;
};

/*
 *  Registering
 */

int snd_timer_new(struct snd_card *card, char *id, struct snd_timer_id *tid, struct snd_timer **rtimer);
void snd_timer_notify(struct snd_timer *timer, int event, struct timespec *tstamp);
int snd_timer_global_new(char *id, int device, struct snd_timer **rtimer);
int snd_timer_global_free(struct snd_timer *timer);
int snd_timer_global_register(struct snd_timer *timer);

int snd_timer_open(struct snd_timer_instance **ti, char *owner, struct snd_timer_id *tid, unsigned int slave_id);
void snd_timer_close(struct snd_timer_instance *timeri);
unsigned long snd_timer_resolution(struct snd_timer_instance *timeri);
int snd_timer_start(struct snd_timer_instance *timeri, unsigned int ticks);
int snd_timer_stop(struct snd_timer_instance *timeri);
int snd_timer_continue(struct snd_timer_instance *timeri);
int snd_timer_pause(struct snd_timer_instance *timeri);

void snd_timer_interrupt(struct snd_timer *timer, unsigned long ticks_left);

#endif /* __SOUND_TIMER_H */
Commit	Line	Data
1a59d1b8	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
1da177e4 LT	2	#ifndef __SOUND_TIMER_H
	3	#define __SOUND_TIMER_H
	4
	5	/*
	6	* Timer abstract layer
c1017a4c	7	* Copyright (c) by Jaroslav Kysela <perex@perex.cz>,
1da177e4	8	* Abramo Bagnara <abramo@alsa-project.org>
1da177e4 LT	9	*/
	10
	11	#include <sound/asound.h>
	12	#include <linux/interrupt.h>
	13
1da177e4 LT	14	#define snd_timer_chip(timer) ((timer)->private_data)
	15
	16	#define SNDRV_TIMER_DEVICES 16
	17
	18	#define SNDRV_TIMER_DEV_FLG_PCM 0x10000000
	19
	20	#define SNDRV_TIMER_HW_AUTO 0x00000001 /* auto trigger is supported */
	21	#define SNDRV_TIMER_HW_STOP 0x00000002 /* call stop before start */
	22	#define SNDRV_TIMER_HW_SLAVE 0x00000004 /* only slave timer (variable resolution) */
	23	#define SNDRV_TIMER_HW_FIRST 0x00000008 /* first tick can be incomplete */
	24	#define SNDRV_TIMER_HW_TASKLET 0x00000010 /* timer is called from tasklet */
	25
	26	#define SNDRV_TIMER_IFLG_SLAVE 0x00000001
	27	#define SNDRV_TIMER_IFLG_RUNNING 0x00000002
	28	#define SNDRV_TIMER_IFLG_START 0x00000004
	29	#define SNDRV_TIMER_IFLG_AUTO 0x00000008 /* auto restart */
	30	#define SNDRV_TIMER_IFLG_FAST 0x00000010 /* fast callback (do not use tasklet) */
	31	#define SNDRV_TIMER_IFLG_CALLBACK 0x00000020 /* timer callback is active */
	32	#define SNDRV_TIMER_IFLG_EXCLUSIVE 0x00000040 /* exclusive owner - no more instances */
	33	#define SNDRV_TIMER_IFLG_EARLY_EVENT 0x00000080 /* write early event to the poll queue */
	34
	35	#define SNDRV_TIMER_FLG_CHANGE 0x00000001
	36	#define SNDRV_TIMER_FLG_RESCHED 0x00000002 /* need reschedule */
	37
53d2f744	38	struct snd_timer;
1da177e4	39
53d2f744	40	struct snd_timer_hardware {
1da177e4 LT	41	/* -- must be filled with low-level driver */
	42	unsigned int flags; /* various flags */
	43	unsigned long resolution; /* average timer resolution for one tick in nsec */
	44	unsigned long resolution_min; /* minimal resolution */
	45	unsigned long resolution_max; /* maximal resolution */
	46	unsigned long ticks; /* max timer ticks per interrupt */
	47	/* -- low-level functions -- */
53d2f744 TI	48	int (open) (struct snd_timer timer);
	49	int (close) (struct snd_timer timer);
	50	unsigned long (c_resolution) (struct snd_timer timer);
	51	int (start) (struct snd_timer timer);
	52	int (stop) (struct snd_timer timer);
	53	int (set_period) (struct snd_timer timer, unsigned long period_num, unsigned long period_den);
	54	int (precise_resolution) (struct snd_timer timer, unsigned long num, unsigned long den);
1da177e4 LT	55	};
1da177e4 LT	56
53d2f744 TI	57	struct snd_timer {
	58	int tmr_class;
	59	struct snd_card *card;
de24214d	60	struct module *module;
1da177e4 LT	61	int tmr_device;
	62	int tmr_subdevice;
	63	char id[64];
	64	char name[80];
	65	unsigned int flags;
	66	int running; /* running instances */
	67	unsigned long sticks; /* schedule ticks */
	68	void *private_data;
53d2f744 TI	69	void (private_free) (struct snd_timer timer);
53d2f744 TI	70	struct snd_timer_hardware hw;
1da177e4 LT	71	spinlock_t lock;
	72	struct list_head device_list;
	73	struct list_head open_list_head;
	74	struct list_head active_list_head;
	75	struct list_head ack_list_head;
	76	struct list_head sack_list_head; /* slow ack list head */
	77	struct tasklet_struct task_queue;
9b7d869e TI	78	int max_instances; /* upper limit of timer instances */
9b7d869e TI	79	int num_instances; /* current number of timer instances */
1da177e4 LT	80	};
1da177e4 LT	81
53d2f744 TI	82	struct snd_timer_instance {
53d2f744 TI	83	struct snd_timer *timer;
1da177e4 LT	84	char *owner;
	85	unsigned int flags;
	86	void *private_data;
53d2f744 TI	87	void (private_free) (struct snd_timer_instance ti);
	88	void (callback) (struct snd_timer_instance timeri,
	89	unsigned long ticks, unsigned long resolution);
	90	void (ccallback) (struct snd_timer_instance timeri,
	91	int event,
	92	struct timespec * tstamp,
	93	unsigned long resolution);
40ed9444	94	void (disconnect)(struct snd_timer_instance timeri);
1da177e4 LT	95	void *callback_data;
	96	unsigned long ticks; /* auto-load ticks when expired */
	97	unsigned long cticks; /* current ticks */
	98	unsigned long pticks; /* accumulated ticks for callback */
	99	unsigned long resolution; /* current resolution for tasklet */
	100	unsigned long lost; /* lost ticks */
53d2f744	101	int slave_class;
1da177e4 LT	102	unsigned int slave_id;
	103	struct list_head open_list;
	104	struct list_head active_list;
	105	struct list_head ack_list;
	106	struct list_head slave_list_head;
	107	struct list_head slave_active_head;
53d2f744	108	struct snd_timer_instance *master;
1da177e4 LT	109	};
	110
	111	/*
	112	* Registering
	113	*/
	114
53d2f744 TI	115	int snd_timer_new(struct snd_card card, char id, struct snd_timer_id tid, struct snd_timer *rtimer);
	116	void snd_timer_notify(struct snd_timer timer, int event, struct timespec tstamp);
	117	int snd_timer_global_new(char id, int device, struct snd_timer *rtimer);
	118	int snd_timer_global_free(struct snd_timer *timer);
	119	int snd_timer_global_register(struct snd_timer *timer);
53d2f744 TI	120
53d2f744 TI	121	int snd_timer_open(struct snd_timer_instance *ti, char owner, struct snd_timer_id *tid, unsigned int slave_id);
33bbb8a0	122	void snd_timer_close(struct snd_timer_instance *timeri);
53d2f744 TI	123	unsigned long snd_timer_resolution(struct snd_timer_instance *timeri);
	124	int snd_timer_start(struct snd_timer_instance *timeri, unsigned int ticks);
	125	int snd_timer_stop(struct snd_timer_instance *timeri);
	126	int snd_timer_continue(struct snd_timer_instance *timeri);
	127	int snd_timer_pause(struct snd_timer_instance *timeri);
	128
	129	void snd_timer_interrupt(struct snd_timer *timer, unsigned long ticks_left);
1da177e4	130
1da177e4	131	#endif /* __SOUND_TIMER_H */