Logo Search packages:      
Sourcecode: alsa-driver version File versions  Download package

usb_audio_v2_compat.h

/*
 * Copyright (c) 2010 Daniel Mack <daniel@caiaq.de>
 *
 * This software is distributed under the terms of the GNU General Public
 * License ("GPL") version 2, as published by the Free Software Foundation.
 *
 * This file holds USB constants and structures defined
 * by the USB Device Class Definition for Audio Devices in version 2.0.
 * Comments below reference relevant sections of the documents contained
 * in http://www.usb.org/developers/devclass_docs/Audio2.0_final.zip
 */

#ifndef __LINUX_USB_AUDIO_V2_H
#define __LINUX_USB_AUDIO_V2_H

#include <linux/types.h>

/* v1.0 and v2.0 of this standard have many things in common. For the rest
 * of the definitions, please refer to audio.h */

/* 4.7.2.1 Clock Source Descriptor */

struct uac_clock_source_descriptor {
      __u8 bLength;
      __u8 bDescriptorType;
      __u8 bDescriptorSubtype;
      __u8 bClockID;
      __u8 bmAttributes;
      __u8 bmControls;
      __u8 bAssocTerminal;
      __u8 iClockSource;
} __attribute__((packed));

/* 4.7.2.2 Clock Source Descriptor */

struct uac_clock_selector_descriptor {
      __u8 bLength;
      __u8 bDescriptorType;
      __u8 bDescriptorSubtype;
      __u8 bClockID;
      __u8 bNrInPins;
      __u8 bmControls;
      __u8 baCSourceID[];
} __attribute__((packed));

/* 4.7.2.4 Input terminal descriptor */

struct uac2_input_terminal_descriptor {
      __u8 bLength;
      __u8 bDescriptorType;
      __u8 bDescriptorSubtype;
      __u8 bTerminalID;
      __u16 wTerminalType;
      __u8 bAssocTerminal;
      __u8 bCSourceID;
      __u8 bNrChannels;
      __u32 bmChannelConfig;
      __u8 iChannelNames;
      __u16 bmControls;
      __u8 iTerminal;
} __attribute__((packed));

/* 4.7.2.5 Output terminal descriptor */

struct uac2_output_terminal_descriptor {
      __u8 bLength;
      __u8 bDescriptorType;
      __u8 bDescriptorSubtype;
      __u8 bTerminalID;
      __u16 wTerminalType;
      __u8 bAssocTerminal;
      __u8 bSourceID;
      __u8 bCSourceID;
      __u16 bmControls;
      __u8 iTerminal;
} __attribute__((packed));



/* 4.7.2.8 Feature Unit Descriptor */

struct uac2_feature_unit_descriptor {
      __u8 bLength;
      __u8 bDescriptorType;
      __u8 bDescriptorSubtype;
      __u8 bUnitID;
      __u8 bSourceID;
      /* bmaControls is actually u32,
       * but u8 is needed for the hybrid parser */
      __u8 bmaControls[0]; /* variable length */
} __attribute__((packed));

/* 4.9.2 Class-Specific AS Interface Descriptor */

struct uac_as_header_descriptor_v2 {
      __u8 bLength;
      __u8 bDescriptorType;
      __u8 bDescriptorSubtype;
      __u8 bTerminalLink;
      __u8 bmControls;
      __u8 bFormatType;
      __u32 bmFormats;
      __u8 bNrChannels;
      __u32 bmChannelConfig;
      __u8 iChannelNames;
} __attribute__((packed));


/* A.7 Audio Function Category Codes */
#define UAC2_FUNCTION_SUBCLASS_UNDEFINED  0x00
#define UAC2_FUNCTION_DESKTOP_SPEAKER           0x01
#define UAC2_FUNCTION_HOME_THEATER        0x02
#define UAC2_FUNCTION_MICROPHONE          0x03
#define UAC2_FUNCTION_HEADSET             0x04
#define UAC2_FUNCTION_TELEPHONE                 0x05
#define UAC2_FUNCTION_CONVERTER                 0x06
#define UAC2_FUNCTION_SOUND_RECORDER            0x07
#define UAC2_FUNCTION_IO_BOX              0x08
#define UAC2_FUNCTION_MUSICAL_INSTRUMENT  0x09
#define UAC2_FUNCTION_PRO_AUDIO                 0x0a
#define UAC2_FUNCTION_AUDIO_VIDEO         0x0b
#define UAC2_FUNCTION_CONTROL_PANEL       0x0c
#define UAC2_FUNCTION_OTHER               0xff

