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