projects / pub / USBasp.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Added new Drivers/USB/LowLevel/Device.c file to house Device mode specific functions...
[pub/USBasp.git] / LUFA / Drivers / USB / Class / Common / Audio.h
diff --git a/LUFA/Drivers/USB/Class/Common/Audio.h b/LUFA/Drivers/USB/Class/Common/Audio.h
index 7b9e9f5..eb2e95b 100644 (file)
--- a/LUFA/Drivers/USB/Class/Common/Audio.h
+++ b/LUFA/Drivers/USB/Class/Common/Audio.h
@@ -79,22 +79,22 @@
                /** Descriptor header constant to indicate a Audio class endpoint descriptor. */
                #define DTYPE_AudioEndpoint          0x25
 
                /** Descriptor header constant to indicate a Audio class endpoint descriptor. */
                #define DTYPE_AudioEndpoint          0x25
 
-               /** Audio class descriptor subtype value for a Audio class specific header descriptor. */
+               /** Audio class descriptor subtype value for a Audio class-specific header descriptor. */
                #define DSUBTYPE_Header              0x01
 
                #define DSUBTYPE_Header              0x01
 
-               /** Audio class descriptor subtype value for an Output Terminal Audio class specific descriptor. */
+               /** Audio class descriptor subtype value for an Output Terminal Audio class-specific descriptor. */
                #define DSUBTYPE_InputTerminal       0x02
 
                #define DSUBTYPE_InputTerminal       0x02
 
-               /** Audio class descriptor subtype value for an Input Terminal Audio class specific descriptor. */
+               /** Audio class descriptor subtype value for an Input Terminal Audio class-specific descriptor. */
                #define DSUBTYPE_OutputTerminal      0x03
 
                #define DSUBTYPE_OutputTerminal      0x03
 
-               /** Audio class descriptor subtype value for a Feature Unit Audio class specific descriptor. */
+               /** Audio class descriptor subtype value for a Feature Unit Audio class-specific descriptor. */
                #define DSUBTYPE_FeatureUnit         0x06
 
                #define DSUBTYPE_FeatureUnit         0x06
 
-               /** Audio class descriptor subtype value for a general Audio class specific descriptor. */
+               /** Audio class descriptor subtype value for a general Audio class-specific descriptor. */
                #define DSUBTYPE_General             0x01
 
                #define DSUBTYPE_General             0x01
 
-               /** Audio class descriptor subtype value for an Audio class specific descriptor indicating the format of an audio stream. */
+               /** Audio class descriptor subtype value for an Audio class-specific descriptor indicating the format of an audio stream. */
                #define DSUBTYPE_Format              0x02
                
                /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
                #define DSUBTYPE_Format              0x02
                
                /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
@@ -225,175 +225,175 @@
                 */
                #define AUDIO_SAMPLE_FREQ(freq)  {LowWord: ((uint32_t)freq & 0x00FFFF), HighByte: (((uint32_t)freq >> 16) & 0x0000FF)}
                
                 */
                #define AUDIO_SAMPLE_FREQ(freq)  {LowWord: ((uint32_t)freq & 0x00FFFF), HighByte: (((uint32_t)freq >> 16) & 0x0000FF)}
                
-               /** Mask for the attributes parameter of an Audio class specific Endpoint descriptor, indicating that the endpoint
+               /** Mask for the attributes parameter of an Audio class-specific Endpoint descriptor, indicating that the endpoint
                 *  accepts only filled endpoint packets of audio samples.
                 */
                #define EP_ACCEPTS_ONLY_FULL_PACKETS (1 << 7)
 
                 *  accepts only filled endpoint packets of audio samples.
                 */
                #define EP_ACCEPTS_ONLY_FULL_PACKETS (1 << 7)
 
-               /** Mask for the attributes parameter of an Audio class specific Endpoint descriptor, indicating that the endpoint
+               /** Mask for the attributes parameter of an Audio class-specific Endpoint descriptor, indicating that the endpoint
                 *  will accept partially filled endpoint packets of audio samples.
                 */
                #define EP_ACCEPTS_SMALL_PACKETS     (0 << 7)
                
        /* Type Defines: */
                 *  will accept partially filled endpoint packets of audio samples.
                 */
                #define EP_ACCEPTS_SMALL_PACKETS     (0 << 7)
                
        /* Type Defines: */
