X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/d6edfe35c8a9490407e4a5e34f8e5108c6a260a3..797130bddc25d519cd765ca8d82d1e729e3d8ae0:/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 553c778e2..512758866 100644 --- a/LUFA/Drivers/USB/Class/Common/Audio.h +++ b/LUFA/Drivers/USB/Class/Common/Audio.h @@ -1,21 +1,21 @@ /* LUFA Library - Copyright (C) Dean Camera, 2009. + Copyright (C) Dean Camera, 2010. dean [at] fourwalledcubicle [dot] com www.fourwalledcubicle.com */ /* - Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com) - - Permission to use, copy, modify, and distribute this software - and its documentation for any purpose and without fee is hereby - granted, 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 + Copyright 2010 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 @@ -28,6 +28,15 @@ this software. */ +/** \file + * \brief Common definitions and declarations for the library USB Audio Class driver. + * + * Common definitions and declarations for the library USB Audio Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/Audio.h. + */ + /** \ingroup Group_USBClassAudio * @defgroup Group_USBClassAudioCommon Common Class Definitions * @@ -51,6 +60,11 @@ extern "C" { #endif + /* Preprocessor Checks: */ + #if !defined(__INCLUDE_FROM_AUDIO_DRIVER) + #error Do not include this file directly. Include LUFA/Drivers/Class/Audio.h instead. + #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 @@ -222,7 +236,9 @@ #define EP_ACCEPTS_SMALL_PACKETS (0 << 7) /* Type Defines: */ - /** Type define for an Audio class specific interface descriptor. This follows a regular interface descriptor to + /** \brief Audio Class Specific Interface Descriptor. + * + * 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. */ @@ -238,7 +254,9 @@ uint8_t InterfaceNumbers[1]; /**< Interface numbers of each audio interface */ } USB_Audio_Interface_AC_t; - /** Type define for an Audio class specific Feature Unit descriptor. This indicates to the host what features + /** \brief Audio Class Specific Feature Unit Descriptor. + * + * 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. */ @@ -256,7 +274,9 @@ uint8_t FeatureUnitStrIndex; /**< Index of a string descriptor describing this descriptor within the device */ } USB_Audio_FeatureUnit_t; - /** Type define for an Audio class specific input terminal descriptor. This indicates to the host that the device + /** \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 * 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. */ @@ -277,7 +297,9 @@ uint8_t TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device */ } USB_Audio_InputTerminal_t; - /** Type define for an Audio class specific output terminal descriptor. This indicates to the host that the device + /** \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 * 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. */ @@ -296,7 +318,9 @@ uint8_t TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device */ } USB_Audio_OutputTerminal_t; - /** Type define for an Audio class specific streaming interface descriptor. This indicates to the host + /** \brief Audio Class Specific Streaming Audio Interface Descriptor. + * + * 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 @@ -310,7 +334,9 @@ uint16_t AudioFormat; /**< Format of the audio stream, see Audio Device Formats specification */ } USB_Audio_Interface_AS_t; - /** Type define for a 24bit audio sample frequency structure. GCC does not contain a built in 24bit datatype, + /** \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. */ typedef struct @@ -319,7 +345,9 @@ uint8_t HighByte; /**< Upper 8 bits of the 24-bit value */ } USB_Audio_SampleFreq_t; - /** Type define for an Audio class specific audio format descriptor. This is used to give the host full details + /** \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 * 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. */ @@ -338,7 +366,9 @@ USB_Audio_SampleFreq_t SampleFrequencies[AUDIO_TOTAL_SAMPLE_RATES]; /**< Sample frequencies supported by the device */ } USB_Audio_Format_t; - /** Type define for an Audio class specific endpoint descriptor. This contains a regular endpoint + /** \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. */ typedef struct @@ -349,7 +379,9 @@ uint8_t SyncEndpointNumber; /**< Endpoint address to send synchronization information to, if needed (zero otherwise) */ } USB_Audio_StreamEndpoint_Std_t; - /** Type define for an Audio class specific extended endpoint descriptor. This contains extra information + /** \brief Audio Class Specific Extended Endpoint Descriptor. + * + * 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 * class specific extended endpoint descriptor. See the USB Audio specification for more details. */