/* A.9 Audio Class-Specific AC Interface Descriptor Subtypes */
/* see audio.h for the rest, which is identical to v1 */
#define UAC2_EFFECT_UNIT                  0x07
#define UAC2_PROCESSING_UNIT_V2           0x08
#define UAC2_EXTENSION_UNIT_V2            0x09
#define UAC2_CLOCK_SOURCE           0x0a
#define UAC2_CLOCK_SELECTOR         0x0b
#define UAC2_CLOCK_MULTIPLIER       0x0c
#define UAC2_SAMPLE_RATE_CONVERTER  0x0d

/* A.10 Audio Class-Specific AS Interface Descriptor Subtypes */
/* see audio.h for the rest, which is identical to v1 */
#define UAC2_ENCODER                0x03
#define UAC2_DECODER                0x04

/* A.11 Effect Unit Effect Types */
#define UAC2_EFFECT_UNDEFINED       0x00
#define UAC2_EFFECT_PARAM_EQ        0x01
#define UAC2_EFFECT_REVERB          0x02
#define UAC2_EFFECT_MOD_DELAY       0x03
#define UAC2_EFFECT_DYN_RANGE_COMP  0x04

/* A.12 Processing Unit Process Types */
#define UAC2_PROCESS_UNDEFINED            0x00
#define UAC2_PROCESS_UP_DOWNMIX           0x01
#define UAC2_PROCESS_DOLBY_PROLOCIC 0x02
#define UAC2_PROCESS_STEREO_EXTENDER      0x03

/* A.14 Audio Class-Specific Request Codes */
#define UAC2_CS_CUR                 0x01
#define UAC2_CS_RANGE               0x02

/* A.15 Encoder Type Codes */
#define UAC2_ENCODER_UNDEFINED            0x00
#define UAC2_ENCODER_OTHER          0x01
#define UAC2_ENCODER_MPEG           0x02
#define UAC2_ENCODER_AC3            0x03
#define UAC2_ENCODER_WMA            0x04
#define UAC2_ENCODER_DTS            0x05

/* A.16 Decoder Type Codes */
#define UAC2_DECODER_UNDEFINED            0x00
#define UAC2_DECODER_OTHER          0x01
#define UAC2_DECODER_MPEG           0x02
#define UAC2_DECODER_AC3            0x03
#define UAC2_DECODER_WMA            0x04
#define UAC2_DECODER_DTS            0x05

/* A.17.1 Clock Source Control Selectors */
#define UAC2_CS_UNDEFINED           0x00
#define UAC2_CS_CONTROL_SAM_FREQ    0x01
#define UAC2_CS_CONTROL_CLOCK_VALID 0x02

/* A.17.2 Clock Selector Control Selectors */
#define UAC2_CX_UNDEFINED           0x00
#define UAC2_CX_CLOCK_SELECTOR            0x01

/* A.17.3 Clock Multiplier Control Selectors */
#define UAC2_CM_UNDEFINED           0x00
#define UAC2_CM_NUMERATOR           0x01
#define UAC2_CM_DENOMINTATOR        0x02

/* A.17.4 Terminal Control Selectors */
#define UAC2_TE_UNDEFINED           0x00
#define UAC2_TE_COPY_PROTECT        0x01
#define UAC2_TE_CONNECTOR           0x02
#define UAC2_TE_OVERLOAD            0x03
#define UAC2_TE_CLUSTER             0x04
#define UAC2_TE_UNDERFLOW           0x05
#define UAC2_TE_OVERFLOW            0x06
#define UAC2_TE_LATENCY             0x07

/* A.17.5 Mixer Control Selectors */
#define UAC2_MU_UNDEFINED           0x00
#define UAC2_MU_MIXER               0x01
#define UAC2_MU_CLUSTER             0x02
#define UAC2_MU_UNDERFLOW           0x03
#define UAC2_MU_OVERFLOW            0x04
#define UAC2_MU_LATENCY             0x05

