1 /* 2 * Advanced Linux Sound Architecture - ALSA - Driver 3 * Copyright (c) 1994-2003 by Jaroslav Kysela <perex@perex.cz>, 4 * Abramo Bagnara <abramo@alsa-project.org> 5 * 6 * 7 * This program is free software; you can redistribute it and/or modify 8 * it under the terms of the GNU General Public License as published by 9 * the Free Software Foundation; either version 2 of the License, or 10 * (at your option) any later version. 11 * 12 * This program is distributed in the hope that it will be useful, 13 * but WITHOUT ANY WARRANTY; without even the implied warranty of 14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 * GNU General Public License for more details. 16 * 17 * You should have received a copy of the GNU General Public License 18 * along with this program; if not, write to the Free Software 19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 20 * 21 */ 22 23 #ifndef _UAPI__SOUND_ASOUND_H 24 #define _UAPI__SOUND_ASOUND_H 25 26 #include <linux/types.h> 27 28 29 /* 30 * protocol version 31 */ 32 33 #define SNDRV_PROTOCOL_VERSION(major, minor, subminor) (((major)<<16)|((minor)<<8)|(subminor)) 34 #define SNDRV_PROTOCOL_MAJOR(version) (((version)>>16)&0xffff) 35 #define SNDRV_PROTOCOL_MINOR(version) (((version)>>8)&0xff) 36 #define SNDRV_PROTOCOL_MICRO(version) ((version)&0xff) 37 #define SNDRV_PROTOCOL_INCOMPATIBLE(kversion, uversion) \ 38 (SNDRV_PROTOCOL_MAJOR(kversion) != SNDRV_PROTOCOL_MAJOR(uversion) || \ 39 (SNDRV_PROTOCOL_MAJOR(kversion) == SNDRV_PROTOCOL_MAJOR(uversion) && \ 40 SNDRV_PROTOCOL_MINOR(kversion) != SNDRV_PROTOCOL_MINOR(uversion))) 41 42 /**************************************************************************** 43 * * 44 * Digital audio interface * 45 * * 46 ****************************************************************************/ 47 48 struct snd_aes_iec958 { 49 unsigned char status[24]; /* AES/IEC958 channel status bits */ 50 unsigned char subcode[147]; /* AES/IEC958 subcode bits */ 51 unsigned char pad; /* nothing */ 52 unsigned char dig_subframe[4]; /* AES/IEC958 subframe bits */ 53 }; 54 55 /**************************************************************************** 56 * * 57 * CEA-861 Audio InfoFrame. Used in HDMI and DisplayPort * 58 * * 59 ****************************************************************************/ 60 61 struct snd_cea_861_aud_if { 62 unsigned char db1_ct_cc; /* coding type and channel count */ 63 unsigned char db2_sf_ss; /* sample frequency and size */ 64 unsigned char db3; /* not used, all zeros */ 65 unsigned char db4_ca; /* channel allocation code */ 66 unsigned char db5_dminh_lsv; /* downmix inhibit & level-shit values */ 67 }; 68 69 /**************************************************************************** 70 * * 71 * Section for driver hardware dependent interface - /dev/snd/hw? * 72 * * 73 ****************************************************************************/ 74 75 #define SNDRV_HWDEP_VERSION SNDRV_PROTOCOL_VERSION(1, 0, 1) 76 77 enum { 78 SNDRV_HWDEP_IFACE_OPL2 = 0, 79 SNDRV_HWDEP_IFACE_OPL3, 80 SNDRV_HWDEP_IFACE_OPL4, 81 SNDRV_HWDEP_IFACE_SB16CSP, /* Creative Signal Processor */ 82 SNDRV_HWDEP_IFACE_EMU10K1, /* FX8010 processor in EMU10K1 chip */ 83 SNDRV_HWDEP_IFACE_YSS225, /* Yamaha FX processor */ 84 SNDRV_HWDEP_IFACE_ICS2115, /* Wavetable synth */ 85 SNDRV_HWDEP_IFACE_SSCAPE, /* Ensoniq SoundScape ISA card (MC68EC000) */ 86 SNDRV_HWDEP_IFACE_VX, /* Digigram VX cards */ 87 SNDRV_HWDEP_IFACE_MIXART, /* Digigram miXart cards */ 88 SNDRV_HWDEP_IFACE_USX2Y, /* Tascam US122, US224 & US428 usb */ 89 SNDRV_HWDEP_IFACE_EMUX_WAVETABLE, /* EmuX wavetable */ 90 SNDRV_HWDEP_IFACE_BLUETOOTH, /* Bluetooth audio */ 91 SNDRV_HWDEP_IFACE_USX2Y_PCM, /* Tascam US122, US224 & US428 rawusb pcm */ 92 SNDRV_HWDEP_IFACE_PCXHR, /* Digigram PCXHR */ 93 SNDRV_HWDEP_IFACE_SB_RC, /* SB Extigy/Audigy2NX remote control */ 94 SNDRV_HWDEP_IFACE_HDA, /* HD-audio */ 95 SNDRV_HWDEP_IFACE_USB_STREAM, /* direct access to usb stream */ 96 SNDRV_HWDEP_IFACE_FW_DICE, /* TC DICE FireWire device */ 97 SNDRV_HWDEP_IFACE_FW_FIREWORKS, /* Echo Audio Fireworks based device */ 98 SNDRV_HWDEP_IFACE_FW_BEBOB, /* BridgeCo BeBoB based device */ 99 100 /* Don't forget to change the following: */ 101 SNDRV_HWDEP_IFACE_LAST = SNDRV_HWDEP_IFACE_FW_BEBOB 102 }; 103 104 struct snd_hwdep_info { 105 unsigned int device; /* WR: device number */ 106 int card; /* R: card number */ 107 unsigned char id[64]; /* ID (user selectable) */ 108 unsigned char name[80]; /* hwdep name */ 109 int iface; /* hwdep interface */ 110 unsigned char reserved[64]; /* reserved for future */ 111 }; 112 113 /* generic DSP loader */ 114 struct snd_hwdep_dsp_status { 115 unsigned int version; /* R: driver-specific version */ 116 unsigned char id[32]; /* R: driver-specific ID string */ 117 unsigned int num_dsps; /* R: number of DSP images to transfer */ 118 unsigned int dsp_loaded; /* R: bit flags indicating the loaded DSPs */ 119 unsigned int chip_ready; /* R: 1 = initialization finished */ 120 unsigned char reserved[16]; /* reserved for future use */ 121 }; 122 123 struct snd_hwdep_dsp_image { 124 unsigned int index; /* W: DSP index */ 125 unsigned char name[64]; /* W: ID (e.g. file name) */ 126 unsigned char __user *image; /* W: binary image */ 127 size_t length; /* W: size of image in bytes */ 128 unsigned long driver_data; /* W: driver-specific data */ 129 }; 130 131 #define SNDRV_HWDEP_IOCTL_PVERSION _IOR ('H', 0x00, int) 132 #define SNDRV_HWDEP_IOCTL_INFO _IOR ('H', 0x01, struct snd_hwdep_info) 133 #define SNDRV_HWDEP_IOCTL_DSP_STATUS _IOR('H', 0x02, struct snd_hwdep_dsp_status) 134 #define SNDRV_HWDEP_IOCTL_DSP_LOAD _IOW('H', 0x03, struct snd_hwdep_dsp_image) 135 136 /***************************************************************************** 137 * * 138 * Digital Audio (PCM) interface - /dev/snd/pcm?? * 139 * * 140 *****************************************************************************/ 141 142 #define SNDRV_PCM_VERSION SNDRV_PROTOCOL_VERSION(2, 0, 12) 143 144 typedef unsigned long snd_pcm_uframes_t; 145 typedef signed long snd_pcm_sframes_t; 146 147 enum { 148 SNDRV_PCM_CLASS_GENERIC = 0, /* standard mono or stereo device */ 149 SNDRV_PCM_CLASS_MULTI, /* multichannel device */ 150 SNDRV_PCM_CLASS_MODEM, /* software modem class */ 151 SNDRV_PCM_CLASS_DIGITIZER, /* digitizer class */ 152 /* Don't forget to change the following: */ 153 SNDRV_PCM_CLASS_LAST = SNDRV_PCM_CLASS_DIGITIZER, 154 }; 155 156 enum { 157 SNDRV_PCM_SUBCLASS_GENERIC_MIX = 0, /* mono or stereo subdevices are mixed together */ 158 SNDRV_PCM_SUBCLASS_MULTI_MIX, /* multichannel subdevices are mixed together */ 159 /* Don't forget to change the following: */ 160 SNDRV_PCM_SUBCLASS_LAST = SNDRV_PCM_SUBCLASS_MULTI_MIX, 161 }; 162 163 enum { 164 SNDRV_PCM_STREAM_PLAYBACK = 0, 165 SNDRV_PCM_STREAM_CAPTURE, 166 SNDRV_PCM_STREAM_LAST = SNDRV_PCM_STREAM_CAPTURE, 167 }; 168 169 typedef int __bitwise snd_pcm_access_t; 170 #define SNDRV_PCM_ACCESS_MMAP_INTERLEAVED ((__force snd_pcm_access_t) 0) /* interleaved mmap */ 171 #define SNDRV_PCM_ACCESS_MMAP_NONINTERLEAVED ((__force snd_pcm_access_t) 1) /* noninterleaved mmap */ 172 #define SNDRV_PCM_ACCESS_MMAP_COMPLEX ((__force snd_pcm_access_t) 2) /* complex mmap */ 173 #define SNDRV_PCM_ACCESS_RW_INTERLEAVED ((__force snd_pcm_access_t) 3) /* readi/writei */ 174 #define SNDRV_PCM_ACCESS_RW_NONINTERLEAVED ((__force snd_pcm_access_t) 4) /* readn/writen */ 175 #define SNDRV_PCM_ACCESS_LAST SNDRV_PCM_ACCESS_RW_NONINTERLEAVED 176 177 typedef int __bitwise snd_pcm_format_t; 178 #define SNDRV_PCM_FORMAT_S8 ((__force snd_pcm_format_t) 0) 179 #define SNDRV_PCM_FORMAT_U8 ((__force snd_pcm_format_t) 1) 180 #define SNDRV_PCM_FORMAT_S16_LE ((__force snd_pcm_format_t) 2) 181 #define SNDRV_PCM_FORMAT_S16_BE ((__force snd_pcm_format_t) 3) 182 #define SNDRV_PCM_FORMAT_U16_LE ((__force snd_pcm_format_t) 4) 183 #define SNDRV_PCM_FORMAT_U16_BE ((__force snd_pcm_format_t) 5) 184 #define SNDRV_PCM_FORMAT_S24_LE ((__force snd_pcm_format_t) 6) /* low three bytes */ 185 #define SNDRV_PCM_FORMAT_S24_BE ((__force snd_pcm_format_t) 7) /* low three bytes */ 186 #define SNDRV_PCM_FORMAT_U24_LE ((__force snd_pcm_format_t) 8) /* low three bytes */ 187 #define SNDRV_PCM_FORMAT_U24_BE ((__force snd_pcm_format_t) 9) /* low three bytes */ 188 #define SNDRV_PCM_FORMAT_S32_LE ((__force snd_pcm_format_t) 10) 189 #define SNDRV_PCM_FORMAT_S32_BE ((__force snd_pcm_format_t) 11) 190 #define SNDRV_PCM_FORMAT_U32_LE ((__force snd_pcm_format_t) 12) 191 #define SNDRV_PCM_FORMAT_U32_BE ((__force snd_pcm_format_t) 13) 192 #define SNDRV_PCM_FORMAT_FLOAT_LE ((__force snd_pcm_format_t) 14) /* 4-byte float, IEEE-754 32-bit, range -1.0 to 1.0 */ 193 #define SNDRV_PCM_FORMAT_FLOAT_BE ((__force snd_pcm_format_t) 15) /* 4-byte float, IEEE-754 32-bit, range -1.0 to 1.0 */ 194 #define SNDRV_PCM_FORMAT_FLOAT64_LE ((__force snd_pcm_format_t) 16) /* 8-byte float, IEEE-754 64-bit, range -1.0 to 1.0 */ 195 #define SNDRV_PCM_FORMAT_FLOAT64_BE ((__force snd_pcm_format_t) 17) /* 8-byte float, IEEE-754 64-bit, range -1.0 to 1.0 */ 196 #define SNDRV_PCM_FORMAT_IEC958_SUBFRAME_LE ((__force snd_pcm_format_t) 18) /* IEC-958 subframe, Little Endian */ 197 #define SNDRV_PCM_FORMAT_IEC958_SUBFRAME_BE ((__force snd_pcm_format_t) 19) /* IEC-958 subframe, Big Endian */ 198 #define SNDRV_PCM_FORMAT_MU_LAW ((__force snd_pcm_format_t) 20) 199 #define SNDRV_PCM_FORMAT_A_LAW ((__force snd_pcm_format_t) 21) 200 #define SNDRV_PCM_FORMAT_IMA_ADPCM ((__force snd_pcm_format_t) 22) 201 #define SNDRV_PCM_FORMAT_MPEG ((__force snd_pcm_format_t) 23) 202 #define SNDRV_PCM_FORMAT_GSM ((__force snd_pcm_format_t) 24) 203 #define SNDRV_PCM_FORMAT_SPECIAL ((__force snd_pcm_format_t) 31) 204 #define SNDRV_PCM_FORMAT_S24_3LE ((__force snd_pcm_format_t) 32) /* in three bytes */ 205 #define SNDRV_PCM_FORMAT_S24_3BE ((__force snd_pcm_format_t) 33) /* in three bytes */ 206 #define SNDRV_PCM_FORMAT_U24_3LE ((__force snd_pcm_format_t) 34) /* in three bytes */ 207 #define SNDRV_PCM_FORMAT_U24_3BE ((__force snd_pcm_format_t) 35) /* in three bytes */ 208 #define SNDRV_PCM_FORMAT_S20_3LE ((__force snd_pcm_format_t) 36) /* in three bytes */ 209 #define SNDRV_PCM_FORMAT_S20_3BE ((__force snd_pcm_format_t) 37) /* in three bytes */ 210 #define SNDRV_PCM_FORMAT_U20_3LE ((__force snd_pcm_format_t) 38) /* in three bytes */ 211 #define SNDRV_PCM_FORMAT_U20_3BE ((__force snd_pcm_format_t) 39) /* in three bytes */ 212 #define SNDRV_PCM_FORMAT_S18_3LE ((__force snd_pcm_format_t) 40) /* in three bytes */ 213 #define SNDRV_PCM_FORMAT_S18_3BE ((__force snd_pcm_format_t) 41) /* in three bytes */ 214 #define SNDRV_PCM_FORMAT_U18_3LE ((__force snd_pcm_format_t) 42) /* in three bytes */ 215 #define SNDRV_PCM_FORMAT_U18_3BE ((__force snd_pcm_format_t) 43) /* in three bytes */ 216 #define SNDRV_PCM_FORMAT_G723_24 ((__force snd_pcm_format_t) 44) /* 8 samples in 3 bytes */ 217 #define SNDRV_PCM_FORMAT_G723_24_1B ((__force snd_pcm_format_t) 45) /* 1 sample in 1 byte */ 218 #define SNDRV_PCM_FORMAT_G723_40 ((__force snd_pcm_format_t) 46) /* 8 Samples in 5 bytes */ 219 #define SNDRV_PCM_FORMAT_G723_40_1B ((__force snd_pcm_format_t) 47) /* 1 sample in 1 byte */ 220 #define SNDRV_PCM_FORMAT_DSD_U8 ((__force snd_pcm_format_t) 48) /* DSD, 1-byte samples DSD (x8) */ 221 #define SNDRV_PCM_FORMAT_DSD_U16_LE ((__force snd_pcm_format_t) 49) /* DSD, 2-byte samples DSD (x16), little endian */ 222 #define SNDRV_PCM_FORMAT_DSD_U32_LE ((__force snd_pcm_format_t) 50) /* DSD, 4-byte samples DSD (x32), little endian */ 223 #define SNDRV_PCM_FORMAT_LAST SNDRV_PCM_FORMAT_DSD_U32_LE 224 225 #ifdef SNDRV_LITTLE_ENDIAN 226 #define SNDRV_PCM_FORMAT_S16 SNDRV_PCM_FORMAT_S16_LE 227 #define SNDRV_PCM_FORMAT_U16 SNDRV_PCM_FORMAT_U16_LE 228 #define SNDRV_PCM_FORMAT_S24 SNDRV_PCM_FORMAT_S24_LE 229 #define SNDRV_PCM_FORMAT_U24 SNDRV_PCM_FORMAT_U24_LE 230 #define SNDRV_PCM_FORMAT_S32 SNDRV_PCM_FORMAT_S32_LE 231 #define SNDRV_PCM_FORMAT_U32 SNDRV_PCM_FORMAT_U32_LE 232 #define SNDRV_PCM_FORMAT_FLOAT SNDRV_PCM_FORMAT_FLOAT_LE 233 #define SNDRV_PCM_FORMAT_FLOAT64 SNDRV_PCM_FORMAT_FLOAT64_LE 234 #define SNDRV_PCM_FORMAT_IEC958_SUBFRAME SNDRV_PCM_FORMAT_IEC958_SUBFRAME_LE 235 #endif 236 #ifdef SNDRV_BIG_ENDIAN 237 #define SNDRV_PCM_FORMAT_S16 SNDRV_PCM_FORMAT_S16_BE 238 #define SNDRV_PCM_FORMAT_U16 SNDRV_PCM_FORMAT_U16_BE 239 #define SNDRV_PCM_FORMAT_S24 SNDRV_PCM_FORMAT_S24_BE 240 #define SNDRV_PCM_FORMAT_U24 SNDRV_PCM_FORMAT_U24_BE 241 #define SNDRV_PCM_FORMAT_S32 SNDRV_PCM_FORMAT_S32_BE 242 #define SNDRV_PCM_FORMAT_U32 SNDRV_PCM_FORMAT_U32_BE 243 #define SNDRV_PCM_FORMAT_FLOAT SNDRV_PCM_FORMAT_FLOAT_BE 244 #define SNDRV_PCM_FORMAT_FLOAT64 SNDRV_PCM_FORMAT_FLOAT64_BE 245 #define SNDRV_PCM_FORMAT_IEC958_SUBFRAME SNDRV_PCM_FORMAT_IEC958_SUBFRAME_BE 246 #endif 247 248 typedef int __bitwise snd_pcm_subformat_t; 249 #define SNDRV_PCM_SUBFORMAT_STD ((__force snd_pcm_subformat_t) 0) 250 #define SNDRV_PCM_SUBFORMAT_LAST SNDRV_PCM_SUBFORMAT_STD 251 252 #define SNDRV_PCM_INFO_MMAP 0x00000001 /* hardware supports mmap */ 253 #define SNDRV_PCM_INFO_MMAP_VALID 0x00000002 /* period data are valid during transfer */ 254 #define SNDRV_PCM_INFO_DOUBLE 0x00000004 /* Double buffering needed for PCM start/stop */ 255 #define SNDRV_PCM_INFO_BATCH 0x00000010 /* double buffering */ 256 #define SNDRV_PCM_INFO_INTERLEAVED 0x00000100 /* channels are interleaved */ 257 #define SNDRV_PCM_INFO_NONINTERLEAVED 0x00000200 /* channels are not interleaved */ 258 #define SNDRV_PCM_INFO_COMPLEX 0x00000400 /* complex frame organization (mmap only) */ 259 #define SNDRV_PCM_INFO_BLOCK_TRANSFER 0x00010000 /* hardware transfer block of samples */ 260 #define SNDRV_PCM_INFO_OVERRANGE 0x00020000 /* hardware supports ADC (capture) overrange detection */ 261 #define SNDRV_PCM_INFO_RESUME 0x00040000 /* hardware supports stream resume after suspend */ 262 #define SNDRV_PCM_INFO_PAUSE 0x00080000 /* pause ioctl is supported */ 263 #define SNDRV_PCM_INFO_HALF_DUPLEX 0x00100000 /* only half duplex */ 264 #define SNDRV_PCM_INFO_JOINT_DUPLEX 0x00200000 /* playback and capture stream are somewhat correlated */ 265 #define SNDRV_PCM_INFO_SYNC_START 0x00400000 /* pcm support some kind of sync go */ 266 #define SNDRV_PCM_INFO_NO_PERIOD_WAKEUP 0x00800000 /* period wakeup can be disabled */ 267 #define SNDRV_PCM_INFO_HAS_WALL_CLOCK 0x01000000 /* has audio wall clock for audio/system time sync */ 268 #define SNDRV_PCM_INFO_FIFO_IN_FRAMES 0x80000000 /* internal kernel flag - FIFO size is in frames */ 269 270 typedef int __bitwise snd_pcm_state_t; 271 #define SNDRV_PCM_STATE_OPEN ((__force snd_pcm_state_t) 0) /* stream is open */ 272 #define SNDRV_PCM_STATE_SETUP ((__force snd_pcm_state_t) 1) /* stream has a setup */ 273 #define SNDRV_PCM_STATE_PREPARED ((__force snd_pcm_state_t) 2) /* stream is ready to start */ 274 #define SNDRV_PCM_STATE_RUNNING ((__force snd_pcm_state_t) 3) /* stream is running */ 275 #define SNDRV_PCM_STATE_XRUN ((__force snd_pcm_state_t) 4) /* stream reached an xrun */ 276 #define SNDRV_PCM_STATE_DRAINING ((__force snd_pcm_state_t) 5) /* stream is draining */ 277 #define SNDRV_PCM_STATE_PAUSED ((__force snd_pcm_state_t) 6) /* stream is paused */ 278 #define SNDRV_PCM_STATE_SUSPENDED ((__force snd_pcm_state_t) 7) /* hardware is suspended */ 279 #define SNDRV_PCM_STATE_DISCONNECTED ((__force snd_pcm_state_t) 8) /* hardware is disconnected */ 280 #define SNDRV_PCM_STATE_LAST SNDRV_PCM_STATE_DISCONNECTED 281 282 enum { 283 SNDRV_PCM_MMAP_OFFSET_DATA = 0x00000000, 284 SNDRV_PCM_MMAP_OFFSET_STATUS = 0x80000000, 285 SNDRV_PCM_MMAP_OFFSET_CONTROL = 0x81000000, 286 }; 287 288 union snd_pcm_sync_id { 289 unsigned char id[16]; 290 unsigned short id16[8]; 291 unsigned int id32[4]; 292 }; 293 294 struct snd_pcm_info { 295 unsigned int device; /* RO/WR (control): device number */ 296 unsigned int subdevice; /* RO/WR (control): subdevice number */ 297 int stream; /* RO/WR (control): stream direction */ 298 int card; /* R: card number */ 299 unsigned char id[64]; /* ID (user selectable) */ 300 unsigned char name[80]; /* name of this device */ 301 unsigned char subname[32]; /* subdevice name */ 302 int dev_class; /* SNDRV_PCM_CLASS_* */ 303 int dev_subclass; /* SNDRV_PCM_SUBCLASS_* */ 304 unsigned int subdevices_count; 305 unsigned int subdevices_avail; 306 union snd_pcm_sync_id sync; /* hardware synchronization ID */ 307 unsigned char reserved[64]; /* reserved for future... */ 308 }; 309 310 typedef int snd_pcm_hw_param_t; 311 #define SNDRV_PCM_HW_PARAM_ACCESS 0 /* Access type */ 312 #define SNDRV_PCM_HW_PARAM_FORMAT 1 /* Format */ 313 #define SNDRV_PCM_HW_PARAM_SUBFORMAT 2 /* Subformat */ 314 #define SNDRV_PCM_HW_PARAM_FIRST_MASK SNDRV_PCM_HW_PARAM_ACCESS 315 #define SNDRV_PCM_HW_PARAM_LAST_MASK SNDRV_PCM_HW_PARAM_SUBFORMAT 316 317 #define SNDRV_PCM_HW_PARAM_SAMPLE_BITS 8 /* Bits per sample */ 318 #define SNDRV_PCM_HW_PARAM_FRAME_BITS 9 /* Bits per frame */ 319 #define SNDRV_PCM_HW_PARAM_CHANNELS 10 /* Channels */ 320 #define SNDRV_PCM_HW_PARAM_RATE 11 /* Approx rate */ 321 #define SNDRV_PCM_HW_PARAM_PERIOD_TIME 12 /* Approx distance between 322 * interrupts in us 323 */ 324 #define SNDRV_PCM_HW_PARAM_PERIOD_SIZE 13 /* Approx frames between 325 * interrupts 326 */ 327 #define SNDRV_PCM_HW_PARAM_PERIOD_BYTES 14 /* Approx bytes between 328 * interrupts 329 */ 330 #define SNDRV_PCM_HW_PARAM_PERIODS 15 /* Approx interrupts per 331 * buffer 332 */ 333 #define SNDRV_PCM_HW_PARAM_BUFFER_TIME 16 /* Approx duration of buffer 334 * in us 335 */ 336 #define SNDRV_PCM_HW_PARAM_BUFFER_SIZE 17 /* Size of buffer in frames */ 337 #define SNDRV_PCM_HW_PARAM_BUFFER_BYTES 18 /* Size of buffer in bytes */ 338 #define SNDRV_PCM_HW_PARAM_TICK_TIME 19 /* Approx tick duration in us */ 339 #define SNDRV_PCM_HW_PARAM_FIRST_INTERVAL SNDRV_PCM_HW_PARAM_SAMPLE_BITS 340 #define SNDRV_PCM_HW_PARAM_LAST_INTERVAL SNDRV_PCM_HW_PARAM_TICK_TIME 341 342 #define SNDRV_PCM_HW_PARAMS_NORESAMPLE (1<<0) /* avoid rate resampling */ 343 #define SNDRV_PCM_HW_PARAMS_EXPORT_BUFFER (1<<1) /* export buffer */ 344 #define SNDRV_PCM_HW_PARAMS_NO_PERIOD_WAKEUP (1<<2) /* disable period wakeups */ 345 346 struct snd_interval { 347 unsigned int min, max; 348 unsigned int openmin:1, 349 openmax:1, 350 integer:1, 351 empty:1; 352 }; 353 354 #define SNDRV_MASK_MAX 256 355 356 struct snd_mask { 357 __u32 bits[(SNDRV_MASK_MAX+31)/32]; 358 }; 359 360 struct snd_pcm_hw_params { 361 unsigned int flags; 362 struct snd_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK - 363 SNDRV_PCM_HW_PARAM_FIRST_MASK + 1]; 364 struct snd_mask mres[5]; /* reserved masks */ 365 struct snd_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL - 366 SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1]; 367 struct snd_interval ires[9]; /* reserved intervals */ 368 unsigned int rmask; /* W: requested masks */ 369 unsigned int cmask; /* R: changed masks */ 370 unsigned int info; /* R: Info flags for returned setup */ 371 unsigned int msbits; /* R: used most significant bits */ 372 unsigned int rate_num; /* R: rate numerator */ 373 unsigned int rate_den; /* R: rate denominator */ 374 snd_pcm_uframes_t fifo_size; /* R: chip FIFO size in frames */ 375 unsigned char reserved[64]; /* reserved for future */ 376 }; 377 378 enum { 379 SNDRV_PCM_TSTAMP_NONE = 0, 380 SNDRV_PCM_TSTAMP_ENABLE, 381 SNDRV_PCM_TSTAMP_LAST = SNDRV_PCM_TSTAMP_ENABLE, 382 }; 383 384 struct snd_pcm_sw_params { 385 int tstamp_mode; /* timestamp mode */ 386 unsigned int period_step; 387 unsigned int sleep_min; /* min ticks to sleep */ 388 snd_pcm_uframes_t avail_min; /* min avail frames for wakeup */ 389 snd_pcm_uframes_t xfer_align; /* obsolete: xfer size need to be a multiple */ 390 snd_pcm_uframes_t start_threshold; /* min hw_avail frames for automatic start */ 391 snd_pcm_uframes_t stop_threshold; /* min avail frames for automatic stop */ 392 snd_pcm_uframes_t silence_threshold; /* min distance from noise for silence filling */ 393 snd_pcm_uframes_t silence_size; /* silence block size */ 394 snd_pcm_uframes_t boundary; /* pointers wrap point */ 395 unsigned int proto; /* protocol version */ 396 unsigned int tstamp_type; /* timestamp type (req. proto >= 2.0.12) */ 397 unsigned char reserved[56]; /* reserved for future */ 398 }; 399 400 struct snd_pcm_channel_info { 401 unsigned int channel; 402 __kernel_off_t offset; /* mmap offset */ 403 unsigned int first; /* offset to first sample in bits */ 404 unsigned int step; /* samples distance in bits */ 405 }; 406 407 struct snd_pcm_status { 408 snd_pcm_state_t state; /* stream state */ 409 struct timespec trigger_tstamp; /* time when stream was started/stopped/paused */ 410 struct timespec tstamp; /* reference timestamp */ 411 snd_pcm_uframes_t appl_ptr; /* appl ptr */ 412 snd_pcm_uframes_t hw_ptr; /* hw ptr */ 413 snd_pcm_sframes_t delay; /* current delay in frames */ 414 snd_pcm_uframes_t avail; /* number of frames available */ 415 snd_pcm_uframes_t avail_max; /* max frames available on hw since last status */ 416 snd_pcm_uframes_t overrange; /* count of ADC (capture) overrange detections from last status */ 417 snd_pcm_state_t suspended_state; /* suspended stream state */ 418 __u32 reserved_alignment; /* must be filled with zero */ 419 struct timespec audio_tstamp; /* from sample counter or wall clock */ 420 unsigned char reserved[56-sizeof(struct timespec)]; /* must be filled with zero */ 421 }; 422 423 struct snd_pcm_mmap_status { 424 snd_pcm_state_t state; /* RO: state - SNDRV_PCM_STATE_XXXX */ 425 int pad1; /* Needed for 64 bit alignment */ 426 snd_pcm_uframes_t hw_ptr; /* RO: hw ptr (0...boundary-1) */ 427 struct timespec tstamp; /* Timestamp */ 428 snd_pcm_state_t suspended_state; /* RO: suspended stream state */ 429 struct timespec audio_tstamp; /* from sample counter or wall clock */ 430 }; 431 432 struct snd_pcm_mmap_control { 433 snd_pcm_uframes_t appl_ptr; /* RW: appl ptr (0...boundary-1) */ 434 snd_pcm_uframes_t avail_min; /* RW: min available frames for wakeup */ 435 }; 436 437 #define SNDRV_PCM_SYNC_PTR_HWSYNC (1<<0) /* execute hwsync */ 438 #define SNDRV_PCM_SYNC_PTR_APPL (1<<1) /* get appl_ptr from driver (r/w op) */ 439 #define SNDRV_PCM_SYNC_PTR_AVAIL_MIN (1<<2) /* get avail_min from driver */ 440 441 struct snd_pcm_sync_ptr { 442 unsigned int flags; 443 union { 444 struct snd_pcm_mmap_status status; 445 unsigned char reserved[64]; 446 } s; 447 union { 448 struct snd_pcm_mmap_control control; 449 unsigned char reserved[64]; 450 } c; 451 }; 452 453 struct snd_xferi { 454 snd_pcm_sframes_t result; 455 void __user *buf; 456 snd_pcm_uframes_t frames; 457 }; 458 459 struct snd_xfern { 460 snd_pcm_sframes_t result; 461 void __user * __user *bufs; 462 snd_pcm_uframes_t frames; 463 }; 464 465 enum { 466 SNDRV_PCM_TSTAMP_TYPE_GETTIMEOFDAY = 0, /* gettimeofday equivalent */ 467 SNDRV_PCM_TSTAMP_TYPE_MONOTONIC, /* posix_clock_monotonic equivalent */ 468 SNDRV_PCM_TSTAMP_TYPE_MONOTONIC_RAW, /* monotonic_raw (no NTP) */ 469 SNDRV_PCM_TSTAMP_TYPE_LAST = SNDRV_PCM_TSTAMP_TYPE_MONOTONIC_RAW, 470 }; 471 472 /* channel positions */ 473 enum { 474 SNDRV_CHMAP_UNKNOWN = 0, 475 SNDRV_CHMAP_NA, /* N/A, silent */ 476 SNDRV_CHMAP_MONO, /* mono stream */ 477 /* this follows the alsa-lib mixer channel value + 3 */ 478 SNDRV_CHMAP_FL, /* front left */ 479 SNDRV_CHMAP_FR, /* front right */ 480 SNDRV_CHMAP_RL, /* rear left */ 481 SNDRV_CHMAP_RR, /* rear right */ 482 SNDRV_CHMAP_FC, /* front center */ 483 SNDRV_CHMAP_LFE, /* LFE */ 484 SNDRV_CHMAP_SL, /* side left */ 485 SNDRV_CHMAP_SR, /* side right */ 486 SNDRV_CHMAP_RC, /* rear center */ 487 /* new definitions */ 488 SNDRV_CHMAP_FLC, /* front left center */ 489 SNDRV_CHMAP_FRC, /* front right center */ 490 SNDRV_CHMAP_RLC, /* rear left center */ 491 SNDRV_CHMAP_RRC, /* rear right center */ 492 SNDRV_CHMAP_FLW, /* front left wide */ 493 SNDRV_CHMAP_FRW, /* front right wide */ 494 SNDRV_CHMAP_FLH, /* front left high */ 495 SNDRV_CHMAP_FCH, /* front center high */ 496 SNDRV_CHMAP_FRH, /* front right high */ 497 SNDRV_CHMAP_TC, /* top center */ 498 SNDRV_CHMAP_TFL, /* top front left */ 499 SNDRV_CHMAP_TFR, /* top front right */ 500 SNDRV_CHMAP_TFC, /* top front center */ 501 SNDRV_CHMAP_TRL, /* top rear left */ 502 SNDRV_CHMAP_TRR, /* top rear right */ 503 SNDRV_CHMAP_TRC, /* top rear center */ 504 /* new definitions for UAC2 */ 505 SNDRV_CHMAP_TFLC, /* top front left center */ 506 SNDRV_CHMAP_TFRC, /* top front right center */ 507 SNDRV_CHMAP_TSL, /* top side left */ 508 SNDRV_CHMAP_TSR, /* top side right */ 509 SNDRV_CHMAP_LLFE, /* left LFE */ 510 SNDRV_CHMAP_RLFE, /* right LFE */ 511 SNDRV_CHMAP_BC, /* bottom center */ 512 SNDRV_CHMAP_BLC, /* bottom left center */ 513 SNDRV_CHMAP_BRC, /* bottom right center */ 514 SNDRV_CHMAP_LAST = SNDRV_CHMAP_BRC, 515 }; 516 517 #define SNDRV_CHMAP_POSITION_MASK 0xffff 518 #define SNDRV_CHMAP_PHASE_INVERSE (0x01 << 16) 519 #define SNDRV_CHMAP_DRIVER_SPEC (0x02 << 16) 520 521 #define SNDRV_PCM_IOCTL_PVERSION _IOR('A', 0x00, int) 522 #define SNDRV_PCM_IOCTL_INFO _IOR('A', 0x01, struct snd_pcm_info) 523 #define SNDRV_PCM_IOCTL_TSTAMP _IOW('A', 0x02, int) 524 #define SNDRV_PCM_IOCTL_TTSTAMP _IOW('A', 0x03, int) 525 #define SNDRV_PCM_IOCTL_HW_REFINE _IOWR('A', 0x10, struct snd_pcm_hw_params) 526 #define SNDRV_PCM_IOCTL_HW_PARAMS _IOWR('A', 0x11, struct snd_pcm_hw_params) 527 #define SNDRV_PCM_IOCTL_HW_FREE _IO('A', 0x12) 528 #define SNDRV_PCM_IOCTL_SW_PARAMS _IOWR('A', 0x13, struct snd_pcm_sw_params) 529 #define SNDRV_PCM_IOCTL_STATUS _IOR('A', 0x20, struct snd_pcm_status) 530 #define SNDRV_PCM_IOCTL_DELAY _IOR('A', 0x21, snd_pcm_sframes_t) 531 #define SNDRV_PCM_IOCTL_HWSYNC _IO('A', 0x22) 532 #define SNDRV_PCM_IOCTL_SYNC_PTR _IOWR('A', 0x23, struct snd_pcm_sync_ptr) 533 #define SNDRV_PCM_IOCTL_CHANNEL_INFO _IOR('A', 0x32, struct snd_pcm_channel_info) 534 #define SNDRV_PCM_IOCTL_PREPARE _IO('A', 0x40) 535 #define SNDRV_PCM_IOCTL_RESET _IO('A', 0x41) 536 #define SNDRV_PCM_IOCTL_START _IO('A', 0x42) 537 #define SNDRV_PCM_IOCTL_DROP _IO('A', 0x43) 538 #define SNDRV_PCM_IOCTL_DRAIN _IO('A', 0x44) 539 #define SNDRV_PCM_IOCTL_PAUSE _IOW('A', 0x45, int) 540 #define SNDRV_PCM_IOCTL_REWIND _IOW('A', 0x46, snd_pcm_uframes_t) 541 #define SNDRV_PCM_IOCTL_RESUME _IO('A', 0x47) 542 #define SNDRV_PCM_IOCTL_XRUN _IO('A', 0x48) 543 #define SNDRV_PCM_IOCTL_FORWARD _IOW('A', 0x49, snd_pcm_uframes_t) 544 #define SNDRV_PCM_IOCTL_WRITEI_FRAMES _IOW('A', 0x50, struct snd_xferi) 545 #define SNDRV_PCM_IOCTL_READI_FRAMES _IOR('A', 0x51, struct snd_xferi) 546 #define SNDRV_PCM_IOCTL_WRITEN_FRAMES _IOW('A', 0x52, struct snd_xfern) 547 #define SNDRV_PCM_IOCTL_READN_FRAMES _IOR('A', 0x53, struct snd_xfern) 548 #define SNDRV_PCM_IOCTL_LINK _IOW('A', 0x60, int) 549 #define SNDRV_PCM_IOCTL_UNLINK _IO('A', 0x61) 550 551 /***************************************************************************** 552 * * 553 * MIDI v1.0 interface * 554 * * 555 *****************************************************************************/ 556 557 /* 558 * Raw MIDI section - /dev/snd/midi?? 559 */ 560 561 #define SNDRV_RAWMIDI_VERSION SNDRV_PROTOCOL_VERSION(2, 0, 0) 562 563 enum { 564 SNDRV_RAWMIDI_STREAM_OUTPUT = 0, 565 SNDRV_RAWMIDI_STREAM_INPUT, 566 SNDRV_RAWMIDI_STREAM_LAST = SNDRV_RAWMIDI_STREAM_INPUT, 567 }; 568 569 #define SNDRV_RAWMIDI_INFO_OUTPUT 0x00000001 570 #define SNDRV_RAWMIDI_INFO_INPUT 0x00000002 571 #define SNDRV_RAWMIDI_INFO_DUPLEX 0x00000004 572 573 struct snd_rawmidi_info { 574 unsigned int device; /* RO/WR (control): device number */ 575 unsigned int subdevice; /* RO/WR (control): subdevice number */ 576 int stream; /* WR: stream */ 577 int card; /* R: card number */ 578 unsigned int flags; /* SNDRV_RAWMIDI_INFO_XXXX */ 579 unsigned char id[64]; /* ID (user selectable) */ 580 unsigned char name[80]; /* name of device */ 581 unsigned char subname[32]; /* name of active or selected subdevice */ 582 unsigned int subdevices_count; 583 unsigned int subdevices_avail; 584 unsigned char reserved[64]; /* reserved for future use */ 585 }; 586 587 struct snd_rawmidi_params { 588 int stream; 589 size_t buffer_size; /* queue size in bytes */ 590 size_t avail_min; /* minimum avail bytes for wakeup */ 591 unsigned int no_active_sensing: 1; /* do not send active sensing byte in close() */ 592 unsigned char reserved[16]; /* reserved for future use */ 593 }; 594 595 struct snd_rawmidi_status { 596 int stream; 597 struct timespec tstamp; /* Timestamp */ 598 size_t avail; /* available bytes */ 599 size_t xruns; /* count of overruns since last status (in bytes) */ 600 unsigned char reserved[16]; /* reserved for future use */ 601 }; 602 603 #define SNDRV_RAWMIDI_IOCTL_PVERSION _IOR('W', 0x00, int) 604 #define SNDRV_RAWMIDI_IOCTL_INFO _IOR('W', 0x01, struct snd_rawmidi_info) 605 #define SNDRV_RAWMIDI_IOCTL_PARAMS _IOWR('W', 0x10, struct snd_rawmidi_params) 606 #define SNDRV_RAWMIDI_IOCTL_STATUS _IOWR('W', 0x20, struct snd_rawmidi_status) 607 #define SNDRV_RAWMIDI_IOCTL_DROP _IOW('W', 0x30, int) 608 #define SNDRV_RAWMIDI_IOCTL_DRAIN _IOW('W', 0x31, int) 609 610 /* 611 * Timer section - /dev/snd/timer 612 */ 613 614 #define SNDRV_TIMER_VERSION SNDRV_PROTOCOL_VERSION(2, 0, 6) 615 616 enum { 617 SNDRV_TIMER_CLASS_NONE = -1, 618 SNDRV_TIMER_CLASS_SLAVE = 0, 619 SNDRV_TIMER_CLASS_GLOBAL, 620 SNDRV_TIMER_CLASS_CARD, 621 SNDRV_TIMER_CLASS_PCM, 622 SNDRV_TIMER_CLASS_LAST = SNDRV_TIMER_CLASS_PCM, 623 }; 624 625 /* slave timer classes */ 626 enum { 627 SNDRV_TIMER_SCLASS_NONE = 0, 628 SNDRV_TIMER_SCLASS_APPLICATION, 629 SNDRV_TIMER_SCLASS_SEQUENCER, /* alias */ 630 SNDRV_TIMER_SCLASS_OSS_SEQUENCER, /* alias */ 631 SNDRV_TIMER_SCLASS_LAST = SNDRV_TIMER_SCLASS_OSS_SEQUENCER, 632 }; 633 634 /* global timers (device member) */ 635 #define SNDRV_TIMER_GLOBAL_SYSTEM 0 636 #define SNDRV_TIMER_GLOBAL_RTC 1 637 #define SNDRV_TIMER_GLOBAL_HPET 2 638 #define SNDRV_TIMER_GLOBAL_HRTIMER 3 639 640 /* info flags */ 641 #define SNDRV_TIMER_FLG_SLAVE (1<<0) /* cannot be controlled */ 642 643 struct snd_timer_id { 644 int dev_class; 645 int dev_sclass; 646 int card; 647 int device; 648 int subdevice; 649 }; 650 651 struct snd_timer_ginfo { 652 struct snd_timer_id tid; /* requested timer ID */ 653 unsigned int flags; /* timer flags - SNDRV_TIMER_FLG_* */ 654 int card; /* card number */ 655 unsigned char id[64]; /* timer identification */ 656 unsigned char name[80]; /* timer name */ 657 unsigned long reserved0; /* reserved for future use */ 658 unsigned long resolution; /* average period resolution in ns */ 659 unsigned long resolution_min; /* minimal period resolution in ns */ 660 unsigned long resolution_max; /* maximal period resolution in ns */ 661 unsigned int clients; /* active timer clients */ 662 unsigned char reserved[32]; 663 }; 664 665 struct snd_timer_gparams { 666 struct snd_timer_id tid; /* requested timer ID */ 667 unsigned long period_num; /* requested precise period duration (in seconds) - numerator */ 668 unsigned long period_den; /* requested precise period duration (in seconds) - denominator */ 669 unsigned char reserved[32]; 670 }; 671 672 struct snd_timer_gstatus { 673 struct snd_timer_id tid; /* requested timer ID */ 674 unsigned long resolution; /* current period resolution in ns */ 675 unsigned long resolution_num; /* precise current period resolution (in seconds) - numerator */ 676 unsigned long resolution_den; /* precise current period resolution (in seconds) - denominator */ 677 unsigned char reserved[32]; 678 }; 679 680 struct snd_timer_select { 681 struct snd_timer_id id; /* bind to timer ID */ 682 unsigned char reserved[32]; /* reserved */ 683 }; 684 685 struct snd_timer_info { 686 unsigned int flags; /* timer flags - SNDRV_TIMER_FLG_* */ 687 int card; /* card number */ 688 unsigned char id[64]; /* timer identificator */ 689 unsigned char name[80]; /* timer name */ 690 unsigned long reserved0; /* reserved for future use */ 691 unsigned long resolution; /* average period resolution in ns */ 692 unsigned char reserved[64]; /* reserved */ 693 }; 694 695 #define SNDRV_TIMER_PSFLG_AUTO (1<<0) /* auto start, otherwise one-shot */ 696 #define SNDRV_TIMER_PSFLG_EXCLUSIVE (1<<1) /* exclusive use, precise start/stop/pause/continue */ 697 #define SNDRV_TIMER_PSFLG_EARLY_EVENT (1<<2) /* write early event to the poll queue */ 698 699 struct snd_timer_params { 700 unsigned int flags; /* flags - SNDRV_MIXER_PSFLG_* */ 701 unsigned int ticks; /* requested resolution in ticks */ 702 unsigned int queue_size; /* total size of queue (32-1024) */ 703 unsigned int reserved0; /* reserved, was: failure locations */ 704 unsigned int filter; /* event filter (bitmask of SNDRV_TIMER_EVENT_*) */ 705 unsigned char reserved[60]; /* reserved */ 706 }; 707 708 struct snd_timer_status { 709 struct timespec tstamp; /* Timestamp - last update */ 710 unsigned int resolution; /* current period resolution in ns */ 711 unsigned int lost; /* counter of master tick lost */ 712 unsigned int overrun; /* count of read queue overruns */ 713 unsigned int queue; /* used queue size */ 714 unsigned char reserved[64]; /* reserved */ 715 }; 716 717 #define SNDRV_TIMER_IOCTL_PVERSION _IOR('T', 0x00, int) 718 #define SNDRV_TIMER_IOCTL_NEXT_DEVICE _IOWR('T', 0x01, struct snd_timer_id) 719 #define SNDRV_TIMER_IOCTL_TREAD _IOW('T', 0x02, int) 720 #define SNDRV_TIMER_IOCTL_GINFO _IOWR('T', 0x03, struct snd_timer_ginfo) 721 #define SNDRV_TIMER_IOCTL_GPARAMS _IOW('T', 0x04, struct snd_timer_gparams) 722 #define SNDRV_TIMER_IOCTL_GSTATUS _IOWR('T', 0x05, struct snd_timer_gstatus) 723 #define SNDRV_TIMER_IOCTL_SELECT _IOW('T', 0x10, struct snd_timer_select) 724 #define SNDRV_TIMER_IOCTL_INFO _IOR('T', 0x11, struct snd_timer_info) 725 #define SNDRV_TIMER_IOCTL_PARAMS _IOW('T', 0x12, struct snd_timer_params) 726 #define SNDRV_TIMER_IOCTL_STATUS _IOR('T', 0x14, struct snd_timer_status) 727 /* The following four ioctls are changed since 1.0.9 due to confliction */ 728 #define SNDRV_TIMER_IOCTL_START _IO('T', 0xa0) 729 #define SNDRV_TIMER_IOCTL_STOP _IO('T', 0xa1) 730 #define SNDRV_TIMER_IOCTL_CONTINUE _IO('T', 0xa2) 731 #define SNDRV_TIMER_IOCTL_PAUSE _IO('T', 0xa3) 732 733 struct snd_timer_read { 734 unsigned int resolution; 735 unsigned int ticks; 736 }; 737 738 enum { 739 SNDRV_TIMER_EVENT_RESOLUTION = 0, /* val = resolution in ns */ 740 SNDRV_TIMER_EVENT_TICK, /* val = ticks */ 741 SNDRV_TIMER_EVENT_START, /* val = resolution in ns */ 742 SNDRV_TIMER_EVENT_STOP, /* val = 0 */ 743 SNDRV_TIMER_EVENT_CONTINUE, /* val = resolution in ns */ 744 SNDRV_TIMER_EVENT_PAUSE, /* val = 0 */ 745 SNDRV_TIMER_EVENT_EARLY, /* val = 0, early event */ 746 SNDRV_TIMER_EVENT_SUSPEND, /* val = 0 */ 747 SNDRV_TIMER_EVENT_RESUME, /* val = resolution in ns */ 748 /* master timer events for slave timer instances */ 749 SNDRV_TIMER_EVENT_MSTART = SNDRV_TIMER_EVENT_START + 10, 750 SNDRV_TIMER_EVENT_MSTOP = SNDRV_TIMER_EVENT_STOP + 10, 751 SNDRV_TIMER_EVENT_MCONTINUE = SNDRV_TIMER_EVENT_CONTINUE + 10, 752 SNDRV_TIMER_EVENT_MPAUSE = SNDRV_TIMER_EVENT_PAUSE + 10, 753 SNDRV_TIMER_EVENT_MSUSPEND = SNDRV_TIMER_EVENT_SUSPEND + 10, 754 SNDRV_TIMER_EVENT_MRESUME = SNDRV_TIMER_EVENT_RESUME + 10, 755 }; 756 757 struct snd_timer_tread { 758 int event; 759 struct timespec tstamp; 760 unsigned int val; 761 }; 762 763 /**************************************************************************** 764 * * 765 * Section for driver control interface - /dev/snd/control? * 766 * * 767 ****************************************************************************/ 768 769 #define SNDRV_CTL_VERSION SNDRV_PROTOCOL_VERSION(2, 0, 7) 770 771 struct snd_ctl_card_info { 772 int card; /* card number */ 773 int pad; /* reserved for future (was type) */ 774 unsigned char id[16]; /* ID of card (user selectable) */ 775 unsigned char driver[16]; /* Driver name */ 776 unsigned char name[32]; /* Short name of soundcard */ 777 unsigned char longname[80]; /* name + info text about soundcard */ 778 unsigned char reserved_[16]; /* reserved for future (was ID of mixer) */ 779 unsigned char mixername[80]; /* visual mixer identification */ 780 unsigned char components[128]; /* card components / fine identification, delimited with one space (AC97 etc..) */ 781 }; 782 783 typedef int __bitwise snd_ctl_elem_type_t; 784 #define SNDRV_CTL_ELEM_TYPE_NONE ((__force snd_ctl_elem_type_t) 0) /* invalid */ 785 #define SNDRV_CTL_ELEM_TYPE_BOOLEAN ((__force snd_ctl_elem_type_t) 1) /* boolean type */ 786 #define SNDRV_CTL_ELEM_TYPE_INTEGER ((__force snd_ctl_elem_type_t) 2) /* integer type */ 787 #define SNDRV_CTL_ELEM_TYPE_ENUMERATED ((__force snd_ctl_elem_type_t) 3) /* enumerated type */ 788 #define SNDRV_CTL_ELEM_TYPE_BYTES ((__force snd_ctl_elem_type_t) 4) /* byte array */ 789 #define SNDRV_CTL_ELEM_TYPE_IEC958 ((__force snd_ctl_elem_type_t) 5) /* IEC958 (S/PDIF) setup */ 790 #define SNDRV_CTL_ELEM_TYPE_INTEGER64 ((__force snd_ctl_elem_type_t) 6) /* 64-bit integer type */ 791 #define SNDRV_CTL_ELEM_TYPE_LAST SNDRV_CTL_ELEM_TYPE_INTEGER64 792 793 typedef int __bitwise snd_ctl_elem_iface_t; 794 #define SNDRV_CTL_ELEM_IFACE_CARD ((__force snd_ctl_elem_iface_t) 0) /* global control */ 795 #define SNDRV_CTL_ELEM_IFACE_HWDEP ((__force snd_ctl_elem_iface_t) 1) /* hardware dependent device */ 796 #define SNDRV_CTL_ELEM_IFACE_MIXER ((__force snd_ctl_elem_iface_t) 2) /* virtual mixer device */ 797 #define SNDRV_CTL_ELEM_IFACE_PCM ((__force snd_ctl_elem_iface_t) 3) /* PCM device */ 798 #define SNDRV_CTL_ELEM_IFACE_RAWMIDI ((__force snd_ctl_elem_iface_t) 4) /* RawMidi device */ 799 #define SNDRV_CTL_ELEM_IFACE_TIMER ((__force snd_ctl_elem_iface_t) 5) /* timer device */ 800 #define SNDRV_CTL_ELEM_IFACE_SEQUENCER ((__force snd_ctl_elem_iface_t) 6) /* sequencer client */ 801 #define SNDRV_CTL_ELEM_IFACE_LAST SNDRV_CTL_ELEM_IFACE_SEQUENCER 802 803 #define SNDRV_CTL_ELEM_ACCESS_READ (1<<0) 804 #define SNDRV_CTL_ELEM_ACCESS_WRITE (1<<1) 805 #define SNDRV_CTL_ELEM_ACCESS_READWRITE (SNDRV_CTL_ELEM_ACCESS_READ|SNDRV_CTL_ELEM_ACCESS_WRITE) 806 #define SNDRV_CTL_ELEM_ACCESS_VOLATILE (1<<2) /* control value may be changed without a notification */ 807 #define SNDRV_CTL_ELEM_ACCESS_TIMESTAMP (1<<3) /* when was control changed */ 808 #define SNDRV_CTL_ELEM_ACCESS_TLV_READ (1<<4) /* TLV read is possible */ 809 #define SNDRV_CTL_ELEM_ACCESS_TLV_WRITE (1<<5) /* TLV write is possible */ 810 #define SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE (SNDRV_CTL_ELEM_ACCESS_TLV_READ|SNDRV_CTL_ELEM_ACCESS_TLV_WRITE) 811 #define SNDRV_CTL_ELEM_ACCESS_TLV_COMMAND (1<<6) /* TLV command is possible */ 812 #define SNDRV_CTL_ELEM_ACCESS_INACTIVE (1<<8) /* control does actually nothing, but may be updated */ 813 #define SNDRV_CTL_ELEM_ACCESS_LOCK (1<<9) /* write lock */ 814 #define SNDRV_CTL_ELEM_ACCESS_OWNER (1<<10) /* write lock owner */ 815 #define SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK (1<<28) /* kernel use a TLV callback */ 816 #define SNDRV_CTL_ELEM_ACCESS_USER (1<<29) /* user space element */ 817 /* bits 30 and 31 are obsoleted (for indirect access) */ 818 819 /* for further details see the ACPI and PCI power management specification */ 820 #define SNDRV_CTL_POWER_D0 0x0000 /* full On */ 821 #define SNDRV_CTL_POWER_D1 0x0100 /* partial On */ 822 #define SNDRV_CTL_POWER_D2 0x0200 /* partial On */ 823 #define SNDRV_CTL_POWER_D3 0x0300 /* Off */ 824 #define SNDRV_CTL_POWER_D3hot (SNDRV_CTL_POWER_D3|0x0000) /* Off, with power */ 825 #define SNDRV_CTL_POWER_D3cold (SNDRV_CTL_POWER_D3|0x0001) /* Off, without power */ 826 827 #define SNDRV_CTL_ELEM_ID_NAME_MAXLEN 44 828 829 struct snd_ctl_elem_id { 830 unsigned int numid; /* numeric identifier, zero = invalid */ 831 snd_ctl_elem_iface_t iface; /* interface identifier */ 832 unsigned int device; /* device/client number */ 833 unsigned int subdevice; /* subdevice (substream) number */ 834 unsigned char name[44]; /* ASCII name of item */ 835 unsigned int index; /* index of item */ 836 }; 837 838 struct snd_ctl_elem_list { 839 unsigned int offset; /* W: first element ID to get */ 840 unsigned int space; /* W: count of element IDs to get */ 841 unsigned int used; /* R: count of element IDs set */ 842 unsigned int count; /* R: count of all elements */ 843 struct snd_ctl_elem_id __user *pids; /* R: IDs */ 844 unsigned char reserved[50]; 845 }; 846 847 struct snd_ctl_elem_info { 848 struct snd_ctl_elem_id id; /* W: element ID */ 849 snd_ctl_elem_type_t type; /* R: value type - SNDRV_CTL_ELEM_TYPE_* */ 850 unsigned int access; /* R: value access (bitmask) - SNDRV_CTL_ELEM_ACCESS_* */ 851 unsigned int count; /* count of values */ 852 __kernel_pid_t owner; /* owner's PID of this control */ 853 union { 854 struct { 855 long min; /* R: minimum value */ 856 long max; /* R: maximum value */ 857 long step; /* R: step (0 variable) */ 858 } integer; 859 struct { 860 long long min; /* R: minimum value */ 861 long long max; /* R: maximum value */ 862 long long step; /* R: step (0 variable) */ 863 } integer64; 864 struct { 865 unsigned int items; /* R: number of items */ 866 unsigned int item; /* W: item number */ 867 char name[64]; /* R: value name */ 868 __u64 names_ptr; /* W: names list (ELEM_ADD only) */ 869 unsigned int names_length; 870 } enumerated; 871 unsigned char reserved[128]; 872 } value; 873 union { 874 unsigned short d[4]; /* dimensions */ 875 unsigned short *d_ptr; /* indirect - obsoleted */ 876 } dimen; 877 unsigned char reserved[64-4*sizeof(unsigned short)]; 878 }; 879 880 struct snd_ctl_elem_value { 881 struct snd_ctl_elem_id id; /* W: element ID */ 882 unsigned int indirect: 1; /* W: indirect access - obsoleted */ 883 union { 884 union { 885 long value[128]; 886 long *value_ptr; /* obsoleted */ 887 } integer; 888 union { 889 long long value[64]; 890 long long *value_ptr; /* obsoleted */ 891 } integer64; 892 union { 893 unsigned int item[128]; 894 unsigned int *item_ptr; /* obsoleted */ 895 } enumerated; 896 union { 897 unsigned char data[512]; 898 unsigned char *data_ptr; /* obsoleted */ 899 } bytes; 900 struct snd_aes_iec958 iec958; 901 } value; /* RO */ 902 struct timespec tstamp; 903 unsigned char reserved[128-sizeof(struct timespec)]; 904 }; 905 906 struct snd_ctl_tlv { 907 unsigned int numid; /* control element numeric identification */ 908 unsigned int length; /* in bytes aligned to 4 */ 909 unsigned int tlv[0]; /* first TLV */ 910 }; 911 912 #define SNDRV_CTL_IOCTL_PVERSION _IOR('U', 0x00, int) 913 #define SNDRV_CTL_IOCTL_CARD_INFO _IOR('U', 0x01, struct snd_ctl_card_info) 914 #define SNDRV_CTL_IOCTL_ELEM_LIST _IOWR('U', 0x10, struct snd_ctl_elem_list) 915 #define SNDRV_CTL_IOCTL_ELEM_INFO _IOWR('U', 0x11, struct snd_ctl_elem_info) 916 #define SNDRV_CTL_IOCTL_ELEM_READ _IOWR('U', 0x12, struct snd_ctl_elem_value) 917 #define SNDRV_CTL_IOCTL_ELEM_WRITE _IOWR('U', 0x13, struct snd_ctl_elem_value) 918 #define SNDRV_CTL_IOCTL_ELEM_LOCK _IOW('U', 0x14, struct snd_ctl_elem_id) 919 #define SNDRV_CTL_IOCTL_ELEM_UNLOCK _IOW('U', 0x15, struct snd_ctl_elem_id) 920 #define SNDRV_CTL_IOCTL_SUBSCRIBE_EVENTS _IOWR('U', 0x16, int) 921 #define SNDRV_CTL_IOCTL_ELEM_ADD _IOWR('U', 0x17, struct snd_ctl_elem_info) 922 #define SNDRV_CTL_IOCTL_ELEM_REPLACE _IOWR('U', 0x18, struct snd_ctl_elem_info) 923 #define SNDRV_CTL_IOCTL_ELEM_REMOVE _IOWR('U', 0x19, struct snd_ctl_elem_id) 924 #define SNDRV_CTL_IOCTL_TLV_READ _IOWR('U', 0x1a, struct snd_ctl_tlv) 925 #define SNDRV_CTL_IOCTL_TLV_WRITE _IOWR('U', 0x1b, struct snd_ctl_tlv) 926 #define SNDRV_CTL_IOCTL_TLV_COMMAND _IOWR('U', 0x1c, struct snd_ctl_tlv) 927 #define SNDRV_CTL_IOCTL_HWDEP_NEXT_DEVICE _IOWR('U', 0x20, int) 928 #define SNDRV_CTL_IOCTL_HWDEP_INFO _IOR('U', 0x21, struct snd_hwdep_info) 929 #define SNDRV_CTL_IOCTL_PCM_NEXT_DEVICE _IOR('U', 0x30, int) 930 #define SNDRV_CTL_IOCTL_PCM_INFO _IOWR('U', 0x31, struct snd_pcm_info) 931 #define SNDRV_CTL_IOCTL_PCM_PREFER_SUBDEVICE _IOW('U', 0x32, int) 932 #define SNDRV_CTL_IOCTL_RAWMIDI_NEXT_DEVICE _IOWR('U', 0x40, int) 933 #define SNDRV_CTL_IOCTL_RAWMIDI_INFO _IOWR('U', 0x41, struct snd_rawmidi_info) 934 #define SNDRV_CTL_IOCTL_RAWMIDI_PREFER_SUBDEVICE _IOW('U', 0x42, int) 935 #define SNDRV_CTL_IOCTL_POWER _IOWR('U', 0xd0, int) 936 #define SNDRV_CTL_IOCTL_POWER_STATE _IOR('U', 0xd1, int) 937 938 /* 939 * Read interface. 940 */ 941 942 enum sndrv_ctl_event_type { 943 SNDRV_CTL_EVENT_ELEM = 0, 944 SNDRV_CTL_EVENT_LAST = SNDRV_CTL_EVENT_ELEM, 945 }; 946 947 #define SNDRV_CTL_EVENT_MASK_VALUE (1<<0) /* element value was changed */ 948 #define SNDRV_CTL_EVENT_MASK_INFO (1<<1) /* element info was changed */ 949 #define SNDRV_CTL_EVENT_MASK_ADD (1<<2) /* element was added */ 950 #define SNDRV_CTL_EVENT_MASK_TLV (1<<3) /* element TLV tree was changed */ 951 #define SNDRV_CTL_EVENT_MASK_REMOVE (~0U) /* element was removed */ 952 953 struct snd_ctl_event { 954 int type; /* event type - SNDRV_CTL_EVENT_* */ 955 union { 956 struct { 957 unsigned int mask; 958 struct snd_ctl_elem_id id; 959 } elem; 960 unsigned char data8[60]; 961 } data; 962 }; 963 964 /* 965 * Control names 966 */ 967 968 #define SNDRV_CTL_NAME_NONE "" 969 #define SNDRV_CTL_NAME_PLAYBACK "Playback " 970 #define SNDRV_CTL_NAME_CAPTURE "Capture " 971 972 #define SNDRV_CTL_NAME_IEC958_NONE "" 973 #define SNDRV_CTL_NAME_IEC958_SWITCH "Switch" 974 #define SNDRV_CTL_NAME_IEC958_VOLUME "Volume" 975 #define SNDRV_CTL_NAME_IEC958_DEFAULT "Default" 976 #define SNDRV_CTL_NAME_IEC958_MASK "Mask" 977 #define SNDRV_CTL_NAME_IEC958_CON_MASK "Con Mask" 978 #define SNDRV_CTL_NAME_IEC958_PRO_MASK "Pro Mask" 979 #define SNDRV_CTL_NAME_IEC958_PCM_STREAM "PCM Stream" 980 #define SNDRV_CTL_NAME_IEC958(expl,direction,what) "IEC958 " expl SNDRV_CTL_NAME_##direction SNDRV_CTL_NAME_IEC958_##what 981 982 #endif /* _UAPI__SOUND_ASOUND_H */ 983