include/uapi/sound/asound.h

   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 #ifndef _UAPI__SOUND_ASOUND_H
   9 #define _UAPI__SOUND_ASOUND_H
  10
  11 #if defined(__KERNEL__) || defined(__linux__)
  12 #include <linux/types.h>
  13 #include <asm/byteorder.h>
  14 #else
  15 #include <endian.h>
  16 #include <sys/ioctl.h>
  17 #endif
  18
  19 #ifndef __KERNEL__
  20 #include <stdlib.h>
  21 #include <time.h>
  22 #endif
  23
  24 /*
  25  *  protocol version
  26  */
  27
  28 #define SNDRV_PROTOCOL_VERSION(major, minor, subminor) (((major)<<16)|((minor)<<8)|(subminor))
  29 #define SNDRV_PROTOCOL_MAJOR(version) (((version)>>16)&0xffff)
  30 #define SNDRV_PROTOCOL_MINOR(version) (((version)>>8)&0xff)
  31 #define SNDRV_PROTOCOL_MICRO(version) ((version)&0xff)
  32 #define SNDRV_PROTOCOL_INCOMPATIBLE(kversion, uversion) \
  33         (SNDRV_PROTOCOL_MAJOR(kversion) != SNDRV_PROTOCOL_MAJOR(uversion) || \
  34          (SNDRV_PROTOCOL_MAJOR(kversion) == SNDRV_PROTOCOL_MAJOR(uversion) && \
  35            SNDRV_PROTOCOL_MINOR(kversion) != SNDRV_PROTOCOL_MINOR(uversion)))
  36
  37 /****************************************************************************
  38  *                                                                          *
  39  *        Digital audio interface                                           *
  40  *                                                                          *
  41  ****************************************************************************/
  42
  43 #define AES_IEC958_STATUS_SIZE          24
  44
  45 struct snd_aes_iec958 {
  46         unsigned char status[AES_IEC958_STATUS_SIZE]; /* AES/IEC958 channel status bits */
  47         unsigned char subcode[147];     /* AES/IEC958 subcode bits */
  48         unsigned char pad;              /* nothing */
  49         unsigned char dig_subframe[4];  /* AES/IEC958 subframe bits */
  50 };
  51
  52 /****************************************************************************
  53  *                                                                          *
  54  *        CEA-861 Audio InfoFrame. Used in HDMI and DisplayPort             *
  55  *                                                                          *
  56  ****************************************************************************/
  57
  58 struct snd_cea_861_aud_if {
  59         unsigned char db1_ct_cc; /* coding type and channel count */
  60         unsigned char db2_sf_ss; /* sample frequency and size */
  61         unsigned char db3; /* not used, all zeros */
  62         unsigned char db4_ca; /* channel allocation code */
  63         unsigned char db5_dminh_lsv; /* downmix inhibit & level-shit values */
  64 };
  65
  66 /****************************************************************************
  67  *                                                                          *
  68  *      Section for driver hardware dependent interface - /dev/snd/hw?      *
  69  *                                                                          *
  70  ****************************************************************************/
  71
  72 #define SNDRV_HWDEP_VERSION             SNDRV_PROTOCOL_VERSION(1, 0, 1)
  73
  74 enum {
  75         SNDRV_HWDEP_IFACE_OPL2 = 0,
  76         SNDRV_HWDEP_IFACE_OPL3,
  77         SNDRV_HWDEP_IFACE_OPL4,
  78         SNDRV_HWDEP_IFACE_SB16CSP,      /* Creative Signal Processor */
  79         SNDRV_HWDEP_IFACE_EMU10K1,      /* FX8010 processor in EMU10K1 chip */
  80         SNDRV_HWDEP_IFACE_YSS225,       /* Yamaha FX processor */
  81         SNDRV_HWDEP_IFACE_ICS2115,      /* Wavetable synth */
  82         SNDRV_HWDEP_IFACE_SSCAPE,       /* Ensoniq SoundScape ISA card (MC68EC000) */
  83         SNDRV_HWDEP_IFACE_VX,           /* Digigram VX cards */
  84         SNDRV_HWDEP_IFACE_MIXART,       /* Digigram miXart cards */
  85         SNDRV_HWDEP_IFACE_USX2Y,        /* Tascam US122, US224 & US428 usb */
  86         SNDRV_HWDEP_IFACE_EMUX_WAVETABLE, /* EmuX wavetable */
  87         SNDRV_HWDEP_IFACE_BLUETOOTH,    /* Bluetooth audio */
  88         SNDRV_HWDEP_IFACE_USX2Y_PCM,    /* Tascam US122, US224 & US428 rawusb pcm */
  89         SNDRV_HWDEP_IFACE_PCXHR,        /* Digigram PCXHR */
  90         SNDRV_HWDEP_IFACE_SB_RC,        /* SB Extigy/Audigy2NX remote control */
  91         SNDRV_HWDEP_IFACE_HDA,          /* HD-audio */
  92         SNDRV_HWDEP_IFACE_USB_STREAM,   /* direct access to usb stream */
  93         SNDRV_HWDEP_IFACE_FW_DICE,      /* TC DICE FireWire device */
  94         SNDRV_HWDEP_IFACE_FW_FIREWORKS, /* Echo Audio Fireworks based device */
  95         SNDRV_HWDEP_IFACE_FW_BEBOB,     /* BridgeCo BeBoB based device */
  96         SNDRV_HWDEP_IFACE_FW_OXFW,      /* Oxford OXFW970/971 based device */
  97         SNDRV_HWDEP_IFACE_FW_DIGI00X,   /* Digidesign Digi 002/003 family */
  98         SNDRV_HWDEP_IFACE_FW_TASCAM,    /* TASCAM FireWire series */
  99         SNDRV_HWDEP_IFACE_LINE6,        /* Line6 USB processors */
 100         SNDRV_HWDEP_IFACE_FW_MOTU,      /* MOTU FireWire series */
 101         SNDRV_HWDEP_IFACE_FW_FIREFACE,  /* RME Fireface series */
 102
 103         /* Don't forget to change the following: */
 104         SNDRV_HWDEP_IFACE_LAST = SNDRV_HWDEP_IFACE_FW_FIREFACE
 105 };
 106
 107 struct snd_hwdep_info {
 108         unsigned int device;            /* WR: device number */
 109         int card;                       /* R: card number */
 110         unsigned char id[64];           /* ID (user selectable) */
 111         unsigned char name[80];         /* hwdep name */
 112         int iface;                      /* hwdep interface */
 113         unsigned char reserved[64];     /* reserved for future */
 114 };
 115
 116 /* generic DSP loader */
 117 struct snd_hwdep_dsp_status {
 118         unsigned int version;           /* R: driver-specific version */
 119         unsigned char id[32];           /* R: driver-specific ID string */
 120         unsigned int num_dsps;          /* R: number of DSP images to transfer */
 121         unsigned int dsp_loaded;        /* R: bit flags indicating the loaded DSPs */
 122         unsigned int chip_ready;        /* R: 1 = initialization finished */
 123         unsigned char reserved[16];     /* reserved for future use */
 124 };
 125
 126 struct snd_hwdep_dsp_image {
 127         unsigned int index;             /* W: DSP index */
 128         unsigned char name[64];         /* W: ID (e.g. file name) */
 129         unsigned char __user *image;    /* W: binary image */
 130         size_t length;                  /* W: size of image in bytes */
 131         unsigned long driver_data;      /* W: driver-specific data */
 132 };
 133
 134 #define SNDRV_HWDEP_IOCTL_PVERSION      _IOR ('H', 0x00, int)
 135 #define SNDRV_HWDEP_IOCTL_INFO          _IOR ('H', 0x01, struct snd_hwdep_info)
 136 #define SNDRV_HWDEP_IOCTL_DSP_STATUS    _IOR('H', 0x02, struct snd_hwdep_dsp_status)
 137 #define SNDRV_HWDEP_IOCTL_DSP_LOAD      _IOW('H', 0x03, struct snd_hwdep_dsp_image)
 138
 139 /*****************************************************************************
 140  *                                                                           *
 141  *             Digital Audio (PCM) interface - /dev/snd/pcm??                *
 142  *                                                                           *
 143  *****************************************************************************/
 144
 145 #define SNDRV_PCM_VERSION               SNDRV_PROTOCOL_VERSION(2, 0, 15)
 146
 147 typedef unsigned long snd_pcm_uframes_t;
 148 typedef signed long snd_pcm_sframes_t;
 149
 150 enum {
 151         SNDRV_PCM_CLASS_GENERIC = 0,    /* standard mono or stereo device */
 152         SNDRV_PCM_CLASS_MULTI,          /* multichannel device */
 153         SNDRV_PCM_CLASS_MODEM,          /* software modem class */
 154         SNDRV_PCM_CLASS_DIGITIZER,      /* digitizer class */
 155         /* Don't forget to change the following: */
 156         SNDRV_PCM_CLASS_LAST = SNDRV_PCM_CLASS_DIGITIZER,
 157 };
 158
 159 enum {
 160         SNDRV_PCM_SUBCLASS_GENERIC_MIX = 0, /* mono or stereo subdevices are mixed together */
 161         SNDRV_PCM_SUBCLASS_MULTI_MIX,   /* multichannel subdevices are mixed together */
 162         /* Don't forget to change the following: */
 163         SNDRV_PCM_SUBCLASS_LAST = SNDRV_PCM_SUBCLASS_MULTI_MIX,
 164 };
 165
 166 enum {
 167         SNDRV_PCM_STREAM_PLAYBACK = 0,
 168         SNDRV_PCM_STREAM_CAPTURE,
 169         SNDRV_PCM_STREAM_LAST = SNDRV_PCM_STREAM_CAPTURE,
 170 };
 171
 172 typedef int __bitwise snd_pcm_access_t;
 173 #define SNDRV_PCM_ACCESS_MMAP_INTERLEAVED       ((__force snd_pcm_access_t) 0) /* interleaved mmap */
 174 #define SNDRV_PCM_ACCESS_MMAP_NONINTERLEAVED    ((__force snd_pcm_access_t) 1) /* noninterleaved mmap */
 175 #define SNDRV_PCM_ACCESS_MMAP_COMPLEX           ((__force snd_pcm_access_t) 2) /* complex mmap */
 176 #define SNDRV_PCM_ACCESS_RW_INTERLEAVED         ((__force snd_pcm_access_t) 3) /* readi/writei */
 177 #define SNDRV_PCM_ACCESS_RW_NONINTERLEAVED      ((__force snd_pcm_access_t) 4) /* readn/writen */
 178 #define SNDRV_PCM_ACCESS_LAST           SNDRV_PCM_ACCESS_RW_NONINTERLEAVED
 179
 180 typedef int __bitwise snd_pcm_format_t;
 181 #define SNDRV_PCM_FORMAT_S8     ((__force snd_pcm_format_t) 0)
 182 #define SNDRV_PCM_FORMAT_U8     ((__force snd_pcm_format_t) 1)
 183 #define SNDRV_PCM_FORMAT_S16_LE ((__force snd_pcm_format_t) 2)
 184 #define SNDRV_PCM_FORMAT_S16_BE ((__force snd_pcm_format_t) 3)
 185 #define SNDRV_PCM_FORMAT_U16_LE ((__force snd_pcm_format_t) 4)
 186 #define SNDRV_PCM_FORMAT_U16_BE ((__force snd_pcm_format_t) 5)
 187 #define SNDRV_PCM_FORMAT_S24_LE ((__force snd_pcm_format_t) 6) /* low three bytes */
 188 #define SNDRV_PCM_FORMAT_S24_BE ((__force snd_pcm_format_t) 7) /* low three bytes */
 189 #define SNDRV_PCM_FORMAT_U24_LE ((__force snd_pcm_format_t) 8) /* low three bytes */
 190 #define SNDRV_PCM_FORMAT_U24_BE ((__force snd_pcm_format_t) 9) /* low three bytes */
 191 /*
 192  * For S32/U32 formats, 'msbits' hardware parameter is often used to deliver information about the
 193  * available bit count in most significant bit. It's for the case of so-called 'left-justified' or
 194  * `right-padding` sample which has less width than 32 bit.
 195  */
 196 #define SNDRV_PCM_FORMAT_S32_LE ((__force snd_pcm_format_t) 10)
 197 #define SNDRV_PCM_FORMAT_S32_BE ((__force snd_pcm_format_t) 11)
 198 #define SNDRV_PCM_FORMAT_U32_LE ((__force snd_pcm_format_t) 12)
 199 #define SNDRV_PCM_FORMAT_U32_BE ((__force snd_pcm_format_t) 13)
 200 #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 */
 201 #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 */
 202 #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 */
 203 #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 */
 204 #define SNDRV_PCM_FORMAT_IEC958_SUBFRAME_LE ((__force snd_pcm_format_t) 18) /* IEC-958 subframe, Little Endian */
 205 #define SNDRV_PCM_FORMAT_IEC958_SUBFRAME_BE ((__force snd_pcm_format_t) 19) /* IEC-958 subframe, Big Endian */
 206 #define SNDRV_PCM_FORMAT_MU_LAW         ((__force snd_pcm_format_t) 20)
 207 #define SNDRV_PCM_FORMAT_A_LAW          ((__force snd_pcm_format_t) 21)
 208 #define SNDRV_PCM_FORMAT_IMA_ADPCM      ((__force snd_pcm_format_t) 22)
 209 #define SNDRV_PCM_FORMAT_MPEG           ((__force snd_pcm_format_t) 23)
 210 #define SNDRV_PCM_FORMAT_GSM            ((__force snd_pcm_format_t) 24)
 211 #define SNDRV_PCM_FORMAT_S20_LE ((__force snd_pcm_format_t) 25) /* in four bytes, LSB justified */
 212 #define SNDRV_PCM_FORMAT_S20_BE ((__force snd_pcm_format_t) 26) /* in four bytes, LSB justified */
 213 #define SNDRV_PCM_FORMAT_U20_LE ((__force snd_pcm_format_t) 27) /* in four bytes, LSB justified */
 214 #define SNDRV_PCM_FORMAT_U20_BE ((__force snd_pcm_format_t) 28) /* in four bytes, LSB justified */
 215 /* gap in the numbering for a future standard linear format */
 216 #define SNDRV_PCM_FORMAT_SPECIAL        ((__force snd_pcm_format_t) 31)
 217 #define SNDRV_PCM_FORMAT_S24_3LE        ((__force snd_pcm_format_t) 32) /* in three bytes */
 218 #define SNDRV_PCM_FORMAT_S24_3BE        ((__force snd_pcm_format_t) 33) /* in three bytes */
 219 #define SNDRV_PCM_FORMAT_U24_3LE        ((__force snd_pcm_format_t) 34) /* in three bytes */
 220 #define SNDRV_PCM_FORMAT_U24_3BE        ((__force snd_pcm_format_t) 35) /* in three bytes */
 221 #define SNDRV_PCM_FORMAT_S20_3LE        ((__force snd_pcm_format_t) 36) /* in three bytes */
 222 #define SNDRV_PCM_FORMAT_S20_3BE        ((__force snd_pcm_format_t) 37) /* in three bytes */
 223 #define SNDRV_PCM_FORMAT_U20_3LE        ((__force snd_pcm_format_t) 38) /* in three bytes */
 224 #define SNDRV_PCM_FORMAT_U20_3BE        ((__force snd_pcm_format_t) 39) /* in three bytes */
 225 #define SNDRV_PCM_FORMAT_S18_3LE        ((__force snd_pcm_format_t) 40) /* in three bytes */
 226 #define SNDRV_PCM_FORMAT_S18_3BE        ((__force snd_pcm_format_t) 41) /* in three bytes */
 227 #define SNDRV_PCM_FORMAT_U18_3LE        ((__force snd_pcm_format_t) 42) /* in three bytes */
 228 #define SNDRV_PCM_FORMAT_U18_3BE        ((__force snd_pcm_format_t) 43) /* in three bytes */
 229 #define SNDRV_PCM_FORMAT_G723_24        ((__force snd_pcm_format_t) 44) /* 8 samples in 3 bytes */
 230 #define SNDRV_PCM_FORMAT_G723_24_1B     ((__force snd_pcm_format_t) 45) /* 1 sample in 1 byte */
 231 #define SNDRV_PCM_FORMAT_G723_40        ((__force snd_pcm_format_t) 46) /* 8 Samples in 5 bytes */
 232 #define SNDRV_PCM_FORMAT_G723_40_1B     ((__force snd_pcm_format_t) 47) /* 1 sample in 1 byte */
 233 #define SNDRV_PCM_FORMAT_DSD_U8         ((__force snd_pcm_format_t) 48) /* DSD, 1-byte samples DSD (x8) */
 234 #define SNDRV_PCM_FORMAT_DSD_U16_LE     ((__force snd_pcm_format_t) 49) /* DSD, 2-byte samples DSD (x16), little endian */
 235 #define SNDRV_PCM_FORMAT_DSD_U32_LE     ((__force snd_pcm_format_t) 50) /* DSD, 4-byte samples DSD (x32), little endian */
 236 #define SNDRV_PCM_FORMAT_DSD_U16_BE     ((__force snd_pcm_format_t) 51) /* DSD, 2-byte samples DSD (x16), big endian */
 237 #define SNDRV_PCM_FORMAT_DSD_U32_BE     ((__force snd_pcm_format_t) 52) /* DSD, 4-byte samples DSD (x32), big endian */
 238 #define SNDRV_PCM_FORMAT_LAST           SNDRV_PCM_FORMAT_DSD_U32_BE
 239 #define SNDRV_PCM_FORMAT_FIRST          SNDRV_PCM_FORMAT_S8
 240
 241 #ifdef SNDRV_LITTLE_ENDIAN
 242 #define SNDRV_PCM_FORMAT_S16            SNDRV_PCM_FORMAT_S16_LE
 243 #define SNDRV_PCM_FORMAT_U16            SNDRV_PCM_FORMAT_U16_LE
 244 #define SNDRV_PCM_FORMAT_S24            SNDRV_PCM_FORMAT_S24_LE
 245 #define SNDRV_PCM_FORMAT_U24            SNDRV_PCM_FORMAT_U24_LE
 246 #define SNDRV_PCM_FORMAT_S32            SNDRV_PCM_FORMAT_S32_LE
 247 #define SNDRV_PCM_FORMAT_U32            SNDRV_PCM_FORMAT_U32_LE
 248 #define SNDRV_PCM_FORMAT_FLOAT          SNDRV_PCM_FORMAT_FLOAT_LE
 249 #define SNDRV_PCM_FORMAT_FLOAT64        SNDRV_PCM_FORMAT_FLOAT64_LE
 250 #define SNDRV_PCM_FORMAT_IEC958_SUBFRAME SNDRV_PCM_FORMAT_IEC958_SUBFRAME_LE
 251 #define SNDRV_PCM_FORMAT_S20            SNDRV_PCM_FORMAT_S20_LE
 252 #define SNDRV_PCM_FORMAT_U20            SNDRV_PCM_FORMAT_U20_LE
 253 #endif
 254 #ifdef SNDRV_BIG_ENDIAN
 255 #define SNDRV_PCM_FORMAT_S16            SNDRV_PCM_FORMAT_S16_BE
 256 #define SNDRV_PCM_FORMAT_U16            SNDRV_PCM_FORMAT_U16_BE
 257 #define SNDRV_PCM_FORMAT_S24            SNDRV_PCM_FORMAT_S24_BE
 258 #define SNDRV_PCM_FORMAT_U24            SNDRV_PCM_FORMAT_U24_BE
 259 #define SNDRV_PCM_FORMAT_S32            SNDRV_PCM_FORMAT_S32_BE
 260 #define SNDRV_PCM_FORMAT_U32            SNDRV_PCM_FORMAT_U32_BE
 261 #define SNDRV_PCM_FORMAT_FLOAT          SNDRV_PCM_FORMAT_FLOAT_BE
 262 #define SNDRV_PCM_FORMAT_FLOAT64        SNDRV_PCM_FORMAT_FLOAT64_BE
 263 #define SNDRV_PCM_FORMAT_IEC958_SUBFRAME SNDRV_PCM_FORMAT_IEC958_SUBFRAME_BE
 264 #define SNDRV_PCM_FORMAT_S20            SNDRV_PCM_FORMAT_S20_BE
 265 #define SNDRV_PCM_FORMAT_U20            SNDRV_PCM_FORMAT_U20_BE
 266 #endif
 267
 268 typedef int __bitwise snd_pcm_subformat_t;
 269 #define SNDRV_PCM_SUBFORMAT_STD         ((__force snd_pcm_subformat_t) 0)
 270 #define SNDRV_PCM_SUBFORMAT_LAST        SNDRV_PCM_SUBFORMAT_STD
 271
 272 #define SNDRV_PCM_INFO_MMAP             0x00000001      /* hardware supports mmap */
 273 #define SNDRV_PCM_INFO_MMAP_VALID       0x00000002      /* period data are valid during transfer */
 274 #define SNDRV_PCM_INFO_DOUBLE           0x00000004      /* Double buffering needed for PCM start/stop */
 275 #define SNDRV_PCM_INFO_BATCH            0x00000010      /* double buffering */
 276 #define SNDRV_PCM_INFO_SYNC_APPLPTR     0x00000020      /* need the explicit sync of appl_ptr update */
 277 #define SNDRV_PCM_INFO_PERFECT_DRAIN    0x00000040      /* silencing at the end of stream is not required */
 278 #define SNDRV_PCM_INFO_INTERLEAVED      0x00000100      /* channels are interleaved */
 279 #define SNDRV_PCM_INFO_NONINTERLEAVED   0x00000200      /* channels are not interleaved */
 280 #define SNDRV_PCM_INFO_COMPLEX          0x00000400      /* complex frame organization (mmap only) */
 281 #define SNDRV_PCM_INFO_BLOCK_TRANSFER   0x00010000      /* hardware transfer block of samples */
 282 #define SNDRV_PCM_INFO_OVERRANGE        0x00020000      /* hardware supports ADC (capture) overrange detection */
 283 #define SNDRV_PCM_INFO_RESUME           0x00040000      /* hardware supports stream resume after suspend */
 284 #define SNDRV_PCM_INFO_PAUSE            0x00080000      /* pause ioctl is supported */
 285 #define SNDRV_PCM_INFO_HALF_DUPLEX      0x00100000      /* only half duplex */
 286 #define SNDRV_PCM_INFO_JOINT_DUPLEX     0x00200000      /* playback and capture stream are somewhat correlated */
 287 #define SNDRV_PCM_INFO_SYNC_START       0x00400000      /* pcm support some kind of sync go */
 288 #define SNDRV_PCM_INFO_NO_PERIOD_WAKEUP 0x00800000      /* period wakeup can be disabled */
 289 #define SNDRV_PCM_INFO_HAS_WALL_CLOCK   0x01000000      /* (Deprecated)has audio wall clock for audio/system time sync */
 290 #define SNDRV_PCM_INFO_HAS_LINK_ATIME              0x01000000  /* report hardware link audio time, reset on startup */
 291 #define SNDRV_PCM_INFO_HAS_LINK_ABSOLUTE_ATIME     0x02000000  /* report absolute hardware link audio time, not reset on startup */
 292 #define SNDRV_PCM_INFO_HAS_LINK_ESTIMATED_ATIME    0x04000000  /* report estimated link audio time */
 293 #define SNDRV_PCM_INFO_HAS_LINK_SYNCHRONIZED_ATIME 0x08000000  /* report synchronized audio/system time */
 294 #define SNDRV_PCM_INFO_EXPLICIT_SYNC    0x10000000      /* needs explicit sync of pointers and data */
 295 #define SNDRV_PCM_INFO_NO_REWINDS       0x20000000      /* hardware can only support monotonic changes of appl_ptr */
 296 #define SNDRV_PCM_INFO_DRAIN_TRIGGER    0x40000000              /* internal kernel flag - trigger in drain */
 297 #define SNDRV_PCM_INFO_FIFO_IN_FRAMES   0x80000000      /* internal kernel flag - FIFO size is in frames */
 298
 299 #if (__BITS_PER_LONG == 32 && defined(__USE_TIME_BITS64)) || defined __KERNEL__
 300 #define __SND_STRUCT_TIME64
 301 #endif
 302
 303 typedef int __bitwise snd_pcm_state_t;
 304 #define SNDRV_PCM_STATE_OPEN            ((__force snd_pcm_state_t) 0) /* stream is open */
 305 #define SNDRV_PCM_STATE_SETUP           ((__force snd_pcm_state_t) 1) /* stream has a setup */
 306 #define SNDRV_PCM_STATE_PREPARED        ((__force snd_pcm_state_t) 2) /* stream is ready to start */
 307 #define SNDRV_PCM_STATE_RUNNING         ((__force snd_pcm_state_t) 3) /* stream is running */
 308 #define SNDRV_PCM_STATE_XRUN            ((__force snd_pcm_state_t) 4) /* stream reached an xrun */
 309 #define SNDRV_PCM_STATE_DRAINING        ((__force snd_pcm_state_t) 5) /* stream is draining */
 310 #define SNDRV_PCM_STATE_PAUSED          ((__force snd_pcm_state_t) 6) /* stream is paused */
 311 #define SNDRV_PCM_STATE_SUSPENDED       ((__force snd_pcm_state_t) 7) /* hardware is suspended */
 312 #define SNDRV_PCM_STATE_DISCONNECTED    ((__force snd_pcm_state_t) 8) /* hardware is disconnected */
 313 #define SNDRV_PCM_STATE_LAST            SNDRV_PCM_STATE_DISCONNECTED
 314
 315 enum {
 316         SNDRV_PCM_MMAP_OFFSET_DATA = 0x00000000,
 317         SNDRV_PCM_MMAP_OFFSET_STATUS_OLD = 0x80000000,
 318         SNDRV_PCM_MMAP_OFFSET_CONTROL_OLD = 0x81000000,
 319         SNDRV_PCM_MMAP_OFFSET_STATUS_NEW = 0x82000000,
 320         SNDRV_PCM_MMAP_OFFSET_CONTROL_NEW = 0x83000000,
 321 #ifdef __SND_STRUCT_TIME64
 322         SNDRV_PCM_MMAP_OFFSET_STATUS = SNDRV_PCM_MMAP_OFFSET_STATUS_NEW,
 323         SNDRV_PCM_MMAP_OFFSET_CONTROL = SNDRV_PCM_MMAP_OFFSET_CONTROL_NEW,
 324 #else
 325         SNDRV_PCM_MMAP_OFFSET_STATUS = SNDRV_PCM_MMAP_OFFSET_STATUS_OLD,
 326         SNDRV_PCM_MMAP_OFFSET_CONTROL = SNDRV_PCM_MMAP_OFFSET_CONTROL_OLD,
 327 #endif
 328 };
 329
 330 union snd_pcm_sync_id {
 331         unsigned char id[16];
 332         unsigned short id16[8];
 333         unsigned int id32[4];
 334 };
 335
 336 struct snd_pcm_info {
 337         unsigned int device;            /* RO/WR (control): device number */
 338         unsigned int subdevice;         /* RO/WR (control): subdevice number */
 339         int stream;                     /* RO/WR (control): stream direction */
 340         int card;                       /* R: card number */
 341         unsigned char id[64];           /* ID (user selectable) */
 342         unsigned char name[80];         /* name of this device */
 343         unsigned char subname[32];      /* subdevice name */
 344         int dev_class;                  /* SNDRV_PCM_CLASS_* */
 345         int dev_subclass;               /* SNDRV_PCM_SUBCLASS_* */
 346         unsigned int subdevices_count;
 347         unsigned int subdevices_avail;
 348         union snd_pcm_sync_id sync;     /* hardware synchronization ID */
 349         unsigned char reserved[64];     /* reserved for future... */
 350 };
 351
 352 typedef int snd_pcm_hw_param_t;
 353 #define SNDRV_PCM_HW_PARAM_ACCESS       0       /* Access type */
 354 #define SNDRV_PCM_HW_PARAM_FORMAT       1       /* Format */
 355 #define SNDRV_PCM_HW_PARAM_SUBFORMAT    2       /* Subformat */
 356 #define SNDRV_PCM_HW_PARAM_FIRST_MASK   SNDRV_PCM_HW_PARAM_ACCESS
 357 #define SNDRV_PCM_HW_PARAM_LAST_MASK    SNDRV_PCM_HW_PARAM_SUBFORMAT
 358
 359 #define SNDRV_PCM_HW_PARAM_SAMPLE_BITS  8       /* Bits per sample */
 360 #define SNDRV_PCM_HW_PARAM_FRAME_BITS   9       /* Bits per frame */
 361 #define SNDRV_PCM_HW_PARAM_CHANNELS     10      /* Channels */
 362 #define SNDRV_PCM_HW_PARAM_RATE         11      /* Approx rate */
 363 #define SNDRV_PCM_HW_PARAM_PERIOD_TIME  12      /* Approx distance between
 364                                                  * interrupts in us
 365                                                  */
 366 #define SNDRV_PCM_HW_PARAM_PERIOD_SIZE  13      /* Approx frames between
 367                                                  * interrupts
 368                                                  */
 369 #define SNDRV_PCM_HW_PARAM_PERIOD_BYTES 14      /* Approx bytes between
 370                                                  * interrupts
 371                                                  */
 372 #define SNDRV_PCM_HW_PARAM_PERIODS      15      /* Approx interrupts per
 373                                                  * buffer
 374                                                  */
 375 #define SNDRV_PCM_HW_PARAM_BUFFER_TIME  16      /* Approx duration of buffer
 376                                                  * in us
 377                                                  */
 378 #define SNDRV_PCM_HW_PARAM_BUFFER_SIZE  17      /* Size of buffer in frames */
 379 #define SNDRV_PCM_HW_PARAM_BUFFER_BYTES 18      /* Size of buffer in bytes */
 380 #define SNDRV_PCM_HW_PARAM_TICK_TIME    19      /* Approx tick duration in us */
 381 #define SNDRV_PCM_HW_PARAM_FIRST_INTERVAL       SNDRV_PCM_HW_PARAM_SAMPLE_BITS
 382 #define SNDRV_PCM_HW_PARAM_LAST_INTERVAL        SNDRV_PCM_HW_PARAM_TICK_TIME
 383
 384 #define SNDRV_PCM_HW_PARAMS_NORESAMPLE  (1<<0)  /* avoid rate resampling */
 385 #define SNDRV_PCM_HW_PARAMS_EXPORT_BUFFER       (1<<1)  /* export buffer */
 386 #define SNDRV_PCM_HW_PARAMS_NO_PERIOD_WAKEUP    (1<<2)  /* disable period wakeups */
 387 #define SNDRV_PCM_HW_PARAMS_NO_DRAIN_SILENCE    (1<<3)  /* suppress drain with the filling
 388                                                          * of the silence samples
 389                                                          */
 390
 391 struct snd_interval {
 392         unsigned int min, max;
 393         unsigned int openmin:1,
 394                      openmax:1,
 395                      integer:1,
 396                      empty:1;
 397 };
 398
 399 #define SNDRV_MASK_MAX  256
 400
 401 struct snd_mask {
 402         __u32 bits[(SNDRV_MASK_MAX+31)/32];
 403 };
 404
 405 struct snd_pcm_hw_params {
 406         unsigned int flags;
 407         struct snd_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK -
 408                                SNDRV_PCM_HW_PARAM_FIRST_MASK + 1];
 409         struct snd_mask mres[5];        /* reserved masks */
 410         struct snd_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL -
 411                                         SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1];
 412         struct snd_interval ires[9];    /* reserved intervals */
 413         unsigned int rmask;             /* W: requested masks */
 414         unsigned int cmask;             /* R: changed masks */
 415         unsigned int info;              /* R: Info flags for returned setup */
 416         unsigned int msbits;            /* R: used most significant bits */
 417         unsigned int rate_num;          /* R: rate numerator */
 418         unsigned int rate_den;          /* R: rate denominator */
 419         snd_pcm_uframes_t fifo_size;    /* R: chip FIFO size in frames */
 420         unsigned char reserved[64];     /* reserved for future */
 421 };
 422
 423 enum {
 424         SNDRV_PCM_TSTAMP_NONE = 0,
 425         SNDRV_PCM_TSTAMP_ENABLE,
 426         SNDRV_PCM_TSTAMP_LAST = SNDRV_PCM_TSTAMP_ENABLE,
 427 };
 428
 429 struct snd_pcm_sw_params {
 430         int tstamp_mode;                        /* timestamp mode */
 431         unsigned int period_step;
 432         unsigned int sleep_min;                 /* min ticks to sleep */
 433         snd_pcm_uframes_t avail_min;            /* min avail frames for wakeup */
 434         snd_pcm_uframes_t xfer_align;           /* obsolete: xfer size need to be a multiple */
 435         snd_pcm_uframes_t start_threshold;      /* min hw_avail frames for automatic start */
 436         /*
 437          * The following two thresholds alleviate playback buffer underruns; when
 438          * hw_avail drops below the threshold, the respective action is triggered:
 439          */
 440         snd_pcm_uframes_t stop_threshold;       /* - stop playback */
 441         snd_pcm_uframes_t silence_threshold;    /* - pre-fill buffer with silence */
 442         snd_pcm_uframes_t silence_size;         /* max size of silence pre-fill; when >= boundary,
 443                                                  * fill played area with silence immediately */
 444         snd_pcm_uframes_t boundary;             /* pointers wrap point */
 445         unsigned int proto;                     /* protocol version */
 446         unsigned int tstamp_type;               /* timestamp type (req. proto >= 2.0.12) */
 447         unsigned char reserved[56];             /* reserved for future */
 448 };
 449
 450 struct snd_pcm_channel_info {
 451         unsigned int channel;
 452         __kernel_off_t offset;          /* mmap offset */
 453         unsigned int first;             /* offset to first sample in bits */
 454         unsigned int step;              /* samples distance in bits */
 455 };
 456
 457 enum {
 458         /*
 459          *  first definition for backwards compatibility only,
 460          *  maps to wallclock/link time for HDAudio playback and DEFAULT/DMA time for everything else
 461          */
 462         SNDRV_PCM_AUDIO_TSTAMP_TYPE_COMPAT = 0,
 463
 464         /* timestamp definitions */
 465         SNDRV_PCM_AUDIO_TSTAMP_TYPE_DEFAULT = 1,           /* DMA time, reported as per hw_ptr */
 466         SNDRV_PCM_AUDIO_TSTAMP_TYPE_LINK = 2,              /* link time reported by sample or wallclock counter, reset on startup */
 467         SNDRV_PCM_AUDIO_TSTAMP_TYPE_LINK_ABSOLUTE = 3,     /* link time reported by sample or wallclock counter, not reset on startup */
 468         SNDRV_PCM_AUDIO_TSTAMP_TYPE_LINK_ESTIMATED = 4,    /* link time estimated indirectly */
 469         SNDRV_PCM_AUDIO_TSTAMP_TYPE_LINK_SYNCHRONIZED = 5, /* link time synchronized with system time */
 470         SNDRV_PCM_AUDIO_TSTAMP_TYPE_LAST = SNDRV_PCM_AUDIO_TSTAMP_TYPE_LINK_SYNCHRONIZED
 471 };
 472
 473 #ifndef __KERNEL__
 474 /* explicit padding avoids incompatibility between i386 and x86-64 */
 475 typedef struct { unsigned char pad[sizeof(time_t) - sizeof(int)]; } __time_pad;
 476
 477 struct snd_pcm_status {
 478         snd_pcm_state_t state;          /* stream state */
 479         __time_pad pad1;                /* align to timespec */
 480         struct timespec trigger_tstamp; /* time when stream was started/stopped/paused */
 481         struct timespec tstamp;         /* reference timestamp */
 482         snd_pcm_uframes_t appl_ptr;     /* appl ptr */
 483         snd_pcm_uframes_t hw_ptr;       /* hw ptr */
 484         snd_pcm_sframes_t delay;        /* current delay in frames */
 485         snd_pcm_uframes_t avail;        /* number of frames available */
 486         snd_pcm_uframes_t avail_max;    /* max frames available on hw since last status */
 487         snd_pcm_uframes_t overrange;    /* count of ADC (capture) overrange detections from last status */
 488         snd_pcm_state_t suspended_state; /* suspended stream state */
 489         __u32 audio_tstamp_data;         /* needed for 64-bit alignment, used for configs/report to/from userspace */
 490         struct timespec audio_tstamp;   /* sample counter, wall clock, PHC or on-demand sync'ed */
 491         struct timespec driver_tstamp;  /* useful in case reference system tstamp is reported with delay */
 492         __u32 audio_tstamp_accuracy;    /* in ns units, only valid if indicated in audio_tstamp_data */
 493         unsigned char reserved[52-2*sizeof(struct timespec)]; /* must be filled with zero */
 494 };
 495 #endif
 496
 497 /*
 498  * For mmap operations, we need the 64-bit layout, both for compat mode,
 499  * and for y2038 compatibility. For 64-bit applications, the two definitions
 500  * are identical, so we keep the traditional version.
 501  */
 502 #ifdef __SND_STRUCT_TIME64
 503 #define __snd_pcm_mmap_status64         snd_pcm_mmap_status
 504 #define __snd_pcm_mmap_control64        snd_pcm_mmap_control
 505 #define __snd_pcm_sync_ptr64            snd_pcm_sync_ptr
 506 #ifdef __KERNEL__
 507 #define __snd_timespec64                __kernel_timespec
 508 #else
 509 #define __snd_timespec64                timespec
 510 #endif
 511 struct __snd_timespec {
 512         __s32 tv_sec;
 513         __s32 tv_nsec;
 514 };
 515 #else
 516 #define __snd_pcm_mmap_status           snd_pcm_mmap_status
 517 #define __snd_pcm_mmap_control          snd_pcm_mmap_control
 518 #define __snd_pcm_sync_ptr              snd_pcm_sync_ptr
 519 #define __snd_timespec                  timespec
 520 struct __snd_timespec64 {
 521         __s64 tv_sec;
 522         __s64 tv_nsec;
 523 };
 524
 525 #endif
 526
 527 struct __snd_pcm_mmap_status {
 528         snd_pcm_state_t state;          /* RO: state - SNDRV_PCM_STATE_XXXX */
 529         int pad1;                       /* Needed for 64 bit alignment */
 530         snd_pcm_uframes_t hw_ptr;       /* RO: hw ptr (0...boundary-1) */
 531         struct __snd_timespec tstamp;   /* Timestamp */
 532         snd_pcm_state_t suspended_state; /* RO: suspended stream state */
 533         struct __snd_timespec audio_tstamp; /* from sample counter or wall clock */
 534 };
 535
 536 struct __snd_pcm_mmap_control {
 537         snd_pcm_uframes_t appl_ptr;     /* RW: appl ptr (0...boundary-1) */
 538         snd_pcm_uframes_t avail_min;    /* RW: min available frames for wakeup */
 539 };
 540
 541 #define SNDRV_PCM_SYNC_PTR_HWSYNC       (1<<0)  /* execute hwsync */
 542 #define SNDRV_PCM_SYNC_PTR_APPL         (1<<1)  /* get appl_ptr from driver (r/w op) */
 543 #define SNDRV_PCM_SYNC_PTR_AVAIL_MIN    (1<<2)  /* get avail_min from driver */
 544
 545 struct __snd_pcm_sync_ptr {
 546         unsigned int flags;
 547         union {
 548                 struct __snd_pcm_mmap_status status;
 549                 unsigned char reserved[64];
 550         } s;
 551         union {
 552                 struct __snd_pcm_mmap_control control;
 553                 unsigned char reserved[64];
 554         } c;
 555 };
 556
 557 #if defined(__BYTE_ORDER) ? __BYTE_ORDER == __BIG_ENDIAN : defined(__BIG_ENDIAN)
 558 typedef char __pad_before_uframe[sizeof(__u64) - sizeof(snd_pcm_uframes_t)];
 559 typedef char __pad_after_uframe[0];
 560 #endif
 561
 562 #if defined(__BYTE_ORDER) ? __BYTE_ORDER == __LITTLE_ENDIAN : defined(__LITTLE_ENDIAN)
 563 typedef char __pad_before_uframe[0];
 564 typedef char __pad_after_uframe[sizeof(__u64) - sizeof(snd_pcm_uframes_t)];
 565 #endif
 566
 567 struct __snd_pcm_mmap_status64 {
 568         snd_pcm_state_t state;          /* RO: state - SNDRV_PCM_STATE_XXXX */
 569         __u32 pad1;                     /* Needed for 64 bit alignment */
 570         __pad_before_uframe __pad1;
 571         snd_pcm_uframes_t hw_ptr;       /* RO: hw ptr (0...boundary-1) */
 572         __pad_after_uframe __pad2;
 573         struct __snd_timespec64 tstamp; /* Timestamp */
 574         snd_pcm_state_t suspended_state;/* RO: suspended stream state */
 575         __u32 pad3;                     /* Needed for 64 bit alignment */
 576         struct __snd_timespec64 audio_tstamp; /* sample counter or wall clock */
 577 };
 578
 579 struct __snd_pcm_mmap_control64 {
 580         __pad_before_uframe __pad1;
 581         snd_pcm_uframes_t appl_ptr;      /* RW: appl ptr (0...boundary-1) */
 582         __pad_before_uframe __pad2;      // This should be __pad_after_uframe, but binary
 583                                          // backwards compatibility constraints prevent a fix.
 584
 585         __pad_before_uframe __pad3;
 586         snd_pcm_uframes_t  avail_min;    /* RW: min available frames for wakeup */
 587         __pad_after_uframe __pad4;
 588 };
 589
 590 struct __snd_pcm_sync_ptr64 {
 591         __u32 flags;
 592         __u32 pad1;
 593         union {
 594                 struct __snd_pcm_mmap_status64 status;
 595                 unsigned char reserved[64];
 596         } s;
 597         union {
 598                 struct __snd_pcm_mmap_control64 control;
 599                 unsigned char reserved[64];
 600         } c;
 601 };
 602
 603 struct snd_xferi {
 604         snd_pcm_sframes_t result;
 605         void __user *buf;
 606         snd_pcm_uframes_t frames;
 607 };
 608
 609 struct snd_xfern {
 610         snd_pcm_sframes_t result;
 611         void __user * __user *bufs;
 612         snd_pcm_uframes_t frames;
 613 };
 614
 615 enum {
 616         SNDRV_PCM_TSTAMP_TYPE_GETTIMEOFDAY = 0, /* gettimeofday equivalent */
 617         SNDRV_PCM_TSTAMP_TYPE_MONOTONIC,        /* posix_clock_monotonic equivalent */
 618         SNDRV_PCM_TSTAMP_TYPE_MONOTONIC_RAW,    /* monotonic_raw (no NTP) */
 619         SNDRV_PCM_TSTAMP_TYPE_LAST = SNDRV_PCM_TSTAMP_TYPE_MONOTONIC_RAW,
 620 };
 621
 622 /* channel positions */
 623 enum {
 624         SNDRV_CHMAP_UNKNOWN = 0,
 625         SNDRV_CHMAP_NA,         /* N/A, silent */
 626         SNDRV_CHMAP_MONO,       /* mono stream */
 627         /* this follows the alsa-lib mixer channel value + 3 */
 628         SNDRV_CHMAP_FL,         /* front left */
 629         SNDRV_CHMAP_FR,         /* front right */
 630         SNDRV_CHMAP_RL,         /* rear left */
 631         SNDRV_CHMAP_RR,         /* rear right */
 632         SNDRV_CHMAP_FC,         /* front center */
 633         SNDRV_CHMAP_LFE,        /* LFE */
 634         SNDRV_CHMAP_SL,         /* side left */
 635         SNDRV_CHMAP_SR,         /* side right */
 636         SNDRV_CHMAP_RC,         /* rear center */
 637         /* new definitions */
 638         SNDRV_CHMAP_FLC,        /* front left center */
 639         SNDRV_CHMAP_FRC,        /* front right center */
 640         SNDRV_CHMAP_RLC,        /* rear left center */
 641         SNDRV_CHMAP_RRC,        /* rear right center */
 642         SNDRV_CHMAP_FLW,        /* front left wide */
 643         SNDRV_CHMAP_FRW,        /* front right wide */
 644         SNDRV_CHMAP_FLH,        /* front left high */
 645         SNDRV_CHMAP_FCH,        /* front center high */
 646         SNDRV_CHMAP_FRH,        /* front right high */
 647         SNDRV_CHMAP_TC,         /* top center */
 648         SNDRV_CHMAP_TFL,        /* top front left */
 649         SNDRV_CHMAP_TFR,        /* top front right */
 650         SNDRV_CHMAP_TFC,        /* top front center */
 651         SNDRV_CHMAP_TRL,        /* top rear left */
 652         SNDRV_CHMAP_TRR,        /* top rear right */
 653         SNDRV_CHMAP_TRC,        /* top rear center */
 654         /* new definitions for UAC2 */
 655         SNDRV_CHMAP_TFLC,       /* top front left center */
 656         SNDRV_CHMAP_TFRC,       /* top front right center */
 657         SNDRV_CHMAP_TSL,        /* top side left */
 658         SNDRV_CHMAP_TSR,        /* top side right */
 659         SNDRV_CHMAP_LLFE,       /* left LFE */
 660         SNDRV_CHMAP_RLFE,       /* right LFE */
 661         SNDRV_CHMAP_BC,         /* bottom center */
 662         SNDRV_CHMAP_BLC,        /* bottom left center */
 663         SNDRV_CHMAP_BRC,        /* bottom right center */
 664         SNDRV_CHMAP_LAST = SNDRV_CHMAP_BRC,
 665 };
 666
 667 #define SNDRV_CHMAP_POSITION_MASK       0xffff
 668 #define SNDRV_CHMAP_PHASE_INVERSE       (0x01 << 16)
 669 #define SNDRV_CHMAP_DRIVER_SPEC         (0x02 << 16)
 670
 671 #define SNDRV_PCM_IOCTL_PVERSION        _IOR('A', 0x00, int)
 672 #define SNDRV_PCM_IOCTL_INFO            _IOR('A', 0x01, struct snd_pcm_info)
 673 #define SNDRV_PCM_IOCTL_TSTAMP          _IOW('A', 0x02, int)
 674 #define SNDRV_PCM_IOCTL_TTSTAMP         _IOW('A', 0x03, int)
 675 #define SNDRV_PCM_IOCTL_USER_PVERSION   _IOW('A', 0x04, int)
 676 #define SNDRV_PCM_IOCTL_HW_REFINE       _IOWR('A', 0x10, struct snd_pcm_hw_params)
 677 #define SNDRV_PCM_IOCTL_HW_PARAMS       _IOWR('A', 0x11, struct snd_pcm_hw_params)
 678 #define SNDRV_PCM_IOCTL_HW_FREE         _IO('A', 0x12)
 679 #define SNDRV_PCM_IOCTL_SW_PARAMS       _IOWR('A', 0x13, struct snd_pcm_sw_params)
 680 #define SNDRV_PCM_IOCTL_STATUS          _IOR('A', 0x20, struct snd_pcm_status)
 681 #define SNDRV_PCM_IOCTL_DELAY           _IOR('A', 0x21, snd_pcm_sframes_t)
 682 #define SNDRV_PCM_IOCTL_HWSYNC          _IO('A', 0x22)
 683 #define __SNDRV_PCM_IOCTL_SYNC_PTR      _IOWR('A', 0x23, struct __snd_pcm_sync_ptr)
 684 #define __SNDRV_PCM_IOCTL_SYNC_PTR64    _IOWR('A', 0x23, struct __snd_pcm_sync_ptr64)
 685 #define SNDRV_PCM_IOCTL_SYNC_PTR        _IOWR('A', 0x23, struct snd_pcm_sync_ptr)
 686 #define SNDRV_PCM_IOCTL_STATUS_EXT      _IOWR('A', 0x24, struct snd_pcm_status)
 687 #define SNDRV_PCM_IOCTL_CHANNEL_INFO    _IOR('A', 0x32, struct snd_pcm_channel_info)
 688 #define SNDRV_PCM_IOCTL_PREPARE         _IO('A', 0x40)
 689 #define SNDRV_PCM_IOCTL_RESET           _IO('A', 0x41)
 690 #define SNDRV_PCM_IOCTL_START           _IO('A', 0x42)
 691 #define SNDRV_PCM_IOCTL_DROP            _IO('A', 0x43)
 692 #define SNDRV_PCM_IOCTL_DRAIN           _IO('A', 0x44)
 693 #define SNDRV_PCM_IOCTL_PAUSE           _IOW('A', 0x45, int)
 694 #define SNDRV_PCM_IOCTL_REWIND          _IOW('A', 0x46, snd_pcm_uframes_t)
 695 #define SNDRV_PCM_IOCTL_RESUME          _IO('A', 0x47)
 696 #define SNDRV_PCM_IOCTL_XRUN            _IO('A', 0x48)
 697 #define SNDRV_PCM_IOCTL_FORWARD         _IOW('A', 0x49, snd_pcm_uframes_t)
 698 #define SNDRV_PCM_IOCTL_WRITEI_FRAMES   _IOW('A', 0x50, struct snd_xferi)
 699 #define SNDRV_PCM_IOCTL_READI_FRAMES    _IOR('A', 0x51, struct snd_xferi)
 700 #define SNDRV_PCM_IOCTL_WRITEN_FRAMES   _IOW('A', 0x52, struct snd_xfern)
 701 #define SNDRV_PCM_IOCTL_READN_FRAMES    _IOR('A', 0x53, struct snd_xfern)
 702 #define SNDRV_PCM_IOCTL_LINK            _IOW('A', 0x60, int)
 703 #define SNDRV_PCM_IOCTL_UNLINK          _IO('A', 0x61)
 704
 705 /*****************************************************************************
 706  *                                                                           *
 707  *                            MIDI v1.0 interface                            *
 708  *                                                                           *
 709  *****************************************************************************/
 710
 711 /*
 712  *  Raw MIDI section - /dev/snd/midi??
 713  */
 714
 715 #define SNDRV_RAWMIDI_VERSION           SNDRV_PROTOCOL_VERSION(2, 0, 4)
 716
 717 enum {
 718         SNDRV_RAWMIDI_STREAM_OUTPUT = 0,
 719         SNDRV_RAWMIDI_STREAM_INPUT,
 720         SNDRV_RAWMIDI_STREAM_LAST = SNDRV_RAWMIDI_STREAM_INPUT,
 721 };
 722
 723 #define SNDRV_RAWMIDI_INFO_OUTPUT               0x00000001
 724 #define SNDRV_RAWMIDI_INFO_INPUT                0x00000002
 725 #define SNDRV_RAWMIDI_INFO_DUPLEX               0x00000004
 726 #define SNDRV_RAWMIDI_INFO_UMP                  0x00000008
 727
 728 struct snd_rawmidi_info {
 729         unsigned int device;            /* RO/WR (control): device number */
 730         unsigned int subdevice;         /* RO/WR (control): subdevice number */
 731         int stream;                     /* WR: stream */
 732         int card;                       /* R: card number */
 733         unsigned int flags;             /* SNDRV_RAWMIDI_INFO_XXXX */
 734         unsigned char id[64];           /* ID (user selectable) */
 735         unsigned char name[80];         /* name of device */
 736         unsigned char subname[32];      /* name of active or selected subdevice */
 737         unsigned int subdevices_count;
 738         unsigned int subdevices_avail;
 739         unsigned char reserved[64];     /* reserved for future use */
 740 };
 741
 742 #define SNDRV_RAWMIDI_MODE_FRAMING_MASK         (7<<0)
 743 #define SNDRV_RAWMIDI_MODE_FRAMING_SHIFT        0
 744 #define SNDRV_RAWMIDI_MODE_FRAMING_NONE         (0<<0)
 745 #define SNDRV_RAWMIDI_MODE_FRAMING_TSTAMP       (1<<0)
 746 #define SNDRV_RAWMIDI_MODE_CLOCK_MASK           (7<<3)
 747 #define SNDRV_RAWMIDI_MODE_CLOCK_SHIFT          3
 748 #define SNDRV_RAWMIDI_MODE_CLOCK_NONE           (0<<3)
 749 #define SNDRV_RAWMIDI_MODE_CLOCK_REALTIME       (1<<3)
 750 #define SNDRV_RAWMIDI_MODE_CLOCK_MONOTONIC      (2<<3)
 751 #define SNDRV_RAWMIDI_MODE_CLOCK_MONOTONIC_RAW  (3<<3)
 752
 753 #define SNDRV_RAWMIDI_FRAMING_DATA_LENGTH 16
 754
 755 struct snd_rawmidi_framing_tstamp {
 756         /* For now, frame_type is always 0. Midi 2.0 is expected to add new
 757          * types here. Applications are expected to skip unknown frame types.
 758          */
 759         __u8 frame_type;
 760         __u8 length; /* number of valid bytes in data field */
 761         __u8 reserved[2];
 762         __u32 tv_nsec;          /* nanoseconds */
 763         __u64 tv_sec;           /* seconds */
 764         __u8 data[SNDRV_RAWMIDI_FRAMING_DATA_LENGTH];
 765 } __packed;
 766
 767 struct snd_rawmidi_params {
 768         int stream;
 769         size_t buffer_size;             /* queue size in bytes */
 770         size_t avail_min;               /* minimum avail bytes for wakeup */
 771         unsigned int no_active_sensing: 1; /* do not send active sensing byte in close() */
 772         unsigned int mode;              /* For input data only, frame incoming data */
 773         unsigned char reserved[12];     /* reserved for future use */
 774 };
 775
 776 #ifndef __KERNEL__
 777 struct snd_rawmidi_status {
 778         int stream;
 779         __time_pad pad1;
 780         struct timespec tstamp;         /* Timestamp */
 781         size_t avail;                   /* available bytes */
 782         size_t xruns;                   /* count of overruns since last status (in bytes) */
 783         unsigned char reserved[16];     /* reserved for future use */
 784 };
 785 #endif
 786
 787 /* UMP EP info flags */
 788 #define SNDRV_UMP_EP_INFO_STATIC_BLOCKS         0x01
 789
 790 /* UMP EP Protocol / JRTS capability bits */
 791 #define SNDRV_UMP_EP_INFO_PROTO_MIDI_MASK       0x0300
 792 #define SNDRV_UMP_EP_INFO_PROTO_MIDI1           0x0100 /* MIDI 1.0 */
 793 #define SNDRV_UMP_EP_INFO_PROTO_MIDI2           0x0200 /* MIDI 2.0 */
 794 #define SNDRV_UMP_EP_INFO_PROTO_JRTS_MASK       0x0003
 795 #define SNDRV_UMP_EP_INFO_PROTO_JRTS_TX         0x0001 /* JRTS Transmit */
 796 #define SNDRV_UMP_EP_INFO_PROTO_JRTS_RX         0x0002 /* JRTS Receive */
 797
 798 /* UMP Endpoint information */
 799 struct snd_ump_endpoint_info {
 800         int card;                       /* card number */
 801         int device;                     /* device number */
 802         unsigned int flags;             /* additional info */
 803         unsigned int protocol_caps;     /* protocol capabilities */
 804         unsigned int protocol;          /* current protocol */
 805         unsigned int num_blocks;        /* # of function blocks */
 806         unsigned short version;         /* UMP major/minor version */
 807         unsigned short family_id;       /* MIDI device family ID */
 808         unsigned short model_id;        /* MIDI family model ID */
 809         unsigned int manufacturer_id;   /* MIDI manufacturer ID */
 810         unsigned char sw_revision[4];   /* software revision */
 811         unsigned short padding;
 812         unsigned char name[128];        /* endpoint name string */
 813         unsigned char product_id[128];  /* unique product id string */
 814         unsigned char reserved[32];
 815 } __packed;
 816
 817 /* UMP direction */
 818 #define SNDRV_UMP_DIR_INPUT             0x01
 819 #define SNDRV_UMP_DIR_OUTPUT            0x02
 820 #define SNDRV_UMP_DIR_BIDIRECTION       0x03
 821
 822 /* UMP block info flags */
 823 #define SNDRV_UMP_BLOCK_IS_MIDI1        (1U << 0) /* MIDI 1.0 port w/o restrict */
 824 #define SNDRV_UMP_BLOCK_IS_LOWSPEED     (1U << 1) /* 31.25Kbps B/W MIDI1 port */
 825
 826 /* UMP block user-interface hint */
 827 #define SNDRV_UMP_BLOCK_UI_HINT_UNKNOWN         0x00
 828 #define SNDRV_UMP_BLOCK_UI_HINT_RECEIVER        0x01
 829 #define SNDRV_UMP_BLOCK_UI_HINT_SENDER          0x02
 830 #define SNDRV_UMP_BLOCK_UI_HINT_BOTH            0x03
 831
 832 /* UMP groups and blocks */
 833 #define SNDRV_UMP_MAX_GROUPS            16
 834 #define SNDRV_UMP_MAX_BLOCKS            32
 835
 836 /* UMP Block information */
 837 struct snd_ump_block_info {
 838         int card;                       /* card number */
 839         int device;                     /* device number */
 840         unsigned char block_id;         /* block ID (R/W) */
 841         unsigned char direction;        /* UMP direction */
 842         unsigned char active;           /* Activeness */
 843         unsigned char first_group;      /* first group ID */
 844         unsigned char num_groups;       /* number of groups */
 845         unsigned char midi_ci_version;  /* MIDI-CI support version */
 846         unsigned char sysex8_streams;   /* max number of sysex8 streams */
 847         unsigned char ui_hint;          /* user interface hint */
 848         unsigned int flags;             /* various info flags */
 849         unsigned char name[128];        /* block name string */
 850         unsigned char reserved[32];
 851 } __packed;
 852
 853 #define SNDRV_RAWMIDI_IOCTL_PVERSION    _IOR('W', 0x00, int)
 854 #define SNDRV_RAWMIDI_IOCTL_INFO        _IOR('W', 0x01, struct snd_rawmidi_info)
 855 #define SNDRV_RAWMIDI_IOCTL_USER_PVERSION _IOW('W', 0x02, int)
 856 #define SNDRV_RAWMIDI_IOCTL_PARAMS      _IOWR('W', 0x10, struct snd_rawmidi_params)
 857 #define SNDRV_RAWMIDI_IOCTL_STATUS      _IOWR('W', 0x20, struct snd_rawmidi_status)
 858 #define SNDRV_RAWMIDI_IOCTL_DROP        _IOW('W', 0x30, int)
 859 #define SNDRV_RAWMIDI_IOCTL_DRAIN       _IOW('W', 0x31, int)
 860 /* Additional ioctls for UMP rawmidi devices */
 861 #define SNDRV_UMP_IOCTL_ENDPOINT_INFO   _IOR('W', 0x40, struct snd_ump_endpoint_info)
 862 #define SNDRV_UMP_IOCTL_BLOCK_INFO      _IOR('W', 0x41, struct snd_ump_block_info)
 863
 864 /*
 865  *  Timer section - /dev/snd/timer
 866  */
 867
 868 #define SNDRV_TIMER_VERSION             SNDRV_PROTOCOL_VERSION(2, 0, 7)
 869
 870 enum {
 871         SNDRV_TIMER_CLASS_NONE = -1,
 872         SNDRV_TIMER_CLASS_SLAVE = 0,
 873         SNDRV_TIMER_CLASS_GLOBAL,
 874         SNDRV_TIMER_CLASS_CARD,
 875         SNDRV_TIMER_CLASS_PCM,
 876         SNDRV_TIMER_CLASS_LAST = SNDRV_TIMER_CLASS_PCM,
 877 };
 878
 879 /* slave timer classes */
 880 enum {
 881         SNDRV_TIMER_SCLASS_NONE = 0,
 882         SNDRV_TIMER_SCLASS_APPLICATION,
 883         SNDRV_TIMER_SCLASS_SEQUENCER,           /* alias */
 884         SNDRV_TIMER_SCLASS_OSS_SEQUENCER,       /* alias */
 885         SNDRV_TIMER_SCLASS_LAST = SNDRV_TIMER_SCLASS_OSS_SEQUENCER,
 886 };
 887
 888 /* global timers (device member) */
 889 #define SNDRV_TIMER_GLOBAL_SYSTEM       0
 890 #define SNDRV_TIMER_GLOBAL_RTC          1       /* unused */
 891 #define SNDRV_TIMER_GLOBAL_HPET         2
 892 #define SNDRV_TIMER_GLOBAL_HRTIMER      3
 893
 894 /* info flags */
 895 #define SNDRV_TIMER_FLG_SLAVE           (1<<0)  /* cannot be controlled */
 896
 897 struct snd_timer_id {
 898         int dev_class;
 899         int dev_sclass;
 900         int card;
 901         int device;
 902         int subdevice;
 903 };
 904
 905 struct snd_timer_ginfo {
 906         struct snd_timer_id tid;        /* requested timer ID */
 907         unsigned int flags;             /* timer flags - SNDRV_TIMER_FLG_* */
 908         int card;                       /* card number */
 909         unsigned char id[64];           /* timer identification */
 910         unsigned char name[80];         /* timer name */
 911         unsigned long reserved0;        /* reserved for future use */
 912         unsigned long resolution;       /* average period resolution in ns */
 913         unsigned long resolution_min;   /* minimal period resolution in ns */
 914         unsigned long resolution_max;   /* maximal period resolution in ns */
 915         unsigned int clients;           /* active timer clients */
 916         unsigned char reserved[32];
 917 };
 918
 919 struct snd_timer_gparams {
 920         struct snd_timer_id tid;        /* requested timer ID */
 921         unsigned long period_num;       /* requested precise period duration (in seconds) - numerator */
 922         unsigned long period_den;       /* requested precise period duration (in seconds) - denominator */
 923         unsigned char reserved[32];
 924 };
 925
 926 struct snd_timer_gstatus {
 927         struct snd_timer_id tid;        /* requested timer ID */
 928         unsigned long resolution;       /* current period resolution in ns */
 929         unsigned long resolution_num;   /* precise current period resolution (in seconds) - numerator */
 930         unsigned long resolution_den;   /* precise current period resolution (in seconds) - denominator */
 931         unsigned char reserved[32];
 932 };
 933
 934 struct snd_timer_select {
 935         struct snd_timer_id id; /* bind to timer ID */
 936         unsigned char reserved[32];     /* reserved */
 937 };
 938
 939 struct snd_timer_info {
 940         unsigned int flags;             /* timer flags - SNDRV_TIMER_FLG_* */
 941         int card;                       /* card number */
 942         unsigned char id[64];           /* timer identificator */
 943         unsigned char name[80];         /* timer name */
 944         unsigned long reserved0;        /* reserved for future use */
 945         unsigned long resolution;       /* average period resolution in ns */
 946         unsigned char reserved[64];     /* reserved */
 947 };
 948
 949 #define SNDRV_TIMER_PSFLG_AUTO          (1<<0)  /* auto start, otherwise one-shot */
 950 #define SNDRV_TIMER_PSFLG_EXCLUSIVE     (1<<1)  /* exclusive use, precise start/stop/pause/continue */
 951 #define SNDRV_TIMER_PSFLG_EARLY_EVENT   (1<<2)  /* write early event to the poll queue */
 952
 953 struct snd_timer_params {
 954         unsigned int flags;             /* flags - SNDRV_TIMER_PSFLG_* */
 955         unsigned int ticks;             /* requested resolution in ticks */
 956         unsigned int queue_size;        /* total size of queue (32-1024) */
 957         unsigned int reserved0;         /* reserved, was: failure locations */
 958         unsigned int filter;            /* event filter (bitmask of SNDRV_TIMER_EVENT_*) */
 959         unsigned char reserved[60];     /* reserved */
 960 };
 961
 962 #ifndef __KERNEL__
 963 struct snd_timer_status {
 964         struct timespec tstamp;         /* Timestamp - last update */
 965         unsigned int resolution;        /* current period resolution in ns */
 966         unsigned int lost;              /* counter of master tick lost */
 967         unsigned int overrun;           /* count of read queue overruns */
 968         unsigned int queue;             /* used queue size */
 969         unsigned char reserved[64];     /* reserved */
 970 };
 971 #endif
 972
 973 #define SNDRV_TIMER_IOCTL_PVERSION      _IOR('T', 0x00, int)
 974 #define SNDRV_TIMER_IOCTL_NEXT_DEVICE   _IOWR('T', 0x01, struct snd_timer_id)
 975 #define SNDRV_TIMER_IOCTL_TREAD_OLD     _IOW('T', 0x02, int)
 976 #define SNDRV_TIMER_IOCTL_GINFO         _IOWR('T', 0x03, struct snd_timer_ginfo)
 977 #define SNDRV_TIMER_IOCTL_GPARAMS       _IOW('T', 0x04, struct snd_timer_gparams)
 978 #define SNDRV_TIMER_IOCTL_GSTATUS       _IOWR('T', 0x05, struct snd_timer_gstatus)
 979 #define SNDRV_TIMER_IOCTL_SELECT        _IOW('T', 0x10, struct snd_timer_select)
 980 #define SNDRV_TIMER_IOCTL_INFO          _IOR('T', 0x11, struct snd_timer_info)
 981 #define SNDRV_TIMER_IOCTL_PARAMS        _IOW('T', 0x12, struct snd_timer_params)
 982 #define SNDRV_TIMER_IOCTL_STATUS        _IOR('T', 0x14, struct snd_timer_status)
 983 /* The following four ioctls are changed since 1.0.9 due to confliction */
 984 #define SNDRV_TIMER_IOCTL_START         _IO('T', 0xa0)
 985 #define SNDRV_TIMER_IOCTL_STOP          _IO('T', 0xa1)
 986 #define SNDRV_TIMER_IOCTL_CONTINUE      _IO('T', 0xa2)
 987 #define SNDRV_TIMER_IOCTL_PAUSE         _IO('T', 0xa3)
 988 #define SNDRV_TIMER_IOCTL_TREAD64       _IOW('T', 0xa4, int)
 989
 990 #if __BITS_PER_LONG == 64
 991 #define SNDRV_TIMER_IOCTL_TREAD SNDRV_TIMER_IOCTL_TREAD_OLD
 992 #else
 993 #define SNDRV_TIMER_IOCTL_TREAD ((sizeof(__kernel_long_t) >= sizeof(time_t)) ? \
 994                                  SNDRV_TIMER_IOCTL_TREAD_OLD : \
 995                                  SNDRV_TIMER_IOCTL_TREAD64)
 996 #endif
 997
 998 struct snd_timer_read {
 999         unsigned int resolution;
1000         unsigned int ticks;
1001 };
1002
1003 enum {
1004         SNDRV_TIMER_EVENT_RESOLUTION = 0,       /* val = resolution in ns */
1005         SNDRV_TIMER_EVENT_TICK,                 /* val = ticks */
1006         SNDRV_TIMER_EVENT_START,                /* val = resolution in ns */
1007         SNDRV_TIMER_EVENT_STOP,                 /* val = 0 */
1008         SNDRV_TIMER_EVENT_CONTINUE,             /* val = resolution in ns */
1009         SNDRV_TIMER_EVENT_PAUSE,                /* val = 0 */
1010         SNDRV_TIMER_EVENT_EARLY,                /* val = 0, early event */
1011         SNDRV_TIMER_EVENT_SUSPEND,              /* val = 0 */
1012         SNDRV_TIMER_EVENT_RESUME,               /* val = resolution in ns */
1013         /* master timer events for slave timer instances */
1014         SNDRV_TIMER_EVENT_MSTART = SNDRV_TIMER_EVENT_START + 10,
1015         SNDRV_TIMER_EVENT_MSTOP = SNDRV_TIMER_EVENT_STOP + 10,
1016         SNDRV_TIMER_EVENT_MCONTINUE = SNDRV_TIMER_EVENT_CONTINUE + 10,
1017         SNDRV_TIMER_EVENT_MPAUSE = SNDRV_TIMER_EVENT_PAUSE + 10,
1018         SNDRV_TIMER_EVENT_MSUSPEND = SNDRV_TIMER_EVENT_SUSPEND + 10,
1019         SNDRV_TIMER_EVENT_MRESUME = SNDRV_TIMER_EVENT_RESUME + 10,
1020 };
1021
1022 #ifndef __KERNEL__
1023 struct snd_timer_tread {
1024         int event;
1025         __time_pad pad1;
1026         struct timespec tstamp;
1027         unsigned int val;
1028         __time_pad pad2;
1029 };
1030 #endif
1031
1032 /****************************************************************************
1033  *                                                                          *
1034  *        Section for driver control interface - /dev/snd/control?          *
1035  *                                                                          *
1036  ****************************************************************************/
1037
1038 #define SNDRV_CTL_VERSION               SNDRV_PROTOCOL_VERSION(2, 0, 9)
1039
1040 struct snd_ctl_card_info {
1041         int card;                       /* card number */
1042         int pad;                        /* reserved for future (was type) */
1043         unsigned char id[16];           /* ID of card (user selectable) */
1044         unsigned char driver[16];       /* Driver name */
1045         unsigned char name[32];         /* Short name of soundcard */
1046         unsigned char longname[80];     /* name + info text about soundcard */
1047         unsigned char reserved_[16];    /* reserved for future (was ID of mixer) */
1048         unsigned char mixername[80];    /* visual mixer identification */
1049         unsigned char components[128];  /* card components / fine identification, delimited with one space (AC97 etc..) */
1050 };
1051
1052 typedef int __bitwise snd_ctl_elem_type_t;
1053 #define SNDRV_CTL_ELEM_TYPE_NONE        ((__force snd_ctl_elem_type_t) 0) /* invalid */
1054 #define SNDRV_CTL_ELEM_TYPE_BOOLEAN     ((__force snd_ctl_elem_type_t) 1) /* boolean type */
1055 #define SNDRV_CTL_ELEM_TYPE_INTEGER     ((__force snd_ctl_elem_type_t) 2) /* integer type */
1056 #define SNDRV_CTL_ELEM_TYPE_ENUMERATED  ((__force snd_ctl_elem_type_t) 3) /* enumerated type */
1057 #define SNDRV_CTL_ELEM_TYPE_BYTES       ((__force snd_ctl_elem_type_t) 4) /* byte array */
1058 #define SNDRV_CTL_ELEM_TYPE_IEC958      ((__force snd_ctl_elem_type_t) 5) /* IEC958 (S/PDIF) setup */
1059 #define SNDRV_CTL_ELEM_TYPE_INTEGER64   ((__force snd_ctl_elem_type_t) 6) /* 64-bit integer type */
1060 #define SNDRV_CTL_ELEM_TYPE_LAST        SNDRV_CTL_ELEM_TYPE_INTEGER64
1061
1062 typedef int __bitwise snd_ctl_elem_iface_t;
1063 #define SNDRV_CTL_ELEM_IFACE_CARD       ((__force snd_ctl_elem_iface_t) 0) /* global control */
1064 #define SNDRV_CTL_ELEM_IFACE_HWDEP      ((__force snd_ctl_elem_iface_t) 1) /* hardware dependent device */
1065 #define SNDRV_CTL_ELEM_IFACE_MIXER      ((__force snd_ctl_elem_iface_t) 2) /* virtual mixer device */
1066 #define SNDRV_CTL_ELEM_IFACE_PCM        ((__force snd_ctl_elem_iface_t) 3) /* PCM device */
1067 #define SNDRV_CTL_ELEM_IFACE_RAWMIDI    ((__force snd_ctl_elem_iface_t) 4) /* RawMidi device */
1068 #define SNDRV_CTL_ELEM_IFACE_TIMER      ((__force snd_ctl_elem_iface_t) 5) /* timer device */
1069 #define SNDRV_CTL_ELEM_IFACE_SEQUENCER  ((__force snd_ctl_elem_iface_t) 6) /* sequencer client */
1070 #define SNDRV_CTL_ELEM_IFACE_LAST       SNDRV_CTL_ELEM_IFACE_SEQUENCER
1071
1072 #define SNDRV_CTL_ELEM_ACCESS_READ              (1<<0)
1073 #define SNDRV_CTL_ELEM_ACCESS_WRITE             (1<<1)
1074 #define SNDRV_CTL_ELEM_ACCESS_READWRITE         (SNDRV_CTL_ELEM_ACCESS_READ|SNDRV_CTL_ELEM_ACCESS_WRITE)
1075 #define SNDRV_CTL_ELEM_ACCESS_VOLATILE          (1<<2)  /* control value may be changed without a notification */
1076 /* (1 << 3) is unused. */
1077 #define SNDRV_CTL_ELEM_ACCESS_TLV_READ          (1<<4)  /* TLV read is possible */
1078 #define SNDRV_CTL_ELEM_ACCESS_TLV_WRITE         (1<<5)  /* TLV write is possible */
1079 #define SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE     (SNDRV_CTL_ELEM_ACCESS_TLV_READ|SNDRV_CTL_ELEM_ACCESS_TLV_WRITE)
1080 #define SNDRV_CTL_ELEM_ACCESS_TLV_COMMAND       (1<<6)  /* TLV command is possible */
1081 #define SNDRV_CTL_ELEM_ACCESS_INACTIVE          (1<<8)  /* control does actually nothing, but may be updated */
1082 #define SNDRV_CTL_ELEM_ACCESS_LOCK              (1<<9)  /* write lock */
1083 #define SNDRV_CTL_ELEM_ACCESS_OWNER             (1<<10) /* write lock owner */
1084 #define SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK      (1<<28) /* kernel use a TLV callback */
1085 #define SNDRV_CTL_ELEM_ACCESS_USER              (1<<29) /* user space element */
1086 /* bits 30 and 31 are obsoleted (for indirect access) */
1087
1088 /* for further details see the ACPI and PCI power management specification */
1089 #define SNDRV_CTL_POWER_D0              0x0000  /* full On */
1090 #define SNDRV_CTL_POWER_D1              0x0100  /* partial On */
1091 #define SNDRV_CTL_POWER_D2              0x0200  /* partial On */
1092 #define SNDRV_CTL_POWER_D3              0x0300  /* Off */
1093 #define SNDRV_CTL_POWER_D3hot           (SNDRV_CTL_POWER_D3|0x0000)     /* Off, with power */
1094 #define SNDRV_CTL_POWER_D3cold          (SNDRV_CTL_POWER_D3|0x0001)     /* Off, without power */
1095
1096 #define SNDRV_CTL_ELEM_ID_NAME_MAXLEN   44
1097
1098 struct snd_ctl_elem_id {
1099         unsigned int numid;             /* numeric identifier, zero = invalid */
1100         snd_ctl_elem_iface_t iface;     /* interface identifier */
1101         unsigned int device;            /* device/client number */
1102         unsigned int subdevice;         /* subdevice (substream) number */
1103         unsigned char name[SNDRV_CTL_ELEM_ID_NAME_MAXLEN];              /* ASCII name of item */
1104         unsigned int index;             /* index of item */
1105 };
1106
1107 struct snd_ctl_elem_list {
1108         unsigned int offset;            /* W: first element ID to get */
1109         unsigned int space;             /* W: count of element IDs to get */
1110         unsigned int used;              /* R: count of element IDs set */
1111         unsigned int count;             /* R: count of all elements */
1112         struct snd_ctl_elem_id __user *pids; /* R: IDs */
1113         unsigned char reserved[50];
1114 };
1115
1116 struct snd_ctl_elem_info {
1117         struct snd_ctl_elem_id id;      /* W: element ID */
1118         snd_ctl_elem_type_t type;       /* R: value type - SNDRV_CTL_ELEM_TYPE_* */
1119         unsigned int access;            /* R: value access (bitmask) - SNDRV_CTL_ELEM_ACCESS_* */
1120         unsigned int count;             /* count of values */
1121         __kernel_pid_t owner;           /* owner's PID of this control */
1122         union {
1123                 struct {
1124                         long min;               /* R: minimum value */
1125                         long max;               /* R: maximum value */
1126                         long step;              /* R: step (0 variable) */
1127                 } integer;
1128                 struct {
1129                         long long min;          /* R: minimum value */
1130                         long long max;          /* R: maximum value */
1131                         long long step;         /* R: step (0 variable) */
1132                 } integer64;
1133                 struct {
1134                         unsigned int items;     /* R: number of items */
1135                         unsigned int item;      /* W: item number */
1136                         char name[64];          /* R: value name */
1137                         __u64 names_ptr;        /* W: names list (ELEM_ADD only) */
1138                         unsigned int names_length;
1139                 } enumerated;
1140                 unsigned char reserved[128];
1141         } value;
1142         unsigned char reserved[64];
1143 };
1144
1145 struct snd_ctl_elem_value {
1146         struct snd_ctl_elem_id id;      /* W: element ID */
1147         unsigned int indirect: 1;       /* W: indirect access - obsoleted */
1148         union {
1149                 union {
1150                         long value[128];
1151                         long *value_ptr;        /* obsoleted */
1152                 } integer;
1153                 union {
1154                         long long value[64];
1155                         long long *value_ptr;   /* obsoleted */
1156                 } integer64;
1157                 union {
1158                         unsigned int item[128];
1159                         unsigned int *item_ptr; /* obsoleted */
1160                 } enumerated;
1161                 union {
1162                         unsigned char data[512];
1163                         unsigned char *data_ptr;        /* obsoleted */
1164                 } bytes;
1165                 struct snd_aes_iec958 iec958;
1166         } value;                /* RO */
1167         unsigned char reserved[128];
1168 };
1169
1170 struct snd_ctl_tlv {
1171         unsigned int numid;     /* control element numeric identification */
1172         unsigned int length;    /* in bytes aligned to 4 */
1173         unsigned int tlv[];     /* first TLV */
1174 };
1175
1176 #define SNDRV_CTL_IOCTL_PVERSION        _IOR('U', 0x00, int)
1177 #define SNDRV_CTL_IOCTL_CARD_INFO       _IOR('U', 0x01, struct snd_ctl_card_info)
1178 #define SNDRV_CTL_IOCTL_ELEM_LIST       _IOWR('U', 0x10, struct snd_ctl_elem_list)
1179 #define SNDRV_CTL_IOCTL_ELEM_INFO       _IOWR('U', 0x11, struct snd_ctl_elem_info)
1180 #define SNDRV_CTL_IOCTL_ELEM_READ       _IOWR('U', 0x12, struct snd_ctl_elem_value)
1181 #define SNDRV_CTL_IOCTL_ELEM_WRITE      _IOWR('U', 0x13, struct snd_ctl_elem_value)
1182 #define SNDRV_CTL_IOCTL_ELEM_LOCK       _IOW('U', 0x14, struct snd_ctl_elem_id)
1183 #define SNDRV_CTL_IOCTL_ELEM_UNLOCK     _IOW('U', 0x15, struct snd_ctl_elem_id)
1184 #define SNDRV_CTL_IOCTL_SUBSCRIBE_EVENTS _IOWR('U', 0x16, int)
1185 #define SNDRV_CTL_IOCTL_ELEM_ADD        _IOWR('U', 0x17, struct snd_ctl_elem_info)
1186 #define SNDRV_CTL_IOCTL_ELEM_REPLACE    _IOWR('U', 0x18, struct snd_ctl_elem_info)
1187 #define SNDRV_CTL_IOCTL_ELEM_REMOVE     _IOWR('U', 0x19, struct snd_ctl_elem_id)
1188 #define SNDRV_CTL_IOCTL_TLV_READ        _IOWR('U', 0x1a, struct snd_ctl_tlv)
1189 #define SNDRV_CTL_IOCTL_TLV_WRITE       _IOWR('U', 0x1b, struct snd_ctl_tlv)
1190 #define SNDRV_CTL_IOCTL_TLV_COMMAND     _IOWR('U', 0x1c, struct snd_ctl_tlv)
1191 #define SNDRV_CTL_IOCTL_HWDEP_NEXT_DEVICE _IOWR('U', 0x20, int)
1192 #define SNDRV_CTL_IOCTL_HWDEP_INFO      _IOR('U', 0x21, struct snd_hwdep_info)
1193 #define SNDRV_CTL_IOCTL_PCM_NEXT_DEVICE _IOR('U', 0x30, int)
1194 #define SNDRV_CTL_IOCTL_PCM_INFO        _IOWR('U', 0x31, struct snd_pcm_info)
1195 #define SNDRV_CTL_IOCTL_PCM_PREFER_SUBDEVICE _IOW('U', 0x32, int)
1196 #define SNDRV_CTL_IOCTL_RAWMIDI_NEXT_DEVICE _IOWR('U', 0x40, int)
1197 #define SNDRV_CTL_IOCTL_RAWMIDI_INFO    _IOWR('U', 0x41, struct snd_rawmidi_info)
1198 #define SNDRV_CTL_IOCTL_RAWMIDI_PREFER_SUBDEVICE _IOW('U', 0x42, int)
1199 #define SNDRV_CTL_IOCTL_UMP_NEXT_DEVICE _IOWR('U', 0x43, int)
1200 #define SNDRV_CTL_IOCTL_UMP_ENDPOINT_INFO _IOWR('U', 0x44, struct snd_ump_endpoint_info)
1201 #define SNDRV_CTL_IOCTL_UMP_BLOCK_INFO  _IOWR('U', 0x45, struct snd_ump_block_info)
1202 #define SNDRV_CTL_IOCTL_POWER           _IOWR('U', 0xd0, int)
1203 #define SNDRV_CTL_IOCTL_POWER_STATE     _IOR('U', 0xd1, int)
1204
1205 /*
1206  *  Read interface.
1207  */
1208
1209 enum sndrv_ctl_event_type {
1210         SNDRV_CTL_EVENT_ELEM = 0,
1211         SNDRV_CTL_EVENT_LAST = SNDRV_CTL_EVENT_ELEM,
1212 };
1213
1214 #define SNDRV_CTL_EVENT_MASK_VALUE      (1<<0)  /* element value was changed */
1215 #define SNDRV_CTL_EVENT_MASK_INFO       (1<<1)  /* element info was changed */
1216 #define SNDRV_CTL_EVENT_MASK_ADD        (1<<2)  /* element was added */
1217 #define SNDRV_CTL_EVENT_MASK_TLV        (1<<3)  /* element TLV tree was changed */
1218 #define SNDRV_CTL_EVENT_MASK_REMOVE     (~0U)   /* element was removed */
1219
1220 struct snd_ctl_event {
1221         int type;       /* event type - SNDRV_CTL_EVENT_* */
1222         union {
1223                 struct {
1224                         unsigned int mask;
1225                         struct snd_ctl_elem_id id;
1226                 } elem;
1227                 unsigned char data8[60];
1228         } data;
1229 };
1230
1231 /*
1232  *  Control names
1233  */
1234
1235 #define SNDRV_CTL_NAME_NONE                             ""
1236 #define SNDRV_CTL_NAME_PLAYBACK                         "Playback "
1237 #define SNDRV_CTL_NAME_CAPTURE                          "Capture "
1238
1239 #define SNDRV_CTL_NAME_IEC958_NONE                      ""
1240 #define SNDRV_CTL_NAME_IEC958_SWITCH                    "Switch"
1241 #define SNDRV_CTL_NAME_IEC958_VOLUME                    "Volume"
1242 #define SNDRV_CTL_NAME_IEC958_DEFAULT                   "Default"
1243 #define SNDRV_CTL_NAME_IEC958_MASK                      "Mask"
1244 #define SNDRV_CTL_NAME_IEC958_CON_MASK                  "Con Mask"
1245 #define SNDRV_CTL_NAME_IEC958_PRO_MASK                  "Pro Mask"
1246 #define SNDRV_CTL_NAME_IEC958_PCM_STREAM                "PCM Stream"
1247 #define SNDRV_CTL_NAME_IEC958(expl,direction,what)      "IEC958 " expl SNDRV_CTL_NAME_##direction SNDRV_CTL_NAME_IEC958_##what
1248
1249 #endif /* _UAPI__SOUND_ASOUND_H */