xref: /openbmc/linux/include/sound/seq_kernel.h (revision 12eb4683)
1 #ifndef __SOUND_SEQ_KERNEL_H
2 #define __SOUND_SEQ_KERNEL_H
3 
4 /*
5  *  Main kernel header file for the ALSA sequencer
6  *  Copyright (c) 1998 by Frank van de Pol <fvdpol@coil.demon.nl>
7  *
8  *
9  *   This program is free software; you can redistribute it and/or modify
10  *   it under the terms of the GNU General Public License as published by
11  *   the Free Software Foundation; either version 2 of the License, or
12  *   (at your option) any later version.
13  *
14  *   This program is distributed in the hope that it will be useful,
15  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
16  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  *   GNU General Public License for more details.
18  *
19  *   You should have received a copy of the GNU General Public License
20  *   along with this program; if not, write to the Free Software
21  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
22  *
23  */
24 #include <linux/time.h>
25 #include <sound/asequencer.h>
26 
27 typedef struct snd_seq_real_time snd_seq_real_time_t;
28 typedef union snd_seq_timestamp snd_seq_timestamp_t;
29 
30 /* maximum number of events dequeued per schedule interval */
31 #define SNDRV_SEQ_MAX_DEQUEUE		50
32 
33 /* maximum number of queues */
34 #define SNDRV_SEQ_MAX_QUEUES		8
35 
36 /* max number of concurrent clients */
37 #define SNDRV_SEQ_MAX_CLIENTS 		192
38 
39 /* max number of concurrent ports */
40 #define SNDRV_SEQ_MAX_PORTS 		254
41 
42 /* max number of events in memory pool */
43 #define SNDRV_SEQ_MAX_EVENTS		2000
44 
45 /* default number of events in memory chunk */
46 #define SNDRV_SEQ_DEFAULT_CHUNK_EVENTS	64
47 
48 /* default number of events in memory pool */
49 #define SNDRV_SEQ_DEFAULT_EVENTS	500
50 
51 /* max number of events in memory pool for one client (outqueue) */
52 #define SNDRV_SEQ_MAX_CLIENT_EVENTS	2000
53 
54 /* default number of events in memory pool for one client (outqueue) */
55 #define SNDRV_SEQ_DEFAULT_CLIENT_EVENTS	200
56 
57 /* max delivery path length */
58 #define SNDRV_SEQ_MAX_HOPS		10
59 
60 /* max size of event size */
61 #define SNDRV_SEQ_MAX_EVENT_LEN		0x3fffffff
62 
63 /* call-backs for kernel port */
64 struct snd_seq_port_callback {
65 	struct module *owner;
66 	void *private_data;
67 	int (*subscribe)(void *private_data, struct snd_seq_port_subscribe *info);
68 	int (*unsubscribe)(void *private_data, struct snd_seq_port_subscribe *info);
69 	int (*use)(void *private_data, struct snd_seq_port_subscribe *info);
70 	int (*unuse)(void *private_data, struct snd_seq_port_subscribe *info);
71 	int (*event_input)(struct snd_seq_event *ev, int direct, void *private_data, int atomic, int hop);
72 	void (*private_free)(void *private_data);
73 	unsigned int callback_all;	/* call subscribe callbacks at each connection/disconnection */
74 	/*...*/
75 };
76 
77 /* interface for kernel client */
78 __printf(3, 4)
79 int snd_seq_create_kernel_client(struct snd_card *card, int client_index,
80 				 const char *name_fmt, ...);
81 int snd_seq_delete_kernel_client(int client);
82 int snd_seq_kernel_client_enqueue(int client, struct snd_seq_event *ev, int atomic, int hop);
83 int snd_seq_kernel_client_dispatch(int client, struct snd_seq_event *ev, int atomic, int hop);
84 int snd_seq_kernel_client_ctl(int client, unsigned int cmd, void *arg);
85 
86 #define SNDRV_SEQ_EXT_MASK	0xc0000000
87 #define SNDRV_SEQ_EXT_USRPTR	0x80000000
88 #define SNDRV_SEQ_EXT_CHAINED	0x40000000
89 
90 typedef int (*snd_seq_dump_func_t)(void *ptr, void *buf, int count);
91 int snd_seq_expand_var_event(const struct snd_seq_event *event, int count, char *buf,
92 			     int in_kernel, int size_aligned);
93 int snd_seq_dump_var_event(const struct snd_seq_event *event,
94 			   snd_seq_dump_func_t func, void *private_data);
95 
96 /* interface for OSS emulation */
97 int snd_seq_set_queue_tempo(int client, struct snd_seq_queue_tempo *tempo);
98 
99 /* port callback routines */
100 void snd_port_init_callback(struct snd_seq_port_callback *p);
101 struct snd_seq_port_callback *snd_port_alloc_callback(void);
102 
103 /* port attach/detach */
104 int snd_seq_event_port_attach(int client, struct snd_seq_port_callback *pcbp,
105 			      int cap, int type, int midi_channels, int midi_voices, char *portname);
106 int snd_seq_event_port_detach(int client, int port);
107 
108 #ifdef CONFIG_MODULES
109 void snd_seq_autoload_lock(void);
110 void snd_seq_autoload_unlock(void);
111 #else
112 #define snd_seq_autoload_lock()
113 #define snd_seq_autoload_unlock()
114 #endif
115 
116 #endif /* __SOUND_SEQ_KERNEL_H */
117