X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/5a4def747897c1c6ffbe465506d846c7c686d3e9..c79f6e2586047f66f96089e7f398622ccac80cec:/LUFA/Drivers/USB/Class/Device/Audio.h diff --git a/LUFA/Drivers/USB/Class/Device/Audio.h b/LUFA/Drivers/USB/Class/Device/Audio.h index 6520a3379..cf63c65b0 100644 --- a/LUFA/Drivers/USB/Class/Device/Audio.h +++ b/LUFA/Drivers/USB/Class/Device/Audio.h @@ -1,13 +1,13 @@ /* LUFA Library - Copyright (C) Dean Camera, 2010. + Copyright (C) Dean Camera, 2011. dean [at] fourwalledcubicle [dot] com - www.fourwalledcubicle.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 @@ -33,18 +33,18 @@ * * Device mode driver for the library USB Audio 1.0 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. + * \note This file should not be included directly. It is automatically included as needed by the USB module driver + * dispatch header located in LUFA/Drivers/USB.h. */ /** \ingroup Group_USBClassAudio - * @defgroup Group_USBClassAudioDevice Audio Class Device Mode Driver + * \defgroup Group_USBClassAudioDevice Audio Class Device Mode Driver * * \section Sec_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Device/Audio.c (Makefile source module name: LUFA_SRC_USBCLASS) * - * \section Module Description + * \section Sec_ModDescription Module Description * Device Mode USB Class driver framework interface, for the Audio 1.0 USB Class driver. * * @{ @@ -57,8 +57,6 @@ #include "../../USB.h" #include "../Common/Audio.h" - #include - /* Enable C linkage for C++ Compilers: */ #if defined(__cplusplus) extern "C" { @@ -66,7 +64,7 @@ /* Preprocessor Checks: */ #if !defined(__INCLUDE_FROM_AUDIO_DRIVER) - #error Do not include this file directly. Include LUFA/Drivers/Class/Audio.h instead. + #error Do not include this file directly. Include LUFA/Drivers/USB.h instead. #endif /* Public Interface - May be used in end-application: */ @@ -75,7 +73,7 @@ * * Class state structure. An instance of this structure should be made for each Audio interface * within the user application, and passed to each of the Audio class driver functions as the - * AudioInterfaceInfo parameter. This stores each Audio interface's configuration and state information. + * \c AudioInterfaceInfo parameter. This stores each Audio interface's configuration and state information. */ typedef struct { @@ -122,12 +120,12 @@ * * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state. * - * \return Boolean true if the endpoints were successfully configured, false otherwise. + * \return Boolean \c true if the endpoints were successfully configured, \c false otherwise. */ bool Audio_Device_ConfigureEndpoints(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); /** Processes incoming control requests from the host, that are directed to the given Audio class interface. This should be - * linked to the library \ref EVENT_USB_Device_UnhandledControlRequest() event. + * linked to the library \ref EVENT_USB_Device_ControlRequest() event. * * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state. */ @@ -154,7 +152,7 @@ * * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state. * - * \return Boolean true if the given Audio interface has a sample to be read, false otherwise. + * \return Boolean \c true if the given Audio interface has a sample to be read, \c false otherwise. */ static inline bool Audio_Device_IsSampleReceived(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE; @@ -175,7 +173,7 @@ * * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state. * - * \return Boolean true if the given Audio interface is ready to accept the next sample, false otherwise. + * \return Boolean \c true if the given Audio interface is ready to accept the next sample, \c false otherwise. */ static inline bool Audio_Device_IsReadyForNextSample(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE; @@ -314,8 +312,8 @@ static inline void Audio_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo, const int32_t Sample) { - Endpoint_Write_Byte(Sample >> 16); Endpoint_Write_Word_LE(Sample); + Endpoint_Write_Byte(Sample >> 16); if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize) Endpoint_ClearIN();