asound.h 45 KB

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