X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/b120c4e4cda5b5ed12a61697b5ab33d4dd0a70e8..2e76ad721e494f3a14ece73100ea9a2144c6fe8e:/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 c10e499ad..247f7f6d4 100644 --- a/LUFA/Drivers/USB/Class/Common/Audio.h +++ b/LUFA/Drivers/USB/Class/Common/Audio.h @@ -1,13 +1,13 @@ /* LUFA Library - Copyright (C) Dean Camera, 2010. + Copyright (C) Dean Camera, 2011. dean [at] fourwalledcubicle [dot] com www.lufa-lib.org */ /* - Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com) + Copyright 2011 Dean Camera (dean [at] fourwalledcubicle [dot] com) Permission to use, copy, modify, distribute, and sell this software and its documentation for any purpose is hereby granted @@ -38,9 +38,9 @@ */ /** \ingroup Group_USBClassAudio - * @defgroup Group_USBClassAudioCommon Common Class Definitions + * \defgroup Group_USBClassAudioCommon Common Class Definitions * - * \section Module Description + * \section Sec_ModDescription Module Description * Constants, Types and Enum definitions that are common to both Device and Host modes for the USB * Audio 1.0 Class. * @@ -51,9 +51,7 @@ #define _AUDIO_CLASS_COMMON_H_ /* Includes: */ - #include "../../HighLevel/StdDescriptors.h" - - #include + #include "../../Core/StdDescriptors.h" /* Enable C linkage for C++ Compilers: */ #if defined(__cplusplus) @@ -66,13 +64,6 @@ #endif /* Macros: */ - #if !defined(AUDIO_TOTAL_SAMPLE_RATES) || defined(__DOXYGEN__) - /** Total number of discrete audio sample rates supported by the device. This value can be overridden by defining this - * token in the project makefile to the desired value, and passing it to the compiler via the -D switch. - */ - #define AUDIO_TOTAL_SAMPLE_RATES 1 - #endif - /** \name Audio Channel Masks */ //@{ /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */ @@ -206,7 +197,7 @@ * * \param[in] freq Required audio sampling frequency in HZ */ - #define AUDIO_SAMPLE_FREQ(freq) {((uint32_t)freq & 0x00FFFF), (((uint32_t)freq >> 16) & 0x0000FF)} + #define AUDIO_SAMPLE_FREQ(freq) {.Byte1 = ((uint32_t)freq & 0xFF), .Byte2 = (((uint32_t)freq >> 8) & 0xFF), .Byte3 = (((uint32_t)freq >> 16) & 0xFF)} /** Mask for the attributes parameter of an Audio class-specific Endpoint descriptor, indicating that the endpoint * accepts only filled endpoint packets of audio samples. @@ -218,6 +209,16 @@ */ #define AUDIO_EP_ACCEPTS_SMALL_PACKETS (0 << 7) + /** Mask for the attributes parameter of an Audio class-specific Endpoint descriptor, indicating that the endpoint + * allows for sampling frequency adjustments to be made via control requests directed at the endpoint. + */ + #define AUDIO_EP_SAMPLE_FREQ_CONTROL (1 << 0) + + /** Mask for the attributes parameter of an Audio class-specific Endpoint descriptor, indicating that the endpoint + * allows for pitch adjustments to be made via control requests directed at the endpoint. + */ + #define AUDIO_EP_PITCH_CONTROL (1 << 1) + /* Enums: */ /** Enum for possible Class, Subclass and Protocol values of device and interface descriptors relating to the Audio * device class. @@ -271,6 +272,31 @@ AUDIO_DSUBTYPE_CSEndpoint_General = 0x01, /**< Audio class specific endpoint general descriptor. */ }; + /** Enum for the Audio class specific control requests that can be issued by the USB bus host. */ + enum Audio_ClassRequests_t + { + AUDIO_REQ_SetCurrent = 0x01, /**< Audio class-specific request to set the current value of a parameter within the device. */ + AUDIO_REQ_SetMinimum = 0x02, /**< Audio class-specific request to set the minimum value of a parameter within the device. */ + AUDIO_REQ_SetMaximum = 0x03, /**< Audio class-specific request to set the maximum value of a parameter within the device. */ + AUDIO_REQ_SetResolution = 0x04, /**< Audio class-specific request to set the resolution value of a parameter within the device. */ + AUDIO_REQ_SetMemory = 0x05, /**< Audio class-specific request to set the memory value of a parameter within the device. */ + AUDIO_REQ_GetCurrent = 0x81, /**< Audio class-specific request to get the current value of a parameter within the device. */ + AUDIO_REQ_GetMinimum = 0x82, /**< Audio class-specific request to get the minimum value of a parameter within the device. */ + AUDIO_REQ_GetMaximum = 0x83, /**< Audio class-specific request to get the maximum value of a parameter within the device. */ + AUDIO_REQ_GetResolution = 0x84, /**< Audio class-specific request to get the resolution value of a parameter within the device. */ + AUDIO_REQ_GetMemory = 0x85, /**< Audio class-specific request to get the memory value of a parameter within the device. */ + AUDIO_REQ_GetStatus = 0xFF, /**< Audio class-specific request to get the device status. */ + }; + + /** Enum for Audio class specific Endpoint control modifiers which can be set and retrieved by a USB host, if the corresponding + * endpoint control is indicated to be supported in the Endpoint's Audio-class specific endpoint descriptor. + */ + enum Audio_EndpointControls_t + { + AUDIO_EPCONTROL_SamplingFreq = 0x01, /**< Sampling frequency adjustment of the endpoint. */ + AUDIO_EPCONTROL_Pitch = 0x02, /**< Pitch adjustment of the endpoint. */ + }; + /* Type Defines: */ /** \brief Audio class-specific Input Terminal Descriptor (LUFA naming conventions). * @@ -288,16 +314,16 @@ */ 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. */ + uint16_t TerminalType; /**< Type of terminal, a \c TERMINAL_* mask. */ uint8_t AssociatedOutputTerminal; /**< ID of associated output terminal, for physically grouped terminals * 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.) */ - uint16_t ChannelConfig; /**< CHANNEL_* masks indicating what channel layout is supported by this terminal. */ + uint16_t ChannelConfig; /**< \c 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. */ - } USB_Audio_Descriptor_InputTerminal_t; + } ATTR_PACKED USB_Audio_Descriptor_InputTerminal_t; /** \brief Audio class-specific Input Terminal Descriptor (USB-IF naming conventions). * @@ -319,16 +345,16 @@ * must be \ref AUDIO_DSUBTYPE_CSInterface_InputTerminal. */ uint8_t bTerminalID; /**< ID value of this terminal unit - must be a unique value within the device. */ - uint16_t wTerminalType; /**< Type of terminal, a TERMINAL_* mask. */ + uint16_t wTerminalType; /**< Type of terminal, a \c TERMINAL_* mask. */ uint8_t bAssocTerminal; /**< ID of associated output terminal, for physically grouped terminals * such as the speaker and microphone of a phone handset. */ uint8_t bNrChannels; /**< Total number of separate audio channels within this interface (right, left, etc.) */ - uint16_t wChannelConfig; /**< CHANNEL_* masks indicating what channel layout is supported by this terminal. */ + uint16_t wChannelConfig; /**< \c CHANNEL_* masks indicating what channel layout is supported by this terminal. */ uint8_t iChannelNames; /**< Index of a string descriptor describing this channel within the device. */ uint8_t iTerminal; /**< Index of a string descriptor describing this descriptor within the device. */ - } USB_Audio_StdDescriptor_InputTerminal_t; + } ATTR_PACKED USB_Audio_StdDescriptor_InputTerminal_t; /** \brief Audio class-specific Output Terminal Descriptor (LUFA naming conventions). * @@ -346,14 +372,14 @@ */ 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. */ + uint16_t TerminalType; /**< Type of terminal, a \c TERMINAL_* mask. */ uint8_t AssociatedInputTerminal; /**< ID of associated input terminal, for physically grouped terminals * 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 TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */ - } USB_Audio_Descriptor_OutputTerminal_t; + } ATTR_PACKED USB_Audio_Descriptor_OutputTerminal_t; /** \brief Audio class-specific Output Terminal Descriptor (USB-IF naming conventions). * @@ -375,14 +401,14 @@ * a value from the \ref Audio_CSInterface_AC_SubTypes_t enum. */ uint8_t bTerminalID; /**< ID value of this terminal unit - must be a unique value within the device. */ - uint16_t wTerminalType; /**< Type of terminal, a TERMINAL_* mask. */ + uint16_t wTerminalType; /**< Type of terminal, a \c TERMINAL_* mask. */ uint8_t bAssocTerminal; /**< ID of associated input terminal, for physically grouped terminals * such as the speaker and microphone of a phone handset. */ uint8_t bSourceID; /**< ID value of the unit this terminal's audio is sourced from. */ uint8_t iTerminal; /**< Index of a string descriptor describing this descriptor within the device. */ - } USB_Audio_StdDescriptor_OutputTerminal_t; + } ATTR_PACKED USB_Audio_StdDescriptor_OutputTerminal_t; /** \brief Audio class-specific Interface Descriptor (LUFA naming conventions). * @@ -404,7 +430,7 @@ uint8_t InCollection; /**< Total number of Audio Streaming interfaces linked to this Audio Control interface (must be 1). */ uint8_t InterfaceNumber; /**< Interface number of the associated Audio Streaming interface. */ - } USB_Audio_Descriptor_Interface_AC_t; + } ATTR_PACKED USB_Audio_Descriptor_Interface_AC_t; /** \brief Audio class-specific Interface Descriptor (USB-IF naming conventions). * @@ -431,7 +457,7 @@ uint8_t bInCollection; /**< Total number of Audio Streaming interfaces linked to this Audio Control interface (must be 1). */ uint8_t bInterfaceNumbers; /**< Interface number of the associated Audio Streaming interface. */ - } USB_Audio_StdDescriptor_Interface_AC_t; + } ATTR_PACKED USB_Audio_StdDescriptor_Interface_AC_t; /** \brief Audio class-specific Feature Unit Descriptor (LUFA naming conventions). * @@ -451,11 +477,11 @@ 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 ControlSize; /**< Size of each element in the \c ChannelControls 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. */ - } USB_Audio_Descriptor_FeatureUnit_t; + } ATTR_PACKED USB_Audio_Descriptor_FeatureUnit_t; /** \brief Audio class-specific Feature Unit Descriptor (USB-IF naming conventions). * @@ -480,11 +506,11 @@ uint8_t bUnitID; /**< ID value of this feature unit - must be a unique value within the device. */ uint8_t bSourceID; /**< Source ID value of the audio source input into this feature unit. */ - uint8_t bControlSize; /**< Size of each element in the ChanelControlls array. */ + uint8_t bControlSize; /**< Size of each element in the \c ChannelControls array. */ uint8_t bmaControls[3]; /**< Feature masks for the control channel, and each separate audio channel. */ uint8_t iFeature; /**< Index of a string descriptor describing this descriptor within the device. */ - } USB_Audio_StdDescriptor_FeatureUnit_t; + } ATTR_PACKED USB_Audio_StdDescriptor_FeatureUnit_t; /** \brief Audio class-specific Streaming Audio Interface Descriptor (LUFA naming conventions). * @@ -504,7 +530,7 @@ 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_Descriptor_Interface_AS_t; + } ATTR_PACKED USB_Audio_Descriptor_Interface_AS_t; /** \brief Audio class-specific Streaming Audio Interface Descriptor (USB-IF naming conventions). * @@ -529,18 +555,7 @@ uint8_t bDelay; /**< Delay in frames resulting from the complete sample processing from input to output. */ uint16_t wFormatTag; /**< Format of the audio stream, see Audio Device Formats specification. */ - } USB_Audio_StdDescriptor_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 \ref AUDIO_SAMPLE_FREQ() macro. - */ - typedef struct - { - 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; + } ATTR_PACKED USB_Audio_StdDescriptor_Interface_AS_t; /** \brief Audio class-specific Format Descriptor (LUFA naming conventions). * @@ -548,6 +563,9 @@ * 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. * + * \note This descriptor must be followed by one or more \ref USB_Audio_SampleFreq_t elements containing + * the continuous or discrete sample frequencies. + * * \see \ref USB_Audio_StdDescriptor_Format_t for the version of this type with standard element names. */ typedef struct @@ -563,9 +581,24 @@ 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 (must be 24-bit). */ - } USB_Audio_Descriptor_Format_t; + uint8_t TotalDiscreteSampleRates; /**< Total number of discrete sample frequencies supported by the device. When + * zero, this must be followed by the lower and upper continuous sampling + * frequencies supported by the device; otherwise, this must be followed + * by the given number of discrete sampling frequencies supported. + */ + } ATTR_PACKED USB_Audio_Descriptor_Format_t; + + /** \brief 24-Bit Audio Frequency Structure. + * + * Type define for a 24bit audio sample frequency structure. As GCC does not contain a built in 24-bit datatype, + * this this structure is used to build up the value instead. Fill this structure with the \ref AUDIO_SAMPLE_FREQ() macro. + */ + typedef struct + { + uint8_t Byte1; /**< Lowest 8 bits of the 24-bit value. */ + uint8_t Byte2; /**< Middle 8 bits of the 24-bit value. */ + uint8_t Byte3; /**< Upper 8 bits of the 24-bit value. */ + } ATTR_PACKED USB_Audio_SampleFreq_t; /** \brief Audio class-specific Format Descriptor (USB-IF naming conventions). * @@ -573,6 +606,9 @@ * 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. * + * \note This descriptor must be followed by one or more 24-bit integer elements containing the continuous + * or discrete sample frequencies. + * * \see \ref USB_Audio_Descriptor_Format_t for the version of this type with non-standard LUFA specific * element names. */ @@ -593,9 +629,12 @@ uint8_t bSubFrameSize; /**< Size in bytes of each channel's sample data in the stream. */ uint8_t bBitResolution; /**< Bits of resolution of each channel's samples in the stream. */ - uint8_t bSampleFrequencyType; /**< Total number of sample frequencies supported by the device. */ - uint8_t SampleFrequencies[AUDIO_TOTAL_SAMPLE_RATES * 3]; /**< Sample frequencies supported by the device (must be 24-bit). */ - } USB_Audio_StdDescriptor_Format_t; + uint8_t bSampleFrequencyType; /**< Total number of sample frequencies supported by the device. When + * zero, this must be followed by the lower and upper continuous sampling + * frequencies supported by the device; otherwise, this must be followed + * by the given number of discrete sampling frequencies supported. + */ + } ATTR_PACKED USB_Audio_StdDescriptor_Format_t; /** \brief Audio class-specific Streaming Endpoint Descriptor (LUFA naming conventions). * @@ -610,7 +649,7 @@ 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_Descriptor_StreamEndpoint_Std_t; + } ATTR_PACKED USB_Audio_Descriptor_StreamEndpoint_Std_t; /** \brief Audio class-specific Streaming Endpoint Descriptor (USB-IF naming conventions). * @@ -629,8 +668,8 @@ uint8_t bEndpointAddress; /**< Logical address of the endpoint within the device for the current * configuration, including direction mask. */ - uint8_t bmAttributes; /**< Endpoint attributes, comprised of a mask of the endpoint type (EP_TYPE_*) - * and attributes (ENDPOINT_ATTR_*) masks. + uint8_t bmAttributes; /**< Endpoint attributes, comprised of a mask of the endpoint type (\c EP_TYPE_*) + * and attributes (\c ENDPOINT_ATTR_*) masks. */ uint16_t wMaxPacketSize; /**< Size of the endpoint bank, in bytes. This indicates the maximum packet size * that the endpoint can receive at a time. @@ -641,7 +680,7 @@ uint8_t bRefresh; /**< Always set to zero for Audio class devices. */ uint8_t bSynchAddress; /**< Endpoint address to send synchronization information to, if needed (zero otherwise). */ - } USB_Audio_StdDescriptor_StreamEndpoint_Std_t; + } ATTR_PACKED USB_Audio_StdDescriptor_StreamEndpoint_Std_t; /** \brief Audio class-specific Extended Endpoint Descriptor (LUFA naming conventions). * @@ -658,11 +697,11 @@ * a value from the \ref Audio_CSEndpoint_SubTypes_t enum. */ - uint8_t Attributes; /**< Audio class-specific endpoint attributes, such as ACCEPTS_SMALL_PACKETS. */ + uint8_t Attributes; /**< Audio class-specific endpoint attributes, such as \ref AUDIO_EP_FULL_PACKETS_ONLY. */ 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_Descriptor_StreamEndpoint_Spc_t; + } ATTR_PACKED USB_Audio_Descriptor_StreamEndpoint_Spc_t; /** \brief Audio class-specific Extended Endpoint Descriptor (USB-IF naming conventions). * @@ -684,11 +723,11 @@ * a value from the \ref Audio_CSEndpoint_SubTypes_t enum. */ - uint8_t bmAttributes; /**< Audio class-specific endpoint attributes, such as ACCEPTS_SMALL_PACKETS. */ + uint8_t bmAttributes; /**< Audio class-specific endpoint attributes, such as \ref AUDIO_EP_FULL_PACKETS_ONLY. */ uint8_t bLockDelayUnits; /**< Units used for the LockDelay field, see Audio class specification. */ uint16_t wLockDelay; /**< Time required to internally lock endpoint's internal clock recovery circuitry. */ - } USB_Audio_StdDescriptor_StreamEndpoint_Spc_t; + } ATTR_PACKED USB_Audio_StdDescriptor_StreamEndpoint_Spc_t; /* Disable C linkage for C++ Compilers: */ #if defined(__cplusplus)