-               /** \brief Audio Class Specific Interface Descriptor.
+               /** \brief Audio class-specific Interface Descriptor.
                 *
                 *
-                *  Type define for an Audio class specific interface descriptor. This follows a regular interface descriptor to
+                *  Type define for an Audio class-specific interface descriptor. This follows a regular interface descriptor to
                 *  supply extra information about the audio device's layout to the host. See the USB Audio specification for more
                 *  details.
                 */
                typedef struct
                {
                 *  supply extra information about the audio device's layout to the host. See the USB Audio specification for more
                 *  details.
                 */
                typedef struct
                {
-                       USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
-                       uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
+                       USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length. */
+                       uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 
 
-                       uint16_t                  ACSpecification; /**< Binary coded decimal value, indicating the supported Audio Class specification version */
-                       uint16_t                  TotalLength; /**< Total length of the Audio class specific descriptors, including this descriptor */
+                       uint16_t                  ACSpecification; /**< Binary coded decimal value, indicating the supported Audio Class specification version. */
+                       uint16_t                  TotalLength; /**< Total length of the Audio class-specific descriptors, including this descriptor. */
                        
                        
-                       uint8_t                   InCollection; /**< Total number of audio class interfaces within this device */
-                       uint8_t                   InterfaceNumbers[1]; /**< Interface numbers of each audio interface */
+                       uint8_t                   InCollection; /**< Total number of audio class interfaces within this device. */
+                       uint8_t                   InterfaceNumbers[1]; /**< Interface numbers of each audio interface. */
                } USB_Audio_Interface_AC_t;
                
                } USB_Audio_Interface_AC_t;
                
-               /** \brief Audio Class Specific Feature Unit Descriptor.
+               /** \brief Audio class-specific Feature Unit Descriptor.
                 *
                 *
-                *  Type define for an Audio class specific Feature Unit descriptor. This indicates to the host what features
+                *  Type define for an Audio class-specific Feature Unit descriptor. This indicates to the host what features
                 *  are present in the device's audio stream for basic control, such as per-channel volume. See the USB Audio
                 *  specification for more details.
                 */
                typedef struct
                {
                 *  are present in the device's audio stream for basic control, such as per-channel volume. See the USB Audio
                 *  specification for more details.
                 */
                typedef struct
                {
-                       USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
-                       uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
+                       USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length. */
+                       uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
                        
                        
-                       uint8_t                   UnitID; /**< ID value of this feature unit - must be a unique value within the device */
-                       uint8_t                   SourceID; /**< Source ID value of the audio source input into this feature unit */
+                       uint8_t                   UnitID; /**< ID value of this feature unit - must be a unique value within the device. */
+                       uint8_t                   SourceID; /**< Source ID value of the audio source input into this feature unit. */
                        
                        
-                       uint8_t                   ControlSize; /**< Size of each element in the ChanelControlls array */
-                       uint8_t                   ChannelControls[3]; /**< Feature masks for the control channel, and each separate audio channel */
+                       uint8_t                   ControlSize; /**< Size of each element in the ChanelControlls array. */
+                       uint8_t                   ChannelControls[3]; /**< Feature masks for the control channel, and each separate audio channel. */
                        
                        
-                       uint8_t                   FeatureUnitStrIndex; /**< Index of a string descriptor describing this descriptor within the device */
+                       uint8_t                   FeatureUnitStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
                } USB_Audio_FeatureUnit_t;
 
                } USB_Audio_FeatureUnit_t;
 
