xref: /openbmc/linux/include/sound/asoundef.h (revision 1da177e4c3f41524e886b7f1b8a0c1fc7321cac2)
1*1da177e4SLinus Torvalds #ifndef __SOUND_ASOUNDEF_H
2*1da177e4SLinus Torvalds #define __SOUND_ASOUNDEF_H
3*1da177e4SLinus Torvalds 
4*1da177e4SLinus Torvalds /*
5*1da177e4SLinus Torvalds  *  Advanced Linux Sound Architecture - ALSA - Driver
6*1da177e4SLinus Torvalds  *  Copyright (c) 1994-2000 by Jaroslav Kysela <perex@suse.cz>
7*1da177e4SLinus Torvalds  *
8*1da177e4SLinus Torvalds  *
9*1da177e4SLinus Torvalds  *   This program is free software; you can redistribute it and/or modify
10*1da177e4SLinus Torvalds  *   it under the terms of the GNU General Public License as published by
11*1da177e4SLinus Torvalds  *   the Free Software Foundation; either version 2 of the License, or
12*1da177e4SLinus Torvalds  *   (at your option) any later version.
13*1da177e4SLinus Torvalds  *
14*1da177e4SLinus Torvalds  *   This program is distributed in the hope that it will be useful,
15*1da177e4SLinus Torvalds  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
16*1da177e4SLinus Torvalds  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17*1da177e4SLinus Torvalds  *   GNU General Public License for more details.
18*1da177e4SLinus Torvalds  *
19*1da177e4SLinus Torvalds  *   You should have received a copy of the GNU General Public License
20*1da177e4SLinus Torvalds  *   along with this program; if not, write to the Free Software
21*1da177e4SLinus Torvalds  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
22*1da177e4SLinus Torvalds  *
23*1da177e4SLinus Torvalds  */
24*1da177e4SLinus Torvalds 
25*1da177e4SLinus Torvalds /****************************************************************************
26*1da177e4SLinus Torvalds  *                                                                          *
27*1da177e4SLinus Torvalds  *        Digital audio interface					    *
28*1da177e4SLinus Torvalds  *                                                                          *
29*1da177e4SLinus Torvalds  ****************************************************************************/
30*1da177e4SLinus Torvalds 
31*1da177e4SLinus Torvalds /* AES/IEC958 channel status bits */
32*1da177e4SLinus Torvalds #define IEC958_AES0_PROFESSIONAL	(1<<0)	/* 0 = consumer, 1 = professional */
33*1da177e4SLinus Torvalds #define IEC958_AES0_NONAUDIO		(1<<1)	/* 0 = audio, 1 = non-audio */
34*1da177e4SLinus Torvalds #define IEC958_AES0_PRO_EMPHASIS	(7<<2)	/* mask - emphasis */
35*1da177e4SLinus Torvalds #define IEC958_AES0_PRO_EMPHASIS_NOTID	(0<<2)	/* emphasis not indicated */
36*1da177e4SLinus Torvalds #define IEC958_AES0_PRO_EMPHASIS_NONE	(1<<2)	/* none emphasis */
37*1da177e4SLinus Torvalds #define IEC958_AES0_PRO_EMPHASIS_5015	(3<<2)	/* 50/15us emphasis */
38*1da177e4SLinus Torvalds #define IEC958_AES0_PRO_EMPHASIS_CCITT	(7<<2)	/* CCITT J.17 emphasis */
39*1da177e4SLinus Torvalds #define IEC958_AES0_PRO_FREQ_UNLOCKED	(1<<5)	/* source sample frequency: 0 = locked, 1 = unlocked */
40*1da177e4SLinus Torvalds #define IEC958_AES0_PRO_FS		(3<<6)	/* mask - sample frequency */
41*1da177e4SLinus Torvalds #define IEC958_AES0_PRO_FS_NOTID	(0<<6)	/* fs not indicated */
42*1da177e4SLinus Torvalds #define IEC958_AES0_PRO_FS_44100	(1<<6)	/* 44.1kHz */
43*1da177e4SLinus Torvalds #define IEC958_AES0_PRO_FS_48000	(2<<6)	/* 48kHz */
44*1da177e4SLinus Torvalds #define IEC958_AES0_PRO_FS_32000	(3<<6)	/* 32kHz */
45*1da177e4SLinus Torvalds #define IEC958_AES0_CON_NOT_COPYRIGHT	(1<<2)	/* 0 = copyright, 1 = not copyright */
46*1da177e4SLinus Torvalds #define IEC958_AES0_CON_EMPHASIS	(7<<3)	/* mask - emphasis */
47*1da177e4SLinus Torvalds #define IEC958_AES0_CON_EMPHASIS_NONE	(0<<3)	/* none emphasis */
48*1da177e4SLinus Torvalds #define IEC958_AES0_CON_EMPHASIS_5015	(1<<3)	/* 50/15us emphasis */
49*1da177e4SLinus Torvalds #define IEC958_AES0_CON_MODE		(3<<6)	/* mask - mode */
50*1da177e4SLinus Torvalds #define IEC958_AES1_PRO_MODE		(15<<0)	/* mask - channel mode */
51*1da177e4SLinus Torvalds #define IEC958_AES1_PRO_MODE_NOTID	(0<<0)	/* not indicated */
52*1da177e4SLinus Torvalds #define IEC958_AES1_PRO_MODE_STEREOPHONIC (2<<0) /* stereophonic - ch A is left */
53*1da177e4SLinus Torvalds #define IEC958_AES1_PRO_MODE_SINGLE	(4<<0)	/* single channel */
54*1da177e4SLinus Torvalds #define IEC958_AES1_PRO_MODE_TWO	(8<<0)	/* two channels */
55*1da177e4SLinus Torvalds #define IEC958_AES1_PRO_MODE_PRIMARY	(12<<0)	/* primary/secondary */
56*1da177e4SLinus Torvalds #define IEC958_AES1_PRO_MODE_BYTE3	(15<<0)	/* vector to byte 3 */
57*1da177e4SLinus Torvalds #define IEC958_AES1_PRO_USERBITS	(15<<4)	/* mask - user bits */
58*1da177e4SLinus Torvalds #define IEC958_AES1_PRO_USERBITS_NOTID	(0<<4)	/* not indicated */
59*1da177e4SLinus Torvalds #define IEC958_AES1_PRO_USERBITS_192	(8<<4)	/* 192-bit structure */
60*1da177e4SLinus Torvalds #define IEC958_AES1_PRO_USERBITS_UDEF	(12<<4)	/* user defined application */
61*1da177e4SLinus Torvalds #define IEC958_AES1_CON_CATEGORY	0x7f
62*1da177e4SLinus Torvalds #define IEC958_AES1_CON_GENERAL		0x00
63*1da177e4SLinus Torvalds #define IEC958_AES1_CON_EXPERIMENTAL	0x40
64*1da177e4SLinus Torvalds #define IEC958_AES1_CON_SOLIDMEM_MASK	0x0f
65*1da177e4SLinus Torvalds #define IEC958_AES1_CON_SOLIDMEM_ID	0x08
66*1da177e4SLinus Torvalds #define IEC958_AES1_CON_BROADCAST1_MASK 0x07
67*1da177e4SLinus Torvalds #define IEC958_AES1_CON_BROADCAST1_ID	0x04
68*1da177e4SLinus Torvalds #define IEC958_AES1_CON_DIGDIGCONV_MASK 0x07
69*1da177e4SLinus Torvalds #define IEC958_AES1_CON_DIGDIGCONV_ID	0x02
70*1da177e4SLinus Torvalds #define IEC958_AES1_CON_ADC_COPYRIGHT_MASK 0x1f
71*1da177e4SLinus Torvalds #define IEC958_AES1_CON_ADC_COPYRIGHT_ID 0x06
72*1da177e4SLinus Torvalds #define IEC958_AES1_CON_ADC_MASK	0x1f
73*1da177e4SLinus Torvalds #define IEC958_AES1_CON_ADC_ID		0x16
74*1da177e4SLinus Torvalds #define IEC958_AES1_CON_BROADCAST2_MASK 0x0f
75*1da177e4SLinus Torvalds #define IEC958_AES1_CON_BROADCAST2_ID	0x0e
76*1da177e4SLinus Torvalds #define IEC958_AES1_CON_LASEROPT_MASK	0x07
77*1da177e4SLinus Torvalds #define IEC958_AES1_CON_LASEROPT_ID	0x01
78*1da177e4SLinus Torvalds #define IEC958_AES1_CON_MUSICAL_MASK	0x07
79*1da177e4SLinus Torvalds #define IEC958_AES1_CON_MUSICAL_ID	0x05
80*1da177e4SLinus Torvalds #define IEC958_AES1_CON_MAGNETIC_MASK	0x07
81*1da177e4SLinus Torvalds #define IEC958_AES1_CON_MAGNETIC_ID	0x03
82*1da177e4SLinus Torvalds #define IEC958_AES1_CON_IEC908_CD	(IEC958_AES1_CON_LASEROPT_ID|0x00)
83*1da177e4SLinus Torvalds #define IEC958_AES1_CON_NON_IEC908_CD	(IEC958_AES1_CON_LASEROPT_ID|0x08)
84*1da177e4SLinus Torvalds #define IEC958_AES1_CON_PCM_CODER	(IEC958_AES1_CON_DIGDIGCONV_ID|0x00)
85*1da177e4SLinus Torvalds #define IEC958_AES1_CON_SAMPLER		(IEC958_AES1_CON_DIGDIGCONV_ID|0x20)
86*1da177e4SLinus Torvalds #define IEC958_AES1_CON_MIXER		(IEC958_AES1_CON_DIGDIGCONV_ID|0x10)
87*1da177e4SLinus Torvalds #define IEC958_AES1_CON_RATE_CONVERTER	(IEC958_AES1_CON_DIGDIGCONV_ID|0x18)
88*1da177e4SLinus Torvalds #define IEC958_AES1_CON_SYNTHESIZER	(IEC958_AES1_CON_MUSICAL_ID|0x00)
89*1da177e4SLinus Torvalds #define IEC958_AES1_CON_MICROPHONE	(IEC958_AES1_CON_MUSICAL_ID|0x08)
90*1da177e4SLinus Torvalds #define IEC958_AES1_CON_DAT		(IEC958_AES1_CON_MAGNETIC_ID|0x00)
91*1da177e4SLinus Torvalds #define IEC958_AES1_CON_VCR		(IEC958_AES1_CON_MAGNETIC_ID|0x08)
92*1da177e4SLinus Torvalds #define IEC958_AES1_CON_ORIGINAL	(1<<7)	/* this bits depends on the category code */
93*1da177e4SLinus Torvalds #define IEC958_AES2_PRO_SBITS		(7<<0)	/* mask - sample bits */
94*1da177e4SLinus Torvalds #define IEC958_AES2_PRO_SBITS_20	(2<<0)	/* 20-bit - coordination */
95*1da177e4SLinus Torvalds #define IEC958_AES2_PRO_SBITS_24	(4<<0)	/* 24-bit - main audio */
96*1da177e4SLinus Torvalds #define IEC958_AES2_PRO_SBITS_UDEF	(6<<0)	/* user defined application */
97*1da177e4SLinus Torvalds #define IEC958_AES2_PRO_WORDLEN		(7<<3)	/* mask - source word length */
98*1da177e4SLinus Torvalds #define IEC958_AES2_PRO_WORDLEN_NOTID	(0<<3)	/* not indicated */
99*1da177e4SLinus Torvalds #define IEC958_AES2_PRO_WORDLEN_22_18	(2<<3)	/* 22-bit or 18-bit */
100*1da177e4SLinus Torvalds #define IEC958_AES2_PRO_WORDLEN_23_19	(4<<3)	/* 23-bit or 19-bit */
101*1da177e4SLinus Torvalds #define IEC958_AES2_PRO_WORDLEN_24_20	(5<<3)	/* 24-bit or 20-bit */
102*1da177e4SLinus Torvalds #define IEC958_AES2_PRO_WORDLEN_20_16	(6<<3)	/* 20-bit or 16-bit */
103*1da177e4SLinus Torvalds #define IEC958_AES2_CON_SOURCE		(15<<0)	/* mask - source number */
104*1da177e4SLinus Torvalds #define IEC958_AES2_CON_SOURCE_UNSPEC	(0<<0)	/* unspecified */
105*1da177e4SLinus Torvalds #define IEC958_AES2_CON_CHANNEL		(15<<4)	/* mask - channel number */
106*1da177e4SLinus Torvalds #define IEC958_AES2_CON_CHANNEL_UNSPEC	(0<<4)	/* unspecified */
107*1da177e4SLinus Torvalds #define IEC958_AES3_CON_FS		(15<<0)	/* mask - sample frequency */
108*1da177e4SLinus Torvalds #define IEC958_AES3_CON_FS_44100	(0<<0)	/* 44.1kHz */
109*1da177e4SLinus Torvalds #define IEC958_AES3_CON_FS_48000	(2<<0)	/* 48kHz */
110*1da177e4SLinus Torvalds #define IEC958_AES3_CON_FS_32000	(3<<0)	/* 32kHz */
111*1da177e4SLinus Torvalds #define IEC958_AES3_CON_CLOCK		(3<<4)	/* mask - clock accuracy */
112*1da177e4SLinus Torvalds #define IEC958_AES3_CON_CLOCK_1000PPM	(0<<4)	/* 1000 ppm */
113*1da177e4SLinus Torvalds #define IEC958_AES3_CON_CLOCK_50PPM	(1<<4)	/* 50 ppm */
114*1da177e4SLinus Torvalds #define IEC958_AES3_CON_CLOCK_VARIABLE	(2<<4)	/* variable pitch */
115*1da177e4SLinus Torvalds 
116*1da177e4SLinus Torvalds /*****************************************************************************
117*1da177e4SLinus Torvalds  *                                                                           *
118*1da177e4SLinus Torvalds  *                            MIDI v1.0 interface                            *
119*1da177e4SLinus Torvalds  *                                                                           *
120*1da177e4SLinus Torvalds  *****************************************************************************/
121*1da177e4SLinus Torvalds 
122*1da177e4SLinus Torvalds #define MIDI_CHANNELS			16
123*1da177e4SLinus Torvalds #define MIDI_GM_DRUM_CHANNEL		(10-1)
124*1da177e4SLinus Torvalds 
125*1da177e4SLinus Torvalds /*
126*1da177e4SLinus Torvalds  *  MIDI commands
127*1da177e4SLinus Torvalds  */
128*1da177e4SLinus Torvalds 
129*1da177e4SLinus Torvalds #define MIDI_CMD_NOTE_OFF		0x80
130*1da177e4SLinus Torvalds #define MIDI_CMD_NOTE_ON		0x90
131*1da177e4SLinus Torvalds #define MIDI_CMD_NOTE_PRESSURE		0xa0
132*1da177e4SLinus Torvalds #define MIDI_CMD_CONTROL		0xb0
133*1da177e4SLinus Torvalds #define MIDI_CMD_PGM_CHANGE		0xc0
134*1da177e4SLinus Torvalds #define MIDI_CMD_CHANNEL_PRESSURE	0xd0
135*1da177e4SLinus Torvalds #define MIDI_CMD_BENDER			0xe0
136*1da177e4SLinus Torvalds 
137*1da177e4SLinus Torvalds #define MIDI_CMD_COMMON_SYSEX		0xf0
138*1da177e4SLinus Torvalds #define MIDI_CMD_COMMON_MTC_QUARTER	0xf1
139*1da177e4SLinus Torvalds #define MIDI_CMD_COMMON_SONG_POS	0xf2
140*1da177e4SLinus Torvalds #define MIDI_CMD_COMMON_SONG_SELECT	0xf3
141*1da177e4SLinus Torvalds #define MIDI_CMD_COMMON_TUNE_REQUEST	0xf6
142*1da177e4SLinus Torvalds #define MIDI_CMD_COMMON_SYSEX_END	0xf7
143*1da177e4SLinus Torvalds #define MIDI_CMD_COMMON_CLOCK		0xf8
144*1da177e4SLinus Torvalds #define MIDI_CMD_COMMON_START		0xfa
145*1da177e4SLinus Torvalds #define MIDI_CMD_COMMON_CONTINUE	0xfb
146*1da177e4SLinus Torvalds #define MIDI_CMD_COMMON_STOP		0xfc
147*1da177e4SLinus Torvalds #define MIDI_CMD_COMMON_SENSING		0xfe
148*1da177e4SLinus Torvalds #define MIDI_CMD_COMMON_RESET		0xff
149*1da177e4SLinus Torvalds 
150*1da177e4SLinus Torvalds /*
151*1da177e4SLinus Torvalds  *  MIDI controllers
152*1da177e4SLinus Torvalds  */
153*1da177e4SLinus Torvalds 
154*1da177e4SLinus Torvalds #define MIDI_CTL_MSB_BANK		0x00
155*1da177e4SLinus Torvalds #define MIDI_CTL_MSB_MODWHEEL         	0x01
156*1da177e4SLinus Torvalds #define MIDI_CTL_MSB_BREATH           	0x02
157*1da177e4SLinus Torvalds #define MIDI_CTL_MSB_FOOT             	0x04
158*1da177e4SLinus Torvalds #define MIDI_CTL_MSB_PORTAMENTO_TIME 	0x05
159*1da177e4SLinus Torvalds #define MIDI_CTL_MSB_DATA_ENTRY		0x06
160*1da177e4SLinus Torvalds #define MIDI_CTL_MSB_MAIN_VOLUME      	0x07
161*1da177e4SLinus Torvalds #define MIDI_CTL_MSB_BALANCE          	0x08
162*1da177e4SLinus Torvalds #define MIDI_CTL_MSB_PAN              	0x0a
163*1da177e4SLinus Torvalds #define MIDI_CTL_MSB_EXPRESSION       	0x0b
164*1da177e4SLinus Torvalds #define MIDI_CTL_MSB_EFFECT1		0x0c
165*1da177e4SLinus Torvalds #define MIDI_CTL_MSB_EFFECT2		0x0d
166*1da177e4SLinus Torvalds #define MIDI_CTL_MSB_GENERAL_PURPOSE1 	0x10
167*1da177e4SLinus Torvalds #define MIDI_CTL_MSB_GENERAL_PURPOSE2 	0x11
168*1da177e4SLinus Torvalds #define MIDI_CTL_MSB_GENERAL_PURPOSE3 	0x12
169*1da177e4SLinus Torvalds #define MIDI_CTL_MSB_GENERAL_PURPOSE4 	0x13
170*1da177e4SLinus Torvalds #define MIDI_CTL_LSB_BANK		0x20
171*1da177e4SLinus Torvalds #define MIDI_CTL_LSB_MODWHEEL        	0x21
172*1da177e4SLinus Torvalds #define MIDI_CTL_LSB_BREATH           	0x22
173*1da177e4SLinus Torvalds #define MIDI_CTL_LSB_FOOT             	0x24
174*1da177e4SLinus Torvalds #define MIDI_CTL_LSB_PORTAMENTO_TIME 	0x25
175*1da177e4SLinus Torvalds #define MIDI_CTL_LSB_DATA_ENTRY		0x26
176*1da177e4SLinus Torvalds #define MIDI_CTL_LSB_MAIN_VOLUME      	0x27
177*1da177e4SLinus Torvalds #define MIDI_CTL_LSB_BALANCE          	0x28
178*1da177e4SLinus Torvalds #define MIDI_CTL_LSB_PAN              	0x2a
179*1da177e4SLinus Torvalds #define MIDI_CTL_LSB_EXPRESSION       	0x2b
180*1da177e4SLinus Torvalds #define MIDI_CTL_LSB_EFFECT1		0x2c
181*1da177e4SLinus Torvalds #define MIDI_CTL_LSB_EFFECT2		0x2d
182*1da177e4SLinus Torvalds #define MIDI_CTL_LSB_GENERAL_PURPOSE1 	0x30
183*1da177e4SLinus Torvalds #define MIDI_CTL_LSB_GENERAL_PURPOSE2 	0x31
184*1da177e4SLinus Torvalds #define MIDI_CTL_LSB_GENERAL_PURPOSE3 	0x32
185*1da177e4SLinus Torvalds #define MIDI_CTL_LSB_GENERAL_PURPOSE4 	0x33
186*1da177e4SLinus Torvalds #define MIDI_CTL_SUSTAIN              	0x40
187*1da177e4SLinus Torvalds #define MIDI_CTL_PORTAMENTO           	0x41
188*1da177e4SLinus Torvalds #define MIDI_CTL_SOSTENUTO            	0x42
189*1da177e4SLinus Torvalds #define MIDI_CTL_SOFT_PEDAL           	0x43
190*1da177e4SLinus Torvalds #define MIDI_CTL_LEGATO_FOOTSWITCH	0x44
191*1da177e4SLinus Torvalds #define MIDI_CTL_HOLD2                	0x45
192*1da177e4SLinus Torvalds #define MIDI_CTL_SC1_SOUND_VARIATION	0x46
193*1da177e4SLinus Torvalds #define MIDI_CTL_SC2_TIMBRE		0x47
194*1da177e4SLinus Torvalds #define MIDI_CTL_SC3_RELEASE_TIME	0x48
195*1da177e4SLinus Torvalds #define MIDI_CTL_SC4_ATTACK_TIME	0x49
196*1da177e4SLinus Torvalds #define MIDI_CTL_SC5_BRIGHTNESS		0x4a
197*1da177e4SLinus Torvalds #define MIDI_CTL_SC6			0x4b
198*1da177e4SLinus Torvalds #define MIDI_CTL_SC7			0x4c
199*1da177e4SLinus Torvalds #define MIDI_CTL_SC8			0x4d
200*1da177e4SLinus Torvalds #define MIDI_CTL_SC9			0x4e
201*1da177e4SLinus Torvalds #define MIDI_CTL_SC10			0x4f
202*1da177e4SLinus Torvalds #define MIDI_CTL_GENERAL_PURPOSE5     	0x50
203*1da177e4SLinus Torvalds #define MIDI_CTL_GENERAL_PURPOSE6     	0x51
204*1da177e4SLinus Torvalds #define MIDI_CTL_GENERAL_PURPOSE7     	0x52
205*1da177e4SLinus Torvalds #define MIDI_CTL_GENERAL_PURPOSE8     	0x53
206*1da177e4SLinus Torvalds #define MIDI_CTL_PORTAMENTO_CONTROL	0x54
207*1da177e4SLinus Torvalds #define MIDI_CTL_E1_REVERB_DEPTH	0x5b
208*1da177e4SLinus Torvalds #define MIDI_CTL_E2_TREMOLO_DEPTH	0x5c
209*1da177e4SLinus Torvalds #define MIDI_CTL_E3_CHORUS_DEPTH	0x5d
210*1da177e4SLinus Torvalds #define MIDI_CTL_E4_DETUNE_DEPTH	0x5e
211*1da177e4SLinus Torvalds #define MIDI_CTL_E5_PHASER_DEPTH	0x5f
212*1da177e4SLinus Torvalds #define MIDI_CTL_DATA_INCREMENT       	0x60
213*1da177e4SLinus Torvalds #define MIDI_CTL_DATA_DECREMENT       	0x61
214*1da177e4SLinus Torvalds #define MIDI_CTL_NONREG_PARM_NUM_LSB  	0x62
215*1da177e4SLinus Torvalds #define MIDI_CTL_NONREG_PARM_NUM_MSB  	0x63
216*1da177e4SLinus Torvalds #define MIDI_CTL_REGIST_PARM_NUM_LSB  	0x64
217*1da177e4SLinus Torvalds #define MIDI_CTL_REGIST_PARM_NUM_MSB	0x65
218*1da177e4SLinus Torvalds #define MIDI_CTL_ALL_SOUNDS_OFF		0x78
219*1da177e4SLinus Torvalds #define MIDI_CTL_RESET_CONTROLLERS	0x79
220*1da177e4SLinus Torvalds #define MIDI_CTL_LOCAL_CONTROL_SWITCH	0x7a
221*1da177e4SLinus Torvalds #define MIDI_CTL_ALL_NOTES_OFF		0x7b
222*1da177e4SLinus Torvalds #define MIDI_CTL_OMNI_OFF		0x7c
223*1da177e4SLinus Torvalds #define MIDI_CTL_OMNI_ON		0x7d
224*1da177e4SLinus Torvalds #define MIDI_CTL_MONO1			0x7e
225*1da177e4SLinus Torvalds #define MIDI_CTL_MONO2			0x7f
226*1da177e4SLinus Torvalds 
227*1da177e4SLinus Torvalds #endif /* __SOUND_ASOUNDEF_H */
228