[linux.git] / include / sound / timer.h

#ifndef __SOUND_TIMER_H
#define __SOUND_TIMER_H

/*
 *  Timer abstract layer
 *  Copyright (c) by Jaroslav Kysela <[email protected]>,
 *		     Abramo Bagnara <[email protected]>
 *
 *
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 2 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 *
 */

#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;
};

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);
int 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
1da177e4 LT	1	#ifndef __SOUND_TIMER_H
	2	#define __SOUND_TIMER_H
	3
	4	/*
	5	* Timer abstract layer
c1017a4c	6	* Copyright (c) by Jaroslav Kysela <[email protected]>,
1da177e4 LT	7	* Abramo Bagnara <[email protected]>
	8	*
	9	*
	10	* This program is free software; you can redistribute it and/or modify
	11	* it under the terms of the GNU General Public License as published by
	12	* the Free Software Foundation; either version 2 of the License, or
	13	* (at your option) any later version.
	14	*
	15	* This program is distributed in the hope that it will be useful,
	16	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	17	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	18	* GNU General Public License for more details.
	19	*
	20	* You should have received a copy of the GNU General Public License
	21	* along with this program; if not, write to the Free Software
	22	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	23	*
	24	*/
	25
	26	#include <sound/asound.h>
	27	#include <linux/interrupt.h>
	28
1da177e4 LT	29	#define snd_timer_chip(timer) ((timer)->private_data)
	30
	31	#define SNDRV_TIMER_DEVICES 16
	32
	33	#define SNDRV_TIMER_DEV_FLG_PCM 0x10000000
	34
	35	#define SNDRV_TIMER_HW_AUTO 0x00000001 /* auto trigger is supported */
	36	#define SNDRV_TIMER_HW_STOP 0x00000002 /* call stop before start */
	37	#define SNDRV_TIMER_HW_SLAVE 0x00000004 /* only slave timer (variable resolution) */
	38	#define SNDRV_TIMER_HW_FIRST 0x00000008 /* first tick can be incomplete */
	39	#define SNDRV_TIMER_HW_TASKLET 0x00000010 /* timer is called from tasklet */
	40
	41	#define SNDRV_TIMER_IFLG_SLAVE 0x00000001
	42	#define SNDRV_TIMER_IFLG_RUNNING 0x00000002
	43	#define SNDRV_TIMER_IFLG_START 0x00000004
	44	#define SNDRV_TIMER_IFLG_AUTO 0x00000008 /* auto restart */
	45	#define SNDRV_TIMER_IFLG_FAST 0x00000010 /* fast callback (do not use tasklet) */
	46	#define SNDRV_TIMER_IFLG_CALLBACK 0x00000020 /* timer callback is active */
	47	#define SNDRV_TIMER_IFLG_EXCLUSIVE 0x00000040 /* exclusive owner - no more instances */
	48	#define SNDRV_TIMER_IFLG_EARLY_EVENT 0x00000080 /* write early event to the poll queue */
	49
	50	#define SNDRV_TIMER_FLG_CHANGE 0x00000001
	51	#define SNDRV_TIMER_FLG_RESCHED 0x00000002 /* need reschedule */
	52