-               /** \brief Audio Class Specific Input Terminal Descriptor.
+               /** \brief Audio class-specific Input Terminal Descriptor.
                 *
                 *
-                *  Type define for an Audio class specific input terminal descriptor. This indicates to the host that the device
+                *  Type define for an Audio class-specific input terminal descriptor. This indicates to the host that the device
                 *  contains an input audio source, either from a physical terminal on the device, or a logical terminal (for example,
                 *  a USB endpoint). See the USB Audio specification for more details.
                 */
                typedef struct
                {
                 *  contains an input audio source, either from a physical terminal on the device, or a logical terminal (for example,
                 *  a USB endpoint). See the USB Audio specification for more details.
                 */
                typedef struct
                {
-                       USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
-                       uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
+                       USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length. */
+                       uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
                
                
-                       uint8_t                   TerminalID; /**< ID value of this terminal unit - must be a unique value within the device */
-                       uint16_t                  TerminalType; /**< Type of terminal, a TERMINAL_* mask */
+                       uint8_t                   TerminalID; /**< ID value of this terminal unit - must be a unique value within the device. */
+                       uint16_t                  TerminalType; /**< Type of terminal, a TERMINAL_* mask. */
                        uint8_t                   AssociatedOutputTerminal; /**< ID of associated output terminal, for physically grouped terminals
                        uint8_t                   AssociatedOutputTerminal; /**< ID of associated output terminal, for physically grouped terminals
-                                                                            *   such as the speaker and microphone of a phone handset
+                                                                            *   such as the speaker and microphone of a phone handset.
                                                                             */
                        uint8_t                   TotalChannels; /**< Total number of separate audio channels within this interface (right, left, etc.) */
                                                                             */
                        uint8_t                   TotalChannels; /**< Total number of separate audio channels within this interface (right, left, etc.) */
-                       uint16_t                  ChannelConfig; /**< CHANNEL_* masks indicating what channel layout is supported by this terminal */
+                       uint16_t                  ChannelConfig; /**< CHANNEL_* masks indicating what channel layout is supported by this terminal. */
                        
                        
-                       uint8_t                   ChannelStrIndex; /**< Index of a string descriptor describing this channel within the device */
-                       uint8_t                   TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device */
+                       uint8_t                   ChannelStrIndex; /**< Index of a string descriptor describing this channel within the device. */
+                       uint8_t                   TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
                } USB_Audio_InputTerminal_t;
 
                } USB_Audio_InputTerminal_t;
 
-               /** \brief Audio Class Specific Output Terminal Descriptor.
+               /** \brief Audio class-specific Output Terminal Descriptor.
                 *
                 *
-                *  Type define for an Audio class specific output terminal descriptor. This indicates to the host that the device
+                *  Type define for an Audio class-specific output terminal descriptor. This indicates to the host that the device
                 *  contains an output audio sink, either to a physical terminal on the device, or a logical terminal (for example,
                 *  a USB endpoint). See the USB Audio specification for more details.
                 */
                typedef struct
                {
                 *  contains an output audio sink, either to a physical terminal on the device, or a logical terminal (for example,
                 *  a USB endpoint). See the USB Audio specification for more details.
                 */
                typedef struct
                {
-                       USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
-                       uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
+                       USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length. */
+                       uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
                
                
-                       uint8_t                   TerminalID; /**< ID value of this terminal unit - must be a unique value within the device */
-                       uint16_t                  TerminalType; /**< Type of terminal, a TERMINAL_* mask */
+                       uint8_t                   TerminalID; /**< ID value of this terminal unit - must be a unique value within the device. */
+                       uint16_t                  TerminalType; /**< Type of terminal, a TERMINAL_* mask. */
                        uint8_t                   AssociatedInputTerminal; /**< ID of associated input terminal, for physically grouped terminals
                        uint8_t                   AssociatedInputTerminal; /**< ID of associated input terminal, for physically grouped terminals
-                                                                           *   such as the speaker and microphone of a phone handset
+                                                                           *   such as the speaker and microphone of a phone handset.
                                                                            */
                                                                            */
-                       uint8_t                   SourceID; /**< ID value of the unit this terminal's audio is sourced from */
+                       uint8_t                   SourceID; /**< ID value of the unit this terminal's audio is sourced from. */
                        
                        
-                       uint8_t                   TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device */
+                       uint8_t                   TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
                } USB_Audio_OutputTerminal_t;
                
                } USB_Audio_OutputTerminal_t;
                
