-/*\r
- LUFA Library\r
- Copyright (C) Dean Camera, 2009.\r
- \r
- dean [at] fourwalledcubicle [dot] com\r
- www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\r
- Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
- Permission to use, copy, modify, and distribute this software\r
- and its documentation for any purpose and without fee is hereby\r
- granted, provided that the above copyright notice appear in all\r
- copies and that both that the copyright notice and this\r
- permission notice and warranty disclaimer appear in supporting\r
- documentation, and that the name of the author not be used in\r
- advertising or publicity pertaining to distribution of the\r
- software without specific, written prior permission.\r
-\r
- The author disclaim all warranties with regard to this\r
- software, including all implied warranties of merchantability\r
- and fitness. In no event shall the author be liable for any\r
- special, indirect or consequential damages or any damages\r
- whatsoever resulting from loss of use, data or profits, whether\r
- in an action of contract, negligence or other tortious action,\r
- arising out of or in connection with the use or performance of\r
- this software.\r
-*/\r
-\r
-/** \file\r
- *\r
- * Header file for Descriptors.c.\r
- */\r
- \r
-#ifndef _DESCRIPTORS_H_\r
-#define _DESCRIPTORS_H_\r
-\r
- /* Includes: */\r
- #include <LUFA/Drivers/USB/USB.h>\r
-\r
- #include <avr/pgmspace.h>\r
-\r
- /* Macros: */\r
- /** Descriptor header constant to indicate a Audio class interface descriptor. */\r
- #define DTYPE_AudioInterface 0x24\r
-\r
- /** Descriptor header constant to indicate a Audio class endpoint descriptor. */\r
- #define DTYPE_AudioEndpoint 0x25\r
-\r
- /** Audio class descriptor subtype value for a Audio class specific header descriptor. */\r
- #define DSUBTYPE_Header 0x01\r
-\r
- /** Audio class descriptor subtype value for an Output Terminal Audio class specific descriptor. */\r
- #define DSUBTYPE_InputTerminal 0x02\r
-\r
- /** Audio class descriptor subtype value for an Input Terminal Audio class specific descriptor. */\r
- #define DSUBTYPE_OutputTerminal 0x03\r
-\r
- /** Audio class descriptor subtype value for a Feature Unit Audio class specific descriptor. */\r
- #define DSUBTYPE_FeatureUnit 0x06\r
-\r
- /** Audio class descriptor subtype value for a general Audio class specific descriptor. */\r
- #define DSUBTYPE_General 0x01\r
-\r
- /** Audio class descriptor subtype value for an Audio class specific descriptor indicating the format of an audio stream. */\r
- #define DSUBTYPE_Format 0x02\r
- \r
- //@{\r
- /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */\r
-\r
- #define CHANNEL_LEFT_FRONT (1 << 0)\r
- #define CHANNEL_RIGHT_FRONT (1 << 1)\r
- #define CHANNEL_CENTER_FRONT (1 << 2)\r
- #define CHANNEL_LOW_FREQ_ENHANCE (1 << 3)\r
- #define CHANNEL_LEFT_SURROUND (1 << 4)\r
- #define CHANNEL_RIGHT_SURROUND (1 << 5)\r
- #define CHANNEL_LEFT_OF_CENTER (1 << 6)\r
- #define CHANNEL_RIGHT_OF_CENTER (1 << 7)\r
- #define CHANNEL_SURROUND (1 << 8)\r
- #define CHANNEL_SIDE_LEFT (1 << 9)\r
- #define CHANNEL_SIDE_RIGHT (1 << 10)\r
- #define CHANNEL_TOP (1 << 11)\r
- //@}\r
-\r
- //@{\r
- /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */\r
-\r
- #define FEATURE_MUTE (1 << 0)\r
- #define FEATURE_VOLUME (1 << 1)\r
- #define FEATURE_BASS (1 << 2)\r
- #define FEATURE_MID (1 << 3)\r
- #define FEATURE_TREBLE (1 << 4)\r
- #define FEATURE_GRAPHIC_EQUALIZER (1 << 5)\r
- #define FEATURE_AUTOMATIC_GAIN (1 << 6)\r
- #define FEATURE_DELAY (1 << 7)\r
- #define FEATURE_BASS_BOOST (1 << 8)\r
- #define FEATURE_BASS_LOUDNESS (1 << 9)\r
- //@}\r
-\r
- //@{\r
- /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */\r
- \r
- #define TERMINAL_UNDEFINED 0x0100\r
- #define TERMINAL_STREAMING 0x0101\r
- #define TERMINAL_VENDOR 0x01FF\r
- #define TERMINAL_IN_UNDEFINED 0x0200\r
- #define TERMINAL_IN_MIC 0x0201\r
- #define TERMINAL_IN_DESKTOP_MIC 0x0202\r
- #define TERMINAL_IN_PERSONAL_MIC 0x0203\r
- #define TERMINAL_IN_OMNIDIR_MIC 0x0204\r
- #define TERMINAL_IN_MIC_ARRAY 0x0205\r
- #define TERMINAL_IN_PROCESSING_MIC 0x0206\r
- #define TERMINAL_IN_OUT_UNDEFINED 0x0300\r
- #define TERMINAL_OUT_SPEAKER 0x0301\r
- #define TERMINAL_OUT_HEADPHONES 0x0302\r
- #define TERMINAL_OUT_HEAD_MOUNTED 0x0303\r
- #define TERMINAL_OUT_DESKTOP 0x0304\r
- #define TERMINAL_OUT_ROOM 0x0305\r
- #define TERMINAL_OUT_COMMUNICATION 0x0306\r
- #define TERMINAL_OUT_LOWFREQ 0x0307\r
- //@}\r
-\r
- /** Convenience macro, to fill a 24-bit AudioSampleFreq_t structure with the given sample rate as a 24-bit number.\r
- *\r
- * \param freq Required audio sampling frequency in HZ\r
- */\r
- #define SAMPLE_FREQ(freq) {LowWord: ((uint32_t)freq & 0x00FFFF), HighByte: (((uint32_t)freq >> 16) & 0x0000FF)}\r
- \r
- /** Mask for the attributes parameter of an Audio class specific Endpoint descriptor, indicating that the endpoint\r
- * accepts only filled endpoint packets of audio samples.\r
- */\r
- #define EP_ACCEPTS_ONLY_FULL_PACKETS (1 << 7)\r
-\r
- /** Mask for the attributes parameter of an Audio class specific Endpoint descriptor, indicating that the endpoint\r
- * will accept partially filled endpoint packets of audio samples.\r
- */\r
- #define EP_ACCEPTS_SMALL_PACKETS (0 << 7)\r
-\r
- #if defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR) || defined(__DOXYGEN__)\r
- /** Endpoint number of the Audio isochronous streaming data endpoint. */\r
- #define AUDIO_STREAM_EPNUM 1\r
- #else\r
- #define AUDIO_STREAM_EPNUM 3 \r
- #endif\r
- \r
- /** Endpoint size in bytes of the Audio isochronous streaming data endpoint. The Windows audio stack requires\r
- * at least 192 bytes for correct output, thus the smaller 128 byte maximum endpoint size on some of the smaller\r
- * USB AVR models will result in unavoidable distorted output.\r
- */\r
- #define AUDIO_STREAM_EPSIZE ENDPOINT_MAX_SIZE(AUDIO_STREAM_EPNUM)\r
- \r
- /** Sample frequency of the data being transmitted through the streaming endpoint. */\r
- #define AUDIO_SAMPLE_FREQUENCY 48000\r
- \r
- /* Type Defines: */\r
- /** Type define for an Audio class specific interface descriptor. This follows a regular interface descriptor to\r
- * supply extra information about the audio device's layout to the host. See the USB Audio specification for more\r
- * details.\r
- */\r
- typedef struct\r
- {\r
- USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length */\r
- uint8_t Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */\r
-\r
- uint16_t ACSpecification; /**< Binary coded decimal value, indicating the supported Audio Class specification version */\r
- uint16_t TotalLength; /**< Total length of the Audio class specific descriptors, including this descriptor */\r
- \r
- uint8_t InCollection; /**< Total number of audio class interfaces within this device */\r
- uint8_t InterfaceNumbers[1]; /**< Interface numbers of each audio interface */\r
- } USB_Audio_Interface_AC_t;\r
- \r
- /** Type define for an Audio class specific Feature Unit descriptor. This indicates to the host what features\r
- * are present in the device's audio stream for basic control, such as per-channel volume. See the USB Audio\r
- * specification for more details.\r
- */\r
- typedef struct\r
- {\r
- USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length */\r
- uint8_t Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */\r
- \r
- uint8_t UnitID; /**< ID value of this feature unit - must be a unique value within the device */\r
- uint8_t SourceID; /**< Source ID value of the audio source input into this feature unit */\r
- \r
- uint8_t ControlSize; /**< Size of each element in the ChanelControlls array */\r
- uint8_t ChannelControls[3]; /**< Feature masks for the control channel, and each separate audio channel */\r
- \r
- uint8_t FeatureUnitStrIndex; /**< Index of a string descriptor describing this descriptor within the device */\r
- } USB_Audio_FeatureUnit_t;\r
-\r
- /** Type define for an Audio class specific input terminal descriptor. This indicates to the host that the device\r
- * contains an input audio source, either from a physical terminal on the device, or a logical terminal (for example,\r
- * a USB endpoint). See the USB Audio specification for more details.\r
- */\r
- typedef struct\r
- {\r
- USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length */\r
- uint8_t Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */\r
- \r
- uint8_t TerminalID; /**< ID value of this terminal unit - must be a unique value within the device */\r
- uint16_t TerminalType; /**< Type of terminal, a TERMINAL_* mask */\r
- uint8_t AssociatedOutputTerminal; /**< ID of associated output terminal, for physically grouped terminals\r
- * such as the speaker and microphone of a phone handset\r
- */\r
- uint8_t TotalChannels; /**< Total number of separate audio channels within this interface (right, left, etc.) */\r
- uint16_t ChannelConfig; /**< CHANNEL_* masks indicating what channel layout is supported by this terminal */\r
- \r
- uint8_t ChannelStrIndex; /**< Index of a string descriptor describing this channel within the device */\r
- uint8_t TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device */\r
- } USB_Audio_InputTerminal_t;\r
-\r
- /** Type define for an Audio class specific output terminal descriptor. This indicates to the host that the device\r
- * contains an output audio sink, either to a physical terminal on the device, or a logical terminal (for example,\r
- * a USB endpoint). See the USB Audio specification for more details.\r
- */\r
- typedef struct\r
- {\r
- USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length */\r
- uint8_t Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */\r
- \r
- uint8_t TerminalID; /**< ID value of this terminal unit - must be a unique value within the device */\r
- uint16_t TerminalType; /**< Type of terminal, a TERMINAL_* mask */\r
- uint8_t AssociatedInputTerminal; /**< ID of associated input terminal, for physically grouped terminals\r
- * such as the speaker and microphone of a phone handset\r
- */\r
- uint8_t SourceID; /**< ID value of the unit this terminal's audio is sourced from */\r
- \r
- uint8_t TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device */\r
- } USB_Audio_OutputTerminal_t;\r
- \r
- /** Type define for an Audio class specific streaming interface descriptor. This indicates to the host\r
- * how audio streams within the device are formatted. See the USB Audio specification for more details.\r
- */\r
- typedef struct\r
- {\r
- USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length */\r
- uint8_t Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */\r
- \r
- uint8_t TerminalLink; /**< ID value of the output terminal this descriptor is describing */\r
- \r
- uint8_t FrameDelay; /**< Delay in frames resulting from the complete sample processing from input to output */\r
- uint16_t AudioFormat; /**< Format of the audio stream, see Audio Device Formats specification */\r
- } USB_Audio_Interface_AS_t;\r
- \r
- /** Type define for a 24bit audio sample frequency structure. GCC does not contain a built in 24bit datatype,\r
- * this this structure is used to build up the value instead. Fill this structure with the SAMPLE_FREQ() macro.\r
- */\r
- typedef struct\r
- {\r
- uint16_t LowWord; /**< Low 16 bits of the 24-bit value */\r
- uint8_t HighByte; /**< Upper 8 bits of the 24-bit value */\r
- } Audio_SampleFreq_t;\r
-\r
- /** Type define for an Audio class specific audio format descriptor. This is used to give the host full details\r
- * about the number of channels, the sample resolution, acceptable sample frequencies and encoding method used\r
- * in the device's audio streams. See the USB Audio specification for more details.\r
- */\r
- typedef struct\r
- {\r
- USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length */\r
- uint8_t Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */\r
-\r
- uint8_t FormatType; /**< Format of the audio stream, see Audio Device Formats specification */\r
- uint8_t Channels; /**< Total number of discrete channels in the stream */\r
- \r
- uint8_t SubFrameSize; /**< Size in bytes of each channel's sample data in the stream */\r
- uint8_t BitResolution; /**< Bits of resolution of each channel's samples in the stream */\r
-\r
- uint8_t SampleFrequencyType; /**< Total number of sample frequencies supported by the device */ \r
- Audio_SampleFreq_t SampleFrequencies[1]; /**< Sample frequencies supported by the device */\r
- } USB_Audio_Format_t;\r
- \r
- /** Type define for an Audio class specific endpoint descriptor. This contains a regular endpoint \r
- * descriptor with a few Audio-class specific extensions. See the USB Audio specification for more details.\r
- */\r
- typedef struct\r
- {\r
- USB_Descriptor_Endpoint_t Endpoint; /**< Standard endpoint descriptor describing the audio endpoint */\r
-\r
- uint8_t Refresh; /**< Always set to zero */\r
- uint8_t SyncEndpointNumber; /**< Endpoint address to send synchronisation information to, if needed (zero otherwise) */\r
- } USB_Audio_StreamEndpoint_Std_t;\r
- \r
- /** Type define for an Audio class specific extended endpoint descriptor. This contains extra information\r
- * on the usage of endpoints used to stream audio in and out of the USB Audio device, and follows an Audio\r
- * class specific extended endpoint descriptor. See the USB Audio specification for more details.\r
- */\r
- typedef struct\r
- {\r
- USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length */\r
- uint8_t Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */\r
- \r
- uint8_t Attributes; /**< Audio class specific endpoint attributes, such as ACCEPTS_SMALL_PACKETS */\r
-\r
- uint8_t LockDelayUnits; /**< Units used for the LockDelay field, see Audio class specification */\r
- uint16_t LockDelay; /**< Time required to internally lock endpoint's internal clock recovery circuitry */\r
- } USB_Audio_StreamEndpoint_Spc_t; \r
-\r
- /** Type define for the device configuration descriptor structure. This must be defined in the\r
- * application code, as the configuration descriptor contains several sub-descriptors which\r
- * vary between devices, and which describe the device's usage to the host.\r
- */\r
- typedef struct\r
- {\r
- USB_Descriptor_Configuration_Header_t Config;\r
- USB_Descriptor_Interface_t AudioControlInterface;\r
- USB_Audio_Interface_AC_t AudioControlInterface_SPC;\r
- USB_Audio_InputTerminal_t InputTerminal;\r
- USB_Audio_OutputTerminal_t OutputTerminal;\r
- USB_Descriptor_Interface_t AudioStreamInterface_Alt0;\r
- USB_Descriptor_Interface_t AudioStreamInterface_Alt1;\r
- USB_Audio_Interface_AS_t AudioStreamInterface_SPC;\r
- USB_Audio_Format_t AudioFormat;\r
- USB_Audio_StreamEndpoint_Std_t AudioEndpoint;\r
- USB_Audio_StreamEndpoint_Spc_t AudioEndpoint_SPC;\r
- } USB_Descriptor_Configuration_t;\r
- \r
- /* Function Prototypes: */\r
- uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)\r
- ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);\r
-\r
-#endif\r
+/*
+ LUFA Library
+ Copyright (C) Dean Camera, 2011.
+
+ dean [at] fourwalledcubicle [dot] com
+ www.lufa-lib.org
+*/
+
+/*
+ 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
+ without fee, provided that the above copyright notice appear in
+ all copies and that both that the copyright notice and this
+ permission notice and warranty disclaimer appear in supporting
+ documentation, and that the name of the author not be used in
+ advertising or publicity pertaining to distribution of the
+ software without specific, written prior permission.
+
+ The author disclaim all warranties with regard to this
+ software, including all implied warranties of merchantability
+ and fitness. In no event shall the author be liable for any
+ special, indirect or consequential damages or any damages
+ whatsoever resulting from loss of use, data or profits, whether
+ in an action of contract, negligence or other tortious action,
+ arising out of or in connection with the use or performance of
+ this software.
+*/
+
+/** \file
+ *
+ * Header file for Descriptors.c.
+ */
+
+#ifndef _DESCRIPTORS_H_
+#define _DESCRIPTORS_H_
+
+ /* Includes: */
+ #include <LUFA/Drivers/USB/USB.h>
+
+ #include <avr/pgmspace.h>
+
+ /* Macros: */
+ /** Endpoint number of the Audio isochronous streaming data endpoint. */
+ #define AUDIO_STREAM_EPNUM 1
+
+ /** Endpoint size in bytes of the Audio isochronous streaming data endpoint. The Windows audio stack requires
+ * at least 192 bytes for correct output, thus the smaller 128 byte maximum endpoint size on some of the smaller
+ * USB AVR models will result in unavoidable distorted output.
+ */
+ #define AUDIO_STREAM_EPSIZE ENDPOINT_MAX_SIZE(AUDIO_STREAM_EPNUM)
+
+ /* Type Defines: */
+ /** Type define for the device configuration descriptor structure. This must be defined in the
+ * application code, as the configuration descriptor contains several sub-descriptors which
+ * vary between devices, and which describe the device's usage to the host.
+ */
+ typedef struct
+ {
+ USB_Descriptor_Configuration_Header_t Config;
+
+ // Audio Control Interface
+ USB_Descriptor_Interface_t Audio_ControlInterface;
+ USB_Audio_Descriptor_Interface_AC_t Audio_ControlInterface_SPC;
+ USB_Audio_Descriptor_InputTerminal_t Audio_InputTerminal;
+ USB_Audio_Descriptor_OutputTerminal_t Audio_OutputTerminal;
+
+ // Audio Streaming Interface
+ USB_Descriptor_Interface_t Audio_StreamInterface_Alt0;
+ USB_Descriptor_Interface_t Audio_StreamInterface_Alt1;
+ USB_Audio_Descriptor_Interface_AS_t Audio_StreamInterface_SPC;
+ USB_Audio_Descriptor_Format_t Audio_AudioFormat;
+ USB_Audio_SampleFreq_t Audio_AudioFormatSampleRates[5];
+ USB_Audio_Descriptor_StreamEndpoint_Std_t Audio_StreamEndpoint;
+ USB_Audio_Descriptor_StreamEndpoint_Spc_t Audio_StreamEndpoint_SPC;
+ } USB_Descriptor_Configuration_t;
+
+ /* Function Prototypes: */
+ uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
+ const uint8_t wIndex,
+ const void** const DescriptorAddress)
+ ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
+
+#endif
projects / pub / USBasp.git / blobdiff