asound.h 46 KB

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