-               /** \brief Audio Class Specific Streaming Audio Interface Descriptor.
+               /** \brief Audio class-specific Streaming Audio Interface Descriptor.
                 *
                 *
-                *  Type define for an Audio class specific streaming interface descriptor. This indicates to the host
+                *  Type define for an Audio class-specific streaming interface descriptor. This indicates to the host
                 *  how audio streams within the device are formatted. See the USB Audio specification for more details.
                 */
                typedef struct
                {
                 *  how audio streams within the device are formatted. See the USB Audio specification for more details.
                 */
                typedef struct
                {
-                       USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
-                       uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
+                       USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length. */
+                       uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
                        
                        
-                       uint8_t                   TerminalLink; /**< ID value of the output terminal this descriptor is describing */
+                       uint8_t                   TerminalLink; /**< ID value of the output terminal this descriptor is describing. */
                        
                        
-                       uint8_t                   FrameDelay; /**< Delay in frames resulting from the complete sample processing from input to output */
-                       uint16_t                  AudioFormat; /**< Format of the audio stream, see Audio Device Formats specification */
+                       uint8_t                   FrameDelay; /**< Delay in frames resulting from the complete sample processing from input to output. */
+                       uint16_t                  AudioFormat; /**< Format of the audio stream, see Audio Device Formats specification. */
                } USB_Audio_Interface_AS_t;
                
                /** \brief 24-Bit Audio Frequency Structure.
                 *
                 *  Type define for a 24bit audio sample frequency structure. GCC does not contain a built in 24bit datatype,
                } USB_Audio_Interface_AS_t;
                
                /** \brief 24-Bit Audio Frequency Structure.
                 *
                 *  Type define for a 24bit audio sample frequency structure. GCC does not contain a built in 24bit datatype,
-                *  this this structure is used to build up the value instead. Fill this structure with the SAMPLE_FREQ() macro.
+                *  this this structure is used to build up the value instead. Fill this structure with the \ref AUDIO_SAMPLE_FREQ() macro.
                 */
                typedef struct
                {
                 */
                typedef struct
                {
-                       uint16_t                  LowWord; /**< Low 16 bits of the 24-bit value */
-                       uint8_t                   HighByte; /**< Upper 8 bits of the 24-bit value */
+                       uint16_t                  LowWord; /**< Low 16 bits of the 24-bit value. */
+                       uint8_t                   HighByte; /**< Upper 8 bits of the 24-bit value. */
                } USB_Audio_SampleFreq_t;
 
                } USB_Audio_SampleFreq_t;
 
-               /** \brief Audio Class Specific Format Descriptor.
+               /** \brief Audio class-specific Format Descriptor.
                 *
                 *
-                *  Type define for an Audio class specific audio format descriptor. This is used to give the host full details
+                *  Type define for an Audio class-specific audio format descriptor. This is used to give the host full details
                 *  about the number of channels, the sample resolution, acceptable sample frequencies and encoding method used
                 *  in the device's audio streams. See the USB Audio specification for more details.
                 */
                typedef struct
                {
                 *  about the number of channels, the sample resolution, acceptable sample frequencies and encoding method used
                 *  in the device's audio streams. See the USB Audio specification for more details.
                 */
                typedef struct
                {
-                       USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
-                       uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
+                       USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length. */
+                       uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 
 
-                       uint8_t                   FormatType; /**< Format of the audio stream, see Audio Device Formats specification */
-                       uint8_t                   Channels; /**< Total number of discrete channels in the stream */
+                       uint8_t                   FormatType; /**< Format of the audio stream, see Audio Device Formats specification. */
+                       uint8_t                   Channels; /**< Total number of discrete channels in the stream. */
                        
                        
-                       uint8_t                   SubFrameSize; /**< Size in bytes of each channel's sample data in the stream */
-                       uint8_t                   BitResolution; /**< Bits of resolution of each channel's samples in the stream */
+                       uint8_t                   SubFrameSize; /**< Size in bytes of each channel's sample data in the stream. */
+                       uint8_t                   BitResolution; /**< Bits of resolution of each channel's samples in the stream. */
 
 
-                       uint8_t                   SampleFrequencyType; /**< Total number of sample frequencies supported by the device */                       
-                       USB_Audio_SampleFreq_t    SampleFrequencies[AUDIO_TOTAL_SAMPLE_RATES]; /**< Sample frequencies supported by the device */
+                       uint8_t                   SampleFrequencyType; /**< Total number of sample frequencies supported by the device. */                      
+                       USB_Audio_SampleFreq_t    SampleFrequencies[AUDIO_TOTAL_SAMPLE_RATES]; /**< Sample frequencies supported by the device. */
                } USB_Audio_Format_t;
                
                } USB_Audio_Format_t;
                
-               /** \brief Audio Class Specific Streaming Endpoint Descriptor.
+               /** \brief Audio class-specific Streaming Endpoint Descriptor.
                 *
                 *
-                *  Type define for an Audio class specific endpoint descriptor. This contains a regular endpoint 
-                *  descriptor with a few Audio-class specific extensions. See the USB Audio specification for more details.
+                *  Type define for an Audio class-specific endpoint descriptor. This contains a regular endpoint 
+                *  descriptor with a few Audio-class-specific extensions. See the USB Audio specification for more details.
                 */
                typedef struct
                {
                 */
                typedef struct
                {
-                       USB_Descriptor_Endpoint_t Endpoint; /**< Standard endpoint descriptor describing the audio endpoint */
+                       USB_Descriptor_Endpoint_t Endpoint; /**< Standard endpoint descriptor describing the audio endpoint. */
 
 
-                       uint8_t                   Refresh; /**< Always set to zero */
-                       uint8_t                   SyncEndpointNumber; /**< Endpoint address to send synchronization information to, if needed (zero otherwise) */
+                       uint8_t                   Refresh; /**< Always set to zero for Audio class devices. */
+                       uint8_t                   SyncEndpointNumber; /**< Endpoint address to send synchronization information to, if needed (zero otherwise). */
                } USB_Audio_StreamEndpoint_Std_t;
                                        
                } USB_Audio_StreamEndpoint_Std_t;
                                        
-               /** \brief Audio Class Specific Extended Endpoint Descriptor.
+               /** \brief Audio class-specific Extended Endpoint Descriptor.
                 *
                 *
-                *  Type define for an Audio class specific extended endpoint descriptor. This contains extra information
+                *  Type define for an Audio class-specific extended endpoint descriptor. This contains extra information
                 *  on the usage of endpoints used to stream audio in and out of the USB Audio device, and follows an Audio
                 *  on the usage of endpoints used to stream audio in and out of the USB Audio device, and follows an Audio
-                *  class specific extended endpoint descriptor. See the USB Audio specification for more details.
+                *  class-specific extended endpoint descriptor. See the USB Audio specification for more details.
                 */
                typedef struct
                {
                 */
                typedef struct
                {
-                       USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
-                       uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
+                       USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length. */
+                       uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
                        
                        
-                       uint8_t                   Attributes; /**< Audio class specific endpoint attributes, such as ACCEPTS_SMALL_PACKETS */
+                       uint8_t                   Attributes; /**< Audio class-specific endpoint attributes, such as ACCEPTS_SMALL_PACKETS. */
 
 
-                       uint8_t                   LockDelayUnits; /**< Units used for the LockDelay field, see Audio class specification */
-                       uint16_t                  LockDelay; /**< Time required to internally lock endpoint's internal clock recovery circuitry */
+                       uint8_t                   LockDelayUnits; /**< Units used for the LockDelay field, see Audio class specification. */
+                       uint16_t                  LockDelay; /**< Time required to internally lock endpoint's internal clock recovery circuitry. */
                } USB_Audio_StreamEndpoint_Spc_t;
 
        /* Disable C linkage for C++ Compilers: */
                } USB_Audio_StreamEndpoint_Spc_t;
 
        /* Disable C linkage for C++ Compilers: */
USB isp AVR programmer