53d2f744	53	struct snd_timer;
1da177e4	54
53d2f744	55	struct snd_timer_hardware {
1da177e4 LT	56	/* -- must be filled with low-level driver */
	57	unsigned int flags; /* various flags */
	58	unsigned long resolution; /* average timer resolution for one tick in nsec */
	59	unsigned long resolution_min; /* minimal resolution */
	60	unsigned long resolution_max; /* maximal resolution */
	61	unsigned long ticks; /* max timer ticks per interrupt */
	62	/* -- low-level functions -- */
53d2f744 TI	63	int (open) (struct snd_timer timer);
	64	int (close) (struct snd_timer timer);
	65	unsigned long (c_resolution) (struct snd_timer timer);
	66	int (start) (struct snd_timer timer);
	67	int (stop) (struct snd_timer timer);
	68	int (set_period) (struct snd_timer timer, unsigned long period_num, unsigned long period_den);
	69	int (precise_resolution) (struct snd_timer timer, unsigned long num, unsigned long den);
1da177e4 LT	70	};
1da177e4 LT	71
53d2f744 TI	72	struct snd_timer {
	73	int tmr_class;
	74	struct snd_card *card;
de24214d	75	struct module *module;
1da177e4 LT	76	int tmr_device;
	77	int tmr_subdevice;
	78	char id[64];
	79	char name[80];
	80	unsigned int flags;
	81	int running; /* running instances */
	82	unsigned long sticks; /* schedule ticks */
	83	void *private_data;
53d2f744 TI	84	void (private_free) (struct snd_timer timer);
53d2f744 TI	85	struct snd_timer_hardware hw;
1da177e4 LT	86	spinlock_t lock;
	87	struct list_head device_list;
	88	struct list_head open_list_head;
	89	struct list_head active_list_head;
	90	struct list_head ack_list_head;
	91	struct list_head sack_list_head; /* slow ack list head */
	92	struct tasklet_struct task_queue;
	93	};
	94
53d2f744 TI	95	struct snd_timer_instance {
53d2f744 TI	96	struct snd_timer *timer;
1da177e4 LT	97	char *owner;
	98	unsigned int flags;
	99	void *private_data;
53d2f744 TI	100	void (private_free) (struct snd_timer_instance ti);
	101	void (callback) (struct snd_timer_instance timeri,
	102	unsigned long ticks, unsigned long resolution);
	103	void (ccallback) (struct snd_timer_instance timeri,
	104	int event,
	105	struct timespec * tstamp,
	106	unsigned long resolution);
40ed9444	107	void (disconnect)(struct snd_timer_instance timeri);
1da177e4 LT	108	void *callback_data;
	109	unsigned long ticks; /* auto-load ticks when expired */
	110	unsigned long cticks; /* current ticks */
	111	unsigned long pticks; /* accumulated ticks for callback */
	112	unsigned long resolution; /* current resolution for tasklet */
	113	unsigned long lost; /* lost ticks */
53d2f744	114	int slave_class;
1da177e4 LT	115	unsigned int slave_id;
	116	struct list_head open_list;
	117	struct list_head active_list;
	118	struct list_head ack_list;
	119	struct list_head slave_list_head;
	120	struct list_head slave_active_head;
53d2f744	121	struct snd_timer_instance *master;
1da177e4 LT	122	};
	123
	124	/*
	125	* Registering
	126	*/
	127
53d2f744 TI	128	int snd_timer_new(struct snd_card card, char id, struct snd_timer_id tid, struct snd_timer *rtimer);
	129	void snd_timer_notify(struct snd_timer timer, int event, struct timespec tstamp);
	130	int snd_timer_global_new(char id, int device, struct snd_timer *rtimer);
	131	int snd_timer_global_free(struct snd_timer *timer);
	132	int snd_timer_global_register(struct snd_timer *timer);
53d2f744 TI	133
	134	int snd_timer_open(struct snd_timer_instance *ti, char owner, struct snd_timer_id *tid, unsigned int slave_id);
	135	int snd_timer_close(struct snd_timer_instance *timeri);
	136	unsigned long snd_timer_resolution(struct snd_timer_instance *timeri);
	137	int snd_timer_start(struct snd_timer_instance *timeri, unsigned int ticks);
	138	int snd_timer_stop(struct snd_timer_instance *timeri);
	139	int snd_timer_continue(struct snd_timer_instance *timeri);
	140	int snd_timer_pause(struct snd_timer_instance *timeri);
	141
	142	void snd_timer_interrupt(struct snd_timer *timer, unsigned long ticks_left);
1da177e4	143
1da177e4	144	#endif /* __SOUND_TIMER_H */