/* A.17.6 Selector Control Selectors */
#define UAC2_SU_UNDEFINED           0x00
#define UAC2_SU_SELECTOR            0x01
#define UAC2_SU_LATENCY             0x02

/* A.17.7 Feature Unit Control Selectors */
/* see audio.h for the rest, which is identical to v1 */
#define UAC2_FU_INPUT_GAIN          0x0b
#define UAC2_FU_INPUT_GAIN_PAD            0x0c
#define UAC2_FU_PHASE_INVERTER            0x0d
#define UAC2_FU_UNDERFLOW           0x0e
#define UAC2_FU_OVERFLOW            0x0f
#define UAC2_FU_LATENCY             0x10

/* A.17.8.1 Parametric Equalizer Section Effect Unit Control Selectors */
#define UAC2_PE_UNDEFINED           0x00
#define UAC2_PE_ENABLE              0x01
#define UAC2_PE_CENTERFREQ          0x02
#define UAC2_PE_QFACTOR             0x03
#define UAC2_PE_GAIN                0x04
#define UAC2_PE_UNDERFLOW           0x05
#define UAC2_PE_OVERFLOW            0x06
#define UAC2_PE_LATENCY             0x07

/* A.17.8.2 Reverberation Effect Unit Control Selectors */
#define UAC2_RV_UNDEFINED           0x00
#define UAC2_RV_ENABLE              0x01
#define UAC2_RV_TYPE                0x02
#define UAC2_RV_LEVEL               0x03
#define UAC2_RV_TIME                0x04
#define UAC2_RV_FEEDBACK            0x05
#define UAC2_RV_PREDELAY            0x06
#define UAC2_RV_DENSITY             0x07
#define UAC2_RV_HIFREQ_ROLLOFF            0x08
#define UAC2_RV_UNDERFLOW           0x09
#define UAC2_RV_OVERFLOW            0x0a
#define UAC2_RV_LATENCY             0x0b

/* A.17.8.3 Modulation Delay Effect Control Selectors */
#define UAC2_MD_UNDEFINED           0x00
#define UAC2_MD_ENABLE              0x01
#define UAC2_MD_BALANCE             0x02
#define UAC2_MD_RATE                0x03
#define UAC2_MD_DEPTH               0x04
#define UAC2_MD_TIME                0x05
#define UAC2_MD_FEEDBACK            0x06
#define UAC2_MD_UNDERFLOW           0x07
#define UAC2_MD_OVERFLOW            0x08
#define UAC2_MD_LATENCY             0x09

/* A.17.8.4 Dynamic Range Compressor Effect Unit Control Selectors */
#define UAC2_DR_UNDEFINED           0x00
#define UAC2_DR_ENABLE              0x01
#define UAC2_DR_COMPRESSION_RATE    0x02
#define UAC2_DR_MAXAMPL             0x03
#define UAC2_DR_THRESHOLD           0x04
#define UAC2_DR_ATTACK_TIME         0x05
#define UAC2_DR_RELEASE_TIME        0x06
#define UAC2_DR_UNDEFLOW            0x07
#define UAC2_DR_OVERFLOW            0x08
#define UAC2_DR_LATENCY             0x09

/* A.17.9.1 Up/Down-mix Processing Unit Control Selectors */
#define UAC2_UD_UNDEFINED           0x00
#define UAC2_UD_ENABLE              0x01
#define UAC2_UD_MODE_SELECT         0x02
#define UAC2_UD_CLUSTER             0x03
#define UAC2_UD_UNDERFLOW           0x04
#define UAC2_UD_OVERFLOW            0x05
#define UAC2_UD_LATENCY             0x06

/* A.17.9.2 Dolby Prologic[tm] Processing Unit Control Selectors */
#define UAC2_DP_UNDEFINED           0x00
#define UAC2_DP_ENABLE              0x01
#define UAC2_DP_MODE_SELECT         0x02
#define UAC2_DP_CLUSTER             0x03
#define UAC2_DP_UNDERFFLOW          0x04
#define UAC2_DP_OVERFLOW            0x05
#define UAC2_DP_LATENCY             0x06

