tmk_core/tool/mbed/mbed-sdk/libraries/USBDevice/USBAudio/USBAudio_Types.h

   1 /* Copyright (c) 2010-2011 mbed.org, MIT License
   2 *
   3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
   4 * and associated documentation files (the "Software"), to deal in the Software without
   5 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
   6 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
   7 * Software is furnished to do so, subject to the following conditions:
   8 *
   9 * The above copyright notice and this permission notice shall be included in all copies or
  10 * substantial portions of the Software.
  11 *
  12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
  13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
  15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  17 */
  18
  19 #ifndef USBAUDIO_TYPES_H
  20 #define USBAUDIO_TYPES_H
  21
  22
  23 #define DEFAULT_CONFIGURATION (1)
  24
  25 // Audio Request Codes
  26 #define REQUEST_SET_CUR     0x01
  27 #define REQUEST_GET_CUR     0x81
  28 #define REQUEST_SET_MIN     0x02
  29 #define REQUEST_GET_MIN     0x82
  30 #define REQUEST_SET_MAX     0x03
  31 #define REQUEST_GET_MAX     0x83
  32 #define REQUEST_SET_RES     0x04
  33 #define REQUEST_GET_RES     0x84
  34
  35 #define MUTE_CONTROL        0x01
  36 #define VOLUME_CONTROL      0x02
  37
  38
  39 // Audio Descriptor Sizes
  40 #define CONTROL_INTERFACE_DESCRIPTOR_LENGTH       0x09
  41 #define STREAMING_INTERFACE_DESCRIPTOR_LENGTH     0x07
  42 #define INPUT_TERMINAL_DESCRIPTOR_LENGTH          0x0C
  43 #define OUTPUT_TERMINAL_DESCRIPTOR_LENGTH         0x09
  44 #define FEATURE_UNIT_DESCRIPTOR_LENGTH            0x09
  45 #define STREAMING_ENDPOINT_DESCRIPTOR_LENGTH      0x07
  46
  47 // Audio Format Type Descriptor Sizes
  48 #define FORMAT_TYPE_I_DESCRIPTOR_LENGTH   0x0b
  49
  50 #define AUDIO_CLASS                       0x01
  51 #define SUBCLASS_AUDIOCONTROL             0x01
  52 #define SUBCLASS_AUDIOSTREAMING           0x02
  53
  54 // Audio Descriptor Types
  55 #define INTERFACE_DESCRIPTOR_TYPE         0x24
  56 #define ENDPOINT_DESCRIPTOR_TYPE          0x25
  57
  58 // Audio Control Interface Descriptor Subtypes
  59 #define CONTROL_HEADER                    0x01
  60 #define CONTROL_INPUT_TERMINAL            0x02
  61 #define CONTROL_OUTPUT_TERMINAL           0x03
  62 #define CONTROL_FEATURE_UNIT              0x06
  63
  64 // USB Terminal Types
  65 #define TERMINAL_USB_STREAMING            0x0101
  66
  67 // Predefined Audio Channel Configuration Bits
  68 // Mono
  69 #define CHANNEL_M                         0x0000
  70 #define CHANNEL_L                         0x0001  /* Left Front */
  71 #define CHANNEL_R                         0x0002  /* Right Front */
  72
  73 // Feature Unit Control Bits
  74 #define CONTROL_MUTE                      0x0001
  75 #define CONTROL_VOLUME                    0x0002
  76
  77 // Input Terminal Types
  78 #define TERMINAL_MICROPHONE               0x0201
  79
  80 // Output Terminal Types
  81 #define TERMINAL_SPEAKER                  0x0301
  82 #define TERMINAL_HEADPHONES               0x0302
  83
  84 // Audio Streaming Interface Descriptor Subtypes
  85 #define STREAMING_GENERAL                 0x01
  86 #define STREAMING_FORMAT_TYPE             0x02
  87
  88 // Audio Data Format Type I Codes
  89 #define FORMAT_PCM                        0x0001
  90
  91 // Audio Format Types
  92 #define FORMAT_TYPE_I                     0x01
  93
  94 // Audio Endpoint Descriptor Subtypes
  95 #define ENDPOINT_GENERAL                  0x01
  96
  97 #endif