xref: /openbmc/linux/include/uapi/sound/asequencer.h (revision 5437ac9b)
1 /* SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note */
2 /*
3  *  Main header file for the ALSA sequencer
4  *  Copyright (c) 1998-1999 by Frank van de Pol <fvdpol@coil.demon.nl>
5  *            (c) 1998-1999 by Jaroslav Kysela <perex@perex.cz>
6  */
7 #ifndef _UAPI__SOUND_ASEQUENCER_H
8 #define _UAPI__SOUND_ASEQUENCER_H
9 
10 #include <sound/asound.h>
11 
12 /** version of the sequencer */
13 #define SNDRV_SEQ_VERSION SNDRV_PROTOCOL_VERSION(1, 0, 3)
14 
15 /**
16  * definition of sequencer event types
17  */
18 
19 /** system messages
20  * event data type = #snd_seq_result
21  */
22 #define SNDRV_SEQ_EVENT_SYSTEM		0
23 #define SNDRV_SEQ_EVENT_RESULT		1
24 
25 /** note messages (channel specific)
26  * event data type = #snd_seq_ev_note
27  */
28 #define SNDRV_SEQ_EVENT_NOTE		5
29 #define SNDRV_SEQ_EVENT_NOTEON		6
30 #define SNDRV_SEQ_EVENT_NOTEOFF		7
31 #define SNDRV_SEQ_EVENT_KEYPRESS	8
32 
33 /** control messages (channel specific)
34  * event data type = #snd_seq_ev_ctrl
35  */
36 #define SNDRV_SEQ_EVENT_CONTROLLER	10
37 #define SNDRV_SEQ_EVENT_PGMCHANGE	11
38 #define SNDRV_SEQ_EVENT_CHANPRESS	12
39 #define SNDRV_SEQ_EVENT_PITCHBEND	13	/**< from -8192 to 8191 */
40 #define SNDRV_SEQ_EVENT_CONTROL14	14	/**< 14 bit controller value */
41 #define SNDRV_SEQ_EVENT_NONREGPARAM	15	/**< 14 bit NRPN address + 14 bit unsigned value */
42 #define SNDRV_SEQ_EVENT_REGPARAM	16	/**< 14 bit RPN address + 14 bit unsigned value */
43 
44 /** synchronisation messages
45  * event data type = #snd_seq_ev_ctrl
46  */
47 #define SNDRV_SEQ_EVENT_SONGPOS		20	/* Song Position Pointer with LSB and MSB values */
48 #define SNDRV_SEQ_EVENT_SONGSEL		21	/* Song Select with song ID number */
49 #define SNDRV_SEQ_EVENT_QFRAME		22	/* midi time code quarter frame */
50 #define SNDRV_SEQ_EVENT_TIMESIGN	23	/* SMF Time Signature event */
51 #define SNDRV_SEQ_EVENT_KEYSIGN		24	/* SMF Key Signature event */
52 
53 /** timer messages
54  * event data type = snd_seq_ev_queue_control
55  */
56 #define SNDRV_SEQ_EVENT_START		30	/* midi Real Time Start message */
57 #define SNDRV_SEQ_EVENT_CONTINUE	31	/* midi Real Time Continue message */
58 #define SNDRV_SEQ_EVENT_STOP		32	/* midi Real Time Stop message */
59 #define	SNDRV_SEQ_EVENT_SETPOS_TICK	33	/* set tick queue position */
60 #define SNDRV_SEQ_EVENT_SETPOS_TIME	34	/* set realtime queue position */
61 #define SNDRV_SEQ_EVENT_TEMPO		35	/* (SMF) Tempo event */
62 #define SNDRV_SEQ_EVENT_CLOCK		36	/* midi Real Time Clock message */
63 #define SNDRV_SEQ_EVENT_TICK		37	/* midi Real Time Tick message */
64 #define SNDRV_SEQ_EVENT_QUEUE_SKEW	38	/* skew queue tempo */
65 
66 /** others
67  * event data type = none
68  */
69 #define SNDRV_SEQ_EVENT_TUNE_REQUEST	40	/* tune request */
70 #define SNDRV_SEQ_EVENT_RESET		41	/* reset to power-on state */
71 #define SNDRV_SEQ_EVENT_SENSING		42	/* "active sensing" event */
72 
73 /** echo back, kernel private messages
74  * event data type = any type
75  */
76 #define SNDRV_SEQ_EVENT_ECHO		50	/* echo event */
77 #define SNDRV_SEQ_EVENT_OSS		51	/* OSS raw event */
78 
79 /** system status messages (broadcast for subscribers)
80  * event data type = snd_seq_addr
81  */
82 #define SNDRV_SEQ_EVENT_CLIENT_START	60	/* new client has connected */
83 #define SNDRV_SEQ_EVENT_CLIENT_EXIT	61	/* client has left the system */
84 #define SNDRV_SEQ_EVENT_CLIENT_CHANGE	62	/* client status/info has changed */
85 #define SNDRV_SEQ_EVENT_PORT_START	63	/* new port was created */
86 #define SNDRV_SEQ_EVENT_PORT_EXIT	64	/* port was deleted from system */
87 #define SNDRV_SEQ_EVENT_PORT_CHANGE	65	/* port status/info has changed */
88 
89 /** port connection changes
90  * event data type = snd_seq_connect
91  */
92 #define SNDRV_SEQ_EVENT_PORT_SUBSCRIBED	66	/* ports connected */
93 #define SNDRV_SEQ_EVENT_PORT_UNSUBSCRIBED 67	/* ports disconnected */
94 
95 /* 70-89:  synthesizer events - obsoleted */
96 
97 /** user-defined events with fixed length
98  * event data type = any
99  */
100 #define SNDRV_SEQ_EVENT_USR0		90
101 #define SNDRV_SEQ_EVENT_USR1		91
102 #define SNDRV_SEQ_EVENT_USR2		92
103 #define SNDRV_SEQ_EVENT_USR3		93
104 #define SNDRV_SEQ_EVENT_USR4		94
105 #define SNDRV_SEQ_EVENT_USR5		95
106 #define SNDRV_SEQ_EVENT_USR6		96
107 #define SNDRV_SEQ_EVENT_USR7		97
108 #define SNDRV_SEQ_EVENT_USR8		98
109 #define SNDRV_SEQ_EVENT_USR9		99
110 
111 /* 100-118: instrument layer - obsoleted */
112 /* 119-129: reserved */
113 
114 /* 130-139: variable length events
115  * event data type = snd_seq_ev_ext
116  * (SNDRV_SEQ_EVENT_LENGTH_VARIABLE must be set)
117  */
118 #define SNDRV_SEQ_EVENT_SYSEX		130	/* system exclusive data (variable length) */
119 #define SNDRV_SEQ_EVENT_BOUNCE		131	/* error event */
120 /* 132-134: reserved */
121 #define SNDRV_SEQ_EVENT_USR_VAR0	135
122 #define SNDRV_SEQ_EVENT_USR_VAR1	136
123 #define SNDRV_SEQ_EVENT_USR_VAR2	137
124 #define SNDRV_SEQ_EVENT_USR_VAR3	138
125 #define SNDRV_SEQ_EVENT_USR_VAR4	139
126 
127 /* 150-151: kernel events with quote - DO NOT use in user clients */
128 #define SNDRV_SEQ_EVENT_KERNEL_ERROR	150
129 #define SNDRV_SEQ_EVENT_KERNEL_QUOTE	151	/* obsolete */
130 
131 /* 152-191: reserved */
132 
133 /* 192-254: hardware specific events */
134 
135 /* 255: special event */
136 #define SNDRV_SEQ_EVENT_NONE		255
137 
138 
139 typedef unsigned char snd_seq_event_type_t;
140 
141 /** event address */
142 struct snd_seq_addr {
143 	unsigned char client;	/**< Client number:         0..255, 255 = broadcast to all clients */
144 	unsigned char port;	/**< Port within client:    0..255, 255 = broadcast to all ports */
145 };
146 
147 /** port connection */
148 struct snd_seq_connect {
149 	struct snd_seq_addr sender;
150 	struct snd_seq_addr dest;
151 };
152 
153 
154 #define SNDRV_SEQ_ADDRESS_UNKNOWN	253	/* unknown source */
155 #define SNDRV_SEQ_ADDRESS_SUBSCRIBERS	254	/* send event to all subscribed ports */
156 #define SNDRV_SEQ_ADDRESS_BROADCAST	255	/* send event to all queues/clients/ports/channels */
157 #define SNDRV_SEQ_QUEUE_DIRECT		253	/* direct dispatch */
158 
159 	/* event mode flag - NOTE: only 8 bits available! */
160 #define SNDRV_SEQ_TIME_STAMP_TICK	(0<<0) /* timestamp in clock ticks */
161 #define SNDRV_SEQ_TIME_STAMP_REAL	(1<<0) /* timestamp in real time */
162 #define SNDRV_SEQ_TIME_STAMP_MASK	(1<<0)
163 
164 #define SNDRV_SEQ_TIME_MODE_ABS		(0<<1)	/* absolute timestamp */
165 #define SNDRV_SEQ_TIME_MODE_REL		(1<<1)	/* relative to current time */
166 #define SNDRV_SEQ_TIME_MODE_MASK	(1<<1)
167 
168 #define SNDRV_SEQ_EVENT_LENGTH_FIXED	(0<<2)	/* fixed event size */
169 #define SNDRV_SEQ_EVENT_LENGTH_VARIABLE	(1<<2)	/* variable event size */
170 #define SNDRV_SEQ_EVENT_LENGTH_VARUSR	(2<<2)	/* variable event size - user memory space */
171 #define SNDRV_SEQ_EVENT_LENGTH_MASK	(3<<2)
172 
173 #define SNDRV_SEQ_PRIORITY_NORMAL	(0<<4)	/* normal priority */
174 #define SNDRV_SEQ_PRIORITY_HIGH		(1<<4)	/* event should be processed before others */
175 #define SNDRV_SEQ_PRIORITY_MASK		(1<<4)
176 
177 #define SNDRV_SEQ_EVENT_UMP		(1<<5)	/* event holds a UMP packet */
178 
179 	/* note event */
180 struct snd_seq_ev_note {
181 	unsigned char channel;
182 	unsigned char note;
183 	unsigned char velocity;
184 	unsigned char off_velocity;	/* only for SNDRV_SEQ_EVENT_NOTE */
185 	unsigned int duration;		/* only for SNDRV_SEQ_EVENT_NOTE */
186 };
187 
188 	/* controller event */
189 struct snd_seq_ev_ctrl {
190 	unsigned char channel;
191 	unsigned char unused1, unused2, unused3;	/* pad */
192 	unsigned int param;
193 	signed int value;
194 };
195 
196 	/* generic set of bytes (12x8 bit) */
197 struct snd_seq_ev_raw8 {
198 	unsigned char d[12];	/* 8 bit value */
199 };
200 
201 	/* generic set of integers (3x32 bit) */
202 struct snd_seq_ev_raw32 {
203 	unsigned int d[3];	/* 32 bit value */
204 };
205 
206 	/* external stored data */
207 struct snd_seq_ev_ext {
208 	unsigned int len;	/* length of data */
209 	void *ptr;		/* pointer to data (note: maybe 64-bit) */
210 } __attribute__((packed));
211 
212 struct snd_seq_result {
213 	int event;		/* processed event type */
214 	int result;
215 };
216 
217 
218 struct snd_seq_real_time {
219 	unsigned int tv_sec;	/* seconds */
220 	unsigned int tv_nsec;	/* nanoseconds */
221 };
222 
223 typedef unsigned int snd_seq_tick_time_t;	/* midi ticks */
224 
225 union snd_seq_timestamp {
226 	snd_seq_tick_time_t tick;
227 	struct snd_seq_real_time time;
228 };
229 
230 struct snd_seq_queue_skew {
231 	unsigned int value;
232 	unsigned int base;
233 };
234 
235 	/* queue timer control */
236 struct snd_seq_ev_queue_control {
237 	unsigned char queue;			/* affected queue */
238 	unsigned char pad[3];			/* reserved */
239 	union {
240 		signed int value;		/* affected value (e.g. tempo) */
241 		union snd_seq_timestamp time;	/* time */
242 		unsigned int position;		/* sync position */
243 		struct snd_seq_queue_skew skew;
244 		unsigned int d32[2];
245 		unsigned char d8[8];
246 	} param;
247 };
248 
249 	/* quoted event - inside the kernel only */
250 struct snd_seq_ev_quote {
251 	struct snd_seq_addr origin;		/* original sender */
252 	unsigned short value;		/* optional data */
253 	struct snd_seq_event *event;		/* quoted event */
254 } __attribute__((packed));
255 
256 union snd_seq_event_data { /* event data... */
257 	struct snd_seq_ev_note note;
258 	struct snd_seq_ev_ctrl control;
259 	struct snd_seq_ev_raw8 raw8;
260 	struct snd_seq_ev_raw32 raw32;
261 	struct snd_seq_ev_ext ext;
262 	struct snd_seq_ev_queue_control queue;
263 	union snd_seq_timestamp time;
264 	struct snd_seq_addr addr;
265 	struct snd_seq_connect connect;
266 	struct snd_seq_result result;
267 	struct snd_seq_ev_quote quote;
268 };
269 
270 	/* sequencer event */
271 struct snd_seq_event {
272 	snd_seq_event_type_t type;	/* event type */
273 	unsigned char flags;		/* event flags */
274 	char tag;
275 
276 	unsigned char queue;		/* schedule queue */
277 	union snd_seq_timestamp time;	/* schedule time */
278 
279 	struct snd_seq_addr source;	/* source address */
280 	struct snd_seq_addr dest;	/* destination address */
281 
282 	union snd_seq_event_data data;
283 };
284 
285 	/* (compatible) event for UMP-capable clients */
286 struct snd_seq_ump_event {
287 	snd_seq_event_type_t type;	/* event type */
288 	unsigned char flags;		/* event flags */
289 	char tag;
290 	unsigned char queue;		/* schedule queue */
291 	union snd_seq_timestamp time;	/* schedule time */
292 	struct snd_seq_addr source;	/* source address */
293 	struct snd_seq_addr dest;	/* destination address */
294 
295 	union {
296 		union snd_seq_event_data data;
297 		unsigned int ump[4];
298 	};
299 };
300 
301 /*
302  * bounce event - stored as variable size data
303  */
304 struct snd_seq_event_bounce {
305 	int err;
306 	struct snd_seq_event event;
307 	/* external data follows here. */
308 };
309 
310 
311 	/* system information */
312 struct snd_seq_system_info {
313 	int queues;			/* maximum queues count */
314 	int clients;			/* maximum clients count */
315 	int ports;			/* maximum ports per client */
316 	int channels;			/* maximum channels per port */
317 	int cur_clients;		/* current clients */
318 	int cur_queues;			/* current queues */
319 	char reserved[24];
320 };
321 
322 
323 	/* system running information */
324 struct snd_seq_running_info {
325 	unsigned char client;		/* client id */
326 	unsigned char big_endian;	/* 1 = big-endian */
327 	unsigned char cpu_mode;		/* 4 = 32bit, 8 = 64bit */
328 	unsigned char pad;		/* reserved */
329 	unsigned char reserved[12];
330 };
331 
332 
333 	/* known client numbers */
334 #define SNDRV_SEQ_CLIENT_SYSTEM		0
335 	/* internal client numbers */
336 #define SNDRV_SEQ_CLIENT_DUMMY		14	/* midi through */
337 #define SNDRV_SEQ_CLIENT_OSS		15	/* oss sequencer emulator */
338 
339 
340 	/* client types */
341 typedef int __bitwise snd_seq_client_type_t;
342 #define	NO_CLIENT	((__force snd_seq_client_type_t) 0)
343 #define	USER_CLIENT	((__force snd_seq_client_type_t) 1)
344 #define	KERNEL_CLIENT	((__force snd_seq_client_type_t) 2)
345 
346 	/* event filter flags */
347 #define SNDRV_SEQ_FILTER_BROADCAST	(1U<<0)	/* accept broadcast messages */
348 #define SNDRV_SEQ_FILTER_MULTICAST	(1U<<1)	/* accept multicast messages */
349 #define SNDRV_SEQ_FILTER_BOUNCE		(1U<<2)	/* accept bounce event in error */
350 #define SNDRV_SEQ_FILTER_NO_CONVERT	(1U<<30) /* don't convert UMP events */
351 #define SNDRV_SEQ_FILTER_USE_EVENT	(1U<<31)	/* use event filter */
352 
353 struct snd_seq_client_info {
354 	int client;			/* client number to inquire */
355 	snd_seq_client_type_t type;	/* client type */
356 	char name[64];			/* client name */
357 	unsigned int filter;		/* filter flags */
358 	unsigned char multicast_filter[8]; /* multicast filter bitmap */
359 	unsigned char event_filter[32];	/* event filter bitmap */
360 	int num_ports;			/* RO: number of ports */
361 	int event_lost;			/* number of lost events */
362 	int card;			/* RO: card number[kernel] */
363 	int pid;			/* RO: pid[user] */
364 	unsigned int midi_version;	/* MIDI version */
365 	unsigned int group_filter;	/* UMP group filter bitmap
366 					 * (bit 0 = groupless messages,
367 					 *  bit 1-16 = messages for groups 1-16)
368 					 */
369 	char reserved[48];		/* for future use */
370 };
371 
372 /* MIDI version numbers in client info */
373 #define SNDRV_SEQ_CLIENT_LEGACY_MIDI		0	/* Legacy client */
374 #define SNDRV_SEQ_CLIENT_UMP_MIDI_1_0		1	/* UMP MIDI 1.0 */
375 #define SNDRV_SEQ_CLIENT_UMP_MIDI_2_0		2	/* UMP MIDI 2.0 */
376 
377 /* client pool size */
378 struct snd_seq_client_pool {
379 	int client;			/* client number to inquire */
380 	int output_pool;		/* outgoing (write) pool size */
381 	int input_pool;			/* incoming (read) pool size */
382 	int output_room;		/* minimum free pool size for select/blocking mode */
383 	int output_free;		/* unused size */
384 	int input_free;			/* unused size */
385 	char reserved[64];
386 };
387 
388 
389 /* Remove events by specified criteria */
390 
391 #define SNDRV_SEQ_REMOVE_INPUT		(1<<0)	/* Flush input queues */
392 #define SNDRV_SEQ_REMOVE_OUTPUT		(1<<1)	/* Flush output queues */
393 #define SNDRV_SEQ_REMOVE_DEST		(1<<2)	/* Restrict by destination q:client:port */
394 #define SNDRV_SEQ_REMOVE_DEST_CHANNEL	(1<<3)	/* Restrict by channel */
395 #define SNDRV_SEQ_REMOVE_TIME_BEFORE	(1<<4)	/* Restrict to before time */
396 #define SNDRV_SEQ_REMOVE_TIME_AFTER	(1<<5)	/* Restrict to time or after */
397 #define SNDRV_SEQ_REMOVE_TIME_TICK	(1<<6)	/* Time is in ticks */
398 #define SNDRV_SEQ_REMOVE_EVENT_TYPE	(1<<7)	/* Restrict to event type */
399 #define SNDRV_SEQ_REMOVE_IGNORE_OFF 	(1<<8)	/* Do not flush off events */
400 #define SNDRV_SEQ_REMOVE_TAG_MATCH 	(1<<9)	/* Restrict to events with given tag */
401 
402 struct snd_seq_remove_events {
403 	unsigned int  remove_mode;	/* Flags that determine what gets removed */
404 
405 	union snd_seq_timestamp time;
406 
407 	unsigned char queue;	/* Queue for REMOVE_DEST */
408 	struct snd_seq_addr dest;	/* Address for REMOVE_DEST */
409 	unsigned char channel;	/* Channel for REMOVE_DEST */
410 
411 	int  type;	/* For REMOVE_EVENT_TYPE */
412 	char  tag;	/* Tag for REMOVE_TAG */
413 
414 	int  reserved[10];	/* To allow for future binary compatibility */
415 
416 };
417 
418 
419 	/* known port numbers */
420 #define SNDRV_SEQ_PORT_SYSTEM_TIMER	0
421 #define SNDRV_SEQ_PORT_SYSTEM_ANNOUNCE	1
422 
423 	/* port capabilities (32 bits) */
424 #define SNDRV_SEQ_PORT_CAP_READ		(1<<0)	/* readable from this port */
425 #define SNDRV_SEQ_PORT_CAP_WRITE	(1<<1)	/* writable to this port */
426 
427 #define SNDRV_SEQ_PORT_CAP_SYNC_READ	(1<<2)
428 #define SNDRV_SEQ_PORT_CAP_SYNC_WRITE	(1<<3)
429 
430 #define SNDRV_SEQ_PORT_CAP_DUPLEX	(1<<4)
431 
432 #define SNDRV_SEQ_PORT_CAP_SUBS_READ	(1<<5)	/* allow read subscription */
433 #define SNDRV_SEQ_PORT_CAP_SUBS_WRITE	(1<<6)	/* allow write subscription */
434 #define SNDRV_SEQ_PORT_CAP_NO_EXPORT	(1<<7)	/* routing not allowed */
435 #define SNDRV_SEQ_PORT_CAP_INACTIVE	(1<<8)	/* inactive port */
436 #define SNDRV_SEQ_PORT_CAP_UMP_ENDPOINT	(1<<9)	/* MIDI 2.0 UMP Endpoint port */
437 
438 	/* port type */
439 #define SNDRV_SEQ_PORT_TYPE_SPECIFIC	(1<<0)	/* hardware specific */
440 #define SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC (1<<1)	/* generic MIDI device */
441 #define SNDRV_SEQ_PORT_TYPE_MIDI_GM	(1<<2)	/* General MIDI compatible device */
442 #define SNDRV_SEQ_PORT_TYPE_MIDI_GS	(1<<3)	/* GS compatible device */
443 #define SNDRV_SEQ_PORT_TYPE_MIDI_XG	(1<<4)	/* XG compatible device */
444 #define SNDRV_SEQ_PORT_TYPE_MIDI_MT32	(1<<5)	/* MT-32 compatible device */
445 #define SNDRV_SEQ_PORT_TYPE_MIDI_GM2	(1<<6)	/* General MIDI 2 compatible device */
446 #define SNDRV_SEQ_PORT_TYPE_MIDI_UMP	(1<<7)	/* UMP */
447 
448 /* other standards...*/
449 #define SNDRV_SEQ_PORT_TYPE_SYNTH	(1<<10)	/* Synth device (no MIDI compatible - direct wavetable) */
450 #define SNDRV_SEQ_PORT_TYPE_DIRECT_SAMPLE (1<<11)	/* Sampling device (support sample download) */
451 #define SNDRV_SEQ_PORT_TYPE_SAMPLE	(1<<12)	/* Sampling device (sample can be downloaded at any time) */
452 /*...*/
453 #define SNDRV_SEQ_PORT_TYPE_HARDWARE	(1<<16)	/* driver for a hardware device */
454 #define SNDRV_SEQ_PORT_TYPE_SOFTWARE	(1<<17)	/* implemented in software */
455 #define SNDRV_SEQ_PORT_TYPE_SYNTHESIZER	(1<<18)	/* generates sound */
456 #define SNDRV_SEQ_PORT_TYPE_PORT	(1<<19)	/* connects to other device(s) */
457 #define SNDRV_SEQ_PORT_TYPE_APPLICATION	(1<<20)	/* application (sequencer/editor) */
458 
459 /* misc. conditioning flags */
460 #define SNDRV_SEQ_PORT_FLG_GIVEN_PORT	(1<<0)
461 #define SNDRV_SEQ_PORT_FLG_TIMESTAMP	(1<<1)
462 #define SNDRV_SEQ_PORT_FLG_TIME_REAL	(1<<2)
463 
464 /* port direction */
465 #define SNDRV_SEQ_PORT_DIR_UNKNOWN	0
466 #define SNDRV_SEQ_PORT_DIR_INPUT	1
467 #define SNDRV_SEQ_PORT_DIR_OUTPUT	2
468 #define SNDRV_SEQ_PORT_DIR_BIDIRECTION	3
469 
470 struct snd_seq_port_info {
471 	struct snd_seq_addr addr;	/* client/port numbers */
472 	char name[64];			/* port name */
473 
474 	unsigned int capability;	/* port capability bits */
475 	unsigned int type;		/* port type bits */
476 	int midi_channels;		/* channels per MIDI port */
477 	int midi_voices;		/* voices per MIDI port */
478 	int synth_voices;		/* voices per SYNTH port */
479 
480 	int read_use;			/* R/O: subscribers for output (from this port) */
481 	int write_use;			/* R/O: subscribers for input (to this port) */
482 
483 	void *kernel;			/* reserved for kernel use (must be NULL) */
484 	unsigned int flags;		/* misc. conditioning */
485 	unsigned char time_queue;	/* queue # for timestamping */
486 	unsigned char direction;	/* port usage direction (r/w/bidir) */
487 	unsigned char ump_group;	/* 0 = UMP EP (no conversion), 1-16 = UMP group number */
488 	char reserved[57];		/* for future use */
489 };
490 
491 
492 /* queue flags */
493 #define SNDRV_SEQ_QUEUE_FLG_SYNC	(1<<0)	/* sync enabled */
494 
495 /* queue information */
496 struct snd_seq_queue_info {
497 	int queue;		/* queue id */
498 
499 	/*
500 	 *  security settings, only owner of this queue can start/stop timer
501 	 *  etc. if the queue is locked for other clients
502 	 */
503 	int owner;		/* client id for owner of the queue */
504 	unsigned locked:1;	/* timing queue locked for other queues */
505 	char name[64];		/* name of this queue */
506 	unsigned int flags;	/* flags */
507 	char reserved[60];	/* for future use */
508 
509 };
510 
511 /* queue info/status */
512 struct snd_seq_queue_status {
513 	int queue;			/* queue id */
514 	int events;			/* read-only - queue size */
515 	snd_seq_tick_time_t tick;	/* current tick */
516 	struct snd_seq_real_time time;	/* current time */
517 	int running;			/* running state of queue */
518 	int flags;			/* various flags */
519 	char reserved[64];		/* for the future */
520 };
521 
522 
523 /* queue tempo */
524 struct snd_seq_queue_tempo {
525 	int queue;			/* sequencer queue */
526 	unsigned int tempo;		/* current tempo, us/tick */
527 	int ppq;			/* time resolution, ticks/quarter */
528 	unsigned int skew_value;	/* queue skew */
529 	unsigned int skew_base;		/* queue skew base */
530 	char reserved[24];		/* for the future */
531 };
532 
533 
534 /* sequencer timer sources */
535 #define SNDRV_SEQ_TIMER_ALSA		0	/* ALSA timer */
536 #define SNDRV_SEQ_TIMER_MIDI_CLOCK	1	/* Midi Clock (CLOCK event) */
537 #define SNDRV_SEQ_TIMER_MIDI_TICK	2	/* Midi Timer Tick (TICK event) */
538 
539 /* queue timer info */
540 struct snd_seq_queue_timer {
541 	int queue;			/* sequencer queue */
542 	int type;			/* source timer type */
543 	union {
544 		struct {
545 			struct snd_timer_id id;	/* ALSA's timer ID */
546 			unsigned int resolution;	/* resolution in Hz */
547 		} alsa;
548 	} u;
549 	char reserved[64];		/* for the future use */
550 };
551 
552 
553 struct snd_seq_queue_client {
554 	int queue;		/* sequencer queue */
555 	int client;		/* sequencer client */
556 	int used;		/* queue is used with this client
557 				   (must be set for accepting events) */
558 	/* per client watermarks */
559 	char reserved[64];	/* for future use */
560 };
561 
562 
563 #define SNDRV_SEQ_PORT_SUBS_EXCLUSIVE	(1<<0)	/* exclusive connection */
564 #define SNDRV_SEQ_PORT_SUBS_TIMESTAMP	(1<<1)
565 #define SNDRV_SEQ_PORT_SUBS_TIME_REAL	(1<<2)
566 
567 struct snd_seq_port_subscribe {
568 	struct snd_seq_addr sender;	/* sender address */
569 	struct snd_seq_addr dest;	/* destination address */
570 	unsigned int voices;		/* number of voices to be allocated (0 = don't care) */
571 	unsigned int flags;		/* modes */
572 	unsigned char queue;		/* input time-stamp queue (optional) */
573 	unsigned char pad[3];		/* reserved */
574 	char reserved[64];
575 };
576 
577 /* type of query subscription */
578 #define SNDRV_SEQ_QUERY_SUBS_READ	0
579 #define SNDRV_SEQ_QUERY_SUBS_WRITE	1
580 
581 struct snd_seq_query_subs {
582 	struct snd_seq_addr root;	/* client/port id to be searched */
583 	int type;		/* READ or WRITE */
584 	int index;		/* 0..N-1 */
585 	int num_subs;		/* R/O: number of subscriptions on this port */
586 	struct snd_seq_addr addr;	/* R/O: result */
587 	unsigned char queue;	/* R/O: result */
588 	unsigned int flags;	/* R/O: result */
589 	char reserved[64];	/* for future use */
590 };
591 
592 /*
593  * UMP-specific information
594  */
595 /* type of UMP info query */
596 #define SNDRV_SEQ_CLIENT_UMP_INFO_ENDPOINT	0
597 #define SNDRV_SEQ_CLIENT_UMP_INFO_BLOCK		1
598 
599 struct snd_seq_client_ump_info {
600 	int client;			/* client number to inquire/set */
601 	int type;			/* type to inquire/set */
602 	unsigned char info[512];	/* info (either UMP ep or block info) */
603 } __packed;
604 
605 /*
606  *  IOCTL commands
607  */
608 
609 #define SNDRV_SEQ_IOCTL_PVERSION	_IOR ('S', 0x00, int)
610 #define SNDRV_SEQ_IOCTL_CLIENT_ID	_IOR ('S', 0x01, int)
611 #define SNDRV_SEQ_IOCTL_SYSTEM_INFO	_IOWR('S', 0x02, struct snd_seq_system_info)
612 #define SNDRV_SEQ_IOCTL_RUNNING_MODE	_IOWR('S', 0x03, struct snd_seq_running_info)
613 #define SNDRV_SEQ_IOCTL_USER_PVERSION	_IOW('S', 0x04, int)
614 
615 #define SNDRV_SEQ_IOCTL_GET_CLIENT_INFO	_IOWR('S', 0x10, struct snd_seq_client_info)
616 #define SNDRV_SEQ_IOCTL_SET_CLIENT_INFO	_IOW ('S', 0x11, struct snd_seq_client_info)
617 #define SNDRV_SEQ_IOCTL_GET_CLIENT_UMP_INFO	_IOWR('S', 0x12, struct snd_seq_client_ump_info)
618 #define SNDRV_SEQ_IOCTL_SET_CLIENT_UMP_INFO	_IOWR('S', 0x13, struct snd_seq_client_ump_info)
619 
620 #define SNDRV_SEQ_IOCTL_CREATE_PORT	_IOWR('S', 0x20, struct snd_seq_port_info)
621 #define SNDRV_SEQ_IOCTL_DELETE_PORT	_IOW ('S', 0x21, struct snd_seq_port_info)
622 #define SNDRV_SEQ_IOCTL_GET_PORT_INFO	_IOWR('S', 0x22, struct snd_seq_port_info)
623 #define SNDRV_SEQ_IOCTL_SET_PORT_INFO	_IOW ('S', 0x23, struct snd_seq_port_info)
624 
625 #define SNDRV_SEQ_IOCTL_SUBSCRIBE_PORT	_IOW ('S', 0x30, struct snd_seq_port_subscribe)
626 #define SNDRV_SEQ_IOCTL_UNSUBSCRIBE_PORT _IOW ('S', 0x31, struct snd_seq_port_subscribe)
627 
628 #define SNDRV_SEQ_IOCTL_CREATE_QUEUE	_IOWR('S', 0x32, struct snd_seq_queue_info)
629 #define SNDRV_SEQ_IOCTL_DELETE_QUEUE	_IOW ('S', 0x33, struct snd_seq_queue_info)
630 #define SNDRV_SEQ_IOCTL_GET_QUEUE_INFO	_IOWR('S', 0x34, struct snd_seq_queue_info)
631 #define SNDRV_SEQ_IOCTL_SET_QUEUE_INFO	_IOWR('S', 0x35, struct snd_seq_queue_info)
632 #define SNDRV_SEQ_IOCTL_GET_NAMED_QUEUE	_IOWR('S', 0x36, struct snd_seq_queue_info)
633 #define SNDRV_SEQ_IOCTL_GET_QUEUE_STATUS _IOWR('S', 0x40, struct snd_seq_queue_status)
634 #define SNDRV_SEQ_IOCTL_GET_QUEUE_TEMPO	_IOWR('S', 0x41, struct snd_seq_queue_tempo)
635 #define SNDRV_SEQ_IOCTL_SET_QUEUE_TEMPO	_IOW ('S', 0x42, struct snd_seq_queue_tempo)
636 #define SNDRV_SEQ_IOCTL_GET_QUEUE_TIMER	_IOWR('S', 0x45, struct snd_seq_queue_timer)
637 #define SNDRV_SEQ_IOCTL_SET_QUEUE_TIMER	_IOW ('S', 0x46, struct snd_seq_queue_timer)
638 #define SNDRV_SEQ_IOCTL_GET_QUEUE_CLIENT	_IOWR('S', 0x49, struct snd_seq_queue_client)
639 #define SNDRV_SEQ_IOCTL_SET_QUEUE_CLIENT	_IOW ('S', 0x4a, struct snd_seq_queue_client)
640 #define SNDRV_SEQ_IOCTL_GET_CLIENT_POOL	_IOWR('S', 0x4b, struct snd_seq_client_pool)
641 #define SNDRV_SEQ_IOCTL_SET_CLIENT_POOL	_IOW ('S', 0x4c, struct snd_seq_client_pool)
642 #define SNDRV_SEQ_IOCTL_REMOVE_EVENTS	_IOW ('S', 0x4e, struct snd_seq_remove_events)
643 #define SNDRV_SEQ_IOCTL_QUERY_SUBS	_IOWR('S', 0x4f, struct snd_seq_query_subs)
644 #define SNDRV_SEQ_IOCTL_GET_SUBSCRIPTION	_IOWR('S', 0x50, struct snd_seq_port_subscribe)
645 #define SNDRV_SEQ_IOCTL_QUERY_NEXT_CLIENT	_IOWR('S', 0x51, struct snd_seq_client_info)
646 #define SNDRV_SEQ_IOCTL_QUERY_NEXT_PORT	_IOWR('S', 0x52, struct snd_seq_port_info)
647 
648 #endif /* _UAPI__SOUND_ASEQUENCER_H */
649