/* A.17.9.3 Stereo Expander Processing Unit Control Selectors */
#define UAC2_ST_EXT_UNDEFINED       0x00
#define UAC2_ST_EXT_ENABLE          0x01
#define UAC2_ST_EXT_WIDTH           0x02
#define UAC2_ST_EXT_UNDEFLOW        0x03
#define UAC2_ST_EXT_OVERFLOW        0x04
#define UAC2_ST_EXT_LATENCY         0x05

/* A.17.10 Extension Unit Control Selectors */
#define UAC2_XU_UNDEFINED           0x00
#define UAC2_XU_ENABLE              0x01
#define UAC2_XU_CLUSTER             0x02
#define UAC2_XU_UNDERFLOW           0x03
#define UAC2_XU_OVERFLOW            0x04
#define UAC2_XU_LATENCY             0x05

/* A.17.11 AudioStreaming Interface Control Selectors */
#define UAC2_AS_UNDEFINED           0x00
#define UAC2_AS_ACT_ALT_SETTING           0x01
#define UAC2_AS_VAL_ALT_SETTINGS    0x02
#define UAC2_AS_AUDIO_DATA_FORMAT   0x03

/* A.17.12 Encoder Control Selectors */
#define UAC2_EN_UNDEFINED           0x00
#define UAC2_EN_BIT_RATE            0x01
#define UAC2_EN_QUALITY             0x02
#define UAC2_EN_VBR                 0x03
#define UAC2_EN_TYPE                0x04
#define UAC2_EN_UNDERFLOW           0x05
#define UAC2_EN_OVERFLOW            0x06
#define UAC2_EN_ENCODER_ERROR       0x07
#define UAC2_EN_PARAM1              0x08
#define UAC2_EN_PARAM2              0x09
#define UAC2_EN_PARAM3              0x0a
#define UAC2_EN_PARAM4              0x0b
#define UAC2_EN_PARAM5              0x0c
#define UAC2_EN_PARAM6              0x0d
#define UAC2_EN_PARAM7              0x0e
#define UAC2_EN_PARAM8              0x0f

/* A.17.13.1 MPEG Decoder Control Selectors */
#define UAC2_MPEG_UNDEFINED         0x00
#define UAC2_MPEG_DUAL_CHANNEL            0x01
#define UAC2_MPEG_SECOND_STEREO           0x02
#define UAC2_MPEG_MULTILINGUAL            0x03
#define UAC2_MPEG_DYN_RANGE         0x04
#define UAC2_MPEG_SCALING           0x05
#define UAC2_MPEG_HILO_SCALING            0x06
#define UAC2_MPEG_UNDERFLOW         0x07
#define UAC2_MPEG_OVERFLOW          0x08
#define UAC2_MPEG_DECODER_ERROR           0x09

/* A17.13.2 AC3 Decoder Control Selectors */
#define UAC2_AC3_UNDEFINED          0x00
#define UAC2_AC3_MODE               0x01
#define UAC2_AC3_DYN_RANGE          0x02
#define UAC2_AC3_SCALING            0x03
#define UAC2_AC3_HILO_SCALING       0x04
#define UAC2_AC3_UNDERFLOW          0x05
#define UAC2_AC3_OVERFLOW           0x06
#define UAC2_AC3_DECODER_ERROR            0x07

/* A17.13.3 WMA Decoder Control Selectors */
#define UAC2_WMA_UNDEFINED          0x00
#define UAC2_WMA_UNDERFLOW          0x01
#define UAC2_WMA_OVERFLOW           0x02
#define UAC2_WMA_DECODER_ERROR            0x03

/* A17.13.4 DTS Decoder Control Selectors */
#define UAC2_DTS_UNDEFINED          0x00
#define UAC2_DTS_UNDERFLOW          0x01
#define UAC2_DTS_OVERFLOW           0x02
#define UAC2_DTS_DECODER_ERROR            0x03

/* A17.14 Endpoint Control Selectors */
#define UAC2_EP_CS_UNDEFINED        0x00
#define UAC2_EP_CS_PITCH            0x01
#define UAC2_EP_CS_DATA_OVERRUN           0x02
#define UAC2_EP_CS_DATA_UNDERRUN    0x03

#endif /* __LINUX_USB_AUDIO_V2_H */


Generated by  Doxygen 1.6.0   Back to index