]> git.sur5r.net Git - armstart-ibdap/blobdiff - inc/usbd/usbd_audio.h
initial commit
[armstart-ibdap] / inc / usbd / usbd_audio.h
diff --git a/inc/usbd/usbd_audio.h b/inc/usbd/usbd_audio.h
new file mode 100644 (file)
index 0000000..4b8e885
--- /dev/null
@@ -0,0 +1,377 @@
+/***********************************************************************\r
+* $Id:: mw_usbd_audio.h 165 2011-04-14 17:41:11Z usb10131                     $\r
+*\r
+* Project: USB device ROM Stack\r
+*\r
+* Description:\r
+*     USB Audio Device Class Definitions.\r
+*\r
+***********************************************************************\r
+*   Copyright(C) 2011, NXP Semiconductor\r
+*   All rights reserved.\r
+*\r
+* Software that is described herein is for illustrative purposes only\r
+* which provides customers with programming information regarding the\r
+* products. This software is supplied "AS IS" without any warranties.\r
+* NXP Semiconductors assumes no responsibility or liability for the\r
+* use of the software, conveys no license or title under any patent,\r
+* copyright, or mask work right to the product. NXP Semiconductors\r
+* reserves the right to make changes in the software without\r
+* notification. NXP Semiconductors also make no representation or\r
+* warranty that such application will be suitable for the specified\r
+* use without further testing or modification.\r
+**********************************************************************/\r
+#ifndef __AUDIO_H__\r
+#define __AUDIO_H__\r
+\r
+\r
+/* Audio Interface Subclass Codes */\r
+#define AUDIO_SUBCLASS_UNDEFINED                0x00\r
+#define AUDIO_SUBCLASS_AUDIOCONTROL             0x01\r
+#define AUDIO_SUBCLASS_AUDIOSTREAMING           0x02\r
+#define AUDIO_SUBCLASS_MIDISTREAMING            0x03\r
+\r
+/* Audio Interface Protocol Codes */\r
+#define AUDIO_PROTOCOL_UNDEFINED                0x00\r
+\r
+\r
+/* Audio Descriptor Types */\r
+#define AUDIO_UNDEFINED_DESCRIPTOR_TYPE         0x20\r
+#define AUDIO_DEVICE_DESCRIPTOR_TYPE            0x21\r
+#define AUDIO_CONFIGURATION_DESCRIPTOR_TYPE     0x22\r
+#define AUDIO_STRING_DESCRIPTOR_TYPE            0x23\r
+#define AUDIO_INTERFACE_DESCRIPTOR_TYPE         0x24\r
+#define AUDIO_ENDPOINT_DESCRIPTOR_TYPE          0x25\r
+\r
+\r
+/* Audio Control Interface Descriptor Subtypes */\r
+#define AUDIO_CONTROL_UNDEFINED                 0x00\r
+#define AUDIO_CONTROL_HEADER                    0x01\r
+#define AUDIO_CONTROL_INPUT_TERMINAL            0x02\r
+#define AUDIO_CONTROL_OUTPUT_TERMINAL           0x03\r
+#define AUDIO_CONTROL_MIXER_UNIT                0x04\r
+#define AUDIO_CONTROL_SELECTOR_UNIT             0x05\r
+#define AUDIO_CONTROL_FEATURE_UNIT              0x06\r
+#define AUDIO_CONTROL_PROCESSING_UNIT           0x07\r
+#define AUDIO_CONTROL_EXTENSION_UNIT            0x08\r
+\r
+/* Audio Streaming Interface Descriptor Subtypes */\r
+#define AUDIO_STREAMING_UNDEFINED               0x00\r
+#define AUDIO_STREAMING_GENERAL                 0x01\r
+#define AUDIO_STREAMING_FORMAT_TYPE             0x02\r
+#define AUDIO_STREAMING_FORMAT_SPECIFIC         0x03\r
+\r
+/* Audio Endpoint Descriptor Subtypes */\r
+#define AUDIO_ENDPOINT_UNDEFINED                0x00\r
+#define AUDIO_ENDPOINT_GENERAL                  0x01\r
+\r
+\r
+/* Audio Descriptor Sizes */\r
+#define AUDIO_CONTROL_INTERFACE_DESC_SZ(n)      0x08+n\r
+#define AUDIO_STREAMING_INTERFACE_DESC_SIZE     0x07\r
+#define AUDIO_INPUT_TERMINAL_DESC_SIZE          0x0C\r
+#define AUDIO_OUTPUT_TERMINAL_DESC_SIZE         0x09\r
+#define AUDIO_MIXER_UNIT_DESC_SZ(p,n)           0x0A+p+n\r
+#define AUDIO_SELECTOR_UNIT_DESC_SZ(p)          0x06+p\r
+#define AUDIO_FEATURE_UNIT_DESC_SZ(ch,n)        0x07+(ch+1)*n\r
+#define AUDIO_PROCESSING_UNIT_DESC_SZ(p,n,x)    0x0D+p+n+x\r
+#define AUDIO_EXTENSION_UNIT_DESC_SZ(p,n)       0x0D+p+n\r
+#define AUDIO_STANDARD_ENDPOINT_DESC_SIZE       0x09\r
+#define AUDIO_STREAMING_ENDPOINT_DESC_SIZE      0x07\r
+\r
+\r
+/* Audio Processing Unit Process Types */\r
+#define AUDIO_UNDEFINED_PROCESS                 0x00\r
+#define AUDIO_UP_DOWN_MIX_PROCESS               0x01\r
+#define AUDIO_DOLBY_PROLOGIC_PROCESS            0x02\r
+#define AUDIO_3D_STEREO_PROCESS                 0x03\r
+#define AUDIO_REVERBERATION_PROCESS             0x04\r
+#define AUDIO_CHORUS_PROCESS                    0x05\r
+#define AUDIO_DYN_RANGE_COMP_PROCESS            0x06\r
+\r
+\r
+/* Audio Request Codes */\r
+#define AUDIO_REQUEST_UNDEFINED                 0x00\r
+#define AUDIO_REQUEST_SET_CUR                   0x01\r
+#define AUDIO_REQUEST_GET_CUR                   0x81\r
+#define AUDIO_REQUEST_SET_MIN                   0x02\r
+#define AUDIO_REQUEST_GET_MIN                   0x82\r
+#define AUDIO_REQUEST_SET_MAX                   0x03\r
+#define AUDIO_REQUEST_GET_MAX                   0x83\r
+#define AUDIO_REQUEST_SET_RES                   0x04\r
+#define AUDIO_REQUEST_GET_RES                   0x84\r
+#define AUDIO_REQUEST_SET_MEM                   0x05\r
+#define AUDIO_REQUEST_GET_MEM                   0x85\r
+#define AUDIO_REQUEST_GET_STAT                  0xFF\r
+\r
+\r
+/* Audio Control Selector Codes */\r
+#define AUDIO_CONTROL_UNDEFINED                 0x00    /* Common Selector */\r
+\r
+/*  Terminal Control Selectors */\r
+#define AUDIO_COPY_PROTECT_CONTROL              0x01\r
+\r
+/*  Feature Unit Control Selectors */\r
+#define AUDIO_MUTE_CONTROL                      0x01\r
+#define AUDIO_VOLUME_CONTROL                    0x02\r
+#define AUDIO_BASS_CONTROL                      0x03\r
+#define AUDIO_MID_CONTROL                       0x04\r
+#define AUDIO_TREBLE_CONTROL                    0x05\r
+#define AUDIO_GRAPHIC_EQUALIZER_CONTROL         0x06\r
+#define AUDIO_AUTOMATIC_GAIN_CONTROL            0x07\r
+#define AUDIO_DELAY_CONTROL                     0x08\r
+#define AUDIO_BASS_BOOST_CONTROL                0x09\r
+#define AUDIO_LOUDNESS_CONTROL                  0x0A\r
+\r
+/*  Processing Unit Control Selectors: */\r
+#define AUDIO_ENABLE_CONTROL                    0x01    /* Common Selector */\r
+#define AUDIO_MODE_SELECT_CONTROL               0x02    /* Common Selector */\r
+\r
+/*  - Up/Down-mix Control Selectors */\r
+/*      AUDIO_ENABLE_CONTROL                    0x01       Common Selector */\r
+/*      AUDIO_MODE_SELECT_CONTROL               0x02       Common Selector */\r
+\r
+/*  - Dolby Prologic Control Selectors */\r
+/*      AUDIO_ENABLE_CONTROL                    0x01       Common Selector */\r
+/*      AUDIO_MODE_SELECT_CONTROL               0x02       Common Selector */\r
+\r
+/*  - 3D Stereo Extender Control Selectors */\r
+/*      AUDIO_ENABLE_CONTROL                    0x01       Common Selector */\r
+#define AUDIO_SPACIOUSNESS_CONTROL              0x02\r
+\r
+/*  - Reverberation Control Selectors */\r
+/*      AUDIO_ENABLE_CONTROL                    0x01       Common Selector */\r
+#define AUDIO_REVERB_LEVEL_CONTROL              0x02\r
+#define AUDIO_REVERB_TIME_CONTROL               0x03\r
+#define AUDIO_REVERB_FEEDBACK_CONTROL           0x04\r
+\r
+/*  - Chorus Control Selectors */\r
+/*      AUDIO_ENABLE_CONTROL                    0x01       Common Selector */\r
+#define AUDIO_CHORUS_LEVEL_CONTROL              0x02\r
+#define AUDIO_SHORUS_RATE_CONTROL               0x03\r
+#define AUDIO_CHORUS_DEPTH_CONTROL              0x04\r
+\r
+/*  - Dynamic Range Compressor Control Selectors */\r
+/*      AUDIO_ENABLE_CONTROL                    0x01       Common Selector */\r
+#define AUDIO_COMPRESSION_RATE_CONTROL          0x02\r
+#define AUDIO_MAX_AMPL_CONTROL                  0x03\r
+#define AUDIO_THRESHOLD_CONTROL                 0x04\r
+#define AUDIO_ATTACK_TIME_CONTROL               0x05\r
+#define AUDIO_RELEASE_TIME_CONTROL              0x06\r
+\r
+/*  Extension Unit Control Selectors */\r
+/*      AUDIO_ENABLE_CONTROL                    0x01       Common Selector */\r
+\r
+/*  Endpoint Control Selectors */\r
+#define AUDIO_SAMPLING_FREQ_CONTROL             0x01\r
+#define AUDIO_PITCH_CONTROL                     0x02\r
+\r
+\r
+/* Audio Format Specific Control Selectors */\r
+\r
+/*  MPEG Control Selectors */\r
+#define AUDIO_MPEG_CONTROL_UNDEFINED            0x00\r
+#define AUDIO_MPEG_DUAL_CHANNEL_CONTROL         0x01\r
+#define AUDIO_MPEG_SECOND_STEREO_CONTROL        0x02\r
+#define AUDIO_MPEG_MULTILINGUAL_CONTROL         0x03\r
+#define AUDIO_MPEG_DYN_RANGE_CONTROL            0x04\r
+#define AUDIO_MPEG_SCALING_CONTROL              0x05\r
+#define AUDIO_MPEG_HILO_SCALING_CONTROL         0x06\r
+\r
+/*  AC-3 Control Selectors */\r
+#define AUDIO_AC3_CONTROL_UNDEFINED             0x00\r
+#define AUDIO_AC3_MODE_CONTROL                  0x01\r
+#define AUDIO_AC3_DYN_RANGE_CONTROL             0x02\r
+#define AUDIO_AC3_SCALING_CONTROL               0x03\r
+#define AUDIO_AC3_HILO_SCALING_CONTROL          0x04\r
+\r
+\r
+/* Audio Format Types */\r
+#define AUDIO_FORMAT_TYPE_UNDEFINED             0x00\r
+#define AUDIO_FORMAT_TYPE_I                     0x01\r
+#define AUDIO_FORMAT_TYPE_II                    0x02\r
+#define AUDIO_FORMAT_TYPE_III                   0x03\r
+\r
+\r
+/* Audio Format Type Descriptor Sizes */\r
+#define AUDIO_FORMAT_TYPE_I_DESC_SZ(n)          0x08+(n*3)\r
+#define AUDIO_FORMAT_TYPE_II_DESC_SZ(n)         0x09+(n*3)\r
+#define AUDIO_FORMAT_TYPE_III_DESC_SZ(n)        0x08+(n*3)\r
+#define AUDIO_FORMAT_MPEG_DESC_SIZE             0x09\r
+#define AUDIO_FORMAT_AC3_DESC_SIZE              0x0A\r
+\r
+\r
+/* Audio Data Format Codes */\r
+\r
+/*  Audio Data Format Type I Codes */\r
+#define AUDIO_FORMAT_TYPE_I_UNDEFINED           0x0000\r
+#define AUDIO_FORMAT_PCM                        0x0001\r
+#define AUDIO_FORMAT_PCM8                       0x0002\r
+#define AUDIO_FORMAT_IEEE_FLOAT                 0x0003\r
+#define AUDIO_FORMAT_ALAW                       0x0004\r
+#define AUDIO_FORMAT_MULAW                      0x0005\r
+\r
+/*  Audio Data Format Type II Codes */\r
+#define AUDIO_FORMAT_TYPE_II_UNDEFINED          0x1000\r
+#define AUDIO_FORMAT_MPEG                       0x1001\r
+#define AUDIO_FORMAT_AC3                        0x1002\r
+\r
+/*  Audio Data Format Type III Codes */\r
+#define AUDIO_FORMAT_TYPE_III_UNDEFINED         0x2000\r
+#define AUDIO_FORMAT_IEC1937_AC3                0x2001\r
+#define AUDIO_FORMAT_IEC1937_MPEG1_L1           0x2002\r
+#define AUDIO_FORMAT_IEC1937_MPEG1_L2_3         0x2003\r
+#define AUDIO_FORMAT_IEC1937_MPEG2_NOEXT        0x2003\r
+#define AUDIO_FORMAT_IEC1937_MPEG2_EXT          0x2004\r
+#define AUDIO_FORMAT_IEC1937_MPEG2_L1_LS        0x2005\r
+#define AUDIO_FORMAT_IEC1937_MPEG2_L2_3         0x2006\r
+\r
+\r
+/* Predefined Audio Channel Configuration Bits */\r
+#define AUDIO_CHANNEL_M                         0x0000  /* Mono */\r
+#define AUDIO_CHANNEL_L                         0x0001  /* Left Front */\r
+#define AUDIO_CHANNEL_R                         0x0002  /* Right Front */\r
+#define AUDIO_CHANNEL_C                         0x0004  /* Center Front */\r
+#define AUDIO_CHANNEL_LFE                       0x0008  /* Low Freq. Enhance. */\r
+#define AUDIO_CHANNEL_LS                        0x0010  /* Left Surround */\r
+#define AUDIO_CHANNEL_RS                        0x0020  /* Right Surround */\r
+#define AUDIO_CHANNEL_LC                        0x0040  /* Left of Center */\r
+#define AUDIO_CHANNEL_RC                        0x0080  /* Right of Center */\r
+#define AUDIO_CHANNEL_S                         0x0100  /* Surround */\r
+#define AUDIO_CHANNEL_SL                        0x0200  /* Side Left */\r
+#define AUDIO_CHANNEL_SR                        0x0400  /* Side Right */\r
+#define AUDIO_CHANNEL_T                         0x0800  /* Top */\r
+\r
+\r
+/* Feature Unit Control Bits */\r
+#define AUDIO_CONTROL_MUTE                      0x0001\r
+#define AUDIO_CONTROL_VOLUME                    0x0002\r
+#define AUDIO_CONTROL_BASS                      0x0004\r
+#define AUDIO_CONTROL_MID                       0x0008\r
+#define AUDIO_CONTROL_TREBLE                    0x0010\r
+#define AUDIO_CONTROL_GRAPHIC_EQUALIZER         0x0020\r
+#define AUDIO_CONTROL_AUTOMATIC_GAIN            0x0040\r
+#define AUDIO_CONTROL_DEALY                     0x0080\r
+#define AUDIO_CONTROL_BASS_BOOST                0x0100\r
+#define AUDIO_CONTROL_LOUDNESS                  0x0200\r
+\r
+/* Processing Unit Control Bits: */\r
+#define AUDIO_CONTROL_ENABLE                    0x0001  /* Common Bit */\r
+#define AUDIO_CONTROL_MODE_SELECT               0x0002  /* Common Bit */\r
+\r
+/* - Up/Down-mix Control Bits */\r
+/*      AUDIO_CONTROL_ENABLE                    0x0001     Common Bit */\r
+/*      AUDIO_CONTROL_MODE_SELECT               0x0002     Common Bit */\r
+\r
+/* - Dolby Prologic Control Bits */\r
+/*      AUDIO_CONTROL_ENABLE                    0x0001     Common Bit */\r
+/*      AUDIO_CONTROL_MODE_SELECT               0x0002     Common Bit */\r
+\r
+/* - 3D Stereo Extender Control Bits */\r
+/*      AUDIO_CONTROL_ENABLE                    0x0001     Common Bit */\r
+#define AUDIO_CONTROL_SPACIOUSNESS              0x0002\r
+\r
+/* - Reverberation Control Bits */\r
+/*      AUDIO_CONTROL_ENABLE                    0x0001     Common Bit */\r
+#define AUDIO_CONTROL_REVERB_TYPE               0x0002\r
+#define AUDIO_CONTROL_REVERB_LEVEL              0x0004\r
+#define AUDIO_CONTROL_REVERB_TIME               0x0008\r
+#define AUDIO_CONTROL_REVERB_FEEDBACK           0x0010\r
+\r
+/* - Chorus Control Bits */\r
+/*      AUDIO_CONTROL_ENABLE                    0x0001     Common Bit */\r
+#define AUDIO_CONTROL_CHORUS_LEVEL              0x0002\r
+#define AUDIO_CONTROL_SHORUS_RATE               0x0004\r
+#define AUDIO_CONTROL_CHORUS_DEPTH              0x0008\r
+\r
+/* - Dynamic Range Compressor Control Bits */\r
+/*      AUDIO_CONTROL_ENABLE                    0x0001     Common Bit */\r
+#define AUDIO_CONTROL_COMPRESSION_RATE          0x0002\r
+#define AUDIO_CONTROL_MAX_AMPL                  0x0004\r
+#define AUDIO_CONTROL_THRESHOLD                 0x0008\r
+#define AUDIO_CONTROL_ATTACK_TIME               0x0010\r
+#define AUDIO_CONTROL_RELEASE_TIME              0x0020\r
+\r
+/* Extension Unit Control Bits */\r
+/*      AUDIO_CONTROL_ENABLE                    0x0001     Common Bit */\r
+\r
+/* Endpoint Control Bits */\r
+#define AUDIO_CONTROL_SAMPLING_FREQ             0x01\r
+#define AUDIO_CONTROL_PITCH                     0x02\r
+#define AUDIO_MAX_PACKETS_ONLY                  0x80\r
+\r
+\r
+/* Audio Terminal Types */\r
+\r
+/*  USB Terminal Types */\r
+#define AUDIO_TERMINAL_USB_UNDEFINED            0x0100\r
+#define AUDIO_TERMINAL_USB_STREAMING            0x0101\r
+#define AUDIO_TERMINAL_USB_VENDOR_SPECIFIC      0x01FF\r
+\r
+/*  Input Terminal Types */\r
+#define AUDIO_TERMINAL_INPUT_UNDEFINED          0x0200\r
+#define AUDIO_TERMINAL_MICROPHONE               0x0201\r
+#define AUDIO_TERMINAL_DESKTOP_MICROPHONE       0x0202\r
+#define AUDIO_TERMINAL_PERSONAL_MICROPHONE      0x0203\r
+#define AUDIO_TERMINAL_OMNI_DIR_MICROPHONE      0x0204\r
+#define AUDIO_TERMINAL_MICROPHONE_ARRAY         0x0205\r
+#define AUDIO_TERMINAL_PROCESSING_MIC_ARRAY     0x0206\r
+\r
+/*  Output Terminal Types */\r
+#define AUDIO_TERMINAL_OUTPUT_UNDEFINED         0x0300\r
+#define AUDIO_TERMINAL_SPEAKER                  0x0301\r
+#define AUDIO_TERMINAL_HEADPHONES               0x0302\r
+#define AUDIO_TERMINAL_HEAD_MOUNTED_AUDIO       0x0303\r
+#define AUDIO_TERMINAL_DESKTOP_SPEAKER          0x0304\r
+#define AUDIO_TERMINAL_ROOM_SPEAKER             0x0305\r
+#define AUDIO_TERMINAL_COMMUNICATION_SPEAKER    0x0306\r
+#define AUDIO_TERMINAL_LOW_FREQ_SPEAKER         0x0307\r
+\r
+/*  Bi-directional Terminal Types */\r
+#define AUDIO_TERMINAL_BIDIRECTIONAL_UNDEFINED  0x0400\r
+#define AUDIO_TERMINAL_HANDSET                  0x0401\r
+#define AUDIO_TERMINAL_HEAD_MOUNTED_HANDSET     0x0402\r
+#define AUDIO_TERMINAL_SPEAKERPHONE             0x0403\r
+#define AUDIO_TERMINAL_SPEAKERPHONE_ECHOSUPRESS 0x0404\r
+#define AUDIO_TERMINAL_SPEAKERPHONE_ECHOCANCEL  0x0405\r
+\r
+/*  Telephony Terminal Types */\r
+#define AUDIO_TERMINAL_TELEPHONY_UNDEFINED      0x0500\r
+#define AUDIO_TERMINAL_PHONE_LINE               0x0501\r
+#define AUDIO_TERMINAL_TELEPHONE                0x0502\r
+#define AUDIO_TERMINAL_DOWN_LINE_PHONE          0x0503\r
+\r
+/*  External Terminal Types */\r
+#define AUDIO_TERMINAL_EXTERNAL_UNDEFINED       0x0600\r
+#define AUDIO_TERMINAL_ANALOG_CONNECTOR         0x0601\r
+#define AUDIO_TERMINAL_DIGITAL_AUDIO_INTERFACE  0x0602\r
+#define AUDIO_TERMINAL_LINE_CONNECTOR           0x0603\r
+#define AUDIO_TERMINAL_LEGACY_AUDIO_CONNECTOR   0x0604\r
+#define AUDIO_TERMINAL_SPDIF_INTERFACE          0x0605\r
+#define AUDIO_TERMINAL_1394_DA_STREAM           0x0606\r
+#define AUDIO_TERMINAL_1394_DA_STREAM_TRACK     0x0607\r
+\r
+/*  Embedded Function Terminal Types */\r
+#define AUDIO_TERMINAL_EMBEDDED_UNDEFINED       0x0700\r
+#define AUDIO_TERMINAL_CALIBRATION_NOISE        0x0701\r
+#define AUDIO_TERMINAL_EQUALIZATION_NOISE       0x0702\r
+#define AUDIO_TERMINAL_CD_PLAYER                0x0703\r
+#define AUDIO_TERMINAL_DAT                      0x0704\r
+#define AUDIO_TERMINAL_DCC                      0x0705\r
+#define AUDIO_TERMINAL_MINI_DISK                0x0706\r
+#define AUDIO_TERMINAL_ANALOG_TAPE              0x0707\r
+#define AUDIO_TERMINAL_PHONOGRAPH               0x0708\r
+#define AUDIO_TERMINAL_VCR_AUDIO                0x0709\r
+#define AUDIO_TERMINAL_VIDEO_DISC_AUDIO         0x070A\r
+#define AUDIO_TERMINAL_DVD_AUDIO                0x070B\r
+#define AUDIO_TERMINAL_TV_TUNER_AUDIO           0x070C\r
+#define AUDIO_TERMINAL_SATELLITE_RECEIVER_AUDIO 0x070D\r
+#define AUDIO_TERMINAL_CABLE_TUNER_AUDIO        0x070E\r
+#define AUDIO_TERMINAL_DSS_AUDIO                0x070F\r
+#define AUDIO_TERMINAL_RADIO_RECEIVER           0x0710\r
+#define AUDIO_TERMINAL_RADIO_TRANSMITTER        0x0711\r
+#define AUDIO_TERMINAL_MULTI_TRACK_RECORDER     0x0712\r
+#define AUDIO_TERMINAL_SYNTHESIZER              0x0713\r
+\r
+\r
+#endif  /* __AUDIO_H__ */\r